foxit::ofd::Catalog类 参考

类 foxit::ofd::Catalog 继承关系图:

Public 类型
enum	CatalogPositionType { e_CatalogPositionTypeFirstPage = 0, e_CatalogPositionTypeSecondPage = 1 }
	OFD目录位置类型定义枚举类型。 更多...

Public 成员函数
	Catalog ()
	构造函数。
	Catalog (const Catalog &other)
	构造函数，通过另一个目录对象。 更多...
	~Catalog ()
	析构函数。
bool	AddAttachment (const Attachments &attachments)
	添加附件对象目录。 更多...
bool	AddItemInfo (const String &title, int page_count)
	添加目录项信息。 更多...
bool	AddItemInfo (const String &title, int page_count, float x, float y)
	添加目录项信息。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	operator != (const Catalog &other) const
	不相等操作符。 更多...
Catalog &	operator= (const Catalog &other)
	赋值操作符。 更多...
bool	operator== (const Catalog &other) const
	相等操作符。 更多...
void	SetFormat (int section, const String &font_name, float font_size, float lower_space)
	设置目录格式。 更多...
void	SetMargin (float x_margin, float y_margin)
	设置目录边距。 更多...
void	SetPosition (CatalogPositionType type)
	设置目录位置。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。 更多...

详细描述

此类表示和OFD目录相关的操作。

成员枚举类型说明

CatalogPositionType

enum foxit::ofd::Catalog::CatalogPositionType

OFD目录位置类型定义枚举类型。

该枚举值应单独使用。

枚举值
e_CatalogPositionTypeFirstPage	目录位置：在第一页前新增一页作为目录页。
e_CatalogPositionTypeSecondPage	目录位置：在第二页前新增一页作为目录页。

构造及析构函数说明

Catalog()

foxit::ofd::Catalog::Catalog

(

const Catalog &

other

)

构造函数，通过另一个目录对象。

参数

[in]

other

另一个目录对象。

成员函数说明

AddAttachment()

bool foxit::ofd::Catalog::AddAttachment

(

const Attachments &

attachments

)

添加附件对象目录。

参数

[in]

attachments

附件对象。

返回

true 表示成功，false 表示失败。

AddItemInfo() [1/2]

bool foxit::ofd::Catalog::AddItemInfo	(	const String &	title,
		int	page_count
	)

添加目录项信息。

参数

[in]	title	目录项标题。
[in]	page_count	目录项对应的页码。

返回

true 表示成功，false 表示失败。

AddItemInfo() [2/2]

bool foxit::ofd::Catalog::AddItemInfo	(	const String &	title,
		int	page_count,
		float	x,
		float	y
	)

添加目录项信息。

参数

[in]	title	目录项标题。
[in]	page_count	目录项对应的页码。
[in]	x	目录项对应页码的X坐标，单位为毫米。
[in]	y	目录项对应页码的Y坐标，单位为毫米。

返回

true 表示成功，false 表示失败。

IsEmpty()

bool foxit::ofd::Catalog::IsEmpty

(

)

const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回

true 表示当前对象为空，false 表示不为空。

operator !=()

bool foxit::ofd::Catalog::operator !=

(

const Catalog &

other

)

const

不相等操作符。

参数

[in]

other

另一个目录对象。此函数将检查当前对象是否不等于这个对象。

返回

true 表示不相等，false 表示相等。

operator=()

Catalog& foxit::ofd::Catalog::operator=

(

const Catalog &

other

)

赋值操作符。

参数

[in]

other

另一个目录对象，其值将被赋给当前对象。

返回

当前对象自身的引用。

operator==()

bool foxit::ofd::Catalog::operator==

(

const Catalog &

other

)

const

相等操作符。

参数

[in]

other

另一个目录对象。此函数将检查当前对象是否等于这个对象。

返回

true 表示相等，false 表示不相等。

SetFormat()

void foxit::ofd::Catalog::SetFormat	(	int	section,
		const String &	font_name,
		float	font_size,
		float	lower_space
	)

设置目录格式。

参数

[in]	section	章节号，从0开始。
[in]	font_name	字体名称。
[in]	font_size	字体大小，单位为毫米。
[in]	lower_space	行间距，单位为毫米。

返回

无。

SetMargin()

void foxit::ofd::Catalog::SetMargin	(	float	x_margin,
		float	y_margin
	)

设置目录边距。

参数

[in]	x_margin	横向边距，单位为毫米。
[in]	y_margin	纵向边距，单位为毫米。

返回

无。

SetPosition()

void foxit::ofd::Catalog::SetPosition

(

CatalogPositionType

type

)

设置目录位置。

参数

[in]

type

目录位置类型。请参考从 foxit::ofd::Catalog::e_CatalogPositionTypeFirstPage 开始的值， 这应该是这些值中的一个。

返回

无。