Mako 7.4.0 API
Loading...
Searching...
No Matches
JawsMako::IPDFReference Class Referenceabstract

A simple class representing an immutable PDF indirect reference. More...

#include <pdfobjects.h>

Inheritance diagram for JawsMako::IPDFReference:

Public Member Functions

virtual const CPDFReferencegetValue () const =0
 Obtain the CPDFReference data for this reference.
 
int32 getObjectNum ()
 Obtain the object number for this reference.
 
int32 getGeneration ()
 Obtain the geneartion number for this reference.
 
- Public Member Functions inherited from JawsMako::IPDFObject
virtual ePDFObjectType getType () const =0
 Get the type of this PDF object.
 
virtual IPDFObjectPtr clone () const =0
 Create a clone of this PDF object if appropriate. Note that simple immutable objects are not actually cloned and instead the same object is returned.
 
virtual IPDFObjectPtr deepClone () const =0
 Create a deep clone of this PDF object if appropriate. Note that simple immutable objects are not actually cloned and instead the same object is returned. If the object is composite (an IPDFArray, IPDFDictionary or IPDFStream) then the object will be cloned as well as the consituent objects in a recursive fashion.
 
virtual bool getIsExecutable () const =0
 Get whether or not the object is considered executable, such as an executable name, array, or operator.
 
virtual bool containsReferences () const =0
 Get whether or not the object contains indirect references to other objects (that is, does the object or any constituent object contain IPDFReference or IPDFFarReference objects).
 
virtual void emitPostScriptCode (const IOutputStreamPtr &dest) const =0
 Convert the object to PostScript code and write to the given stream. Only allowed for objects that are representable in PostScript.
 
virtual bool getNumber (double &number) const =0
 If the object is a number (a real or integer) obtain that number.
 
virtual bool getNumber (float &number) const =0
 If the object is a number (a real or integer) within the range of a 32-bit float, obtain that number. If the object is an integer, thiw will fail if the integer cannot be represented exactly in a single precision float.
 
virtual bool getNumber (int32 &number) const =0
 If the object is an integer (a integral real or integer) within the range of a 32-bit integer, obtain that number.
 
virtual bool getString (RawString &string) const =0
 If the object is a string or a name, retrieve the raw string data.
 
- Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
 
- Public Member Functions inherited from JawsMako::IHashable
virtual uint64 hash () const
 Obtain a 64-bit hash of the receiving object.
 
virtual void updateHash (uint64 &hash) const =0
 Update the given hash to include the receiver.
 

Static Public Member Functions

static JAWSMAKO_API IPDFReferencePtr create (const CPDFReference &reference)
 Create an indirect reference object from CPDFReference data.
 
static JAWSMAKO_API IPDFReferencePtr create (int32 objectNum, int32 generation)
 Create an indirect reference object from an object number and generation.
 
- Static Public Member Functions inherited from JawsMako::IPDFObject
static JAWSMAKO_API IPDFObjectPtr createNumber (double number)
 If the given number is an integer, create an IPDFInteger, otherwise create an IPDFReal.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A simple class representing an immutable PDF indirect reference.

Member Function Documentation

◆ create() [1/2]

static JAWSMAKO_API IPDFReferencePtr JawsMako::IPDFReference::create ( const CPDFReference & reference)
static

Create an indirect reference object from CPDFReference data.

Parameters
referenceThe CPDFReference data to use.
Returns
IPDFReferencePtr The created object.

◆ create() [2/2]

static JAWSMAKO_API IPDFReferencePtr JawsMako::IPDFReference::create ( int32 objectNum,
int32 generation )
inlinestatic

Create an indirect reference object from an object number and generation.

Parameters
objectNumThe object number to use.
generationThe generation number to use.
Returns
IPDFReferencePtr The created object.

◆ getGeneration()

int32 JawsMako::IPDFReference::getGeneration ( )
inline

Obtain the geneartion number for this reference.

Returns
int32 The generation.

◆ getObjectNum()

int32 JawsMako::IPDFReference::getObjectNum ( )
inline

Obtain the object number for this reference.

Returns
int32 The object number.

◆ getValue()

virtual const CPDFReference & JawsMako::IPDFReference::getValue ( ) const
pure virtual

Obtain the CPDFReference data for this reference.

Returns
CPDFReference The reference data.

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