PoDoFo
0.9.6
|
#include <PdfOutlines.h>
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) | |
![]() | |
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 |
PdfObject * | CreateObject (const char *pszType=NULL) |
PdfObject * | GetNonConstObject () const |
A PDF outline item has an title and a destination. It is an element in the documents outline which shows its hierarchical structure.
|
protected |
Create a new PdfOutlineItem dictionary
pParent | parent vector of objects |
|
protected |
Create a new PdfOutlineItem from scratch
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 |
|
protected |
Create a new PdfOutlineItem from scratch
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 |
|
protected |
Create a PdfOutlineItem from an existing PdfObject
pObject | an existing outline item |
pParentOutline | parent of this outline item in the outline item hierarchie |
pPrevious | previous item of this item |
PdfOutlineItem * PoDoFo::PdfOutlineItem::CreateChild | ( | const PdfString & | sTitle, |
const PdfDestination & | rDest | ||
) |
Create a PdfOutlineItem that is a child of this item
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.
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.
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.
|
inline |
PdfAction * PoDoFo::PdfOutlineItem::GetAction | ( | void | ) |
Get the action of this outline.
PdfDestination * PoDoFo::PdfOutlineItem::GetDestination | ( | PdfDocument * | pDoc | ) |
Get the destination of this outline.
pDoc | a PdfDocument owning this annotation. This is required to resolve names and pages. |
|
inline |
double PoDoFo::PdfOutlineItem::GetTextColorBlue | ( | ) | const |
Get the color of the title of this item. Supported since PDF 1.4.
double PoDoFo::PdfOutlineItem::GetTextColorGreen | ( | ) | const |
Get the color of the title of this item. Supported since PDF 1.4.
double PoDoFo::PdfOutlineItem::GetTextColorRed | ( | ) | const |
Get the color of the title of this item. Supported since PDF 1.4.
EPdfOutlineFormat PoDoFo::PdfOutlineItem::GetTextFormat | ( | ) | const |
Get the text format of the title
const PdfString & PoDoFo::PdfOutlineItem::GetTitle | ( | ) | const |
Get the title of this item
void PoDoFo::PdfOutlineItem::InsertChild | ( | PdfOutlineItem * | pItem | ) |
Inserts a new PdfOutlineItem as a child of this outline item. The former can't be in the same tree as this one, as the tree property would be broken. If this prerequisite is violated, a PdfError exception (code ePdfError_OutlineItemAlreadyPresent) is thrown and nothing is changed. The item inserted is not copied, i.e. Erase() calls affect the original! Therefore also shared ownership is in effect, i.e. deletion by where it comes from damages the data structure it's inserted into.
pItem | an existing outline item |
|
inline |
|
inline |
|
inline |
void PoDoFo::PdfOutlineItem::SetAction | ( | const PdfAction & | rAction | ) |
Set the action of this outline.
rAction | the action |
void PoDoFo::PdfOutlineItem::SetDestination | ( | const PdfDestination & | rDest | ) |
Set the destination of this outline.
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.
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.
eFormat | the formatting options for the title |
void PoDoFo::PdfOutlineItem::SetTitle | ( | const PdfString & | sTitle | ) |
Set the title of this outline item
sTitle | the title to use |