类 foxit::pdf::objects::PDFDictionary 继承关系图:

Public 成员函数
PDFObject *	GetElement (const char *key) const
	获取具有指定键的条目的值元素。更多...

String	GetKey (POSITION position) const
	获取由位置指定的条目的键。更多...

PDFObject *	GetValue (POSITION position) const
	获取由位置指定的条目的值元素。更多...

bool	HasKey (const char *key) const
	检查当前字典中是否存在具有指定键的条目。更多...

POSITION	MoveNext (POSITION position)
	移动到第一个或下一个条目的位置。更多...

void	RemoveAt (const char *key)
	移除由键指定的条目。更多...

void	SetAt (const char key, PDFObject pdf_object)
	将直接PDF对象（其对象编号总是等于0）作为值元素设置到由键指定的条目。更多...

void	SetAtBoolean (const char *key, bool value)
	将布尔元素设置到由键指定的条目。更多...

void	SetAtDateTime (const char *key, const DateTime &value)
	将Datetime对象作为值元素设置到由键指定的条目。更多...

void	SetAtFloat (const char *key, float value)
	将浮点数元素设置到由键指定的条目。更多...

void	SetAtInteger (const char *key, int value)
	将整数元素设置到由键指定的条目。更多...

void	SetAtMatrix (const char *key, const Matrix &value)
	将矩阵对象作为值元素设置到由键指定的条目。更多...

void	SetAtName (const char key, const char value)
	将字符串（作为PDF名称对象）作为值元素设置到由键指定的条目。更多...

void	SetAtRect (const char *key, const RectF &value)
	将矩形对象作为值元素设置到由键指定的条目。更多...

void	SetAtReference (const char key, PDFObject pdf_object, PDFDoc document)
	将间接PDF对象（其对象编号总是大于0）的引用对象作为值元素设置到由键指定的条目。更多...

void	SetAtString (const char key, const char value)
	将字符串作为值元素设置到由键指定的条目。更多...

void	SetAtString (const char key, const wchar_t value)
	将字符串作为值元素设置到由键指定的条目。更多...

Public 成员函数继承自 foxit::pdf::objects::PDFObject
PDFObject *	CloneObject () const
	克隆当前PDF对象并获取克隆的PDF对象。更多...

PDFObject *	DeepCloneObject () const
	克隆当前PDF对象并获取克隆的PDF对象。更多...

PDFArray *	GetArray ()
	获取当前PDF对象的PDF数组对象。更多...

bool	GetBoolean () const
	获取当前PDF对象的布尔值。更多...

DateTime	GetDateTime () const
	获取当前PDF对象的日期时间值。更多...

PDFDictionary *	GetDict ()
	获取当前PDF对象的PDF字典对象。更多...

PDFObject *	GetDirectObject () const
	获取当前PDF对象的直接对象。更多...

float	GetFloat () const
	获取当前PDF对象的浮点数值。更多...

int	GetInteger () const
	获取当前PDF对象的整数值。更多...

Matrix	GetMatrix () const
	获取当前PDF对象的矩阵值。更多...

String	GetName () const
	获取当前PDF对象的名称值。更多...

uint32	GetObjNum () const
	获取当前PDF对象的间接对象编号。更多...

RectF	GetRect () const
	获取当前PDF对象的矩形值。更多...

PDFStream *	GetStream ()
	获取当前PDF对象的PDF流对象。更多...

String	GetString () const
	获取当前PDF对象的字符串值。更多...

Type	GetType () const
	获取当前PDF对象的类型。更多...

WString	GetWideString () const
	获取当前PDF对象的宽字符串值。更多...

bool	IsIdentical (PDFObject *pdf_obj) const
	检查输入的PDF对象是否与当前PDF对象相同。更多...

void	Release ()
	释放新创建的PDF对象或克隆PDF对象，该对象与PDF文档或其他PDF对象无关且不会再使用。更多...

静态 Public 成员函数
static PDFDictionary *	Create ()
	创建新的字典对象。更多...

静态 Public 成员函数继承自 foxit::pdf::objects::PDFObject
static PDFObject *	CreateFromBoolean (bool boolean_value)
	从布尔值创建PDF对象。更多...

static PDFObject *	CreateFromDateTime (const DateTime &date_time)
	从日期时间创建PDF对象。更多...

static PDFObject *	CreateFromFloat (float float_value)
	从浮点数创建PDF对象。更多...

static PDFObject *	CreateFromInteger (int integer_value)
	Create a PDF object from a integer number. 更多...

static PDFObject *	CreateFromName (const char *name)
	从表示名称的字符串创建PDF对象。更多...

static PDFObject *	CreateFromNameW (const wchar_t *name)
	从表示名称的字符串创建PDF对象。更多...

static PDFObject *	CreateFromString (const wchar_t *string_value)
	从字符串创建PDF对象。更多...

static PDFObject *	CreateFromString (const wchar_t *string_value, int length)
	从字符串创建PDF对象。更多...

static PDFObject *	CreateReference (PDFDoc document, uint32 object_number)
	为间接对象创建引用。更多...

额外继承的成员函数
Public 类型继承自 foxit::pdf::objects::PDFObject
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 }
	PDF对象类型的枚举。更多...

详细描述

PDF字典对象是一个关联表，包含成对的对象，称为字典的条目。每个条目的第一个元素是键，它必须是一个PDF名称对象。第二个元素是值，它可以是任何种类的PDF对象，包括另一个字典。在同一个字典中，不应有两个条目具有相同的键。有关更多详细信息，请参阅<PDF Reference 1.7>中的第3.2.6节“字典对象”。
类objects::PDFDictionary派生自PDFObject，并提供函数来创建新的PDF字典对象以及获取/设置PDF字典对象中的条目。

参见: PDFObject

成员函数说明

◆ Create()

static PDFDictionary* foxit::pdf::objects::PDFDictionary::Create ( )

static

创建新的字典对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数PDFObject::Release来释放该对象。

返回: 一个新的PDFDictionary对象。如果有任何错误，此函数将返回NULL。

◆ GetElement()

PDFObject* foxit::pdf::objects::PDFDictionary::GetElement ( const char * key ) const

获取具有指定键的条目的值元素。

参数

[in] key 条目的键。它不应为空字符串。

返回: 一个PDFObject对象，接收具有指定键的值。如果未找到，此函数将返回NULL。

◆ GetKey()

String foxit::pdf::objects::PDFDictionary::GetKey ( POSITION position ) const

获取由位置指定的条目的键。

参数

[in] position 指定条目位置的POSITION。它不应为NULL或0。

返回: 指定条目的键。

◆ GetValue()

PDFObject* foxit::pdf::objects::PDFDictionary::GetValue ( POSITION position ) const

获取由位置指定的条目的值元素。

参数

[in] position 指定条目位置的POSITION。它不应为NULL或0。

返回: 一个PDFObject，接收指定条目的值元素。如果有任何错误，此函数将返回NULL。

◆ HasKey()

bool foxit::pdf::objects::PDFDictionary::HasKey ( const char * key ) const

检查当前字典中是否存在具有指定键的条目。

参数

[in] key 要检查的键。它不应为空字符串。

返回: true表示指定的键存在于当前字典中，而false表示不存在。

◆ MoveNext()

POSITION foxit::pdf::objects::PDFDictionary::MoveNext ( POSITION position )

移动到第一个或下一个条目的位置。

参数

[in] position 一个POSITION，指示字典中当前条目的位置。如果为NULL或0，将返回字典中第一个条目的位置。

返回: 一个POSITION，表示字典中下一个条目的位置。 NULL或0表示当前条目是字典中的最后一个。

◆ RemoveAt()

void foxit::pdf::objects::PDFDictionary::RemoveAt ( const char * key )

移除由键指定的条目。

参数

[in] key 要移除的条目的键。它不应为空字符串。

返回: 无。

◆ SetAt()

void foxit::pdf::objects::PDFDictionary::SetAt	(	const char *	key,
		PDFObject *	pdf_object
	)

将直接PDF对象（其对象编号总是等于0）作为值元素设置到由键指定的条目。

如果用户想要将间接PDF对象（其对象编号总是大于0）设置到条目，请参考函数PDFDictionary::SetAtReference。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	pdf_object	一个PDFObject对象，它是一个直接PDF对象（其对象编号总是等于0），将被设置到条目。它不应为NULL。

返回: 无。

◆ SetAtBoolean()

void foxit::pdf::objects::PDFDictionary::SetAtBoolean	(	const char *	key,
		bool	value
	)

将布尔元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的布尔元素。

返回: 无。

◆ SetAtDateTime()

void foxit::pdf::objects::PDFDictionary::SetAtDateTime	(	const char *	key,
		const DateTime &	value
	)

将Datetime对象作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的日期时间信息。

返回: 无。

◆ SetAtFloat()

void foxit::pdf::objects::PDFDictionary::SetAtFloat	(	const char *	key,
		float	value
	)

将浮点数元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的浮点数值。

返回: 无。

◆ SetAtInteger()

void foxit::pdf::objects::PDFDictionary::SetAtInteger	(	const char *	key,
		int	value
	)

将整数元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的整数值。

返回: 无。

◆ SetAtMatrix()

void foxit::pdf::objects::PDFDictionary::SetAtMatrix	(	const char *	key,
		const Matrix &	value
	)

将矩阵对象作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的矩阵。

返回: 无。

◆ SetAtName()

void foxit::pdf::objects::PDFDictionary::SetAtName	(	const char *	key,
		const char *	value
	)

将字符串（作为PDF名称对象）作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将作为PDF名称对象设置到条目的字符串。它不应为空字符串。

返回: 无。

◆ SetAtRect()

void foxit::pdf::objects::PDFDictionary::SetAtRect	(	const char *	key,
		const RectF &	value
	)

将矩形对象作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的矩形。

返回: 无。

◆ SetAtReference()

void foxit::pdf::objects::PDFDictionary::SetAtReference	(	const char *	key,
		PDFObject *	pdf_object,
		PDFDoc	document
	)

将间接PDF对象（其对象编号总是大于0）的引用对象作为值元素设置到由键指定的条目。

如果用户想要将直接PDF对象（其对象编号总是等于0）设置到条目，请参考函数PDFDictionary::SetAt。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	pdf_object	一个PDFObject对象，它是一个间接PDF对象（其对象编号总是大于0），将通过引用此间接对象的引用对象设置到条目。它不应为NULL。
[in]	document	一个有效的PDF文档对象，当前PDF字典对象属于该文档，且参数pdf_object是或将是其中的间接对象。

返回: 无。

◆ SetAtString() [1/2]

void foxit::pdf::objects::PDFDictionary::SetAtString	(	const char *	key,
		const char *	value
	)

将字符串作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将作为PDF字符串对象设置到条目的字符串。

返回: 无。

注解: 如果要获取字符串值，请调用函数PDFObject::GetString。

◆ SetAtString() [2/2]

void foxit::pdf::objects::PDFDictionary::SetAtString	(	const char *	key,
		const wchar_t *	value
	)

将字符串作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将作为PDF字符串对象设置到条目的宽字符串。

返回: 无。

注解: 如果要获取字符串值，请调用函数PDFObject::GetWideString。

Public 成员函数

静态 Public 成员函数

额外继承的成员函数

详细描述

成员函数说明

◆ Create()

◆ GetElement()

◆ GetKey()

◆ GetValue()

◆ HasKey()

◆ MoveNext()

◆ RemoveAt()

◆ SetAt()

◆ SetAtBoolean()

◆ SetAtDateTime()

◆ SetAtFloat()

◆ SetAtInteger()

◆ SetAtMatrix()

◆ SetAtName()

◆ SetAtRect()

◆ SetAtReference()

◆ SetAtString() [1/2]

◆ SetAtString() [2/2]