CCoeAppUi Class Reference

class CCoeAppUi : public CBase

Application user interface (app UI) base class.

The app UI's responsibilities include owning the application's control stack and views, handling user commands, (see the derived class CEikAppUi), and handling events sent by the OS to the application, for instance being brought to the foreground.

The UI framework class CEikAppUi is derived from this class. UIs may derive further to add their own UI-specific features to the app UI; each application must derive its own concrete app UI class from this.

Inherits from

Public Member Functions
CCoeAppUi()
~CCoeAppUi()
IMPORT_C voidActivateTopViewL()
IMPORT_C voidActivateViewL(const TVwsViewId &)
IMPORT_C voidActivateViewL(const TVwsViewId &, TUid, const TDesC8 &)
IMPORT_C voidAddToStackL(const MCoeView &, CCoeControl *, TInt, TInt)
IMPORT_C voidAddToStackL(CCoeControl *, TInt, TInt)
IMPORT_C voidAddToViewStackL(const MCoeView &, CCoeControl *, TInt, TInt)
IMPORT_C voidAddViewActivationObserverL(MCoeViewActivationObserver *)
IMPORT_C voidAddViewDeactivationObserverL(MCoeViewDeactivationObserver *)
IMPORT_C voidAddViewObserverL(MCoeViewObserver *)
IMPORT_C CArrayFix< TCoeHelpContext > *AppHelpContextL()
IMPORT_C voidCheckInitializeViewsL(TUid)
IMPORT_C TBoolCheckSourceOfViewSwitchL(const TSecurityPolicy &, const char *)
IMPORT_C voidConstructL(CCoeAppUi *)
IMPORT_C voidCreateActivateViewEventL(const TVwsViewId &, TUid, const TDesC8 &)
IMPORT_C voidDeactivateActiveViewIfOwnerMatchL()
IMPORT_C voidDeactivateActiveViewL()
IMPORT_C voidDeregisterApplicationView()
IMPORT_C voidDeregisterView(const MCoeView &)
IMPORT_C voidDeregisterViewAndRemoveStack(const MCoeView &)
IMPORT_C TIntEnableExternalViewSwitches(TBool)
IMPORT_C TBoolFrameworkCallsRendezvous()
IMPORT_C TIntGetActiveViewId(TVwsViewId &)
IMPORT_C TIntGetDefaultViewId(TVwsViewId &)
IMPORT_C voidGetSystemDefaultViewL(TVwsViewId &)
IMPORT_C TIntGetTopViewId(TVwsViewId &)
IMPORT_C voidHandleStackChanged()
IMPORT_C voidHandleStackedControlsResourceChange(TInt)
IMPORT_C voidHandleWsEventL(const TWsEvent &, CCoeControl *)
IMPORT_C TCoeInputCapabilitiesInputCapabilities()
TBool IsControlOnStack(CCoeControl *)
IMPORT_C TBoolIsDisplayingControlBetweenPriorities(TInt, TInt)
IMPORT_C TBoolIsDisplayingDialog()
IMPORT_C TBoolIsDisplayingMenuOrDialog()
IMPORT_C TBoolIsViewConstructed(const TVwsViewId &)
voidMonitorWsEvent(const TWsEvent &)
voidNotifyFontChange(const CCoeFontProvider &)
IMPORT_C voidNotifyNextActivation(const TVwsViewId &, MCoeViewActivationObserver &)
IMPORT_C voidNotifyNextActivation(MCoeViewActivationObserver &)
IMPORT_C voidNotifyNextDeactivation(const TVwsViewId &, MCoeViewDeactivationObserver &)
IMPORT_C voidNotifyNextDeactivation(MCoeViewDeactivationObserver &)
IMPORT_C voidPrepareToExit()
voidRefetchPixelMappingL()
IMPORT_C voidRegisterApplicationViewL(TUid)
IMPORT_C voidRegisterViewAndAddStackL(MCoeView &)
IMPORT_C voidRegisterViewL(MCoeView &)
IMPORT_C voidRemoveFromStack(CCoeControl *)
IMPORT_C voidRemoveFromViewStack(const MCoeView &, CCoeControl *)
IMPORT_C voidRemoveViewActivationObserver(MCoeViewActivationObserver *)
IMPORT_C voidRemoveViewDeactivationObserver(MCoeViewDeactivationObserver *)
IMPORT_C voidRemoveViewObserver(MCoeViewObserver *)
IMPORT_C voidSetApplicationViewAsDefaultL()
voidSetCurrentControlStackGroupId(TInt)
IMPORT_C voidSetCustomControl(TInt)
IMPORT_C voidSetDefaultViewL(const MCoeView &)
IMPORT_C voidSetSystemDefaultViewL(const TVwsViewId &, TInt)
IMPORT_C voidSetSystemDefaultViewL(const TVwsViewId &)
IMPORT_C voidSetWindowGroupOrdinal(TInt)
IMPORT_C CCoeControl *TopFocusedControl()
IMPORT_C voidUpdateStackedControlFlags(CCoeControl *, TInt, TInt)
IMPORT_C voidUpdateViewServerBackgroundColor(const TRgb &)
IMPORT_C voidUpdateViewStackedControlFlags(const MCoeView &, CCoeControl *, TInt, TInt)
IMPORT_C voidWriteInternalStateOfStackedControlsL(RWriteStream &)
Protected Member Functions
IMPORT_C voidHandleScreenDeviceChangedL()
Private Member Functions
IMPORT_C voidCCoeAppUi_Reserved_2()
voidDoAddToStackL(CCoeControlStack *, CCoeControl *, TInt, TInt)
voidDoAddToStackL(CCoeControlStack *, CCoeControl *, TInt, TInt, TInt)
voidDoRemoveFromStack(CCoeControlStack *, CCoeControl *, TRemoveCondition)
voidDoUpdateStackedControlFlags(CCoeControlStack *, CCoeControl *, TInt, TInt)
TInt FindPos(CCoeControlStack *, CCoeControl *)
IMPORT_C voidHandleApplicationSpecificEventL(TInt, const TWsEvent &)
IMPORT_C voidHandleForegroundEventL(TBool)
IMPORT_C TKeyResponseHandleKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidHandleSwitchOnEventL(CCoeControl *)
IMPORT_C voidHandleSystemEventL(const TWsEvent &)
IMPORT_C CArrayFix< TCoeHelpContext > *HelpContextL()
IMPORT_C voidSetAndDrawFocus(TBool)
voidSetFocusToControl(CCoeControl *, TBool)
CCoeControl *TopFocusableControl()
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 Member Enumerations
enumTRemoveCondition { ERemoveUnconditionally, ERemoveOnlyIfSharable }
Protected Attributes
CCoeEnv *iCoeEnv
Private Attributes
TInt iCCoeAppUi_Reserved1
CExtra *iExtra
CCoeControlStack *iStack
CCoeViewManager *iViewManager

Constructor & Destructor Documentation

CCoeAppUi()

IMPORT_CCCoeAppUi()

~CCoeAppUi()

IMPORT_C~CCoeAppUi()

Member Functions Documentation

ActivateTopViewL()

IMPORT_C voidActivateTopViewL()

ActivateViewL(const TVwsViewId &)

IMPORT_C voidActivateViewL(const TVwsViewId &aViewId)

Parameters

const TVwsViewId & aViewId

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

IMPORT_C voidActivateViewL(const TVwsViewId &aViewId,
TUidaCustomMessageId,
const TDesC8 &aCustomMessage
)

Parameters

const TVwsViewId & aViewId
TUid aCustomMessageId
const TDesC8 & aCustomMessage

AddToStackL(const MCoeView &, CCoeControl *, TInt, TInt)

IMPORT_C voidAddToStackL(const MCoeView &aView,
CCoeControl *aControl,
TIntaPriority = ECoeStackPriorityDefault,
TIntaStackingFlags = ECoeStackFlagStandard
)

Parameters

const MCoeView & aView
CCoeControl * aControl
TInt aPriority = ECoeStackPriorityDefault
TInt aStackingFlags = ECoeStackFlagStandard

AddToStackL(CCoeControl *, TInt, TInt)

IMPORT_C voidAddToStackL(CCoeControl *aControl,
TIntaPriority = ECoeStackPriorityDefault,
TIntaStackingFlags = ECoeStackFlagStandard
)

Parameters

CCoeControl * aControl
TInt aPriority = ECoeStackPriorityDefault
TInt aStackingFlags = ECoeStackFlagStandard

AddToViewStackL(const MCoeView &, CCoeControl *, TInt, TInt)

IMPORT_C voidAddToViewStackL(const MCoeView &aView,
CCoeControl *aControl,
TIntaPriority = ECoeStackPriorityDefault,
TIntaStackingFlags = ECoeStackFlagStandard
)

Parameters

const MCoeView & aView
CCoeControl * aControl
TInt aPriority = ECoeStackPriorityDefault
TInt aStackingFlags = ECoeStackFlagStandard

AddViewActivationObserverL(MCoeViewActivationObserver *)

IMPORT_C voidAddViewActivationObserverL(MCoeViewActivationObserver *aViewActivationObserver)

Parameters

MCoeViewActivationObserver * aViewActivationObserver

AddViewDeactivationObserverL(MCoeViewDeactivationObserver *)

IMPORT_C voidAddViewDeactivationObserverL(MCoeViewDeactivationObserver *aViewDeactivationObserver)

Parameters

MCoeViewDeactivationObserver * aViewDeactivationObserver

AddViewObserverL(MCoeViewObserver *)

IMPORT_C voidAddViewObserverL(MCoeViewObserver *aViewObserver)

Parameters

MCoeViewObserver * aViewObserver

AppHelpContextL()

IMPORT_C CArrayFix< TCoeHelpContext > *AppHelpContextL()const

CCoeAppUi_Reserved_2()

IMPORT_C voidCCoeAppUi_Reserved_2()[private, virtual]

CheckInitializeViewsL(TUid)

IMPORT_C voidCheckInitializeViewsL(TUidaAppUid)

Parameters

TUid aAppUid

CheckSourceOfViewSwitchL(const TSecurityPolicy &, const char *)

IMPORT_C TBoolCheckSourceOfViewSwitchL(const TSecurityPolicy &aSecurityPolicy,
const char *aDiagnostic = NULL
)const

Parameters

const TSecurityPolicy & aSecurityPolicy
const char * aDiagnostic = NULL

ConstructL(CCoeAppUi *)

IMPORT_C voidConstructL(CCoeAppUi *aPrevious = NULL)

Parameters

CCoeAppUi * aPrevious = NULL

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

IMPORT_C voidCreateActivateViewEventL(const TVwsViewId &aViewId,
TUidaCustomMessageId,
const TDesC8 &aCustomMessage
)

Parameters

const TVwsViewId & aViewId
TUid aCustomMessageId
const TDesC8 & aCustomMessage

DeactivateActiveViewIfOwnerMatchL()

IMPORT_C voidDeactivateActiveViewIfOwnerMatchL()

DeactivateActiveViewL()

IMPORT_C voidDeactivateActiveViewL()

DeregisterApplicationView()

IMPORT_C voidDeregisterApplicationView()

DeregisterView(const MCoeView &)

IMPORT_C voidDeregisterView(const MCoeView &aView)

Parameters

const MCoeView & aView

DeregisterViewAndRemoveStack(const MCoeView &)

IMPORT_C voidDeregisterViewAndRemoveStack(const MCoeView &aView)

Parameters

const MCoeView & aView

DoAddToStackL(CCoeControlStack *, CCoeControl *, TInt, TInt)

voidDoAddToStackL(CCoeControlStack *aStack,
CCoeControl *aControl,
TIntaPriority,
TIntaStackingFlags
)[private]

Parameters

CCoeControlStack * aStack
CCoeControl * aControl
TInt aPriority
TInt aStackingFlags

DoAddToStackL(CCoeControlStack *, CCoeControl *, TInt, TInt, TInt)

voidDoAddToStackL(CCoeControlStack *aStack,
CCoeControl *aControl,
TIntaPriority,
TIntaStackingFlags,
TIntaGroupId
)[private]

Parameters

CCoeControlStack * aStack
CCoeControl * aControl
TInt aPriority
TInt aStackingFlags
TInt aGroupId

DoRemoveFromStack(CCoeControlStack *, CCoeControl *, TRemoveCondition)

voidDoRemoveFromStack(CCoeControlStack *aStack,
CCoeControl *aControl,
TRemoveConditionaRemoveCondition = ERemoveUnconditionally
)[private]

Parameters

CCoeControlStack * aStack
CCoeControl * aControl
TRemoveCondition aRemoveCondition = ERemoveUnconditionally

DoUpdateStackedControlFlags(CCoeControlStack *, CCoeControl *, TInt, TInt)

voidDoUpdateStackedControlFlags(CCoeControlStack *aStack,
CCoeControl *aControl,
TIntaFlags,
TIntaMask
)[private]

Parameters

CCoeControlStack * aStack
CCoeControl * aControl
TInt aFlags
TInt aMask

EnableExternalViewSwitches(TBool)

IMPORT_C TIntEnableExternalViewSwitches(TBoolaEnable)

Parameters

TBool aEnable

FindPos(CCoeControlStack *, CCoeControl *)

TInt FindPos(CCoeControlStack *aStack,
CCoeControl *aControl
)const [private]

Parameters

CCoeControlStack * aStack
CCoeControl * aControl

FrameworkCallsRendezvous()

IMPORT_C TBoolFrameworkCallsRendezvous()const [virtual]

GetActiveViewId(TVwsViewId &)

IMPORT_C TIntGetActiveViewId(TVwsViewId &aViewId)const

Parameters

TVwsViewId & aViewId

GetDefaultViewId(TVwsViewId &)

IMPORT_C TIntGetDefaultViewId(TVwsViewId &aViewId)const

Parameters

TVwsViewId & aViewId

GetSystemDefaultViewL(TVwsViewId &)

IMPORT_C voidGetSystemDefaultViewL(TVwsViewId &aViewId)

Parameters

TVwsViewId & aViewId

GetTopViewId(TVwsViewId &)

IMPORT_C TIntGetTopViewId(TVwsViewId &aViewId)const

Parameters

TVwsViewId & aViewId

HandleApplicationSpecificEventL(TInt, const TWsEvent &)

IMPORT_C voidHandleApplicationSpecificEventL(TIntaType,
const TWsEvent &aEvent
)[private, virtual]

Parameters

TInt aType
const TWsEvent & aEvent

HandleForegroundEventL(TBool)

IMPORT_C voidHandleForegroundEventL(TBoolaForeground)[private, virtual]

Parameters

TBool aForeground

HandleKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseHandleKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[private, virtual]

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

HandleScreenDeviceChangedL()

IMPORT_C voidHandleScreenDeviceChangedL()[protected, virtual]

HandleStackChanged()

IMPORT_C voidHandleStackChanged()

HandleStackedControlsResourceChange(TInt)

IMPORT_C voidHandleStackedControlsResourceChange(TIntaType)

Parameters

TInt aType

HandleSwitchOnEventL(CCoeControl *)

IMPORT_C voidHandleSwitchOnEventL(CCoeControl *aDestination)[private, virtual]

Parameters

CCoeControl * aDestination

HandleSystemEventL(const TWsEvent &)

IMPORT_C voidHandleSystemEventL(const TWsEvent &aEvent)[private, virtual]

Parameters

const TWsEvent & aEvent

HandleWsEventL(const TWsEvent &, CCoeControl *)

IMPORT_C voidHandleWsEventL(const TWsEvent &aEvent,
CCoeControl *aDestination
)[virtual]

Parameters

const TWsEvent & aEvent
CCoeControl * aDestination

HelpContextL()

IMPORT_C CArrayFix< TCoeHelpContext > *HelpContextL()const [private, virtual]

InputCapabilities()

IMPORT_C TCoeInputCapabilitiesInputCapabilities()const [virtual]

IsControlOnStack(CCoeControl *)

TBool IsControlOnStack(CCoeControl *aControl)const

Parameters

CCoeControl * aControl

IsDisplayingControlBetweenPriorities(TInt, TInt)

IMPORT_C TBoolIsDisplayingControlBetweenPriorities(TIntaLowerPriority,
TIntaHigherPriority
)const

Parameters

TInt aLowerPriority
TInt aHigherPriority

IsDisplayingDialog()

IMPORT_C TBoolIsDisplayingDialog()const

IsDisplayingMenuOrDialog()

IMPORT_C TBoolIsDisplayingMenuOrDialog()const

IsViewConstructed(const TVwsViewId &)

IMPORT_C TBoolIsViewConstructed(const TVwsViewId &aViewId)const

Parameters

const TVwsViewId & aViewId

MonitorWsEvent(const TWsEvent &)

voidMonitorWsEvent(const TWsEvent &aEvent)

Monitor function for passing all windows events to registered monitor observers for optional inspection

Parameters

const TWsEvent & aEvent

NotifyFontChange(const CCoeFontProvider &)

voidNotifyFontChange(const CCoeFontProvider &aFontProvider)

Parameters

const CCoeFontProvider & aFontProvider

NotifyNextActivation(const TVwsViewId &, MCoeViewActivationObserver &)

IMPORT_C voidNotifyNextActivation(const TVwsViewId &aViewId,
MCoeViewActivationObserver &aViewActivationObserver
)

Parameters

const TVwsViewId & aViewId
MCoeViewActivationObserver & aViewActivationObserver

NotifyNextActivation(MCoeViewActivationObserver &)

IMPORT_C voidNotifyNextActivation(MCoeViewActivationObserver &aViewActivationObserver)

Parameters

MCoeViewActivationObserver & aViewActivationObserver

NotifyNextDeactivation(const TVwsViewId &, MCoeViewDeactivationObserver &)

IMPORT_C voidNotifyNextDeactivation(const TVwsViewId &aViewId,
MCoeViewDeactivationObserver &aViewDeactivationObserver
)

Parameters

const TVwsViewId & aViewId
MCoeViewDeactivationObserver & aViewDeactivationObserver

NotifyNextDeactivation(MCoeViewDeactivationObserver &)

IMPORT_C voidNotifyNextDeactivation(MCoeViewDeactivationObserver &aViewDeactivationObserver)

Parameters

MCoeViewDeactivationObserver & aViewDeactivationObserver

PrepareToExit()

IMPORT_C voidPrepareToExit()[virtual]

RefetchPixelMappingL()

voidRefetchPixelMappingL()

RegisterApplicationViewL(TUid)

IMPORT_C voidRegisterApplicationViewL(TUidaAppUid)

Parameters

TUid aAppUid

RegisterViewAndAddStackL(MCoeView &)

IMPORT_C voidRegisterViewAndAddStackL(MCoeView &aView)

Parameters

MCoeView & aView

RegisterViewL(MCoeView &)

IMPORT_C voidRegisterViewL(MCoeView &aView)

Parameters

MCoeView & aView

RemoveFromStack(CCoeControl *)

IMPORT_C voidRemoveFromStack(CCoeControl *aControl)

Parameters

CCoeControl * aControl

RemoveFromViewStack(const MCoeView &, CCoeControl *)

IMPORT_C voidRemoveFromViewStack(const MCoeView &aView,
CCoeControl *aControl
)

Parameters

const MCoeView & aView
CCoeControl * aControl

RemoveViewActivationObserver(MCoeViewActivationObserver *)

IMPORT_C voidRemoveViewActivationObserver(MCoeViewActivationObserver *aViewActivationObserver)

Parameters

MCoeViewActivationObserver * aViewActivationObserver

RemoveViewDeactivationObserver(MCoeViewDeactivationObserver *)

IMPORT_C voidRemoveViewDeactivationObserver(MCoeViewDeactivationObserver *aViewDeactivationObserver)

Parameters

MCoeViewDeactivationObserver * aViewDeactivationObserver

RemoveViewObserver(MCoeViewObserver *)

IMPORT_C voidRemoveViewObserver(MCoeViewObserver *aViewObserver)

Parameters

MCoeViewObserver * aViewObserver

SetAndDrawFocus(TBool)

IMPORT_C voidSetAndDrawFocus(TBoolaFocus)[private, virtual]

Parameters

TBool aFocus

SetApplicationViewAsDefaultL()

IMPORT_C voidSetApplicationViewAsDefaultL()

SetCurrentControlStackGroupId(TInt)

voidSetCurrentControlStackGroupId(TIntaGroupId)

Parameters

TInt aGroupId

SetCustomControl(TInt)

IMPORT_C voidSetCustomControl(TIntaCustomControl)

Parameters

TInt aCustomControl

SetDefaultViewL(const MCoeView &)

IMPORT_C voidSetDefaultViewL(const MCoeView &aView)

Parameters

const MCoeView & aView

SetFocusToControl(CCoeControl *, TBool)

voidSetFocusToControl(CCoeControl *aControl,
TBoolaFocus
)[private]

Parameters

CCoeControl * aControl
TBool aFocus

SetSystemDefaultViewL(const TVwsViewId &, TInt)

IMPORT_C voidSetSystemDefaultViewL(const TVwsViewId &aViewId,
TIntaMode
)

Parameters

const TVwsViewId & aViewId
TInt aMode

SetSystemDefaultViewL(const TVwsViewId &)

IMPORT_C voidSetSystemDefaultViewL(const TVwsViewId &aViewId)

Parameters

const TVwsViewId & aViewId

SetWindowGroupOrdinal(TInt)

IMPORT_C voidSetWindowGroupOrdinal(TIntaWindowGroupOrdinal)

Parameters

TInt aWindowGroupOrdinal

TopFocusableControl()

CCoeControl *TopFocusableControl()const [private]

TopFocusedControl()

IMPORT_C CCoeControl *TopFocusedControl()const

UpdateStackedControlFlags(CCoeControl *, TInt, TInt)

IMPORT_C voidUpdateStackedControlFlags(CCoeControl *aControl,
TIntaFlags,
TIntaMask
)

Parameters

CCoeControl * aControl
TInt aFlags
TInt aMask

UpdateViewServerBackgroundColor(const TRgb &)

IMPORT_C voidUpdateViewServerBackgroundColor(const TRgb &aBgColor)

Parameters

const TRgb & aBgColor

UpdateViewStackedControlFlags(const MCoeView &, CCoeControl *, TInt, TInt)

IMPORT_C voidUpdateViewStackedControlFlags(const MCoeView &aView,
CCoeControl *aControl,
TIntaFlags,
TIntaMask
)

Parameters

const MCoeView & aView
CCoeControl * aControl
TInt aFlags
TInt aMask

WriteInternalStateOfStackedControlsL(RWriteStream &)

IMPORT_C voidWriteInternalStateOfStackedControlsL(RWriteStream &aWriteStream)const

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum TRemoveCondition

Enumerators

ERemoveUnconditionally
ERemoveOnlyIfSharable

Member Data Documentation

TInt iCCoeAppUi_Reserved1

TInt iCCoeAppUi_Reserved1[private]

CCoeEnv * iCoeEnv

CCoeEnv *iCoeEnv[protected]

CExtra * iExtra

CExtra *iExtra[private]

CCoeControlStack * iStack

CCoeControlStack *iStack[private]

CCoeViewManager * iViewManager

CCoeViewManager *iViewManager[private]
© Nokia 2010.