Collapse all Symbian^3 Product Developer Library

MMPXCollection Class Reference

class MMPXCollection

MPXCollection

mpxcollectionutility.lib

Public Member Functions
void	AddL(const CMPXMedia &)
void	AddSubscriptionL(const CMPXSubscription &)
void	BackL()
void	CancelRequest()
void	ClearSubscriptionsL()
TUid	CollectionIDL(TUid &)
void	CommandL(TMPXCollectionCommand, TInt)
void	CommandL(CMPXCommand &)
CMPXFilter *	FilterL()
void	FindAllL(const CMPXSearchCriteria &, const TArray< TMPXAttribute > &, MMPXCollectionFindObserver &)
CMPXMedia *	FindAllL(const CMPXSearchCriteria &, const TArray< TMPXAttribute > &)
void	GetSupportedCapabilitiesL(TCollectionCapability &)
void	GetSupportedTypesL(RPointerArray< CMPXCollectionType > &)
TBool	IsRemote(const CMPXCollectionPath &)
void	MediaL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, CMPXAttributeSpecs , CMPXFilter )
void	NotifyL(TMPXCollectionBroadCastMsg, TInt)
void	OpenL(TMPXOpenMode)
void	OpenL(TInt, TMPXOpenMode)
void	OpenL(const CMPXCollectionPath &, TMPXOpenMode)
void	OpenL(TInt, const TArray< TMPXAttribute > &, TMPXOpenMode)
void	OpenL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, TMPXOpenMode)
void	OpenL(const TArray< TUid > &, TMPXOpenMode)
void	OpenL(const TUid &, TMPXOpenMode)
CMPXCollectionPath *	PathL()
void	RemoveL(const CMPXCollectionPath &, MMPXCollectionRemoveObserver *)
void	RemoveL(const CMPXMedia &)
void	RemoveSubscriptionL(const CMPXSubscription &)
void	SetFilterL(CMPXFilter *)
void	SetL(const CMPXMedia &)
void	SetSyncL(const CMPXMedia &)
TUid	UidL()

Member Functions Documentation

AddL(const CMPXMedia &)

void

AddL

(

const CMPXMedia &

aNewMedia

)

[pure virtual]

Adds item(s) to the collection.

Since: S60 3.2.3

Parameters

const CMPXMedia & aNewMedia

new item(s) to add

AddSubscriptionL(const CMPXSubscription &)

void

AddSubscriptionL

(

const CMPXSubscription &

aSubscription

)

[pure virtual]

Adds a message subscription for this client.

Since: S60 3.2.3

Parameters

const CMPXSubscription & aSubscription

subscription to be added

BackL()

void

BackL

(

)

[pure virtual]

Navigates back to the container of the current items. Calls back MMPXCollectionObserver::HandleOpenL().

Since: S60 3.2.3

CancelRequest()

void

CancelRequest

(

)

[pure virtual]

Stops any async operations that are currently under way.

Since: S60 3.2.3

ClearSubscriptionsL()

void

ClearSubscriptionsL

(

)

[pure virtual]

Removes all message subscriptions for this client.

Since: S60 3.2.3

CollectionIDL(TUid &)

TUid

CollectionIDL

(

TUid &

aCollection

)

[pure virtual]

Retrieves the real collection UID based on a predefined UID use MMPXCollectionUtility::CollectionIDL

Parameters

TUid & aCollection

CommandL(TMPXCollectionCommand, TInt)

void	CommandL	(	TMPXCollectionCommand	aCmd,
			TInt	aData = 0
		)	[pure virtual]

Send a command to the collection server

use CommandL(CMPXCommand& aCmd)

Parameters

TMPXCollectionCommand aCmd
TInt aData = 0

CommandL(CMPXCommand &)

void

CommandL

(

CMPXCommand &

aCmd

)

[pure virtual]

Send a command to the collection server.

Since: S60 3.2.3

Parameters

CMPXCommand & aCmd

command to handle

FilterL()

CMPXFilter *

FilterL

(

)

[pure virtual]

Current filter that is applied to collection browsing. i.e. results returned through MMPXCollectionObserver::HandleOpenL() callback from OpenL().

Since: S60 3.2.3

FindAllL(const CMPXSearchCriteria &, const TArray< TMPXAttribute > &, MMPXCollectionFindObserver &)

void	FindAllL	(	const CMPXSearchCriteria &	aCriteria,
			const TArray< TMPXAttribute > &	aAttrs,
			MMPXCollectionFindObserver &	aObs
		)	[pure virtual]

Find a list of media properties based on a search criteria. The types of supported "queries" are collection dependent. Callback via MMPXCollectionFindObserver::HandleFindL();

Since: S60 3.2.3

Parameters

const CMPXSearchCriteria & aCriteria	criteria to search on
const TArray< TMPXAttribute > & aAttrs	attributes to return
MMPXCollectionFindObserver & aObs	observer for find callback

FindAllL(const CMPXSearchCriteria &, const TArray< TMPXAttribute > &)

CMPXMedia *	FindAllL	(	const CMPXSearchCriteria &	aCriteria,
			const TArray< TMPXAttribute > &	aAttrs
		)	[pure virtual]

Find a list of media properties based on a search criteria. The types of supported "queries" are collection dependent. This is a SYNCHRONOUS METHOD, use only if necessary.

Since: S60 3.2.3

Parameters

const CMPXSearchCriteria & aCriteria	criteria to search on
const TArray< TMPXAttribute > & aAttrs	attributes to return

GetSupportedCapabilitiesL(TCollectionCapability &)

void

GetSupportedCapabilitiesL

(

TCollectionCapability &

aCapability

)

[pure virtual]

Fetches the capabilities supported by the current collection context.

Since: S60 3.2.3

Parameters

TCollectionCapability & aCapability

bitmask of the capabilities supported.

GetSupportedTypesL(RPointerArray< CMPXCollectionType > &)

void

GetSupportedTypesL

(

RPointerArray< CMPXCollectionType > &

aArray

)

[pure virtual]

Retrieves the list of supported types.

Since: S60 3.2.3

Parameters

RPointerArray< CMPXCollectionType > & aArray

On return, array will be filled with collection type items

IsRemote(const CMPXCollectionPath &)

TBool

IsRemote

(

const CMPXCollectionPath &

aPath

)

[pure virtual]

Is this path on a 'remote' collection.

Since: S60 3.2.3 aPath the collection path

Parameters

const CMPXCollectionPath & aPath

MediaL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, CMPXAttributeSpecs , CMPXFilter )

void	MediaL	(	const CMPXCollectionPath &	aPath,
			const TArray< TMPXAttribute > &	aAttrs,
			CMPXAttributeSpecs *	aSpecs = NULL,
			CMPXFilter *	aFilter = NULL
		)	[pure virtual]

Retrieve media for the item specified in the path. Note: if selection is set in aPath, HandleMedia will return an array of media of current selected items. if no selection is set in aPath, HandleMedia will return media properities of current item. Calls back MMPXCollectionObserver::HandleMediaL()

Since: S60 3.2.3

Parameters

const CMPXCollectionPath & aPath	the path of the collection
const TArray< TMPXAttribute > & aAttrs	attributes requested.
CMPXAttributeSpecs * aSpecs = NULL	specifications for attributes, Ownership not transferred
CMPXFilter * aFilter = NULL	filter to apply, Ownership not transferred

NotifyL(TMPXCollectionBroadCastMsg, TInt)

void	NotifyL	(	TMPXCollectionBroadCastMsg	aMsg,
			TInt	aData
		)	[pure virtual]

Broadcasts an event to all clients or plugins.

Since: S60 3.2.3

Parameters

TMPXCollectionBroadCastMsg aMsg	event to broadcast
TInt aData	data to accompany the event

OpenL(TMPXOpenMode)

void

OpenL

(

TMPXOpenMode

aMode = EMPXOpenDefault

)

[pure virtual]

Opens the collection in its current state.

Calls back MMPXCollectionObserver::HandleOpenL() with CMPXMedia object with ID KMPXMediaIdContainer, i.e.contains other media objects.

Since: S60 3.2.3

Parameters

TMPXOpenMode aMode = EMPXOpenDefault

open mode

OpenL(TInt, TMPXOpenMode)

void	OpenL	(	TInt	aIndex,
			TMPXOpenMode	aMode = EMPXOpenDefault
		)	[pure virtual]

Opens the collection at a specific index.

Calls back MMPXCollectionObserver::HandleOpenL() with CMPXMedia object with ID KMPXMediaIdContainer, i.e.contains other media objects.

Since: S60 3.2.3

Parameters

TInt aIndex	the index into the currently opened item list
TMPXOpenMode aMode = EMPXOpenDefault	type of open mode

OpenL(const CMPXCollectionPath &, TMPXOpenMode)

void	OpenL	(	const CMPXCollectionPath &	aPath,
			TMPXOpenMode	aMode = EMPXOpenDefault
		)	[pure virtual]

Opens the collection at a specific level.

Since: S60 3.2.3

Calls back MMPXCollectionObserver::HandleOpenL()

Parameters

const CMPXCollectionPath & aPath	the path of the collection
TMPXOpenMode aMode = EMPXOpenDefault	type of open mode required

OpenL(TInt, const TArray< TMPXAttribute > &, TMPXOpenMode)

void	OpenL	(	TInt	aIndex,
			const TArray< TMPXAttribute > &	aAttrs,
			TMPXOpenMode	aMode = EMPXOpenDefault
		)	[pure virtual]

Opens the collection at a specific index.

Calls back MMPXCollectionObserver::HandleOpenL() with CMPXMedia object with ID KMPXMediaIdContainer, i.e.contains other media objects which will contain the attribute values specified by aAttrs.

Since: S60 3.2.3

Parameters

TInt aIndex	the index into the currently opened item list
const TArray< TMPXAttribute > & aAttrs	attributes requested
TMPXOpenMode aMode = EMPXOpenDefault	type of open mode

OpenL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, TMPXOpenMode)

void	OpenL	(	const CMPXCollectionPath &	aPath,
			const TArray< TMPXAttribute > &	aAttrs,
			TMPXOpenMode	aMode = EMPXOpenDefault
		)	[pure virtual]

Opens the collection at a specific level.

Calls back MMPXCollectionObserver::HandleOpenL() with CMPXMedia object with ID KMPXMediaIdContainer, i.e.contains other media objects which will contain the attribute values specified by aAttrs.

Since: S60 3.2.3

Parameters

const CMPXCollectionPath & aPath	the path of the collection
const TArray< TMPXAttribute > & aAttrs	attributes requested
TMPXOpenMode aMode = EMPXOpenDefault	type of open mode required

OpenL(const TArray< TUid > &, TMPXOpenMode)

void	OpenL	(	const TArray< TUid > &	aUids,
			TMPXOpenMode	aMode = EMPXOpenDefault
		)	[pure virtual]

Opens the collection with a list of implementation uids to be matched. If current context matches the criteria, it will return existing browsing media; otherwise it will be back to root level and only plug-ins which match all provided uids will be returned, in priority order.

Calls back MMPXCollectionObserver::HandleOpenL() with CMPXMedia object with ID KMPXMediaIdContainer. Returned plugins will be sorted by plugin priority if mulitple plugins support aUids.

Since: S60 3.2.3

Parameters

const TArray< TUid > & aUids	array of UIDs used to select collection plugins based on supported uids in plugin resource file.
TMPXOpenMode aMode = EMPXOpenDefault	open mode

OpenL(const TUid &, TMPXOpenMode)

void	OpenL	(	const TUid &	aUid,
			TMPXOpenMode	aMode = EMPXOpenDefault
		)	[pure virtual]

Opens the collection with an uid to be matched. If current context matches the criteria, it will return existing browsing media; otherwise it will be back to root level and only plug-ins which match the uid will be returned, in priority order.

Calls back MMPXCollectionObserver::HandleOpenL() with CMPXMedia object with ID KMPXMediaIdContainer. Returned plugins will be sorted by plugin priority if mulitple plugins support the uid.

Since: S60 3.2.3

Parameters

const TUid & aUid	single UID used to select a collection
TMPXOpenMode aMode = EMPXOpenDefault	open mode

PathL()

CMPXCollectionPath *

PathL

(

)

[pure virtual]

The path of the collection in its current state. Ownsership transferred.

Since: S60 3.2.3

RemoveL(const CMPXCollectionPath &, MMPXCollectionRemoveObserver *)

void	RemoveL	(	const CMPXCollectionPath &	aPath,
			MMPXCollectionRemoveObserver *	aObs = NULL
		)	[pure virtual]

Remove an item (or items under a group) from the collection

please use CommandL (CMPXCommand)

Parameters

const CMPXCollectionPath & aPath
MMPXCollectionRemoveObserver * aObs = NULL

RemoveL(const CMPXMedia &)

void

RemoveL

(

const CMPXMedia &

aMedia

)

[pure virtual]

Removes item(s) from the collection.

Since: S60 3.2.3

Parameters

const CMPXMedia & aMedia

item(s) to remove

RemoveSubscriptionL(const CMPXSubscription &)

void

RemoveSubscriptionL

(

const CMPXSubscription &

aSubscription

)

[pure virtual]

Removes a message subscription for this client.

Since: S60 3.2.3

Parameters

const CMPXSubscription & aSubscription

subscription to be removed.

SetFilterL(CMPXFilter *)

void

SetFilterL

(

CMPXFilter *

aFilter

)

[pure virtual]

Apply a filter to collection browsing. All subsequent calls to OpenL() will have this filter applied.

Since: S60 3.2.3

Parameters

CMPXFilter * aFilter

the filter to apply, or NULL to remove current filter

SetL(const CMPXMedia &)

void

SetL

(

const CMPXMedia &

aMedia

)

[pure virtual]

Sets/updates the item specified in the path, Aynchronous Callback for completion with HandleCollectionMessageL() event: TMPXCollectionMessage::EAsyncOpComplete type: EMcsSetMediaAsync data: error code

, please use CommandL(CMPXCommand& aCmd)

Parameters

const CMPXMedia & aMedia

SetSyncL(const CMPXMedia &)

void

SetSyncL

(

const CMPXMedia &

aMedia

)

[pure virtual]

Sets/updates the media for the item. Callback via EMediaChanged message if currently opened.

Since: S60 3.2.3

Parameters

const CMPXMedia & aMedia

updated item

UidL()

TUid

UidL

(

)

const [pure virtual]

Returns current collection plugin implementation UID.

Since: S60 3.2.3

MMPXCollection Class Reference

Member Functions Documentation

AddL(const CMPXMedia &)

Parameters

AddSubscriptionL(const CMPXSubscription &)

Parameters

BackL()

CancelRequest()

ClearSubscriptionsL()

CollectionIDL(TUid &)

Parameters

CommandL(TMPXCollectionCommand, TInt)

Parameters

CommandL(CMPXCommand &)

Parameters

FilterL()

FindAllL(const CMPXSearchCriteria &, const TArray< TMPXAttribute > &, MMPXCollectionFindObserver &)

Parameters

FindAllL(const CMPXSearchCriteria &, const TArray< TMPXAttribute > &)

Parameters

GetSupportedCapabilitiesL(TCollectionCapability &)

Parameters

GetSupportedTypesL(RPointerArray< CMPXCollectionType > &)

Parameters

IsRemote(const CMPXCollectionPath &)

Parameters

MediaL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, CMPXAttributeSpecs *, CMPXFilter *)

Parameters

NotifyL(TMPXCollectionBroadCastMsg, TInt)

Parameters

OpenL(TMPXOpenMode)

Parameters

OpenL(TInt, TMPXOpenMode)

Parameters

OpenL(const CMPXCollectionPath &, TMPXOpenMode)

Parameters

OpenL(TInt, const TArray< TMPXAttribute > &, TMPXOpenMode)

Parameters

OpenL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, TMPXOpenMode)

Parameters

OpenL(const TArray< TUid > &, TMPXOpenMode)

Parameters

OpenL(const TUid &, TMPXOpenMode)

Parameters

PathL()

RemoveL(const CMPXCollectionPath &, MMPXCollectionRemoveObserver *)

Parameters

RemoveL(const CMPXMedia &)

Parameters

RemoveSubscriptionL(const CMPXSubscription &)

Parameters

SetFilterL(CMPXFilter *)

Parameters

SetL(const CMPXMedia &)

Parameters

SetSyncL(const CMPXMedia &)

Parameters

UidL()

MediaL(const CMPXCollectionPath &, const TArray< TMPXAttribute > &, CMPXAttributeSpecs , CMPXFilter )