PoDoFo 0.9.20
PoDoFo::PdfOutlines Class Reference

#include <PdfOutlines.h>

Inheritance diagram for PoDoFo::PdfOutlines:
PoDoFo::PdfOutlineItem

Public Member Functions

 PdfOutlines (PdfDocument &doc)
 PdfOutlines (PdfObject &obj)
PdfOutlineItemCreateRoot (const PdfString &title)
Public Member Functions inherited from PoDoFo::PdfOutlineItem
PdfOutlineItemCreateChild (const PdfString &title, const std::shared_ptr< PdfDestination > &dest)
PdfOutlineItemCreateNext (const PdfString &title, const std::shared_ptr< PdfDestination > &dest)
PdfOutlineItemCreateNext (const PdfString &title, const std::shared_ptr< PdfAction > &action)
void InsertChild (PdfOutlineItem *item)
PdfOutlineItemPrev () const
PdfOutlineItemNext () const
PdfOutlineItemFirst () const
PdfOutlineItemLast () const
PdfOutlineItemGetParentOutline () const
void Erase ()
void SetDestination (const std::shared_ptr< PdfDestination > &dest)
std::shared_ptr< PdfDestinationGetDestination () const
void SetAction (const std::shared_ptr< PdfAction > &action)
std::shared_ptr< PdfActionGetAction () const
void SetTitle (const PdfString &title)
const PdfStringGetTitle () const
void SetTextFormat (PdfOutlineFormat format)
PdfOutlineFormat GetTextFormat () const
void SetTextColor (double r, double g, double b)
double GetTextColorRed () const
double GetTextColorBlue () const
double GetTextColorGreen () const

Additional Inherited Members

Protected Member Functions inherited from PoDoFo::PdfOutlineItem
 PdfOutlineItem (PdfDocument &doc)
 PdfOutlineItem (PdfDocument &doc, const PdfString &title, const std::shared_ptr< PdfDestination > &dest, PdfOutlineItem *parentOutline)
 PdfOutlineItem (PdfDocument &doc, const PdfString &title, const std::shared_ptr< PdfAction > &action, PdfOutlineItem *parentOutline)
 PdfOutlineItem (PdfObject &obj, PdfOutlineItem *parentOutline, PdfOutlineItem *previous)

Detailed Description

The main PDF outlines dictionary.

Do not create it by yourself but use PdfDocument::GetOutlines() instead.

See also
PdfDocument

Constructor & Destructor Documentation

◆ PdfOutlines() [1/2]

PdfOutlines::PdfOutlines ( PdfDocument & doc)

Create a new PDF outlines dictionary

Parameters
parentparent vector of objects

◆ PdfOutlines() [2/2]

PdfOutlines::PdfOutlines ( PdfObject & obj)

Create a PDF outlines object from an existing dictionary

Parameters
objan existing outlines dictionary

Member Function Documentation

◆ CreateRoot()

PdfOutlineItem * PdfOutlines::CreateRoot ( const PdfString & title)

Create the root node of the outline item tree.

Parameters
titlethe title of the root node