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
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:
43
51
59
67
75
79 void Remove();
80
85 void InsertNext(Bookmark next);
86
92 void InsertChild(Bookmark child);
93
100 Bookmark CreateNext(const std::wstring& title);
101
109 Bookmark CreateNext(const std::wstring& title, const Dest& dest);
110
118 Bookmark CreateNext(const std::wstring& title, const Action& actions);
119
125 Bookmark CreateChild(const std::wstring& title);
126
133 Bookmark CreateChild(const std::wstring& title, const Dest& dest);
134
141 Bookmark CreateChild(const std::wstring& title, const Action& actions);
142
150
154 void Expand();
155
159 void Collapse();
160
165 bool IsExpanded() const;
166
171 void SetTitle(const std::wstring& title);
172
177 std::wstring GetTitle() const;
178
184 void SetTextColor(PDColorValue color);
185
190 PDColorValue GetTextColor() const;
191
197 void SetTextStyle(PDBookmarkFlags flags);
198
204 PDBookmarkFlags GetTextStyle() const;
205
211 void SetActions(Action actions);
212
218
223 void SetDest(Dest dest);
224
229 Dest GetDest() const;
230
231 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Bookmark, PDBookmark)
232};
233
234} // namespace PDF
235
236#include "bookmark_impl.inl"
237
238#endif // PDFSDK_CXX_PDF_BOOKMARK_H_INCLUDED_
Bookmarks API.
Represents an action in a PDF document.
Definition action.h:32
Represents a bookmark/outline item in a PDF document.
Definition bookmark.h:33
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
Represents a destination in a PDF document.
Definition dest.h:31