From 4d62b6b16bf5df3911948bdb5dd336b365ec76e0 Mon Sep 17 00:00:00 2001 From: Bo Xu Date: Sat, 10 Jan 2015 22:52:59 -0800 Subject: XFA: merge patch from CL 834703002, add APIs for getting bookmarks and named destinations. Also uses "((CPDFXFA_Document*)document)->GetPDFDoc();" in a various places Add APIs for getting bookmarks and named destinations. R=tsepez@chromium.org Review URL: https://codereview.chromium.org/834703002 --- fpdfsdk/include/fpdfdoc.h | 39 +++++++++++++++++++++++++++++++++++++++ fpdfsdk/include/fpdfview.h | 25 +++++++++++++++++++++++++ 2 files changed, 64 insertions(+) (limited to 'fpdfsdk/include') diff --git a/fpdfsdk/include/fpdfdoc.h b/fpdfsdk/include/fpdfdoc.h index da49ba062a..99deab27fe 100644 --- a/fpdfsdk/include/fpdfdoc.h +++ b/fpdfsdk/include/fpdfdoc.h @@ -14,6 +14,45 @@ extern "C" { #endif +// Function: FPDFBookmark_GetFirstChild +// Get the first child of a bookmark item, or the first top level bookmark item. +// Parameters: +// document - Handle to the document. Returned by FPDF_LoadDocument or FPDF_LoadMemDocument. +// bookmark - Handle to the current bookmark. Can be NULL if you want to get the first top level item. +// Return value: +// Handle to the first child or top level bookmark item. NULL if no child or top level bookmark found. +// +DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_GetFirstChild(FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark); + +// Function: FPDFBookmark_GetNextSibling +// Get next bookmark item at the same level. +// Parameters: +// document - Handle to the document. Returned by FPDF_LoadDocument or FPDF_LoadMemDocument. +// bookmark - Handle to the current bookmark. Cannot be NULL. +// Return value: +// Handle to the next bookmark item at the same level. NULL if this is the last bookmark at this level. +// +DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_GetNextSibling(FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark); + +// Function: FPDFBookmark_GetTitle +// Get title of a bookmark. +// Parameters: +// bookmark - Handle to the bookmark. +// buffer - Buffer for the title. Can be NULL. +// buflen - The length of the buffer in bytes. Can be 0. +// Return value: +// Number of bytes the title consumes, including trailing zeros. +// Comments: +// Regardless of the platform, the title is always in UTF-16LE encoding. That means the buffer +// can be treated as an array of WORD (on Intel and compatible CPUs), each WORD representing the Unicode of +// a character(some special Unicode may take 2 WORDs).The string is followed by two bytes of zero +// indicating the end of the string. +// +// The return value always indicates the number of bytes required for the buffer, even if no buffer is specified +// or the buffer size is less then required. In these cases, the buffer will not be modified. +// +DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK bookmark, void* buffer, unsigned long buflen); + // Function: FPDFBookmark_Find // Find a bookmark in the document, using the bookmark title. // Parameters: diff --git a/fpdfsdk/include/fpdfview.h b/fpdfsdk/include/fpdfview.h index 34c3f522a4..2ae1d1f5b9 100644 --- a/fpdfsdk/include/fpdfview.h +++ b/fpdfsdk/include/fpdfview.h @@ -720,6 +720,14 @@ DLLEXPORT FPDF_PAGERANGE STDCALL FPDF_VIEWERREF_GetPrintPageRange(FPDF_DOCUMENT // DLLEXPORT FPDF_DUPLEXTYPE STDCALL FPDF_VIEWERREF_GetDuplex(FPDF_DOCUMENT document); +// Function: FPDF_CountNamedDests +// Get the count of named destinations in the PDF document. +// Parameters: +// document - Handle to a document +// Return value: +// The count of named destinations. +DLLEXPORT FPDF_DWORD STDCALL FPDF_CountNamedDests(FPDF_DOCUMENT document); + // Function: FPDF_GetNamedDestByName // get a special dest handle by the index. // Parameters: @@ -730,6 +738,23 @@ DLLEXPORT FPDF_DUPLEXTYPE STDCALL FPDF_VIEWERREF_GetDuplex(FPDF_DOCUMENT documen // DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDestByName(FPDF_DOCUMENT document,FPDF_BYTESTRING name); +// Function: FPDF_GetNamedDest +// Get the specified named destinations of the PDF document by index. +// Parameters: +// document - Handle to a document +// index - The index of named destination. +// buffer - The buffer to obtain destination name, used as wchar_t*. +// buflen - The length of the buffer in byte. +// Return value: +// The destination handle of a named destination, NULL when retrieving the length. +// Comments: +// Call this function twice to get the name of the named destination: +// 1) First time pass in |buffer| as NULL and get buflen. +// 2) Second time pass in allocated |buffer| and buflen to retrieve |buffer|, which should be used as wchar_t*. +// If buflen is not sufficiently large, it will be returned as -1. +// +DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDest(FPDF_DOCUMENT document, int index, void* buffer, unsigned long& buflen); + // Function: FPDF_BStr_Init // Helper function to initialize a byte string. DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Init(FPDF_BSTR* str); -- cgit v1.2.3