foxit::pdf::annots::Popup类 参考
类 foxit::pdf::annots::Popup 继承关系图:
Public 成员函数 | |
| Popup () | |
| 构造函数。 | |
| Popup (const Annot &annot) | |
| 构造函数，使用父类对象。 更多... | |
| ~Popup () | |
| 析构函数。 | |
| bool | GetOpenStatus () const |
| 获取打开状态。 更多... | |
| Markup | GetParent () |
| 获取相关的父标记注释。 更多... | |
| void | SetOpenStatus (bool status) |
| 设置打开状态。 更多... | |
 Public 成员函数 继承自 foxit::pdf::annots::Annot | |
| Annot (const PDFPage &page, objects::PDFDictionary *annot_dict) | |
| 构造函数，使用PDF页面和注释的PDF字典。 更多... | |
| Annot (const Annot &annot) | |
| 构造函数，使用另一个注释对象。 更多... | |
| Annot () | |
| 构造函数。 | |
| virtual | ~Annot () |
| 析构函数。 | |
| objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const |
| 获取具有指定类型和状态的注释外观流。 更多... | |
| RGB | GetBorderColor () const |
| 获取边框颜色。 更多... | |
| BorderInfo | GetBorderInfo () const |
| 获取边框信息。 更多... | |
| WString | GetContent () const |
| 获取内容。 更多... | |
| RectI | GetDeviceRect (const Matrix &matrix) |
| 获取设备坐标系统中的注释矩形。 更多... | |
| objects::PDFDictionary * | GetDict () const |
| 获取注释的字典对象。 更多... | |
| Matrix | GetDisplayMatrix (const Matrix &page_display_matrix) |
| 获取显示矩阵，从PDF坐标系统到 目标设备坐标系统。 更多... | |
| uint32 | GetFlags () const |
| 获取注释标志。 更多... | |
| int | GetIndex () const |
| 获取当前注释在其所属页面中的索引。 更多... | |
| DateTime | GetModifiedDateTime () const |
| 获取最后修改日期时间。 更多... | |
| objects::PDFDictionary * | GetOptionalContent () const |
| 获取注释可选内容的PDF字典。 更多... | |
| PDFPage | GetPage () const |
| 获取相关的PDF页面。 更多... | |
| RectF | GetRect () const |
| 获取矩形，以PDF坐标系统表示。 更多... | |
| Type | GetType () const |
| 获取当前注释的实际注释类型。 更多... | |
| WString | GetUniqueID () const |
| 获取唯一ID。 更多... | |
| bool | HasProperty (Property property) const |
| 当前注释是否具有指定的注释属性。 更多... | |
| bool | IsEmpty () const |
| 检查当前对象是否为空。 更多... | |
| bool | IsMarkup () const |
| 检查当前注释是否为标记注释。 更多... | |
| bool | Move (const RectF &rect) |
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多... | |
| bool | Move (const RectF &rect, bool is_reset_appearance) |
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多... | |
| bool | operator != (const Annot &other) const |
| 不等于运算符。 更多... | |
| Annot & | operator= (const Annot &annot) |
| 赋值运算符。 更多... | |
| bool | operator== (const Annot &other) const |
| 等于运算符。 更多... | |
| bool | RemoveProperty (Property property) |
| 删除指定的注释属性。 更多... | |
| bool | ResetAppearanceStream () |
| 重置外观流。 更多... | |
| bool | ResetAppearanceStream (bool is_generate_new_appearance_obj) |
| 重置外观流。 更多... | |
| void | SetBorderColor (RGB color) |
| 设置边框颜色。 更多... | |
| void | SetBorderInfo (const BorderInfo &border) |
| 设置边框信息。 更多... | |
| void | SetContent (const WString &content) |
| 设置内容。 更多... | |
| void | SetFlags (uint32 flags) |
| 设置注释标志。 更多... | |
| void | SetModifiedDateTime (const DateTime &date_time) |
| 设置最后修改日期时间。 更多... | |
| void | SetUniqueID (const WString &unique_id) |
| 设置唯一ID。 更多... | |
| Public 成员函数 继承自 foxit::Base | |
| FS_HANDLE | Handle () const |
| 获取当前对象的句柄。 更多... | |
详细描述
弹出注释在弹出窗口中显示文本以供输入和编辑。它通常不单独出现， 而是与标记注释（其父注释）关联，用于编辑父注释的文本。
类annots::Popup派生自类Annot，还提供获取/设置弹出注释属性的函数。 弹出注释没有自己的外观流或关联的动作，因此函数 Annot::ResetAppearanceStream对于弹出注释总是返回false。
- 参见
- Annot
构造及析构函数说明
◆ Popup()
|
explicit |
构造函数，使用父类对象。
- 参数
-
[in] annot 父类对象。
成员函数说明
◆ GetOpenStatus()
| bool foxit::pdf::annots::Popup::GetOpenStatus | ( | ) | const |
获取打开状态。
打开状态是一个布尔值，指定注释是否应该初始显示为打开状态：
- true表示注释应该初始显示为打开状态。
- false表示注释应该初始显示为关闭状态。
- 返回
- 打开状态。
◆ GetParent()
| Markup foxit::pdf::annots::Popup::GetParent | ( | ) |
获取相关的父标记注释。
- 返回
- 相关的父标记注释。如果返回的标记注释的函数Annot::IsEmpty （从Markup的父类继承）的返回值为true， 则表示当前弹出注释没有标记注释。
◆ SetOpenStatus()
| void foxit::pdf::annots::Popup::SetOpenStatus | ( | bool | status | ) |
设置打开状态。
打开状态是一个布尔值，指定注释是否应该初始显示为打开状态：
- true表示注释应该初始显示为打开状态。
- false表示注释应该初始显示为关闭状态。
- 参数
-
[in] status 新的打开状态值。
- 返回
- 无。
