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 1465 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1476 * Return Value: | 1476 * Return Value: |
1477 * NONE. | 1477 * NONE. |
1478 * Comments: | 1478 * Comments: |
1479 * Please refresh the client window to remove the highlight immediately | 1479 * Please refresh the client window to remove the highlight immediately |
1480 *if necessary. | 1480 *if necessary. |
1481 **/ | 1481 **/ |
1482 DLLEXPORT void STDCALL FPDF_RemoveFormFieldHighlight(FPDF_FORMHANDLE hHandle); | 1482 DLLEXPORT void STDCALL FPDF_RemoveFormFieldHighlight(FPDF_FORMHANDLE hHandle); |
1483 | 1483 |
1484 /** | 1484 /** |
1485 * Function: FPDF_FFLDraw | 1485 * Function: FPDF_FFLDraw |
1486 * Render FormFeilds on a page to a device independent bitmap. | 1486 * Render FormFields and popup window on a page to a device independent |
| 1487 *bitmap. |
1487 * Parameters: | 1488 * Parameters: |
1488 * hHandle - Handle to the form fill module. Returned by | 1489 * hHandle - Handle to the form fill module. Returned by |
1489 *FPDFDOC_InitFormFillEnvironment. | 1490 *FPDFDOC_InitFormFillEnvironment. |
1490 * bitmap - Handle to the device independent bitmap (as the | 1491 * bitmap - Handle to the device independent bitmap (as the |
1491 *output buffer). | 1492 *output buffer). |
1492 * Bitmap handle can be created by FPDFBitmap_Create | 1493 * Bitmap handle can be created by FPDFBitmap_Create |
1493 *function. | 1494 *function. |
1494 * page - Handle to the page. Returned by FPDF_LoadPage | 1495 * page - Handle to the page. Returned by FPDF_LoadPage |
1495 *function. | 1496 *function. |
1496 * start_x - Left pixel position of the display area in the | 1497 * start_x - Left pixel position of the display area in the |
1497 *device coordinate. | 1498 *device coordinate. |
1498 * start_y - Top pixel position of the display area in the device | 1499 * start_y - Top pixel position of the display area in the device |
1499 *coordinate. | 1500 *coordinate. |
1500 * size_x - Horizontal size (in pixels) for displaying the page. | 1501 * size_x - Horizontal size (in pixels) for displaying the page. |
1501 * size_y - Vertical size (in pixels) for displaying the page. | 1502 * size_y - Vertical size (in pixels) for displaying the page. |
1502 * rotate - Page orientation: 0 (normal), 1 (rotated 90 degrees | 1503 * rotate - Page orientation: 0 (normal), 1 (rotated 90 degrees |
1503 *clockwise), | 1504 *clockwise), |
1504 * 2 (rotated 180 degrees), 3 (rotated 90 degrees | 1505 * 2 (rotated 180 degrees), 3 (rotated 90 degrees |
1505 *counter-clockwise). | 1506 *counter-clockwise). |
1506 * flags - 0 for normal display, or combination of flags | 1507 * flags - 0 for normal display, or combination of flags |
1507 *defined above. | 1508 *defined above. |
1508 * Return Value: | 1509 * Return Value: |
1509 * None. | 1510 * None. |
1510 * Comments: | 1511 * Comments: |
1511 * This method is designed to only render annotations and FormFields on | 1512 * This function is designed to render annotations that are |
1512 *the page. | 1513 *user-interactive, which are widget annotation (for FormFields) and popup |
1513 * Without FPDF_ANNOT specified for flags, Rendering functions such as | 1514 *annotation. |
1514 *FPDF_RenderPageBitmap or FPDF_RenderPageBitmap_Start will only render page | 1515 * With FPDF_ANNOT flag, this function will render popup annotation |
1515 *contents(without annotations) to a bitmap. | 1516 *when users mouse-hover on non-widget annotation. Regardless of FPDF_ANNOT flag, |
1516 * In order to implement the FormFill functions,Implementation should | 1517 *this function will always render widget annotations for FormFields. |
1517 *call this method after rendering functions finish rendering the page contents. | 1518 * In order to implement the FormFill functions, implementation should |
| 1519 *call this function after rendering functions, such as FPDF_RenderPageBitmap or |
| 1520 *FPDF_RenderPageBitmap_Start, finish rendering the page contents. |
1518 **/ | 1521 **/ |
1519 DLLEXPORT void STDCALL FPDF_FFLDraw(FPDF_FORMHANDLE hHandle, | 1522 DLLEXPORT void STDCALL FPDF_FFLDraw(FPDF_FORMHANDLE hHandle, |
1520 FPDF_BITMAP bitmap, | 1523 FPDF_BITMAP bitmap, |
1521 FPDF_PAGE page, | 1524 FPDF_PAGE page, |
1522 int start_x, | 1525 int start_x, |
1523 int start_y, | 1526 int start_y, |
1524 int size_x, | 1527 int size_x, |
1525 int size_y, | 1528 int size_y, |
1526 int rotate, | 1529 int rotate, |
1527 int flags); | 1530 int flags); |
(...skipping 223 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1751 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle, | 1754 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle, |
1752 FPDF_BYTESTRING bsText, | 1755 FPDF_BYTESTRING bsText, |
1753 FPDF_DWORD size); | 1756 FPDF_DWORD size); |
1754 #endif // PDF_ENABLE_XFA | 1757 #endif // PDF_ENABLE_XFA |
1755 | 1758 |
1756 #ifdef __cplusplus | 1759 #ifdef __cplusplus |
1757 } | 1760 } |
1758 #endif | 1761 #endif |
1759 | 1762 |
1760 #endif // PUBLIC_FPDF_FORMFILL_H_ | 1763 #endif // PUBLIC_FPDF_FORMFILL_H_ |
OLD | NEW |