Foxit PDF SDK

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

继承自 <NSObject> .

## 构造函数
(void) | - displayCaret:is_visible:rect:
| 用于显示或隐藏光标的回调函数。 更多...
(void) | - exportData:file_path:
| 用于导出数据到文件的回调函数。 更多...
(int) | - getCurrentPage:
| 用于获取当前页面索引的回调函数。 更多...
(int) | - getHighlightColor:
| 用于获取高亮颜色的回调函数。 更多...
(BOOL) | - getPopupPos:min_popup:max_popup:rect_widget:inout_rect_popup:
| 用于获取弹出位置的回调函数。 更多...
(NSString *) | - getTitle:
| 用于获取当前 XFA 文档标题的回调函数。 更多...
(void) | - gotoURL:url:
| 用于跳转到指定 URL 的回调函数。 更多...
(void) | - importData:file_path:
| 用于从文件导入数据的回调函数。 更多...
(void) | - invalidateRect:rect:flag:
| 用于根据标志使矩形区域无效的回调函数。 更多...
(void) | - notifyWidgetChangeInfo:change_info:
| 用于通知 XFA 控件更改信息的回调函数。 更多...
(void) | - pageViewEvent:page_view_event_type:
| 用于执行页面视图事件的回调函数。 更多...
(BOOL) | - popupMenu:rect_popup:
| 用于弹出上下文菜单的回调函数。 更多...
(void) | - print:start_page_index:end_page_index:options:
| 用于打印的回调函数。 更多...
(void) | - setChangeMark:
| 用于为当前 XFA 文档设置更改标记标志的回调函数。 更多...
(void) | - setCurrentPage:current_page_index:
| 用于设置当前页面索引的回调函数。 更多...
(void) | - setFocus:is_relayout:
| 用于设置焦点控件的回调函数。 更多...
(BOOL) | - submitData:target:format:text_encoding:content:
| 用于提交数据的回调函数。 更多...
(void) | - widgetEvent:widget_event_type:
| 用于执行 XFA 控件事件的回调函数。 更多...

## 详细描述

此类表示作为 XFA 文档提供者的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现。

## 函数文档

## ◆ displayCaret:is_visible:rect:()

- (void) displayCaret: |  | (int) | page_index
is_visible: |  | (BOOL) | is_visible
rect: |  | (FSRectF *) | rect
| required

用于显示或隐藏光标的回调函数。

参数

  [in] | page_index | 页面的索引。
  [in] | is_visible | 用于决定光标是否可见：YES 表示可见， 而 NO 表示不可见。
  [in] | rect | 一个矩形。

返回
  无。

## ◆ exportData:file_path:()

- (void) exportData: |  | (FSPDFDoc *) | doc
file_path: |  | (NSString *) | file_path
| required

用于导出数据到文件的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | file_path | 数据应导出到的文件路径。 如果为空字符串，用户应指定一个路径作为导出文件路径。 在这种情况下，应用程序可以向用户显示对话框，让用户手动选择文件。

返回
  无。

## ◆ getCurrentPage:()

- (int) getCurrentPage: |  | (FSPDFDoc *) | doc |
| required

用于获取当前页面索引的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  当前页面的索引。

## ◆ getHighlightColor:()

- (int) getHighlightColor: |  | (FSPDFDoc *) | doc |
| required

用于获取高亮颜色的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  高亮颜色。

## ◆ getPopupPos:min_popup:max_popup:rect_widget:inout_rect_popup:()

- (BOOL) getPopupPos: |  | (int) | page_index
min_popup: |  | (float) | min_popup
max_popup: |  | (float) | max_popup
rect_widget: |  | (FSRectF *) | rect_widget
inout_rect_popup: |  | (FSRectF *) | inout_rect_popup
| required

用于获取弹出位置的回调函数。

参数

  [in] | page_index | 页面的索引。
  [in] | min_popup | 下拉框的最小高度。
  [in] | max_popup | 下拉框的最大高度。
  [in] | rect_widget | 当前控件的矩形。
  [in,out] | inout_rect_popup | 一个矩形。当调用此函数时，它用作输入参数， 指定下拉框的宽度。 当此函数返回时，它用作输出参数，接收 下拉框的高度。

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

## ◆ getTitle:()

- (NSString*) getTitle: |  | (FSPDFDoc *) | doc |
| required

用于获取当前 XFA 文档标题的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  标题。

## ◆ gotoURL:url:()

- (void) gotoURL: |  | (FSPDFDoc *) | doc
url: |  | (NSString *) | url
| required

用于跳转到指定 URL 的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | url | URL 字符串。

返回
  无。

## ◆ importData:file_path:()

- (void) importData: |  | (FSPDFDoc *) | doc
file_path: |  | (NSString *) | file_path
| required

用于从文件导入数据的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | file_path | 数据将从其导入的文件路径。 如果为空字符串，用户应指定一个路径作为导入文件路径。 在这种情况下，应用程序可以向用户显示对话框，让用户手动选择文件。

返回
  无。

## ◆ invalidateRect:rect:flag:()

- (void) invalidateRect: |  | (int) | page_index
rect: |  | (FSRectF *) | rect
flag: |  | (FSDocProviderCallbackInvalidateFlag) | flag
| required

用于根据标志使矩形区域无效的回调函数。

此回调函数将用于动态 XFA 文档。

参数

  [in] | page_index | 页面的索引。
  [in] | rect | 要使其无效的矩形。
  [in] | flag | 无效标志。请参考从 FSDocProviderCallbackInvalidateFlagAllPages 开始的值， 这将是其中之一。

返回
  无。

## ◆ notifyWidgetChangeInfo:change_info:()

- (void) notifyWidgetChangeInfo: |  | (FSXFADoc *) | doc
change_info: |  | (FSXFAWidgetModifyInfo *) | change_info
| required

用于通知 XFA 控件更改信息的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | change_info | XFA 控件更改信息。

返回
  无。

## ◆ pageViewEvent:page_view_event_type:()

- (void) pageViewEvent: |  | (int) | page_index
page_view_event_type: |  | (FSDocProviderCallbackPageViewEventType) | page_view_event_type
| required

用于执行页面视图事件的回调函数。

参数

  [in] | page_index | 页面索引。
  [in] | page_view_event_type | 页面视图事件类型。请参考从 FSDocProviderCallbackPageViewEventTypeAdded 开始的值，这将是 其中之一。

返回
  无。

## ◆ popupMenu:rect_popup:()

- (BOOL) popupMenu: |  | (int) | page_index
rect_popup: |  | (FSPointF *) | rect_popup
| required

用于弹出上下文菜单的回调函数。

参数

  [in] | page_index | 页面的索引。
  [in] | rect_popup | 弹出菜单的位置矩形。

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

## ◆ print:start_page_index:end_page_index:options:()

- (void) print: |  | (FSPDFDoc *) | doc
start_page_index: |  | (int) | start_page_index
end_page_index: |  | (int) | end_page_index
options: |  | (int) | options
| required

用于打印的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | start_page_index | 起始页面的索引。
  [in] | end_page_index | 结束页面的索引。
  [in] | options | 打印选项。请参考从 FSDocProviderCallbackPrintOptionShowDialog 开始的值， 这将是其中之一或这些值的组合。

返回
  无。

## ◆ setChangeMark:()

- (void) setChangeMark: |  | (FSXFADoc *) | doc |
| required

用于为当前 XFA 文档设置更改标记标志的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  无。

## ◆ setCurrentPage:current_page_index:()

- (void) setCurrentPage: |  | (FSPDFDoc *) | doc
current_page_index: |  | (int) | current_page_index
| required

用于设置当前页面索引的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | current_page_index | 要设置的索引。

返回
  无。

## ◆ setFocus:is_relayout:()

- (void) setFocus: |  | (FSXFAWidget *) | xfa_widget
is_relayout: |  | (BOOL) | is_relayout
| required

用于设置焦点控件的回调函数。

参数

  [in] | xfa_widget | 要设置焦点的 XFA 控件。
  [in] | is_relayout | true 表示布局已更改， 而 false 表示布局未更改。

返回
  无。

## ◆ submitData:target:format:text_encoding:content:()

- (BOOL) submitData: |  | (FSPDFDoc *) | doc
target: |  | (NSString *) | target
format: |  | (FSDocProviderCallbackSubmitFormat) | format
text_encoding: |  | (FSDocProviderCallbackTextEncoding) | text_encoding
content: |  | (NSString *) | content
| required

用于提交数据的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | target | 表示要提交的数据目标的字符串。
  [in] | format | 要提交的数据格式。请参考从 FSDocProviderCallbackSubmitInXDP 开始的值，这将是其中之一。
  [in] | text_encoding | 要提交的数据的文本编码。请参考从 FSDocProviderCallbackTextEncodingNone 开始的值，这将是其中之一。
  [in] | content | 要提交的数据内容。

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

## ◆ widgetEvent:widget_event_type:()

- (void) widgetEvent: |  | (FSXFAWidget *) | xfa_widget
widget_event_type: |  | (FSDocProviderCallbackWidgetEventType) | widget_event_type
| required

用于执行 XFA 控件事件的回调函数。

参数

  [in] | xfa_widget | 发送事件的 XFA 控件。
  [in] | widget_event_type | 控件事件类型。请参考从 FSDocProviderCallbackWidgetEventTypeAdded 开始的值， 这将是其中之一。

返回
  无。