Foxit PDF SDK

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

继承自 <NSObject> .

## 构造函数
(BOOL) | - appendPopupMenuItem:popup_menu_item:default_string:
| 需要向弹出菜单追加菜单项时触发的回调函数。 更多...
(void *) | - createPopupMenu
| 需要创建弹出菜单时触发的回调函数。 更多...
(void) | - destroyPopupMenu:
| 需要销毁弹出菜单时触发的回调函数。 更多...
(BOOL) | - enablePopupMenuItem:popup_menu_item:is_enabled:
| 需要为弹出菜单启用菜单项时触发的回调函数。 更多...
(void) | - focusGotOnControl:value:
| 当焦点设置到表单控件时触发的回调函数。 更多...
(void) | - focusLostFromControl:value:
| 当焦点从表单控件失去时触发的回调函数。 更多...
(NSString *) | - getClipboardText
| 需要获取剪贴板上的文本时触发的回调函数。 更多...
(BOOL) | - killTimer:
| 用于通过定时器标识符终止定时器事件的回调函数。 更多...
(void) | - refresh:rect:
| 用于刷新指定页面上指定区域的回调函数。 更多...
(void) | - reportInvalidValue:invalid_value:
| 当用户输入无效值时触发的回调函数。 更多...
(void) | - setClipboardText:
| 需要设置剪贴板文本时触发的回调函数。 更多...
(BOOL) | - setTimer:timer:out_timer_id:
| 用于设置系统定时器的回调函数。 更多...
(BOOL) | - showPopupMenu:point:
| 需要显示弹出菜单时触发的回调函数。 更多...

## 详细描述

此类表示用于辅助表单填充的回调对象。 此类中的所有纯虚函数都用作回调函数，应由用户实现。

## 函数文档

## ◆ appendPopupMenuItem:popup_menu_item:default_string:()

- (BOOL) appendPopupMenuItem: |  | (const void *) | h_popup_menu
popup_menu_item: |  | (FSFillerAssistCallbackPopupMenuItem) | popup_menu_item
default_string: |  | (NSString *) | default_string
| required

需要向弹出菜单追加菜单项时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。
  [in] | popup_menu_item | 弹出菜单项ID。请参阅从FSFillerAssistCallbackPopupMenuItem::e_PopupMenuItemNone开始的值， 并且应该是这些值之一。
  [in] | default_string | 默认弹出菜单项字符串。

返回
  true表示成功，而false表示失败。

## ◆ createPopupMenu()

- (void *) createPopupMenu |  |  |
| required

需要创建弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

返回
  弹出菜单句柄。

## ◆ destroyPopupMenu:()

- (void) destroyPopupMenu: |  | (const void *) | h_popup_menu |
| required

需要销毁弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。

返回
  无。

## ◆ enablePopupMenuItem:popup_menu_item:is_enabled:()

- (BOOL) enablePopupMenuItem: |  | (const void *) | h_popup_menu
popup_menu_item: |  | (FSFillerAssistCallbackPopupMenuItem) | popup_menu_item
is_enabled: |  | (BOOL) | is_enabled
| required

需要为弹出菜单启用菜单项时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。
  [in] | popup_menu_item | 弹出菜单项ID。请参阅从FSFillerAssistCallbackPopupMenuItem::e_PopupMenuItemNone开始的值， 并且应该是这些值之一。
  [in] | is_enabled | 是否启用菜单项或禁用。

返回
  true表示成功，而false表示失败。

## ◆ focusGotOnControl:value:()

- (void) focusGotOnControl: |  | (FSControl *) | control
value: |  | (NSString *) | value
| required

当焦点设置到表单控件时触发的回调函数。

此回调函数支持文本字段、组合框字段、列表框字段、按钮字段。

参数

  [in] | control | 设置焦点的表单控件对象。
  [in] | value | 与控件关联的表单字段的值。 如果控件属于按钮字段，此值将始终为空字符串。

返回
  无。

## ◆ focusLostFromControl:value:()

- (void) focusLostFromControl: |  | (FSControl *) | control
value: |  | (NSString *) | value
| required

当焦点从表单控件失去时触发的回调函数。

此回调函数支持文本字段、组合框字段、列表框字段、按钮字段、 复选框字段、单选按钮字段。

参数

  [in] | control | 失去焦点的表单控件对象。
  [in] | value | 与控件关联的表单字段的值。 如果控件属于按钮字段，此值将始终为空字符串。

返回
  无。

## ◆ getClipboardText()

- (NSString*) getClipboardText |  |  |
| required

需要获取剪贴板上的文本时触发的回调函数。

此回调函数支持文本字段、组合框字段。

返回
  剪贴板上的文本。

## ◆ killTimer:()

- (BOOL) killTimer: |  | (int) | timer_id |
| required

用于通过定时器标识符终止定时器事件的回调函数。

参数

  [in] | timer_id | 由较早调用回调函数 FSFillerAssistCallback::setTimer:timer:out_timer_id:返回的定时器标识符。

返回
  YES表示成功，而NO表示失败。

## ◆ refresh:rect:()

- (void) refresh: |  | (FSPDFPage *) | page
rect: |  | (FSRectF *) | rect
| required

用于刷新指定页面上指定区域的回调函数。

参数

  [in] | page | 一个PDF页面对象。
  [in] | rect | 指定页面上要重绘区域的矩形。 nil表示刷新整个页面。

返回
  无。

## ◆ reportInvalidValue:invalid_value:()

- (void) reportInvalidValue: |  | (NSString *) | form_field_name
invalid_value: |  | (NSString *) | invalid_value
| required

当用户输入无效值时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | form_field_name | 与控件关联的表单字段的名称。
  [in] | invalid_value | 与控件关联的表单字段的无效值。

返回
  无。

## ◆ setClipboardText:()

- (void) setClipboardText: |  | (NSString *) | text |
| required

需要设置剪贴板文本时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | text | 需要设置到剪贴板的文本。

返回
  无。

## ◆ setTimer:timer:out_timer_id:()

- (BOOL) setTimer: |  | (int) | elapse
timer: |  | (FSTimer *) | timer
out_timer_id: |  | (int *) | out_timer_id
| required

用于设置系统定时器的回调函数。

调用此回调函数以安装系统定时器。当指定了超时值时， 每次发生超时时，系统都会向定时器回调函数传递一条消息。

参数

  [in] | elapse | 指定超时值，以毫秒为单位。
  [in] | timer | 指向定时器回调对象的指针。
  [out] | out_timer_id | 输出参数，如果函数成功完成，则接收新定时器的定时器标识符。 此值将被传递给回调函数FSFillerAssistCallback::killTimer:以终止定时器。 如果函数成功，则为非零；否则应为零。

返回
  YES表示成功，而NO表示失败。

## ◆ showPopupMenu:point:()

- (BOOL) showPopupMenu: |  | (const void *) | h_popup_menu
point: |  | (FSPointF *) | point
| required

需要显示弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。
  [in] | point | 弹出菜单的左上角点，在PDF坐标系统中。

返回
  true表示成功，而false表示失败。