PdsObject Struct Reference

PdsObject class. More...

#include <pdfix.h>

Inheritance diagram for PdsObject:

Public Member Functions
virtual PdfObjectType	GetObjectType () const =0
	Gets the type of an object. More...
virtual int	GetId () const =0
	Gets the object number. More...
virtual int	GetGenId () const =0
	Gets the generation number. More...
virtual PdfDoc *	GetDoc () const =0
	Gets a reference to a document. More...
virtual PdsObject *	Clone (bool clone_indirect)=0
	Clone the object. More...
virtual bool	RegisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0
	Registers a user-supplied procedure to call when the specified event occurs. More...
virtual bool	UnregisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0

Detailed Description

PdsObject class.

A PdsObject is a general object in a PDF file, which may be of any PdsObject object type. The Object layer provides several methods that are not specific to any particular object.

Member Function Documentation

Clone()

virtual PdsObject * PdsObject::Clone ( bool  clone_indirect )

pure virtual

Clone the object.

Parameters

clone_indirect

Make a deep clone including all references

Returns

The new clone of the PdsObject.

GetDoc()

virtual PdfDoc * PdsObject::GetDoc ( ) const

pure virtual

Gets a reference to a document.

Returns

PdfDoc object.

GetGenId()

virtual int PdsObject::GetGenId ( ) const

pure virtual

Gets the generation number.

Returns

Generation number

GetId()

virtual int PdsObject::GetId ( ) const

pure virtual

Gets the object number.

Returns

Object number or zero in case of a direct object

GetObjectType()

virtual PdfObjectType PdsObject::GetObjectType ( ) const

pure virtual

Gets the type of an object.

Returns

Object type, kObjectUnknown otherwise.

RegisterEvent()

virtual bool PdsObject::RegisterEvent ( PdfEventType  type, PdsObjectEventProc  proc, void *  data  )

pure virtual

Registers a user-supplied procedure to call when the specified event occurs.

Parameters

type	The event type.
proc	A user-supplied callback to call when the event occurs.
data	A pointer to user-supplied data to pass to proc each time it is called.

Returns

true if event was registered, false otherwise. Sample RegisterEvent

UnregisterEvent()

virtual bool PdsObject::UnregisterEvent ( PdfEventType  type, PdsObjectEventProc  proc, void *  data  )

pure virtual

Unregisters a user-supplied procedure to call when the specified event occurs. To un-register, you must use same type, proc and data that were used when the event was registered using Pdfix::RegisterEvent.

Parameters

type	The registered event type.
proc	A registered user-supplied callback.
data	A pointer to registered user-supplied data.

Returns

true if event was registered, false otherwise.