PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
bookmark.h
1// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
2
3#ifndef PDFSDK_CXX_PDF_BOOKMARK_H_INCLUDED_
4#define PDFSDK_CXX_PDF_BOOKMARK_H_INCLUDED_
5
6#include <string>
7
9
10#include "forward_declarations.h"
11#include "wrapper_base.h"
12
13namespace PDF {
14
20class Bookmark : public detail::RefCountedHandle<PDBookmark> {
21public:
27
33
39
45
51
55 void Remove();
56
61 void InsertNext(Bookmark next);
62
67 void InsertChild(Bookmark child);
68
74 Bookmark CreateNext(const std::wstring& title);
75
82 Bookmark CreateNext(const std::wstring& title, const Dest& dest);
83
90 Bookmark CreateNext(const std::wstring& title, const Action& actions);
91
97 Bookmark CreateChild(const std::wstring& title);
98
105 Bookmark CreateChild(const std::wstring& title, const Dest& dest);
106
113 Bookmark CreateChild(const std::wstring& title, const Action& actions);
114
120
124 void Expand();
125
129 void Collapse();
130
136
141 void SetTitle(const std::wstring& title);
142
147 std::wstring GetTitle();
148
153 void SetTextColor(PDColorValue color);
154
159 PDColorValue GetTextColor();
160
165 void SetTextStyle(PDBookmarkFlags flags);
166
171 PDBookmarkFlags GetTextStyle();
172
177 void SetActions(Action actions);
178
184
189 void SetDest(Dest dest);
190
196
197 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Bookmark, PDBookmark)
198};
199
200} // namespace PDF
201
202#include "bookmark_impl.inl"
203
204#endif // PDFSDK_CXX_PDF_BOOKMARK_H_INCLUDED_
Bookmarks API.
Represents an action in a PDF document.
Definition action.h:21
Represents a bookmark in a PDF document.
Definition bookmark.h:20
PDColorValue GetTextColor()
void SetDest(Dest dest)
Bookmark GetPrev()
Bookmark CreateChild(const std::wstring &title)
Bookmark CreateNext(const std::wstring &title, const Action &actions)
Bookmark GetNext()
Bookmark GetFirstChild()
void SetActions(Action actions)
Bookmark CreateChild(const std::wstring &title, const Action &actions)
Bookmark CreateNext(const std::wstring &title, const Dest &dest)
Action GetActions()
void InsertChild(Bookmark child)
int GetVisibleChildrenCount()
Bookmark CreateNext(const std::wstring &title)
void InsertNext(Bookmark next)
Bookmark GetParent()
PDBookmarkFlags GetTextStyle()
Bookmark GetLastChild()
void SetTextStyle(PDBookmarkFlags flags)
std::wstring GetTitle()
void SetTextColor(PDColorValue color)
bool IsExpanded()
void SetTitle(const std::wstring &title)
Bookmark CreateChild(const std::wstring &title, const Dest &dest)
Represents a destination in a PDF document.
Definition dest.h:23