Make v8 embedder data slot configurable
[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
235     /**
236      *   The embedder data slot to use in the v8::Isolate to store PDFium's
237      *   per-isolate data. The value needs to be between 0 and
238      *   v8::Internals::kNumIsolateDataLots (exclusive).
239      */
240     unsigned int m_v8EmbedderSlot;
241 } IPDF_JSPLATFORM;
242
243 // Flags for Cursor type
244 #define FXCT_ARROW  0
245 #define FXCT_NESW   1
246 #define FXCT_NWSE   2
247 #define FXCT_VBEAM  3
248 #define FXCT_HBEAM  4
249 #define FXCT_HAND   5
250
251 /**
252  * Declares of a pointer type to the callback function for the FFI_SetTimer method.
253  * Parameters:
254  *          idEvent     -   Identifier of the timer.
255  * Return value:
256  *          None.
257  **/
258 typedef void    (*TimerCallback)(int idEvent);
259
260 /**
261  * Declares of a struct type to the local system time.
262 **/
263 typedef struct _FPDF_SYSTEMTIME
264 {
265     unsigned short wYear;           /* years since 1900 */
266     unsigned short wMonth;          /* months since January - [0,11] */
267     unsigned short wDayOfWeek;      /* days since Sunday - [0,6] */
268     unsigned short wDay;            /* day of the month - [1,31] */
269     unsigned short wHour;           /* hours since midnight - [0,23] */
270     unsigned short wMinute;         /* minutes after the hour - [0,59] */
271     unsigned short wSecond;         /* seconds after the minute - [0,59] */
272     unsigned short wMilliseconds;   /* milliseconds after the second - [0,999] */
273 }FPDF_SYSTEMTIME;
274
275
276 typedef struct  _FPDF_FORMFILLINFO
277 {
278     /**
279      * Version number of the interface. Currently must be 1.
280      **/
281     int version;
282
283         /**
284      * Method: Release
285      *          Give implementation a chance to release any data after the interface is no longer used
286      * Interface Version:
287      *          1
288      * Implementation Required:
289      *          No
290      * Comments:
291      *          Called by Foxit SDK during the final cleanup process.
292      * Parameters:
293      *          pThis       -   Pointer to the interface structure itself
294      * Return Value:
295      *          None
296      */
297
298     void (*Release)(struct _FPDF_FORMFILLINFO* pThis);
299
300     /**
301      * Method: FFI_Invalidate
302      *          Invalidate the client area within the specified rectangle.
303      * Interface Version:
304      *          1
305      * Implementation Required:
306         *           yes
307      * Parameters:
308      *          pThis       -   Pointer to the interface structure itself.
309      *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
310      *          left        -   Left position of the client area in PDF page coordinate.
311      *          top         -   Top  position of the client area in PDF page coordinate.
312      *          right       -   Right position of the client area in PDF page  coordinate.
313      *          bottom      -   Bottom position of the client area in PDF page coordinate.
314      * Return Value:
315      *          None.
316      *
317      *comments:
318      *          All positions are measured in PDF "user space".
319      *          Implementation should call FPDF_RenderPageBitmap() function for repainting a specified page area.
320     */
321     void (*FFI_Invalidate)(struct _FPDF_FORMFILLINFO* pThis,FPDF_PAGE page, double left, double top, double right, double bottom);
322
323     /**
324      * Method: FFI_OutputSelectedRect
325      *          When user is taking the mouse to select texts on a form field, this callback function will keep
326      *          returning the selected areas to the implementation.
327      *
328      * Interface Version:
329      *          1
330      * Implementation Required:
331      *          No
332      * Parameters:
333      *          pThis       -   Pointer to the interface structure itself.
334      *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
335      *          left        -   Left position of the client area in PDF page coordinate.
336      *          top         -   Top  position of the client area in PDF page coordinate.
337      *          right       -   Right position of the client area in PDF page  coordinate.
338      *          bottom      -   Bottom position of the client area in PDF page coordinate.
339      * Return Value:
340      *          None.
341      *
342      * comments:
343      *          This CALLBACK function is useful for implementing special text selection effect. Implementation should
344      *          first records the returned rectangles, then draw them one by one at the painting period, last,remove all
345      *          the recorded rectangles when finish painting.
346     */
347     void (*FFI_OutputSelectedRect)(struct _FPDF_FORMFILLINFO* pThis,FPDF_PAGE page, double left, double top, double right, double bottom);
348
349     /**
350     * Method: FFI_SetCursor
351     *           Set the Cursor shape.
352     * Interface Version:
353     *           1
354     * Implementation Required:
355     *           yes
356     * Parameters:
357     *       pThis       -   Pointer to the interface structure itself.
358     *       nCursorType -   Cursor type. see Flags for Cursor type for the details.
359     *   Return value:
360     *       None.
361     * */
362     void (*FFI_SetCursor)(struct _FPDF_FORMFILLINFO* pThis, int nCursorType);
363
364     /**
365     * Method: FFI_SetTimer
366     *           This method installs a system timer. A time-out value is specified,
367     *           and every time a time-out occurs, the system passes a message to
368     *           the TimerProc callback function.
369     * Interface Version:
370     *           1
371     * Implementation Required:
372     *           yes
373     * Parameters:
374     *       pThis       -   Pointer to the interface structure itself.
375     *       uElapse     -   Specifies the time-out value, in milliseconds.
376     *       lpTimerFunc -   A pointer to the callback function-TimerCallback.
377     *   Return value:
378     *       The timer identifier of the new timer if the function is successful.
379     *       An application passes this value to the FFI_KillTimer method to kill
380     *       the timer. Nonzero if it is successful; otherwise, it is zero.
381     * */
382     int  (*FFI_SetTimer)(struct _FPDF_FORMFILLINFO* pThis, int uElapse, TimerCallback lpTimerFunc);
383
384     /**
385     * Method: FFI_KillTimer
386     *           This method kills the timer event identified by nIDEvent, set by an earlier call to FFI_SetTimer.
387     * Interface Version:
388     *           1
389     * Implementation Required:
390     *           yes
391     * Parameters:
392     *       pThis       -   Pointer to the interface structure itself.
393     *       nTimerID    -   The timer ID return by FFI_SetTimer function.
394     *   Return value:
395     *       None.
396     * */
397     void (*FFI_KillTimer)(struct _FPDF_FORMFILLINFO* pThis, int nTimerID);
398
399
400     /**
401     * Method: FFI_GetLocalTime
402     *           This method receives the current local time on the system.
403     * Interface Version:
404     *           1
405     * Implementation Required:
406     *           yes
407     * Parameters:
408     *       pThis       -   Pointer to the interface structure itself.
409     *   Return value:
410     *       None.
411     * */
412     FPDF_SYSTEMTIME (*FFI_GetLocalTime)(struct _FPDF_FORMFILLINFO* pThis);
413
414     /**
415     * Method: FFI_OnChange
416     *           This method will be invoked to notify implementation when the value of any FormField on the document had been changed.
417     * Interface Version:
418     *           1
419     * Implementation Required:
420     *           no
421     * Parameters:
422     *       pThis       -   Pointer to the interface structure itself.
423     *   Return value:
424     *       None.
425     * */
426     void (*FFI_OnChange)(struct _FPDF_FORMFILLINFO* pThis);
427
428     /**
429     * Method: FFI_GetPage
430     *           This method receives the page pointer associated with a specified page index.
431     * Interface Version:
432     *           1
433     * Implementation Required:
434     *           yes
435     * Parameters:
436     *       pThis       -   Pointer to the interface structure itself.
437     *       document    -   Handle to document. Returned by FPDF_LoadDocument function.
438     *       nPageIndex  -   Index number of the page. 0 for the first page.
439     * Return value:
440     *       Handle to the page. Returned by FPDF_LoadPage function.
441     * Comments:
442     *       In some cases, the document-level JavaScript action may refer to a page which hadn't been loaded yet.
443     *       To successfully run the javascript action, implementation need to load the page for SDK.
444     * */
445     FPDF_PAGE   (*FFI_GetPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DOCUMENT document, int nPageIndex);
446
447     /**
448     * Method: FFI_GetCurrentPage
449     *       This method receives the current page pointer.
450     * Interface Version:
451     *           1
452     * Implementation Required:
453     *           yes
454     * Parameters:
455     *       pThis       -   Pointer to the interface structure itself.
456     *       document    -   Handle to document. Returned by FPDF_LoadDocument function.
457     * Return value:
458     *       Handle to the page. Returned by FPDF_LoadPage function.
459     * */
460     FPDF_PAGE   (*FFI_GetCurrentPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DOCUMENT document);
461
462     /**
463     * Method: FFI_GetRotation
464     *           This method receives currently rotation of the page view.
465     * Interface Version:
466     *           1
467     * Implementation Required:
468     *           yes
469     * Parameters:
470     *       pThis       -   Pointer to the interface structure itself.
471     *       page        -   Handle to page. Returned by FPDF_LoadPage function.
472     * Return value:
473     *       The page rotation. Should be 0(0 degree),1(90 degree),2(180 degree),3(270 degree), in a clockwise direction.
474     * */
475     int     (*FFI_GetRotation)(struct _FPDF_FORMFILLINFO* pThis, FPDF_PAGE page);
476
477     /**
478     * Method: FFI_ExecuteNamedAction
479     *           This method will execute an named action.
480     * Interface Version:
481     *           1
482     * Implementation Required:
483     *           yes
484     * Parameters:
485     *       pThis           -   Pointer to the interface structure itself.
486     *       namedAction     -   A byte string which indicates the named action, terminated by 0.
487     * Return value:
488     *       None.
489     * Comments:
490     *       See the named actions description of <<PDF Reference, version 1.7>> for more details.
491     * */
492     void    (*FFI_ExecuteNamedAction)(struct _FPDF_FORMFILLINFO* pThis, FPDF_BYTESTRING namedAction);
493     /**
494     * @brief This method will be called when a text field is getting or losing a focus.
495     *
496     * @param[in] pThis      Pointer to the interface structure itself.
497     * @param[in] value      The string value of the form field, in UTF-16LE format.
498     * @param[in] valueLen   The length of the string value, number of characters (not bytes).
499     * @param[in] is_focus   True if the form field is getting a focus, False for losing a focus.
500     *
501     * @return None.
502     *
503     * @note Currently,only support text field and combobox field.
504     * */
505     void    (*FFI_SetTextFieldFocus)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDESTRING value, FPDF_DWORD valueLen, FPDF_BOOL is_focus);
506
507
508     /**
509     * Method: FFI_DoURIAction
510     *           This action resolves to a uniform resource identifier.
511     * Interface Version:
512     *           1
513     * Implementation Required:
514     *           No
515     * Parameters:
516     *       pThis           -   Pointer to the interface structure itself.
517     *       bsURI           -   A byte string which indicates the uniform resource identifier, terminated by 0.
518     * Return value:
519     *       None.
520     * Comments:
521     *       See the URI actions description of <<PDF Reference, version 1.7>> for more details.
522     * */
523     void    (*FFI_DoURIAction)(struct _FPDF_FORMFILLINFO* pThis, FPDF_BYTESTRING bsURI);
524
525     /**
526     * Method: FFI_DoGoToAction
527     *           This action changes the view to a specified destination.
528     * Interface Version:
529     *           1
530     * Implementation Required:
531     *           No
532     * Parameters:
533     *       pThis           -   Pointer to the interface structure itself.
534     *       nPageIndex      -   The index of the PDF page.
535     *       zoomMode        -   The zoom mode for viewing page.See Macros "PDFZOOM_XXX" defined in "fpdfdoc.h".
536     *       fPosArray       -   The float array which carries the position info.
537     *       sizeofArray     -   The size of float array.
538     * Return value:
539     *       None.
540     * Comments:
541     *       See the Destinations description of <<PDF Reference, version 1.7>> in 8.2.1 for more details.
542     **/
543     void    (*FFI_DoGoToAction)(struct _FPDF_FORMFILLINFO* pThis, int nPageIndex, int zoomMode, float* fPosArray, int sizeofArray);
544     /**
545     *   pointer to IPDF_JSPLATFORM interface
546     **/
547     IPDF_JSPLATFORM*    m_pJsPlatform;
548
549 } FPDF_FORMFILLINFO;
550
551
552
553 /**
554  * Function: FPDFDOC_InitFormFillEnvironment
555  *          Init form fill environment.
556  * Comments:
557  *          This function should be called before any form fill operation.
558  * Parameters:
559  *          document        -   Handle to document. Returned by FPDF_LoadDocument function.
560  *          pFormFillInfo   -   Pointer to a FPDF_FORMFILLINFO structure.
561  * Return Value:
562  *          Return handler to the form fill module. NULL means fails.
563  **/
564 DLLEXPORT FPDF_FORMHANDLE STDCALL FPDFDOC_InitFormFillEnvironment(FPDF_DOCUMENT document, FPDF_FORMFILLINFO* formInfo);
565
566 /**
567  * Function: FPDFDOC_ExitFormFillEnvironment
568  *          Exit form fill environment.
569  * Parameters:
570  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
571  * Return Value:
572  *          NULL.
573  **/
574 DLLEXPORT void STDCALL FPDFDOC_ExitFormFillEnvironment(FPDF_FORMHANDLE hHandle);
575
576 /**
577  * Function: FORM_OnAfterLoadPage
578  *          This method is required for implementing all the form related functions. Should be invoked after user
579  *          successfully loaded a PDF page, and method FPDFDOC_InitFormFillEnvironment had been invoked.
580  * Parameters:
581  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
582  * Return Value:
583  *          NONE.
584  **/
585 DLLEXPORT void STDCALL FORM_OnAfterLoadPage(FPDF_PAGE page, FPDF_FORMHANDLE hHandle);
586
587 /**
588  * Function: FORM_OnBeforeClosePage
589  *          This method is required for implementing all the form related functions. Should be invoked before user
590  *          close the PDF page.
591  * Parameters:
592  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
593  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
594  * Return Value:
595  *          NONE.
596  **/
597 DLLEXPORT void STDCALL FORM_OnBeforeClosePage(FPDF_PAGE page, FPDF_FORMHANDLE hHandle);
598
599 /**
600 * Function: FORM_DoDocumentJSAction
601 *           This method is required for performing Document-level JavaScript action. It should be invoked after the PDF document
602 *           had been loaded.
603 * Parameters:
604 *           hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
605 * Return Value:
606 *           NONE
607 * Comments:
608 *           If there is Document-level JavaScript action embedded in the document, this method will execute the javascript action;
609 *           otherwise, the method will do nothing.
610 **/
611 DLLEXPORT void STDCALL FORM_DoDocumentJSAction(FPDF_FORMHANDLE hHandle);
612
613
614 /**
615 * Function: FORM_DoDocumentOpenAction
616 *           This method is required for performing open-action when the document is opened.
617 * Parameters:
618 *           hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
619 * Return Value:
620 *           NONE
621 * Comments:
622 *           This method will do nothing if there is no open-actions embedded in the document.
623 **/
624 DLLEXPORT void STDCALL FORM_DoDocumentOpenAction(FPDF_FORMHANDLE hHandle);
625
626
627 // additional actions type of document.
628 #define FPDFDOC_AACTION_WC      0x10        //WC, before closing document, JavaScript action.
629 #define FPDFDOC_AACTION_WS      0x11        //WS, before saving document, JavaScript action.
630 #define FPDFDOC_AACTION_DS      0x12        //DS, after saving document, JavaScript action.
631 #define FPDFDOC_AACTION_WP      0x13        //WP, before printing document, JavaScript action.
632 #define FPDFDOC_AACTION_DP      0x14        //DP, after printing document, JavaScript action.
633 /**
634 * Function: FORM_DoDocumentAAction
635 *           This method is required for performing the document's additional-action.
636 * Parameters:
637 *           hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
638 *           aaType      -   The type of the additional-actions which defined above.
639 * Return Value:
640 *           NONE
641 * Comments:
642 *           This method will do nothing if there is no document additional-action corresponding to the specified aaType.
643 **/
644
645 DLLEXPORT void STDCALL FORM_DoDocumentAAction(FPDF_FORMHANDLE hHandle, int aaType);
646
647 // Additional-action types of page object
648 #define FPDFPAGE_AACTION_OPEN       0       // /O -- An action to be performed when the page is opened
649 #define FPDFPAGE_AACTION_CLOSE      1       // /C -- An action to be performed when the page is closed
650
651 /**
652 * Function: FORM_DoPageAAction
653 *           This method is required for performing the page object's additional-action when opened or closed.
654 * Parameters:
655 *           page        -   Handle to the page. Returned by FPDF_LoadPage function.
656 *           hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
657 *           aaType      -   The type of the page object's additional-actions which defined above.
658 * Return Value:
659 *           NONE
660 * Comments:
661 *           This method will do nothing if no additional-action corresponding to the specified aaType exists.
662 **/
663 DLLEXPORT void STDCALL FORM_DoPageAAction(FPDF_PAGE page, FPDF_FORMHANDLE hHandle, int aaType);
664
665 /**
666  * Function: FORM_OnMouseMove
667  *          You can call this member function when the mouse cursor moves.
668  * Parameters:
669  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
670  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
671  *          modifier        -   Indicates whether various virtual keys are down.
672  *          page_x      -   Specifies the x-coordinate of the cursor in PDF user space.
673  *          page_y      -   Specifies the y-coordinate of the cursor in PDF user space.
674  * Return Value:
675  *          TRUE indicates success; otherwise false.
676  **/
677 DLLEXPORT FPDF_BOOL STDCALL FORM_OnMouseMove(FPDF_FORMHANDLE hHandle,FPDF_PAGE page, int modifier, double page_x, double page_y);
678
679 /**
680  * Function: FORM_OnLButtonDown
681  *          You can call this member function when the user presses the left mouse button.
682  * Parameters:
683  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
684  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
685  *          modifier        -   Indicates whether various virtual keys are down.
686  *          page_x      -   Specifies the x-coordinate of the cursor in PDF user space.
687  *          page_y      -   Specifies the y-coordinate of the cursor in PDF user space.
688  * Return Value:
689  *          TRUE indicates success; otherwise false.
690  **/
691 DLLEXPORT FPDF_BOOL STDCALL FORM_OnLButtonDown(FPDF_FORMHANDLE hHandle,FPDF_PAGE page, int modifier, double page_x, double page_y);
692
693 /**
694  * Function: FORM_OnLButtonUp
695  *          You can call this member function when the user releases the left mouse button.
696  * Parameters:
697  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
698  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
699  *          modifier    -   Indicates whether various virtual keys are down.
700  *          page_x      -   Specifies the x-coordinate of the cursor in device.
701  *          page_y      -   Specifies the y-coordinate of the cursor in device.
702  * Return Value:
703  *          TRUE indicates success; otherwise false.
704  **/
705 DLLEXPORT FPDF_BOOL STDCALL FORM_OnLButtonUp(FPDF_FORMHANDLE hHandle,FPDF_PAGE page, int modifier, double page_x, double page_y);
706
707 /**
708  * Function: FORM_OnKeyDown
709  *          You can call this member function when a nonsystem key is pressed.
710  * Parameters:
711  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
712  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
713  *          nKeyCode    -   Indicates whether various virtual keys are down.
714  *          modifier    -   Contains the scan code, key-transition code, previous key state, and context code.
715  * Return Value:
716  *          TRUE indicates success; otherwise false.
717  **/
718 DLLEXPORT FPDF_BOOL STDCALL FORM_OnKeyDown(FPDF_FORMHANDLE hHandle,FPDF_PAGE page, int nKeyCode, int modifier);
719
720 /**
721  * Function: FORM_OnKeyUp
722  *          You can call this member function when a nonsystem key is released.
723  * Parameters:
724  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
725  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
726  *          nKeyCode    -   The virtual-key code of the given key.
727  *          modifier    -   Contains the scan code, key-transition code, previous key state, and context code.
728  * Return Value:
729  *          TRUE indicates success; otherwise false.
730  **/
731 DLLEXPORT FPDF_BOOL STDCALL FORM_OnKeyUp(FPDF_FORMHANDLE hHandle,FPDF_PAGE page, int nKeyCode, int modifier);
732
733 /**
734  * Function: FORM_OnChar
735  *          You can call this member function when a keystroke translates to a nonsystem character.
736  * Parameters:
737  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
738  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
739  *          nChar       -   The character code value of the key.
740  *          modifier    -   Contains the scan code, key-transition code, previous key state, and context code.
741  * Return Value:
742  *          TRUE indicates success; otherwise false.
743  **/
744 DLLEXPORT FPDF_BOOL STDCALL FORM_OnChar(FPDF_FORMHANDLE hHandle,FPDF_PAGE page, int nChar, int modifier);
745
746 /**
747  * Function: FORM_ForceToKillFocus.
748  *          You can call this member function to force to kill the focus of the form field which got focus.
749  *          It would kill the focus on the form field, save the value of form field if it's changed by user.
750  * Parameters:
751  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
752  * Return Value:
753  *          TRUE indicates success; otherwise false.
754  **/
755 DLLEXPORT FPDF_BOOL STDCALL FORM_ForceToKillFocus(FPDF_FORMHANDLE hHandle);
756
757 // Field Types
758 #define FPDF_FORMFIELD_UNKNOWN      0       // Unknown.
759 #define FPDF_FORMFIELD_PUSHBUTTON   1       // push button type.
760 #define FPDF_FORMFIELD_CHECKBOX     2       // check box type.
761 #define FPDF_FORMFIELD_RADIOBUTTON  3       // radio button type.
762 #define FPDF_FORMFIELD_COMBOBOX     4       // combo box type.
763 #define FPDF_FORMFIELD_LISTBOX      5       // list box type.
764 #define FPDF_FORMFIELD_TEXTFIELD    6       // text field type.
765
766 /**
767  * Function: FPDPage_HasFormFieldAtPoint
768  *          Check the form filed position by point.
769  * Parameters:
770  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
771  *          page        -   Handle to the page. Returned by FPDF_LoadPage function.
772  *          page_x      -   X position in PDF "user space".
773  *          page_y      -   Y position in PDF "user space".
774  * Return Value:
775  *          Return the type of the formfiled; -1 indicates no fields.
776  **/
777 DLLEXPORT int STDCALL FPDPage_HasFormFieldAtPoint(FPDF_FORMHANDLE hHandle,FPDF_PAGE page,double page_x, double page_y);
778
779 /**
780  * Function: FPDF_SetFormFieldHighlightColor
781  *          Set the highlight color of specified or all the form fields in the document.
782  * Parameters:
783  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
784  *          doc         -   Handle to the document. Returned by FPDF_LoadDocument function.
785  *          fieldType   -   A 32-bit integer indicating the type of a form field(defined above).
786  *          color       -   The highlight color of the form field.Constructed by 0xxxrrggbb.
787  * Return Value:
788  *          NONE.
789  * Comments:
790  *          When the parameter fieldType is set to zero, the highlight color will be applied to all the form fields in the
791  *          document.
792  *          Please refresh the client window to show the highlight immediately if necessary.
793  **/
794 DLLEXPORT void STDCALL FPDF_SetFormFieldHighlightColor(FPDF_FORMHANDLE hHandle, int fieldType, unsigned long color);
795
796 /**
797  * Function: FPDF_SetFormFieldHighlightAlpha
798  *          Set the transparency of the form field highlight color in the document.
799  * Parameters:
800  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
801  *          doc         -   Handle to the document. Returned by FPDF_LoadDocument function.
802  *          alpha       -   The transparency of the form field highlight color. between 0-255.
803  * Return Value:
804  *          NONE.
805  **/
806 DLLEXPORT void STDCALL FPDF_SetFormFieldHighlightAlpha(FPDF_FORMHANDLE hHandle, unsigned char alpha);
807
808
809 /**
810  * Function: FPDF_RemoveFormFieldHighlight
811  *          Remove the form field highlight color in the document.
812  * Parameters:
813  *          hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
814  * Return Value:
815  *          NONE.
816  * Comments:
817  *          Please refresh the client window to remove the highlight immediately if necessary.
818  **/
819 DLLEXPORT void STDCALL FPDF_RemoveFormFieldHighlight(FPDF_FORMHANDLE hHandle);
820
821 /**
822 * Function: FPDF_FFLDraw
823 *           Render FormFeilds on a page to a device independent bitmap.
824 * Parameters:
825 *           hHandle     -   Handle to the form fill module. Returned by FPDFDOC_InitFormFillEnvironment.
826 *           bitmap      -   Handle to the device independent bitmap (as the output buffer).
827 *                           Bitmap handle can be created by FPDFBitmap_Create function.
828 *           page        -   Handle to the page. Returned by FPDF_LoadPage function.
829 *           start_x     -   Left pixel position of the display area in the device coordinate.
830 *           start_y     -   Top pixel position of the display area in the device coordinate.
831 *           size_x      -   Horizontal size (in pixels) for displaying the page.
832 *           size_y      -   Vertical size (in pixels) for displaying the page.
833 *           rotate      -   Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
834 *                               2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
835 *           flags       -   0 for normal display, or combination of flags defined above.
836 * Return Value:
837 *           None.
838 * Comments:
839 *           This method is designed to only render annotations and FormFields on the page.
840 *           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.
841 *           In order to implement the FormFill functions,Implementation should call this method after rendering functions finish rendering the page contents.
842 **/
843 DLLEXPORT void STDCALL FPDF_FFLDraw(FPDF_FORMHANDLE hHandle,FPDF_BITMAP bitmap, FPDF_PAGE page, int start_x, int start_y,
844                         int size_x, int size_y, int rotate, int flags);
845
846
847 #ifdef __cplusplus
848 }
849 #endif
850
851 #endif  // PUBLIC_FPDF_FORMFILL_H_