foxit::pdf::objects::PDFArray类 参考

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

Public 成员函数
void	AddBoolean (bool boolean_value)
	将布尔值添加到当前PDF数组对象的末尾。 更多...
void	AddDateTime (const DateTime &date_time)
	将日期时间添加到当前PDF数组对象的末尾。 更多...
void	AddElement (PDFObject *element)
	将PDF对象添加到当前PDF数组对象的末尾。 更多...
void	AddFloat (float float_value)
	将浮点数值添加到当前PDF数组对象的末尾。 更多...
void	AddInteger (int integer_value)
	将整数值添加到当前PDF数组对象的末尾。 更多...
void	AddMatrix (const Matrix &matrix)
	将矩阵添加到当前PDF数组对象的末尾。 更多...
void	AddName (const char *name)
	将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。 更多...
void	AddRect (const RectF &rect)
	将矩形添加到当前PDF数组对象的末尾。 更多...
void	AddReference (PDFObject *pdf_object, PDFDoc document)
	将间接PDF对象（其对象编号总是大于0）的引用对象设置为值元素。 更多...
void	AddString (const wchar_t *new_string)
	将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。 更多...
PDFObject *	GetElement (int index) const
	通过索引获取指定的元素。 更多...
int	GetElementCount () const
	获取元素的数量。 更多...
void	InsertAt (int index, PDFObject *element)
	将PDF对象插入到当前PDF数组对象的指定位置。 更多...
void	RemoveAt (int index)
	从当前PDF数组对象中移除指定位置（按索引）的元素。 更多...
void	SetAt (int index, PDFObject *element)
	在当前PDF数组对象的指定位置设置新的PDF对象。 更多...
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 PDFArray *	Create ()
	创建新的数组对象。 更多...
static PDFArray *	CreateFromMatrix (const Matrix &matrix)
	为矩阵创建新的数组对象。 更多...
static PDFArray *	CreateFromRect (const RectF &rect)
	为矩形创建新的数组对象。 更多...
静态 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 Reference 1.7>中的第3.2.5节“数组对象”。
类objects::PDFArray派生自PDFObject，并提供函数来创建新的PDF数组对象以及 获取/设置PDF数组对象的元素。

参见

PDFObject

成员函数说明

AddBoolean()

void foxit::pdf::objects::PDFArray::AddBoolean

(

bool

boolean_value

)

将布尔值添加到当前PDF数组对象的末尾。

参数

[in]

boolean_value

要添加到当前PDF数组对象的布尔值。

返回

无。

AddDateTime()

void foxit::pdf::objects::PDFArray::AddDateTime

(

const DateTime &

date_time

)

将日期时间添加到当前PDF数组对象的末尾。

参数

[in]

date_time

要添加到当前PDF数组对象的日期时间。

返回

无。

AddElement()

void foxit::pdf::objects::PDFArray::AddElement

(

PDFObject *

element

)

将PDF对象添加到当前PDF数组对象的末尾。

参数

[in]

element

要添加到当前PDF数组对象的PDF对象。它不应为NULL。

返回

无。

AddFloat()

void foxit::pdf::objects::PDFArray::AddFloat

(

float

float_value

)

将浮点数值添加到当前PDF数组对象的末尾。

参数

[in]

float_value

要添加到当前PDF数组对象的浮点数值。

返回

无。

AddInteger()

void foxit::pdf::objects::PDFArray::AddInteger

(

int

integer_value

)

将整数值添加到当前PDF数组对象的末尾。

参数

[in]

integer_value

要添加到当前PDF数组对象的整数值。

返回

无。

AddMatrix()

void foxit::pdf::objects::PDFArray::AddMatrix

(

const Matrix &

matrix

)

将矩阵添加到当前PDF数组对象的末尾。

参数

[in]

matrix

要添加到当前PDF数组对象的矩阵。

返回

无。

AddName()

void foxit::pdf::objects::PDFArray::AddName

(

const char *

name

)

将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。

参数

[in]

name

要作为PDF名称对象添加到当前PDF数组对象的字符串。 它不应为空字符串。

返回

无。

AddRect()

void foxit::pdf::objects::PDFArray::AddRect

(

const RectF &

rect

)

将矩形添加到当前PDF数组对象的末尾。

参数

[in]

rect

要添加到当前PDF数组对象的矩形。

返回

无。

AddReference()

void foxit::pdf::objects::PDFArray::AddReference	(	PDFObject *	pdf_object,
		PDFDoc	document
	)

将间接PDF对象（其对象编号总是大于0）的引用对象设置为值元素。

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

参数

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

返回

无。

AddString()

void foxit::pdf::objects::PDFArray::AddString

(

const wchar_t *

new_string

)

将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。

参数

[in]

new_string

要作为PDF字符串对象添加到当前PDF数组对象的字符串。 它不应为空字符串。

返回

无。

Create()

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

static

创建新的数组对象。

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

返回

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

CreateFromMatrix()

static PDFArray* foxit::pdf::objects::PDFArray::CreateFromMatrix ( const Matrix &  matrix )

static

为矩阵创建新的数组对象。

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

参数

[in]

matrix

一个矩阵。

返回

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

CreateFromRect()

static PDFArray* foxit::pdf::objects::PDFArray::CreateFromRect ( const RectF &  rect )

static

为矩形创建新的数组对象。

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

参数

[in]

rect

一个矩形。

返回

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

GetElement()

PDFObject* foxit::pdf::objects::PDFArray::GetElement

(

int

index

)

const

通过索引获取指定的元素。

参数

[in]

index

要检索的元素的索引。有效范围：从0到(count-1)。 count由函数PDFArray::GetElementCount返回。

返回

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

GetElementCount()

int foxit::pdf::objects::PDFArray::GetElementCount

(

)

const

获取元素的数量。

返回

元素数量。

InsertAt()

void foxit::pdf::objects::PDFArray::InsertAt	(	int	index,
		PDFObject *	element
	)

将PDF对象插入到当前PDF数组对象的指定位置。

参数

[in]	index	参数element将被插入到的位置的索引。 有效范围：从0到(count-1)。 count由函数PDFArray::GetElementCount返回。 如果小于0或当前PDF数组中的元素数量为0， 参数element将被插入到第一个位置。 如果大于当前PDF数组中的元素数量， 参数element将被添加到末尾。
[in]	element	要插入到当前PDF数组对象的PDF对象。它不应为NULL。

返回

无。

RemoveAt()

void foxit::pdf::objects::PDFArray::RemoveAt

(

int

index

)

从当前PDF数组对象中移除指定位置（按索引）的元素。

参数

[in]

index

将被移除的元素的位置的索引。 有效范围：从0到(count-1)。 count由函数PDFArray::GetElementCount返回。

返回

无。

SetAt()

void foxit::pdf::objects::PDFArray::SetAt	(	int	index,
		PDFObject *	element
	)

在当前PDF数组对象的指定位置设置新的PDF对象。

参数

[in]	index	参数element将被设置到的位置的索引。 有效范围：从0到(count-1)。 count由函数PDFArray::GetElementCount返回。
[in]	element	要设置到当前PDF数组对象的PDF对象。它不应为NULL。

返回

无。