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