PoDoFo  1.0.0-dev
Public Member Functions | Friends | List of all members
PoDoFo::PdfOutlines Class Referencefinal

The main PDF outlines dictionary. More...

#include <PdfOutlines.h>

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

Public Member Functions

PdfOutlineItemCreateRoot (const PdfString &title)
 Create the root node of the outline item tree. More...
 
- Public Member Functions inherited from PoDoFo::PdfOutlineItem
PdfOutlineItemCreateChild (const PdfString &title)
 Create a PdfOutlineItem that is on the same level and follows the current item. More...
 
PdfOutlineItemCreateNext (const PdfString &title)
 Create a PdfOutlineItem that is on the same level and follows the current item. More...
 
PdfOutlineItemPrev () const
 
PdfOutlineItemNext () const
 
PdfOutlineItemFirst () const
 
PdfOutlineItemLast () const
 
PdfOutlineItemGetParentOutline () 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 PdfStringGetTitle () 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 PdfDocument
 

Detailed Description

The main PDF outlines dictionary.

Normally accessible through PdfDocument::GetOutlines()

See also
PdfDocument

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

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