PoDoFo::PdfAction Class Reference

#include <PdfAction.h>

Inheritance diagram for PoDoFo::PdfAction:

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
Public Member Functions inherited from PoDoFo::PdfElement
PdfObject *	GetObject ()
const PdfObject *	GetObject () const

Additional Inherited Members
Protected Member Functions inherited from PoDoFo::PdfElement
	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

Detailed Description

An action that can be performed in a PDF document

Constructor & Destructor Documentation

PdfAction() [1/3]

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

Create a new PdfAction object

Parameters

eAction	type of this action
pParent	parent of this action

PdfAction() [2/3]

PoDoFo::PdfAction::PdfAction	(	EPdfAction	eAction,
		PdfDocument *	pParent
	)

Create a new PdfAction object

Parameters

eAction	type of this action
pParent	parent of this action

PdfAction() [3/3]

PoDoFo::PdfAction::PdfAction

(

PdfObject *

pObject

)

Create a PdfAction object from an existing PdfObject

Member Function Documentation

AddToDictionary()

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

dictionary

the action will be added to this dictionary

GetType()

EPdfAction PoDoFo::PdfAction::GetType ( ) const

inline

Get the type of this action

Returns

the type of this action

GetURI()

PdfString PoDoFo::PdfAction::GetURI

(

)

const

Get the URI of an ePdfAction_URI

Returns

an URI

HasURI()

bool PoDoFo::PdfAction::HasURI

(

)

const

Returns

true if this action has an URI

SetURI()

void PoDoFo::PdfAction::SetURI

(

const PdfString &

sUri

)

Set the URI of an ePdfAction_URI

Parameters

sUri	must be a correct URI as PdfString