My Project
foxit::pdf::interform::FillerAssistCallback Class Referenceabstract

Public Member Functions

virtual void FocusGotOnControl (const Control &control, const char *value)=0
 A callback function which is triggered when the focus is set to a form control. More...
 
virtual void FocusLostFromControl (const Control &control, const char *value)=0
 A callback function which is triggered when the focus is lost from a form control. More...
 
virtual int GetVersion ()
 Get the version of derived implementation, for compatibility reason. More...
 
virtual bool KillTimer (int timer_id)=0
 A callback function used to kill the timer event by timer identifier. More...
 
virtual void Refresh (const PDFPage &page, const RectF *rect)=0
 A callback function used to refresh the specified area on a specified page. More...
 
virtual void Release ()=0
 A callback function used to release current callback object itself. More...
 
virtual bool SetTimerCallback (int elapse, TimerCallback *timer, int *out_timer_id)=0
 A callback function used to set a system timer. 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.

Member Function Documentation

◆ FocusGotOnControl()

virtual void foxit::pdf::interform::FillerAssistCallback::FocusGotOnControl ( const Control control,
const char *  value 
)
pure virtual

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.

Parameters
[in]controlThe form control object to which the focus is set.
[in]valueThe 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.
Returns
None.

◆ FocusLostFromControl()

virtual void foxit::pdf::interform::FillerAssistCallback::FocusLostFromControl ( const Control control,
const char *  value 
)
pure virtual

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.

Parameters
[in]controlThe form control object, from which the focus is lost.
[in]valueThe 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.
Returns
None.

◆ GetVersion()

virtual int foxit::pdf::interform::FillerAssistCallback::GetVersion ( )
inlinevirtual

Get the version of derived implementation, for compatibility reason.

Returns
Version of derived implementation.

◆ KillTimer()

virtual bool foxit::pdf::interform::FillerAssistCallback::KillTimer ( int  timer_id)
pure virtual

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 FillerAssistCallback::SetTimerCallback.
Returns
true means success, while false means failure.

◆ Refresh()

virtual void foxit::pdf::interform::FillerAssistCallback::Refresh ( const PDFPage page,
const RectF rect 
)
pure virtual

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. NULL means to refresh the whole page.
Returns
None.

◆ Release()

virtual void foxit::pdf::interform::FillerAssistCallback::Release ( )
pure virtual

A callback function used to release current callback object itself.

Returns
None.

◆ SetTimerCallback()

virtual bool foxit::pdf::interform::FillerAssistCallback::SetTimerCallback ( int  elapse,
TimerCallback timer,
int *  out_timer_id 
)
pure virtual

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]timerA TimerCallback 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 FillerAssistCallback::KillTimer to kill the timer. Nonzero if the function is successful; otherwise, this should be zero.
Returns
true means success, while false means failure.

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.