Collapse all Symbian^3 Application Developer Library

CVCFolderInfo Class Reference

class CVCFolderInfo : public CBase

Container for the voice command folder information. Note that every command can have its own folder information

Inherits from

CVCFolderInfo
- CBase

Public Member Functions
	~CVCFolderInfo ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C TUint32	HelpTopicId ()
IMPORT_C CGulIcon *	IconLC ()
IMPORT_C const TDesC &	ListedName ()
IMPORT_C CVCFolderInfo *	NewL (const TDesC &, const TDesC &, TUint32 , TUint , const TDesC &)
IMPORT_C CVCFolderInfo *	NewL ( RReadStream &)
IMPORT_C CVCFolderInfo *	NewL (const CVCFolderInfo &)
IMPORT_C const TDesC &	Title ()
IMPORT_C TBool	operator== (const CVCFolderInfo &)

Protected Member Functions
	CVCFolderInfo ( TUint32 , TUint )
	CVCFolderInfo ()
TDesC &	IconFile ()
TUint	IconIndex ()

Private Member Functions
void	ConstructL (const TDesC &, const TDesC &, const TDesC &)
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
TUint32	iHelpTopicId
HBufC *	iIconFile
TUint	iIconIndex
HBufC *	iListedName
HBufC *	iTitle

Constructor & Destructor Documentation

CVCFolderInfo(TUint32, TUint)

CVCFolderInfo	(	TUint32	aHelpTopicId,
		TUint	aIconIndex
	)	[protected]

Parameters

TUint32 aHelpTopicId
TUint aIconIndex

CVCFolderInfo()

CVCFolderInfo

(

)

[protected, inline]

~CVCFolderInfo()

IMPORT_C

~CVCFolderInfo

(

)

Member Functions Documentation

ConstructL(const TDesC &, const TDesC &, const TDesC &)

void	ConstructL	(	const TDesC &	aTitle,
			const TDesC &	aListedName,
			const TDesC &	aIconFile
		)	[private]

NewL Second-phase constructor

Parameters

const TDesC & aTitle
const TDesC & aListedName
const TDesC & aIconFile

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[private]

Parameters

RReadStream & aStream

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

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

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

HelpTopicId()

IMPORT_C TUint32

HelpTopicId

(

)

const

IconFile()

TDesC &

IconFile

(

)

const [protected]

Full file name of the file name, where the folder icon is obtained from Is always no longer, than KMaxFileName If KNullDesC is returned, the default icon file is used

IconIndex()

TUint

IconIndex

(

)

const [protected]

Zero based index of the folder icon in the icon file IconFile

IconLC()

IMPORT_C CGulIcon *

IconLC

(

)

const

Creates an icon to represent this folder. Works only if CEikonEnv is available

ListedName()

IMPORT_C const TDesC &

ListedName

(

)

const

Version of a title shown when the folder is is displayed in the list of VCommands in the VCommand app

NewL(const TDesC &, const TDesC &, TUint32, TUint, const TDesC &)

IMPORT_C CVCFolderInfo *	NewL	(	const TDesC &	aTitle,
			const TDesC &	aListedName,
			TUint32	aHelpTopicId,
			TUint	aIconIndex,
			const TDesC &	aIconFile = KNullDesC
		)	[static]

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

Parameters

const TDesC & aTitle	Folder title. It is shown at the top of the screen, when the folder is opened in the VCommand application
const TDesC & aListedName	Version of a title shown when the folder is is displayed in the list of VCommands in the VCommand app
TUint32 aHelpTopicId	Topic to open when help is requested for the given folder
TUint aIconIndex	Index of the folder icon in the folder icons mbm file each index correspods to two images - the actual icon and its mask
const TDesC & aIconFile = KNullDesC	Mbm file where the icons are obtained from. If KNullDesC, the default icon file is used

NewL(RReadStream &)

IMPORT_C CVCFolderInfo *

NewL

(

RReadStream &

aStream

)

[static]

Constructs the folder information from stream

leave: KErrNotSupported if the stream data format is unsupported

Parameters

RReadStream & aStream

NewL(const CVCFolderInfo &)

IMPORT_C CVCFolderInfo *

NewL

(

const CVCFolderInfo &

aOriginal

)

[static]

Cloning constructor

Copy the existing CVCFolderInfo

Parameters

const CVCFolderInfo & aOriginal

Title()

IMPORT_C const TDesC &

Title

(

)

const

Returns folder title. It is shown at the top of the screen, when the folder is opened in the VCommand application

operator==(const CVCFolderInfo &)

IMPORT_C TBool

operator==

(

const CVCFolderInfo &

aFolderInfo

)

const

Parameters

const CVCFolderInfo & aFolderInfo

Member Data Documentation

TUint32 iHelpTopicId

TUint32

iHelpTopicId

[private]

HBufC * iIconFile

HBufC *

iIconFile

[private]

TUint iIconIndex

TUint

iIconIndex

[private]

HBufC * iListedName

HBufC *

iListedName

[private]

HBufC * iTitle

HBufC *

iTitle

[private]