Foxit PDF SDK
foxit::pdf::objects::PDFObject Class Reference
Inheritance diagram for foxit::pdf::objects::PDFObject:
foxit::pdf::objects::PDFArray foxit::pdf::objects::PDFDictionary foxit::pdf::objects::PDFStream

Public Types

enum  Type {
  e_InvalidType = 0, e_Boolean = 1, e_Number = 2, e_String = 3,
  e_Name = 4, e_Array = 5, e_Dictionary = 6, e_Stream = 7,
  e_Null = 8, e_Reference = 9
}
 Enumeration for PDF object type. More...
 

Public Member Functions

PDFObjectCloneObject () const
 Clone current PDF object and get the cloned PDF object. More...
 
PDFObjectDeepCloneObject () const
 Clone current PDF object and get the cloned PDF object. More...
 
PDFArrayGetArray ()
 Get the PDF array object of current PDF object. More...
 
bool GetBoolean () const
 Get the boolean value of current PDF object. More...
 
DateTime GetDateTime () const
 Get the date time value of current PDF object. More...
 
PDFDictionaryGetDict ()
 Get the PDF dictionary object of current PDF object. More...
 
PDFObjectGetDirectObject () const
 Get the direct object of current PDF object. More...
 
float GetFloat () const
 Get the float value of current PDF object. More...
 
int GetInteger () const
 Get the integer value of current PDF object. More...
 
Matrix GetMatrix () const
 Get the matrix value of current PDF object. More...
 
String GetName () const
 Get the name value of current PDF object. More...
 
uint32 GetObjNum () const
 Get the indirect object number of current PDF object. More...
 
RectF GetRect () const
 Get the rectangle value of current PDF object. More...
 
PDFStreamGetStream ()
 Get the PDF stream object of current PDF object. More...
 
String GetString () const
 Get the string value of current PDF object. More...
 
Type GetType () const
 Get the type of current PDF object. More...
 
WString GetWideString () const
 Get the wide string value of current PDF object. More...
 
bool IsIdentical (PDFObject *pdf_obj) const
 Check if input PDF object is identical with current PDF object. More...
 
void Release ()
 Release a newly created PDF object or a clone PDF object, which is not related to PDF document or other PDF object and will not be used any more. More...
 

Static Public Member Functions

static PDFObjectCreateFromBoolean (bool boolean_value)
 Create a PDF object from a boolean value. More...
 
static PDFObjectCreateFromDateTime (const DateTime &date_time)
 Create a PDF object from date time. More...
 
static PDFObjectCreateFromFloat (float float_value)
 Create a PDF object from a float number. More...
 
static PDFObjectCreateFromInteger (int integer_value)
 Create a PDF object from a integer number. More...
 
static PDFObjectCreateFromName (const char *name)
 Create a PDF object from a string which represents a name. More...
 
static PDFObjectCreateFromString (const wchar_t *string_value)
 Create a PDF object from string. More...
 
static PDFObjectCreateReference (PDFDoc document, uint32 object_number)
 Create a reference for an indirect object. More...
 

Detailed Description

PDF supports eight basic types of objects:
"Boolean value", "Integer and real number", "String", "Name", "Array", "Dictionary", "Stream", "The null object". For more details about PDF objects, please refer to Section 3.2 "Objects" in <PDF Reference 1.7>.
Class PDFObject is a base class for all kinds of PDF objects. It offers different functions to create different kind of PDF objects. For "Array", "Dictionary" and "Stream" PDF object, please refer to derived classes objects::PDFArray, objects::PDFDictionary and PDFStream.
If user wants to make a newly created PDF object to be an indirect object, please call function pdf::PDFDoc::AddIndirectObject.

See also
PDFArray
PDFDictionary
PDFStream
pdf::PDFDoc

Member Enumeration Documentation

◆ Type

Enumeration for PDF object type.

Values of this enumeration should be used alone.

Enumerator
e_InvalidType 

Invalid PDF object type.

e_Boolean 

PDF boolean object.

e_Number 

PDF number object.

e_String 

PDF string object.

e_Name 

PDF name object.

e_Array 

PDF array object.

e_Dictionary 

PDF dictionary object.

e_Stream 

PDF stream object.

e_Null 

PDF null object.

e_Reference 

PDF reference object.

Member Function Documentation

◆ CloneObject()

PDFObject* foxit::pdf::objects::PDFObject::CloneObject ( ) const

Clone current PDF object and get the cloned PDF object.

Please call PDFObject::Release to release the new object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Returns
A new PDFObject object as the clone result. If there is any error, this function will return NULL.

◆ CreateFromBoolean()

static PDFObject* foxit::pdf::objects::PDFObject::CreateFromBoolean ( bool  boolean_value)
static

Create a PDF object from a boolean value.

Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]boolean_valueA boolean value.
Returns
A new PDFObject object, whose object type is PDFObject::e_Boolean. If there is any error, this function will return NULL.

◆ CreateFromDateTime()

static PDFObject* foxit::pdf::objects::PDFObject::CreateFromDateTime ( const DateTime date_time)
static

Create a PDF object from date time.

PDF defines a standard date format, which closely follows that of the international standard ASN.1 (Abstract Syntax Notation One), defined in ISO/ IEC 8824 (see the Bibliography). A date is defined as an ASCII string of the form (D:YYYYMMDDHHmmSSOHH'mm'). Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]date_timeA date and time object.
Returns
A new PDFObject object, whose object type is PDFObject::e_String. If there is any error, this function will return NULL.

◆ CreateFromFloat()

static PDFObject* foxit::pdf::objects::PDFObject::CreateFromFloat ( float  float_value)
static

Create a PDF object from a float number.

Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]float_valueA float value.
Returns
A new PDFObject object, whose object type is PDFObject::e_Number. If there is any error, this function will return NULL.

◆ CreateFromInteger()

static PDFObject* foxit::pdf::objects::PDFObject::CreateFromInteger ( int  integer_value)
static

Create a PDF object from a integer number.

Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]integer_valueAn integer value.
Returns
A new PDFObject object, whose object type is PDFObject::e_Number. If there is any error, this function will return NULL.

◆ CreateFromName()

static PDFObject* foxit::pdf::objects::PDFObject::CreateFromName ( const char *  name)
static

Create a PDF object from a string which represents a name.

Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]nameA string. It should not be an empty string.
Returns
A new PDFObject object, whose object type is PDFObject::e_Name. If there is any error, this function will return NULL.

◆ CreateFromString()

static PDFObject* foxit::pdf::objects::PDFObject::CreateFromString ( const wchar_t *  string_value)
static

Create a PDF object from string.

Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]string_valueA string. It should not be an empty string.
Returns
A PDFObject object, whose object type is PDFObject::e_String. If there is any error, this function will return NULL.

◆ CreateReference()

static PDFObject* foxit::pdf::objects::PDFObject::CreateReference ( PDFDoc  document,
uint32  object_number 
)
static

Create a reference for an indirect object.

The indirect object can be retrieved by following methods:

Please call function PDFObject::Release to release the created object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Parameters
[in]documentA valid PDF document object.
[in]object_numberThe indirect object number of the indirect PDF object. This should be above 0.
Returns
A new PDFObject object, whose object type is PDFObject::e_Reference. If there is any error, this function will return NULL.

◆ DeepCloneObject()

PDFObject* foxit::pdf::objects::PDFObject::DeepCloneObject ( ) const

Clone current PDF object and get the cloned PDF object.

This function is a totally direct copy, without any reference object inside, so the copy object can be copied to another document. Please call PDFObject::Release to release the new object if it has not been added/set into PDF document or other PDF object and will not be used any more.

Returns
A new PDFObject object as the clone result. If there is any error, this function will return NULL.

◆ GetArray()

PDFArray* foxit::pdf::objects::PDFObject::GetArray ( )

Get the PDF array object of current PDF object.

If the type of current PDF object is PDFObject::e_Reference, this function will check the direct PDF object of current PDF object.

Returns
A PDF array object. If current PDF object or the direct PDF object is not a PDF array, NULL will be returned.

◆ GetBoolean()

bool foxit::pdf::objects::PDFObject::GetBoolean ( ) const

Get the boolean value of current PDF object.

Only useful when the type of current PDF object is PDFObject::e_Boolean.

Returns
The boolean value. For PDF object in other type, false will be returned.

◆ GetDateTime()

DateTime foxit::pdf::objects::PDFObject::GetDateTime ( ) const

Get the date time value of current PDF object.

Only useful when the type of current PDF objec is PDFObject::e_String and its content is in PDF standard date format.

Returns
The data time information. If there is any error or current object is in other type, an empty date and time object will be returned.

◆ GetDict()

PDFDictionary* foxit::pdf::objects::PDFObject::GetDict ( )

Get the PDF dictionary object of current PDF object.

If the type of current PDF object is PDFObject::e_Reference, this function will check the direct PDF object of current PDF object.

Returns
A PDF dictionary object. If current PDF object or the direct PDF object is not a PDF dictionary, NULL will be returned.

◆ GetDirectObject()

PDFObject* foxit::pdf::objects::PDFObject::GetDirectObject ( ) const

Get the direct object of current PDF object.

If the type of current PDF object is PDFObject::e_Reference, the direct object will be returned.

Returns
The direct PDF object. For PDF object in other type, this function will return current PDF object itself. If there is any error, this function will return NULL.

◆ GetFloat()

float foxit::pdf::objects::PDFObject::GetFloat ( ) const

Get the float value of current PDF object.

Only useful when the type of current PDF object is PDFObject::e_Number.

Returns
The float value. For PDF object in other type, 0.0f will be returned.

◆ GetInteger()

int foxit::pdf::objects::PDFObject::GetInteger ( ) const

Get the integer value of current PDF object.

Only useful when the type of current PDF object is PDFObject::e_Number.

Returns
The integer value. For PDF object in other type, 0 will be returned.

◆ GetMatrix()

Matrix foxit::pdf::objects::PDFObject::GetMatrix ( ) const

Get the matrix value of current PDF object.

Only useful for PDF object whose type is PDFObject::e_Array and it has 6 number objects as elements.

Returns
A matrix. If there is any error or current object is in other type, a matrix with value [0 0 0 0 0 0] will be returned.

◆ GetName()

String foxit::pdf::objects::PDFObject::GetName ( ) const

Get the name value of current PDF object.

Only useful when the type of current PDF object is PDFObject::e_Name or PDFObject::e_String.

Returns
A string that represents the value. If there is any error or current object is in other type, an empty string will be returned.

◆ GetObjNum()

uint32 foxit::pdf::objects::PDFObject::GetObjNum ( ) const

Get the indirect object number of current PDF object.

Returns
The indirect object number. It would be:
  • 0 if current PDF object is a direct object.
  • above 0 if current PDF object is an indirect object.
  • -1 means there is any error.

◆ GetRect()

RectF foxit::pdf::objects::PDFObject::GetRect ( ) const

Get the rectangle value of current PDF object.

Only useful for PDF object whose type is PDFObject::e_Array and it has 4 number objects as elements.

Returns
A rectangle. If there is any error or current object is in other type, a rectangle with value [0 0 0 0] will be returned.

◆ GetStream()

PDFStream* foxit::pdf::objects::PDFObject::GetStream ( )

Get the PDF stream object of current PDF object.

If the type of current PDF object is PDFObject::e_Reference, this function will check the direct PDF object of current PDF object.

Returns
A PDF stream object. If current PDF object or the direct PDF object is not a PDF stream, NULL will be returned.

◆ GetString()

String foxit::pdf::objects::PDFObject::GetString ( ) const

Get the string value of current PDF object.

This function will get the string format for actual value of current PDF object:

  • If object type is PDFObject::e_Boolean, "true" or "false" string value will be returned, depending on its actual value.
  • If object type is PDFObject::e_Number, the value will be represents as a string. For example, "1.5" string is for value 1.5.
  • If object type is PDFObject::e_String, the string value will be retrieved directly.

If value of current PDF object cannot be converted to a valid string, an empty string will be returned.

Returns
A string.

◆ GetType()

Type foxit::pdf::objects::PDFObject::GetType ( ) const

Get the type of current PDF object.

Returns
PDF object type. Please refer to values starting from PDFObject::e_Boolean and this would be one of these values.

◆ GetWideString()

WString foxit::pdf::objects::PDFObject::GetWideString ( ) const

Get the wide string value of current PDF object.

This function will get the string format for actual value of current PDF object:

  • If object type is PDFObject::e_Boolean, "true" or "false" string value will be returned, depending on its actual value.
  • If object type is PDFObject::e_Number, the value will be represents as a string. For example, "1.5" string is for value 1.5.
  • If object type is PDFObject::e_String, the string value will be retrieved directly.

If value of current PDF object cannot be converted to a valid string, an empty string will be returned.

Returns
A string.

◆ IsIdentical()

bool foxit::pdf::objects::PDFObject::IsIdentical ( PDFObject pdf_obj) const

Check if input PDF object is identical with current PDF object.

Parameters
[in]pdf_objAnother PDF object which is to be check with current PDF object.
Returns
true means input PDF object is identical with current PDF object, while false means input PDF object is not identical with current PDF object.

◆ Release()

void foxit::pdf::objects::PDFObject::Release ( )

Release a newly created PDF object or a clone PDF object, which is not related to PDF document or other PDF object and will not be used any more.

This function should be called only for a newly created PDF object or a cloned PDF object, which has not been added or set to other PDF object or related to PDF document, and will not be used any more. Please do not use this function for other case, otherwise unknown error may occur.

Returns
None.