Collapse all Symbian^3 Application Developer Library

MMPXCollectionUtility Class Reference

class MMPXCollectionUtility

Main client interface for collections. Some terms used in the documentation of this interface:

Context - represents the 'state' of the collection, i.e. the current browse path (encapsulated in CMPXCollectionPath ) and filter applied (encapsulated in CMPXFilter)

Playlist - an abstract list of songs. A collection path allows the client to cross reference the playlist with a collection, for example to iterate through the playlist, extract user-supplied metadata etc.

mpxcollectionutility.lib

Public Member Functions
void	Close ()
MMPXCollection &	Collection ()
TUid	CollectionIDL (const TArray < TUid > &)
IMPORT_C MMPXCollectionUtility *	NewL (MMPXCollectionObserver *, const TUid &)

Member Functions Documentation

Close()

void

(

)

[pure virtual]

Frees up client side resources only. A collection is freed when there are no clients using it, and all resources are freed when the last client closes.

Since: S60 3.2.3

Collection()

MMPXCollection &

Collection

(

)

[pure virtual]

The collection.

Since: S60 3.2.3

CollectionIDL(const TArray< TUid > &)

TUid

CollectionIDL

(

const TArray < TUid > &

aUids

)

[pure virtual]

Retrieves the ID of the collection plugin which matched aUids best. If multiple plugins match the aUids, the only one with high priority will be returned.

Since: S60 3.2.3

Parameters

const TArray < TUid > & aUids

selection criteria

NewL(MMPXCollectionObserver *, const TUid &)

IMPORT_C MMPXCollectionUtility *	NewL	(	MMPXCollectionObserver *	aObs = NULL,
			const TUid &	aModeId = KMcModeDefault
		)	[static]

Creates the interface for the client. This interface is bound to (i.e. controls and receives events from) either an existing context or a new one, according to:

aModeId=KMcModeDefault - bound to the same context as any other client running in the same thread, or KMcModeIsolated context created if the first client in the thread aModeId=KMcModeIsolated - new context created specifically for client, may be shared later aModeId=<UID> - bound to the same context as other clients which have supplied the same UID. Most common case is application UID so that clients in external processes can easily bind to a specific application context

Since: S60 3.2.3

Parameters

MMPXCollectionObserver * aObs = NULL	collection observer
const TUid & aModeId = KMcModeDefault	collection mode id