Symbian^3 Product Developer Library >

CCoeViewManager Class Reference

class CCoeViewManager : public CBase

The CCoeViewManager class provides Cone's view management and implements the view specific functionality accessed through the CCoeAppUi API.

Inherits from

Public Member Functions
~CCoeViewManager()
voidActivateTopViewL()
voidActivateViewL(const TVwsViewId &, TBool)
voidActivateViewL(const TVwsViewId &, const TUid &, const TDesC8 &, TBool)
voidAddViewActivationObserverL(MCoeViewActivationObserver *)
voidAddViewDeactivationObserverL(MCoeViewDeactivationObserver *)
voidAddViewObserverL(MCoeViewObserver *)
voidCheckInitializeViewsL(const TUid &)
TBool CheckSourceOfViewSwitchL(const TSecurityPolicy &, const char *)
voidCreateActivateViewEventL(const TVwsViewId &, const TUid &, const TDesC8 &)
voidDeactivateActiveViewIfOwnerMatchL()
voidDeactivateActiveViewL()
voidDeregisterApplicationView()
voidDeregisterView(const MCoeView &)
voidDoActivationL(const TVwsViewId &, const TVwsViewId &, const TUid &, TInt)
voidDoDeactivation(const TVwsViewId &, const TVwsViewId &, const TVwsViewEvent::TVwsViewEventType)
TInt EnableExternalViewSwitches(TBool)
TInt GetActiveViewId(TVwsViewId &)
TInt GetDefaultViewId(TVwsViewId &)
voidGetSystemDefaultViewL(TVwsViewId &)
TInt GetTopViewId(TVwsViewId &)
TVwsViewIdAndMessage HandleScreenDeviceChangedL(const TVwsViewId &)
voidHandleViewActivationNotification(const TVwsViewId &, const TVwsViewId &)
voidHandleViewDeactivationNotification(const TVwsViewId &, const TVwsViewId &)
TBool IsViewConstructed(const TVwsViewId &)
CCoeViewManager *NewL(CCoeEnv &, CCoeAppUi &, CCoeAppUi *)
voidNotifyNextActivation(const TVwsViewId &, MCoeViewActivationObserver &)
voidNotifyNextActivation(MCoeViewActivationObserver &)
voidNotifyNextDeactivation(const TVwsViewId &, MCoeViewDeactivationObserver &)
voidNotifyNextDeactivation(MCoeViewDeactivationObserver &)
voidRegisterApplicationViewL(const TUid &)
voidRegisterViewL(MCoeView &)
voidRemoveViewActivationObserver(MCoeViewActivationObserver *)
voidRemoveViewDeactivationObserver(MCoeViewDeactivationObserver *)
voidRemoveViewObserver(MCoeViewObserver *)
voidSetApplicationViewAsDefaultL()
voidSetCustomControl(const TInt)
voidSetDefaultViewL(const MCoeView &)
voidSetSystemDefaultViewL(const TVwsViewId &, TInt)
voidSetSystemDefaultViewL(const TVwsViewId &)
voidSetWindowGroupOrdinal(const TInt)
voidUpdateViewServerBackgroundColor(const TRgb &)
TInt ViewIndex(const MCoeView &)
TInt ViewIndex(const TVwsViewId &)
Private Member Functions
CCoeViewManager(CCoeEnv &, CCoeAppUi &, CCoeAppUi *)
voidCompleteActivation(TInt, const TVwsViewId &, const TVwsViewId &)
voidConstructL()
voidHandleViewEventL(const TVwsViewEvent &)
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
TBool iActivatingTopView
TVwsViewId iActivatingViewId
TVwsViewId iActiveViewId
TInt iActiveViewIndex
CCoeAppUi &iAppUi
TVwsViewId iApplicationViewId
CCoeEnv &iCoeEnv
TInt iCustomControl
TPtrC8 iCustomMessage
TVwsViewId iDefaultViewId
TVwsViewId iLastActiveViewId
MCoeViewActivationObserver *iNextViewActivationObserver
MCoeViewDeactivationObserver *iNextViewDeactivationObserver
CCoeAppUi *iPreviousAppUi
TBool iRegisteredApplicationView
CArrayPtrFlat< MCoeViewActivationObserver >iViewActivationObserverArray
CArrayPtrFlat< CCoeView >iViewArray
CArrayPtrFlat< MCoeViewDeactivationObserver >iViewDeactivationObserverArray
CCoeViewObserver *iViewObserver
CArrayPtrFlat< MCoeViewObserver >iViewObserverArray
CVwsSessionWrapper *iVwsSession
TInt iWindowGroupOrdinal

Constructor & Destructor Documentation

CCoeViewManager(CCoeEnv &, CCoeAppUi &, CCoeAppUi *)

CCoeViewManager(CCoeEnv &aCoeEnv,
CCoeAppUi &aAppUi,
CCoeAppUi *aPreviousAppUi
)[private]

Parameters

CCoeEnv & aCoeEnv
CCoeAppUi & aAppUi
CCoeAppUi * aPreviousAppUi

~CCoeViewManager()

~CCoeViewManager()

Member Functions Documentation

ActivateTopViewL()

voidActivateTopViewL()

ActivateViewL(const TVwsViewId &, TBool)

voidActivateViewL(const TVwsViewId &aViewId,
TBoolaActivatingTopView = EFalse
)

Parameters

const TVwsViewId & aViewId
TBool aActivatingTopView = EFalse

ActivateViewL(const TVwsViewId &, const TUid &, const TDesC8 &, TBool)

voidActivateViewL(const TVwsViewId &aViewId,
const TUid &aCustomMessageId,
const TDesC8 &aCustomMessage,
TBoolaActivatingTopView = EFalse
)

Parameters

const TVwsViewId & aViewId
const TUid & aCustomMessageId
const TDesC8 & aCustomMessage
TBool aActivatingTopView = EFalse

AddViewActivationObserverL(MCoeViewActivationObserver *)

voidAddViewActivationObserverL(MCoeViewActivationObserver *aViewActivationObserver)

Parameters

MCoeViewActivationObserver * aViewActivationObserver

AddViewDeactivationObserverL(MCoeViewDeactivationObserver *)

voidAddViewDeactivationObserverL(MCoeViewDeactivationObserver *aViewDeactivationObserver)

Parameters

MCoeViewDeactivationObserver * aViewDeactivationObserver

AddViewObserverL(MCoeViewObserver *)

voidAddViewObserverL(MCoeViewObserver *aViewObserver)

Parameters

MCoeViewObserver * aViewObserver

CheckInitializeViewsL(const TUid &)

voidCheckInitializeViewsL(const TUid &aAppUid)

Parameters

const TUid & aAppUid

CheckSourceOfViewSwitchL(const TSecurityPolicy &, const char *)

TBool CheckSourceOfViewSwitchL(const TSecurityPolicy &aSecurityPolicy,
const char *aDiagnostic
)const

Parameters

const TSecurityPolicy & aSecurityPolicy
const char * aDiagnostic

CompleteActivation(TInt, const TVwsViewId &, const TVwsViewId &)

voidCompleteActivation(TIntaActiveViewIndex,
const TVwsViewId &aViewId,
const TVwsViewId &aPreviousViewId
)[private]

Parameters

TInt aActiveViewIndex
const TVwsViewId & aViewId
const TVwsViewId & aPreviousViewId

ConstructL()

voidConstructL()[private]

CreateActivateViewEventL(const TVwsViewId &, const TUid &, const TDesC8 &)

voidCreateActivateViewEventL(const TVwsViewId &aViewId,
const TUid &aCustomMessageId,
const TDesC8 &aCustomMessage
)

Parameters

const TVwsViewId & aViewId
const TUid & aCustomMessageId
const TDesC8 & aCustomMessage

DeactivateActiveViewIfOwnerMatchL()

voidDeactivateActiveViewIfOwnerMatchL()

DeactivateActiveViewL()

voidDeactivateActiveViewL()

DeregisterApplicationView()

voidDeregisterApplicationView()

DeregisterView(const MCoeView &)

voidDeregisterView(const MCoeView &aView)

Parameters

const MCoeView & aView

DoActivationL(const TVwsViewId &, const TVwsViewId &, const TUid &, TInt)

voidDoActivationL(const TVwsViewId &aViewId,
const TVwsViewId &aPreviousViewId,
const TUid &aCustomMessageId,
TIntaCustomMessageLength
)

Parameters

const TVwsViewId & aViewId
const TVwsViewId & aPreviousViewId
const TUid & aCustomMessageId
TInt aCustomMessageLength

DoDeactivation(const TVwsViewId &, const TVwsViewId &, const TVwsViewEvent::TVwsViewEventType)

voidDoDeactivation(const TVwsViewId &aViewId,
const TVwsViewId &aActiveViewId,
const TVwsViewEvent::TVwsViewEventTypeaType
)

Parameters

const TVwsViewId & aViewId
const TVwsViewId & aActiveViewId
const TVwsViewEvent::TVwsViewEventType aType

EnableExternalViewSwitches(TBool)

TInt EnableExternalViewSwitches(TBoolaEnable)

Parameters

TBool aEnable

GetActiveViewId(TVwsViewId &)

TInt GetActiveViewId(TVwsViewId &aViewId)const

Parameters

TVwsViewId & aViewId

GetDefaultViewId(TVwsViewId &)

TInt GetDefaultViewId(TVwsViewId &aViewId)const

Parameters

TVwsViewId & aViewId

GetSystemDefaultViewL(TVwsViewId &)

voidGetSystemDefaultViewL(TVwsViewId &aViewId)

Parameters

TVwsViewId & aViewId

GetTopViewId(TVwsViewId &)

TInt GetTopViewId(TVwsViewId &aViewId)const

Parameters

TVwsViewId & aViewId

HandleScreenDeviceChangedL(const TVwsViewId &)

TVwsViewIdAndMessage HandleScreenDeviceChangedL(const TVwsViewId &aViewId)

Parameters

const TVwsViewId & aViewId

HandleViewActivationNotification(const TVwsViewId &, const TVwsViewId &)

voidHandleViewActivationNotification(const TVwsViewId &aActiveViewId,
const TVwsViewId &aViewToDeactivatedId
)

Parameters

const TVwsViewId & aActiveViewId
const TVwsViewId & aViewToDeactivatedId

HandleViewDeactivationNotification(const TVwsViewId &, const TVwsViewId &)

voidHandleViewDeactivationNotification(const TVwsViewId &aViewId,
const TVwsViewId &aActiveViewId
)

Parameters

const TVwsViewId & aViewId
const TVwsViewId & aActiveViewId

HandleViewEventL(const TVwsViewEvent &)

voidHandleViewEventL(const TVwsViewEvent &aEvent)[private]

Parameters

const TVwsViewEvent & aEvent

IsViewConstructed(const TVwsViewId &)

TBool IsViewConstructed(const TVwsViewId &aViewId)const

Parameters

const TVwsViewId & aViewId

NewL(CCoeEnv &, CCoeAppUi &, CCoeAppUi *)

CCoeViewManager *NewL(CCoeEnv &aCoeEnv,
CCoeAppUi &aAppUi,
CCoeAppUi *aPreviousAppUi
)[static]

Parameters

CCoeEnv & aCoeEnv
CCoeAppUi & aAppUi
CCoeAppUi * aPreviousAppUi

NotifyNextActivation(const TVwsViewId &, MCoeViewActivationObserver &)

voidNotifyNextActivation(const TVwsViewId &aViewId,
MCoeViewActivationObserver &aViewActivationObserver
)

Parameters

const TVwsViewId & aViewId
MCoeViewActivationObserver & aViewActivationObserver

NotifyNextActivation(MCoeViewActivationObserver &)

voidNotifyNextActivation(MCoeViewActivationObserver &aViewActivationObserver)

Parameters

MCoeViewActivationObserver & aViewActivationObserver

NotifyNextDeactivation(const TVwsViewId &, MCoeViewDeactivationObserver &)

voidNotifyNextDeactivation(const TVwsViewId &aViewId,
MCoeViewDeactivationObserver &aViewDeactivationObserver
)

Parameters

const TVwsViewId & aViewId
MCoeViewDeactivationObserver & aViewDeactivationObserver

NotifyNextDeactivation(MCoeViewDeactivationObserver &)

voidNotifyNextDeactivation(MCoeViewDeactivationObserver &aViewDeactivationObserver)

Parameters

MCoeViewDeactivationObserver & aViewDeactivationObserver

RegisterApplicationViewL(const TUid &)

voidRegisterApplicationViewL(const TUid &aAppUid)

Parameters

const TUid & aAppUid

RegisterViewL(MCoeView &)

voidRegisterViewL(MCoeView &aView)

Parameters

MCoeView & aView

RemoveViewActivationObserver(MCoeViewActivationObserver *)

voidRemoveViewActivationObserver(MCoeViewActivationObserver *aViewActivationObserver)

Parameters

MCoeViewActivationObserver * aViewActivationObserver

RemoveViewDeactivationObserver(MCoeViewDeactivationObserver *)

voidRemoveViewDeactivationObserver(MCoeViewDeactivationObserver *aViewDeactivationObserver)

Parameters

MCoeViewDeactivationObserver * aViewDeactivationObserver

RemoveViewObserver(MCoeViewObserver *)

voidRemoveViewObserver(MCoeViewObserver *aViewObserver)

Parameters

MCoeViewObserver * aViewObserver

SetApplicationViewAsDefaultL()

voidSetApplicationViewAsDefaultL()

SetCustomControl(const TInt)

voidSetCustomControl(const TIntaCustomControl)

Parameters

const TInt aCustomControl

SetDefaultViewL(const MCoeView &)

voidSetDefaultViewL(const MCoeView &aView)

Parameters

const MCoeView & aView

SetSystemDefaultViewL(const TVwsViewId &, TInt)

voidSetSystemDefaultViewL(const TVwsViewId &aViewId,
TIntaMode
)

Parameters

const TVwsViewId & aViewId
TInt aMode

SetSystemDefaultViewL(const TVwsViewId &)

voidSetSystemDefaultViewL(const TVwsViewId &aViewId)

Parameters

const TVwsViewId & aViewId

SetWindowGroupOrdinal(const TInt)

voidSetWindowGroupOrdinal(const TIntaWindowGroupOrdinal)

Parameters

const TInt aWindowGroupOrdinal

UpdateViewServerBackgroundColor(const TRgb &)

voidUpdateViewServerBackgroundColor(const TRgb &aBgColor)

Parameters

const TRgb & aBgColor

ViewIndex(const MCoeView &)

TInt ViewIndex(const MCoeView &aView)const

Parameters

const MCoeView & aView

ViewIndex(const TVwsViewId &)

TInt ViewIndex(const TVwsViewId &aViewId)const

Parameters

const TVwsViewId & aViewId

Member Data Documentation

TBool iActivatingTopView

TBool iActivatingTopView[private]

TVwsViewId iActivatingViewId

TVwsViewId iActivatingViewId[private]

TVwsViewId iActiveViewId

TVwsViewId iActiveViewId[private]

TInt iActiveViewIndex

TInt iActiveViewIndex[private]

CCoeAppUi & iAppUi

CCoeAppUi &iAppUi[private]

TVwsViewId iApplicationViewId

TVwsViewId iApplicationViewId[private]

CCoeEnv & iCoeEnv

CCoeEnv &iCoeEnv[private]

TInt iCustomControl

TInt iCustomControl[private]

TPtrC8 iCustomMessage

TPtrC8 iCustomMessage[private]

TVwsViewId iDefaultViewId

TVwsViewId iDefaultViewId[private]

TVwsViewId iLastActiveViewId

TVwsViewId iLastActiveViewId[private]

MCoeViewActivationObserver * iNextViewActivationObserver

MCoeViewActivationObserver *iNextViewActivationObserver[private]

MCoeViewDeactivationObserver * iNextViewDeactivationObserver

MCoeViewDeactivationObserver *iNextViewDeactivationObserver[private]

CCoeAppUi * iPreviousAppUi

CCoeAppUi *iPreviousAppUi[private]

TBool iRegisteredApplicationView

TBool iRegisteredApplicationView[private]

CArrayPtrFlat< MCoeViewActivationObserver > iViewActivationObserverArray

CArrayPtrFlat< MCoeViewActivationObserver >iViewActivationObserverArray[private]

CArrayPtrFlat< CCoeView > iViewArray

CArrayPtrFlat< CCoeView >iViewArray[private]

CArrayPtrFlat< MCoeViewDeactivationObserver > iViewDeactivationObserverArray

CArrayPtrFlat< MCoeViewDeactivationObserver >iViewDeactivationObserverArray[private]

CCoeViewObserver * iViewObserver

CCoeViewObserver *iViewObserver[private]

CArrayPtrFlat< MCoeViewObserver > iViewObserverArray

CArrayPtrFlat< MCoeViewObserver >iViewObserverArray[private]

CVwsSessionWrapper * iVwsSession

CVwsSessionWrapper *iVwsSession[private]

TInt iWindowGroupOrdinal

TInt iWindowGroupOrdinal[private]

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.