Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::objects::StructElement类 参考
类 foxit::pdf::objects::StructElement 继承关系图:

## Public 类型
enum | ElementInfoType { e_ElementInfoTypeTitle = 0, e_ElementInfoTypeLanguage = 1, e_ElementInfoTypeAltDescription = 2, e_ElementInfoTypeExpandedForm = 3, e_ElementInfoTypeActualText = 4 }
| 结构元素信息类型的枚举。 更多...
Public 类型 继承自 foxit::pdf::objects::StructTreeEntity
enum | StructTreeEntityType { e_UnknownType = -1, e_StructTreeEntityTypeElement = 0, e_StructTreeEntityTypeMarkedContent = 1, e_StructTreeEntityTypeObjectContent = 2 }
| 结构树实体类型的枚举。 更多...

## Public 成员函数
| StructElement ()
| 构造函数。
| StructElement (const StructElement &other)
| 拷贝构造函数。 更多...
| StructElement (const StructTreeEntity &other)
| 构造函数，从另一个结构树实体对象构造。 更多...
| ~StructElement ()
| 析构函数。
StructTreeEntity | GetChild (int index)
| 通过索引获取子结构树实体。 更多...
int | GetChildCount () const
| 获取当前结构元素中子结构树实体的数量。 更多...
WString | GetElementInfo (ElementInfoType type) const
| 获取结构元素信息。 更多...
StructElement | GetParentElement ()
| 获取父结构元素。 更多...
String | GetStructureTypeName () const
| 获取结构类型名称。 更多...
bool | HasElementInfo (ElementInfoType type) const
| 检查特定类型的结构元素信息是否存在。 更多...
void | RemoveChild (int index)
| 通过索引删除子结构树实体。 更多...
Public 成员函数 继承自 foxit::pdf::objects::StructTreeEntity
| StructTreeEntity ()
| 构造函数。
| StructTreeEntity (const StructTreeEntity &other)
| 拷贝构造函数。 更多...
| ~StructTreeEntity ()
| 析构函数。
PDFPage | GetPage () const
| 获取相关的PDF页面。 更多...
StructTreeEntityType | GetType () const
| 获取结构树实体类型。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const StructTreeEntity &other) const
| 不等操作符。 更多...
StructTreeEntity & | operator= (const StructTreeEntity &other)
| 赋值操作符。 更多...
bool | operator== (const StructTreeEntity &other) const
| 相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示结构元素。

## 成员枚举类型说明

## ◆ ElementInfoType

enum foxit::pdf::objects::StructElement::ElementInfoType

结构元素信息类型的枚举。

此枚举的值应单独使用。

枚举值
e_ElementInfoTypeTitle | 结构元素信息类型：Title，表示结构元素的标题。以人类可读形式表示的文本字符串。
e_ElementInfoTypeLanguage | 结构元素信息类型：Language，表示结构元素中所有文本的 自然语言，除非被嵌套结构元素或标记内容的语言规范覆盖。
e_ElementInfoTypeAltDescription | 结构元素信息类型：Alternative Description，表示结构元素的替代描述。
e_ElementInfoTypeExpandedForm | 结构元素信息类型：Expanded Form，表示结构元素的扩展形式。
e_ElementInfoTypeActualText | 结构元素信息类型：Actual Text，表示结构元素的实际文本。

## 构造及析构函数说明

## ◆ StructElement() [1/2]

foxit::pdf::objects::StructElement::StructElement | ( | const StructElement & | other | ) |

拷贝构造函数。

参数

  [in] | other | 另一个结构元素对象。

## ◆ StructElement() [2/2]

foxit::pdf::objects::StructElement::StructElement | ( | const StructTreeEntity & | other | ) |

构造函数，从另一个结构树实体对象构造。

参数

  [in] | other | 另一个结构树实体对象。

## 成员函数说明

## ◆ GetChild()

StructTreeEntity foxit::pdf::objects::StructElement::GetChild | ( | int | index | ) |

通过索引获取子结构树实体。

参数

  [in] | index | 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数StructElement::GetChildCount返回。

返回
  一个子结构树实体对象。

## ◆ GetChildCount()

int foxit::pdf::objects::StructElement::GetChildCount | ( |  | ) | const

获取当前结构元素中子结构树实体的数量。

返回
  子结构树实体的数量。

## ◆ GetElementInfo()

WString foxit::pdf::objects::StructElement::GetElementInfo | ( | ElementInfoType | type | ) | const

获取结构元素信息。

在获取结构元素信息之前，请确保已调用函数StructElement::HasElementInfo 并返回true（使用相应的类型）。

参数

  [in] | type | 结构元素信息类型。请参考从StructElement::e_ElementInfoTypeTitle开始的值， 这应该是这些值中的一个。

返回
  结构元素信息字符串。

## ◆ GetParentElement()

StructElement foxit::pdf::objects::StructElement::GetParentElement | ( |  | ) |

获取父结构元素。

返回
  父结构元素。如果返回对象的函数StructElement::IsEmpty返回true， 这意味着当前元素没有父元素。

## ◆ GetStructureTypeName()

String foxit::pdf::objects::StructElement::GetStructureTypeName | ( |  | ) | const

获取结构类型名称。

每个结构元素都应该有一个结构类型，这是一个名称对象，用于标识 结构元素的性质及其在文档中的角色（例如章节、段落或脚注）。 有关更多详细信息，请参考<PDF Reference 1.7>第10.7.3节中对"标准结构类型"的描述或 <PDF Reference 2.0>第14.8.4节中对"标准结构类型"的描述。

返回
  表示当前结构元素的结构类型名称的字符串。

## ◆ HasElementInfo()

bool foxit::pdf::objects::StructElement::HasElementInfo | ( | ElementInfoType | type | ) | const

检查特定类型的结构元素信息是否存在。

参数

  [in] | type | 结构元素信息类型。请参考从StructElement::e_ElementInfoTypeTitle开始的值， 这应该是这些值中的一个。

返回
  true表示元素信息类型有元素信息， 而false表示元素信息类型没有元素信息。

## ◆ RemoveChild()

void foxit::pdf::objects::StructElement::RemoveChild | ( | int | index | ) |

通过索引删除子结构树实体。

参数

  [in] | index | 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数StructElement::GetChildCount返回。

返回
  无。