Foxit PDF SDK
foxit::pdf::objects::PDFStructTree类 参考
类 foxit::pdf::objects::PDFStructTree 继承关系图:
foxit::Base

Public 成员函数

 PDFStructTree (const PDFDoc &document)
 带参数的构造函数。 更多...
 
 PDFStructTree (const PDFStructTree &other)
 拷贝构造函数。 更多...
 
 ~PDFStructTree ()
 析构函数。
 
StructElement GetChild (int index) const
 通过索引获取结构元素。 更多...
 
int GetChildCount () const
 获取当前PDF结构树中结构元素的数量。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const PDFStructTree &other) const
 不等操作符。 更多...
 
PDFStructTreeoperator= (const PDFStructTree &other)
 赋值操作符。 更多...
 
bool operator== (const PDFStructTree &other) const
 相等操作符。 更多...
 
void RemoveChild (int index)
 通过索引删除结构元素。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

PDF结构树是标记PDF文档中的一种常见数据结构。结构树用于 表示文档内容的组织和层次结构。 PDF结构树具有以下特点:

  • PDF结构树也是一个层次结构,顶部节点表示 整个文档,较低的节点表示页面、段落、标题和其他元素。
  • PDF结构树包含有关文档内容的语义信息, 例如标题、段落、表格和列表。此信息用于增强文档的可访问性 和可用性,以及优化其显示和打印;

PDFStructTree用于与现有的PDF结构树关联。 它提供了在PDF结构树中获取结构元素的函数。

构造及析构函数说明

◆ PDFStructTree() [1/2]

foxit::pdf::objects::PDFStructTree::PDFStructTree ( const PDFDoc document)

带参数的构造函数。

如果PDF文档中存在PDF结构树, 此函数只是构造一个PDF结构树对象以与该结构树关联。

参数
[in]document有效的PDF文档对象。

◆ PDFStructTree() [2/2]

foxit::pdf::objects::PDFStructTree::PDFStructTree ( const PDFStructTree other)

拷贝构造函数。

参数
[in]other另一个PDF结构树对象。

成员函数说明

◆ GetChild()

StructElement foxit::pdf::objects::PDFStructTree::GetChild ( int  index) const

通过索引获取结构元素。

参数
[in]index要检索的结构元素的索引。有效范围:从0到(count-1)。 count由函数PDFStructTree::GetChildCount返回。
返回
一个StructElement对象。

◆ GetChildCount()

int foxit::pdf::objects::PDFStructTree::GetChildCount ( ) const

获取当前PDF结构树中结构元素的数量。

返回
结构元素数量。

◆ IsEmpty()

bool foxit::pdf::objects::PDFStructTree::IsEmpty ( ) const

检查当前对象是否为空。

当当前对象为空时,这意味着当前对象无用。

返回
true表示当前对象为空,而false表示不为空。

◆ operator !=()

bool foxit::pdf::objects::PDFStructTree::operator != ( const PDFStructTree other) const

不等操作符。

参数
[in]other另一个PDF结构树对象。此函数将检查当前对象是否不等于此对象。
返回
true表示不相等,而false表示相等。

◆ operator=()

PDFStructTree& foxit::pdf::objects::PDFStructTree::operator= ( const PDFStructTree other)

赋值操作符。

参数
[in]other另一个PDF结构树对象,其值将被赋给当前对象。
返回
当前对象本身的引用。

◆ operator==()

bool foxit::pdf::objects::PDFStructTree::operator== ( const PDFStructTree other) const

相等操作符。

参数
[in]other另一个PDF结构树对象。此函数将检查当前对象是否等于此对象。
返回
true表示相等,而false表示不相等。

◆ RemoveChild()

void foxit::pdf::objects::PDFStructTree::RemoveChild ( int  index)

通过索引删除结构元素。

参数
[in]index要检索的结构元素的索引。有效范围:从0到(count-1)。 count由函数PDFStructTree::GetChildCount返回。
返回
无。