foxit::pdf::LayerTree类 参考

类 foxit::pdf::LayerTree 继承关系图:

Public 类型
enum	UsageState { e_StateON = 0x0000, e_StateOFF = 0x0001, e_StateUnchanged = 0x0002, e_StateUndefined = 0x0003 }
	PDF图层基础状态的枚举。 更多...

Public 成员函数
	LayerTree (const PDFDoc &document)
	从PDF文档构造的构造函数。 更多...
	LayerTree (const LayerTree &other)
	拷贝构造函数。 更多...
	~LayerTree ()
	析构函数。
objects::PDFDictionary *	GetDict () const
	获取当前对象的字典。 更多...
objects::PDFArray *	GetOCGs () const
	从当前对象获取"OCGs" PDF数组。 更多...
LayerNodeArray	GetOCGsByPageIndex (int page_index)
	获取在指定页面上找到的OCG对象数组。 更多...
LayerNode	GetRootNode ()
	获取根图层节点。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	operator != (const LayerTree &other) const
	不等于运算符。 更多...
LayerTree &	operator= (const LayerTree &other)
	赋值运算符。 更多...
bool	operator== (const LayerTree &other) const
	等于运算符。 更多...
bool	SetBaseState (UsageState state)
	为默认配置中的所有图层设置基础状态。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。 更多...

详细描述

PDF图层节点存储在PDF图层树中。如果用户想要检索图层节点，用户必须首先从PDF文档 构造一个图层树对象，然后调用函数 LayerTree::GetRootNode 获取 整个图层树的根图层节点。然后，用户可以从根图层节点枚举图层树中的所有节点。

参见

LayerNode

成员枚举类型说明

UsageState

enum foxit::pdf::LayerTree::UsageState

PDF图层基础状态的枚举。

此枚举的值应单独使用。

枚举值
e_StateON	状态为开启。
e_StateOFF	状态为关闭。
e_StateUnchanged	状态为未改变。
e_StateUndefined	状态为未定义。

构造及析构函数说明

LayerTree() [1/2]

foxit::pdf::LayerTree::LayerTree ( const PDFDoc &  document )

explicit

从PDF文档构造的构造函数。

构造的图层树对象可以与PDF文档中存在的图层树关联。 如果PDF文档中没有图层树（可以通过函数 PDFDoc::HasLayer 判断）， 构造的图层树对象将构建图层相关的字典。

参数

[in]

document

有效的PDF文档对象。

LayerTree() [2/2]

foxit::pdf::LayerTree::LayerTree

(

const LayerTree &

other

)

拷贝构造函数。

参数

[in]

other

另一个图层树对象。

成员函数说明

GetDict()

objects::PDFDictionary* foxit::pdf::LayerTree::GetDict

(

)

const

获取当前对象的字典。

注解

请参考<PDF Reference 1.7> P375中的"Optional Content Properties Dictionary"了解更多详情。

返回

当前对象的字典。如果有任何错误，此函数将返回NULL。

GetOCGs()

objects::PDFArray* foxit::pdf::LayerTree::GetOCGs

(

)

const

从当前对象获取"OCGs" PDF数组。

注解

请参考<PDF Reference 1.7> P375中的"Optional Content Properties Dictionary"了解更多详情。

返回

"OCGs" PDF数组。 如果没有"OCGs"条目或发生任何错误，此函数将返回NULL。

GetOCGsByPageIndex()

LayerNodeArray foxit::pdf::LayerTree::GetOCGsByPageIndex

(

int

page_index

)

获取在指定页面上找到的OCG对象数组。

参数

[in]

page_index

要检索的子项的页面索引。有效范围：从0到(数量-1)。 数量由函数 PDFDoc::GetPageCount 返回。

返回

图层节点数组对象。

GetRootNode()

LayerNode foxit::pdf::LayerTree::GetRootNode

(

)

获取根图层节点。

获取根图层节点后，用户可以通过LayerNode类的函数 枚举当前图层树中的所有图层节点。

返回

根图层节点。

IsEmpty()

bool foxit::pdf::LayerTree::IsEmpty

(

)

const

检查当前对象是否为空。

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

返回

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

operator !=()

bool foxit::pdf::LayerTree::operator !=

(

const LayerTree &

other

)

const

不等于运算符。

参数

[in]

other

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

返回

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

operator=()

LayerTree& foxit::pdf::LayerTree::operator=

(

const LayerTree &

other

)

赋值运算符。

参数

[in]

other

另一个图层树对象，其值将被赋给当前对象。

返回

对当前对象本身的引用。

operator==()

bool foxit::pdf::LayerTree::operator==

(

const LayerTree &

other

)

const

等于运算符。

参数

[in]

other

另一个图层树对象。此函数将检查当前对象是否等于这个对象。

返回

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

SetBaseState()

bool foxit::pdf::LayerTree::SetBaseState

(

UsageState

state

)

为默认配置中的所有图层设置基础状态。

如果用户希望新状态对渲染结果生效，请在此函数成功后构造一个新的图层上下文对象， 然后使用新的LayerContext来渲染器进行渲染。

参数

[in]

state

图层用途状态。请参考从 LayerTree::e_StateON 开始的值， 应该是这些值中的一个，除了 LayerTree::e_StateUndefined。

返回

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