PoDoFo 0.9.1
Public Member Functions

PoDoFo::PdfAction Class Reference

#include <PdfAction.h>

Inheritance diagram for PoDoFo::PdfAction:
PoDoFo::PdfElement

List of all members.

Public Member Functions

 PdfAction (EPdfAction eAction, PdfVecObjects *pParent)
 PdfAction (EPdfAction eAction, PdfDocument *pParent)
 PdfAction (PdfObject *pObject)
void SetURI (const PdfString &sUri)
PdfString GetURI () const
bool HasURI () const
EPdfAction GetType () const
void AddToDictionary (PdfDictionary &dictionary) const

Detailed Description

An action that can be performed in a PDF document


Constructor & Destructor Documentation

PoDoFo::PdfAction::PdfAction ( EPdfAction  eAction,
PdfVecObjects pParent 
)

Create a new PdfAction object

Parameters:
eActiontype of this action
pParentparent of this action
PoDoFo::PdfAction::PdfAction ( EPdfAction  eAction,
PdfDocument pParent 
)

Create a new PdfAction object

Parameters:
eActiontype of this action
pParentparent of this action
PoDoFo::PdfAction::PdfAction ( PdfObject pObject)

Create a PdfAction object from an existing PdfObject


Member Function Documentation

void PoDoFo::PdfAction::AddToDictionary ( PdfDictionary &  dictionary) const

Adds this action to an dictionary. This method handles the all the complexities of making sure it's added correctly

If this action is empty. Nothing will be added.

Parameters:
dictionarythe action will be added to this dictionary
EPdfAction PoDoFo::PdfAction::GetType ( ) const [inline]

Get the type of this action

Returns:
the type of this action
PdfString PoDoFo::PdfAction::GetURI ( ) const

Get the URI of an ePdfAction_URI

Returns:
an URI
bool PoDoFo::PdfAction::HasURI ( ) const
Returns:
true if this action has an URI
void PoDoFo::PdfAction::SetURI ( const PdfString sUri)

Set the URI of an ePdfAction_URI

Parameters:
sUrimust be a correct URI as PdfString