CEvtEvent Class Reference

class CEvtEvent : public CBase

Concrete class that encapsulates all the information related for Event.

This class is used to store the detailed information for an event.

evtstorage.lib
Since
S60 v9.1

Inherits from

Constructor & Destructor Documentation

CEvtEvent()

CEvtEvent()[private]

Default C++ Constructor.

CEvtEvent(CEvtEvent &)

CEvtEvent(CEvtEvent &)[private]

Default Copy Constructor.

Parameters

CEvtEvent &

~CEvtEvent()

~CEvtEvent()[virtual]

Destructor.

Member Functions Documentation

Action()

IMPORT_C CEvtAction &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 action is returned.

Since
S60 v9.1

ConstructL()

voidConstructL()[private]

Second phase of the two phase constructor.

Description()

IMPORT_C TPtrCDescription()const

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

Since
S60 v9.1

EventId()

IMPORT_C TEvtEventIdEventId()const

Gets the Trigger id, identifying the Location Event. This identifier is definded by Location Triggering Engine.

Since
S60 v9.1

EventStatus()

IMPORT_C TEvtEventStatusEventStatus()const

Gets the Status of the Location Event. The Status is defined by the Location EventsUi on Creation. Status is updated as and when the Event moves to different state.

Since
S60 v9.1

HasAction()

IMPORT_C TBoolHasAction()

Check if Action is assigned to the Event.

Since
S60 v9.1 Returns ETrue if action is present Or else EFalse.

Location()

IMPORT_C TPosition &Location()const

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

Since
S60 v9.1

NewL()

IMPORT_C CEvtEvent *NewL()[static]

Constructs a new instance of Event.

leave
System wide error code if the object creation fails.

NewLC()

IMPORT_C CEvtEvent *NewLC()[static]

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

leave
System wide error code if the object creation fails.

Place()

IMPORT_C TPtrCPlace()const

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

Since
S60 v9.1

Radius()

IMPORT_C TRealRadius()const

Gets the Radius for the Location Events. The Radius is defined by the Location EventsUi on Creation. Radius is defined based on the place.

Since
S60 v9.1

Repeat()

IMPORT_C TBoolRepeat()const

Gets the Repeast flag for the Location Event. The Repeast is defined by the Location EventsUi on Creation.

Since
S60 v9.1

SetActionL(CEvtAction *)

IMPORT_C voidSetActionL(CEvtAction *aAction)

Set the Action 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

CEvtAction * aActionAction for the Location Event. The ownership of Action is transferred to Event.

SetDescriptionL(const TDesC &)

IMPORT_C voidSetDescriptionL(const TDesC &aDescription)

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

Since
S60 v9.1
leave
KErrNoMemory If there is not enough memory to copy the string.

Parameters

const TDesC & aDescriptionDescription String for the Location Event. The Description string is copied.

SetEventId(const TEvtEventId)

IMPORT_C voidSetEventId(const TEvtEventIdaId)

Set the Trigger id, identifying the Location Event. The identifer is definded by Location Triggering Engine.

Since
S60 v9.1

Parameters

const TEvtEventId aIdEvent identifier identifying the Location Event.

SetEventStatus(const TEvtEventStatus)

IMPORT_C voidSetEventStatus(const TEvtEventStatusaEventStatus)

Set the Status for the Location Event.

Since
S60 v9.1

Parameters

const TEvtEventStatus aEventStatusStatus for the Location Event.

SetLocationL(TPosition &)

voidSetLocationL(TPosition &aLocation)

Set the Location for the Location Event.

Since
S60 v9.1
leave
KErrNoMemory If there is not enough memory to copy the string.

Parameters

TPosition & aLocationLocation for the Location Event.

SetPlaceL(const TDesC &)

IMPORT_C voidSetPlaceL(const TDesC &aPlace)

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

Since
S60 v9.1
leave
KErrNoMemory If there is not enough memory to copy the string.

Parameters

const TDesC & aPlacePlace String for the Location Event. The Place string is copied.

SetRadius(const TReal)

IMPORT_C voidSetRadius(const TRealaRadius)

Set the Radius for the Location Event.

Since
S60 v9.1

Parameters

const TReal aRadiusRadius for the Location Event.

SetRepeat(const TBool)

IMPORT_C voidSetRepeat(const TBoolaRepeat)

Set the Repeat flag for the Location Event.

Since
S60 v9.1

Parameters

const TBool aRepeat

SetSubjectL(const TDesC &)

IMPORT_C voidSetSubjectL(const TDesC &aSubject)

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

Since
S60 v9.1
leave
KErrNoMemory If there is not enough memory to copy the string.

Parameters

const TDesC & aSubjectSubject String for the Location Event. The Subject string is copied.

Subject()

IMPORT_C TPtrCSubject()const

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

Since
S60 v9.1

Member Data Documentation

CEvtAction * iAction

CEvtAction *iAction[private]

Tone String for Event.

HBufC * iDescription

HBufC *iDescription[private]

Event Description. Description for the Location Event. The String is defined by the Location Events Ui.

Owns

TEvtEventId iEventId

TEvtEventId iEventId[private]

System wide unique identifier identifying the Location Event. This identifier is defined by the Location Triggering Engine.

Owns

TEvtEventStatus iEventStatus

TEvtEventStatus iEventStatus[private]

Event Status.

TPosition * iLocation

TPosition *iLocation[private]

lat-long information

HBufC * iPlace

HBufC *iPlace[private]

Event Place. Place for the Location Event. The String is defined by the Location Events Ui.

Owns

TReal iRadius

TReal iRadius[private]

Radius for Accuracy.

TBool iRepeat

TBool iRepeat[private]

Repeat Event.

HBufC * iSubject

HBufC *iSubject[private]

Event Subject. Subject for the Location Event. The Subject is defined by the Location Events Ui.

Owns