Collapse all Symbian^3 Application Developer Library

CVCommandHandler Class Reference

class CVCommandHandler : public CBase

Provider of the voice command services

Inherits from

CVCommandHandler
- CBase

Public Member Functions
	~CVCommandHandler ()
IMPORT_C void	AddCommandL (const CVCommand &)
IMPORT_C void	AddCommandsL (const RVCommandArray &, TBool )
void	CancelPlaybackL (const CStoredVCommand &)
IMPORT_C CVCommandArray *	ListCommandsL ()
IMPORT_C CVCommandHandler *	NewL ( MVCommandHandlerObserver *)
void	PlayAlternativeSpokenTextL (const CStoredVCommand &, MNssPlayEventHandler &)
void	PlaySpokenTextL (const CStoredVCommand &, MNssPlayEventHandler &)
IMPORT_C void	RemoveCommandL (const CVCommand &)
IMPORT_C void	RemoveCommandsL (const RVCommandArray &, TBool )

Private Member Functions
void	ConstructL ( MVCommandHandlerObserver *)

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
MVCService *	iImpl

Constructor & Destructor Documentation

~CVCommandHandler()

IMPORT_C

~CVCommandHandler

(

)

[virtual]

Member Functions Documentation

AddCommandL(const CVCommand &)

IMPORT_C void

AddCommandL

(

const CVCommand &

aCommand

)

[virtual]

Synchronous. Service doesn't take the ownership, but makes an own copy Duplicates can be added Todoshould we check for duplicates and leave with KErrAlreadyExists?

Parameters

const CVCommand & aCommand

AddCommandsL(const RVCommandArray &, TBool)

IMPORT_C void	AddCommandsL	(	const RVCommandArray &	aCommands,
			TBool	aIgnoreErrors = EFalse
		)	[virtual]

Synchronous. Service doesn't take the ownership, but makes an own copies Duplicates can be added Todoshould we check for duplicates and leave with KErrAlreadyExists? Synchronous. Service doesn't take the ownership, but makes an own copies Duplicates can be added Todoshould we check for duplicates and leave with KErrAlreadyExists?

Parameters

const RVCommandArray & aCommands	Commands to add
TBool aIgnoreErrors = EFalse	If ETrue, even if some commands fail to be trained, handler adds all that are trainable

CancelPlaybackL(const CStoredVCommand &)

void

CancelPlaybackL

(

const CStoredVCommand &

aCommand

)

const [virtual]

Not intented to be called directly. CVCommand::CancelPlaybackL

Parameters

const CStoredVCommand & aCommand

ConstructL(MVCommandHandlerObserver *)

void

ConstructL

(

MVCommandHandlerObserver *

aObserver

)

[private]

Parameters

MVCommandHandlerObserver * aObserver

ListCommandsL()

IMPORT_C CVCommandArray *

ListCommandsL

(

)

[virtual]

Synchronous

NewL(MVCommandHandlerObserver *)

IMPORT_C CVCommandHandler *

NewL

(

MVCommandHandlerObserver *

aObserver = NULL

)

[static]

Factory function

Parameters

MVCommandHandlerObserver * aObserver = NULL

Listener to be notified whenever the VCommand set is changed by *another* instance of CVCommandHandler. I.e. lets the client know if his understanding of the VCommand set is up to date

PlayAlternativeSpokenTextL(const CStoredVCommand &, MNssPlayEventHandler &)

void	PlayAlternativeSpokenTextL	(	const CStoredVCommand &	aCommand,
			MNssPlayEventHandler &	aPlayEventHandler
		)	const [virtual]

Not intented to be called directly. CVCommand::PlayAlternativeSpokenTextL

Parameters

const CStoredVCommand & aCommand
MNssPlayEventHandler & aPlayEventHandler

PlaySpokenTextL(const CStoredVCommand &, MNssPlayEventHandler &)

void	PlaySpokenTextL	(	const CStoredVCommand &	aCommand,
			MNssPlayEventHandler &	aPlayEventHandler
		)	const [virtual]

Not intented to be called directly. CVCommand::PlaySpokenTextL

Parameters

const CStoredVCommand & aCommand
MNssPlayEventHandler & aPlayEventHandler

RemoveCommandL(const CVCommand &)

IMPORT_C void

RemoveCommandL

(

const CVCommand &

aCommand

)

[virtual]

Synchronous. Removes the command from the system

leave: KErrNotFound No such command

Parameters

const CVCommand & aCommand

Reference to the command to be removed. Existing commands are compared against aCommand. All the matches are removed from VAS

RemoveCommandsL(const RVCommandArray &, TBool)

IMPORT_C void	RemoveCommandsL	(	const RVCommandArray &	aCommands,
			TBool	aIgnoreErrors = EFalse
		)	[virtual]

Synchronous.

Parameters

const RVCommandArray & aCommands	Reference to the list of commands to be removed. Existing commands are compared against aCommands items. All the matches are removed from VAS
TBool aIgnoreErrors = EFalse	If ETrue, even if some commands fail to be removed, handler will remove as many as possible

Member Data Documentation

MVCService * iImpl

MVCService *

iImpl

[private]