Foxit PDF SDK
foxit::pdf::annots::PSInk类 参考
类 foxit::pdf::annots::PSInk 继承关系图:
foxit::pdf::annots::Annot foxit::Base

Public 成员函数

 PSInk ()
 构造函数。
 
 PSInk (const Annot &annot)
 构造函数,使用父类对象。 更多...
 
 ~PSInk ()
 析构函数。
 
- Public 成员函数 继承自 foxit::pdf::annots::Annot
 Annot (const PDFPage &page, objects::PDFDictionary *annot_dict)
 构造函数,使用PDF页面和注释的PDF字典。 更多...
 
 Annot (const Annot &annot)
 构造函数,使用另一个注释对象。 更多...
 
 Annot ()
 构造函数。
 
virtual ~Annot ()
 析构函数。
 
objects::PDFStreamGetAppearanceStream (AppearanceType type, const char *appearance_state="") const
 获取具有指定类型和状态的注释外观流。 更多...
 
RGB GetBorderColor () const
 获取边框颜色。 更多...
 
BorderInfo GetBorderInfo () const
 获取边框信息。 更多...
 
WString GetContent () const
 获取内容。 更多...
 
RectI GetDeviceRect (const Matrix &matrix)
 获取设备坐标系统中的注释矩形。 更多...
 
objects::PDFDictionaryGetDict () const
 获取注释的字典对象。 更多...
 
Matrix GetDisplayMatrix (const Matrix &page_display_matrix)
 获取显示矩阵,从PDF坐标系统到 目标设备坐标系统。 更多...
 
uint32 GetFlags () const
 获取注释标志。 更多...
 
int GetIndex () const
 获取当前注释在其所属页面中的索引。 更多...
 
DateTime GetModifiedDateTime () const
 获取最后修改日期时间。 更多...
 
objects::PDFDictionaryGetOptionalContent () 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
 不等于运算符。 更多...
 
Annotoperator= (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注释类型的枚举。 更多...
 

详细描述

PSInk表示福昕自定义注释类型,不是标准注释类型,用于 将压感墨水数据存储到PDF页面。现有的PSInk注释可以通过函数 pdf::PDFPage::GetAnnotpdf::PDFPage::GetAnnotAtPoint从PDF页面获取。 新的PSInk注释由函数PSI::ConvertToPDFAnnot返回,而不是pdf::PDFPage::AddAnnot
annots::PSInk派生自类Annot,还提供获取/设置 PSInk注释基本属性的函数。目前,PSInk注释的某些属性和函数可以更改, 但不会对PSInk注释的外观产生任何影响。 这些属性包括边框信息和边框颜色。这些函数包括 Annot::RemoveProperty
此外,目前福昕PDF SDK不支持通过函数Annot::Move移动PSInk注释。 由于PSInk不是标准注释,因此不能通过函数pdf::PDFPage::AddAnnot添加到页面; 相反,PSInk可以通过函数PSI::ConvertToPDFAnnot从FSPSI对象转换而来。

参见
pdf::PSI
pdf::PDFPage
Annot

构造及析构函数说明

◆ PSInk()

foxit::pdf::annots::PSInk::PSInk ( const Annot annot)
explicit

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

参数
[in]annot父类对象。