foxit::pdf::annots::Note类 参考
类 foxit::pdf::annots::Note 继承关系图:
Public 成员函数 | |
| Note () | |
| 构造函数。 | |
| Note (const Annot &annot) | |
| 构造函数，使用父类对象。 更多... | |
| ~Note () | |
| 析构函数。 | |
| String | GetIconName () const |
| 获取图标名称。 更多... | |
| bool | GetOpenStatus () const |
| 获取开放状态。 更多... | |
| Markup | GetReplyTo () |
| 获取当前注记注释回复的标记注释。 更多... | |
| State | GetState () |
| 获取状态。 更多... | |
| StateModel | GetStateModel () |
| 获取状态模型。 更多... | |
| bool | IsStateAnnot () |
| 检查当前注记注释是否用作状态注释。 更多... | |
| void | SetIconName (const char *icon_name) |
| 设置图标名称。 更多... | |
| void | SetOpenStatus (bool status) |
| 设置开放状态。 更多... | |
| void | SetState (State state) |
| 设置状态。 更多... | |
 Public 成员函数 继承自 foxit::pdf::annots::Markup | |
| Markup (const Annot &annot) | |
| 构造函数，使用父类对象。 更多... | |
| Markup () | |
| 构造函数 | |
| ~Markup () | |
| 析构函数。 | |
| Note | AddReply () |
| 在回复列表的末尾添加新回复。 更多... | |
| void | AddRichText (const WString &content, const RichTextStyle &style) |
| 在末尾添加新的富文本字符串。 更多... | |
| Note | AddStateAnnot (const WString &title, StateModel model, State state) |
| 添加新的状态注释。 更多... | |
| float | GetBorderOpacity () const |
| 获取注释的边框透明度。 更多... | |
| DateTime | GetCreationDateTime () const |
| 获取创建日期时间。 更多... | |
| float | GetFillOpacity () const |
| 获取注释的填充透明度。 更多... | |
| MarkupArray | GetGroupElements () |
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多... | |
| Markup | GetGroupHeader () |
| 获取当前标记注释所属组的头注释（作为主注释）。 更多... | |
| String | GetIntent () const |
| 获取意图名称。 更多... | |
| float | GetOpacity () const |
| 获取不透明度值。 更多... | |
| Popup | GetPopup () |
| 获取相关的弹出注释。 更多... | |
| Note | GetReply (int index) const |
| 按索引获取回复。 更多... | |
| int | GetReplyCount () |
| 计算所有回复。 更多... | |
| WString | GetRichTextContent (int32 index) |
| 获取指定索引的富文本字符串的文本字符串。 更多... | |
| int32 | GetRichTextCount () |
| 获取富文本字符串的数量。 更多... | |
| RichTextStyle | GetRichTextStyle (int32 index) |
| 获取指定索引的富文本字符串的样式数据。 更多... | |
| NoteArray | GetStateAnnots (StateModel model) |
| 获取指定状态模型中的所有状态注释。 更多... | |
| WString | GetSubject () const |
| 获取主题字符串。 更多... | |
| WString | GetTitle () const |
| 获取标题字符串。 更多... | |
| void | InsertRichText (int32 index, const WString &content, const RichTextStyle &style) |
| 在指定索引位置插入新的富文本字符串。 更多... | |
| bool | IsGrouped () |
| 检查当前标记注释是否在组中。 更多... | |
| bool | RemoveAllReplies () |
| 删除所有回复。 更多... | |
| bool | RemoveAllStateAnnots () |
| 移除所有状态注释。 更多... | |
| bool | RemovePopup () |
| 删除相关的弹出注释。 更多... | |
| bool | RemoveReply (int index) |
| 按索引删除回复。 更多... | |
| void | RemoveRichText (int index) |
| 移除指定索引的富文本字符串。 更多... | |
| void | SetBorderOpacity (float opacity) |
| 设置注释的边框透明度。 更多... | |
| void | SetCreationDateTime (const DateTime &date_time) |
| 设置创建日期时间。 更多... | |
| void | SetFillOpacity (float opacity) |
| 设置注释的填充透明度。 更多... | |
| void | SetIntent (const String &intent) |
| 设置意图名称。 更多... | |
| void | SetOpacity (float opacity) |
| 设置不透明度值。 更多... | |
| void | SetPopup (const Popup &popup) |
| 设置相关的弹出注释。 更多... | |
| void | SetRichTextContent (int32 index, const WString &content) |
| 设置指定索引的富文本字符串的文本字符串。 更多... | |
| void | SetRichTextStyle (int32 index, const RichTextStyle &style) |
| 设置指定索引的富文本字符串的样式数据。 更多... | |
| void | SetSubject (const WString &subject) |
| 设置主题字符串。 更多... | |
| void | SetTitle (const WString &title) |
| 设置标题字符串。 更多... | |
| bool | Ungroup () |
| 将当前标记注释从其所属的组中解组。 更多... | |
| 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 |
| 获取当前对象的句柄。 更多... | |
详细描述
注记注释（在<PDF参考1.7>中称为"文本"注释）表示附加到PDF文档中某个点的"便签"。 当关闭时，注释显示为图标；当打开时，它显示一个弹出窗口，其中包含由查看器应用程序选择的字体和大小的注记文本。
注记注释也可以用作标记注释的回复或状态注释：
- 当作为回复时，注记注释不应单独显示，而应与其他回复一起以线程评论的形式显示。 函数 Note::GetReplyTo 可用于获取注记注释回复的标记注释。
- 当作为状态时，注记注释不会单独显示。函数 Note::IsStateAnnot 可用于判断注记注释是否用作状态。
注记注释是一种标记注释，因此类Note派生自 类Markup。它提供获取/设置注记注释属性和 重置注记注释外观的函数。
- 注解
- 对于新创建的普通注记注释，如果用户直接调用函数Annot::ResetAppearanceStream 而不设置任何属性，将使用默认外观：
边框颜色 = 0xFFFFFF00（黄色），不透明度 = 1.0，图标名称 = "Comment"。
- 参见
- Markup
构造及析构函数说明
◆ Note()
|
explicit |
构造函数，使用父类对象。
- 参数
-
[in] annot 父类对象。
成员函数说明
◆ GetIconName()
| String foxit::pdf::annots::Note::GetIconName | ( | ) | const |
获取图标名称。
此属性对便签注释的外观有影响。便签注释具有预定义的标准图标 名称：
"Check"、"Circle"、"Comment"、"Cross"、"Help"、"Insert"、"Key"、"NewParagraph"、"Note"、"Paragraph"、 "RightArrow"、"RightPointer"、"Star"、"UpArrow"、"UpLeftArrow"。
空的图标名称字符串表示当前便签注释将被视为"Note"图标。
- 返回
- 图标名称字符串。
◆ GetOpenStatus()
| bool foxit::pdf::annots::Note::GetOpenStatus | ( | ) | const |
获取开放状态。
开放状态是一个布尔值，指定注记注释是否应初始显示为打开状态：
- true 表示注记注释应初始显示为打开状态。
- false 表示注记注释应初始显示为关闭状态。
- 返回
- 开放状态。
◆ GetReplyTo()
| Markup foxit::pdf::annots::Note::GetReplyTo | ( | ) |
获取当前注记注释回复的标记注释。
此函数仅在当前注记注释用作回复时有用。
- 返回
- 当前注记注释回复的标记注释对象。 如果返回的标记注释对象的函数 Annot::IsEmpty（从 Markup 的父类继承） 的返回值为 true，则表示当前注记注释不用作回复。
◆ GetState()
| State foxit::pdf::annots::Note::GetState | ( | ) |
获取状态。
此函数只能在当前注记注释用作状态注释时使用。 函数 Note::IsStateAnnot 可用于检查当前注记注释是否用作状态注释。
- 返回
- 状态。请参考从 Markup::e_StateMarked 开始的值， 这将是这些值中的一个。 如果当前注记注释不是状态注释，此函数将返回 0。
◆ GetStateModel()
| StateModel foxit::pdf::annots::Note::GetStateModel | ( | ) |
获取状态模型。
此函数只能在当前注记注释用作状态注释时使用。 函数 Note::IsStateAnnot 可用于检查当前注记注释是否用作状态注释。
- 返回
- 状态模型。如果函数成功，返回值将是 Markup::e_StateModelMarked 或 Markup::e_StateModelReview。
如果当前注记注释不是状态注释，此函数将返回 0。
◆ IsStateAnnot()
| bool foxit::pdf::annots::Note::IsStateAnnot | ( | ) |
检查当前注记注释是否用作状态注释。
- 返回
- true 表示当前注记注释用作状态注释， false 表示当前注记注释只是普通的注记注释。
◆ SetIconName()
| void foxit::pdf::annots::Note::SetIconName | ( | const char * | icon_name | ) |
设置图标名称。
此属性对便签注释的外观有影响。便签注释具有预定义的标准图标 名称：
"Check"、"Circle"、"Comment"、"Cross"、"Help"、"Insert"、"Key"、"NewParagraph"、"Note"、"Paragraph"、 "RightArrow"、"RightPointer"、"Star"、"UpArrow"、"UpLeftArrow"。
空的图标名称字符串表示当前便签注释将被视为"Note"图标。
对于新创建的便签注释，如果未调用当前函数，图标名称默认为 "Comment"。
如果用户希望新的图标名称对注释的外观有影响，请在设置新图标名称后调用函数 Annot::ResetAppearanceStream。
- 参数
-
[in] icon_name 要设置的新图标名称字符串。
- 返回
- 无。
◆ SetOpenStatus()
| void foxit::pdf::annots::Note::SetOpenStatus | ( | bool | status | ) |
设置开放状态。
开放状态是一个布尔值，指定注记注释是否应初始显示为打开状态：
- true 表示注记注释应初始显示为打开状态。
- false 表示注记注释应初始显示为关闭状态。
- 参数
-
[in] status 新的开放状态值。
- 返回
- 无。
◆ SetState()
| void foxit::pdf::annots::Note::SetState | ( | State | state | ) |
设置状态。
此函数只能在当前注记注释用作状态注释时使用。 函数 Note::IsStateAnnot 可用于检查当前注记注释是否用作状态注释。
- 参数
-
[in] state 新状态。应为以下值之一： - 如果状态模型是 Markup::e_StateModelMarked， 状态应为 Markup::e_StateMarked 或 Markup::e_StateUnmarked。
- 如果状态模型是 Markup::e_StateModelReview， 状态应为 Markup::e_StateAccepted、Markup::e_StateRejected、 Markup::e_StateCancelled、Markup::e_StateCompleted、 Markup::e_StateDeferred、Markup::e_StateFuture 或 Markup::e_StateNone。
- 返回
- 无。
