PdfBookmark Struct Reference

PdfBookmark class. More...

Public Member Functions
virtual int	GetTitle (wchar_t *buffer, int len)=0
	Gets a bookmark's title. More...
virtual void	GetAppearance (PdfBookmarkAppearance *appearance)=0
	Gets a bookmark's appearance. More...
virtual PdfAction *	GetAction ()=0
	Gets a bookmark's action object. More...
virtual int	GetNumChildren ()=0
	Gets the number of child bookmark in a parent bookmark object. More...
virtual PdfBookmark *	GetChild (int index)=0
	Gets the requested child bookmark from a parent bookmark. More...
virtual PdfBookmark *	GetParent ()=0
	Gets a bookmark's parent bookmark. More...

Detailed Description

PdfBookmark class.

A bookmark corresponds to an outline object in a PDF document. A document outline allows the user to navigate interactively from one part of the document to another. An outline consists of a tree-structured hierarchy of bookmarks, which display the document's structure to the user. Each bookmark has: A title that appears on screen. An action that specifies what happens when the user clicks on the bookmark.

Member Function Documentation

GetAction()

virtual PdfAction* PdfBookmark::GetAction ( )

pure virtual

Gets a bookmark's action object.

Returns

The bookmark's action object or nullptr if bookmark does not have an action.

GetAppearance()

virtual void PdfBookmark::GetAppearance ( PdfBookmarkAppearance *  appearance )

pure virtual

Gets a bookmark's appearance.

Parameters

appearance

(filled by method) Pointer to a PdfBookmarkAppearance structure.

GetChild()

virtual PdfBookmark* PdfBookmark::GetChild ( int  index )

pure virtual

Gets the requested child bookmark from a parent bookmark.

Parameters

index

The index of bookmark to obtain.

Returns

Requested bookmark.

See also

PdfBookmark::GetNumChildren

GetNumChildren()

virtual int PdfBookmark::GetNumChildren ( )

pure virtual

Gets the number of child bookmark in a parent bookmark object.

Returns

The number of children.

See also

PdfBookmark::GetChild

GetParent()

virtual PdfBookmark* PdfBookmark::GetParent ( )

pure virtual

Gets a bookmark's parent bookmark.

Returns

Parent bookmark, or null if is the root bookmark of a document. NOTE: If parent is null, call only PdfBookmark::GetNumChildren and PdfBookmark::GetChild methods. Other methods return false.

GetTitle()

virtual int PdfBookmark::GetTitle ( wchar_t *  buffer, int  len  )

pure virtual

Gets a bookmark's title.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns

Number of characters written into buffer of required length.