| OLD | NEW |
| 1 // Copyright 2014 PDFium Authors. All rights reserved. | 1 // Copyright 2014 PDFium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com | 5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com |
| 6 | 6 |
| 7 #ifndef PUBLIC_FPDF_FORMFILL_H_ |
| 8 #define PUBLIC_FPDF_FORMFILL_H_ |
| 7 | 9 |
| 8 #ifndef _FPDFORMFILL_H | |
| 9 #define _FPDFORMFILL_H | |
| 10 #include "fpdfview.h" | 10 #include "fpdfview.h" |
| 11 | 11 |
| 12 typedef void* FPDF_FORMHANDLE; | 12 typedef void* FPDF_FORMHANDLE; |
| 13 | 13 |
| 14 // Exported Functions | 14 // Exported Functions |
| 15 #ifdef __cplusplus | 15 #ifdef __cplusplus |
| 16 extern "C" { | 16 extern "C" { |
| 17 #endif | 17 #endif |
| 18 | 18 |
| 19 typedef struct _IPDF_JsPlatform | 19 typedef struct _IPDF_JsPlatform |
| 20 { | 20 { |
| 21 /** | 21 /** |
| 22 * Version number of the interface. Currently must be 1. | 22 * Version number of the interface. Currently must be 1. |
| 23 **/ | 23 **/ |
| 24 int version; | 24 int version; |
| 25 | 25 |
| 26 /** | 26 /** |
| 27 * Method: app_alert | 27 * Method: app_alert |
| 28 * pop up a dialog to show warning or hint. | 28 * pop up a dialog to show warning or hint. |
| 29 * Interface Version: | 29 * Interface Version: |
| 30 * 1 | 30 * 1 |
| 31 * Implementation Required: | 31 * Implementation Required: |
| 32 * yes | 32 * yes |
| 33 * Parameters: | 33 * Parameters: |
| 34 * pThis - Pointer to the interface
structure itself | 34 * pThis - Pointer to the interface structure itself |
| 35 * Msg - A string contain
ing the message to be displayed. | 35 * Msg - A string containing the message to be displayed. |
| 36 * Title - The title of the dialog. | 36 * Title - The title of the dialog. |
| 37 * Type - The stype of button grou
p. | 37 * Type - The stype of button group. |
| 38 * 0-OK(default); | 38 * 0-OK(default); |
| 39 * 1-OK,Cancel; | 39 * 1-OK,Cancel; |
| 40 * 2-Yes,NO; | 40 * 2-Yes,NO; |
| 41 * 3-Yes, NO, Cance
l. | 41 * 3-Yes, NO, Cancel. |
| 42 * nIcon - The Icon type. | 42 * nIcon - The Icon type. |
| 43 * 0-Error(default)
; | 43 * 0-Error(default); |
| 44 * 1-Warning; | 44 * 1-Warning; |
| 45 * 2-Question; | 45 * 2-Question; |
| 46 * 3-Status. | 46 * 3-Status. |
| 47 * Return Value: | 47 * Return Value: |
| 48 * The return value could be the folowing type: | 48 * The return value could be the folowing type: |
| 49 * 1-OK; | 49 * 1-OK; |
| 50 * 2-Cancel; | 50 * 2-Cancel; |
| 51 * 3-NO; | 51 * 3-NO; |
| 52 * 4-Yes; | 52 * 4-Yes; |
| 53 */ | 53 */ |
| 54 int (*app_alert)(struct _IPDF_JsPlatform* pThis, FPDF_WIDESTRING Msg, FP
DF_WIDESTRING Title, int Type, int Icon); | 54 int (*app_alert)(struct _IPDF_JsPlatform* pThis, FPDF_WIDESTRING Msg, FPDF_W
IDESTRING Title, int Type, int Icon); |
| 55 | 55 |
| 56 /** | 56 /** |
| 57 * Method: app_beep | 57 * Method: app_beep |
| 58 * Causes the system to play a sound. | 58 * Causes the system to play a sound. |
| 59 * Interface Version: | 59 * Interface Version: |
| 60 * 1 | 60 * 1 |
| 61 * Implementation Required: | 61 * Implementation Required: |
| 62 * yes | 62 * yes |
| 63 * Parameters: | 63 * Parameters: |
| 64 * pThis - Pointer to the interface
structure itself | 64 * pThis - Pointer to the interface structure itself |
| 65 * nType - The sound type. | 65 * nType - The sound type. |
| 66 * 0 - Error | 66 * 0 - Error |
| 67 * 1 - Warning | 67 * 1 - Warning |
| 68 * 2 - Question | 68 * 2 - Question |
| 69 * 3 - Status | 69 * 3 - Status |
| 70 * 4 - Default (def
ault value) | 70 * 4 - Default (default value) |
| 71 * Return Value: | 71 * Return Value: |
| 72 * None | 72 * None |
| 73 */ | 73 */ |
| 74 void (*app_beep)(struct _IPDF_JsPlatform* pThis, int nType); | 74 void (*app_beep)(struct _IPDF_JsPlatform* pThis, int nType); |
| 75 | 75 |
| 76 /** | 76 /** |
| 77 * Method: app_response | 77 * Method: app_response |
| 78 * Displays a dialog box containing a question and
an entry field for the user to reply to the question. | 78 * Displays a dialog box containing a question and an entry field f
or the user to reply to the question. |
| 79 * Interface Version: | 79 * Interface Version: |
| 80 * 1 | 80 * 1 |
| 81 * Implementation Required: | 81 * Implementation Required: |
| 82 * yes | 82 * yes |
| 83 * Parameters: | 83 * Parameters: |
| 84 * pThis - Pointer to the interface
structure itself | 84 * pThis - Pointer to the interface structure itself |
| 85 * Question - The question to be posed
to the user. | 85 * Question - The question to be posed to the user. |
| 86 * Title - The title of the dialog
box. | 86 * Title - The title of the dialog box. |
| 87 * Default - A default value for the
answer to the question. If not specified, no default value is presented. | 87 * Default - A default value for the answer to the question.
If not specified, no default value is presented. |
| 88 * cLabel - A short string to appear
in front of and on the same line as the edit text field. | 88 * cLabel - A short string to appear in front of and on the
same line as the edit text field. |
| 89 * bPassword - If true, indicates that
the user's response should show as asterisks (*) or bullets (?) to mask the resp
onse, which might be sensitive information. The default is false. | 89 * bPassword - If true, indicates that the user's response shou
ld show as asterisks (*) or bullets (?) to mask the response, which might be sen
sitive information. The default is false. |
| 90 * response - A string buffer allocate
d by SDK, to receive the user's response. | 90 * response - A string buffer allocated by SDK, to receive the
user's response. |
| 91 * length - The length of the buffer, nu
mber of bytes. Currently, It's always be 2048. | 91 * length - The length of the buffer, number of bytes. Curre
ntly, It's always be 2048. |
| 92 * Return Value: | 92 * Return Value: |
| 93 * Number of bytes the complete user input would actually r
equire, not including trailing zeros, regardless of the value of the length | 93 * Number of bytes the complete user input would actually require, not
including trailing zeros, regardless of the value of the length |
| 94 * parameter or the presence of the response buffer. | 94 * parameter or the presence of the response buffer. |
| 95 * Comments: | 95 * Comments: |
| 96 * No matter on what platform, the response buffer should b
e always written using UTF-16LE encoding. If a response buffer is | 96 * No matter on what platform, the response buffer should be always wri
tten using UTF-16LE encoding. If a response buffer is |
| 97 * present and the size of the user input exceeds the capac
ity of the buffer as specified by the length parameter, only the | 97 * present and the size of the user input exceeds the capacity of the b
uffer as specified by the length parameter, only the |
| 98 * first "length" bytes of the user input are to be written
to the buffer. | 98 * first "length" bytes of the user input are to be written to the buff
er. |
| 99 */ | 99 */ |
| 100 int (*app_response)(struct _IPDF_JsPlatform* pThis, FPDF_WIDESTRING Ques
tion, FPDF_WIDESTRING Title, FPDF_WIDESTRING Default, FPDF_WIDESTRING cLabel, FP
DF_BOOL bPassword, void* response, int length); | 100 int (*app_response)(struct _IPDF_JsPlatform* pThis, FPDF_WIDESTRING Question
, FPDF_WIDESTRING Title, FPDF_WIDESTRING Default, FPDF_WIDESTRING cLabel, FPDF_B
OOL bPassword, void* response, int length); |
| 101 | 101 |
| 102 /* | 102 /* |
| 103 * Method: Doc_getFilePath | 103 * Method: Doc_getFilePath |
| 104 * Get the file path of the current document. | 104 * Get the file path of the current document. |
| 105 * Interface Version: | 105 * Interface Version: |
| 106 * 1 | 106 * 1 |
| 107 * Implementation Required: | 107 * Implementation Required: |
| 108 * yes | 108 * yes |
| 109 * Parameters: | 109 * Parameters: |
| 110 * pThis - Pointer to the interface
structure itself | 110 * pThis - Pointer to the interface structure itself |
| 111 * filePath - The string buffer to rec
eive the file path. Can be NULL. | 111 * filePath - The string buffer to receive the file path. Can
be NULL. |
| 112 * length - The length of the buffer, nu
mber of bytes. Can be 0. | 112 * length - The length of the buffer, number of bytes. Can b
e 0. |
| 113 * Return Value: | 113 * Return Value: |
| 114 * Number of bytes the filePath consumes, including trailin
g zeros. | 114 * Number of bytes the filePath consumes, including trailing zeros. |
| 115 * Comments: | 115 * Comments: |
| 116 * The filePath should be always input in local encoding. | 116 * The filePath should be always input in local encoding. |
| 117 * | 117 * |
| 118 * The return value always indicated number of bytes requir
ed for the buffer, even when there is | 118 * The return value always indicated number of bytes required for the b
uffer, even when there is |
| 119 * no buffer specified, or the buffer size is less then req
uired. In this case, the buffer will not | 119 * no buffer specified, or the buffer size is less then required. In th
is case, the buffer will not |
| 120 * be modified. | 120 * be modified. |
| 121 */ | 121 */ |
| 122 int (*Doc_getFilePath)(struct _IPDF_JsPlatform* pThis, void* filePath, i
nt length); | 122 int (*Doc_getFilePath)(struct _IPDF_JsPlatform* pThis, void* filePath, int l
ength); |
| 123 | 123 |
| 124 | 124 |
| 125 /* | 125 /* |
| 126 * Method: Doc_mail | 126 * Method: Doc_mail |
| 127 * Mails the data buffer as an attachment to all re
cipients, with or without user interaction. | 127 * Mails the data buffer as an attachment to all recipients, with o
r without user interaction. |
| 128 * Interface Version: | 128 * Interface Version: |
| 129 * 1 | 129 * 1 |
| 130 * Implementation Required: | 130 * Implementation Required: |
| 131 * yes | 131 * yes |
| 132 * Parameters: | 132 * Parameters: |
| 133 * pThis - Pointer to the interface
structure itself | 133 * pThis - Pointer to the interface structure itself |
| 134 * mailData - Pointer to the data buff
er to be sent.Can be NULL. | 134 * mailData - Pointer to the data buffer to be sent.Can be NUL
L. |
| 135 * length - The size,in bytes, of th
e buffer pointed by mailData parameter.Can be 0. | 135 * length - The size,in bytes, of the buffer pointed by mail
Data parameter.Can be 0. |
| 136 * bUI - If true, the rest of
the parameters are used in a compose-new-message window that is displayed to th
e user. If false, the cTo parameter is required and all others are optional. | 136 * bUI - If true, the rest of the parameters are used in
a compose-new-message window that is displayed to the user. If false, the cTo pa
rameter is required and all others are optional. |
| 137 * To - A semicolon-deli
mited list of recipients for the message. | 137 * To - A semicolon-delimited list of recipients for the
message. |
| 138 * Subject - The subject of the message.
The length limit is 64 KB. | 138 * Subject - The subject of the message. The length limit is
64 KB. |
| 139 * CC - A semicolon-deli
mited list of CC recipients for the message. | 139 * CC - A semicolon-delimited list of CC recipients for
the message. |
| 140 * BCC - A semicolon-delimite
d list of BCC recipients for the message. | 140 * BCC - A semicolon-delimited list of BCC recipients for
the message. |
| 141 * Msg - The content of the m
essage. The length limit is 64 KB. | 141 * Msg - The content of the message. The length limit is
64 KB. |
| 142 * Return Value: | 142 * Return Value: |
| 143 * None. | 143 * None. |
| 144 * Comments: | 144 * Comments: |
| 145 * If the parameter mailData is NULL or length is 0
, the current document will be mailed as an attachment to all recipients. | 145 * If the parameter mailData is NULL or length is 0, the current do
cument will be mailed as an attachment to all recipients. |
| 146 */ | 146 */ |
| 147 void (*Doc_mail)(struct _IPDF_JsPlatform* pThis,void* mailData, int leng
th,FPDF_BOOL bUI, FPDF_WIDESTRING To, FPDF_WIDESTRING Subject, FPDF_WIDESTRING C
C, FPDF_WIDESTRING BCC, FPDF_WIDESTRING Msg); | 147 void (*Doc_mail)(struct _IPDF_JsPlatform* pThis,void* mailData, int length,F
PDF_BOOL bUI, FPDF_WIDESTRING To, FPDF_WIDESTRING Subject, FPDF_WIDESTRING CC, F
PDF_WIDESTRING BCC, FPDF_WIDESTRING Msg); |
| 148 | 148 |
| 149 | 149 |
| 150 /* | 150 /* |
| 151 * Method: Doc_print | 151 * Method: Doc_print |
| 152 * Prints all or a specific number of pages of the
document. | 152 * Prints all or a specific number of pages of the document. |
| 153 * Interface Version: | 153 * Interface Version: |
| 154 * 1 | 154 * 1 |
| 155 * Implementation Required: | 155 * Implementation Required: |
| 156 * yes | 156 * yes |
| 157 * Parameters: | 157 * Parameters: |
| 158 * pThis - Pointer to the interface
structure itself. | 158 * pThis - Pointer to the interface structure itself. |
| 159 * bUI - If true, will ca
use a UI to be presented to the user to obtain printing information and confirm
the action. | 159 * bUI - If true, will cause a UI to be presented to the
user to obtain printing information and confirm the action. |
| 160 * nStart - A 0-based index that def
ines the start of an inclusive range of pages. | 160 * nStart - A 0-based index that defines the start of an inc
lusive range of pages. |
| 161 * nEnd - A 0-based index that defines
the end of an inclusive page range. | 161 * nEnd - A 0-based index that defines the end of an inclu
sive page range. |
| 162 * bSilent - If true, suppresses the canc
el dialog box while the document is printing. The default is false. | 162 * bSilent - If true, suppresses the cancel dialog box while
the document is printing. The default is false. |
| 163 * bShrinkToFit - If true, the page is shr
unk (if necessary) to fit within the imageable area of the printed page. | 163 * bShrinkToFit - If true, the page is shrunk (if necessary) t
o fit within the imageable area of the printed page. |
| 164 * bPrintAsImage - If true, print pages as
an image. | 164 * bPrintAsImage - If true, print pages as an image. |
| 165 * bReverse - If true, print from nEnd
to nStart. | 165 * bReverse - If true, print from nEnd to nStart. |
| 166 * bAnnotations - If true (the default), a
nnotations are printed. | 166 * bAnnotations - If true (the default), annotations are print
ed. |
| 167 */ | 167 */ |
| 168 void (*Doc_print)(struct _IPDF_JsPlatform* pThis, FPDF_BOOL bUI, int nSt
art, int nEnd, FPDF_BOOL bSilent ,FPDF_BOOL bShrinkToFit,FPDF_BOOL bPrintAsImage
,FPDF_BOOL bReverse ,FPDF_BOOL bAnnotations); | 168 void (*Doc_print)(struct _IPDF_JsPlatform* pThis, FPDF_BOOL bUI, int nStart,
int nEnd, FPDF_BOOL bSilent ,FPDF_BOOL bShrinkToFit,FPDF_BOOL bPrintAsImage ,FP
DF_BOOL bReverse ,FPDF_BOOL bAnnotations); |
| 169 | 169 |
| 170 /* | 170 /* |
| 171 * Method: Doc_submitForm | 171 * Method: Doc_submitForm |
| 172 * Send the form data to a specified URL. | 172 * Send the form data to a specified URL. |
| 173 * Interface Version: | 173 * Interface Version: |
| 174 * 1 | 174 * 1 |
| 175 * Implementation Required: | 175 * Implementation Required: |
| 176 * yes | 176 * yes |
| 177 * Parameters: | 177 * Parameters: |
| 178 * pThis - Pointer to the interface
structure itself | 178 * pThis - Pointer to the interface structure itself |
| 179 * formData - Pointer to the data buff
er to be sent. | 179 * formData - Pointer to the data buffer to be sent. |
| 180 * length - The size,in bytes, of th
e buffer pointed by formData parameter. | 180 * length - The size,in bytes, of the buffer pointed by form
Data parameter. |
| 181 * URL - The URL to send
to. | 181 * URL - The URL to send to. |
| 182 * Return Value: | 182 * Return Value: |
| 183 * None. | 183 * None. |
| 184 * | 184 * |
| 185 */ | 185 */ |
| 186 void (*Doc_submitForm)(struct _IPDF_JsPlatform* pThis,void* formData, in
t length, FPDF_WIDESTRING URL); | 186 void (*Doc_submitForm)(struct _IPDF_JsPlatform* pThis,void* formData, int le
ngth, FPDF_WIDESTRING URL); |
| 187 | 187 |
| 188 /* | 188 /* |
| 189 * Method: Doc_gotoPage | 189 * Method: Doc_gotoPage |
| 190 * Jump to a specified page. | 190 * Jump to a specified page. |
| 191 * Interface Version: | 191 * Interface Version: |
| 192 * 1 | 192 * 1 |
| 193 * Implementation Required: | 193 * Implementation Required: |
| 194 * yes | 194 * yes |
| 195 * Parameters: | 195 * Parameters: |
| 196 * pThis - Pointer to the interface
structure itself | 196 * pThis - Pointer to the interface structure itself |
| 197 * nPageNum - The specified page numbe
r, zero for the first page. | 197 * nPageNum - The specified page number, zero for the first pa
ge. |
| 198 * Return Value: | 198 * Return Value: |
| 199 * None. | 199 * None. |
| 200 * | 200 * |
| 201 */ | 201 */ |
| 202 void (*Doc_gotoPage)(struct _IPDF_JsPlatform* pThis, int nPageNum); | 202 void (*Doc_gotoPage)(struct _IPDF_JsPlatform* pThis, int nPageNum); |
| 203 /* | 203 /* |
| 204 * Method: Field_browse | 204 * Method: Field_browse |
| 205 * Show a file selection dialog, and return the sel
ected file path. | 205 * Show a file selection dialog, and return the selected file path. |
| 206 * Interface Version: | 206 * Interface Version: |
| 207 * 1 | 207 * 1 |
| 208 * Implementation Required: | 208 * Implementation Required: |
| 209 * yes | 209 * yes |
| 210 * Parameters: | 210 * Parameters: |
| 211 * pThis - Pointer to the interface
structure itself. | 211 * pThis - Pointer to the interface structure itself. |
| 212 * filePath - Pointer to the data buff
er to receive the file path.Can be NULL. | 212 * filePath - Pointer to the data buffer to receive the file p
ath.Can be NULL. |
| 213 * length - The length of the buffer, nu
mber of bytes. Can be 0. | 213 * length - The length of the buffer, number of bytes. Can b
e 0. |
| 214 * Return Value: | 214 * Return Value: |
| 215 * Number of bytes the filePath consumes, including trailin
g zeros. | 215 * Number of bytes the filePath consumes, including trailing zeros. |
| 216 * Comments: | 216 * Comments: |
| 217 * The filePath shoule be always input in local encoding. | 217 * The filePath shoule be always input in local encoding. |
| 218 */ | 218 */ |
| 219 int (*Field_browse)(struct _IPDF_JsPlatform* pThis,void* filePath, int
length); | 219 int (*Field_browse)(struct _IPDF_JsPlatform* pThis,void* filePath, int leng
th); |
| 220 | 220 |
| 221 /** | 221 /** |
| 222 * pointer to FPDF_FORMFILLINFO interface. | 222 * pointer to FPDF_FORMFILLINFO interface. |
| 223 **/ | 223 **/ |
| 224 void* m_pFormfillinfo; | 224 void* m_pFormfillinfo; |
| 225 } IPDF_JSPLATFORM; | 225 } IPDF_JSPLATFORM; |
| 226 | 226 |
| 227 // Flags for Cursor type | 227 // Flags for Cursor type |
| 228 #define FXCT_ARROW» 0 | 228 #define FXCT_ARROW 0 |
| 229 #define FXCT_NESW» 1» » | 229 #define FXCT_NESW 1 |
| 230 #define FXCT_NWSE» 2» » | 230 #define FXCT_NWSE 2 |
| 231 #define FXCT_VBEAM» 3» » | 231 #define FXCT_VBEAM 3 |
| 232 #define FXCT_HBEAM» 4» | 232 #define FXCT_HBEAM 4 |
| 233 #define FXCT_HAND» 5 | 233 #define FXCT_HAND 5 |
| 234 | 234 |
| 235 /** | 235 /** |
| 236 * Declares of a pointer type to the callback function for the FFI_SetTimer meth
od. | 236 * Declares of a pointer type to the callback function for the FFI_SetTimer meth
od. |
| 237 * Parameters: | 237 * Parameters: |
| 238 *» » » idEvent»» -» Identifier of the timer. | 238 * idEvent - Identifier of the timer. |
| 239 * Return value: | 239 * Return value: |
| 240 *» » » None. | 240 * None. |
| 241 **/» | 241 **/ |
| 242 typedef void» (*TimerCallback)(int idEvent); | 242 typedef void (*TimerCallback)(int idEvent); |
| 243 | 243 |
| 244 /** | 244 /** |
| 245 * Declares of a struct type to the local system time. | 245 * Declares of a struct type to the local system time. |
| 246 **/ | 246 **/ |
| 247 typedef struct _FPDF_SYSTEMTIME | 247 typedef struct _FPDF_SYSTEMTIME |
| 248 { | 248 { |
| 249 unsigned short wYear;» » » /* years since 1900 */ | 249 unsigned short wYear; /* years since 1900 */ |
| 250 unsigned short wMonth;» » » /* months since January - [0,11]
*/ | 250 unsigned short wMonth; /* months since January - [0,11] */ |
| 251 unsigned short wDayOfWeek;» » /* days since Sunday - [0,6] */ | 251 unsigned short wDayOfWeek; /* days since Sunday - [0,6] */ |
| 252 unsigned short wDay;» » » /* day of the month - [1,31] */ | 252 unsigned short wDay; /* day of the month - [1,31] */ |
| 253 unsigned short wHour;» » » /* hours since midnight - [0,23]
*/ | 253 unsigned short wHour; /* hours since midnight - [0,23] */ |
| 254 unsigned short wMinute;» » » /* minutes after the hour - [0,5
9] */ | 254 unsigned short wMinute; /* minutes after the hour - [0,59] */ |
| 255 unsigned short wSecond;» » » /* seconds after the minute - [0
,59] */ | 255 unsigned short wSecond; /* seconds after the minute - [0,59] */ |
| 256 unsigned short wMilliseconds;» /* milliseconds after the second - [0,99
9] */ | 256 unsigned short wMilliseconds; /* milliseconds after the second - [0,999] *
/ |
| 257 }FPDF_SYSTEMTIME; | 257 }FPDF_SYSTEMTIME; |
| 258 | 258 |
| 259 | 259 |
| 260 typedef struct _FPDF_FORMFILLINFO | 260 typedef struct _FPDF_FORMFILLINFO |
| 261 { | 261 { |
| 262 /** | 262 /** |
| 263 * Version number of the interface. Currently must be 1. | 263 * Version number of the interface. Currently must be 1. |
| 264 **/ | 264 **/ |
| 265 int version; | 265 int version; |
| 266 | 266 |
| 267 /** | 267 /** |
| 268 * Method: Release | 268 * Method: Release |
| 269 * Give implementation a chance to release any data
after the interface is no longer used | 269 * Give implementation a chance to release any data after the inter
face is no longer used |
| 270 * Interface Version: | 270 * Interface Version: |
| 271 * 1 | 271 * 1 |
| 272 * Implementation Required: | 272 * Implementation Required: |
| 273 * No | 273 * No |
| 274 * Comments: | 274 * Comments: |
| 275 * Called by Foxit SDK during the final cleanup pro
cess. | 275 * Called by Foxit SDK during the final cleanup process. |
| 276 * Parameters: | 276 * Parameters: |
| 277 * pThis - Pointer to the interface
structure itself | 277 * pThis - Pointer to the interface structure itself |
| 278 * Return Value: | 278 * Return Value: |
| 279 * None | 279 * None |
| 280 */ | 280 */ |
| 281 | 281 |
| 282 void (*Release)(struct _FPDF_FORMFILLINFO* pThis); | 282 void (*Release)(struct _FPDF_FORMFILLINFO* pThis); |
| 283 | 283 |
| 284 /** | 284 /** |
| 285 * Method: FFI_Invalidate | 285 * Method: FFI_Invalidate |
| 286 * Invalidate the client area within the specified
rectangle. | 286 * Invalidate the client area within the specified rectangle. |
| 287 * Interface Version: | 287 * Interface Version: |
| 288 * 1 | 288 * 1 |
| 289 * Implementation Required: | 289 * Implementation Required: |
| 290 * yes | 290 * yes |
| 291 * Parameters: | 291 * Parameters: |
| 292 * pThis - Pointer to the interface
structure itself. | 292 * pThis - Pointer to the interface structure itself. |
| 293 * page - Handle to the page. Retu
rned by FPDF_LoadPage function. | 293 * page - Handle to the page. Returned by FPDF_LoadPage fu
nction. |
| 294 * left - Left position of the cli
ent area in PDF page coordinate. | 294 * left - Left position of the client area in PDF page coo
rdinate. |
| 295 * top - Top position of
the client area in PDF page coordinate. | 295 * top - Top position of the client area in PDF page coo
rdinate. |
| 296 * right - Right position of the cl
ient area in PDF page coordinate. | 296 * right - Right position of the client area in PDF page c
oordinate. |
| 297 * bottom - Bottom position of the c
lient area in PDF page coordinate. | 297 * bottom - Bottom position of the client area in PDF page c
oordinate. |
| 298 * Return Value: | 298 * Return Value: |
| 299 * None. | 299 * None. |
| 300 * | 300 * |
| 301 *comments: | 301 *comments: |
| 302 * All positions are measured in PDF "user space". | 302 * All positions are measured in PDF "user space". |
| 303 * Implementation should call FPDF_RenderPageBitmap
() function for repainting a specified page area. | 303 * Implementation should call FPDF_RenderPageBitmap() function for
repainting a specified page area. |
| 304 */ | 304 */ |
| 305 void (*FFI_Invalidate)(struct _FPDF_FORMFILLINFO* pThis,FPDF_PAGE page,
double left, double top, double right, double bottom); | 305 void (*FFI_Invalidate)(struct _FPDF_FORMFILLINFO* pThis,FPDF_PAGE page, doub
le left, double top, double right, double bottom); |
| 306 | 306 |
| 307 /** | 307 /** |
| 308 * Method: FFI_OutputSelectedRect | 308 * Method: FFI_OutputSelectedRect |
| 309 * When user is taking the mouse to select texts on
a form field, this callback function will keep | 309 * When user is taking the mouse to select texts on a form field, t
his callback function will keep |
| 310 * returning the selected areas to the implementati
on. | 310 * returning the selected areas to the implementation. |
| 311 * | 311 * |
| 312 * Interface Version: | 312 * Interface Version: |
| 313 * 1 | 313 * 1 |
| 314 * Implementation Required: | 314 * Implementation Required: |
| 315 * No | 315 * No |
| 316 * Parameters: | 316 * Parameters: |
| 317 * pThis - Pointer to the interface
structure itself. | 317 * pThis - Pointer to the interface structure itself. |
| 318 * page - Handle to the page. Retu
rned by FPDF_LoadPage function. | 318 * page - Handle to the page. Returned by FPDF_LoadPage fu
nction. |
| 319 * left - Left position of the cli
ent area in PDF page coordinate. | 319 * left - Left position of the client area in PDF page coo
rdinate. |
| 320 * top - Top position of
the client area in PDF page coordinate. | 320 * top - Top position of the client area in PDF page coo
rdinate. |
| 321 * right - Right position of the cl
ient area in PDF page coordinate. | 321 * right - Right position of the client area in PDF page c
oordinate. |
| 322 * bottom - Bottom position of the c
lient area in PDF page coordinate. | 322 * bottom - Bottom position of the client area in PDF page c
oordinate. |
| 323 * Return Value: | 323 * Return Value: |
| 324 * None. | 324 * None. |
| 325 * | 325 * |
| 326 * comments: | 326 * comments: |
| 327 * This CALLBACK function is useful for implementin
g special text selection effect. Implementation should | 327 * This CALLBACK function is useful for implementing special text s
election effect. Implementation should |
| 328 * first records the returned rectangles, then draw
them one by one at the painting period, last,remove all | 328 * first records the returned rectangles, then draw them one by one
at the painting period, last,remove all |
| 329 * the recorded rectangles when finish painting. | 329 * the recorded rectangles when finish painting. |
| 330 */ | 330 */ |
| 331 void (*FFI_OutputSelectedRect)(struct _FPDF_FORMFILLINFO* pThis,FPDF_PAG
E page, double left, double top, double right, double bottom); | 331 void (*FFI_OutputSelectedRect)(struct _FPDF_FORMFILLINFO* pThis,FPDF_PAGE pa
ge, double left, double top, double right, double bottom); |
| 332 | 332 |
| 333 /** | 333 /** |
| 334 * Method: FFI_SetCursor | 334 * Method: FFI_SetCursor |
| 335 * Set the Cursor shape. | 335 * Set the Cursor shape. |
| 336 * Interface Version: | 336 * Interface Version: |
| 337 * 1 | 337 * 1 |
| 338 * Implementation Required: | 338 * Implementation Required: |
| 339 * yes | 339 * yes |
| 340 * Parameters: | 340 * Parameters: |
| 341 * pThis - Pointer to the interface structu
re itself. | 341 * pThis - Pointer to the interface structure itself. |
| 342 * nCursorType - Cursor type. see Flags for Curso
r type for the details. | 342 * nCursorType - Cursor type. see Flags for Cursor type for the detai
ls. |
| 343 * Return value: | 343 * Return value: |
| 344 * None. | 344 * None. |
| 345 * */ | 345 * */ |
| 346 void (*FFI_SetCursor)(struct _FPDF_FORMFILLINFO* pThis, int nCursorType)
; | 346 void (*FFI_SetCursor)(struct _FPDF_FORMFILLINFO* pThis, int nCursorType); |
| 347 | 347 |
| 348 /** | 348 /** |
| 349 * Method: FFI_SetTimer | 349 * Method: FFI_SetTimer |
| 350 * This method installs a system timer. A time-out
value is specified, | 350 * This method installs a system timer. A time-out value is specifi
ed, |
| 351 * and every time a time-out occurs, the system pas
ses a message to | 351 * and every time a time-out occurs, the system passes a message to |
| 352 * the TimerProc callback function. | 352 * the TimerProc callback function. |
| 353 * Interface Version: | 353 * Interface Version: |
| 354 * 1 | 354 * 1 |
| 355 * Implementation Required: | 355 * Implementation Required: |
| 356 * yes | 356 * yes |
| 357 * Parameters: | 357 * Parameters: |
| 358 * pThis - Pointer to the interface structu
re itself. | 358 * pThis - Pointer to the interface structure itself. |
| 359 * uElapse - Specifies the time-out value, in
milliseconds. | 359 * uElapse - Specifies the time-out value, in milliseconds. |
| 360 * lpTimerFunc - A pointer to the callback functi
on-TimerCallback. | 360 * lpTimerFunc - A pointer to the callback function-TimerCallback. |
| 361 * Return value: | 361 * Return value: |
| 362 * The timer identifier of the new timer if the function is
successful. | 362 * The timer identifier of the new timer if the function is successful. |
| 363 * An application passes this value to the FFI_KillTimer me
thod to kill | 363 * An application passes this value to the FFI_KillTimer method to kill |
| 364 * the timer. Nonzero if it is successful; otherwise, it is
zero. | 364 * the timer. Nonzero if it is successful; otherwise, it is zero. |
| 365 * */ | 365 * */ |
| 366 int (*FFI_SetTimer)(struct _FPDF_FORMFILLINFO* pThis, int uElapse, Time
rCallback lpTimerFunc); | 366 int (*FFI_SetTimer)(struct _FPDF_FORMFILLINFO* pThis, int uElapse, TimerCal
lback lpTimerFunc); |
| 367 | 367 |
| 368 /** | 368 /** |
| 369 * Method: FFI_KillTimer | 369 * Method: FFI_KillTimer |
| 370 * This method kills the timer event identified by
nIDEvent, set by an earlier call to FFI_SetTimer. | 370 * This method kills the timer event identified by nIDEvent, set by
an earlier call to FFI_SetTimer. |
| 371 * Interface Version: | 371 * Interface Version: |
| 372 * 1 | 372 * 1 |
| 373 * Implementation Required: | 373 * Implementation Required: |
| 374 * yes | 374 * yes |
| 375 * Parameters: | 375 * Parameters: |
| 376 * pThis - Pointer to the interface structu
re itself. | 376 * pThis - Pointer to the interface structure itself. |
| 377 * nTimerID - The timer ID return by FFI_SetTi
mer function. | 377 * nTimerID - The timer ID return by FFI_SetTimer function. |
| 378 * Return value: | 378 * Return value: |
| 379 * None. | 379 * None. |
| 380 * */ | 380 * */ |
| 381 void (*FFI_KillTimer)(struct _FPDF_FORMFILLINFO* pThis, int nTimerID); | 381 void (*FFI_KillTimer)(struct _FPDF_FORMFILLINFO* pThis, int nTimerID); |
| 382 | 382 |
| 383 | 383 |
| 384 /** | 384 /** |
| 385 * Method: FFI_GetLocalTime | 385 * Method: FFI_GetLocalTime |
| 386 * This method receives the current local time on t
he system. | 386 * This method receives the current local time on the system. |
| 387 * Interface Version: | 387 * Interface Version: |
| 388 * 1 | 388 * 1 |
| 389 * Implementation Required: | 389 * Implementation Required: |
| 390 * yes | 390 * yes |
| 391 * Parameters: | 391 * Parameters: |
| 392 * pThis - Pointer to the interface structu
re itself. | 392 * pThis - Pointer to the interface structure itself. |
| 393 * Return value: | 393 * Return value: |
| 394 * None. | 394 * None. |
| 395 * */ | 395 * */ |
| 396 FPDF_SYSTEMTIME (*FFI_GetLocalTime)(struct _FPDF_FORMFILLINFO* pThis); | 396 FPDF_SYSTEMTIME (*FFI_GetLocalTime)(struct _FPDF_FORMFILLINFO* pThis); |
| 397 | 397 |
| 398 /** | 398 /** |
| 399 * Method: FFI_OnChange | 399 * Method: FFI_OnChange |
| 400 * This method will be invoked to notify implementa
tion when the value of any FormField on the document had been changed. | 400 * This method will be invoked to notify implementation when the va
lue of any FormField on the document had been changed. |
| 401 * Interface Version: | 401 * Interface Version: |
| 402 * 1 | 402 * 1 |
| 403 * Implementation Required: | 403 * Implementation Required: |
| 404 * no | 404 * no |
| 405 * Parameters: | 405 * Parameters: |
| 406 * pThis - Pointer to the interface structu
re itself. | 406 * pThis - Pointer to the interface structure itself. |
| 407 * Return value: | 407 * Return value: |
| 408 * None. | 408 * None. |
| 409 * */ | 409 * */ |
| 410 void (*FFI_OnChange)(struct _FPDF_FORMFILLINFO* pThis); | 410 void (*FFI_OnChange)(struct _FPDF_FORMFILLINFO* pThis); |
| 411 | 411 |
| 412 /** | 412 /** |
| 413 * Method: FFI_GetPage | 413 * Method: FFI_GetPage |
| 414 * This method receives the page pointer associated
with a specified page index. | 414 * This method receives the page pointer associated with a specifie
d page index. |
| 415 * Interface Version: | 415 * Interface Version: |
| 416 * 1 | 416 * 1 |
| 417 * Implementation Required: | 417 * Implementation Required: |
| 418 * yes | 418 * yes |
| 419 * Parameters: | 419 * Parameters: |
| 420 * pThis - Pointer to the interface structu
re itself. | 420 * pThis - Pointer to the interface structure itself. |
| 421 * document - Handle to document. Returned by
FPDF_LoadDocument function. | 421 * document - Handle to document. Returned by FPDF_LoadDocument fu
nction. |
| 422 * nPageIndex - Index number of the page. 0 for the firs
t page. | 422 * nPageIndex - Index number of the page. 0 for the first page. |
| 423 * Return value: | 423 * Return value: |
| 424 * Handle to the page. Returned by FPDF_LoadPage function. | 424 * Handle to the page. Returned by FPDF_LoadPage function. |
| 425 * Comments: | 425 * Comments: |
| 426 * In some cases, the document-level JavaScript action may
refer to a page which hadn't been loaded yet. | 426 * In some cases, the document-level JavaScript action may refer to a p
age which hadn't been loaded yet. |
| 427 * To successfully run the javascript action, implementatio
n need to load the page for SDK. | 427 * To successfully run the javascript action, implementation need to lo
ad the page for SDK. |
| 428 * */ | 428 * */ |
| 429 FPDF_PAGE (*FFI_GetPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DO
CUMENT document, int nPageIndex); | 429 FPDF_PAGE (*FFI_GetPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DOCUMENT d
ocument, int nPageIndex); |
| 430 | 430 |
| 431 /** | 431 /** |
| 432 * Method: FFI_GetCurrentPage | 432 * Method: FFI_GetCurrentPage |
| 433 * This method receives the current page pointer. | 433 * This method receives the current page pointer. |
| 434 * Interface Version: | 434 * Interface Version: |
| 435 * 1 | 435 * 1 |
| 436 * Implementation Required: | 436 * Implementation Required: |
| 437 * yes | 437 * yes |
| 438 * Parameters: | 438 * Parameters: |
| 439 * pThis - Pointer to the interface structu
re itself. | 439 * pThis - Pointer to the interface structure itself. |
| 440 * document - Handle to document. Returned by
FPDF_LoadDocument function. | 440 * document - Handle to document. Returned by FPDF_LoadDocument fu
nction. |
| 441 * Return value: | 441 * Return value: |
| 442 * Handle to the page. Returned by FPDF_LoadPage function. | 442 * Handle to the page. Returned by FPDF_LoadPage function. |
| 443 * */ | 443 * */ |
| 444 FPDF_PAGE (*FFI_GetCurrentPage)(struct _FPDF_FORMFILLINFO* pThis,
FPDF_DOCUMENT document); | 444 FPDF_PAGE (*FFI_GetCurrentPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DOC
UMENT document); |
| 445 | 445 |
| 446 /** | 446 /** |
| 447 * Method: FFI_GetRotation | 447 * Method: FFI_GetRotation |
| 448 * This method receives currently rotation of the p
age view. | 448 * This method receives currently rotation of the page view. |
| 449 * Interface Version: | 449 * Interface Version: |
| 450 * 1 | 450 * 1 |
| 451 * Implementation Required: | 451 * Implementation Required: |
| 452 * yes | 452 * yes |
| 453 * Parameters: | 453 * Parameters: |
| 454 * pThis - Pointer to the interface structu
re itself. | 454 * pThis - Pointer to the interface structure itself. |
| 455 * page - Handle to page. Returned by FPDF
_LoadPage function. | 455 * page - Handle to page. Returned by FPDF_LoadPage function. |
| 456 * Return value: | 456 * Return value: |
| 457 * The page rotation. Should be 0(0 degree),1(90 degree),2(
180 degree),3(270 degree), in a clockwise direction. | 457 * The page rotation. Should be 0(0 degree),1(90 degree),2(180 degree),
3(270 degree), in a clockwise direction. |
| 458 * */ | 458 * */ |
| 459 int (*FFI_GetRotation)(struct _FPDF_FORMFILLINFO* pThis, FPDF_PAGE p
age); | 459 int (*FFI_GetRotation)(struct _FPDF_FORMFILLINFO* pThis, FPDF_PAGE page)
; |
| 460 | 460 |
| 461 /** | 461 /** |
| 462 * Method: FFI_ExecuteNamedAction | 462 * Method: FFI_ExecuteNamedAction |
| 463 * This method will execute an named action. | 463 * This method will execute an named action. |
| 464 * Interface Version: | 464 * Interface Version: |
| 465 * 1 | 465 * 1 |
| 466 * Implementation Required: | 466 * Implementation Required: |
| 467 * yes | 467 * yes |
| 468 * Parameters: | 468 * Parameters: |
| 469 * pThis - Pointer to the interface
structure itself. | 469 * pThis - Pointer to the interface structure itself. |
| 470 * namedAction - A byte string which indi
cates the named action, terminated by 0. | 470 * namedAction - A byte string which indicates the named action,
terminated by 0. |
| 471 * Return value: | 471 * Return value: |
| 472 * None. | 472 * None. |
| 473 * Comments: | 473 * Comments: |
| 474 * See the named actions description of <<PDF Reference, ve
rsion 1.7>> for more details. | 474 * See the named actions description of <<PDF Reference, version 1.7>>
for more details. |
| 475 * */ | 475 * */ |
| 476 void (*FFI_ExecuteNamedAction)(struct _FPDF_FORMFILLINFO* pThis, FPDF
_BYTESTRING namedAction); | 476 void (*FFI_ExecuteNamedAction)(struct _FPDF_FORMFILLINFO* pThis, FPDF_BYT
ESTRING namedAction); |
| 477 /** | 477 /** |
| 478 * @brief This method will be called when a text field is getting or losi
ng a focus. | 478 * @brief This method will be called when a text field is getting or losing a
focus. |
| 479 * | 479 * |
| 480 * @param[in] pThis Pointer to the interface structure itsel
f. | 480 * @param[in] pThis Pointer to the interface structure itself. |
| 481 * @param[in] value The string value of the form field, in U
TF-16LE format. | 481 * @param[in] value The string value of the form field, in UTF-16LE form
at. |
| 482 * @param[in] valueLen The length of the string value, number of charac
ters (not bytes). | 482 * @param[in] valueLen The length of the string value, number of characters
(not bytes). |
| 483 * @param[in] is_focus True if the form field is getting a focus, False
for losing a focus. | 483 * @param[in] is_focus True if the form field is getting a focus, False for
losing a focus. |
| 484 * | 484 * |
| 485 * @return None. | 485 * @return None. |
| 486 * | 486 * |
| 487 * @note Currently,only support text field and combobox field. | 487 * @note Currently,only support text field and combobox field. |
| 488 * */ | 488 * */ |
| 489 void (*FFI_SetTextFieldFocus)(struct _FPDF_FORMFILLINFO* pThis, FPDF_
WIDESTRING value, FPDF_DWORD valueLen, FPDF_BOOL is_focus); | 489 void (*FFI_SetTextFieldFocus)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDE
STRING value, FPDF_DWORD valueLen, FPDF_BOOL is_focus); |
| 490 | 490 |
| 491 | 491 |
| 492 /** | 492 /** |
| 493 * Method: FFI_DoURIAction | 493 * Method: FFI_DoURIAction |
| 494 * This action resolves to a uniform resource ident
ifier. | 494 * This action resolves to a uniform resource identifier. |
| 495 * Interface Version: | 495 * Interface Version: |
| 496 * 1 | 496 * 1 |
| 497 * Implementation Required: | 497 * Implementation Required: |
| 498 * No | 498 * No |
| 499 * Parameters: | 499 * Parameters: |
| 500 * pThis - Pointer to the interface
structure itself. | 500 * pThis - Pointer to the interface structure itself. |
| 501 * bsURI - A byte string which indi
cates the uniform resource identifier, terminated by 0. | 501 * bsURI - A byte string which indicates the uniform resour
ce identifier, terminated by 0. |
| 502 * Return value: | 502 * Return value: |
| 503 * None. | 503 * None. |
| 504 * Comments: | 504 * Comments: |
| 505 * See the URI actions description of <<PDF Reference, vers
ion 1.7>> for more details. | 505 * See the URI actions description of <<PDF Reference, version 1.7>> fo
r more details. |
| 506 * */ | 506 * */ |
| 507 void (*FFI_DoURIAction)(struct _FPDF_FORMFILLINFO* pThis, FPDF_BYTEST
RING bsURI); | 507 void (*FFI_DoURIAction)(struct _FPDF_FORMFILLINFO* pThis, FPDF_BYTESTRING
bsURI); |
| 508 | 508 |
| 509 /** | 509 /** |
| 510 * Method: FFI_DoGoToAction | 510 * Method: FFI_DoGoToAction |
| 511 * This action changes the view to a specified dest
ination. | 511 * This action changes the view to a specified destination. |
| 512 * Interface Version: | 512 * Interface Version: |
| 513 * 1 | 513 * 1 |
| 514 * Implementation Required: | 514 * Implementation Required: |
| 515 * No | 515 * No |
| 516 * Parameters: | 516 * Parameters: |
| 517 * pThis - Pointer to the interface
structure itself. | 517 * pThis - Pointer to the interface structure itself. |
| 518 * nPageIndex - The index of the PDF pag
e. | 518 * nPageIndex - The index of the PDF page. |
| 519 * zoomMode - The zoom mode for viewin
g page.See Macros "PDFZOOM_XXX" defined in "fpdfdoc.h". | 519 * zoomMode - The zoom mode for viewing page.See Macros "PDFZO
OM_XXX" defined in "fpdfdoc.h". |
| 520 * fPosArray - The float array which ca
rries the position info. | 520 * fPosArray - The float array which carries the position info. |
| 521 * sizeofArray - The size of float array. | 521 * sizeofArray - The size of float array. |
| 522 * Return value: | 522 * Return value: |
| 523 * None. | 523 * None. |
| 524 * Comments: | 524 * Comments: |
| 525 * See the Destinations description of <<PDF Reference, ver
sion 1.7>> in 8.2.1 for more details. | 525 * See the Destinations description of <<PDF Reference, version 1.7>> i
n 8.2.1 for more details. |
| 526 **/ | 526 **/ |
| 527 void (*FFI_DoGoToAction)(struct _FPDF_FORMFILLINFO* pThis, int nPageI
ndex, int zoomMode, float* fPosArray, int sizeofArray); | 527 void (*FFI_DoGoToAction)(struct _FPDF_FORMFILLINFO* pThis, int nPageIndex
, int zoomMode, float* fPosArray, int sizeofArray); |
| 528 /** | 528 /** |
| 529 * pointer to IPDF_JSPLATFORM interface | 529 * pointer to IPDF_JSPLATFORM interface |
| 530 **/ | 530 **/ |
| 531 IPDF_JSPLATFORM* m_pJsPlatform; | 531 IPDF_JSPLATFORM* m_pJsPlatform; |
| 532 | 532 |
| 533 } FPDF_FORMFILLINFO; | 533 } FPDF_FORMFILLINFO; |
| 534 | 534 |
| 535 | 535 |
| 536 | 536 |
| 537 /** | 537 /** |
| 538 * Function: FPDFDOC_InitFormFillEnvironment | 538 * Function: FPDFDOC_InitFormFillEnvironment |
| 539 *» » » Init form fill environment. | 539 * Init form fill environment. |
| 540 * Comments: | 540 * Comments: |
| 541 *» » » This function should be called before any form fill oper
ation. | 541 * This function should be called before any form fill operation. |
| 542 * Parameters: | 542 * Parameters: |
| 543 *» » » document» » -» Handle to document. Retu
rned by FPDF_LoadDocument function. | 543 * document - Handle to document. Returned by FPDF_LoadDocumen
t function. |
| 544 *» » » pFormFillInfo» -» Pointer to a FPDF_FORMFILLINFO s
tructure. | 544 * pFormFillInfo - Pointer to a FPDF_FORMFILLINFO structure. |
| 545 * Return Value: | 545 * Return Value: |
| 546 *» » » Return handler to the form fill module. NULL means fails
. | 546 * Return handler to the form fill module. NULL means fails. |
| 547 **/ | 547 **/ |
| 548 DLLEXPORT FPDF_FORMHANDLE STDCALL FPDFDOC_InitFormFillEnvironment(FPDF_DOCUMENT
document, FPDF_FORMFILLINFO* formInfo); | 548 DLLEXPORT FPDF_FORMHANDLE STDCALL FPDFDOC_InitFormFillEnvironment(FPDF_DOCUMENT
document, FPDF_FORMFILLINFO* formInfo); |
| 549 | 549 |
| 550 /** | 550 /** |
| 551 * Function: FPDFDOC_ExitFormFillEnvironment | 551 * Function: FPDFDOC_ExitFormFillEnvironment |
| 552 *» » » Exit form fill environment. | 552 * Exit form fill environment. |
| 553 * Parameters: | 553 * Parameters: |
| 554 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 554 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 555 * Return Value: | 555 * Return Value: |
| 556 *» » » NULL. | 556 * NULL. |
| 557 **/ | 557 **/ |
| 558 DLLEXPORT void STDCALL FPDFDOC_ExitFormFillEnvironment(FPDF_FORMHANDLE hHandle); | 558 DLLEXPORT void STDCALL FPDFDOC_ExitFormFillEnvironment(FPDF_FORMHANDLE hHandle); |
| 559 | 559 |
| 560 /** | 560 /** |
| 561 * Function: FORM_OnAfterLoadPage | 561 * Function: FORM_OnAfterLoadPage |
| 562 *» » » This method is required for implementing all the form re
lated functions. Should be invoked after user | 562 * This method is required for implementing all the form related functi
ons. Should be invoked after user |
| 563 *» » » successfully loaded a PDF page, and method FPDFDOC_InitF
ormFillEnvironment had been invoked. | 563 * successfully loaded a PDF page, and method FPDFDOC_InitFormFillEnvir
onment had been invoked. |
| 564 * Parameters: | 564 * Parameters: |
| 565 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 565 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 566 * Return Value: | 566 * Return Value: |
| 567 *» » » NONE. | 567 * NONE. |
| 568 **/ | 568 **/ |
| 569 DLLEXPORT void STDCALL FORM_OnAfterLoadPage(FPDF_PAGE page, FPDF_FORMHANDLE hHan
dle); | 569 DLLEXPORT void STDCALL FORM_OnAfterLoadPage(FPDF_PAGE page, FPDF_FORMHANDLE hHan
dle); |
| 570 | 570 |
| 571 /** | 571 /** |
| 572 * Function: FORM_OnBeforeClosePage | 572 * Function: FORM_OnBeforeClosePage |
| 573 *» » » This method is required for implementing all the form re
lated functions. Should be invoked before user | 573 * This method is required for implementing all the form related functi
ons. Should be invoked before user |
| 574 *» » » close the PDF page. | 574 * close the PDF page. |
| 575 * Parameters: | 575 * Parameters: |
| 576 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 576 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 577 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 577 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 578 * Return Value: | 578 * Return Value: |
| 579 *» » » NONE. | 579 * NONE. |
| 580 **/ | 580 **/ |
| 581 DLLEXPORT void STDCALL FORM_OnBeforeClosePage(FPDF_PAGE page, FPDF_FORMHANDLE hH
andle); | 581 DLLEXPORT void STDCALL FORM_OnBeforeClosePage(FPDF_PAGE page, FPDF_FORMHANDLE hH
andle); |
| 582 | 582 |
| 583 /** | 583 /** |
| 584 * Function: FORM_DoDocumentJSAction | 584 * Function: FORM_DoDocumentJSAction |
| 585 *» » » This method is required for performing Document-level Ja
vaScript action. It should be invoked after the PDF document | 585 * This method is required for performing Document-level JavaScript act
ion. It should be invoked after the PDF document |
| 586 *» » » had been loaded. | 586 * had been loaded. |
| 587 * Parameters: | 587 * Parameters: |
| 588 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 588 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 589 * Return Value: | 589 * Return Value: |
| 590 *» » » NONE | 590 * NONE |
| 591 * Comments: | 591 * Comments: |
| 592 *» » » If there is Document-level JavaScript action embedded in
the document, this method will execute the javascript action; | 592 * If there is Document-level JavaScript action embedded in the documen
t, this method will execute the javascript action; |
| 593 *» » » otherwise, the method will do nothing. | 593 * otherwise, the method will do nothing. |
| 594 **/ | 594 **/ |
| 595 DLLEXPORT void STDCALL FORM_DoDocumentJSAction(FPDF_FORMHANDLE hHandle); | 595 DLLEXPORT void STDCALL FORM_DoDocumentJSAction(FPDF_FORMHANDLE hHandle); |
| 596 | 596 |
| 597 | 597 |
| 598 /** | 598 /** |
| 599 * Function: FORM_DoDocumentOpenAction | 599 * Function: FORM_DoDocumentOpenAction |
| 600 *» » » This method is required for performing open-action when
the document is opened. | 600 * This method is required for performing open-action when the document
is opened. |
| 601 * Parameters: | 601 * Parameters: |
| 602 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 602 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 603 * Return Value: | 603 * Return Value: |
| 604 *» » » NONE | 604 * NONE |
| 605 * Comments: | 605 * Comments: |
| 606 *» » » This method will do nothing if there is no open-actions
embedded in the document. | 606 * This method will do nothing if there is no open-actions embedded in
the document. |
| 607 **/ | 607 **/ |
| 608 DLLEXPORT void STDCALL FORM_DoDocumentOpenAction(FPDF_FORMHANDLE hHandle); | 608 DLLEXPORT void STDCALL FORM_DoDocumentOpenAction(FPDF_FORMHANDLE hHandle); |
| 609 | 609 |
| 610 | 610 |
| 611 // additional actions type of document. | 611 // additional actions type of document. |
| 612 #define FPDFDOC_AACTION_WC» » 0x10» » //WC, before closing doc
ument, JavaScript action. | 612 #define FPDFDOC_AACTION_WC 0x10 //WC, before closing document, JavaS
cript action. |
| 613 #define FPDFDOC_AACTION_WS» » 0x11» » //WS, before saving docu
ment, JavaScript action. | 613 #define FPDFDOC_AACTION_WS 0x11 //WS, before saving document, JavaSc
ript action. |
| 614 #define FPDFDOC_AACTION_DS» » 0x12» » //DS, after saving docum
ent, JavaScript action. | 614 #define FPDFDOC_AACTION_DS 0x12 //DS, after saving document, JavaScr
ipt action. |
| 615 #define FPDFDOC_AACTION_WP» » 0x13» » //WP, before printing do
cument, JavaScript action. | 615 #define FPDFDOC_AACTION_WP 0x13 //WP, before printing document, Java
Script action. |
| 616 #define FPDFDOC_AACTION_DP» » 0x14» » //DP, after printing doc
ument, JavaScript action. | 616 #define FPDFDOC_AACTION_DP 0x14 //DP, after printing document, JavaS
cript action. |
| 617 /** | 617 /** |
| 618 * Function: FORM_DoDocumentAAction | 618 * Function: FORM_DoDocumentAAction |
| 619 *» » » This method is required for performing the document's ad
ditional-action. | 619 * This method is required for performing the document's additional-act
ion. |
| 620 * Parameters: | 620 * Parameters: |
| 621 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 621 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 622 *» » » aaType» - The type of the additional-actions which
defined above. | 622 * aaType - The type of the additional-actions which defined abo
ve. |
| 623 * Return Value: | 623 * Return Value: |
| 624 *» » » NONE | 624 * NONE |
| 625 * Comments: | 625 * Comments: |
| 626 *» » » This method will do nothing if there is no document addi
tional-action corresponding to the specified aaType. | 626 * This method will do nothing if there is no document additional-actio
n corresponding to the specified aaType. |
| 627 **/ | 627 **/ |
| 628 | 628 |
| 629 DLLEXPORT void STDCALL FORM_DoDocumentAAction(FPDF_FORMHANDLE hHandle, int aaTyp
e); | 629 DLLEXPORT void STDCALL FORM_DoDocumentAAction(FPDF_FORMHANDLE hHandle, int aaTyp
e); |
| 630 | 630 |
| 631 // Additional-action types of page object | 631 // Additional-action types of page object |
| 632 #define FPDFPAGE_AACTION_OPEN» » 0» » // /O -- An action to be
performed when the page is opened | 632 #define FPDFPAGE_AACTION_OPEN 0 // /O -- An action to be performed w
hen the page is opened |
| 633 #define FPDFPAGE_AACTION_CLOSE» » 1» » // /C -- An action to be
performed when the page is closed | 633 #define FPDFPAGE_AACTION_CLOSE 1 // /C -- An action to be performed w
hen the page is closed |
| 634 | 634 |
| 635 /** | 635 /** |
| 636 * Function: FORM_DoPageAAction | 636 * Function: FORM_DoPageAAction |
| 637 *» » » This method is required for performing the page object's
additional-action when opened or closed. | 637 * This method is required for performing the page object's additional-
action when opened or closed. |
| 638 * Parameters: | 638 * Parameters: |
| 639 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 639 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 640 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 640 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 641 *» » » aaType» - The type of the page object's additional
-actions which defined above. | 641 * aaType - The type of the page object's additional-actions whi
ch defined above. |
| 642 * Return Value: | 642 * Return Value: |
| 643 *» » » NONE | 643 * NONE |
| 644 * Comments: | 644 * Comments: |
| 645 *» » » This method will do nothing if no additional-action corr
esponding to the specified aaType exists. | 645 * This method will do nothing if no additional-action corresponding to
the specified aaType exists. |
| 646 **/ | 646 **/ |
| 647 DLLEXPORT void STDCALL FORM_DoPageAAction(FPDF_PAGE page, FPDF_FORMHANDLE hHandl
e, int aaType); | 647 DLLEXPORT void STDCALL FORM_DoPageAAction(FPDF_PAGE page, FPDF_FORMHANDLE hHandl
e, int aaType); |
| 648 | 648 |
| 649 /** | 649 /** |
| 650 * Function: FORM_OnMouseMove | 650 * Function: FORM_OnMouseMove |
| 651 *» » » You can call this member function when the mouse cursor
moves. | 651 * You can call this member function when the mouse cursor moves. |
| 652 * Parameters: | 652 * Parameters: |
| 653 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 653 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 654 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 654 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 655 *» » » modifier» » -» Indicates whether variou
s virtual keys are down. | 655 * modifier - Indicates whether various virtual keys are down. |
| 656 *» » » page_x» » -» Specifies the x-coordinate of th
e cursor in PDF user space. | 656 * page_x - Specifies the x-coordinate of the cursor in PDF user
space. |
| 657 *» » » page_y» » -» Specifies the y-coordinate of th
e cursor in PDF user space. | 657 * page_y - Specifies the y-coordinate of the cursor in PDF user
space. |
| 658 * Return Value: | 658 * Return Value: |
| 659 *» » » TRUE indicates success; otherwise false. | 659 * TRUE indicates success; otherwise false. |
| 660 **/ | 660 **/ |
| 661 DLLEXPORT FPDF_BOOL STDCALL FORM_OnMouseMove(FPDF_FORMHANDLE hHandle,FPDF_PAGE p
age, int modifier, double page_x, double page_y); | 661 DLLEXPORT FPDF_BOOL STDCALL FORM_OnMouseMove(FPDF_FORMHANDLE hHandle,FPDF_PAGE p
age, int modifier, double page_x, double page_y); |
| 662 | 662 |
| 663 /** | 663 /** |
| 664 * Function: FORM_OnLButtonDown | 664 * Function: FORM_OnLButtonDown |
| 665 *» » » You can call this member function when the user presses
the left mouse button. | 665 * You can call this member function when the user presses the left mou
se button. |
| 666 * Parameters: | 666 * Parameters: |
| 667 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 667 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 668 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 668 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 669 *» » » modifier» » -» Indicates whether variou
s virtual keys are down. | 669 * modifier - Indicates whether various virtual keys are down. |
| 670 *» » » page_x» » -» Specifies the x-coordinate of th
e cursor in PDF user space. | 670 * page_x - Specifies the x-coordinate of the cursor in PDF user
space. |
| 671 *» » » page_y» » -» Specifies the y-coordinate of th
e cursor in PDF user space. | 671 * page_y - Specifies the y-coordinate of the cursor in PDF user
space. |
| 672 * Return Value: | 672 * Return Value: |
| 673 *» » » TRUE indicates success; otherwise false. | 673 * TRUE indicates success; otherwise false. |
| 674 **/ | 674 **/ |
| 675 DLLEXPORT FPDF_BOOL STDCALL FORM_OnLButtonDown(FPDF_FORMHANDLE hHandle,FPDF_PAGE
page, int modifier, double page_x, double page_y); | 675 DLLEXPORT FPDF_BOOL STDCALL FORM_OnLButtonDown(FPDF_FORMHANDLE hHandle,FPDF_PAGE
page, int modifier, double page_x, double page_y); |
| 676 | 676 |
| 677 /** | 677 /** |
| 678 * Function: FORM_OnLButtonUp | 678 * Function: FORM_OnLButtonUp |
| 679 *» » » You can call this member function when the user releases
the left mouse button. | 679 * You can call this member function when the user releases the left mo
use button. |
| 680 * Parameters: | 680 * Parameters: |
| 681 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 681 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 682 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 682 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 683 *» » » modifier» -» Indicates whether various virtua
l keys are down. | 683 * modifier - Indicates whether various virtual keys are down. |
| 684 *» » » page_x» » -» Specifies the x-coordinate of th
e cursor in device. | 684 * page_x - Specifies the x-coordinate of the cursor in device. |
| 685 *» » » page_y» » -» Specifies the y-coordinate of th
e cursor in device. | 685 * page_y - Specifies the y-coordinate of the cursor in device. |
| 686 * Return Value: | 686 * Return Value: |
| 687 *» » » TRUE indicates success; otherwise false. | 687 * TRUE indicates success; otherwise false. |
| 688 **/ | 688 **/ |
| 689 DLLEXPORT FPDF_BOOL STDCALL FORM_OnLButtonUp(FPDF_FORMHANDLE hHandle,FPDF_PAGE p
age, int modifier, double page_x, double page_y); | 689 DLLEXPORT FPDF_BOOL STDCALL FORM_OnLButtonUp(FPDF_FORMHANDLE hHandle,FPDF_PAGE p
age, int modifier, double page_x, double page_y); |
| 690 | 690 |
| 691 /** | 691 /** |
| 692 * Function: FORM_OnKeyDown | 692 * Function: FORM_OnKeyDown |
| 693 *» » » You can call this member function when a nonsystem key i
s pressed. | 693 * You can call this member function when a nonsystem key is pressed. |
| 694 * Parameters: | 694 * Parameters: |
| 695 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 695 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 696 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 696 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 697 *» » » nKeyCode» -» Indicates whether various virtua
l keys are down. | 697 * nKeyCode - Indicates whether various virtual keys are down. |
| 698 *» » » modifier» -» Contains the scan code, key-tran
sition code, previous key state, and context code. | 698 * modifier - Contains the scan code, key-transition code, previou
s key state, and context code. |
| 699 * Return Value: | 699 * Return Value: |
| 700 *» » » TRUE indicates success; otherwise false. | 700 * TRUE indicates success; otherwise false. |
| 701 **/ | 701 **/ |
| 702 DLLEXPORT FPDF_BOOL STDCALL FORM_OnKeyDown(FPDF_FORMHANDLE hHandle,FPDF_PAGE pag
e, int nKeyCode, int modifier); | 702 DLLEXPORT FPDF_BOOL STDCALL FORM_OnKeyDown(FPDF_FORMHANDLE hHandle,FPDF_PAGE pag
e, int nKeyCode, int modifier); |
| 703 | 703 |
| 704 /** | 704 /** |
| 705 * Function: FORM_OnKeyUp | 705 * Function: FORM_OnKeyUp |
| 706 *» » » You can call this member function when a nonsystem key i
s released. | 706 * You can call this member function when a nonsystem key is released. |
| 707 * Parameters: | 707 * Parameters: |
| 708 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 708 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 709 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 709 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 710 *» » » nKeyCode» -» The virtual-key code of the give
n key. | 710 * nKeyCode - The virtual-key code of the given key. |
| 711 *» » » modifier» -» Contains the scan code, key-tran
sition code, previous key state, and context code. | 711 * modifier - Contains the scan code, key-transition code, previou
s key state, and context code. |
| 712 * Return Value: | 712 * Return Value: |
| 713 *» » » TRUE indicates success; otherwise false. | 713 * TRUE indicates success; otherwise false. |
| 714 **/ | 714 **/ |
| 715 DLLEXPORT FPDF_BOOL STDCALL FORM_OnKeyUp(FPDF_FORMHANDLE hHandle,FPDF_PAGE page,
int nKeyCode, int modifier); | 715 DLLEXPORT FPDF_BOOL STDCALL FORM_OnKeyUp(FPDF_FORMHANDLE hHandle,FPDF_PAGE page,
int nKeyCode, int modifier); |
| 716 | 716 |
| 717 /** | 717 /** |
| 718 * Function: FORM_OnChar | 718 * Function: FORM_OnChar |
| 719 *» » » You can call this member function when a keystroke trans
lates to a nonsystem character. | 719 * You can call this member function when a keystroke translates to a n
onsystem character. |
| 720 * Parameters: | 720 * Parameters: |
| 721 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 721 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 722 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 722 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 723 *» » » nChar» » -» The character code value of the
key. | 723 * nChar - The character code value of the key. |
| 724 *» » » modifier» -» Contains the scan code, key-tran
sition code, previous key state, and context code. | 724 * modifier - Contains the scan code, key-transition code, previou
s key state, and context code. |
| 725 * Return Value: | 725 * Return Value: |
| 726 *» » » TRUE indicates success; otherwise false. | 726 * TRUE indicates success; otherwise false. |
| 727 **/ | 727 **/ |
| 728 DLLEXPORT FPDF_BOOL STDCALL FORM_OnChar(FPDF_FORMHANDLE hHandle,FPDF_PAGE page,
int nChar, int modifier); | 728 DLLEXPORT FPDF_BOOL STDCALL FORM_OnChar(FPDF_FORMHANDLE hHandle,FPDF_PAGE page,
int nChar, int modifier); |
| 729 | 729 |
| 730 /** | 730 /** |
| 731 * Function: FORM_ForceToKillFocus. | 731 * Function: FORM_ForceToKillFocus. |
| 732 *» » » You can call this member function to force to kill the f
ocus of the form field which got focus. | 732 * You can call this member function to force to kill the focus of the
form field which got focus. |
| 733 *» » » It would kill the focus on the form field, save the valu
e of form field if it's changed by user. | 733 * It would kill the focus on the form field, save the value of form fi
eld if it's changed by user. |
| 734 * Parameters: | 734 * Parameters: |
| 735 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 735 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 736 * Return Value: | 736 * Return Value: |
| 737 *» » » TRUE indicates success; otherwise false. | 737 * TRUE indicates success; otherwise false. |
| 738 **/ | 738 **/ |
| 739 DLLEXPORT FPDF_BOOL STDCALL FORM_ForceToKillFocus(FPDF_FORMHANDLE hHandle); | 739 DLLEXPORT FPDF_BOOL STDCALL FORM_ForceToKillFocus(FPDF_FORMHANDLE hHandle); |
| 740 | 740 |
| 741 // Field Types | 741 // Field Types |
| 742 #define FPDF_FORMFIELD_UNKNOWN» » 0» » // Unknown. | 742 #define FPDF_FORMFIELD_UNKNOWN 0 // Unknown. |
| 743 #define FPDF_FORMFIELD_PUSHBUTTON» 1» » // push button type. | 743 #define FPDF_FORMFIELD_PUSHBUTTON 1 // push button type. |
| 744 #define FPDF_FORMFIELD_CHECKBOX»» 2» » // check box type. | 744 #define FPDF_FORMFIELD_CHECKBOX 2 // check box type. |
| 745 #define FPDF_FORMFIELD_RADIOBUTTON» 3» » // radio button type. | 745 #define FPDF_FORMFIELD_RADIOBUTTON 3 // radio button type. |
| 746 #define FPDF_FORMFIELD_COMBOBOX»» 4» » // combo box type. | 746 #define FPDF_FORMFIELD_COMBOBOX 4 // combo box type. |
| 747 #define FPDF_FORMFIELD_LISTBOX» » 5» » // list box type. | 747 #define FPDF_FORMFIELD_LISTBOX 5 // list box type. |
| 748 #define FPDF_FORMFIELD_TEXTFIELD» 6» » // text field type. | 748 #define FPDF_FORMFIELD_TEXTFIELD 6 // text field type. |
| 749 | 749 |
| 750 /** | 750 /** |
| 751 * Function: FPDPage_HasFormFieldAtPoint | 751 * Function: FPDPage_HasFormFieldAtPoint |
| 752 *» » » Check the form filed position by point. | 752 * Check the form filed position by point. |
| 753 * Parameters: | 753 * Parameters: |
| 754 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 754 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 755 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 755 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 756 *» » » page_x» » -» X position in PDF "user space". | 756 * page_x - X position in PDF "user space". |
| 757 *» » » page_y» » -» Y position in PDF "user space". | 757 * page_y - Y position in PDF "user space". |
| 758 * Return Value: | 758 * Return Value: |
| 759 *» » » Return the type of the formfiled; -1 indicates no fields
. | 759 * Return the type of the formfiled; -1 indicates no fields. |
| 760 **/ | 760 **/ |
| 761 DLLEXPORT int STDCALL FPDPage_HasFormFieldAtPoint(FPDF_FORMHANDLE hHandle,FPDF_P
AGE page,double page_x, double page_y); | 761 DLLEXPORT int STDCALL FPDPage_HasFormFieldAtPoint(FPDF_FORMHANDLE hHandle,FPDF_P
AGE page,double page_x, double page_y); |
| 762 | 762 |
| 763 /** | 763 /** |
| 764 * Function: FPDF_SetFormFieldHighlightColor | 764 * Function: FPDF_SetFormFieldHighlightColor |
| 765 *» » » Set the highlight color of specified or all the form fie
lds in the document. | 765 * Set the highlight color of specified or all the form fields in the d
ocument. |
| 766 * Parameters: | 766 * Parameters: |
| 767 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 767 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 768 *» » » doc» » » -» Handle to the document.
Returned by FPDF_LoadDocument function. | 768 * doc - Handle to the document. Returned by FPDF_LoadDocumen
t function. |
| 769 *» » » fieldType» -» A 32-bit integer indicating the
type of a form field(defined above). | 769 * fieldType - A 32-bit integer indicating the type of a form field
(defined above). |
| 770 *» » » color» » -» The highlight color of the form
field.Constructed by 0xxxrrggbb. | 770 * color - The highlight color of the form field.Constructed by
0xxxrrggbb. |
| 771 * Return Value: | 771 * Return Value: |
| 772 *» » » NONE. | 772 * NONE. |
| 773 * Comments: | 773 * Comments: |
| 774 *» » » When the parameter fieldType is set to zero, the highlig
ht color will be applied to all the form fields in the | 774 * When the parameter fieldType is set to zero, the highlight color wil
l be applied to all the form fields in the |
| 775 *» » » document. | 775 * document. |
| 776 *» » » Please refresh the client window to show the highlight i
mmediately if necessary. | 776 * Please refresh the client window to show the highlight immediately i
f necessary. |
| 777 **/ | 777 **/ |
| 778 DLLEXPORT void STDCALL FPDF_SetFormFieldHighlightColor(FPDF_FORMHANDLE hHandle,
int fieldType, unsigned long color); | 778 DLLEXPORT void STDCALL FPDF_SetFormFieldHighlightColor(FPDF_FORMHANDLE hHandle,
int fieldType, unsigned long color); |
| 779 | 779 |
| 780 /** | 780 /** |
| 781 * Function: FPDF_SetFormFieldHighlightAlpha | 781 * Function: FPDF_SetFormFieldHighlightAlpha |
| 782 *» » » Set the transparency of the form field highlight color i
n the document. | 782 * Set the transparency of the form field highlight color in the docume
nt. |
| 783 * Parameters: | 783 * Parameters: |
| 784 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 784 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 785 *» » » doc» » » -» Handle to the document.
Returned by FPDF_LoadDocument function. | 785 * doc - Handle to the document. Returned by FPDF_LoadDocumen
t function. |
| 786 *» » » alpha» » -» The transparency of the form fie
ld highlight color. between 0-255. | 786 * alpha - The transparency of the form field highlight color.
between 0-255. |
| 787 * Return Value: | 787 * Return Value: |
| 788 *» » » NONE. | 788 * NONE. |
| 789 **/ | 789 **/ |
| 790 DLLEXPORT void STDCALL FPDF_SetFormFieldHighlightAlpha(FPDF_FORMHANDLE hHandle,
unsigned char alpha); | 790 DLLEXPORT void STDCALL FPDF_SetFormFieldHighlightAlpha(FPDF_FORMHANDLE hHandle,
unsigned char alpha); |
| 791 | 791 |
| 792 | 792 |
| 793 /** | 793 /** |
| 794 * Function: FPDF_RemoveFormFieldHighlight | 794 * Function: FPDF_RemoveFormFieldHighlight |
| 795 *» » » Remove the form field highlight color in the document. | 795 * Remove the form field highlight color in the document. |
| 796 * Parameters: | 796 * Parameters: |
| 797 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 797 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 798 * Return Value: | 798 * Return Value: |
| 799 *» » » NONE. | 799 * NONE. |
| 800 * Comments: | 800 * Comments: |
| 801 *» » » Please refresh the client window to remove the highlight
immediately if necessary. | 801 * Please refresh the client window to remove the highlight immediately
if necessary. |
| 802 **/ | 802 **/ |
| 803 DLLEXPORT void STDCALL FPDF_RemoveFormFieldHighlight(FPDF_FORMHANDLE hHandle); | 803 DLLEXPORT void STDCALL FPDF_RemoveFormFieldHighlight(FPDF_FORMHANDLE hHandle); |
| 804 | 804 |
| 805 /** | 805 /** |
| 806 * Function: FPDF_FFLDraw | 806 * Function: FPDF_FFLDraw |
| 807 *» » » Render FormFeilds on a page to a device independent bitm
ap. » » » | 807 * Render FormFeilds on a page to a device independent bitmap. |
| 808 * Parameters: | 808 * Parameters: |
| 809 *» » » hHandle»» -» Handle to the form fill module.
Returned by FPDFDOC_InitFormFillEnvironment. | 809 * hHandle - Handle to the form fill module. Returned by FPDFDOC_
InitFormFillEnvironment. |
| 810 *» » » bitmap» » -» Handle to the device independent
bitmap (as the output buffer). | 810 * bitmap - Handle to the device independent bitmap (as the outp
ut buffer). |
| 811 *» » » » » » » Bitmap handle can be cre
ated by FPDFBitmap_Create function. | 811 * Bitmap handle can be created by FPDFBitmap_Create fu
nction. |
| 812 *» » » page» » -» Handle to the page. Returned by
FPDF_LoadPage function. | 812 * page - Handle to the page. Returned by FPDF_LoadPage functi
on. |
| 813 *» » » start_x»» -» Left pixel position of the displ
ay area in the device coordinate. | 813 * start_x - Left pixel position of the display area in the devic
e coordinate. |
| 814 *» » » start_y»» -» Top pixel position of the displa
y area in the device coordinate. | 814 * start_y - Top pixel position of the display area in the device
coordinate. |
| 815 *» » » size_x» » -» Horizontal size (in pixels) for
displaying the page. | 815 * size_x - Horizontal size (in pixels) for displaying the page. |
| 816 *» » » size_y» » -» Vertical size (in pixels) for di
splaying the page. | 816 * size_y - Vertical size (in pixels) for displaying the page. |
| 817 *» » » rotate» » -» Page orientation: 0 (normal), 1
(rotated 90 degrees clockwise), | 817 * rotate - Page orientation: 0 (normal), 1 (rotated 90 degrees
clockwise), |
| 818 *» » » » » » » » 2 (rotated 180 d
egrees), 3 (rotated 90 degrees counter-clockwise). | 818 * 2 (rotated 180 degrees), 3 (rotated 90 degrees c
ounter-clockwise). |
| 819 *» » » flags» » -» 0 for normal display, or combina
tion of flags defined above. | 819 * flags - 0 for normal display, or combination of flags define
d above. |
| 820 * Return Value: | 820 * Return Value: |
| 821 *» » » None. | 821 * None. |
| 822 * Comments: | 822 * Comments: |
| 823 *» » » This method is designed to only render annotations and F
ormFields on the page. | 823 * This method is designed to only render annotations and FormFields on
the page. |
| 824 *» » » Without FPDF_ANNOT specified for flags, Rendering functi
ons such as FPDF_RenderPageBitmap or FPDF_RenderPageBitmap_Start will only rende
r page contents(without annotations) to a bitmap. | 824 * Without FPDF_ANNOT specified for flags, Rendering functions such as
FPDF_RenderPageBitmap or FPDF_RenderPageBitmap_Start will only render page conte
nts(without annotations) to a bitmap. |
| 825 *» » » In order to implement the FormFill functions,Implementat
ion should call this method after rendering functions finish rendering the page
contents. | 825 * In order to implement the FormFill functions,Implementation should c
all this method after rendering functions finish rendering the page contents. |
| 826 **/ | 826 **/ |
| 827 DLLEXPORT void STDCALL FPDF_FFLDraw(FPDF_FORMHANDLE hHandle,FPDF_BITMAP bitmap,
FPDF_PAGE page, int start_x, int start_y, | 827 DLLEXPORT void STDCALL FPDF_FFLDraw(FPDF_FORMHANDLE hHandle,FPDF_BITMAP bitmap,
FPDF_PAGE page, int start_x, int start_y, |
| 828 » » » » » » int size_x, int size_y, int rota
te, int flags); | 828 int size_x, int size_y, int rotate, int flags); |
| 829 | |
| 830 | 829 |
| 831 | 830 |
| 832 #ifdef __cplusplus | 831 #ifdef __cplusplus |
| 833 }; | 832 } |
| 834 #endif | 833 #endif |
| 835 | 834 |
| 836 #endif //_FPDFORMFILL_H | 835 #endif // PUBLIC_FPDF_FORMFILL_H_ |
| 837 | |
| OLD | NEW |