Foxit PDF SDK

构造函数 | 所有成员列表
<FSIconProviderCallback>协议 参考

继承自 <NSObject> .

## 构造函数
(BOOL) | - canChangeColor:icon_name:
| 用于检查当前图标提供程序是否支持为指定类型改变颜色的回调函数。 更多...
(NSNumber *) | - getDisplayHeight:icon_name:
| 用于获取指定图标的显示高度的回调函数，以设备大小（通常为像素）为单位。 更多...
(NSNumber *) | - getDisplayWidth:icon_name:
| 用于获取指定图标的显示宽度的回调函数，以设备大小（通常为像素）为单位。 更多...
(FSPDFPage *) | - getIcon:icon_name:color:
| 用于获取作为PDF页面内容的指定类型图标的回调函数。 更多...
(NSString *) | - getProviderID
| 用于获取提供程序ID的回调函数。 更多...
(NSString *) | - getProviderVersion
| 用于获取提供程序版本的回调函数。 更多...
(FSShadingColor *) | - getShadingColor:icon_name:referenced_color:shading_index:
| 用于获取当前图标提供程序是否支持指定类型的阴影颜色的回调函数。 目前，仅支持具有两个颜色值的Type-2阴影设置。 更多...
(BOOL) | - hasIcon:icon_name:
| A callback function used to check if current icon provider supports icon for a specified type. 更多...

## 详细描述

此类表示作为自定义注释图标提供程序的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现， 用户还可以选择在必要时实现部分或全部重置虚函数。 图标提供程序只能用于批注、文件附件、印章注释。
图标提供程序的ID和版本被视为图标提供程序的名称，因此请通过回调函数 FSIconProviderCallback::getProviderID和FSIconProviderCallback::getProviderVersion 为不同的图标提供程序提供不同的"ID + 版本"。

## 函数文档

## ◆ canChangeColor:icon_name:()

- (BOOL) canChangeColor: |  | (FSAnnotType) | annot_type
icon_name: |  | (NSString *) | icon_name
| required

用于检查当前图标提供程序是否支持为指定类型改变颜色的回调函数。

参数

  [in] | annot_type | 注释类型。它应该是FSActionCallbackMailTypeMsg、 FSAnnotFileAttachment和FSAnnotStamp之一。
  [in] | icon_name | 注释的图标名称。

返回
  YES表示当前图标提供程序支持为指定图标类型改变颜色， 而NO表示不支持。

## ◆ getDisplayHeight:icon_name:()

- (NSNumber*) getDisplayHeight: |  | (FSAnnotType) | annot_type
icon_name: |  | (NSString *) | icon_name
| required

用于获取指定图标的显示高度的回调函数，以设备大小（通常为像素）为单位。

参数

  [in] | annot_type | 注释类型。它应该是FSActionCallbackMailTypeMsg、 FSAnnotFileAttachment和FSAnnotStamp之一。
  [in] | icon_name | 注释的图标名称。

返回
  显示的高度。

## ◆ getDisplayWidth:icon_name:()

- (NSNumber*) getDisplayWidth: |  | (FSAnnotType) | annot_type
icon_name: |  | (NSString *) | icon_name
| required

用于获取指定图标的显示宽度的回调函数，以设备大小（通常为像素）为单位。

参数

  [in] | annot_type | 注释类型。它应该是FSActionCallbackMailTypeMsg、 FSAnnotFileAttachment和FSAnnotStamp之一。
  [in] | icon_name | 注释的图标名称。

返回
  显示的宽度。

## ◆ getIcon:icon_name:color:()

- (FSPDFPage*) getIcon: |  | (FSAnnotType) | annot_type
icon_name: |  | (NSString *) | icon_name
color: |  | (unsigned int) | color
| required

用于获取作为PDF页面内容的指定类型图标的回调函数。

参数

  [in] | annot_type | 注释类型。它应该是FSActionCallbackMailTypeMsg、 FSAnnotFileAttachment和FSAnnotStamp之一。
  [in] | icon_name | 注释的图标名称。
  [in] | color | 注释的图标颜色。格式：0xAARRGGBB。

返回
  一个PDF页面对象，其内容将用作图标。

## ◆ getProviderID()

- (NSString*) getProviderID |  |  |
| required

用于获取提供程序ID的回调函数。

图标提供程序的ID和版本被视为图标提供程序的名称，因此请为不同的 图标提供程序提供不同的"ID + 版本"。

返回
  提供程序ID。

## ◆ getProviderVersion()

- (NSString*) getProviderVersion |  |  |
| required

用于获取提供程序版本的回调函数。

图标提供程序的ID和版本被视为图标提供程序的名称，因此请为不同的 图标提供程序提供不同的"ID + 版本"。

返回
  版本字符串。

## ◆ getShadingColor:icon_name:referenced_color:shading_index:()

- (FSShadingColor*) getShadingColor: |  | (FSAnnotType) | annot_type
icon_name: |  | (NSString *) | icon_name
referenced_color: |  | (unsigned int) | referenced_color
shading_index: |  | (int) | shading_index
| required

用于获取当前图标提供程序是否支持指定类型的阴影颜色的回调函数。 目前，仅支持具有两个颜色值的Type-2阴影设置。

参数

  [in] | annot_type | 注释类型。它应该是FSActionCallbackMailTypeMsg、 FSAnnotFileAttachment和FSAnnotStamp之一。
  [in] | icon_name | 注释的图标名称。
  [in] | referenced_color | 参考颜色。格式：0xRRGGBB。
  [in] | shading_index | 阴影的索引颜色，从0开始。 如果阴影颜色多于一个，此函数将被多次调用。

返回
  阴影颜色。

## ◆ hasIcon:icon_name:()

- (BOOL) hasIcon: |  | (FSAnnotType) | annot_type
icon_name: |  | (NSString *) | icon_name
| required

A callback function used to check if current icon provider supports icon for a specified type.

参数

  [in] | annot_type | The annotation type. It should be one of FSActionCallbackMailTypeMsg, FSAnnotFileAttachment and FSAnnotStamp.
  [in] | icon_name | Icon name of the annotation.

返回
  YES means current icon provider supports the specified icon, while NO means not support.