Define behaviors of FPDF_RenderPageBitmap_Retail and FPDF_FFLDraw.

public/fpdf_formfill.h

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #ifndef PUBLIC_FPDF_FORMFILL_H_
 #define PUBLIC_FPDF_FORMFILL_H_
 
 #include "fpdfview.h"
@@ skipping 1465 matching lines @@
  * Return Value:
  *          NONE.
  * Comments:
  *          Please refresh the client window to remove the highlight immediately
  *if necessary.
  **/
 DLLEXPORT void STDCALL FPDF_RemoveFormFieldHighlight(FPDF_FORMHANDLE hHandle);
 
 /**
 * Function: FPDF_FFLDraw
-*           Render FormFeilds on a page to a device independent bitmap.
+*           Render FormFields and popup window on a page to a device independent
+*bitmap.
 * Parameters:
 *           hHandle     -   Handle to the form fill module. Returned by
 *FPDFDOC_InitFormFillEnvironment.
 *           bitmap      -   Handle to the device independent bitmap (as the
 *output buffer).
 *                           Bitmap handle can be created by FPDFBitmap_Create
 *function.
 *           page        -   Handle to the page. Returned by FPDF_LoadPage
 *function.
 *           start_x     -   Left pixel position of the display area in the
 *device coordinate.
 *           start_y     -   Top pixel position of the display area in the device
 *coordinate.
 *           size_x      -   Horizontal size (in pixels) for displaying the page.
 *           size_y      -   Vertical size (in pixels) for displaying the page.
 *           rotate      -   Page orientation: 0 (normal), 1 (rotated 90 degrees
 *clockwise),
 *                               2 (rotated 180 degrees), 3 (rotated 90 degrees
 *counter-clockwise).
 *           flags       -   0 for normal display, or combination of flags
 *defined above.
 * Return Value:
 *           None.
 * Comments:
-*           This method is designed to only render annotations and FormFields on
-*the page.
-*           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.
-*           In order to implement the FormFill functions,Implementation should
-*call this method after rendering functions finish rendering the page contents.
+*           This function is designed to render annotations that are
+*user-interactive, which are widget annotation (for FormFields) and popup
+*annotation.
+*           With FPDF_ANNOT flag, this function will render popup annotation
+*when users mouse-hover on non-widget annotation. Regardless of FPDF_ANNOT flag,
+*this function will always render widget annotations for FormFields.
+*           In order to implement the FormFill functions, implementation should
+*call this function after rendering functions, such as FPDF_RenderPageBitmap or
+*FPDF_RenderPageBitmap_Start, finish rendering the page contents.
 **/
 DLLEXPORT void STDCALL FPDF_FFLDraw(FPDF_FORMHANDLE hHandle,
                                     FPDF_BITMAP bitmap,
                                     FPDF_PAGE page,
                                     int start_x,
                                     int start_y,
                                     int size_x,
                                     int size_y,
                                     int rotate,
                                     int flags);
@@ skipping 223 matching lines @@
 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle,
                            FPDF_BYTESTRING bsText,
                            FPDF_DWORD size);
 #endif  // PDF_ENABLE_XFA
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif  // PUBLIC_FPDF_FORMFILL_H_