PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfOutlines Class Reference

#include <PdfOutlines.h>

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

Public Member Functions

 PdfOutlines (PdfVecObjects *pParent)
 
 PdfOutlines (PdfObject *pObject)
 
PdfOutlineItemCreateRoot (const PdfString &sTitle)
 
- Public Member Functions inherited from PoDoFo::PdfOutlineItem
PdfOutlineItemCreateChild (const PdfString &sTitle, const PdfDestination &rDest)
 
PdfOutlineItemCreateNext (const PdfString &sTitle, const PdfDestination &rDest)
 
PdfOutlineItemCreateNext (const PdfString &sTitle, const PdfAction &rAction)
 
void InsertChild (PdfOutlineItem *pItem)
 
PdfOutlineItemPrev () const
 
PdfOutlineItemNext () const
 
PdfOutlineItemFirst () const
 
PdfOutlineItemLast () const
 
PdfOutlineItemGetParentOutline () const
 
void Erase ()
 
void SetDestination (const PdfDestination &rDest)
 
PdfDestinationGetDestination (PdfDocument *pDoc)
 
void SetAction (const PdfAction &rAction)
 
PdfActionGetAction (void)
 
void SetTitle (const PdfString &sTitle)
 
const PdfStringGetTitle () const
 
void SetTextFormat (EPdfOutlineFormat eFormat)
 
EPdfOutlineFormat GetTextFormat () const
 
void SetTextColor (double r, double g, double b)
 
double GetTextColorRed () const
 
double GetTextColorBlue () const
 
double GetTextColorGreen () const
 
- Public Member Functions inherited from PoDoFo::PdfElement
PdfObjectGetObject ()
 
const PdfObjectGetObject () const
 

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfOutlineItem
 PdfOutlineItem (PdfVecObjects *pParent)
 
 PdfOutlineItem (const PdfString &sTitle, const PdfDestination &rDest, PdfOutlineItem *pParentOutline, PdfVecObjects *pParent)
 
 PdfOutlineItem (const PdfString &sTitle, const PdfAction &rAction, PdfOutlineItem *pParentOutline, PdfVecObjects *pParent)
 
 PdfOutlineItem (PdfObject *pObject, PdfOutlineItem *pParentOutline, PdfOutlineItem *pPrevious)
 
- Protected Member Functions inherited from PoDoFo::PdfElement
 PdfElement (const char *pszType, PdfVecObjects *pParent)
 
 PdfElement (const char *pszType, PdfDocument *pParent)
 
 PdfElement (const char *pszType, PdfObject *pObject)
 
 PdfElement (EPdfDataType eExpectedDataType, PdfObject *pObject)
 
const char * TypeNameForIndex (int i, const char **ppTypes, long lLen) const
 
int TypeNameToIndex (const char *pszType, const char **ppTypes, long lLen, int nUnknownValue) const
 
PdfObjectCreateObject (const char *pszType=NULL)
 
PdfObjectGetNonConstObject () const
 

Detailed Description

The main PDF outlines dictionary.

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

See also
PdfDocument

Constructor & Destructor Documentation

PoDoFo::PdfOutlines::PdfOutlines ( PdfVecObjects pParent)

Create a new PDF outlines dictionary

Parameters
pParentparent vector of objects
PoDoFo::PdfOutlines::PdfOutlines ( PdfObject pObject)

Create a PDF outlines object from an existing dictionary

Parameters
pObjectan existing outlines dictionary

Member Function Documentation

PdfOutlineItem * PoDoFo::PdfOutlines::CreateRoot ( const PdfString sTitle)

Create the root node of the outline item tree.

Parameters
sTitlethe title of the root node