Foxit PDF SDK

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

## Public 成员函数
| Screen ()
| 构造函数。
| Screen (const Annot &annot)
| 构造函数，使用父类对象。 更多...
virtual | ~Screen ()
| 析构函数。
actions::Action | GetAction ()
| 获取动作。 更多...
common::Bitmap | GetBitmap ()
| 从当前屏幕注释获取位图。 更多...
pdf::objects::PDFDictionary * | GetMKDict () const
| 获取外观特征字典（也称为"MK"字典）。 更多...
float | GetOpacity () const
| 获取不透明度值。 更多...
common::Rotation | GetRotation ()
| 获取用于当前屏幕注释外观的图像旋转。 更多...
WString | GetTitle () const
| 获取当前屏幕注释的标题。 更多...
void | RemoveAction ()
| 移除动作。 更多...
void | SetAction (const actions::Action &action)
| 设置动作。 更多...
void | SetImage (const common::Image &image, int frame_index, int compress)
| 为当前屏幕注释设置图像，使用指定的帧索引。 更多...
void | SetMKDict (pdf::objects::PDFDictionary *dict)
| 设置外观特征字典（也称为"MK"字典）。 更多...
void | SetOpacity (float opacity)
| 设置不透明度值。 更多...
void | SetRotation (common::Rotation rotate)
| 设置用于当前屏幕注释外观的图像旋转。 更多...
void | SetTitle (const WString &title)
| 设置当前屏幕注释的标题。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Annot
| Annot ()
| 构造函数。
| Annot (const Annot &annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot (const PDFPage &page, objects::PDFDictionary *annot_dict)
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
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
| 获取当前对象的句柄。 更多...

## 额外继承的成员函数
Public 类型 继承自 foxit::pdf::annots::Annot
enum | AppearanceType { e_AppearanceTypeNormal = 0, e_AppearanceTypeRollover = 1, e_AppearanceTypeDown = 2 }
| 注释外观类型的枚举。 更多...
enum | Flags { e_FlagInvisible = 0x0001, e_FlagHidden = 0x0002, e_FlagPrint = 0x0004, e_FlagNoZoom = 0x0008, e_FlagNoRotate = 0x0010, e_FlagNoView = 0x0020, e_FlagReadOnly = 0x0040, e_FlagLocked = 0x0080, e_FlagToggleNoView = 0x0100, e_FlagLockedContents = 0x0200 }
| PDF注释标志的枚举。 更多...
enum | HighlightingMode { e_HighlightingNone = 0, e_HighlightingInvert = 1, e_HighlightingOutline = 2, e_HighlightingPush = 3, e_HighlightingToggle = 4 }
| PDF注释高亮模式的枚举。 更多...
enum | MKEntry { e_MKEntryRotation = 0, e_MKEntryBorderColor = 1, e_MKEntryBackgroundColor = 2, e_MKEntryNormalCaption = 3, e_MKEntryRolloverCaption = 4, e_MKEntryDownCaption = 5, e_MKEntryNormalIcon = 6, e_MKEntryRolloverIcon = 7, e_MKEntryDownIcon = 8, e_MKEntryIconFit = 9, e_MKEntryIconCaptionRelation = 10 }
| 注释MK字典（外观特征）条目的枚举。 更多...
enum | MKIconCaptionRelation { e_MKRelationNoIcon = 0, e_MKRelationNoCaption = 1, e_MKRelationCaptionBelowIcon = 2, e_MKRelationCaptionAboveIcon = 3, e_MKRelationCaptionRight = 4, e_MKRelationCaptionLeft = 5, e_MKRelationCaptionOvrlayOnIcon = 6 }
| 注释MK字典中图标和标题相对位置的枚举。 更多...
enum | Property { e_PropertyModifiedDate = 0, e_PropertyCreationDate = 1, e_PropertyBorderColor = 2, e_PropertyFillColor = 3 }
| 某些PDF注释属性的枚举。 更多...
enum | Type { e_UnknownType = 0, e_Note = 1, e_Link = 2, e_FreeText = 3, e_Line = 4, e_Square = 5, e_Circle = 6, e_Polygon = 7, e_PolyLine = 8, e_Highlight = 9, e_Underline = 10, e_Squiggly = 11, e_StrikeOut = 12, e_Stamp = 13, e_Caret = 14, e_Ink = 15, e_PSInk = 16, e_FileAttachment = 17, e_Sound = 18, e_Movie = 19, e_Widget = 20, e_Screen = 21, e_PrinterMark = 22, e_TrapNet = 23, e_Watermark = 24, e_3D = 25, e_Popup = 26, e_Redact = 27, e_RichMedia = 28, e_PagingSeal = 29 }
| PDF注释类型的枚举。 更多...

## 详细描述

屏幕注释指定页面上可以播放媒体剪辑的区域。它还作为可以触发动作的对象。 通常，演出动作被设置给屏幕注释，以便屏幕注释可以用于播放媒体剪辑。
类annots::Screen派生自Annot，并提供获取/设置链接注释属性和 重置屏幕注释外观流的函数。屏幕注释的外观流用于打印（如果可能） 以及当相关媒体剪辑未播放时。

注解
  对于新创建的屏幕注释，它没有边框信息和边框颜色。

参见
  Annot

## 构造及析构函数说明

## ◆ Screen()

foxit::pdf::annots::Screen::Screen | ( | const Annot & | annot | ) |
| explicit

构造函数，使用父类对象。

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ GetAction()

actions::Action foxit::pdf::annots::Screen::GetAction | ( |  | ) |

获取动作。

此函数不能用于获取用作附加动作的动作。 如果用户想要获取任何附加动作，请参考类actions::AdditionalAction了解更多详细信息。

返回
  接收动作数据的动作对象。如果返回的动作对象的函数 actions::Action::IsEmpty的返回值为true，那意味着没有动作。

## ◆ GetBitmap()

common::Bitmap foxit::pdf::annots::Screen::GetBitmap | ( |  | ) |

从当前屏幕注释获取位图。

返回
  位图对象。如果返回的位图对象的函数common::Bitmap::IsEmpty 的返回值为true，那意味着当前屏幕注释没有位图。

## ◆ GetMKDict()

pdf::objects::PDFDictionary* foxit::pdf::annots::Screen::GetMKDict | ( |  | ) | const

获取外观特征字典（也称为"MK"字典）。

如果此字典未设置给屏幕注释（包括当前注释）， 请调用函数objects::PDFObject::Release （从objects::PDFDictionary的父类继承）来释放它。

返回
  表示"MK"字典的PDF字典。 如果没有"MK"条目或发生任何错误，此函数将返回NULL。

## ◆ GetOpacity()

float foxit::pdf::annots::Screen::GetOpacity | ( |  | ) | const

获取不透明度值。

此属性对注释的外观有影响。

返回
  不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

## ◆ GetRotation()

common::Rotation foxit::pdf::annots::Screen::GetRotation | ( |  | ) |

获取用于当前屏幕注释外观的图像旋转。

返回
  图像的旋转值。请参考从common::e_Rotation0开始的值， 这将是这些值中的一个。

## ◆ GetTitle()

WString foxit::pdf::annots::Screen::GetTitle | ( |  | ) | const

获取当前屏幕注释的标题。

返回
  标题字符串。

## ◆ RemoveAction()

void foxit::pdf::annots::Screen::RemoveAction | ( |  | ) |

移除动作。

此函数不能用于移除用作附加动作的动作。 如果用户想要移除任何附加动作，请参考类actions::AdditionalAction了解更多详细信息。

返回
  无。

## ◆ SetAction()

void foxit::pdf::annots::Screen::SetAction | ( | const actions::Action & | action | ) |

设置动作。

此函数不能用于设置用作附加动作的动作。 如果用户想要设置任何附加动作，请参考类actions::AdditionalAction了解更多详细信息。

参数

  [in] | action | 要设置的新动作。它应该是有效的。 目前只支持以下类型作为新动作： actions::Action::e_TypeGoto、 actions::Action::e_TypeURI、 actions::Action::e_TypeJavaScript、 actions::Action::e_TypeNamed、 actions::Action::e_TypeGoToR、 actions::Action::e_TypeGoToE、 actions::Action::e_TypeSubmitForm、 actions::Action::e_TypeResetForm、 actions::Action::e_TypeHide、 actions::Action::e_TypeLaunch、 actions::Action::e_TypeImportData、 actions::Action::e_TypeRendition。

返回
  无。

## ◆ SetImage()

void foxit::pdf::annots::Screen::SetImage | ( | const common::Image & | image,
|  | int | frame_index,
|  | int | compress
| ) |  |

为当前屏幕注释设置图像，使用指定的帧索引。

输入图像可能包含多个帧，只有图像的一个帧可以设置给当前屏幕注释。
如果用户希望效果显示在注释的外观中，请在此函数后调用函数 Annot::ResetAppearanceStream。

参数

  [in] | image | 图像。其中一个帧将被设置给当前屏幕。 此图像至少包含一个帧，且图像类型不应为 common::Image::e_Unknown。
  [in] | frame_index | 帧索引。有效范围：从0到（count-1）。 count由函数common::Image::GetFrameCount返回。
  [in] | compress | 用于压缩图像数据的压缩算法类型。 目前，它只支持2个有效值： 0：不压缩。 1：执行默认压缩。

返回
  无。

## ◆ SetMKDict()

void foxit::pdf::annots::Screen::SetMKDict | ( | pdf::objects::PDFDictionary * | dict | ) |

设置外观特征字典（也称为"MK"字典）。

参数

  [in] | dict | 表示要设置的新"MK"字典的PDF字典。 用户在将其设置给屏幕注释后不应释放此字典。

## ◆ SetOpacity()

void foxit::pdf::annots::Screen::SetOpacity | ( | float | opacity | ) |

设置不透明度值。

此属性对注释的外观有影响。如果用户希望效果显示在注释的外观中， 请在此函数后调用函数Annot::ResetAppearanceStream。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回
  无。

## ◆ SetRotation()

void foxit::pdf::annots::Screen::SetRotation | ( | common::Rotation | rotate | ) |

设置用于当前屏幕注释外观的图像旋转。

此属性对注释的外观有影响。如果用户希望效果显示在注释的外观中， 请在此函数后调用函数Annot::ResetAppearanceStream。

参数

  [in] | rotate | 旋转值。请参考从common::e_Rotation0开始的值， 这应该是这些值中的一个，除了common::e_RotationUnknown。

返回
  无。

## ◆ SetTitle()

void foxit::pdf::annots::Screen::SetTitle | ( | const WString & | title | ) |

设置当前屏幕注释的标题。

参数

  [in] | title | 要设置的标题字符串。

返回
  无。