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=nullptr) const noexcept
 
virtual void write (Stream &stream, const PdfRenumber *renumber=nullptr) 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

ipe::PdfDict::PdfDict ( )
inlineexplicit
PdfDict::~PdfDict ( )

Member Function Documentation

const PdfDict * PdfDict::dict ( ) const
virtualnoexcept

Return this object as PDF dictionary object.

Reimplemented from ipe::PdfObj.

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

String PdfDict::dictRepr ( ) const
noexcept

Return PDF representation of the PdfDict without the stream.

References dictWrite().

void PdfDict::dictWrite ( Stream stream,
const PdfRenumber renumber = nullptr 
) const
noexcept

Referenced by dictRepr().

void PdfDict::write ( Stream stream,
const PdfRenumber renumber = nullptr 
) const
virtualnoexcept

Implements ipe::PdfObj.

void PdfDict::setStream ( const Buffer stream)

Add stream data to this dictionary.

References stream().

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

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

Dictionary takes ownership of obj.

References key().

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::PdfFile::page(), ipe::PdfFile::parse(), ipe::PdfFile::parseObjectStream(), and ipe::Latex::readPdf().

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().

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

Retrieve an array of numbers and store in vals.

References ipe::PdfObj::array(), ipe::PdfArray::count(), ipe::PdfObj::number(), ipe::PdfArray::obj(), and ipe::PdfNumber::value().

int ipe::PdfDict::count ( ) const
inlinenoexcept
String ipe::PdfDict::key ( int  index) const
inlinenoexcept
const PdfObj* ipe::PdfDict::value ( int  index) const
inlinenoexcept
Buffer ipe::PdfDict::stream ( ) const
inlinenoexcept

Referenced by setStream().

bool PdfDict::deflated ( ) const
noexcept

Is this stream compressed with flate compression?

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

Referenced by inflate().

Buffer PdfDict::inflate ( ) const
noexcept

Return the (uncompressed) stream data.

This only handles the /Flate compression.

References ipe::String::data(), deflated(), ipe::InflateSource::getChar(), ipe::String::size(), and ipe::Buffer::size().

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


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