bookmarks.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_BOOKMARKS_H_INCLUDED_
#define PDFSDK_CORE_BOOKMARKS_H_INCLUDED_
 
#include <pdfsdk/core/actions.h>
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/errors.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct PDBookmarkRec_* PDBookmark;
 
enum {
    kPDBookmarkFlagItalic = 1 << 0,
    kPDBookmarkFlagBold = 1 << 1,
};
typedef uint32_t PDBookmarkFlags;
 
typedef void(PDFSDK_CALLCONV* PDBookmarksChangedProc)(void* clientData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachBookmarksChangedCallback(PDDoc doc, PDBookmarksChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachBookmarksChangedCallback(PDDoc doc, PDBookmarksChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyBookmarksChanged(PDDoc doc);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkCreateRoot(PDDoc doc, PDBookmark* pRoot);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetRoot(PDDoc doc, PDBookmark* pRoot);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetParent(PDBookmark bookmark, PDBookmark* pParent);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetPrev(PDBookmark bookmark, PDBookmark* pPrev);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetNext(PDBookmark bookmark, PDBookmark* pNext);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetFirstChild(PDBookmark bookmark, PDBookmark* pFirstChild);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetLastChild(PDBookmark bookmark, PDBookmark* pLastChild);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetVisibleChildrenCount(PDBookmark bookmark, int32_t* pCount);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkExpand(PDBookmark bookmark);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkCollapse(PDBookmark bookmark);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkIsExpanded(PDBookmark bookmark, bool* pOpen);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkSetTitle(PDBookmark bookmark, const wchar_t* title, size_t titleSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetTitle(PDBookmark bookmark, wchar_t* buffer, size_t bufferSize, size_t* pTitleSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkSetTextColor(PDBookmark bookmark, PDColorValue color);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetTextColor(PDBookmark bookmark, PDColorValue* pColor);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkSetTextStyle(PDBookmark bookmark, PDBookmarkFlags flags);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetTextStyle(PDBookmark bookmark, PDBookmarkFlags* pFlags);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkRemove(PDBookmark bookmark);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkInsertNext(PDBookmark bookmark, PDBookmark next);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkInsertChild(PDBookmark bookmark, PDBookmark child);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkCreateNext(PDBookmark bookmark, const wchar_t* title, size_t titleSize, PDBookmark*);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkCreateChild(PDBookmark bookmark, const wchar_t* title, size_t titleSize, PDBookmark*);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkSetActions(PDBookmark bookmark, PDAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetActions(PDBookmark bookmark, PDAction*);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkSetDest(PDBookmark bookmark, PDDest);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkGetDest(PDBookmark bookmark, PDDest*);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDBookmarkEqual(PDBookmark bookmarkA, PDBookmark bookmarkB, bool* pEqual);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_BOOKMARKS_H_INCLUDED_