Foxit PDF SDK

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

## Public 类型
enum | StructTreeEntityType { e_UnknownType = -1, e_StructTreeEntityTypeElement = 0, e_StructTreeEntityTypeMarkedContent = 1, e_StructTreeEntityTypeObjectContent = 2 }
| 结构树实体类型的枚举。 更多...

## Public 成员函数
| 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
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示结构树实体。

## 成员枚举类型说明

## ◆ StructTreeEntityType

enum foxit::pdf::objects::StructTreeEntity::StructTreeEntityType

结构树实体类型的枚举。

此枚举的值应单独使用。

枚举值
e_UnknownType | 结构树实体类型：未知。
e_StructTreeEntityTypeElement | 结构树实体类型：Element，表示结构元素。
e_StructTreeEntityTypeMarkedContent | 结构树实体类型：MarkedContent，表示标记内容项。
e_StructTreeEntityTypeObjectContent | 结构树实体类型：ObjectContent，表示PDF对象内容项， 如注释和XObject。

## 构造及析构函数说明

## ◆ StructTreeEntity()

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

拷贝构造函数。

参数

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

## 成员函数说明

## ◆ GetPage()

PDFPage foxit::pdf::objects::StructTreeEntity::GetPage | ( |  | ) | const

获取相关的PDF页面。

返回
  一个PDF页面对象，它是相关的PDF页面。

## ◆ GetType()

StructTreeEntityType foxit::pdf::objects::StructTreeEntity::GetType | ( |  | ) | const

获取结构树实体类型。

返回
  结构树实体类型。请参考从StructTreeEntity::e_StructTreeEntityTypeElement开始的值， 这将是这些值中的一个。

## ◆ IsEmpty()

bool foxit::pdf::objects::StructTreeEntity::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ operator!=()

bool foxit::pdf::objects::StructTreeEntity::operator!= | ( | const StructTreeEntity & | other | ) | const

不等操作符。

参数

  [in] | other | 另一个结构元素实体对象。此函数将检查当前对象是否不等于此对象。

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

## ◆ operator=()

StructTreeEntity& foxit::pdf::objects::StructTreeEntity::operator= | ( | const StructTreeEntity & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个结构元素实体对象，其值将被赋给当前对象。

返回
  当前对象本身的引用。

## ◆ operator==()

bool foxit::pdf::objects::StructTreeEntity::operator== | ( | const StructTreeEntity & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个结构元素实体对象。此函数将检查当前对象是否等于此对象。

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