Collapse all Symbian^3 Application Developer Library

CEvtAction Class Reference

class CEvtAction : public CBase

Class that represents the action for an Event

This class encapsultes the Action information like action type and generic string for action. This class allows for Internalizing Externalizing the action.

evtstorage.lib

Since: S60 v9.1

Inherits from

CEvtAction
- CBase

Public Member Functions
	~CEvtAction ()
TPtrC	Action ()
TEvtEventId	EvtId ()
TInt64	Id ()
IMPORT_C CEvtAction *	NewL ()
IMPORT_C CEvtAction *	NewLC ()
void	SetActionL (const TDesC &)
void	SetEvtId (const TEvtEventId )
void	SetId (const TInt64 )
void	SetType (const TEvtActionType )
IMPORT_C TEvtActionType	Type ()

Private Member Functions
	CEvtAction ()
void	ConstructL ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
HBufC *	iActionString
TEvtEventId	iEvtId
TInt64	iId
TEvtActionType	iType

Constructor & Destructor Documentation

CEvtAction()

CEvtAction

(

)

[private]

Default C++ Constructor.

~CEvtAction()

~CEvtAction

(

)

[virtual]

Destructor.

Member Functions Documentation

Action()

TPtrC

Action

(

)

const

Gets the Action for the Location Events. The Action is defined by the Location EventsUi on Creation. A reference to the object's internal string is returned.

Since: S60 v9.1

ConstructL()

void

ConstructL

(

)

[private]

Second phase of the two phase constructor.

EvtId()

TEvtEventId

EvtId

(

)

const

Gets the Trigger id, identifying the Location Event to which Action is associated with. This identifier is definded by Storage Db on creation.

Since: S60 v9.1

Id()

TInt64

(

)

const

Gets the Action id, identifying the Location Event's Action. This identifier is definded by Storage Db on creation.

Since: S60 v9.1

NewL()

IMPORT_C CEvtAction *

NewL

(

)

[static]

Constructs a new instance of Event Action.

leave: System wide error code if the object creation fails.

NewLC()

IMPORT_C CEvtAction *

NewLC

(

)

[static]

Constructs a new instance of Event Action. Leaves the created instance on the cleanup stack.

leave: System wide error code if the object creation fails.

SetActionL(const TDesC &)

void

SetActionL

(

const TDesC &

aAction

)

Set the Action String for the Location Event. The Action is copied.

Since: S60 v9.1

leave: KErrNoMemory If there is not enough memory to copy the string.

Parameters

const TDesC & aAction

Action String for the Location Event. The Action string is copied.

SetEvtId(const TEvtEventId)

void

SetEvtId

(

const TEvtEventId

aId

)

Set the Trigger id, identifying the Location Event to which Action is associated with. This identifer is definded by Storage Db on creation.

Since: S60 v9.1

Parameters

const TEvtEventId aId

Action identifier identifying the Location Event's Action.

SetId(const TInt64)

void

SetId

(

const TInt64

aId

)

Set the Action id, identifying the Location Event's Action. This identifier is definded by Storage Db on creation.

Since: S60 v9.1

Parameters

const TInt64 aId

Action identifier identifying the Location Event's Action.

SetType(const TEvtActionType)

void

SetType

(

const TEvtActionType

aType

)

Set the Action type for the Location Event.

Since: S60 v9.1

Parameters

const TEvtActionType aType

Type()

IMPORT_C TEvtActionType

Type

(

)

const

Gets the Action type for the Location Event. The Type is defined when an event is created.

Since: S60 v9.1

Member Data Documentation

HBufC * iActionString

HBufC *

iActionString

[private]

Action String for an Event.

TEvtEventId iEvtId

TEvtEventId

iEvtId

[private]

Event Id to which the Action is associated with.

TInt64 iId

TInt64

iId

[private]

Action Id for an Event.

TEvtActionType iType

TEvtActionType

iType

[private]

Action Type for an Event.