Symbian^3 Application 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 ()
void ActivateTopViewL ()
void ActivateViewL (const TVwsViewId &, TBool )
void ActivateViewL (const TVwsViewId &, const TUid &, const TDesC8 &, TBool )
void AddViewActivationObserverL ( MCoeViewActivationObserver *)
void AddViewDeactivationObserverL ( MCoeViewDeactivationObserver *)
void AddViewObserverL ( MCoeViewObserver *)
void CheckInitializeViewsL (const TUid &)
TBool CheckSourceOfViewSwitchL (const TSecurityPolicy &, const char *)
void CreateActivateViewEventL (const TVwsViewId &, const TUid &, const TDesC8 &)
void DeactivateActiveViewIfOwnerMatchL ()
void DeactivateActiveViewL ()
void DeregisterApplicationView ()
void DeregisterView (const MCoeView &)
void DoActivationL (const TVwsViewId &, const TVwsViewId &, const TUid &, TInt )
void DoDeactivation (const TVwsViewId &, const TVwsViewId &, const TVwsViewEvent::TVwsViewEventType )
TInt EnableExternalViewSwitches ( TBool )
TInt GetActiveViewId ( TVwsViewId &)
TInt GetDefaultViewId ( TVwsViewId &)
void GetSystemDefaultViewL ( TVwsViewId &)
TInt GetTopViewId ( TVwsViewId &)
TVwsViewIdAndMessage HandleScreenDeviceChangedL (const TVwsViewId &)
void HandleViewActivationNotification (const TVwsViewId &, const TVwsViewId &)
void HandleViewDeactivationNotification (const TVwsViewId &, const TVwsViewId &)
TBool IsViewConstructed (const TVwsViewId &)
CCoeViewManager * NewL ( CCoeEnv &, CCoeAppUi &, CCoeAppUi *)
void NotifyNextActivation (const TVwsViewId &, MCoeViewActivationObserver &)
void NotifyNextActivation ( MCoeViewActivationObserver &)
void NotifyNextDeactivation (const TVwsViewId &, MCoeViewDeactivationObserver &)
void NotifyNextDeactivation ( MCoeViewDeactivationObserver &)
void RegisterApplicationViewL (const TUid &)
void RegisterViewL ( MCoeView &)
void RemoveViewActivationObserver ( MCoeViewActivationObserver *)
void RemoveViewDeactivationObserver ( MCoeViewDeactivationObserver *)
void RemoveViewObserver ( MCoeViewObserver *)
void SetApplicationViewAsDefaultL ()
void SetCustomControl (const TInt )
void SetDefaultViewL (const MCoeView &)
void SetSystemDefaultViewL (const TVwsViewId &, TInt )
void SetSystemDefaultViewL (const TVwsViewId &)
void SetWindowGroupOrdinal (const TInt )
void UpdateViewServerBackgroundColor (const TRgb &)
TInt ViewIndex (const MCoeView &)
TInt ViewIndex (const TVwsViewId &)
Private Member Functions
CCoeViewManager ( CCoeEnv &, CCoeAppUi &, CCoeAppUi *)
void CompleteActivation ( TInt , const TVwsViewId &, const TVwsViewId &)
void ConstructL ()
void HandleViewEventL (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()

void ActivateTopViewL ( )

ActivateViewL(const TVwsViewId &, TBool)

void ActivateViewL ( const TVwsViewId & aViewId,
TBool aActivatingTopView = EFalse
)

Parameters

const TVwsViewId & aViewId
TBool aActivatingTopView = EFalse

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

void ActivateViewL ( const TVwsViewId & aViewId,
const TUid & aCustomMessageId,
const TDesC8 & aCustomMessage,
TBool aActivatingTopView = EFalse
)

Parameters

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

AddViewActivationObserverL(MCoeViewActivationObserver *)

void AddViewActivationObserverL ( MCoeViewActivationObserver * aViewActivationObserver )

Parameters

MCoeViewActivationObserver * aViewActivationObserver

AddViewDeactivationObserverL(MCoeViewDeactivationObserver *)

void AddViewDeactivationObserverL ( MCoeViewDeactivationObserver * aViewDeactivationObserver )

Parameters

MCoeViewDeactivationObserver * aViewDeactivationObserver

AddViewObserverL(MCoeViewObserver *)

void AddViewObserverL ( MCoeViewObserver * aViewObserver )

Parameters

MCoeViewObserver * aViewObserver

CheckInitializeViewsL(const TUid &)

void CheckInitializeViewsL ( 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 &)

void CompleteActivation ( TInt aActiveViewIndex,
const TVwsViewId & aViewId,
const TVwsViewId & aPreviousViewId
) [private]

Parameters

TInt aActiveViewIndex
const TVwsViewId & aViewId
const TVwsViewId & aPreviousViewId

ConstructL()

void ConstructL ( ) [private]

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

void CreateActivateViewEventL ( const TVwsViewId & aViewId,
const TUid & aCustomMessageId,
const TDesC8 & aCustomMessage
)

Parameters

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

DeactivateActiveViewIfOwnerMatchL()

void DeactivateActiveViewIfOwnerMatchL ( )

DeactivateActiveViewL()

void DeactivateActiveViewL ( )

DeregisterApplicationView()

void DeregisterApplicationView ( )

DeregisterView(const MCoeView &)

void DeregisterView ( const MCoeView & aView )

Parameters

const MCoeView & aView

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

void DoActivationL ( const TVwsViewId & aViewId,
const TVwsViewId & aPreviousViewId,
const TUid & aCustomMessageId,
TInt aCustomMessageLength
)

Parameters

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

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

void DoDeactivation ( const TVwsViewId & aViewId,
const TVwsViewId & aActiveViewId,
const TVwsViewEvent::TVwsViewEventType aType
)

Parameters

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

EnableExternalViewSwitches(TBool)

TInt EnableExternalViewSwitches ( TBool aEnable )

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 &)

void GetSystemDefaultViewL ( 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 &)

void HandleViewActivationNotification ( const TVwsViewId & aActiveViewId,
const TVwsViewId & aViewToDeactivatedId
)

Parameters

const TVwsViewId & aActiveViewId
const TVwsViewId & aViewToDeactivatedId

HandleViewDeactivationNotification(const TVwsViewId &, const TVwsViewId &)

void HandleViewDeactivationNotification ( const TVwsViewId & aViewId,
const TVwsViewId & aActiveViewId
)

Parameters

const TVwsViewId & aViewId
const TVwsViewId & aActiveViewId

HandleViewEventL(const TVwsViewEvent &)

void HandleViewEventL ( 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 &)

void NotifyNextActivation ( const TVwsViewId & aViewId,
MCoeViewActivationObserver & aViewActivationObserver
)

Parameters

const TVwsViewId & aViewId
MCoeViewActivationObserver & aViewActivationObserver

NotifyNextActivation(MCoeViewActivationObserver &)

void NotifyNextActivation ( MCoeViewActivationObserver & aViewActivationObserver )

Parameters

MCoeViewActivationObserver & aViewActivationObserver

NotifyNextDeactivation(const TVwsViewId &, MCoeViewDeactivationObserver &)

void NotifyNextDeactivation ( const TVwsViewId & aViewId,
MCoeViewDeactivationObserver & aViewDeactivationObserver
)

Parameters

const TVwsViewId & aViewId
MCoeViewDeactivationObserver & aViewDeactivationObserver

NotifyNextDeactivation(MCoeViewDeactivationObserver &)

void NotifyNextDeactivation ( MCoeViewDeactivationObserver & aViewDeactivationObserver )

Parameters

MCoeViewDeactivationObserver & aViewDeactivationObserver

RegisterApplicationViewL(const TUid &)

void RegisterApplicationViewL ( const TUid & aAppUid )

Parameters

const TUid & aAppUid

RegisterViewL(MCoeView &)

void RegisterViewL ( MCoeView & aView )

Parameters

MCoeView & aView

RemoveViewActivationObserver(MCoeViewActivationObserver *)

void RemoveViewActivationObserver ( MCoeViewActivationObserver * aViewActivationObserver )

Parameters

MCoeViewActivationObserver * aViewActivationObserver

RemoveViewDeactivationObserver(MCoeViewDeactivationObserver *)

void RemoveViewDeactivationObserver ( MCoeViewDeactivationObserver * aViewDeactivationObserver )

Parameters

MCoeViewDeactivationObserver * aViewDeactivationObserver

RemoveViewObserver(MCoeViewObserver *)

void RemoveViewObserver ( MCoeViewObserver * aViewObserver )

Parameters

MCoeViewObserver * aViewObserver

SetApplicationViewAsDefaultL()

void SetApplicationViewAsDefaultL ( )

SetCustomControl(const TInt)

void SetCustomControl ( const TInt aCustomControl )

Parameters

const TInt aCustomControl

SetDefaultViewL(const MCoeView &)

void SetDefaultViewL ( const MCoeView & aView )

Parameters

const MCoeView & aView

SetSystemDefaultViewL(const TVwsViewId &, TInt)

void SetSystemDefaultViewL ( const TVwsViewId & aViewId,
TInt aMode
)

Parameters

const TVwsViewId & aViewId
TInt aMode

SetSystemDefaultViewL(const TVwsViewId &)

void SetSystemDefaultViewL ( const TVwsViewId & aViewId )

Parameters

const TVwsViewId & aViewId

SetWindowGroupOrdinal(const TInt)

void SetWindowGroupOrdinal ( const TInt aWindowGroupOrdinal )

Parameters

const TInt aWindowGroupOrdinal

UpdateViewServerBackgroundColor(const TRgb &)

void UpdateViewServerBackgroundColor ( 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.