Symbian^3 Application Developer Library >

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

Public Member Functions
~CEvtEvent ()
IMPORT_C CEvtAction & Action ()
IMPORT_C TPtrC Description ()
IMPORT_C TEvtEventId EventId ()
IMPORT_C TEvtEventStatus EventStatus ()
IMPORT_C TBool HasAction ()
IMPORT_C TPosition & Location ()
IMPORT_C CEvtEvent * NewL ()
IMPORT_C CEvtEvent * NewLC ()
IMPORT_C TPtrC Place ()
IMPORT_C TReal Radius ()
IMPORT_C TBool Repeat ()
IMPORT_C void SetActionL ( CEvtAction *)
IMPORT_C void SetDescriptionL (const TDesC &)
IMPORT_C void SetEventId (const TEvtEventId )
IMPORT_C void SetEventStatus (const TEvtEventStatus )
void SetLocationL ( TPosition &)
IMPORT_C void SetPlaceL (const TDesC &)
IMPORT_C void SetRadius (const TReal )
IMPORT_C void SetRepeat (const TBool )
IMPORT_C void SetSubjectL (const TDesC &)
IMPORT_C TPtrC Subject ()
Private Member Functions
CEvtEvent ()
CEvtEvent ( CEvtEvent &)
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
CEvtAction * iAction
HBufC * iDescription
TEvtEventId iEventId
TEvtEventStatus iEventStatus
TPosition * iLocation
HBufC * iPlace
TReal iRadius
TBool iRepeat
HBufC * iSubject

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

void ConstructL ( ) [private]

Second phase of the two phase constructor.

Description()

IMPORT_C TPtrC Description ( ) 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 TEvtEventId EventId ( ) const

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

Since
S60 v9.1

EventStatus()

IMPORT_C TEvtEventStatus EventStatus ( ) 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 TBool HasAction ( )

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 TPtrC Place ( ) 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 TReal Radius ( ) 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 TBool Repeat ( ) 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 void SetActionL ( 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 * aAction Action for the Location Event. The ownership of Action is transferred to Event.

SetDescriptionL(const TDesC &)

IMPORT_C void SetDescriptionL ( 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 & aDescription Description String for the Location Event. The Description string is copied.

SetEventId(const TEvtEventId)

IMPORT_C void SetEventId ( const TEvtEventId aId )

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

Since
S60 v9.1

Parameters

const TEvtEventId aId Event identifier identifying the Location Event.

SetEventStatus(const TEvtEventStatus)

IMPORT_C void SetEventStatus ( const TEvtEventStatus aEventStatus )

Set the Status for the Location Event.

Since
S60 v9.1

Parameters

const TEvtEventStatus aEventStatus Status for the Location Event.

SetLocationL(TPosition &)

void SetLocationL ( 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 & aLocation Location for the Location Event.

SetPlaceL(const TDesC &)

IMPORT_C void SetPlaceL ( 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 & aPlace Place String for the Location Event. The Place string is copied.

SetRadius(const TReal)

IMPORT_C void SetRadius ( const TReal aRadius )

Set the Radius for the Location Event.

Since
S60 v9.1

Parameters

const TReal aRadius Radius for the Location Event.

SetRepeat(const TBool)

IMPORT_C void SetRepeat ( const TBool aRepeat )

Set the Repeat flag for the Location Event.

Since
S60 v9.1

Parameters

const TBool aRepeat

SetSubjectL(const TDesC &)

IMPORT_C void SetSubjectL ( 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 & aSubject Subject String for the Location Event. The Subject string is copied.

Subject()

IMPORT_C TPtrC Subject ( ) 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

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.