PDF::Bookmark Class Reference

Represents a bookmark in a PDF document. More...

#include <pdfsdk/cxx/bookmark.h>

Inheritance diagram for PDF::Bookmark:

Public Member Functions
Bookmark	GetParent ()
Bookmark	GetPrev ()
Bookmark	GetNext ()
Bookmark	GetFirstChild ()
Bookmark	GetLastChild ()
void	Remove ()
void	InsertNext (Bookmark next)
void	InsertChild (Bookmark child)
Bookmark	CreateNext (const std::wstring &title)
Bookmark	CreateNext (const std::wstring &title, const Dest &dest)
Bookmark	CreateNext (const std::wstring &title, const Action &actions)
Bookmark	CreateChild (const std::wstring &title)
Bookmark	CreateChild (const std::wstring &title, const Dest &dest)
Bookmark	CreateChild (const std::wstring &title, const Action &actions)
int	GetVisibleChildrenCount ()
void	Expand ()
void	Collapse ()
bool	IsExpanded ()
void	SetTitle (const std::wstring &title)
std::wstring	GetTitle ()
void	SetTextColor (PDColorValue color)
PDColorValue	GetTextColor ()
void	SetTextStyle (PDBookmarkFlags flags)
PDBookmarkFlags	GetTextStyle ()
void	SetActions (Action actions)
Action	GetActions ()
void	SetDest (Dest dest)
Dest	GetDest ()
	Bookmark (PDBookmark handle, bool adopt=false) noexcept
	Bookmark (const Bookmark &rhs) noexcept
Bookmark &	operator= (const Bookmark &rhs) noexcept
	Bookmark (Bookmark &&rhs) noexcept
Bookmark &	operator= (Bookmark &&rhs) noexcept

Detailed Description

Represents a bookmark in a PDF document.

ISO 32000-2:2020 - 12.3.3 Document outline

Member Function Documentation

Collapse()

void PDF::Bookmark::Collapse

(

)

Collapse this bookmark.

CreateChild() [1/3]

Bookmark PDF::Bookmark::CreateChild

(

const std::wstring &

title

)

Create a new child bookmark of this bookmark with the specified title.

Parameters

title

The title of the new bookmark.

Returns

The newly created bookmark.

CreateChild() [2/3]

Bookmark PDF::Bookmark::CreateChild	(	const std::wstring &	title,
		const Action &	actions )

Create a new child bookmark of this bookmark with the specified title and actions.

Parameters

title	The title of the new bookmark.
actions	The actions of the new bookmark.

Returns

The newly created bookmark.

CreateChild() [3/3]

Bookmark PDF::Bookmark::CreateChild	(	const std::wstring &	title,
		const Dest &	dest )

Create a new child bookmark of this bookmark with the specified title and destination.

Parameters

title	The title of the new bookmark.
dest	The destination of the new bookmark.

Returns

The newly created bookmark.

CreateNext() [1/3]

Bookmark PDF::Bookmark::CreateNext

(

const std::wstring &

title

)

Create a new bookmark after this bookmark with the specified title.

Parameters

title

The title of the new bookmark.

Returns

The newly created bookmark.

CreateNext() [2/3]

Bookmark PDF::Bookmark::CreateNext	(	const std::wstring &	title,
		const Action &	actions )

Create a new bookmark after this bookmark with the specified title and actions.

Parameters

title	The title of the new bookmark.
actions	The actions of the new bookmark.

Returns

The newly created bookmark.

CreateNext() [3/3]

Bookmark PDF::Bookmark::CreateNext	(	const std::wstring &	title,
		const Dest &	dest )

Create a new bookmark after this bookmark with the specified title and destination.

Parameters

title	The title of the new bookmark.
dest	The destination of the new bookmark.

Returns

The newly created bookmark.

Expand()

void PDF::Bookmark::Expand

(

)

Expand this bookmark.

GetActions()

Action PDF::Bookmark::GetActions

(

)

Get the actions of this bookmark.

Returns

The actions.

GetDest()

Dest PDF::Bookmark::GetDest

(

)

Get the destination of this bookmark.

Returns

The destination.

GetFirstChild()

Bookmark PDF::Bookmark::GetFirstChild

(

)

Get the first child bookmark of this bookmark.

Returns

The first child bookmark.

GetLastChild()

Bookmark PDF::Bookmark::GetLastChild

(

)

Get the last child bookmark of this bookmark.

Returns

The last child bookmark.

GetNext()

Bookmark PDF::Bookmark::GetNext

(

)

Get the next bookmark at the same level as this bookmark.

Returns

The next bookmark.

GetParent()

Bookmark PDF::Bookmark::GetParent

(

)

Get the parent bookmark of this bookmark.

Returns

The parent bookmark.

GetPrev()

Bookmark PDF::Bookmark::GetPrev

(

)

Get the previous bookmark at the same level as this bookmark.

Returns

The previous bookmark.

GetTextColor()

PDColorValue PDF::Bookmark::GetTextColor

(

)

Get the text color of this bookmark.

Returns

The text color.

GetTextStyle()

PDBookmarkFlags PDF::Bookmark::GetTextStyle

(

)

Get the text style of this bookmark.

Returns

The text style flags.

GetTitle()

std::wstring PDF::Bookmark::GetTitle

(

)

Get the title of this bookmark.

Returns

The title.

GetVisibleChildrenCount()

int PDF::Bookmark::GetVisibleChildrenCount

(

)

Get the number of visible children of this bookmark.

Returns

The number of visible children.

InsertChild()

void PDF::Bookmark::InsertChild

(

Bookmark

child

)

Insert the specified bookmark as a child of this bookmark.

Parameters

child

The bookmark to insert.

InsertNext()

void PDF::Bookmark::InsertNext

(

Bookmark

next

)

Insert the specified bookmark after this bookmark.

Parameters

next	The bookmark to insert.

IsExpanded()

bool PDF::Bookmark::IsExpanded

(

)

Check if this bookmark is expanded.

Returns

True if the bookmark is expanded, false otherwise.

Remove()

void PDF::Bookmark::Remove

(

)

Remove this bookmark from its parent.

SetActions()

void PDF::Bookmark::SetActions

(

Action

actions

)

Set the actions of this bookmark.

Parameters

actions

The new actions.

SetDest()

void PDF::Bookmark::SetDest

(

Dest

dest

)

Set the destination of this bookmark.

Parameters

dest	The new destination.

SetTextColor()

void PDF::Bookmark::SetTextColor

(

PDColorValue

color

)

Set the text color of this bookmark.

Parameters

color

The new text color.

SetTextStyle()

void PDF::Bookmark::SetTextStyle

(

PDBookmarkFlags

flags

)

Set the text style of this bookmark.

Parameters

flags

The new text style flags.

SetTitle()

void PDF::Bookmark::SetTitle

(

const std::wstring &

title

)

Set the title of this bookmark.

Parameters

title

The new title.

---

The documentation for this class was generated from the following file:

• include/pdfsdk/cxx/bookmark.h