PoDoFo  1.0.0-dev
Public Member Functions | Protected Member Functions | Friends | List of all members
PoDoFo::PdfDataContainer Class Referenceabstract

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

#include <PdfDataContainer.h>

Inheritance diagram for PoDoFo::PdfDataContainer:
PoDoFo::PdfDataProvider< PdfDataContainer > PoDoFo::PdfArray PoDoFo::PdfDictionary

Public Member Functions

const PdfObjectGetOwner () const
 
PdfObjectGetOwner ()
 
virtual void Write (OutputStream &stream, PdfWriteFlags writeMode, const PdfStatefulEncrypt *encrypt, charbuff &buffer) const =0
 Write the complete datatype to a file. More...
 
- 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. More...
 
void ToString (std::string &str, PdfWriteFlags flags=PdfWriteFlags::None) const
 

Protected Member Functions

virtual void resetDirty ()=0
 
PdfObjectGetIndirectObject (const PdfReference &reference) const
 
PdfDocumentGetObjectDocument ()
 
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

◆ 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
devicewrite the object to this device
writeModeadditional options for writing this object
encryptan encryption object which is used to encrypt this object or nullptr to not encrypt this object

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


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