PoDoFo::PdfOutlineItem Class Reference

A PDF outline item has an title and a destination. More...

#include <PdfOutlines.h>

Inheritance diagram for PoDoFo::PdfOutlineItem:

Public Member Functions
PdfOutlineItem &	CreateChild (const PdfString &title)
	Create a PdfOutlineItem that is on the same level and follows the current item. More...
PdfOutlineItem &	CreateNext (const PdfString &title)
	Create a PdfOutlineItem that is on the same level and follows the current item. More...
PdfOutlineItem *	Prev () const
PdfOutlineItem *	Next () const
PdfOutlineItem *	First () const
PdfOutlineItem *	Last () const
PdfOutlineItem *	GetParentOutline () const
void	Erase ()
	Deletes this outline item and all its children from the outline hierarchy and removes all objects from the list of PdfObjects All pointers to this item will be invalid after this function call.
void	SetDestination (nullable< const PdfDestination & > dest)
	Set the destination of this outline. More...
nullable< const PdfDestination & >	GetDestination () const
	Get the destination of this outline. More...
nullable< PdfDestination & >	GetDestination ()
void	SetAction (nullable< const PdfAction & > action)
	Set the action of this outline. More...
nullable< const PdfAction & >	GetAction () const
	Get the action of this outline. More...
nullable< PdfAction & >	GetAction ()
void	SetTitle (const PdfString &title)
	Set the title of this outline item. More...
const PdfString &	GetTitle () const
	Get the title of this item. More...
void	SetTextFormat (PdfOutlineFormat format)
	Set the text format of the title. More...
PdfOutlineFormat	GetTextFormat () const
	Get the text format of the title. More...
void	SetTextColor (const PdfColor &color)
	Set the color of the title of this item. More...
PdfColor	GetTextColor () const
	Get the color of the title of this item. More...

Friends
class	PdfOutlines
class	PdfDocument

Detailed Description

A PDF outline item has an title and a destination.

It is an element in the documents outline which shows its hierarchical structure.

See also

PdfDocument

PdfOutlines

PdfDestination

Member Function Documentation

CreateChild()

PdfOutlineItem & PdfOutlineItem::CreateChild

(

const PdfString &

title

)

Create a PdfOutlineItem that is on the same level and follows the current item.

Parameters

title

title of this item

CreateNext()

PdfOutlineItem & PdfOutlineItem::CreateNext

(

const PdfString &

title

)

Create a PdfOutlineItem that is on the same level and follows the current item.

Parameters

title

title of this item

First()

PdfOutlineItem* PoDoFo::PdfOutlineItem::First ( ) const

inline

Returns

the first outline item that is a child of this item

GetAction()

nullable< const PdfAction & > PdfOutlineItem::GetAction

(

)

const

Get the action of this outline.

Returns

the action, if there is one, or nullptr

GetDestination()

nullable< const PdfDestination & > PdfOutlineItem::GetDestination

(

)

const

Get the destination of this outline.

Returns

the destination, if there is one, or nullptr

GetParentOutline()

PdfOutlineItem* PoDoFo::PdfOutlineItem::GetParentOutline ( ) const

inline

Returns

the parent item of this item or nullptr if it is the top level outlines dictionary

GetTextColor()

PdfColor PdfOutlineItem::GetTextColor

(

)

const

Get the color of the title of this item.

Supported since PDF 1.4.

See also

SetTextColor

GetTextFormat()

PdfOutlineFormat PdfOutlineItem::GetTextFormat

(

)

const

Get the text format of the title.

Returns

the text format of the title

GetTitle()

const PdfString & PdfOutlineItem::GetTitle

(

)

const

Get the title of this item.

Returns

the title as PdfString

Last()

PdfOutlineItem* PoDoFo::PdfOutlineItem::Last ( ) const

inline

Returns

the last outline item that is a child of this item

Next()

PdfOutlineItem* PoDoFo::PdfOutlineItem::Next ( ) const

inline

Returns

the next item or nullptr if this is the last on the current level

Prev()

PdfOutlineItem* PoDoFo::PdfOutlineItem::Prev ( ) const

inline

Returns

the previous item or nullptr if this is the first on the current level

SetAction()

void PdfOutlineItem::SetAction

(

nullable< const PdfAction & >

action

)

Set the action of this outline.

Parameters

action

the action

SetDestination()

void PdfOutlineItem::SetDestination

(

nullable< const PdfDestination & >

dest

)

Set the destination of this outline.

Parameters

dest	the destination

SetTextColor()

void PdfOutlineItem::SetTextColor

(

const PdfColor &

color

)

Set the color of the title of this item.

This property is supported since PDF 1.4.

Parameters

color

the RGB color that should be set

SetTextFormat()

void PdfOutlineItem::SetTextFormat

(

PdfOutlineFormat

format

)

Set the text format of the title.

Supported since PDF 1.4.

Parameters

format

the formatting options for the title

SetTitle()

void PdfOutlineItem::SetTitle

(

const PdfString &

title

)

Set the title of this outline item.

Parameters

title

the title to use

---

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

• src/podofo/main/PdfOutlines.h
• src/podofo/main/PdfOutlines.cpp