Collapse all Symbian^3 Product Developer Library

CEvtToneAction Class Reference

class CEvtToneAction : public CBase

Class that captures information for the Tone action Type. This class allows for Internalizing and Externalizing the Tone action. This class is used to store the information of Tone action.

evtstorage.lib

Since: S60 v9.1

Inherits from

CEvtToneAction
- CBase

Public Member Functions
	~CEvtToneAction()
IMPORT_C void	ExternalizeL(CEvtAction &)
IMPORT_C TPtrC	FileName()
IMPORT_C void	InternalizeL(CEvtAction &)
IMPORT_C CEvtToneAction *	NewL()
IMPORT_C CEvtToneAction *	NewLC()
IMPORT_C void	SetFileNameL(const TDesC &)
IMPORT_C void	SetToneLoop(const TBool)
IMPORT_C TBool	ToneLoop()

Private Member Functions
	CEvtToneAction()
void	ConstructL()
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
TInt	TotalSize()

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 *	iFileName
TBool	iToneLoop

Constructor & Destructor Documentation

CEvtToneAction()

CEvtToneAction

(

)

[private]

Default C++ Constructor.

~CEvtToneAction()

~CEvtToneAction

(

)

[virtual]

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

Second phase of the two phase constructor.

ExternalizeL(CEvtAction &)

IMPORT_C void

ExternalizeL

(

CEvtAction &

aAction

)

Externalizes the contents into a CEvtAction.

Since: S60 v5.0

Parameters

CEvtAction & aAction

CEvtAction onto which the contents of would be externalized.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aWriteStream

)

[private]

Externalizes the contents into a buffer.

Since: S60 v5.0

Parameters

RWriteStream & aWriteStream

Buffer onto which the contents of would be externalized.

FileName()

IMPORT_C TPtrC

FileName

(

)

const

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

Since: S60 v9.1

InternalizeL(CEvtAction &)

IMPORT_C void

InternalizeL

(

CEvtAction &

aAction

)

Internalized the contents of the CEvtAction.

Since: S60 v5.0

Parameters

CEvtAction & aAction

CEvtAction from which the contents would be populated.

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aReadStream

)

[private]

Internalized the contents of the buffer.

Since: S60 v5.0

Parameters

RReadStream & aReadStream

Buffer from which the contents would be populated.

NewL()

IMPORT_C CEvtToneAction *

NewL

(

)

[static]

Constructs a new instance of Event Tone.

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

NewLC()

IMPORT_C CEvtToneAction *

NewLC

(

)

[static]

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

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

SetFileNameL(const TDesC &)

IMPORT_C void

SetFileNameL

(

const TDesC &

aFileName

)

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

Since: S60 v9.1

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

Parameters

const TDesC & aFileName

SetToneLoop(const TBool)

IMPORT_C void

SetToneLoop

(

const TBool

aRepeat

)

Set the ToneLoop flag for playing tone for Location Event.

Since: S60 v9.1

Parameters

const TBool aRepeat

ToneLoop()

IMPORT_C TBool

ToneLoop

(

)

const

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

Since: S60 v9.1

TotalSize()

TInt

TotalSize

(

)

[private]

Returns the total size for the Internalize/Externalize buffer.

Since: S60 v5.0

Member Data Documentation

HBufC * iFileName

HBufC *

iFileName

[private]

Tone String for Event.

TBool iToneLoop

TBool

iToneLoop

[private]

Loop for tone.