MMPXViewUtility Class Reference

class MMPXViewUtility

MPX view utility interface.

mpxviewutility.lib

Member Functions Documentation

ActivatePreviousViewL()

void ActivatePreviousViewL ( ) [pure virtual]

Activate previous view.

Since
S60 3.2.3
leave
Error code KErrNotFound if there's no history.

ActivateViewL(const TUid &, const TDesC *)

void ActivateViewL ( const TUid & aUid,
const TDesC * aParam = NULL
) [pure virtual]

Activate view by resolving passed uid.

Since
S60 3.2.3
leave
KErrNotFound if a matching plugin cannot be found

Parameters

const TUid & aUid Uid to be resolved. This uid can be plugin implementation uid, plugin type uid or specific view plugin uid.
const TDesC * aParam = NULL Parameter passed to the view on activation

ActivateViewL(const RArray< TUid > &, const TDesC *)

void ActivateViewL ( const RArray < TUid > & aUids,
const TDesC * aParam = NULL
) [pure virtual]

Activate view by resolving passed uids.

Since
S60 3.2.3
leave
KErrNotFound if a matching plugin cannot be found

Parameters

const RArray < TUid > & aUids List of Uids to be resolved, this uid can be plugin uid, plugin type uid or specific view plugin uid.
const TDesC * aParam = NULL Parameter passed to the view on activation

ActiveViewImplementationUid()

TUid ActiveViewImplementationUid ( ) [pure virtual]

Returns the implementation uid of the active view.

Since
S60 3.2.3

ActiveViewType()

TUid ActiveViewType ( ) [pure virtual]

Returns the view type of the active view.

Since
S60 3.2.3

AddObserverL(MMPXViewActivationObserver *)

void AddObserverL ( MMPXViewActivationObserver * aObserver ) [pure virtual]

Add view activation observer.

Since
S60 3.2.3

Parameters

MMPXViewActivationObserver * aObserver Pointer to an observer object

Close()

void Close ( ) [pure virtual]

This method must be called when this object can be freed. This object will be destroyed when no one is using it.

Since
S60 3.2.3

ConstructDefaultViewHistoryL()

TUid ConstructDefaultViewHistoryL ( ) [pure virtual]

Constructs default view history.

Since
S60 3.2.3

DefaultViewUid()

TUid DefaultViewUid ( ) [pure virtual]

Gets default view's UID.

Since
S60 3.2.3

PreLoadViewL(const TUid &)

void PreLoadViewL ( const TUid & aUid ) [pure virtual]

Pre-load view plug-in by resolving passed uid.

Since
S60 3.2.3
leave
if no match is found.

Parameters

const TUid & aUid Uid to be resolved. This uid can be plugin uid, plugin type uid or specific view plugin uid.

PreLoadViewsL()

void PreLoadViewsL ( ) [pure virtual]

Pre-load view plug-ins that have EMPXPluginFlagPreLoad flag set.

Since
S60 3.2.3

PreLoadViewsL(const TUid &)

void PreLoadViewsL ( const TUid & aUid ) [pure virtual]

Pre-load view plug-ins that have EMPXPluginFlagPreLoad flag and also by resolving passed uid.

Parameters

const TUid & aUid Uid of specific application to be resolved.

PreviousViewType()

TUid PreviousViewType ( ) [pure virtual]

Returns the last activated view type.

Since
S60 3.2.3

PushDefaultHistoryL()

void PushDefaultHistoryL ( ) [pure virtual]
Push default history to view history. The current browse history is erased and the default browsing path is loaded as the current history.
Since
S60 3.2.3

RemoveObserver(MMPXViewActivationObserver *)

void RemoveObserver ( MMPXViewActivationObserver * aObserver ) [pure virtual]

Remove view activation observer.

Since
S60 3.2.3

Parameters

MMPXViewActivationObserver * aObserver Pointer to an observer object

SetAsDefaultViewL(const TUid &)

void SetAsDefaultViewL ( const TUid & aUid ) [pure virtual]

Set view as default view, not bring to foreground. This is only valid if there are no views previously activated.

Since
S60 3.2.3
leave
Error code KErrAlreadyExist when there are views already activated
leave
Error code KErrNotSupported for views that doesn't support default view (such as dialogs)

Parameters

const TUid & aUid Uid of item to be activated. This uid can be plugin implementation uid, plugin type uid or specific view plugin uid.

SetAsDefaultViewL(const RArray< TUid > &)

void SetAsDefaultViewL ( const RArray < TUid > & aUids ) [pure virtual]

Set view as default view, not bring to foreground. This is only valid if there are no views previously activated.

Since
S60 3.2.3
leave
Error code KErrAlreadyExist when there are views already activated
leave
Error code KErrNotSupported for views that doesn't support default view (such as dialogs)

Parameters

const RArray < TUid > & aUids

UtilityL()

IMPORT_C MMPXViewUtility * UtilityL ( ) [static]

Retrieve a view utility of this thread. All clients in this thread shares the same viewutility (singleton). Call Close() when this object is not needed anymore.

Since
S60 3.2.3

ViewHistoryDepth()

TInt ViewHistoryDepth ( ) [pure virtual]

Returns the current history depth. if depth is greater than 1, the client should call ActivatePreviousViewL on a back command.

if depth is 1, the client should exit the app on a back command instead of calling ActivatePreviousViewL.

Since
S60 3.2.3

ViewPluginManager()

MMPXViewPluginManager & ViewPluginManager ( ) [pure virtual]

Get a reference to view plugin manager.

Since
S60 3.2.3