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_ | 7 #ifndef PUBLIC_FPDF_FORMFILL_H_ |
8 #define PUBLIC_FPDF_FORMFILL_H_ | 8 #define PUBLIC_FPDF_FORMFILL_H_ |
9 | 9 |
10 #include "fpdfview.h" | 10 #include "fpdfview.h" |
(...skipping 559 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
570 * function. | 570 * function. |
571 * nPageIndex - Index number of the page. 0 for the first page. | 571 * nPageIndex - Index number of the page. 0 for the first page. |
572 * Return value: | 572 * Return value: |
573 * Handle to the page. Returned by FPDF_LoadPage function. | 573 * Handle to the page. Returned by FPDF_LoadPage function. |
574 * Comments: | 574 * Comments: |
575 * In some cases, the document-level JavaScript action may refer to a | 575 * In some cases, the document-level JavaScript action may refer to a |
576 * page which hadn't been loaded yet. | 576 * page which hadn't been loaded yet. |
577 * To successfully run the javascript action, implementation need to load | 577 * To successfully run the javascript action, implementation need to load |
578 * the page for SDK. | 578 * the page for SDK. |
579 * */ | 579 * */ |
580 FPDF_PAGE (*FFI_GetPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DOCUMENT doc
ument, int nPageIndex); | 580 FPDF_PAGE (*FFI_GetPage)(struct _FPDF_FORMFILLINFO* pThis, |
| 581 FPDF_DOCUMENT document, |
| 582 int nPageIndex); |
581 | 583 |
582 /** | 584 /** |
583 * Method: FFI_GetCurrentPage | 585 * Method: FFI_GetCurrentPage |
584 * This method receives the current page pointer. | 586 * This method receives the current page pointer. |
585 * Interface Version: | 587 * Interface Version: |
586 * 1 | 588 * 1 |
587 * Implementation Required: | 589 * Implementation Required: |
588 * yes | 590 * yes |
589 * Parameters: | 591 * Parameters: |
590 * pThis - Pointer to the interface structure itself. | 592 * pThis - Pointer to the interface structure itself. |
591 * document - Handle to document. Returned by FPDF_LoadDocument | 593 * document - Handle to document. Returned by FPDF_LoadDocument |
592 * function. | 594 * function. |
593 * Return value: | 595 * Return value: |
594 * Handle to the page. Returned by FPDF_LoadPage function. | 596 * Handle to the page. Returned by FPDF_LoadPage function. |
595 * */ | 597 * */ |
596 FPDF_PAGE (*FFI_GetCurrentPage)(struct _FPDF_FORMFILLINFO* pThis, FPDF_DOCUM
ENT document); | 598 FPDF_PAGE (*FFI_GetCurrentPage)(struct _FPDF_FORMFILLINFO* pThis, |
| 599 FPDF_DOCUMENT document); |
597 | 600 |
598 /** | 601 /** |
599 * Method: FFI_GetRotation | 602 * Method: FFI_GetRotation |
600 * This method receives currently rotation of the page view. | 603 * This method receives currently rotation of the page view. |
601 * Interface Version: | 604 * Interface Version: |
602 * 1 | 605 * 1 |
603 * Implementation Required: | 606 * Implementation Required: |
604 * yes | 607 * yes |
605 * Parameters: | 608 * Parameters: |
606 * pThis - Pointer to the interface structure itself. | 609 * pThis - Pointer to the interface structure itself. |
(...skipping 243 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
850 * hWidget - Handle to XFA fields. | 853 * hWidget - Handle to XFA fields. |
851 * menuFlag - The menu flags. Please refer to macro definition | 854 * menuFlag - The menu flags. Please refer to macro definition |
852 *of FXFA_MEMU_XXX and this can be one or a combination of these macros. | 855 *of FXFA_MEMU_XXX and this can be one or a combination of these macros. |
853 * x - X position of the client area in PDF page | 856 * x - X position of the client area in PDF page |
854 *coordinate. | 857 *coordinate. |
855 * y - Y position of the client area in PDF page | 858 * y - Y position of the client area in PDF page |
856 *coordinate. | 859 *coordinate. |
857 * Return value: | 860 * Return value: |
858 * TRUE indicates success; otherwise false. | 861 * TRUE indicates success; otherwise false. |
859 **/ | 862 **/ |
860 FPDF_BOOL (*FFI_PopupMenu)(struct _FPDF_FORMFILLINFO* pThis, FPDF_PAGE page, F
PDF_WIDGET hWidget, int menuFlag, float x, float y); | 863 FPDF_BOOL (*FFI_PopupMenu)(struct _FPDF_FORMFILLINFO* pThis, |
| 864 FPDF_PAGE page, |
| 865 FPDF_WIDGET hWidget, |
| 866 int menuFlag, |
| 867 float x, |
| 868 float y); |
861 | 869 |
862 /** | 870 /** |
863 * Method: FFI_OpenFile | 871 * Method: FFI_OpenFile |
864 * This method will open the specified file with the specified mode. | 872 * This method will open the specified file with the specified mode. |
865 * Interface Version | 873 * Interface Version |
866 * 2 | 874 * 2 |
867 * Implementation Required: | 875 * Implementation Required: |
868 * yes | 876 * yes |
869 * Parameters: | 877 * Parameters: |
870 * pThis - Pointer to the interface structure itself. | 878 * pThis - Pointer to the interface structure itself. |
(...skipping 110 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
981 * 2 | 989 * 2 |
982 * Implementation Required: | 990 * Implementation Required: |
983 * yes | 991 * yes |
984 * Parameters: | 992 * Parameters: |
985 * pThis - Pointer to the interface structure itself. | 993 * pThis - Pointer to the interface structure itself. |
986 * URL - The string value of the file URL, in UTF-16LE | 994 * URL - The string value of the file URL, in UTF-16LE |
987 *format. | 995 *format. |
988 * Return value: | 996 * Return value: |
989 * The handle to FPDF_FILEHANDLER. | 997 * The handle to FPDF_FILEHANDLER. |
990 **/ | 998 **/ |
991 FPDF_LPFILEHANDLER (*FFI_DownloadFromURL)(struct _FPDF_FORMFILLINFO* pThis, F
PDF_WIDESTRING URL); | 999 FPDF_LPFILEHANDLER (*FFI_DownloadFromURL)(struct _FPDF_FORMFILLINFO* pThis, |
| 1000 FPDF_WIDESTRING URL); |
992 /** | 1001 /** |
993 * Method: FFI_PostRequestURL | 1002 * Method: FFI_PostRequestURL |
994 * This method will post the request to the server URL. | 1003 * This method will post the request to the server URL. |
995 * Interface Version: | 1004 * Interface Version: |
996 * 2 | 1005 * 2 |
997 * Implementation Required: | 1006 * Implementation Required: |
998 * yes | 1007 * yes |
999 * Parameters: | 1008 * Parameters: |
1000 * pThis - Pointer to the interface structure itself. | 1009 * pThis - Pointer to the interface structure itself. |
1001 * wsURL - The string value of the server URL, in UTF-16LE | 1010 * wsURL - The string value of the server URL, in UTF-16LE |
1002 *format. | 1011 *format. |
1003 * wsData - The post data,in UTF-16LE format. | 1012 * wsData - The post data,in UTF-16LE format. |
1004 * wsContentType - The content type of the request data,in UTF-16LE | 1013 * wsContentType - The content type of the request data,in UTF-16LE |
1005 *format. | 1014 *format. |
1006 * wsEncode - The encode type,in UTF-16LE format. | 1015 * wsEncode - The encode type,in UTF-16LE format. |
1007 * wsHeader - The request header,in UTF-16LE format. | 1016 * wsHeader - The request header,in UTF-16LE format. |
1008 * response - Pointer to the FPDF_BSTR to receive the response | 1017 * response - Pointer to the FPDF_BSTR to receive the response |
1009 *data from server,,in UTF-16LE format. | 1018 *data from server,,in UTF-16LE format. |
1010 * Return value: | 1019 * Return value: |
1011 * TRUE indicates success, otherwise FALSE. | 1020 * TRUE indicates success, otherwise FALSE. |
1012 **/ | 1021 **/ |
1013 FPDF_BOOL (*FFI_PostRequestURL)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDES
TRING wsURL, FPDF_WIDESTRING wsData, FPDF_WIDESTRING wsContentType, FPDF_WIDESTR
ING wsEncode, FPDF_WIDESTRING wsHeader, FPDF_BSTR* respone); | 1022 FPDF_BOOL (*FFI_PostRequestURL)(struct _FPDF_FORMFILLINFO* pThis, |
| 1023 FPDF_WIDESTRING wsURL, |
| 1024 FPDF_WIDESTRING wsData, |
| 1025 FPDF_WIDESTRING wsContentType, |
| 1026 FPDF_WIDESTRING wsEncode, |
| 1027 FPDF_WIDESTRING wsHeader, |
| 1028 FPDF_BSTR* respone); |
1014 | 1029 |
1015 /** | 1030 /** |
1016 * Method: FFI_PutRequestURL | 1031 * Method: FFI_PutRequestURL |
1017 * This method will put the request to the server URL. | 1032 * This method will put the request to the server URL. |
1018 * Interface Version: | 1033 * Interface Version: |
1019 * 2 | 1034 * 2 |
1020 * Implementation Required: | 1035 * Implementation Required: |
1021 * yes | 1036 * yes |
1022 * Parameters: | 1037 * Parameters: |
1023 * pThis - Pointer to the interface structure itself. | 1038 * pThis - Pointer to the interface structure itself. |
1024 * wsURL - The string value of the server URL, in UTF-16LE | 1039 * wsURL - The string value of the server URL, in UTF-16LE |
1025 *format. | 1040 *format. |
1026 * wsData - The put data, in UTF-16LE format. | 1041 * wsData - The put data, in UTF-16LE format. |
1027 * wsEncode - The encode type, in UTR-16LE format. | 1042 * wsEncode - The encode type, in UTR-16LE format. |
1028 * Return value: | 1043 * Return value: |
1029 * TRUE indicates success, otherwise FALSE. | 1044 * TRUE indicates success, otherwise FALSE. |
1030 **/ | 1045 **/ |
1031 FPDF_BOOL (*FFI_PutRequestURL)(struct _FPDF_FORMFILLINFO* pThis, FPDF_WIDEST
RING wsURL, FPDF_WIDESTRING wsData, FPDF_WIDESTRING wsEncode); | 1046 FPDF_BOOL (*FFI_PutRequestURL)(struct _FPDF_FORMFILLINFO* pThis, |
| 1047 FPDF_WIDESTRING wsURL, |
| 1048 FPDF_WIDESTRING wsData, |
| 1049 FPDF_WIDESTRING wsEncode); |
1032 #endif // PDF_ENABLE_XFA | 1050 #endif // PDF_ENABLE_XFA |
1033 } FPDF_FORMFILLINFO; | 1051 } FPDF_FORMFILLINFO; |
1034 | 1052 |
1035 /** | 1053 /** |
1036 * Function: FPDFDOC_InitFormFillEnvironment | 1054 * Function: FPDFDOC_InitFormFillEnvironment |
1037 * Init form fill environment. | 1055 * Init form fill environment. |
1038 * Comments: | 1056 * Comments: |
1039 * This function should be called before any form fill operation. | 1057 * This function should be called before any form fill operation. |
1040 * Parameters: | 1058 * Parameters: |
1041 * document - Handle to document. Returned by | 1059 * document - Handle to document. Returned by |
(...skipping 661 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1703 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle, | 1721 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle, |
1704 FPDF_BYTESTRING bsText, | 1722 FPDF_BYTESTRING bsText, |
1705 FPDF_DWORD size); | 1723 FPDF_DWORD size); |
1706 #endif // PDF_ENABLE_XFA | 1724 #endif // PDF_ENABLE_XFA |
1707 | 1725 |
1708 #ifdef __cplusplus | 1726 #ifdef __cplusplus |
1709 } | 1727 } |
1710 #endif | 1728 #endif |
1711 | 1729 |
1712 #endif // PUBLIC_FPDF_FORMFILL_H_ | 1730 #endif // PUBLIC_FPDF_FORMFILL_H_ |
OLD | NEW |