PoDoFo 0.9.20
PoDoFo::PdfXRefStreamParserObject Class Referencefinal

#include <PdfXRefStreamParserObject.h>

Inheritance diagram for PoDoFo::PdfXRefStreamParserObject:
PoDoFo::PdfParserObject PoDoFo::PdfObject

Public Member Functions

 PdfXRefStreamParserObject (InputStreamDevice &device, PdfXRefEntries &entries)
void DelayedLoadImpl () override
bool TryGetPreviousOffset (size_t &previousOffset) const
Public Member Functions inherited from PoDoFo::PdfParserObject
 PdfParserObject (InputStreamDevice &device, ssize_t offset=-1)
void FreeObjectMemory (bool force=false)
bool HasStreamToParse () const
ssize_t GetOffset () const
Public Member Functions inherited from PoDoFo::PdfObject
 PdfObject ()
 PdfObject (const PdfVariant &var)
 PdfObject (bool b)
 PdfObject (int64_t l)
 PdfObject (double d)
 PdfObject (const PdfString &str)
 PdfObject (const PdfName &name)
 PdfObject (const PdfReference &ref)
 PdfObject (const PdfArray &arr)
 PdfObject (const PdfDictionary &dict)
 PdfObject (const PdfObject &rhs)
PdfDataType GetDataType () const
const char * GetDataTypeString () const
bool IsBool () const
bool IsNumber () const
bool IsRealStrict () const
bool IsNumberOrReal () const
bool IsString () const
bool IsName () const
bool IsArray () const
bool IsDictionary () const
bool IsRawData () const
bool IsNull () const
bool IsReference () const
std::string ToString () const
bool GetBool () const
int64_t GetNumberLenient () const
int64_t GetNumber () const
double GetReal () const
double GetRealStrict () const
const PdfStringGetString () const
const PdfNameGetName () const
PdfReference GetReference () const
const PdfArrayGetArray () const
const PdfDictionaryGetDictionary () const
void SetBool (bool b)
void SetNumber (int64_t l)
void SetReal (double d)
void SetName (const PdfName &name)
void SetString (const PdfString &str)
void Write (OutputStream &stream, PdfWriteFlags writeMode, const PdfEncrypt *encrypt, charbuff &buffer) const
PdfObjectStreamGetOrCreateStream ()
const PdfObjectStreamMustGetStream () const
PdfObjectStreamMustGetStream ()
bool HasStream () const
bool operator< (const PdfObject &rhs) const
bool operator== (const PdfObject &rhs) const
bool operator!= (const PdfObject &rhs) const
bool operator== (const PdfVariant &rhs) const
bool operator!= (const PdfVariant &rhs) const
PdfObjectoperator= (const PdfObject &rhs)
bool IsDirty () const
PdfDocumentGetDocument () const
PdfDocumentMustGetDocument () const
const PdfReferenceGetIndirectReference () const
bool IsDelayedLoadDone () const

Additional Inherited Members

Protected Member Functions inherited from PoDoFo::PdfObject
void DelayedLoad () const
void SetDirty ()
void SetDocument (PdfDocument *document)
void EnableDelayedLoading ()

Detailed Description

A utility class for PdfParser that can parse an XRef stream object.

It is mainly here to make PdfParser more modular. This is only marked PODOFO_API for the benefit of the tests, the class is for internal use only.

Constructor & Destructor Documentation

◆ PdfXRefStreamParserObject()

PdfXRefStreamParserObject::PdfXRefStreamParserObject ( InputStreamDevice & device,
PdfXRefEntries & entries )
Warning
This constructor is for testing usage only

Member Function Documentation

◆ DelayedLoadImpl()

void PdfXRefStreamParserObject::DelayedLoadImpl ( )
overridevirtual

Load all data of the object if delayed loading is enabled.

Never call this method directly; use DelayedLoad() instead.

You should override this to control deferred loading in your subclass. Note that this method should not load any associated streams, just the base object.

The default implementation throws. It should never be called, since objects that do not support delayed loading should not enable it.

While this method is not ‘const’ it may be called from a const context, so be careful what you mess with.

Reimplemented from PoDoFo::PdfParserObject.

◆ TryGetPreviousOffset()

bool PdfXRefStreamParserObject::TryGetPreviousOffset ( size_t & previousOffset) const
Returns
the offset of the previous XRef table