Mako 7.5.0 API
Loading...
Searching...
No Matches
JawsMako::CPDFFarReference Class Reference

A simple concrete class representing indirect reference data stored in a remote context, such as (for example) from a different PDF document. More...

#include <pdfobjects.h>

Public Member Functions

 CPDFFarReference (DOMid docId, DOMid allocatorId, int32 objectNum, int32 generation)
 Construct the reference data from remote document, allocator, object number and generator.
 
DOMid getDocumentId () const
 Obtain the source document ID for this document.
 
DOMid getAllocatorId () const
 Obtain the id of the entity that allocated the object. If the same as the document id, the referenced object is present in the original PDF document with that Id. Otherwise it has been allocated anew.
 
int32 getObjectNum () const
 Obtain the object number of this reference data.
 
int32 getGeneration () const
 Obtain the generation number of this reference data.
 

Detailed Description

A simple concrete class representing indirect reference data stored in a remote context, such as (for example) from a different PDF document.

Constructor & Destructor Documentation

◆ CPDFFarReference()

JawsMako::CPDFFarReference::CPDFFarReference ( DOMid docId,
DOMid allocatorId,
int32 objectNum,
int32 generation )
inline

Construct the reference data from remote document, allocator, object number and generator.

Parameters
docIdThe id of the source document for the referred object
allocatorIdA unique allocator ID used to differentiate between updated objects and unedited objects from the source document.
objectNumThe object number to use
generationThe generation number to use

Member Function Documentation

◆ getAllocatorId()

DOMid JawsMako::CPDFFarReference::getAllocatorId ( ) const
inline

Obtain the id of the entity that allocated the object. If the same as the document id, the referenced object is present in the original PDF document with that Id. Otherwise it has been allocated anew.

Returns
DOMid the allocator ID.

◆ getDocumentId()

DOMid JawsMako::CPDFFarReference::getDocumentId ( ) const
inline

Obtain the source document ID for this document.

Returns
DOMid the source document ID.

◆ getGeneration()

int32 JawsMako::CPDFFarReference::getGeneration ( ) const
inline

Obtain the generation number of this reference data.

Returns
int32 The generation number.

◆ getObjectNum()

int32 JawsMako::CPDFFarReference::getObjectNum ( ) const
inline

Obtain the object number of this reference data.

Returns
int32 The object number.

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