| 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 &) |
| void | Close | ( | ) | [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.
| 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.
| 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
| MMPXCollectionObserver * aObs = NULL | collection observer |
| const TUid & aModeId = KMcModeDefault | collection mode id |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.