Collapse all Symbian^3 Product Developer Library

CFLDFileListContainer Class Reference

class CFLDFileListContainer : public CBase

FileListContainer owns the list box, the model, and the controller, and it is used to launch the popup list.

filelist.lib

Since: 2.1

Inherits from

CFLDFileListContainer
- CBase

Public Member Functions
	~CFLDFileListContainer()
IMPORT_C void	AddExclusiveMediaTypeL(const TInt32)
IMPORT_C void	AddExclusiveMimeTypeL(const TDesC &)
IMPORT_C void	InsertEndNullItemL(const TDesC &)
IMPORT_C void	InsertEndNullItemL(const TDesC &, const TDesC &)
IMPORT_C void	InsertNullItemL(const TDesC &)
IMPORT_C void	InsertNullItemL(const TDesC &, const TDesC &)
IMPORT_C TBool	LaunchL(TDes &, const TDesC &)
IMPORT_C CFLDFileListContainer *	NewL()
IMPORT_C CFLDFileListContainer *	NewL(const TInt)
IMPORT_C CFLDFileListContainer *	NewL(const TInt, const TInt)
IMPORT_C CFLDFileListContainer *	NewLC()
IMPORT_C CFLDFileListContainer *	NewLC(const TInt)
IMPORT_C CFLDFileListContainer *	NewLC(const TInt, const TInt)
IMPORT_C void	ResetExclusiveMediaTypes()
IMPORT_C void	ResetExclusiveMimeTypes()
IMPORT_C void	Set3dEffects(TBool)
IMPORT_C void	SetAutomatedType(CDRMHelper::TDRMHelperAutomatedType)
IMPORT_C void	SetDelay(TTimeIntervalMicroSeconds32)
IMPORT_C void	SetMaxFileSize(const TInt)
IMPORT_C void	SetRingingType(TInt)
IMPORT_C void	SetVibra(TBool)
IMPORT_C void	SetVolume(TInt)
IMPORT_C void	SetWantedMediaTypesL(const TArray< TCLFMediaType > &)
IMPORT_C void	SetWantedMimeTypesL(const MDesCArray &)

Private Member Functions
	CFLDFileListContainer()
void	ConstructL(const TInt, const TInt)

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
CFLDController *	iController
CFLDDRMImplementation *	iDRMImplementation
CFLDFileListModel *	iModel
RConeResourceLoader	iResourceLoader

Constructor & Destructor Documentation

CFLDFileListContainer()

CFLDFileListContainer

(

)

[private]

Constructor

~CFLDFileListContainer()

IMPORT_C

~CFLDFileListContainer

(

)

[virtual]

Destructor

Member Functions Documentation

AddExclusiveMediaTypeL(const TInt32)

IMPORT_C void

AddExclusiveMediaTypeL

(

const TInt32

aMediaType

)

Adds a new media type into blocking list.

Parameters

const TInt32 aMediaType

The blocked media type (see TCLFMediaType enumeration inside CFLContentListing.hrh)

AddExclusiveMimeTypeL(const TDesC &)

IMPORT_C void

AddExclusiveMimeTypeL

(

const TDesC &

aMimeType

)

Adds a new MIME type into blocking list.

Parameters

const TDesC & aMimeType

The blocked MIME type

ConstructL(const TInt, const TInt)

void	ConstructL	(	const TInt	aResourceId,
			const TInt	aDirectoriesResourceId
		)	[private]

Second phase constructor

Parameters

const TInt aResourceId	A CLF model resource, see CLFContentListing.rh
const TInt aDirectoriesResourceId	A resource using FILELISTDIRECTORIES structure, see FileListModel.rh for details

InsertEndNullItemL(const TDesC &)

IMPORT_C void

InsertEndNullItemL

(

const TDesC &

aItemText

)

Adds a text (e.g. "None") as the last item of the list, which will not be sorted among the file name items.

Parameters

const TDesC & aItemText

A descriptor containing the null item text

InsertEndNullItemL(const TDesC &, const TDesC &)

IMPORT_C void	InsertEndNullItemL	(	const TDesC &	aItemText,
			const TDesC &	aFileName
		)

Adds a text (e.g. "None") as the last item of the list, which will not be sorted among the file name items.

Parameters

const TDesC & aItemText	A descriptor containing the null item text
const TDesC & aFileName	A descriptor containing the ringing tone file name for null item

InsertNullItemL(const TDesC &)

IMPORT_C void

InsertNullItemL

(

const TDesC &

aItemText

)

Adds a text (e.g. "None") as the first item of the list, which will not be sorted among the file name items.

Parameters

const TDesC & aItemText

A descriptor containing the null item text

InsertNullItemL(const TDesC &, const TDesC &)

IMPORT_C void	InsertNullItemL	(	const TDesC &	aItemText,
			const TDesC &	aFileName
		)

Adds a text (e.g. "None") as the first item of the list, which will not be sorted among the file name items.

Parameters

const TDesC & aItemText	A descriptor containing the null item text
const TDesC & aFileName	A descriptor containing the ringing tone file name for null item

LaunchL(TDes &, const TDesC &)

IMPORT_C TBool	LaunchL	(	TDes &	aFileName,
			const TDesC &	aPopupTitle = KNullDesC
		)

Launches a popup list for browsing files

Parameters

TDes & aFileName	The selected file name will be stored here. If the selected item was not a file but a null text item, aFileName will contain KNullDesC. If aFileName contains something already, CFLDFileListContainer tries to find the name on the list and focus on it. NOTE: Size of aFileName must be KMaxFileName, otherwise KErrNotFound is returned (aFileName is compared against TFileName entities).
const TDesC & aPopupTitle = KNullDesC	If this parameter is given, sets the title text of the popup

NewL()

IMPORT_C CFLDFileListContainer *

NewL

(

)

[static]

Two-phase static constructor

NewL(const TInt)

IMPORT_C CFLDFileListContainer *

NewL

(

const TInt

aResourceId

)

[static]

Two-phase static constructor

Parameters

const TInt aResourceId

A CLF model resource, see CLFContentListing.rh

NewL(const TInt, const TInt)

IMPORT_C CFLDFileListContainer *	NewL	(	const TInt	aResourceId,
			const TInt	aDirectoriesResourceId
		)	[static]

Two-phase static constructor

Parameters

const TInt aResourceId	A CLF model resource, see CLFContentListing.rh
const TInt aDirectoriesResourceId	A resource using FILELISTDIRECTORIES structure, see FileListModel.rh for details

NewLC()

IMPORT_C CFLDFileListContainer *

NewLC

(

)

[static]

Two-phase static constructor

NewLC(const TInt)

IMPORT_C CFLDFileListContainer *

NewLC

(

const TInt

aResourceId

)

[static]

Two-phase static constructor

Parameters

const TInt aResourceId

A CLF model resource, see CLFContentListing.rh

NewLC(const TInt, const TInt)

IMPORT_C CFLDFileListContainer *	NewLC	(	const TInt	aResourceId,
			const TInt	aDirectoriesResourceId
		)	[static]

Two-phase static constructor

Parameters

const TInt aResourceId	A CLF model resource, see CLFContentListing.rh
const TInt aDirectoriesResourceId	A resource using FILELISTDIRECTORIES structure, see FileListModel.rh for details

ResetExclusiveMediaTypes()

IMPORT_C void

ResetExclusiveMediaTypes

(

)

Removes all the defined exlusive media types

ResetExclusiveMimeTypes()

IMPORT_C void

ResetExclusiveMimeTypes

(

)

Removes all the defined exlusive MIME types

Set3dEffects(TBool)

IMPORT_C void

Set3dEffects

(

TBool

a3dEffects

)

Sets 3d-effects on or off. If this method is called using parameter EFalse 3d-effects are always disabled even though those are set in active profile. Otherwise toneplayer uses the setting in active profile.

Parameters

TBool a3dEffects

True: 3dEffects are on. False: 3dEffects are off.

SetAutomatedType(CDRMHelper::TDRMHelperAutomatedType)

IMPORT_C void

SetAutomatedType

(

CDRMHelper::TDRMHelperAutomatedType

aAutomatedType

)

Set the automated content type

Parameters

CDRMHelper::TDRMHelperAutomatedType aAutomatedType

SetDelay(TTimeIntervalMicroSeconds32)

IMPORT_C void

SetDelay

(

TTimeIntervalMicroSeconds32

aDelay

)

Set the delay until the timer expires.

Parameters

TTimeIntervalMicroSeconds32 aDelay

The delay in microseconds

SetMaxFileSize(const TInt)

IMPORT_C void

SetMaxFileSize

(

const TInt

aMaxFileSize

)

Sets the maximum file size for the list.

Since: 3.1

Parameters

const TInt aMaxFileSize

The maximum file size in bytes. If you want to allow all file sizes, set this to KFLDNoSizeFiltering (defined in FileListModel.hrh).

SetRingingType(TInt)

IMPORT_C void

SetRingingType

(

TInt

aRingingType

)

Sets the ringing type If this method is not called, toneplayer uses the setting in active profile.

Parameters

TInt aRingingType

The ringing type (see CFLDRingingTonePlayer::TRingingTypes)

SetVibra(TBool)

IMPORT_C void

SetVibra

(

TBool

aVibra

)

Sets vibrating alert on or off. If this method is not called, toneplayer uses the setting in active profile.

Parameters

TBool aVibra

True: Vibra is on. False: Vibra is off.

SetVolume(TInt)

IMPORT_C void

SetVolume

(

TInt

aVolume

)

Set the volume level on which the sound is played. If this method is not called, toneplayer uses the setting in active profile.

Parameters

TInt aVolume

The volume level

SetWantedMediaTypesL(const TArray< TCLFMediaType > &)

IMPORT_C void

SetWantedMediaTypesL

(

const TArray< TCLFMediaType > &

aMediaTypes

)

Sets wanted media types. Overrides all settings defined inside resource, defined with AddExclusive -methods or with SetWanted -methods.

Parameters

const TArray< TCLFMediaType > & aMediaTypes

The array containing wanted media types

SetWantedMimeTypesL(const MDesCArray &)

IMPORT_C void

SetWantedMimeTypesL

(

const MDesCArray &

aMimeTypes

)

Sets wanted mime types. Overrides all settings defined inside resource, defined with AddExclusive -methods or with SetWanted -methods.

Parameters

const MDesCArray & aMimeTypes

The array containing wanted MIME types

Member Data Documentation

CFLDController * iController

CFLDController *

iController

[private]

CFLDDRMImplementation * iDRMImplementation

CFLDDRMImplementation *

iDRMImplementation

[private]

CFLDFileListModel * iModel

CFLDFileListModel *

iModel

[private]

RConeResourceLoader iResourceLoader

RConeResourceLoader

iResourceLoader

[private]