|
Foxit PDF SDK
|
Public Member Functions | |
| def | AppendPopupMenuItem (h_popup_menu, popup_menu_item, default_string) |
| A callback function which is triggered when need to append popup menu item to popup menu. More... | |
| def | CreatePopupMenu () |
| A callback function which is triggered when need to create a popup menu. More... | |
| def | DestroyPopupMenu (h_popup_menu) |
| A callback function which is triggered when need to destroy popup menu. More... | |
| def | EnablePopupMenuItem (h_popup_menu, popup_menu_item, is_enabled) |
| A callback function which is triggered when need to enable specified popup menu item in popup menu. More... | |
| def | FocusGotOnControl (control, value) |
| A callback function which is triggered when the focus is set to a form control. More... | |
| def | FocusLostFromControl (control, value) |
| A callback function which is triggered when the focus is lost from a form control. More... | |
| def | GetClipboardText () |
| A callback function which is triggered when need to get the text on clipboard. More... | |
| def | GetVersion () |
| Get the version of derived implementation, for compatibility reason. More... | |
| def | KillTimer (timer_id) |
| A callback function used to kill the timer event by timer identifier. More... | |
| def | Refresh (page, rect) |
| A callback function used to refresh the specified area on a specified page. More... | |
| def | Release () |
| A callback function used to release current callback object itself. More... | |
| def | ReportInvalidValue (form_field_name, invalid_value) |
| A callback function which is triggered when user entered an invalid value. More... | |
| def | SetClipboardText (text) |
| A callback function which is triggered when need to set clipboard text. More... | |
| def | ShowPopupMenu (h_popup_menu, point) |
| A callback function which is triggered when need to show popup menu. More... | |
This class represents a callback object to assist form filler. All the pure virtual functions in this class are used as callback functions and should be implemented by user.
| def fsdk.FillerAssistCallback.AppendPopupMenuItem | ( | h_popup_menu, | |
| popup_menu_item, | |||
| default_string | |||
| ) |
A callback function which is triggered when need to append popup menu item to popup menu.
This callback function supports text field, combo box field.
| [in] | h_popup_menu | Popup menu handle. |
| [in] | popup_menu_item | A value to specify the exact popup menu item. Please refer to values starting from fsdk.FillerAssistCallbackE_PopupMenuItemNone and this would be one of these values. |
| [in] | default_string | Default string for the specified popup menu item. |
| def fsdk.FillerAssistCallback.CreatePopupMenu | ( | ) |
A callback function which is triggered when need to create a popup menu.
This callback function supports text field, combo box field.
| def fsdk.FillerAssistCallback.DestroyPopupMenu | ( | h_popup_menu | ) |
A callback function which is triggered when need to destroy popup menu.
This callback function supports text field, combo box field.
| [in] | h_popup_menu | Popup menu handle. |
| def fsdk.FillerAssistCallback.EnablePopupMenuItem | ( | h_popup_menu, | |
| popup_menu_item, | |||
| is_enabled | |||
| ) |
A callback function which is triggered when need to enable specified popup menu item in popup menu.
This callback function supports text field, combo box field.
| [in] | h_popup_menu | Popup menu handle. |
| [in] | popup_menu_item | A value to specify the exact popup menu item. Please refer to values starting from fsdk.FillerAssistCallbackE_PopupMenuItemNone and this would be one of these values. |
| [in] | is_enabled | A boolean value to decide whether to enable the specified popup menu item or disable it. |
| def fsdk.FillerAssistCallback.FocusGotOnControl | ( | control, | |
| value | |||
| ) |
A callback function which is triggered when the focus is set to a form control.
This callback function supports text field, combo box field, list box field, push button field, check box field, radio button field.
| [in] | control | The form control object to which the focus is set. |
| [in] | value | The value of form field associated with the control. If the control belongs to a push button field, this value would always be an empty string. |
| def fsdk.FillerAssistCallback.FocusLostFromControl | ( | control, | |
| value | |||
| ) |
A callback function which is triggered when the focus is lost from a form control.
This callback function supports text field, combo box field, list box field, push button field, check box field, radio button field.
| [in] | control | The form control object, from which the focus is lost. |
| [in] | value | The value of form field associated with the control. If the control belongs to a push button field, this value would always be an empty string. |
| def fsdk.FillerAssistCallback.GetClipboardText | ( | ) |
A callback function which is triggered when need to get the text on clipboard.
This callback function supports text field, combo box field.
| def fsdk.FillerAssistCallback.GetVersion | ( | ) |
Get the version of derived implementation, for compatibility reason.
| def fsdk.FillerAssistCallback.KillTimer | ( | timer_id | ) |
A callback function used to kill the timer event by timer identifier.
| [in] | timer_id | The timer identifier returned by an earlier calling of callback function FillerAssistCallback::SetTimerCallback. |
| def fsdk.FillerAssistCallback.Refresh | ( | page, | |
| rect | |||
| ) |
A callback function used to refresh the specified area on a specified page.
| [in] | page | A PDF page object. |
| [in] | rect | A rectangle that specifies the area on the page to be redrawn. null means to refresh the whole page. |
| def fsdk.FillerAssistCallback.Release | ( | ) |
A callback function used to release current callback object itself.
| def fsdk.FillerAssistCallback.ReportInvalidValue | ( | form_field_name, | |
| invalid_value | |||
| ) |
A callback function which is triggered when user entered an invalid value.
This callback function supports text field, combo box field.
| [in] | form_field_name | The name of form field associated with the control. |
| [in] | invalid_value | The invalid value of form field associated with the control. |
| def fsdk.FillerAssistCallback.SetClipboardText | ( | text | ) |
A callback function which is triggered when need to set clipboard text.
This callback function supports text field, combo box field.
| [in] | text | The text need to be set to clipboard. |
| def fsdk.FillerAssistCallback.ShowPopupMenu | ( | h_popup_menu, | |
| point | |||
| ) |
A callback function which is triggered when need to show popup menu.
This callback function supports text field, combo box field.
| [in] | h_popup_menu | Popup menu handle. |
| [in] | point | Left-top point used to locate where to show the popup menu, in [PDF coordinate system] (). |