Foxit PDF SDK
FSInk类 参考
类 FSInk 继承关系图:
FSMarkup FSAnnot FSBase

构造函数

(void) - enableUseBezier:
 启用使用贝塞尔样条来为墨迹注释的外观生成墨迹路径。
更多...
 
(id) - init
 构造函数。

 
(id) - initWithAnnot:
 构造函数,使用父类对象。
更多...
 
- 构造函数 继承自 FSMarkup
(FSNote *) - addReply
 在回复列表的末尾添加新回复。
更多...
 
(void) - addRichText:style:
 在末尾添加新的富文本字符串。
更多...
 
(FSNote *) - addStateAnnot:model:state:
 添加新的状态注释。
更多...
 
(FSMarkupArray *) - getGroupElements
 从当前标记注释所属的组中获取一个元素(作为标记注释)。
更多...
 
(FSMarkup *) - getGroupHeader
 获取当前标记注释所属组的头注释(作为主注释)。
更多...
 
(FSNote *) - getReply:
 按索引获取回复。
更多...
 
(int) - getReplyCount
 计算所有回复。
更多...
 
(NSString *) - getRichTextContent:
 获取指定索引的富文本字符串的文本字符串。
更多...
 
(int) - getRichTextCount
 获取富文本字符串的数量。
更多...
 
(FSRichTextStyle *) - getRichTextStyle:
 获取指定索引的富文本字符串的样式数据。
更多...
 
(FSNoteArray *) - getStateAnnots:
 获取指定状态模型中的所有状态注释。
更多...
 
(void) - insertRichText:content:style:
 在指定索引位置插入新的富文本字符串。
更多...
 
(BOOL) - isGrouped
 检查当前标记注释是否在组中。
更多...
 
(BOOL) - removeAllReplies
 删除所有回复。
更多...
 
(BOOL) - removeAllStateAnnots
 移除所有状态注释。
更多...
 
(BOOL) - removePopup
 删除相关的弹出注释。
更多...
 
(BOOL) - removeReply:
 按索引删除回复。
更多...
 
(void) - removeRichText:
 移除指定索引的富文本字符串。
更多...
 
(void) - setRichTextContent:content:
 设置指定索引的富文本字符串的文本字符串。
更多...
 
(void) - setRichTextStyle:style:
 设置指定索引的富文本字符串的样式数据。
更多...
 
(BOOL) - ungroup
 将当前标记注释从其所属的组中解组。
更多...
 
- 构造函数 继承自 FSAnnot
(BOOL) - FSMoveWithResetAppearance:is_reset_appearance:
 将当前注释移动到新位置,由中的新矩形指定。
更多...
 
(BOOL) - FSResetApStreamWithIsGenerateNewAppearanceObj:
 重置外观流。
更多...
 
(FSPDFStream *) - getAppearanceStream:appearance_state:
 获取具有指定类型和状态的注释外观流。
更多...
 
(FSRectI *) - getDeviceRect:
 获取设备坐标系统中的注释矩形。
更多...
 
(FSPDFDictionary *) - getDict
 获取注释的字典对象。
更多...
 
(FSMatrix2D *) - getDisplayMatrix:
 获取显示矩阵,从到 目标设备坐标系统。
更多...
 
(int) - getIndex
 获取当前注释在其所属页面中的索引。
更多...
 
(FSPDFDictionary *) - getOptionalContent
 获取注释可选内容的PDF字典。
更多...
 
(FSPDFPage *) - getPage
 获取相关的PDF页面。
更多...
 
(FSRectF *) - getRect
 获取矩形,以表示。
更多...
 
(FSAnnotType) - getType
 获取标注类型。
更多...
 
(BOOL) - hasProperty:
 当前注释是否具有指定的注释属性。
更多...
 
(id) - initWithPage:annot_dict:
 构造函数,使用PDF页面和注释的PDF字典。
更多...
 
(BOOL) - isEmpty
 标注类型:未知。
更多...
 
(BOOL) - isMarkup
 检查当前注释是否为标记注释。
更多...
 
(BOOL) - move:
 将当前注释移动到新位置,由中的新矩形指定。
更多...
 
(BOOL) - removeProperty:
 删除指定的注释属性。
更多...
 
(BOOL) - resetAppearanceStream
 重置外观流。
更多...
 

属性

FSPath * inkList
 获取墨迹列表数据。
更多...
 
- 属性 继承自 FSMarkup
float borderOpacity
 获取注释的边框透明度。

 
FSDateTime * creationDateTime
 获取创建日期时间。

 
float fillOpacity
 获取注释的填充透明度。

 
NSString * intent
 获取意图名称。
更多...
 
float opacity
 获取不透明度值。
更多...
 
FSPopup * popup
 获取相关的弹出注释。
更多...
 
NSString * subject
 获取主题字符串。

 
NSString * title
 获取标题字符串。
更多...
 
- 属性 继承自 FSAnnot
unsigned int borderColor
 获取边框颜色。
更多...
 
FSBorderInfo * borderInfo
 获取边框信息。
更多...
 
NSString * content
 获取内容。

 
unsigned int flags
 获取注释标志。

 
FSDateTime * modifiedDateTime
 获取最后修改日期时间。

 
NSString * uniqueID
 获取唯一ID。

 

详细描述

墨迹注释表示由一个或多个不相交路径组成的手绘"涂鸦"。
墨迹注释是一种标记注释,所以类 FSInk 派生自 类 FSMarkup ,提供获取/设置墨迹注释属性和 重置墨迹注释外观流的函数。
对于墨迹注释,需要墨迹列表属性。因此,在重置其外观流之前,请确保墨迹注释 具有有效的墨迹列表属性;否则墨迹注释无法重置外观流。

注解
对于新创建的墨迹注释,如果用户在设置必需的墨迹列表属性后直接调用函数 FSAnnot::resetAppearanceStream (从 FSInk 的父类继承) 而不设置任何其他属性,将使用默认外观:
边框宽度 = 2.0,边框样式 = FSBorderInfoSolid , 边框颜色 = 0xFFFF0000(红色),不透明度 = 1.0。
参见
FSMarkup

函数文档

◆ enableUseBezier:()

- (void) enableUseBezier: (BOOL)  use_bezier

启用使用贝塞尔样条来为墨迹注释的外观生成墨迹路径。

如果未调用此函数,Foxit PDF SDK将默认使用贝塞尔样条生成墨迹路径。

参数
[in]use_bezier决定是否使用贝塞尔样条的布尔值: true表示使用贝塞尔样条生成墨迹路径, 而false表示使用直线连接相邻点来生成墨迹路径。
返回
无。

◆ initWithAnnot:()

- (id) initWithAnnot: (FSAnnot*)  annot

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

参数
[in]annot父类对象。

重载 FSMarkup .

属性说明

◆ inkList

- (FSPath *) inkList
readwritenonatomicweak

获取墨迹列表数据。

墨迹列表属性对于墨迹注释是必需的,此属性对墨迹注释的外观有影响。 墨迹列表包含一个或多个描边路径。
在Foxit PDF SDK中,类 FSPath 用于表示墨迹列表数据, 但路径对象的点类型已经为墨迹列表特别简化。 只有 FSPathTypeMoveTo 和 FSPathTypeLineTo 类型 用于墨迹列表中的点:

  • 类型为 FSPathTypeMoveTo 的点意味着 此点是描边路径的起始点。通常路径对象中的第一个点应该是此类型。
  • 类型为 FSPathTypeLineTo 的点意味着 此点在描边路径中,该路径由类型为 FSPathTypeMoveTo 的点开始, 当调用函数 FSAnnot::resetAppearanceStream (从Ink的父类继承)时, Foxit PDF SDK将通过曲线将此点与其他点连接。

诸如移动墨迹注释或为此注释设置新墨迹路径等操作将更新墨迹路径数据, 因此先前返回的路径对象将变为无效。在这种情况下, 用户应再次调用此函数以获得新的路径对象。