wxPdfObject Class Reference

Class representing a base PDF object. (For internal use only). More...

#include <pdfobjects.h>

Inheritance diagram for wxPdfObject:

Public Member Functions
	wxPdfObject (int type)
	Constructor.
virtual	~wxPdfObject ()
	Destructor.
int	GetType ()
	Get the type of the object.
void	SetObjNum (int objNum, int objGen=0)
	Set object and generation number.
int	GetNumber ()
	Get object number.
int	GetGeneration ()
	Get generation number.
void	SetActualId (int actualId)
	Set actual object id.
int	GetActualId ()
void	SetCreatedIndirect (bool indirect)
	Flag this object as created through an indirect reference.
bool	IsCreatedIndirect ()
	Check whether this object was created through an indirect reference.
bool	CanBeInObjStm ()
	Check whether this object can be in an object stream.
bool	IsNull ()
	Checks whether this is a wxPdfNull object.
bool	IsBoolean ()
	Checks whether this is a wxPdfBoolean object.
bool	IsNumber ()
	Checks whether this is a wxPdfNumber object.
bool	IsString ()
	Checks whether this is a wxPdfString object.
bool	IsName ()
	Checks whether this is a wxPdfName object.
bool	IsArray ()
	Checks whether this is a wxPdfArray object.
bool	IsDictionary ()
	Checks whether this is a wxPdfDictionary object.
bool	IsStream ()
	Checks whether this PdfObject is of the type PdfStream.
bool	IsIndirect ()
	Checks if this is an indirect object.

Protected Attributes
int	m_type
	Object type.
int	m_objNum
	Object number.
int	m_objGen
	Object generation.
int	m_actualId
	Actual object id.
bool	m_indirect
	Flag whether created through indirect reference.

Detailed Description

Class representing a base PDF object. (For internal use only).

Constructor & Destructor Documentation

wxPdfObject()

wxPdfObject::wxPdfObject

(

int

type

)

Constructor.

Parameters

type	The object type

~wxPdfObject()

virtual wxPdfObject::~wxPdfObject ( )

virtual

Destructor.

Member Function Documentation

CanBeInObjStm()

bool wxPdfObject::CanBeInObjStm

(

)

Check whether this object can be in an object stream.

Returns

true if the object can be in an object stream, false otherwise

GetActualId()

int wxPdfObject::GetActualId ( )

inline

Returns

The actual object ID

GetGeneration()

int wxPdfObject::GetGeneration ( )

inline

Get generation number.

Returns

The generation number

GetNumber()

int wxPdfObject::GetNumber ( )

inline

Get object number.

Returns

The object number

GetType()

int wxPdfObject::GetType ( )

inline

Get the type of the object.

Returns

The object type

IsArray()

bool wxPdfObject::IsArray ( )

inline

Checks whether this is a wxPdfArray object.

Returns

true if this is an array object, false otherwise

IsBoolean()

bool wxPdfObject::IsBoolean ( )

inline

Checks whether this is a wxPdfBoolean object.

Returns

true if this is a boolean object, false otherwise

IsCreatedIndirect()

bool wxPdfObject::IsCreatedIndirect ( )

inline

Check whether this object was created through an indirect reference.

Returns

true if the object was created through an indirect reference, false otherwise

IsDictionary()

bool wxPdfObject::IsDictionary ( )

inline

Checks whether this is a wxPdfDictionary object.

Returns

true if this is a dictionary object, false otherwise

IsIndirect()

bool wxPdfObject::IsIndirect ( )

inline

Checks if this is an indirect object.

Returns

true if this is an indirect object, false otherwise

IsName()

bool wxPdfObject::IsName ( )

inline

Checks whether this is a wxPdfName object.

Returns

true if this is a name object, false otherwise

IsNull()

bool wxPdfObject::IsNull ( )

inline

Checks whether this is a wxPdfNull object.

Returns

true if this is a null object, false otherwise

IsNumber()

bool wxPdfObject::IsNumber ( )

inline

Checks whether this is a wxPdfNumber object.

Returns

true if this is a number object, false otherwise

IsStream()

bool wxPdfObject::IsStream ( )

inline

Checks whether this PdfObject is of the type PdfStream.

Returns

true if this is a stream object, false otherwise

IsString()

bool wxPdfObject::IsString ( )

inline

Checks whether this is a wxPdfString object.

Returns

true if this is a string object, false otherwise

SetActualId()

void wxPdfObject::SetActualId ( int actualId )

inline

Set actual object id.

Parameters

actualId

The actual object ID

SetCreatedIndirect()

void wxPdfObject::SetCreatedIndirect ( bool indirect )

inline

Flag this object as created through an indirect reference.

Parameters

indirect

Flag whether the object is an indirect reference

SetObjNum()

void wxPdfObject::SetObjNum	(	int	objNum,
		int	objGen = 0 )

Set object and generation number.

Parameters

objNum	The object number
objGen	The generation number

Member Data Documentation

m_actualId

int wxPdfObject::m_actualId

protected

Actual object id.

m_indirect

bool wxPdfObject::m_indirect

protected

Flag whether created through indirect reference.

m_objGen

int wxPdfObject::m_objGen

protected

Object generation.

m_objNum

int wxPdfObject::m_objNum

protected

Object number.

m_type

int wxPdfObject::m_type

protected

Object type.

---

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

• E:/github/wxpdfdoc-current/include/wx/pdfobjects.h