foxit-pdf-sdk-api-reference_51/html/fs__app__r_8h_source.html

 #ifndef _FSCRT_APP_R_H_
 #define _FSCRT_APP_R_H_

 #ifdef __cplusplus
 extern "C" {
 #endif

 /******************************************************************************/
 /* Note definitions - message & event                                         */
 /*                                                                            */
 /* Virtual key codes, note flags, note types, cursor types, note structure                  */
 /******************************************************************************/
 #ifndef _FSCRT_DEF_VKEY_
 #define _FSCRT_DEF_VKEY_

 #define FSCRT_VKEY_UNKNOWN              0x00
 #define FSCRT_VKEY_BACK                 0x08
 #define FSCRT_VKEY_TAB                  0x09
 #define FSCRT_VKEY_RETURN               0x0D
 #define FSCRT_VKEY_SHIFT                0x10
 #define FSCRT_VKEY_CONTROL              0x11
 #define FSCRT_VKEY_MENU                 0x12
 #define FSCRT_VKEY_PAUSE                0x13
 #define FSCRT_VKEY_ESCAPE               0x1B
 #define FSCRT_VKEY_SPACE                0x20
 #define FSCRT_VKEY_PRIOR                0x21
 #define FSCRT_VKEY_NEXT                 0x22
 #define FSCRT_VKEY_END                  0x23
 #define FSCRT_VKEY_HOME                 0x24
 #define FSCRT_VKEY_LEFT                 0x25
 #define FSCRT_VKEY_UP                   0x26
 #define FSCRT_VKEY_RIGHT                0x27
 #define FSCRT_VKEY_DOWN                 0x28
 #define FSCRT_VKEY_PRINT                0x2A
 #define FSCRT_VKEY_SNAPSHOT             0x2C
 #define FSCRT_VKEY_INSERT               0x2D
 #define FSCRT_VKEY_DELETE               0x2E
 #define FSCRT_VKEY_HELP                 0x2F
 #define FSCRT_VKEY_0                    0x30
 #define FSCRT_VKEY_1                    0x31
 #define FSCRT_VKEY_2                    0x32
 #define FSCRT_VKEY_3                    0x33
 #define FSCRT_VKEY_4                    0x34
 #define FSCRT_VKEY_5                    0x35
 #define FSCRT_VKEY_6                    0x36
 #define FSCRT_VKEY_7                    0x37
 #define FSCRT_VKEY_8                    0x38
 #define FSCRT_VKEY_9                    0x39
 #define FSCRT_VKEY_A                    0x41
 #define FSCRT_VKEY_B                    0x42
 #define FSCRT_VKEY_C                    0x43
 #define FSCRT_VKEY_D                    0x44
 #define FSCRT_VKEY_E                    0x45
 #define FSCRT_VKEY_F                    0x46
 #define FSCRT_VKEY_G                    0x47
 #define FSCRT_VKEY_H                    0x48
 #define FSCRT_VKEY_I                    0x49
 #define FSCRT_VKEY_J                    0x4A
 #define FSCRT_VKEY_K                    0x4B
 #define FSCRT_VKEY_L                    0x4C
 #define FSCRT_VKEY_M                    0x4D
 #define FSCRT_VKEY_N                    0x4E
 #define FSCRT_VKEY_O                    0x4F
 #define FSCRT_VKEY_P                    0x50
 #define FSCRT_VKEY_Q                    0x51
 #define FSCRT_VKEY_R                    0x52
 #define FSCRT_VKEY_S                    0x53
 #define FSCRT_VKEY_T                    0x54
 #define FSCRT_VKEY_U                    0x55
 #define FSCRT_VKEY_V                    0x56
 #define FSCRT_VKEY_W                    0x57
 #define FSCRT_VKEY_X                    0x58
 #define FSCRT_VKEY_Y                    0x59
 #define FSCRT_VKEY_Z                    0x5A
 #define FSCRT_VKEY_NUMPAD0              0x60
 #define FSCRT_VKEY_NUMPAD1              0x61
 #define FSCRT_VKEY_NUMPAD2              0x62
 #define FSCRT_VKEY_NUMPAD3              0x63
 #define FSCRT_VKEY_NUMPAD4              0x64
 #define FSCRT_VKEY_NUMPAD5              0x65
 #define FSCRT_VKEY_NUMPAD6              0x66
 #define FSCRT_VKEY_NUMPAD7              0x67
 #define FSCRT_VKEY_NUMPAD8              0x68
 #define FSCRT_VKEY_NUMPAD9              0x69
 #define FSCRT_VKEY_MULTIPLY             0x6A
 #define FSCRT_VKEY_ADD                  0x6B
 #define FSCRT_VKEY_SEPARATOR    0x6C
 #define FSCRT_VKEY_SUBTRACT             0x6D
 #define FSCRT_VKEY_DECIMAL              0x6E
 #define FSCRT_VKEY_DIVIDE               0x6F
 #define FSCRT_VKEY_F1                   0x70
 #define FSCRT_VKEY_F2                   0x71
 #define FSCRT_VKEY_F3                   0x72
 #define FSCRT_VKEY_F4                   0x73
 #define FSCRT_VKEY_F5                   0x74
 #define FSCRT_VKEY_F6                   0x75
 #define FSCRT_VKEY_F7                   0x76
 #define FSCRT_VKEY_F8                   0x77
 #define FSCRT_VKEY_F9                   0x78
 #define FSCRT_VKEY_F10                  0x79
 #define FSCRT_VKEY_F11                  0x7A
 #define FSCRT_VKEY_F12                  0x7B
 #endif /* _FSCRT_DEF_VKEY_ */

 #ifndef _FSCRT_DEF_NOTEFLAG_
 #define _FSCRT_DEF_NOTEFLAG_

 #define FSCRT_NOTEFLAG_SHIFTKEY                         0x0001
 #define FSCRT_NOTEFLAG_CONTROLKEY                       0x0002
 #define FSCRT_NOTEFLAG_ALTKEY                           0x0004
 #define FSCRT_NOTEFLAG_METAKEY                          0x0008
 #define FSCRT_NOTEFLAG_KEYPAD                           0x0010
 #define FSCRT_NOTEFLAG_AUTOREPEAT                       0x0020
 #define FSCRT_NOTEFLAG_LEFTBUTTONDOWN           0x0040
 #define FSCRT_NOTEFLAG_MIDDLEBUTTONDOWN         0x0080
 #define FSCRT_NOTEFLAG_RIGHTBUTTONDOWN          0x0100
 #endif /* _FSCRT_DEF_NOTEFLAG_ */

 #ifndef _FSCRT_DEF_NOTETYPE_
 #define _FSCRT_DEF_NOTETYPE_

 #define FSCRT_NOTETYPE_KEYDOWN                  1
 #define FSCRT_NOTETYPE_KEYUP                    2
 #define FSCRT_NOTETYPE_CHAR                             3
 #define FSCRT_NOTETYPE_LBUTTONDOWN              4
 #define FSCRT_NOTETYPE_LBUTTONUP                5
 #define FSCRT_NOTETYPE_LBUTTONDBLCLK    6
 #define FSCRT_NOTETYPE_RBUTTONDOWN              7
 #define FSCRT_NOTETYPE_RBUTTONUP                8
 #define FSCRT_NOTETYPE_RBUTTONDBLCLK    9
 #define FSCRT_NOTETYPE_MBUTTONDOWN              10
 #define FSCRT_NOTETYPE_MBUTTONUP                11
 #define FSCRT_NOTETYPE_MBUTTONDBLCLK    12
 #define FSCRT_NOTETYPE_MOUSEMOVE                13
 #define FSCRT_NOTETYPE_MOUSEENTER               14
 #define FSCRT_NOTETYPE_MOUSEHOVER               15
 #define FSCRT_NOTETYPE_MOUSELEAVE               16
 #define FSCRT_NOTETYPE_MOUSEWHEEL               17
 #define FSCRT_NOTETYPE_PAGEUP                   18
 #define FSCRT_NOTETYPE_PAGEDOWN                 19
 #define FSCRT_NOTETYPE_KILLFOCUS                20
 #endif /* _FSCRT_DEF_NOTETYPE_*/

 #ifndef _FSCRT_CURSOR_TYPE_
 #define _FSCRT_CURSOR_TYPE_

 #define FSCRT_CURSOR_ARROW      0
 #define FSCRT_CURSOR_NESW       1
 #define FSCRT_CURSOR_NWSE       2
 #define FSCRT_CURSOR_VBEAM      3
 #define FSCRT_CURSOR_HBEAM      4
 #define FSCRT_CURSOR_HAND       5
 #endif /* _FSCRT_CURSOR_TYPE_*/

 #ifndef _FSCRT_DEF_NOTEDATA_KEY_
 #define _FSCRT_DEF_NOTEDATA_KEY_

 typedef struct _FSCRT_NOTEDATA_KEY
 {
         FS_DWORD        flags;
         FS_DWORD        code;
 } FSCRT_NOTEDATA_KEY;

 #endif /* _FSCRT_DEF_NOTEDATA_KEY_ */

 #ifndef _FSCRT_DEF_NOTEDATA_CHAR_
 #define _FSCRT_DEF_NOTEDATA_CHAR_

 typedef struct _FSCRT_NOTEDATA_CHAR
 {
         FS_DWORD        flags;
         FS_DWORD        code;
 } FSCRT_NOTEDATA_CHAR;

 #endif /* _FSCRT_DEF_NOTEDATA_CHAR_ */

 #ifndef _FSCRT_DEF_NOTEDATA_MOUSE_
 #define _FSCRT_DEF_NOTEDATA_MOUSE_

 typedef struct _FSCRT_NOTEDATA_MOUSE
 {
         FS_DWORD        flags;
         FS_FLOAT        x;
         FS_FLOAT        y;
         FS_FLOAT        deltaX;
         FS_FLOAT        deltaY;
 } FSCRT_NOTEDATA_MOUSE;

 #endif /* _FSCRT_DEF_NOTEDATA_MOUSE_ */


 #ifndef _FSCRT_DEF_CALLBACK_TIMER_
 #define _FSCRT_DEF_CALLBACK_TIMER_

 typedef void            (*FSCRT_CALLBACK_TIMER)(FS_INT32 timer);

 #endif /* _FSCRT_DEF_CALLBACK_TIMER_ */


 #ifndef _FSCRT_DEF_EVENT_
 #define _FSCRT_DEF_EVENT_

 #define FSCRT_EVENT_KEYDOWN                                     FSCRT_NOTETYPE_KEYDOWN
 #define FSCRT_EVENT_KEYUP                                       FSCRT_NOTETYPE_KEYUP
 #define FSCRT_EVENT_CHAR                                        FSCRT_NOTETYPE_CHAR
 #define FSCRT_EVENT_LBUTTONDOWN                         FSCRT_NOTETYPE_LBUTTONDOWN
 #define FSCRT_EVENT_LBUTTONUP                           FSCRT_NOTETYPE_LBUTTONUP
 #define FSCRT_EVENT_LBUTTONDBLCLK                       FSCRT_NOTETYPE_LBUTTONDBLCLK
 #define FSCRT_EVENT_RBUTTONDOWN                         FSCRT_NOTETYPE_RBUTTONDOWN
 #define FSCRT_EVENT_RBUTTONUP                           FSCRT_NOTETYPE_RBUTTONUP
 #define FSCRT_EVENT_RBUTTONDBLCLK                       FSCRT_NOTETYPE_RBUTTONDBLCLK
 #define FSCRT_EVENT_MBUTTONDOWN                         FSCRT_NOTETYPE_MBUTTONDOWN
 #define FSCRT_EVENT_MBUTTONUP                           FSCRT_NOTETYPE_MBUTTONUP
 #define FSCRT_EVENT_MBUTTONDBLCLK                       FSCRT_NOTETYPE_MBUTTONDBLCLK
 #define FSCRT_EVENT_MOUSEMOVE                           FSCRT_NOTETYPE_MOUSEMOVE
 #define FSCRT_EVENT_MOUSEENTER                          FSCRT_NOTETYPE_MOUSEENTER
 #define FSCRT_EVENT_MOUSEHOVER                          FSCRT_NOTETYPE_MOUSEHOVER
 #define FSCRT_EVENT_MOUSELEAVE                          FSCRT_NOTETYPE_MOUSELEAVE
 #define FSCRT_EVENT_MOUSEWHEEL                          FSCRT_NOTETYPE_MOUSEWHEEL
 #define FSCRT_EVENT_PAGEUP                                      FSCRT_NOTETYPE_PAGEUP
 #define FSCRT_EVENT_PAGEDOWN                            FSCRT_NOTETYPE_PAGEDOWN
 #define FSCRT_EVENT_KILLFOCUS                           FSCRT_NOTETYPE_KILLFOCUS
 #endif /* _FSCRT_DEF_EVENT_ */

 /******************************************************************************/
 /* PSI event definition                                                       */
 /******************************************************************************/
 #ifndef _FSCRT_DEF_EVENT_PSI_
 #define _FSCRT_DEF_EVENT_PSI_

 #define FSCRT_EVENT_PSI_INVALIDATE                      ((FSCRT_OBJECTTYPE_PSI << 16) | 0)

 #endif /* _FSCRT_DEF_EVENT_PSI_ */

 /******************************************************************************/
 /* Application definitions                                                    */
 /*                                                                            */
 /* Application handler                                                        */
 /******************************************************************************/
 #ifndef _FSCRT_DEF_APPHANDLER_
 #define _FSCRT_DEF_APPHANDLER_

 typedef struct _FSCRT_APPHANDLER
 {
         FS_LPVOID       clientData;

         FS_RESULT       (*CallFunction)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 function, FSCRT_VAR* parameters, FS_INT32 count, FSCRT_VAR* ret);

         FS_RESULT       (*OnEvent)(FS_LPVOID clientData, FS_LPVOID senderObject, FS_DWORD senderObjectType, FS_DWORD eventType, FS_LPVOID eventData);

         void            (*OnOutOfMemory)(FS_LPVOID clientData);

         FS_RESULT               (*OnRecover)(FS_LPVOID clientData, FS_LPVOID senderObject, FS_DWORD senderObjectType);
 } FSCRT_APPHANDLER;

 #endif /* _FSCRT_DEF_APPHANDLER_ */

 FS_RESULT       FSCRT_Library_SetAppHandler(FSCRT_APPHANDLER* appHandler);

 FS_RESULT       FSCRT_Library_OOMRecover(FS_LPVOID senderObject, FS_DWORD senderObjectType);

 FS_RESULT       FSCRT_Library_TriggerRecover(FS_LPVOID senderObject, FS_DWORD senderObjectType);

 #ifdef __cplusplus
 };
 #endif
  /* group FSAPP */

 #endif /* _FSCRT_APP_R_H_ */

FSCRT_NOTEDATA_KEY::code
FS_DWORD code
Key code. Please refer to macro definitions FSCRT_VKEY_XXX and this can be one or combination of thes...
Definition: fs_app_r.h:235

FSCRT_NOTEDATA_CHAR::code
FS_DWORD code
Char code. It should be encoded as a UTF16-LE character code.
Definition: fs_app_r.h:252

FSCRT_NOTEDATA_MOUSE
Structure for note mouse.
Definition: fs_app_r.h:264

FS_FLOAT
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148

FSCRT_NOTEDATA_MOUSE::deltaX
FS_FLOAT deltaX
Mouse wheel.
Definition: fs_app_r.h:272

FSCRT_NOTEDATA_MOUSE::deltaY
FS_FLOAT deltaY
Mouse wheel.
Definition: fs_app_r.h:273

FSCRT_NOTEDATA_MOUSE::x
FS_FLOAT x
Mouse position.
Definition: fs_app_r.h:270

FSCRT_CALLBACK_TIMER
void(* FSCRT_CALLBACK_TIMER)(FS_INT32 timer)
Declares a pointer type for the callback function for the FSPDF_FORMFILL_INFO::SetTimer method...
Definition: fs_app_r.h:289

FS_DWORD
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142

FS_INT32
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175

FSCRT_NOTEDATA_KEY::flags
FS_DWORD flags
Key flags. Please refer to macro definitions FSCRT_NOTEFLAG_XXX and this should be one of these macro...
Definition: fs_app_r.h:233

FSCRT_NOTEDATA_KEY
Structure for note key.
Definition: fs_app_r.h:230

FSCRT_Library_SetAppHandler
FS_RESULT FSCRT_Library_SetAppHandler(FSCRT_APPHANDLER *appHandler)
Set a handler to Foxit PDF SDK library to support extension functions and events. ...

FSCRT_APPHANDLER::clientData
FS_LPVOID clientData
User-defined data.
Definition: fs_app_r.h:357

FSCRT_VAR
Structure for variant definitions.
Definition: fs_base_r.h:369

FSCRT_NOTEDATA_MOUSE::y
FS_FLOAT y
Mouse position.
Definition: fs_app_r.h:271

FS_LPVOID
void * FS_LPVOID
A pointer to any types.
Definition: fs_base_r.h:127

FSCRT_APPHANDLER
Structure for a application handler.
Definition: fs_app_r.h:350

FSCRT_Library_OOMRecover
FS_RESULT FSCRT_Library_OOMRecover(FS_LPVOID senderObject, FS_DWORD senderObjectType)
Trigger the user operation for recovery from out of memory. Only used for OOM handling.

FSCRT_Library_TriggerRecover
FS_RESULT FSCRT_Library_TriggerRecover(FS_LPVOID senderObject, FS_DWORD senderObjectType)
Trigger a recovery for handle of non-PDF module. Only used for OOM handling.

FSCRT_NOTEDATA_MOUSE::flags
FS_DWORD flags
The note flags. Please refer to macro definitions FSCRT_NOTEFLAG_XXX and this should be one of these ...
Definition: fs_app_r.h:269

FSCRT_NOTEDATA_CHAR::flags
FS_DWORD flags
Flags. Please refer to macro definitions FSCRT_NOTEFLAG_XXX and this should be one of these macros...
Definition: fs_app_r.h:250

FS_RESULT
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160

FSCRT_NOTEDATA_CHAR
Structure for character code.
Definition: fs_app_r.h:247