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

PoDoFo::PdfOutlineItem::PdfOutlineItem ( PdfVecObjects pParent  )  [protected]

Create a new PdfOutlineItem dictionary

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

Create a new PdfOutlineItem from scratch

Parameters:
sTitle title of this item
rDest destination of this item
pParentOutline parent of this outline item in the outline item hierarchie
pParent parent 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:
sTitle title of this item
rAction action of this item
pParentOutline parent of this outline item in the outline item hierarchie
pParent parent 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:
pObject an existing outline item
pParentOutline parent of this outline item in the outline item hierarchie
pPrevious previous item of this item

Member Function Documentation

PdfOutlineItem * PoDoFo::PdfOutlineItem::CreateChild ( const PdfString sTitle,
const PdfDestination rDest 
)

Create a PdfOutlineItem that is a child of this item

Parameters:
sTitle title of this item
rDest destination 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:
sTitle title of this item
rAction action of this item
PdfOutlineItem * PoDoFo::PdfOutlineItem::CreateNext ( const PdfString sTitle,
const PdfDestination rDest 
)

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

Parameters:
sTitle title of this item
rDest destination of this item
void PoDoFo::PdfOutlineItem::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.

PdfOutlineItem * PoDoFo::PdfOutlineItem::First (  )  const [inline]
Returns:
the first outline item that is a child of this item
PdfAction * PoDoFo::PdfOutlineItem::GetAction ( void   ) 

Get the action of this outline.

Returns:
the action, if there is one, or NULL
PdfDestination * PoDoFo::PdfOutlineItem::GetDestination ( PdfDocument pDoc  ) 

Get the destination of this outline.

Parameters:
pDoc a PdfDocument owning this annotation. This is required to resolve names and pages.
Returns:
the destination, if there is one, or NULL
PdfOutlineItem * PoDoFo::PdfOutlineItem::GetParentOutline (  )  const [inline]
Returns:
the parent item of this item or NULL if it is the top level outlines dictionary
double PoDoFo::PdfOutlineItem::GetTextColorBlue (  )  const

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

Returns:
the red color component
See also:
SetTextColor
double PoDoFo::PdfOutlineItem::GetTextColorGreen (  )  const

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

Returns:
the red color component
See also:
SetTextColor
double PoDoFo::PdfOutlineItem::GetTextColorRed (  )  const

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

Returns:
the red color component
See also:
SetTextColor
EPdfOutlineFormat PoDoFo::PdfOutlineItem::GetTextFormat (  )  const

Get the text format of the title

Returns:
the text format of the title
const PdfString & PoDoFo::PdfOutlineItem::GetTitle (  )  const

Get the title of this item

Returns:
the title as PdfString
void PoDoFo::PdfOutlineItem::InsertChild ( PdfOutlineItem pItem  ) 

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

Parameters:
pItem an existing outline item
PdfOutlineItem * PoDoFo::PdfOutlineItem::Last (  )  const [inline]
Returns:
the last outline item that is a child of this item
PdfOutlineItem * PoDoFo::PdfOutlineItem::Next (  )  const [inline]
Returns:
the next item or NULL if this is the last on the current level
PdfOutlineItem * PoDoFo::PdfOutlineItem::Prev (  )  const [inline]
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:
rAction the action
void PoDoFo::PdfOutlineItem::SetDestination ( const PdfDestination rDest  ) 

Set the destination of this outline.

Parameters:
rDest the 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:
r red color component
g green color component
b blue color component
void PoDoFo::PdfOutlineItem::SetTextFormat ( EPdfOutlineFormat  eFormat  ) 

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

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

Set the title of this outline item

Parameters:
sTitle the title to use

Generated on 2 Oct 2011 for PoDoFo by  doxygen 1.6.1