PoDoFo::PdfAction Class Reference

#include <PdfAction.h>

Public Member Functions
	PdfAction (PdfDocument &doc, PdfActionType action)
	PdfAction (PdfObject &obj)
void	SetURI (const PdfString &uri)
PdfString	GetURI () const
bool	HasURI () const
PdfActionType	GetType () const
void	AddToDictionary (PdfDictionary &dictionary) const

Detailed Description

An action that can be performed in a PDF document

Constructor & Destructor Documentation

PdfAction() [1/2]

PdfAction::PdfAction	(	PdfDocument &	doc,
		PdfActionType	action )

Create a new PdfAction object

Parameters

eAction	type of this action
parent	parent of this action

PdfAction() [2/2]

PdfAction::PdfAction

(

PdfObject &

obj

)

Create a PdfAction object from an existing PdfObject

Member Function Documentation

AddToDictionary()

void 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()

PdfActionType PoDoFo::PdfAction::GetType ( ) const

inline

Get the type of this action

Returns

the type of this action

GetURI()

PdfString PdfAction::GetURI

(

)

const

Get the URI of an PdfActionType::URI

Returns

an URI

HasURI()

bool PdfAction::HasURI

(

)

const

Returns

true if this action has an URI

SetURI()

void PdfAction::SetURI

(

const PdfString &

uri

)

Set the URI of an PdfActionType::URI

Parameters

sUri	must be a correct URI as PdfString