Foxit PDF SDK
|
Inherits <NSObject>.
Instance Methods | |
(void) | - displayCaret:is_visible:rect: |
A callback function used to display or hide caret. More... | |
(void) | - exportData:file_path: |
A callback function used to export data to file. More... | |
(int) | - getCurrentPage: |
A callback function used to get index of current page. More... | |
(int) | - getHighlightColor: |
A callback function get the highlight color. More... | |
(BOOL) | - getPopupPos:min_popup:max_popup:rect_widget:inout_rect_popup: |
A callback function used to get the pop-up position. More... | |
(NSString *) | - getTitle: |
A callback function used to get title of current XFA document. More... | |
(void) | - gotoURL:url: |
A callback function used to go to a specified URL. More... | |
(void) | - importData:file_path: |
A callback function used to import data from file. More... | |
(void) | - invalidateRect:rect:flag: |
A callback function used to invalidate rectangle according the flag. More... | |
(void) | - pageViewEvent:page_view_event_type: |
A callback function to execute page view event. More... | |
(BOOL) | - popupMenu:rect_popup: |
A callback function used to pop up the context menu. More... | |
(void) | - print:start_page_index:end_page_index:options: |
A callback function used to print. More... | |
(void) | - setChangeMark: |
A callback function used to set change mark flag. More... | |
(void) | - setCurrentPage:current_page_index: |
A callback function used to set index of current page. More... | |
(void) | - setFocus: |
A callback function used to set focus widget. More... | |
(BOOL) | - submitData:target:format:text_encoding:content: |
A callback function to submit data. More... | |
(void) | - widgetEvent:widget_event_type: |
A callback function to execute xfa widget event. More... | |
This class represents a callback object as an XFA document provider. All the functions in this class are used as callback functions. Pure virtual functions should be implemented by user.
|
required |
A callback function used to display or hide caret.
[in] | page_index | The index of page. |
[in] | is_visible | Used to decide whether the caret is visible or not: YES means visible, while NO means invisible. |
[in] | rect | A rectangle. |
|
required |
A callback function used to export data to file.
[in] | doc | Current XFA document. |
[in] | file_path | A file path, to which the data should be exported. If this is an empty string, user should specify a path as the exported file path. In this case, application can show a dialog to user to let user select the file manually. |
|
required |
A callback function used to get index of current page.
[in] | doc | Current XFA document. |
|
required |
A callback function get the highlight color.
[in] | doc | Current XFA document. |
|
required |
A callback function used to get the pop-up position.
[in] | page_index | The index of page. |
[in] | min_popup | The minimum height of drop-down box. |
[in] | max_popup | The maximum height of drop-down box. |
[in] | rect_widget | The rectangle of current widget. |
[in,out] | inout_rect_popup | A rectangle. When this function calls, this is used as an input parameter that specifies the width of drop-down box. When this function returns, this is used as an output parameter that receives the height of drop-down box. |
|
required |
A callback function used to get title of current XFA document.
[in] | doc | Current XFA document. |
|
required |
A callback function used to go to a specified URL.
[in] | doc | Current XFA document. |
[in] | url | A URL string. |
|
required |
A callback function used to import data from file.
[in] | doc | Current XFA document. |
[in] | file_path | A file path, from which the data would be imported. If this is an empty string, user should specify a path as the imported file path. In this case, application can show a dialog to user to let user select the file manually. |
|
required |
A callback function used to invalidate rectangle according the flag.
This callback function would be used in dynamic XFA document.
[in] | page_index | The index of page. |
[in] | rect | A rectangle to be invalidate. |
[in] | flag | Invalidate flag. Please refer to values starting from FSDocProviderCallbackInvalidateFlagAllPages and this would be one of these values. |
|
required |
A callback function to execute page view event.
[in] | page_index | The page index. |
[in] | page_view_event_type | Page view event type. Please refer to values starting from FSDocProviderCallbackPageViewEventTypeAdded and this would be one of these values. |
|
required |
A callback function used to pop up the context menu.
[in] | page_index | The index of page. |
[in] | rect_popup | The rectangle where to pop up menu. |
|
required |
A callback function used to print.
[in] | doc | Current XFA document. |
[in] | start_page_index | The index of start page. |
[in] | end_page_index | The index of end page. |
[in] | options | Print options. Please refer to values starting from FSDocProviderCallbackPrintOptionShowDialog and this would be one or a combination of these values. |
|
required |
A callback function used to set change mark flag.
[in] | doc | Current XFA document. |
|
required |
A callback function used to set index of current page.
[in] | doc | Current XFA document. |
[in] | current_page_index | The index would be set. |
|
required |
A callback function used to set focus widget.
[in] | xfa_widget | An XFA widget to be set focus on. |
|
required |
A callback function to submit data.
[in] | doc | Current XFA document. |
[in] | target | A string that represents the target of data to be submit. |
[in] | format | The format of data to be submit. Please refer to values starting from FSDocProviderCallbackSubmitInXDP and this would be one of these values. |
[in] | text_encoding | The text encoding of data to be submit. Please refer to values starting from FSDocProviderCallbackTextEncodingNone and this would be one of these values. |
[in] | content | The content of data to be submit. |
|
required |
A callback function to execute xfa widget event.
[in] | xfa_widget | An XFA widget which sends the event. |
[in] | widget_event_type | Widget event type. Please refer to values starting from FSDocProviderCallbackWidgetEventTypeAdded and this would be one of these values. |