PoDoFo::PdfOutlineItem Class Reference
#include <PdfOutlines.h>
List of all members.
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 |
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 |
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
Create a PdfOutlineItem that is a child of this item
- Parameters:
-
| sTitle | title of this item |
| rDest | destination of this item |
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.
- Returns:
- the first outline item that is a child of this item
Get the destination of this outline.
- 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
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
Inserts an existing PdfOutlineItem as a child of this outline item.
- Parameters:
-
| pItem | an 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::SetDestination |
( |
const PdfDestination & |
rDest |
) |
|
Set the destination of this outline.
- Parameters:
-
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 |
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:
-