PoDoFo  0.9.1
Public Member Functions | Protected Member Functions
PoDoFo::PdfOutlineItem Class Reference

#include <PdfOutlines.h>

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

List of all members.

Public Member Functions

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

Protected Member Functions

 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)

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

Constructor & Destructor Documentation

Create a new PdfOutlineItem dictionary

Parameters:
pParentparent vector of objects
PoDoFo::PdfOutlineItem::PdfOutlineItem ( const PdfString sTitle,
const PdfDestination rDest,
PdfOutlineItem pParentOutline,
PdfVecObjects pParent 
) [protected]

Create a new PdfOutlineItem from scratch

Parameters:
sTitletitle of this item
rDestdestination of this item
pParentOutlineparent of this outline item in the outline item hierarchie
pParentparent vector of objects which is required to create new objects
PoDoFo::PdfOutlineItem::PdfOutlineItem ( const PdfString sTitle,
const PdfAction rAction,
PdfOutlineItem pParentOutline,
PdfVecObjects pParent 
) [protected]

Create a new PdfOutlineItem from scratch

Parameters:
sTitletitle of this item
rActionaction of this item
pParentOutlineparent of this outline item in the outline item hierarchie
pParentparent vector of objects which is required to create new objects
PoDoFo::PdfOutlineItem::PdfOutlineItem ( PdfObject pObject,
PdfOutlineItem pParentOutline,
PdfOutlineItem pPrevious 
) [protected]

Create a PdfOutlineItem from an existing PdfObject

Parameters:
pObjectan existing outline item
pParentOutlineparent of this outline item in the outline item hierarchie
pPreviousprevious item of this item

Member Function Documentation

Create a PdfOutlineItem that is a child of this item

Parameters:
sTitletitle of this item
rDestdestination of this item

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

Parameters:
sTitletitle of this item
rDestdestination of this item
PdfOutlineItem * PoDoFo::PdfOutlineItem::CreateNext ( const PdfString sTitle,
const PdfAction rAction 
)

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

Parameters:
sTitletitle of this item
rActionaction of this item

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.

Returns:
the first outline item that is a child of this item

Get the action of this outline.

Returns:
the action, if there is one, or NULL

Get the destination of this outline.

Parameters:
pDoca PdfDocument owning this annotation. This is required to resolve names and pages.
Returns:
the destination, if there is one, or NULL
Returns:
the parent item of this item or NULL if it is the top level outlines dictionary

Get the color of the title of this item. Supported since PDF 1.4.

Returns:
the red color component
See also:
SetTextColor

Get the color of the title of this item. Supported since PDF 1.4.

Returns:
the red color component
See also:
SetTextColor

Get the color of the title of this item. Supported since PDF 1.4.

Returns:
the red color component
See also:
SetTextColor

Get the text format of the title

Returns:
the text format of the title

Get the title of this item

Returns:
the title as PdfString

Inserts an existing PdfOutlineItem as a child of this outline item.

Parameters:
pIteman existing outline item
Returns:
the last outline item that is a child of this item
Returns:
the next item or NULL if this is the last on the current level
Returns:
the previous item or NULL if this is the first on the current level
void PoDoFo::PdfOutlineItem::SetAction ( const PdfAction rAction)

Set the action of this outline.

Parameters:
rActionthe action

Set the destination of this outline.

Parameters:
rDestthe destination
void PoDoFo::PdfOutlineItem::SetTextColor ( double  r,
double  g,
double  b 
)

Set the color of the title of this item. This property is supported since PDF 1.4.

Parameters:
rred color component
ggreen color component
bblue color component

Set the text format of the title. Supported since PDF 1.4.

Parameters:
eFormatthe formatting options for the title
void PoDoFo::PdfOutlineItem::SetTitle ( const PdfString sTitle)

Set the title of this outline item

Parameters:
sTitlethe title to use