Merge to XFA: Add new public APIs to find the z-order for links and widgets.

public/fpdf_doc.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_DOC_H_
 #define PUBLIC_FPDF_DOC_H_
 
 #include "fpdfview.h"
@@ skipping 159 matching lines @@
 // Parameters:
 //          document    -   Handle to the document.
 //          dest        -   Handle to the destination.
 // Return value:
 //          The page index. Starting from 0 for the first page.
 //
 DLLEXPORT unsigned long STDCALL FPDFDest_GetPageIndex(FPDF_DOCUMENT document,
                                                       FPDF_DEST dest);
 
 // Function: FPDFLink_GetLinkAtPoint
-//          Find a link at specified point on a document page.
+//     Find a link at specified point on a document page.
 // Parameters:
-//          page        -   Handle to the document page.
-//          x           -   The x coordinate of the point, specified in page
-//          coordinate system.
-//          y           -   The y coordinate of the point, specified in page
-//          coordinate system.
+//     page        -   Handle to the document page.
+//     x           -   The x coordinate of the point, specified in page
+//                     coordinate system.
+//     y           -   The y coordinate of the point, specified in page
+//                     coordinate system.
 // Return value:
-//          Handle to the link. NULL if no link found at that point.
+//     Handle to the link. NULL if no link found at that point.
 // Comments:
-//          The point coordinates are specified in page coordinate system. You
-//          can convert coordinates
-//          from screen system to page system using FPDF_DeviceToPage functions.
+//     The point coordinates are specified in page coordinate system. You can
+//     convert coordinates from screen system to page system using
+//     FPDF_DeviceToPage().
+//
 // Notes:
-//          The method can not support this feature for the document consists of
-//          dynamic XFA fields.
+//     The method can not support this feature for the document consists of
+//     dynamic XFA fields.
 //
 DLLEXPORT FPDF_LINK STDCALL FPDFLink_GetLinkAtPoint(FPDF_PAGE page,
                                                     double x,
                                                     double y);
 
+// Function: FPDFLink_GetLinkZOrderAtPoint
+//     Find the z-order of a link at specified point on a document page.
+// Parameters:
+//     page        -   Handle to the document page.
+//     x           -   The x coordinate of the point, specified in page
+//                     coordinate system.
+//     y           -   The y coordinate of the point, specified in page
+//                     coordinate system.
+// Return value:
+//     Z-order of the link, or -1 if no link found at that point.
+//     Higher numbers are closer to the front.
+// Comments:
+//     The point coordinates are specified in page coordinate system. You can
+//     convert coordinates from screen system to page system using
+//     FPDF_DeviceToPage().
+//
+// Notes:
+//     The method can not support this feature for the document consists of
+//     dynamic XFA fields.
+//
+//
+DLLEXPORT int STDCALL
+FPDFLink_GetLinkZOrderAtPoint(FPDF_PAGE page, double x, double y);
+
 // Function: FPDFLink_GetDest
 //          Get destination info of a link.
 // Parameters:
 //          document    -   Handle to the document.
 //          link        -   Handle to the link. Returned by
 //          FPDFLink_GetLinkAtPoint.
 // Return value:
 //          Handle to the destination. NULL if there is no destination
 //          associated with the link, in this case
 //          the application should try FPDFLink_GetAction.
@@ skipping 116 matching lines @@
 DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT doc,
                                                  FPDF_BYTESTRING tag,
                                                  void* buffer,
                                                  unsigned long buflen);
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif  // PUBLIC_FPDF_DOC_H_