FSPDF_FORMINTERACTION_WINDOWLESS Struct Reference

Structure for windowless form interaction information. More...

#include <fpdf_form_w.h>

Public Attributes

FS_DWORD lStructSize
 The size of the data structure. It must be set to sizeof(FSPDF_FORMINTERACTION_WINDOWLESS).
 
FS_LPVOID clientData
 The user-supplied data.
 
FS_RESULT(* OutputSelectedRect )(FS_LPVOID clientData, FS_INT32 pageIndex, FSCRT_RECTF *pdfRect)
 When user is taking the mouse to select texts on a form field, this callback function will keep returning the selected areas to the implementation. More...
 
FS_RESULT(* SetCursor )(FS_LPVOID clientData, FS_INT32 nCursorType)
 Set the Cursor shape. More...
 
FS_RESULT(* SetTimer )(FS_LPVOID clientData, FS_INT32 uElapse, FSCRT_CALLBACK_TIMER lpTimerFunc, FS_INT32 *timeID)
 This method installs a system timer. A time-out value is specified, and every time a time-out occurs, the system passes a message to the TimerProc callback function. More...
 
FS_RESULT(* KillTimer )(FS_LPVOID clientData, FS_INT32 timerID)
 This method kills the timer event identified by nIDEvent, set by an earlier call to SetTimer. More...
 
FS_RESULT(* GotFocusOnControl )(FS_LPVOID clientData, FSPDF_FORMCONTROL control, const FSCRT_BSTR *filedValue)
 This method will be called when the focus is set to a form control. More...
 
FS_RESULT(* LostFocusOnControl )(FS_LPVOID clientData, FSPDF_FORMCONTROL control, const FSCRT_BSTR *filedValue)
 This method will be called when the focus is lost from a form control. More...
 

Detailed Description

Structure for windowless form interaction information.

Member Data Documentation

FS_RESULT(* FSPDF_FORMINTERACTION_WINDOWLESS::GotFocusOnControl) (FS_LPVOID clientData, FSPDF_FORMCONTROL control, const FSCRT_BSTR *filedValue)

This method will be called when the focus is set to a form control.

Parameters
[in]clientDataPointer to user-defined data.
[in]controlHandler to a FSPDF_FORMCONTROL object.
[in]filedValueThe value of form field associated with the control.
Returns
FSCRT_ERRCODE_SUCCESS if successful.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.
Note
Currently,only support text field and combobox field.
FS_RESULT(* FSPDF_FORMINTERACTION_WINDOWLESS::KillTimer) (FS_LPVOID clientData, FS_INT32 timerID)

This method kills the timer event identified by nIDEvent, set by an earlier call to SetTimer.

Parameters
[in]clientDataPointer to user-defined data.
[in]timerIDThe timer ID returned by FSPDF_FORMINTERACTION_WINDOWLESS::SetTimer function.
Returns
FSCRT_ERRCODE_SUCCESS if successful.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.
FS_RESULT(* FSPDF_FORMINTERACTION_WINDOWLESS::LostFocusOnControl) (FS_LPVOID clientData, FSPDF_FORMCONTROL control, const FSCRT_BSTR *filedValue)

This method will be called when the focus is lost from a form control.

Parameters
[in]clientDataPointer to user-defined data.
[in]controlHandler to a FSPDF_FORMCONTROL object.
[in]filedValueThe value of form field associated with the control.
Returns
FSCRT_ERRCODE_SUCCESS if successful.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.
Note
Currently,only support text field and combobox field.
FS_RESULT(* FSPDF_FORMINTERACTION_WINDOWLESS::OutputSelectedRect) (FS_LPVOID clientData, FS_INT32 pageIndex, FSCRT_RECTF *pdfRect)

When user is taking the mouse to select texts on a form field, this callback function will keep returning the selected areas to the implementation.

This CALLBACK function is useful for implementing special text selection effect. Implementation should first record the returned rectangles, then draw them one by one in the painting period, and finally remove all the recorded rectangles when finish painting.

Parameters
[in]clientDataPointer to user-defined data.
[in]pageIndexThe page index which starts from 0.
[in]pdfRectPointer to a FSCRT_RECTF structure, which specifies the page area in PDF page coordinate.
Returns
FSCRT_ERRCODE_SUCCESS if successful.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.
FS_RESULT(* FSPDF_FORMINTERACTION_WINDOWLESS::SetCursor) (FS_LPVOID clientData, FS_INT32 nCursorType)

Set the Cursor shape.

Parameters
[in]clientDataPointer to user-defined data.
[in]nCursorTypeCursor type. Please refer to macro definitions FSCRT_CURSOR_XXX and this should be one of these macros.
Returns
FSCRT_ERRCODE_SUCCESS if successful.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.
FS_RESULT(* FSPDF_FORMINTERACTION_WINDOWLESS::SetTimer) (FS_LPVOID clientData, FS_INT32 uElapse, FSCRT_CALLBACK_TIMER lpTimerFunc, FS_INT32 *timeID)

This method installs a system timer. A time-out value is specified, and every time a time-out occurs, the system passes a message to the TimerProc callback function.

Parameters
[in]clientDataPointer to user-defined data.
[in]uElapseSpecifies the time-out value, in milliseconds.
[in]lpTimerFuncA pointer to the callback function-TimerCallback.
[out]timeIDThe timer identifier of the new timer if the function is successful. An application passes this value to the KillTimer method to kill the timer. Nonzero if it is successful; otherwise, it is zero.
Returns
FSCRT_ERRCODE_SUCCESS if successful.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.

The documentation for this struct was generated from the following file:

Foxit Corporation