Collapse all Symbian^3 Product Developer Library

CVCCommandUi Class Reference

class CVCCommandUi : public CBase

Container for VC app specific "human-visible" parts of the voice command: tooltip, displayable text, folder, icon, etc

Inherits from

CVCCommandUi
- CBase

Public Member Functions
	~CVCCommandUi()
IMPORT_C TBool	ConfirmationNeeded()
IMPORT_C TBool	EqualNonUserChangeableData(const CVCCommandUi &)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C const CVCFolderInfo &	FolderInfo()
IMPORT_C CGulIcon *	IconLC()
IMPORT_C const TUid &	IconUid()
IMPORT_C TBool	Modifiable()
IMPORT_C CVCCommandUi *	NewL(const TDesC &, const CVCFolderInfo &, TBool, const TDesC &, const TUid &, const TDesC &, TBool)
IMPORT_C CVCCommandUi *	NewL(RReadStream &)
IMPORT_C CVCCommandUi *	NewL(const CVCCommandUi &)
IMPORT_C const TDesC &	Tooltip()
IMPORT_C const TDesC &	UserText()
IMPORT_C const TDesC &	WrittenText()
IMPORT_C TBool	operator==(const CVCCommandUi &)

Private Member Functions
void	ConstructL(const TDesC &, const CVCFolderInfo &, TBool, const TDesC &, const TUid &, const TDesC &, TBool)
void	ConstructL(RReadStream &)

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
TBool	iConfirmationNeeded
CVCFolderInfo *	iFolderInfo
TUid	iIconUid
HBufC *	iTooltip
TBool	iUserCanModify
HBufC *	iUserText
HBufC *	iWrittenText

Constructor & Destructor Documentation

~CVCCommandUi()

IMPORT_C

~CVCCommandUi

(

)

Destructor

Member Functions Documentation

ConfirmationNeeded()

IMPORT_C TBool

ConfirmationNeeded

(

)

const

TodoAdd "see" reference to the recognition-side function that uses the "confirmation needed information"

ConstructL(const TDesC &, const CVCFolderInfo &, TBool, const TDesC &, const TUid &, const TDesC &, TBool)

void	ConstructL	(	const TDesC &	aWrittenText,
			const CVCFolderInfo &	aFolderInfo,
			TBool	aModifiable,
			const TDesC &	aTooltip,
			const TUid &	aIconUid,
			const TDesC &	aUserText,
			TBool	aConfirmationNeeded
		)	[private]

Second-phase constructor NewL for guard conditionsSecond-phase constructor NewL for guarding conditions

Parameters

const TDesC & aWrittenText
const CVCFolderInfo & aFolderInfo
TBool aModifiable
const TDesC & aTooltip
const TUid & aIconUid
const TDesC & aUserText
TBool aConfirmationNeeded

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[private]

Parameters

RReadStream & aStream

EqualNonUserChangeableData(const CVCCommandUi &)

IMPORT_C TBool

EqualNonUserChangeableData

(

const CVCCommandUi &

aCommandUi

)

const

Tells if all non user-changeable parts of aCommandUi are equal to this object's

Parameters

const CVCCommandUi & aCommandUi

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Saves the command to stream. Descriptor components are saved as <length><descriptor> pairs, where <length> is TInt32 and <descriptor> is the default descriptor represetation TBools are saved as TInt32 either

Parameters

RWriteStream & aStream

FolderInfo()

IMPORT_C const CVCFolderInfo &

FolderInfo

(

)

const

IconLC()

IMPORT_C CGulIcon *

IconLC

(

)

const

Creates the command icon. Takes into account the skin-specifics Works only if CEikonEnv is available

IconUid()

IMPORT_C const TUid &

IconUid

(

)

const

TodoAVKON-global? What kind of global?

Modifiable()

IMPORT_C TBool

Modifiable

(

)

const

NewL(const TDesC &, const CVCFolderInfo &, TBool, const TDesC &, const TUid &, const TDesC &, TBool)

IMPORT_C CVCCommandUi *	NewL	(	const TDesC &	aWrittenText,
			const CVCFolderInfo &	aFolderInfo,
			TBool	aModifiable,
			const TDesC &	aTooltip,
			const TUid &	aIconUid,
			const TDesC &	aUserText = KNullDesC ,
			TBool	aConfirmationNeeded = ETrue
		)	[static]

This object does not take an ownership of the passed descriptors, but makes own copies.

TodoAdd "see" reference to the recognition-side function that uses the "confirmation needed information" aModifiable param is "hanging in the air" and never actually used Clarify its existence and responsibilities This object does not take an ownership of the passed descriptors, but makes own copies.

leave: KErrOverflow if descriptors are too big

Parameters

const TDesC & aWrittenText	Text to display
const CVCFolderInfo & aFolderInfo	Folder-related details
TBool aModifiable	If user can modify the command
const TDesC & aTooltip	Second line of the text if ant
const TUid & aIconUid
const TDesC & aUserText = KNullDesC	Optional user-specified shortcut for the command
TBool aConfirmationNeeded = ETrue	If EFalse, when the command is recognized, it is immediately executed If ETrue, when the command is recognized, it is played back and user is asked to confirm the recognition results

NewL(RReadStream &)

IMPORT_C CVCCommandUi *

NewL

(

RReadStream &

aStream

)

[static]

Factory function that constructs a CVCCommandUi from the stream

leave: KErrNotSupported if the stream data format is unsupported e.g. if it has been written by newer implementation

Internalizes the command from stream values are read in the same order as ExternalizeL wrote them

Parameters

RReadStream & aStream

NewL(const CVCCommandUi &)

IMPORT_C CVCCommandUi *

NewL

(

const CVCCommandUi &

aOriginal

)

[static]

Copy the existing CVCCommandUi

Parameters

const CVCCommandUi & aOriginal

Tooltip()

IMPORT_C const TDesC &

Tooltip

(

)

const

UserText()

IMPORT_C const TDesC &

UserText

(

)

const

WrittenText()

IMPORT_C const TDesC &

WrittenText

(

)

const

operator==(const CVCCommandUi &)

IMPORT_C TBool

operator==

(

const CVCCommandUi &

aCommandUi

)

const

Parameters

const CVCCommandUi & aCommandUi

Member Data Documentation

TBool iConfirmationNeeded

TBool

iConfirmationNeeded

[private]

CVCFolderInfo * iFolderInfo

CVCFolderInfo *

iFolderInfo

[private]

TUid iIconUid

TUid

iIconUid

[private]

TodoAVKON-global? What kind of global?

HBufC * iTooltip

HBufC *

iTooltip

[private]

TBool iUserCanModify

TBool

iUserCanModify

[private]

HBufC * iUserText

HBufC *

iUserText

[private]

HBufC * iWrittenText

HBufC *

iWrittenText

[private]