diff options
author | Bo Xu <bo_xu@foxitsoftware.com> | 2015-01-10 22:52:59 -0800 |
---|---|---|
committer | Bo Xu <bo_xu@foxitsoftware.com> | 2015-01-10 22:52:59 -0800 |
commit | 476cd69a6f5c5096a3145e0c4d567010f37739c3 (patch) | |
tree | 3ae201980b163ff06311858863402ee96feea266 /fpdfsdk/include | |
parent | f8105c665856863ad95da37fee6c12b98b953e2c (diff) | |
download | pdfium-476cd69a6f5c5096a3145e0c4d567010f37739c3.tar.xz |
Add APIs for getting bookmarks and named destinations.
R=tsepez@chromium.org
Review URL: https://codereview.chromium.org/834703002
Diffstat (limited to 'fpdfsdk/include')
-rw-r--r-- | fpdfsdk/include/fpdfdoc.h | 39 | ||||
-rw-r--r-- | fpdfsdk/include/fpdfview.h | 26 |
2 files changed, 65 insertions, 0 deletions
diff --git a/fpdfsdk/include/fpdfdoc.h b/fpdfsdk/include/fpdfdoc.h index 54ede4037a..1587ef4069 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 ddf359c127..e36d54e0a2 100644 --- a/fpdfsdk/include/fpdfview.h +++ b/fpdfsdk/include/fpdfview.h @@ -602,6 +602,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: @@ -612,6 +620,24 @@ 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); + + #ifdef __cplusplus }; #endif |