|
Foxit PDF SDK
|
Public Member Functions | |
| def | DisplayCaret (page_index, is_visible, rect) |
| A callback function used to display or hide caret. More... | |
| def | ExportData (doc, file_path) |
| A callback function used to export data to file. More... | |
| def | GetCurrentPage (doc) |
| A callback function used to get index of current page. More... | |
| def | GetHighlightColor (doc) |
| A callback function get the highlight color. More... | |
| def | GetPopupPos (page_index, min_popup, max_popup, rect_widget, inout_rect_popup) |
| A callback function used to get the pop-up position. More... | |
| def | GetTitle (doc) |
| A callback function used to get title of current XFA document. More... | |
| def | GotoURL (doc, url) |
| A callback function used to go to a specified URL. More... | |
| def | ImportData (doc, file_path) |
| A callback function used to import data from file. More... | |
| def | InvalidateRect (page_index, rect, flag) |
| A callback function used to invalidate rectangle according the flag. More... | |
| def | PageViewEvent (page_index, page_view_event_type) |
| A callback function to execute page view event. More... | |
| def | PopupMenu (page_index, rect_popup) |
| A callback function used to pop up the context menu. More... | |
| def | Print (doc, start_page_index, end_page_index, options) |
| A callback function used to print. More... | |
| def | Release () |
| A callback function used to release current callback object itself. More... | |
| def | SetChangeMark (doc) |
| A callback function used to set change mark flag to current XFA document. More... | |
| def | SetCurrentPage (doc, current_page_index) |
| A callback function used to set index of current page. More... | |
| def | SetFocus (xfa_widget, is_relayout) |
| A callback function used to set focus widget. More... | |
| def | SubmitData (doc, target, format, text_encoding, content) |
| A callback function to submit data. More... | |
| def | WidgetEvent (xfa_widget, 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.
| def fsdk.DocProviderCallback.DisplayCaret | ( | page_index, | |
| is_visible, | |||
| rect | |||
| ) |
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: true means visible, while false means invisible. |
| [in] | rect | A rectangle. |
| def fsdk.DocProviderCallback.ExportData | ( | doc, | |
| file_path | |||
| ) |
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. |
| def fsdk.DocProviderCallback.GetCurrentPage | ( | doc | ) |
A callback function used to get index of current page.
| [in] | doc | Current XFA document. |
| def fsdk.DocProviderCallback.GetHighlightColor | ( | doc | ) |
A callback function get the highlight color.
| [in] | doc | Current XFA document. |
| def fsdk.DocProviderCallback.GetPopupPos | ( | page_index, | |
| min_popup, | |||
| max_popup, | |||
| rect_widget, | |||
| inout_rect_popup | |||
| ) |
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. |
| def fsdk.DocProviderCallback.GetTitle | ( | doc | ) |
A callback function used to get title of current XFA document.
| [in] | doc | Current XFA document. |
| def fsdk.DocProviderCallback.GotoURL | ( | doc, | |
| url | |||
| ) |
A callback function used to go to a specified URL.
| [in] | doc | Current XFA document. |
| [in] | url | A URL string. |
| def fsdk.DocProviderCallback.ImportData | ( | doc, | |
| file_path | |||
| ) |
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. |
| def fsdk.DocProviderCallback.InvalidateRect | ( | page_index, | |
| rect, | |||
| flag | |||
| ) |
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 fsdk.DocProviderCallbackE_InvalidateFlagAllPages and this would be one of these values. |
| def fsdk.DocProviderCallback.PageViewEvent | ( | page_index, | |
| page_view_event_type | |||
| ) |
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 fsdk.DocProviderCallbackE_PageViewEventTypeAdded and this would be one of these values. |
| def fsdk.DocProviderCallback.PopupMenu | ( | page_index, | |
| rect_popup | |||
| ) |
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. |
| def fsdk.DocProviderCallback.Print | ( | doc, | |
| start_page_index, | |||
| end_page_index, | |||
| options | |||
| ) |
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 fsdk.DocProviderCallbackE_PrintOptionShowDialog and this would be one or a combination of these values. |
| def fsdk.DocProviderCallback.Release | ( | ) |
A callback function used to release current callback object itself.
| def fsdk.DocProviderCallback.SetChangeMark | ( | doc | ) |
A callback function used to set change mark flag to current XFA document.
| [in] | doc | Current XFA document. |
| def fsdk.DocProviderCallback.SetCurrentPage | ( | doc, | |
| current_page_index | |||
| ) |
A callback function used to set index of current page.
| [in] | doc | Current XFA document. |
| [in] | current_page_index | The index would be set. |
| def fsdk.DocProviderCallback.SetFocus | ( | xfa_widget, | |
| is_relayout | |||
| ) |
A callback function used to set focus widget.
| [in] | xfa_widget | An XFA widget to be set focus on. |
| [in] | is_relayout | true means the layout has changed, while false means the layout has not changed. |
| def fsdk.DocProviderCallback.SubmitData | ( | doc, | |
| target, | |||
| format, | |||
| text_encoding, | |||
| content | |||
| ) |
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 fsdk.DocProviderCallbackE_SubmitInXDP 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 fsdk.DocProviderCallbackE_TextEncodingNone and this would be one of these values. |
| [in] | content | The content of data to be submit. |
| def fsdk.DocProviderCallback.WidgetEvent | ( | xfa_widget, | |
| widget_event_type | |||
| ) |
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 fsdk.DocProviderCallbackE_WidgetEventTypeAdded and this would be one of these values. |