wxPdfDocument 1.2.0
Public Member Functions | List of all members
wxPdfDictionary Class Reference

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

#include <pdfobjects.h>

Inheritance diagram for wxPdfDictionary:
wxPdfObject

Public Member Functions

 wxPdfDictionary ()
 Constructor.
 
 wxPdfDictionary (const wxString &type)
 Constructor.
 
virtual ~wxPdfDictionary ()
 Destructor.
 
void Put (wxPdfName *key, wxPdfObject *value)
 Add a (name,value) pair to the dictionary.
 
void Put (const wxString &key, wxPdfObject *value)
 Add a (name,value) pair to the dictionary.
 
wxPdfObjectGet (const wxString &key)
 Get the value identified by the given key.
 
wxPdfDictionaryMap * GetHashMap ()
 Get the dictionary map.
 
- Public Member Functions inherited from wxPdfObject
 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.
 

Additional Inherited Members

- Protected Attributes inherited from wxPdfObject
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 dictionary object. (For internal use only)

Constructor & Destructor Documentation

◆ wxPdfDictionary() [1/2]

wxPdfDictionary::wxPdfDictionary ( )

Constructor.

◆ wxPdfDictionary() [2/2]

wxPdfDictionary::wxPdfDictionary ( const wxString & type)

Constructor.

◆ ~wxPdfDictionary()

virtual wxPdfDictionary::~wxPdfDictionary ( )
virtual

Destructor.

Member Function Documentation

◆ Get()

wxPdfObject * wxPdfDictionary::Get ( const wxString & key)

Get the value identified by the given key.

◆ GetHashMap()

wxPdfDictionaryMap * wxPdfDictionary::GetHashMap ( )
inline

Get the dictionary map.

◆ Put() [1/2]

void wxPdfDictionary::Put ( const wxString & key,
wxPdfObject * value )

Add a (name,value) pair to the dictionary.

◆ Put() [2/2]

void wxPdfDictionary::Put ( wxPdfName * key,
wxPdfObject * value )

Add a (name,value) pair to the dictionary.


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