PDF SDK Documentation

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

Loading...
Searching...
No Matches
bookmark.h
Go to the documentation of this file.
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
10
11#include <string>
12
14
15#include "forward_declarations.h"
16#include "wrapper_base.h"
17
18namespace PDF {
19
33class Bookmark : public detail::RefCountedHandle<PDBookmark> {
34public:
40
48 Bookmark GetParent() const;
49
56 Bookmark GetPrev() const;
57
64 Bookmark GetNext() const;
65
72 Bookmark GetFirstChild() const;
73
80 Bookmark GetLastChild() const;
81
85 void Remove();
86
91 void InsertNext(Bookmark next);
92
98 void InsertChild(Bookmark child);
99
106 Bookmark CreateNext(const std::wstring& title);
107
115 Bookmark CreateNext(const std::wstring& title, const Dest& dest);
116
124 Bookmark CreateNext(const std::wstring& title, const Action& actions);
125
131 Bookmark CreateChild(const std::wstring& title);
132
139 Bookmark CreateChild(const std::wstring& title, const Dest& dest);
140
147 Bookmark CreateChild(const std::wstring& title, const Action& actions);
148
156
160 void Expand();
161
165 void Collapse();
166
171 bool IsExpanded() const;
172
177 void SetTitle(const std::wstring& title);
178
183 std::wstring GetTitle() const;
184
190 void SetTextColor(PDColorValue color);
191
196 PDColorValue GetTextColor() const;
197
203 void SetTextStyle(PDBookmarkFlags flags);
204
210 PDBookmarkFlags GetTextStyle() const;
211
217 void SetActions(Action actions);
218
224
229 void SetDest(Dest dest);
230
235 Dest GetDest() const;
236
237 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Bookmark, PDBookmark)
238};
239
240} // namespace PDF
241
242#include "bookmark_impl.inl"
243
244#endif // PDFSDK_CXX_PDF_BOOKMARK_H_INCLUDED_
Bookmarks API.
Represents an action in a PDF document.
Definition action.h:32
void SetDest(Dest dest)
PDBookmarkFlags GetTextStyle() const
Bookmark CreateChild(const std::wstring &title)
Bookmark GetLastChild() const
Bookmark GetParent() const
Action GetActions() const
Bookmark CreateNext(const std::wstring &title, const Action &actions)
void SetActions(Action actions)
Bookmark CreateChild(const std::wstring &title, const Action &actions)
Bookmark CreateNext(const std::wstring &title, const Dest &dest)
void InsertChild(Bookmark child)
Bookmark GetPrev() const
Bookmark CreateNext(const std::wstring &title)
void InsertNext(Bookmark next)
std::wstring GetTitle() const
Bookmark GetFirstChild() const
void SetTextStyle(PDBookmarkFlags flags)
Bookmark GetNext() const
void SetTextColor(PDColorValue color)
int GetVisibleChildrenCount() const
bool IsExpanded() const
void SetTitle(const std::wstring &title)
Dest GetDest() const
Bookmark CreateChild(const std::wstring &title, const Dest &dest)
PDColorValue GetTextColor() const
Object GetPdfObject() const
Get the PDF object associated with this bookmark.
Represents a destination in a PDF document.
Definition dest.h:31
Represents a PDF object.
Definition object.h:25