PoDoFo::PdfDataContainer Class Reference

A PdfDataProvider object with a PdfObject owner, specialized in holding objects. More...

#include <PdfDataContainer.h>

Inheritance diagram for PoDoFo::PdfDataContainer:

Public Member Functions
const PdfObject *	GetOwner () const
PdfObject *	GetOwner ()
virtual void	Write (OutputStream &stream, PdfWriteFlags writeMode, const PdfStatefulEncrypt *encrypt, charbuff &buffer) const =0
	Write the complete datatype to a file.
PdfDocument *	GetDocument () const
Public Member Functions inherited from PoDoFo::PdfDataProvider< PdfDataContainer >
std::string	ToString (PdfWriteFlags flags=PdfWriteFlags::None) const
	Converts the current object into a string representation which can be written directly to a PDF file on disc.
void	ToString (std::string &str, PdfWriteFlags flags=PdfWriteFlags::None) const

Protected Member Functions
virtual void	resetDirty ()=0
PdfObject *	GetIndirectObject (const PdfReference &reference) const
PdfDocument *	GetObjectDocument () const
void	SetDirty ()
bool	IsIndirectReferenceAllowed (const PdfObject &obj)
virtual void	setChildrenParent ()=0
void	AssertMutable () const

Friends
class	PdfObject
class	PdfArray
class	PdfDictionary

Detailed Description

A PdfDataProvider object with a PdfObject owner, specialized in holding objects.

Member Function Documentation

GetDocument()

PdfDocument * PoDoFo::PdfDataContainer::GetDocument ( ) const

inline

Returns

the document of the owner object, or nullptr if it has no owner

Remarks

It's stored here so contained objects can recover it without keeping a copy of their own

GetOwner()

const PdfObject * PoDoFo::PdfDataContainer::GetOwner ( ) const

inline

Returns

a pointer to a PdfObject that is the owner of this data type. Might be nullptr if the data type has no owner.

Write()

virtual void PoDoFo::PdfDataContainer::Write ( OutputStream &  stream, PdfWriteFlags  writeMode, const PdfStatefulEncrypt *  encrypt, charbuff &  buffer  ) const

pure virtual

Write the complete datatype to a file.

Parameters

stream	write the object to this device
writeMode	additional options for writing this object
encrypt	an encryption object which is used to encrypt this object or nullptr to not encrypt this object

Implemented in PoDoFo::PdfArray, and PoDoFo::PdfDictionary.

---

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

• src/podofo/main/PdfDataContainer.h
• src/podofo/main/PdfDataContainer.cpp