Collapse all Symbian^3 Application Developer Library

CEvtInfoNoteInputParam Class Reference

class CEvtInfoNoteInputParam : public CBase

Input paramters for Events UI info note display

This class provides the Internalize and Externalize functionalities for the input parameters in Events UI info display. The parameters currently contain 1. The Name of the trigger 2. Detailed description of the trigger 3. Trigerring accuracy 4. Tone String 5. Tone Repeat Flag 6. Tone Enable Flag 7. Snooze Flag

Since: S60 v9.1

Inherits from

CEvtInfoNoteInputParam
- CBase

Public Member Functions
	~CEvtInfoNoteInputParam ()
IMPORT_C TPtrC	Description ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C CEvtInfoNoteInputParam *	NewL ()
IMPORT_C void	SetDescriptionL (const TDesC &)
IMPORT_C void	SetShowSnooze ( TBool )
IMPORT_C void	SetSubjectL (const TDesC &)
IMPORT_C void	SetToneEnabled ( TBool )
IMPORT_C void	SetToneL (const TDesC &)
IMPORT_C void	SetToneRepeat ( TBool )
IMPORT_C void	SetTrigerringAccuracy ( TEvtTriggerAccuracy )
IMPORT_C TBool	ShowSnooze ()
IMPORT_C TPtrC	Subject ()
IMPORT_C TPtrC	Tone ()
IMPORT_C TBool	ToneEnabled ()
IMPORT_C TBool	ToneRepeat ()
IMPORT_C TEvtTriggerAccuracy	TrigerringAccuracy ()

Protected Member Functions
	CEvtInfoNoteInputParam ()
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()

Public Member Enumerations
enum	TEvtTriggerAccuracy { EEvtAccurateTrigger = 0, EEvtInaccurateTrigger , EEvtHighlyInaccurateTrigger }

Private Attributes
TEvtTriggerAccuracy	iAccuracy
HBufC *	iDescription
TBool	iShowSnooze
HBufC *	iSubject
HBufC *	iTone
TBool	iToneEnabled
TBool	iToneRepeat

Constructor & Destructor Documentation

CEvtInfoNoteInputParam()

CEvtInfoNoteInputParam

(

)

[protected]

C++ constructor made protected for this class must not be instantiated directly

~CEvtInfoNoteInputParam()

~CEvtInfoNoteInputParam

(

)

[virtual]

Destructor.

Since: S60 v9.1

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[protected]

Second phase of the two phase constructor

Description()

IMPORT_C TPtrC

Description

(

)

const

Retrieves the Description field for the trigger.

Since: S60 v9.1

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aWriteStream

)

Externalizes the contents of this Array into a buffer.

Since: S60 v5.0

Parameters

RWriteStream & aWriteStream

Buffer onto which the contents of this structure would be externalized.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aReadStream

)

Internalized the contents of the buffer into this array.

Since: S60 v5.0

Parameters

RReadStream & aReadStream

Buffer from which the contents of this structures would be populated.

NewL()

IMPORT_C CEvtInfoNoteInputParam *

NewL

(

)

[static]

Static two phase constructor

Since: S60 v9.1

SetDescriptionL(const TDesC &)

IMPORT_C void

SetDescriptionL

(

const TDesC &

aDescription

)

Sets the Description field for the trigger.

Since: S60 v9.1

Parameters

const TDesC & aDescription

SetShowSnooze(TBool)

IMPORT_C void

SetShowSnooze

(

TBool

aSnooze

)

Show Snooze

Since: S60 v9.1

Parameters

TBool aSnooze

Boolean value to indicate whether snooze is shown

SetSubjectL(const TDesC &)

IMPORT_C void

SetSubjectL

(

const TDesC &

aSubject

)

Sets the subject/name field for the trigger.

Since: S60 v5.0

Parameters

const TDesC & aSubject

The subject/name of the trigger.

SetToneEnabled(TBool)

IMPORT_C void

SetToneEnabled

(

TBool

aRepeat

)

Tone Enabled

Since: S60 v9.1

Parameters

TBool aRepeat

Boolean value to indicate whether tone is enabled

SetToneL(const TDesC &)

IMPORT_C void

SetToneL

(

const TDesC &

aDescription

)

Sets the Tone field for the trigger.

Since: S60 v9.1

Parameters

const TDesC & aDescription

SetToneRepeat(TBool)

IMPORT_C void

SetToneRepeat

(

TBool

aRepeat

)

Tone Repeatition

Since: S60 v9.1

Parameters

TBool aRepeat

Boolean value to indicate whether tone is to be repeated

SetTrigerringAccuracy(TEvtTriggerAccuracy)

IMPORT_C void

SetTrigerringAccuracy

(

TEvtTriggerAccuracy

aAccuracy

)

Sets the Mode in which the Location Application would be launched.

Since: S60 v9.1

Parameters

TEvtTriggerAccuracy aAccuracy

Triggering Accuracy

ShowSnooze()

IMPORT_C TBool

ShowSnooze

(

)

const

Show Snooze

Since: S60 v9.1

Subject()

IMPORT_C TPtrC

Subject

(

)

const

Retrieves the subject/name field for the trigger.

Since: S60 v9.1

Tone()

IMPORT_C TPtrC

Tone

(

)

const

Retrieves the Tone field for the trigger.

Since: S60 v9.1

ToneEnabled()

IMPORT_C TBool

ToneEnabled

(

)

const

Tone Enabled

Since: S60 v9.1

ToneRepeat()

IMPORT_C TBool

ToneRepeat

(

)

const

Tone Repeatition

Since: S60 v9.1

TrigerringAccuracy()

IMPORT_C TEvtTriggerAccuracy

TrigerringAccuracy

(

)

const

The accuracy with which the trigger has been fired.

Since: S60 v9.1

Member Enumerations Documentation

Enum TEvtTriggerAccuracy

Enumeration to define the accuracy of the fired triggers

Since: S60 v9.1

Enumerators

EEvtAccurateTrigger = 0	Enum value for an accurate trigger
EEvtInaccurateTrigger	Enum value for an inaccurate trigger
EEvtHighlyInaccurateTrigger	Enum value for a heavily inaccurate trigger

Member Data Documentation

TEvtTriggerAccuracy iAccuracy

TEvtTriggerAccuracy

iAccuracy

[private]

Enum value for the Trigger accuracy

HBufC * iDescription

HBufC *

iDescription

[private]

Buffer which holds the Description field of the trigger Owns

TBool iShowSnooze

TBool

iShowSnooze

[private]

Boolean value to show Snooze.

HBufC * iSubject

HBufC *

iSubject

[private]

Buffer which holds the Subject/Name field of the trigger Owns

HBufC * iTone

HBufC *

iTone

[private]

Tone field for the trigger. If there is expectation that no tone must be played, then this can be left empty

TBool iToneEnabled

TBool

iToneEnabled

[private]

Boolean value to denote whether the tone is enabled.

TBool iToneRepeat

TBool

iToneRepeat

[private]

Boolean value to denote whether the tone is to be repeated.