Foxit PDF SDK  9.1
<FSFillerAssistCallback> Protocol Reference
Inheritance diagram for <FSFillerAssistCallback>:

Instance Methods

(BOOL) - appendPopupMenuItem:popupMenuItem:default_string:
 A callback function which is triggered when need to append popup menu item to popup menu. More...
 
(void *) - createPopupMenu
 A callback function which is triggered when need to create a popup menu. More...
 
(void) - destroyPopupMenu:
 A callback function which is triggered when need to destroy popup menu. More...
 
(void) - editingMonitorOnCaretChanged:
 A callback function which is triggered when the caret position is changed. More...
 
(void) - editingMonitorOnContentChanged:
 A callback function which is triggered when the content is changed. More...
 
(BOOL) - enablePopupMenuItem:popupMenuItem:is_enabled:
 A callback function which is triggered when need to enable popup menu item for popup menu. More...
 
(void) - executeAction:action:
 A callback function which is triggered when need to execute action. More...
 
(void) - focusGotOnControl:value:
 A callback function which is triggered when the focus is set to a form control. More...
 
(void) - focusLostFromControl:value:
 A callback function which is triggered when the focus is lost from a form control. More...
 
(NSString *) - getClipboardText
 A callback function which is triggered when need to get the text on clipboard. More...
 
(BOOL) - killTimer:
 A callback function used to kill the timer event by timer identifier. More...
 
(void) - refresh:rect:
 A callback function used to refresh the specified area on a specified page. More...
 
(void) - reportInvalidValue:invalid_value:
 A callback function which is triggered when user entered an invalid value. More...
 
(void) - setClipboardText:
 A callback function which is triggered when need to set clipboard text. More...
 
(BOOL) - setTimer:timer:out_timer_id:
 A callback function used to set a system timer. More...
 
(BOOL) - showPopupMenu:point:
 A callback function which is triggered when need to show popup menu. More...
 

Detailed Description

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.

Method Documentation

◆ appendPopupMenuItem:popupMenuItem:default_string:

- (BOOL) appendPopupMenuItem: (void *)  h_popup_menu
popupMenuItem: (FSFillerAssistCallbackPopupMenuItem)  popupMenuItem
default_string: (NSString *)  default_string 
optional

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.

Parameters
[in]h_popup_menuThe popup menu handle.
[in]popup_menu_itemThe popup menu item id.Please refer to values starting from PopupMenuItem::e_PopupMenuItemNone and this should be one of these values.
[in]default_stringThe default popup menu item string.
Returns
true means success, while false means failure.

◆ createPopupMenu

- (void *) createPopupMenu
optional

A callback function which is triggered when need to create a popup menu.

This callback function supports text field, combo box field.

Returns
Popup menu handle.

◆ destroyPopupMenu:

- (void) destroyPopupMenu: (void *)  h_popup_menu
optional

A callback function which is triggered when need to destroy popup menu.

This callback function supports text field, combo box field.

Parameters
[in]h_popup_menuThe menu handle.
Returns
None.

◆ editingMonitorOnCaretChanged:

- (void) editingMonitorOnCaretChanged: (int)  n_caret_pos
optional

A callback function which is triggered when the caret position is changed.

Parameters
[in]n_caret_posThe caret position .
Returns
None.

◆ editingMonitorOnContentChanged:

- (void) editingMonitorOnContentChanged: (NSString *)  content
optional

A callback function which is triggered when the content is changed.

Parameters
[in]ws_contentThe content.
Returns
None.

◆ enablePopupMenuItem:popupMenuItem:is_enabled:

- (BOOL) enablePopupMenuItem: (void *)  h_popup_menu
popupMenuItem: (FSFillerAssistCallbackPopupMenuItem)  popupMenuItem
is_enabled: (BOOL)  is_enabled 
optional

A callback function which is triggered when need to enable popup menu item for popup menu.

This callback function supports text field, combo box field.

Parameters
[in]h_popup_menuThe popup menu handle.
[in]popup_menu_itemThe popup menu item id.Please refer to values starting from PopupMenuItem::e_PopupMenuItemNone and this should be one of these values.
[in]is_enabledWhether to enable menu item or disable.
Returns
true means success, while false means failure.

◆ executeAction:action:

- (void) executeAction: (FSPDFPage *)  page
action: (FSAction *)  action 
optional

A callback function which is triggered when need to execute action.

Parameters
[in]pageThe current page.
[in]actionThe action need to be executed.
Returns
None.

◆ focusGotOnControl:value:

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

A callback function which is triggered when the focus is set to a form control.

Currently, only support text field and combobox field.

Parameters
[in]controlThe form control object to which the focus is set.
[in]valueThe value of form field associated with the control.
Returns
None.

◆ focusLostFromControl:value:

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

A callback function which is triggered when the focus is lost from a form control.

Currently, only support text field and combobox field.

Parameters
[in]controlThe form control object, from which the focus is lost.
[in]valueThe value of form field associated with the control.
Returns
None.

◆ getClipboardText

- (NSString *) getClipboardText
optional

A callback function which is triggered when need to get the text on clipboard.

This callback function supports text field, combo box field.

Returns
The text on clipboard.

◆ killTimer:

- (BOOL) killTimer: (int)  timer_id
required

A callback function used to kill the timer event by timer identifier.

Parameters
[in]timer_idThe timer identifier returned by an earlier calling of callback function FSFillerAssistCallback::setTimer:timer:out_timer_id:.
Returns
YES means success, while NO means failure.

◆ refresh:rect:

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

A callback function used to refresh the specified area on a specified page.

Parameters
[in]pageA PDF page object.
[in]rectA rectangle that specifies the area on the page to be redrawn. nil means to refresh the whole page.
Returns
None.

◆ reportInvalidValue:invalid_value:

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

A callback function which is triggered when user entered an invalid value.

This callback function supports text field, combo box field.

Parameters
[in]form_field_nameThe name of form field associated with the control.
[in]invalid_valueThe invalid value of form field associated with the control.
Returns
None.

◆ setClipboardText:

- (void) setClipboardText: (NSString *)  text
optional

A callback function which is triggered when need to set clipboard text.

This callback function supports text field, combo box field.

Parameters
[in]textThe text need to be set to clipboard.
Returns
None.

◆ setTimer:timer:out_timer_id:

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

A callback function used to set a system timer.

This callback function is called to install a system timer. When a time-out value is specified, and every time when a time-out occurs, the system passes a message to the timer callback function.

Parameters
[in]elapseSpecifies the time-out value, in milliseconds.
[in]timerPointer to a timer callback object as timer.
[out]out_timer_idOutput parameter that receives the timer identifier of the new timer if the function is finished successfully. This value would be passed to callback function FSFillerAssistCallback::killTimer: to kill the timer. Nonzero if the function is successful; otherwise, this should be zero.
Returns
YES means success, while NO means failure.

◆ showPopupMenu:point:

- (BOOL) showPopupMenu: (void *)  h_popup_menu
point: (FSPointF *)  point 
optional

A callback function which is triggered when need to show popup menu.

This callback function supports text field, combo box field.

Parameters
[in]h_popup_menuThe menu handle.
[in]pointLeft-top point for popup menu, in PDF coordinate system.
Returns
true means success, while false means failure.