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

Public 成员函数
	Outline (const Outline &other)
	构造函数，通过另一个大纲对象。更多...

	~Outline ()
	析构函数。

Outline	AddOutline ()
	添加子大纲。更多...

void	EnableExpanded (bool expanded)
	设置是否展开。更多...

Action	GetAction ()
	获取动作对象。更多...

ActionDestinationInfo	GetDestination ()
	获取目标信息对象。更多...

Outline	GetOutline (int index)
	获取指定索引的子大纲对象。更多...

int	GetOutlineCount ()
	获取子大纲的数量。更多...

String	GetTitle ()
	获取标题。更多...

String	GetURI ()
	获取uri。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	operator != (const Outline &other) const
	不相等操作符。更多...

Outline &	operator= (const Outline &other)
	赋值操作符。更多...

bool	operator== (const Outline &other) const
	相等操作符。更多...

bool	RemoveOutline (int index)
	删除指定索引的子大纲。更多...

void	SetDestination (int page_index, float x, float y)
	设置跳转目标到指定页面和位置。更多...

void	SetTitle (const String &title)
	设置标题。更多...

void	SetURI (const String &uri)
	设置URI。更多...

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

详细描述

此类表示和OFD大纲相关的操作。

构造及析构函数说明

◆ Outline()

foxit::ofd::Outline::Outline ( const Outline & other )

构造函数，通过另一个大纲对象。

参数

[in] other 另一个大纲对象。

成员函数说明

◆ AddOutline()

Outline foxit::ofd::Outline::AddOutline ( )

添加子大纲。

返回: 新添加的子大纲对象。

◆ EnableExpanded()

void foxit::ofd::Outline::EnableExpanded ( bool expanded )

设置是否展开。

参数

[in] expanded 是否展开。

返回: 无。

◆ GetAction()

Action foxit::ofd::Outline::GetAction ( )

获取动作对象。

返回: 动作对象。

◆ GetDestination()

ActionDestinationInfo foxit::ofd::Outline::GetDestination ( )

获取目标信息对象。

返回: 目标信息对象。详见 foxit::ofd::ActionDestinationInfo 。

◆ GetOutline()

Outline foxit::ofd::Outline::GetOutline ( int index )

获取指定索引的子大纲对象。

参数

[in] index 指定的子大纲索引，有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Outline::GetOutlineCount 返回。

返回: 指定索引的子大纲对象。

◆ GetOutlineCount()

int foxit::ofd::Outline::GetOutlineCount ( )

获取子大纲的数量。

返回: 子大纲的数量。

◆ GetTitle()

String foxit::ofd::Outline::GetTitle ( )

获取标题。

返回: 标题值。

◆ GetURI()

String foxit::ofd::Outline::GetURI ( )

获取uri。

返回: uri值。

◆ IsEmpty()

bool foxit::ofd::Outline::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ operator !=()

bool foxit::ofd::Outline::operator != ( const Outline & other ) const

不相等操作符。

参数

[in] other 另一个大纲对象。此函数将检查当前对象是否不等于这个对象。

返回: true 表示不相等，false 表示相等。

◆ operator=()

Outline& foxit::ofd::Outline::operator= ( const Outline & other )

赋值操作符。

参数

[in] other 另一个大纲对象，其值将被赋给当前对象。

返回: 当前对象自身的引用。

◆ operator==()

bool foxit::ofd::Outline::operator== ( const Outline & other ) const

相等操作符。

参数

[in] other 另一个大纲对象。此函数将检查当前对象是否等于这个对象。

返回: true 表示相等，false 表示不相等。

◆ RemoveOutline()

bool foxit::ofd::Outline::RemoveOutline ( int index )

删除指定索引的子大纲。

参数

[in] index 指定的子大纲索引，有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Outline::GetOutlineCount 返回。

返回: true 表示删除成功，false 表示删除失败。

◆ SetDestination()

void foxit::ofd::Outline::SetDestination	(	int	page_index,
		float	x,
		float	y
	)

设置跳转目标到指定页面和位置。

参数

[in]	page_index	目标页面索引（从0开始）。
[in]	x	目标位置的X坐标。
[in]	y	目标位置的Y坐标。

返回: 无。

◆ SetTitle()

void foxit::ofd::Outline::SetTitle ( const String & title )

设置标题。

参数

[in] title 标题值。

返回: 无。

◆ SetURI()

void foxit::ofd::Outline::SetURI ( const String & uri )

设置URI。

参数

[in] uri URI值。

返回: 无。

Public 成员函数

详细描述

构造及析构函数说明

◆ Outline()

成员函数说明

◆ AddOutline()

◆ EnableExpanded()

◆ GetAction()

◆ GetDestination()

◆ GetOutline()

◆ GetOutlineCount()

◆ GetTitle()

◆ GetURI()

◆ IsEmpty()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ RemoveOutline()

◆ SetDestination()

◆ SetTitle()

◆ SetURI()