Ipelib
Classes | Public Member Functions | List of all members
ipe::PdfDict Class Reference

#include <ipepdfparser.h>

Inherits ipe::PdfObj.

Public Member Functions

 PdfDict ()
 
 ~PdfDict ()
 
virtual const PdfDictdict () const noexcept
 
String dictRepr () const noexcept
 
void dictWrite (Stream &stream, const PdfRenumber *renumber, bool inflate, int length) const noexcept
 
virtual void write (Stream &stream, const PdfRenumber *renumber, bool inflate) const noexcept
 
void setStream (const Buffer &stream)
 
void add (String key, const PdfObj *obj)
 
const PdfObjget (String key, const PdfFile *file) const noexcept
 
bool getNumber (String key, double &val, const PdfFile *file) const noexcept
 
bool getNumberArray (String key, const PdfFile *file, std::vector< double > &vals) const noexcept
 
int count () const noexcept
 
String key (int index) const noexcept
 
const PdfObjvalue (int index) const noexcept
 
Buffer stream () const noexcept
 
bool deflated () const noexcept
 
Buffer inflate () const noexcept
 
- Public Member Functions inherited from ipe::PdfObj
virtual ~PdfObj ()=0
 
virtual const PdfNullnull () const noexcept
 
virtual const PdfBoolboolean () const noexcept
 
virtual const PdfNumbernumber () const noexcept
 
virtual const PdfStringstring () const noexcept
 
virtual const PdfNamename () const noexcept
 
virtual const PdfRefref () const noexcept
 
virtual const PdfArrayarray () const noexcept
 
String repr () const noexcept
 

Detailed Description

The PDF dictionary and stream objects.

A dictionary may or may not have attached stream data.

Constructor & Destructor Documentation

◆ PdfDict()

ipe::PdfDict::PdfDict ( )
inlineexplicit

◆ ~PdfDict()

PdfDict::~PdfDict ( )

Member Function Documentation

◆ dict()

const PdfDict * PdfDict::dict ( ) const
virtualnoexcept

Return this object as PDF dictionary object.

Reimplemented from ipe::PdfObj.

Referenced by ipe::PdfFile::parse().

◆ dictRepr()

String PdfDict::dictRepr ( ) const
noexcept

Return PDF representation of the PdfDict without the stream.

◆ dictWrite()

void PdfDict::dictWrite ( Stream stream,
const PdfRenumber renumber,
bool  inflate,
int  length 
) const
noexcept

◆ write()

void PdfDict::write ( Stream stream,
const PdfRenumber renumber,
bool  inflate 
) const
virtualnoexcept

Implements ipe::PdfObj.

References ipe::Buffer::size().

◆ setStream()

void PdfDict::setStream ( const Buffer stream)

Add stream data to this dictionary.

◆ add()

void PdfDict::add ( String  key,
const PdfObj obj 
)

Add a (key, value) pair to the dictionary.

Dictionary takes ownership of obj.

Referenced by ipe::PdfResources::collect().

◆ get()

const PdfObj * PdfDict::get ( String  key,
const PdfFile file 
) const
noexcept

Look up key in dictionary.

Indirect objects (references) are looked up if file is not nullptr, and the object referred to is returned. Returns nullptr if key is not in dictionary.

Referenced by ipe::PdfResources::collect(), ipe::Latex::createLatexSource(), ipe::CairoPainter::doDrawText(), ipe::Document::formatFromFilename(), ipe::PdfFile::page(), ipe::PdfFile::parse(), ipe::PdfFile::parseObjectStream(), ipe::Latex::readPdf(), and ipe::PdfWriter::~PdfWriter().

◆ getNumber()

bool PdfDict::getNumber ( String  key,
double &  val,
const PdfFile file 
) const
noexcept

Retrieve a single number and stor in val.

References ipe::PdfObj::number(), and ipe::PdfNumber::value().

Referenced by ipe::Latex::createLatexSource().

◆ getNumberArray()

bool PdfDict::getNumberArray ( String  key,
const PdfFile file,
std::vector< double > &  vals 
) const
noexcept

◆ count()

int ipe::PdfDict::count ( ) const
inlinenoexcept

◆ key()

String ipe::PdfDict::key ( int  index) const
inlinenoexcept

◆ value()

const PdfObj* ipe::PdfDict::value ( int  index) const
inlinenoexcept

◆ stream()

Buffer ipe::PdfDict::stream ( ) const
inlinenoexcept

◆ deflated()

bool PdfDict::deflated ( ) const
noexcept

Is this stream compressed with flate compression?

References ipe::PdfObj::name(), and ipe::PdfName::value().

Referenced by ipe::Document::formatFromFilename(), and ipe::PdfWriter::~PdfWriter().

◆ inflate()

Buffer PdfDict::inflate ( ) const
noexcept

The documentation for this class was generated from the following files: