wxPdfDocument 1.2.0
Public Member Functions | Protected Attributes | List of all members
wxPdfObject Class Reference

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

#include <pdfobjects.h>

Inheritance diagram for wxPdfObject:
wxPdfArray wxPdfBoolean wxPdfDictionary wxPdfIndirectReference wxPdfLiteral wxPdfName wxPdfNull wxPdfNumber wxPdfStream wxPdfString

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 a indirect reference.
 
bool IsCreatedIndirect ()
 Check whether this object was created through a 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.

◆ ~wxPdfObject()

virtual wxPdfObject::~wxPdfObject ( )
virtual

Destructor.

Member Function Documentation

◆ CanBeInObjStm()

bool wxPdfObject::CanBeInObjStm ( )

Check whether this object can be in an object stream.

◆ GetActualId()

int wxPdfObject::GetActualId ( )
inline

◆ GetGeneration()

int wxPdfObject::GetGeneration ( )
inline

Get generation number.

◆ GetNumber()

int wxPdfObject::GetNumber ( )
inline

Get object number.

◆ GetType()

int wxPdfObject::GetType ( )
inline

Get the type of the object.

◆ IsArray()

bool wxPdfObject::IsArray ( )
inline

Checks whether this is a wxPdfArray object.

◆ IsBoolean()

bool wxPdfObject::IsBoolean ( )
inline

Checks whether this is a wxPdfBoolean object.

◆ IsCreatedIndirect()

bool wxPdfObject::IsCreatedIndirect ( )
inline

Check whether this object was created through a indirect reference.

◆ IsDictionary()

bool wxPdfObject::IsDictionary ( )
inline

Checks whether this is a wxPdfDictionary object.

◆ IsIndirect()

bool wxPdfObject::IsIndirect ( )
inline

Checks if this is an indirect object.

◆ IsName()

bool wxPdfObject::IsName ( )
inline

Checks whether this is a wxPdfName object.

◆ IsNull()

bool wxPdfObject::IsNull ( )
inline

Checks whether this is a wxPdfNull object.

◆ IsNumber()

bool wxPdfObject::IsNumber ( )
inline

Checks whether this is a wxPdfNumber object.

◆ IsStream()

bool wxPdfObject::IsStream ( )
inline

Checks whether this PdfObject is of the type PdfStream.

◆ IsString()

bool wxPdfObject::IsString ( )
inline

Checks whether this is a wxPdfString object.

◆ SetActualId()

void wxPdfObject::SetActualId ( int actualId)
inline

Set actual object id.

◆ SetCreatedIndirect()

void wxPdfObject::SetCreatedIndirect ( bool indirect)
inline

Flag this object as created through a indirect reference.

◆ SetObjNum()

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

Set object and 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: