CAknAppUi Class Reference

class CAknAppUi : public CAknAppUiBase

Abstract Avkon application UI class

S60 0.9

Public Member Functions
~CAknAppUi()
IMPORT_C voidBaseConstructL(TInt)
IMPORT_C TInt32CaptureKey(TUint, TUint, TUint)
IMPORT_C voidCaptureKeyL(TUint, TUint, TUint, TInt32 &)
IMPORT_C CEikButtonGroupContainer *Cba()
IMPORT_C voidConstructL()
IMPORT_C CAknToolbar *CurrentFixedToolbar()
IMPORT_C CAknToolbar *CurrentPopupToolbar()
IMPORT_C voidDisableNextKeySound(TInt)
IMPORT_C TBoolExitHidesInBackground()
IMPORT_C voidGetAliasKeyCodeL(TUint &, const TKeyEvent &, TEventCode)
IMPORT_C TErrorHandlerResponseHandleError(TInt, const SExtendedError &, TDes &, TDes &)
IMPORT_C voidHandleTouchPaneSizeChange()
IMPORT_C voidHandleViewDeactivation(const TVwsViewId &, const TVwsViewId &)
IMPORT_C voidHideApplicationFromFSW(TBool)
IMPORT_C voidHideInBackground()
TBool IsAppHiddenInBackground()
IMPORT_C TBoolIsAppShutterRunning()
IMPORT_C CAknToolbar *PopupToolbar()
IMPORT_C voidPrepareToExit()
IMPORT_C voidProcessCommandL(TInt)
IMPORT_C voidRunAppShutter()
IMPORT_C voidSetAliasKeyCodeResolverL(MAknAliasKeyCodeResolver *)
IMPORT_C CEikStatusPane *StatusPane()
voidStopDisplayingPopupToolbar()
IMPORT_C CAknTouchPane *TouchPane()
Protected Member Functions
voidDecideWsClientBufferSizesL()
IMPORT_C voidHandleErrorL(TInt, HBufC **, TBool)
IMPORT_C voidHandleForegroundEventL(TBool)
IMPORT_C voidHandleStatusPaneSizeChange()
IMPORT_C voidHandleSystemEventL(const TWsEvent &)
IMPORT_C voidHandleWsEventL(const TWsEvent &, CCoeControl *)
IMPORT_C voidReserved_MtsmObject()
IMPORT_C voidReserved_MtsmPosition()
IMPORT_C voidSetKeyBlockMode(TAknKeyBlockMode)
Private Member Functions
TBool ExitHidesInBackgroundL()
TBool SimulateHashKeyMarkingEvent(const TWsEvent &)
voidUpdateKeyBlockMode()
Inherited Functions
CAknAppUiBase::ApplicationRect()const
CAknAppUiBase::ApplyLayoutChangeL(TBool)
CAknAppUiBase::CAknAppUiBase()
CAknAppUiBase::EventForForegroundState(TBool,TBool)
CAknAppUiBase::EventMonitor()const
CAknAppUiBase::Exit()
CAknAppUiBase::FindAppWgIdBelowMeL()
CAknAppUiBase::HandleApplicationSpecificEventL(TInt,const TWsEvent &)
CAknAppUiBase::HandleResourceChangeL(TInt)
CAknAppUiBase::HandleScreenDeviceChangedL()
CAknAppUiBase::HasFullOrPartialForeground()const
CAknAppUiBase::IsAppClosing()const
CAknAppUiBase::IsFaded()const
CAknAppUiBase::IsForeground()const
CAknAppUiBase::IsFullScreenApp()const
CAknAppUiBase::IsLayoutAwareApp()const
CAknAppUiBase::IsMSKEnabledApp()const
CAknAppUiBase::IsPartialForeground()const
CAknAppUiBase::IsSingleClickCompatible()const
CAknAppUiBase::IsTouchCompatible()const
CAknAppUiBase::KeySounds()const
CAknAppUiBase::LocalUiZoom()const
CAknAppUiBase::MopSupplyObject(TTypeUid)
CAknAppUiBase::Orientation()const
CAknAppUiBase::OrientationCanBeChanged()const
CAknAppUiBase::PointerEventModifier()
CAknAppUiBase::ReplaceKeySoundsL(TInt)
CAknAppUiBase::ScreenMode()const
CAknAppUiBase::SetFadedL(TBool)
CAknAppUiBase::SetFullScreenApp(TBool)
CAknAppUiBase::SetKeyEventFlags(const TInt)
CAknAppUiBase::SetLayoutAwareApp(TBool)
CAknAppUiBase::SetLocalUiZoom(TAknUiZoom)
CAknAppUiBase::SetOrientationL(TAppUiOrientation)
CAknAppUiBase::SetScreenModeL(TInt)
CAknAppUiBase::SimulateWsEventL(TInt)
CAknAppUiBase::ThreadIsForeground()const
CAknAppUiBase::~CAknAppUiBase()
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()
CCoeAppUi::ActivateTopViewL()
CCoeAppUi::ActivateViewL(const TVwsViewId &)
CCoeAppUi::ActivateViewL(const TVwsViewId &,TUid,const TDesC8 &)
CCoeAppUi::AddToStackL(CCoeControl *,TInt,TInt)
CCoeAppUi::AddToStackL(const MCoeView &,CCoeControl *,TInt,TInt)
CCoeAppUi::AddToViewStackL(const MCoeView &,CCoeControl *,TInt,TInt)
CCoeAppUi::AddViewActivationObserverL(MCoeViewActivationObserver *)
CCoeAppUi::AddViewDeactivationObserverL(MCoeViewDeactivationObserver *)
CCoeAppUi::AddViewObserverL(MCoeViewObserver *)
CCoeAppUi::AppHelpContextL()const
CCoeAppUi::CCoeAppUi()
CCoeAppUi::CheckInitializeViewsL(TUid)
CCoeAppUi::CheckSourceOfViewSwitchL(const TSecurityPolicy &,const char *)const
CCoeAppUi::ConstructL(CCoeAppUi *)
CCoeAppUi::CreateActivateViewEventL(const TVwsViewId &,TUid,const TDesC8 &)
CCoeAppUi::DeactivateActiveViewIfOwnerMatchL()
CCoeAppUi::DeactivateActiveViewL()
CCoeAppUi::DeregisterApplicationView()
CCoeAppUi::DeregisterView(const MCoeView &)
CCoeAppUi::DeregisterViewAndRemoveStack(const MCoeView &)
CCoeAppUi::EnableExternalViewSwitches(TBool)
CCoeAppUi::FrameworkCallsRendezvous()const
CCoeAppUi::GetActiveViewId(TVwsViewId &)const
CCoeAppUi::GetDefaultViewId(TVwsViewId &)const
CCoeAppUi::GetSystemDefaultViewL(TVwsViewId &)
CCoeAppUi::GetTopViewId(TVwsViewId &)const
CCoeAppUi::HandleStackChanged()
CCoeAppUi::HandleStackedControlsResourceChange(TInt)
CCoeAppUi::InputCapabilities()const
CCoeAppUi::IsControlOnStack(CCoeControl *)const
CCoeAppUi::IsDisplayingControlBetweenPriorities(TInt,TInt)const
CCoeAppUi::IsDisplayingDialog()const
CCoeAppUi::IsDisplayingMenuOrDialog()const
CCoeAppUi::IsViewConstructed(const TVwsViewId &)const
CCoeAppUi::MonitorWsEvent(const TWsEvent &)
CCoeAppUi::NotifyFontChange(const CCoeFontProvider &)
CCoeAppUi::NotifyNextActivation(MCoeViewActivationObserver &)
CCoeAppUi::NotifyNextActivation(const TVwsViewId &,MCoeViewActivationObserver &)
CCoeAppUi::NotifyNextDeactivation(MCoeViewDeactivationObserver &)
CCoeAppUi::NotifyNextDeactivation(const TVwsViewId &,MCoeViewDeactivationObserver &)
CCoeAppUi::RefetchPixelMappingL()
CCoeAppUi::RegisterApplicationViewL(TUid)
CCoeAppUi::RegisterViewAndAddStackL(MCoeView &)
CCoeAppUi::RegisterViewL(MCoeView &)
CCoeAppUi::RemoveFromStack(CCoeControl *)
CCoeAppUi::RemoveFromViewStack(const MCoeView &,CCoeControl *)
CCoeAppUi::RemoveViewActivationObserver(MCoeViewActivationObserver *)
CCoeAppUi::RemoveViewDeactivationObserver(MCoeViewDeactivationObserver *)
CCoeAppUi::RemoveViewObserver(MCoeViewObserver *)
CCoeAppUi::SetApplicationViewAsDefaultL()
CCoeAppUi::SetCurrentControlStackGroupId(TInt)
CCoeAppUi::SetCustomControl(TInt)
CCoeAppUi::SetDefaultViewL(const MCoeView &)
CCoeAppUi::SetSystemDefaultViewL(const TVwsViewId &)
CCoeAppUi::SetSystemDefaultViewL(const TVwsViewId &,TInt)
CCoeAppUi::SetWindowGroupOrdinal(TInt)
CCoeAppUi::TopFocusedControl()const
CCoeAppUi::UpdateStackedControlFlags(CCoeControl *,TInt,TInt)
CCoeAppUi::UpdateViewServerBackgroundColor(const TRgb &)
CCoeAppUi::UpdateViewStackedControlFlags(const MCoeView &,CCoeControl *,TInt,TInt)
CCoeAppUi::WriteInternalStateOfStackedControlsL(RWriteStream &)const
CCoeAppUi::~CCoeAppUi()
CEikAppUi::AppUiExtra()
CEikAppUi::Application()const
CEikAppUi::ApplicationLanguageL()const
CEikAppUi::CEikAppUi()
CEikAppUi::ClientRect()const
CEikAppUi::ClosePopup()
CEikAppUi::ContainerAppUi()const
CEikAppUi::CreateFileL(const TDesC &)
CEikAppUi::CreateHotKeyControlL(TInt)
CEikAppUi::Document()const
CEikAppUi::FadeWhenInBackground()
CEikAppUi::HandleCommandL(TInt)
CEikAppUi::HandleMessageL(TUint32,TUid,const TDesC8 &)
CEikAppUi::HandleModelChangeL()
CEikAppUi::HandleSideBarMenuL(TInt,const TPoint &,TInt,const CEikHotKeyTable *)
CEikAppUi::LaunchPopupMenuL(TInt,const TPoint &,TPopupTargetPosType,const CEikHotKeyTable *)
CEikAppUi::MopNext()
CEikAppUi::OpenFileL(const TDesC &)
CEikAppUi::ProcessCommandParametersL(CApaCommandLine &)
CEikAppUi::ProcessCommandParametersL(TApaCommand,TFileName &)
CEikAppUi::ProcessCommandParametersL(TApaCommand,TFileName &,const TDesC8 &)
CEikAppUi::ProcessMessageL(TUid,const TDesC8 &)
CEikAppUi::ReadAppInfoResourceL(TInt)
CEikAppUi::ReportResourceChangedToAppL(TInt)
CEikAppUi::ReportResourceChangedToAppStackL(CEikAppUi *,TInt)
CEikAppUi::SaveAnyChangesL()
CEikAppUi::SaveL()
CEikAppUi::SetDocChanged()
CEikAppUi::SetDocument(CEikDocument *)
CEikAppUi::SetEmbeddedDocInfo(MApaEmbeddedDocObserver *,TBool)
CEikAppUi::SetFaded(TBool)
CEikAppUi::StopDisplayingMenuBar()
CEikAppUi::~CEikAppUi()
Inherited Enumerations
CAknAppUiBase:@169
CAknAppUiBase:TAppUiOrientation
CAknAppUiBase:TKeyEventFlag
CEikAppUi:@154
Private Attributes
CAknAppShutter *iAppShutter
TAknKeyBlockMode iBlockMode
TBool iDumpNextControl
CAknAppUiExtension *iExtension
Inherited Attributes
CCoeAppUi::iCoeEnv
CEikAppUi::iContainerAppUi
CEikAppUi::iDocument
CEikAppUi::iDoorObserver
CEikAppUi::iEmbeddedAndReadOnly
CEikAppUi::iFlags

Constructor & Destructor Documentation

~CAknAppUi()

IMPORT_C~CAknAppUi()

Destructor.

Member Functions Documentation

BaseConstructL(TInt)

IMPORT_C voidBaseConstructL(TIntaAppUiFlags = EStandardApp)

Initialises this Avkon app UI with standard values. aAppUiFlags values are common with CEikAppUi::BaseConstructL(aAppUiFlags). Additionally those aAppUiFlags values can be bitwise ORed with EAknEnableSkin flag to provide default skin parameters for this AppUi instance.

Parameters

TInt aAppUiFlags = EStandardAppApplication user interface flags.

CaptureKey(TUint, TUint, TUint)

IMPORT_C TInt32CaptureKey(TUintaKeycode,
TUintaModifierMask,
TUintaModifier
)

This is same as RWindowGroup::CaptureKey, except that this version takes S60 keymappings into account and captures the key that produces requested aKeyCode according to S60 keymappings. Standard RWindowgroup::CaptureKey functionality takes place before S60 AppUi framework and has no knowledge of S60 keymappings. Note: This method requires same capabilites as RWindowGroup::CaptureKey()

S60 V3.2

A handle identifying the capture key, or one of the system-wide error codes (if <0). Handles should be kept in order to be passed to CancelCaptureKey() later.

Parameters

TUint aKeycodeThe key code for the key to be captured. Key codes for special keys are defined in TKeyCode.
TUint aModifierMask
TUint aModifierThe key is captured only when the modifier keys specified in aModifierMask match these states, where 1=modifier set, and 0=modifier not set. Modifier key states are defined in TEventModifier.

CaptureKeyL(TUint, TUint, TUint, TInt32 &)

IMPORT_C voidCaptureKeyL(TUintaKeycode,
TUintaModifierMask,
TUintaModifier,
TInt32 &aHandle
)

This is same as RWindowGroup::CaptureKey, except that this version takes S60 keymappings into account and captures the key that produces requested aKeyCode according to S60 keymappings. This version leaves instead of returning an error code. Standard RWindowgroup::CaptureKey functionality takes place before S60 AppUi framework and has no knowledge of S60 keymappings. Note: This method requires same capabilites as RWindowGroup::CaptureKey()

S60 V3.2

Parameters

TUint aKeycodeThe key code for the key to be captured. Key codes for special keys are defined in TKeyCode.
TUint aModifierMask
TUint aModifierThe key is captured only when the modifier keys specified in aModifierMask match these states, where 1=modifier set, and 0=modifier not set. Modifier key states are defined in TEventModifier.
TInt32 & aHandleidentifying the capture key. Handles should be kept in order to be passed to CancelCaptureKey() later.

Cba()

IMPORT_C CEikButtonGroupContainer *Cba()

Gets a pointer to the Command Button Area. Pointer to the CBA

ConstructL()

IMPORT_C voidConstructL()[virtual]

From CEikAppUi. Completes construction. The implementation of ConstructL() in CAknAppUi simply calls BaseConstructL().

CurrentFixedToolbar()

IMPORT_C CAknToolbar *CurrentFixedToolbar()const

Gets a pointer to the current fixed toolbar( view toolbar is priority ). Pointer to the current fixed toolbar or NULL

S60 5.0

CurrentPopupToolbar()

IMPORT_C CAknToolbar *CurrentPopupToolbar()const

Gets a pointer to the current toolbar( view toolbar is priority ). Pointer to the current toolbar or NULL

S60 3.1

DecideWsClientBufferSizesL()

voidDecideWsClientBufferSizesL()[protected]

Try to set window server buffer size to KAknDefaultWsBufferSize.

DisableNextKeySound(TInt)

IMPORT_C voidDisableNextKeySound(TIntaScanCode)

Disables next key sound (and repeated key sounds until pointer up event).

S60 V5.0

Parameters

TInt aScanCodeScan code of disabled key.

ExitHidesInBackground()

IMPORT_C TBoolExitHidesInBackground()const

This tells the application if it is allowed to hide itself in the background in response to a user (menu or softkey) exit command, instead of actually exiting. If the application appears to exit, but actually leaves itself in memory, it may appear to start faster next time the user activates it.

S60 V5.0

ETrue if the application can hide itself in the background, EFalse if it must exit properly by calling Exit().

ExitHidesInBackgroundL()

TBool ExitHidesInBackgroundL()const [private]

GetAliasKeyCodeL(TUint &, const TKeyEvent &, TEventCode)

IMPORT_C voidGetAliasKeyCodeL(TUint &aCode,
const TKeyEvent &aKeyEvent,
TEventCodeaType
)

Gets keyboard layout specific keycode. Uses given resolver SetAliasKeyCodeResolverL() if set, by default fetches alternative code from avkon server.

S60 3.1

Parameters

TUint & aCodereference to variable to contain new keycode
const TKeyEvent & aKeyEventreference to original, complete, event
TEventCode aTypeindicating original event type

HandleError(TInt, const SExtendedError &, TDes &, TDes &)

IMPORT_C TErrorHandlerResponseHandleError(TIntaError,
const SExtendedError &aExtErr,
TDes &aErrorText,
TDes &aContextText
)[virtual]

Handles errors. ENoDisplay if Error handled proper way, else EErrorNotHandled

Parameters

TInt aErrorThe error code.
const SExtendedError & aExtErrFor extended error messages. Not used.
TDes & aErrorTextError text. Not used.
TDes & aContextTextText describing the context of the error. Not used.

HandleErrorL(TInt, HBufC **, TBool)

IMPORT_C voidHandleErrorL(TIntaError,
HBufC **aErrorDesc,
TBoolaShowNote = ETrue
)[protected]

Parameters

TInt aError
HBufC ** aErrorDesc
TBool aShowNote = ETrue

HandleForegroundEventL(TBool)

IMPORT_C voidHandleForegroundEventL(TBoolaForeground)[protected, virtual]

Handles changes in keyboard focus when an application switches to, or from, the foreground.

Parameters

TBool aForegroundETrue if the application is in the foreground, otherwise EFalse.

HandleStatusPaneSizeChange()

IMPORT_C voidHandleStatusPaneSizeChange()[protected]

From MEikStatusPaneObserver. Handles a change in the position or size of the screen area occupied by the status pane.

HandleSystemEventL(const TWsEvent &)

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

From CCoeAppUi. Handles system events generated by the window server.

Parameters

const TWsEvent & aEventThe window server event that occurred.

HandleTouchPaneSizeChange()

IMPORT_C voidHandleTouchPaneSizeChange()

From . Handles a change in the size or position of touch pane.

HandleViewDeactivation(const TVwsViewId &, const TVwsViewId &)

IMPORT_C voidHandleViewDeactivation(const TVwsViewId &aViewIdToBeDeactivated,
const TVwsViewId &aNewlyActivatedViewId
)[virtual]

From MCoeViewDeactivationObserver. Handles the deactivation of the view identified by aViewIdToBeDeactivated before the newly activated view with id aNewlyActivatedViewId is marked as current. Default implementation calls iAvkonEnv->CloseAllIntermediateStates() without using aViewIdToBeDeactivated and aNewlyActivatedViewId.

Parameters

const TVwsViewId & aViewIdToBeDeactivated
const TVwsViewId & aNewlyActivatedViewId

HandleWsEventL(const TWsEvent &, CCoeControl *)

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

Handles window server events.

Parameters

const TWsEvent & aEventThe window server event that occurred.
CCoeControl * aDestinationThe control associated with the event.

HideApplicationFromFSW(TBool)

IMPORT_C voidHideApplicationFromFSW(TBoolaHide = ETrue)

Hide application from Fast-swap window. S60 2.6

Parameters

TBool aHide = ETrueETrue if application is hided from Fast-swap window, otherwise EFalse

HideInBackground()

IMPORT_C voidHideInBackground()

Hide the running instance of this application from the user, which makes it appear as if the application has exited. This is done by placing the application in the background, behind all other apps, and removing the application from the Fast Swap Window. When the application comes to the foreground again, it will be restored to the Fast Swap Window (in HandleForegroundEventL). If the application is not supposed to be in the Fast Swap Window, it will have to remove itself again. S60 V5.0

IsAppHiddenInBackground()

TBool IsAppHiddenInBackground()const

Determines whether the application is hidden in background. (i.e. HideInBackground has been called and application has not yet been activated) ETrue if application is hidden in background.

IsAppShutterRunning()

IMPORT_C TBoolIsAppShutterRunning()const

Determines whether the application shutter is active. ETrue if application shutter is active.

PopupToolbar()

IMPORT_C CAknToolbar *PopupToolbar()const

Gets a pointer to the application toolbar. Pointer to the applicaton toolbar or NULL

S60 3.1

PrepareToExit()

IMPORT_C voidPrepareToExit()[virtual]

From CCoeAppUiBase. Performs pre-exit processing to ensure the application will exit cleanly.

ProcessCommandL(TInt)

IMPORT_C voidProcessCommandL(TIntaCommand)

Processes user commands. This function passes aCommand (except values EAknSoftkeyOptions, EAknCmdExit, EEikCmdCanceled) to user derived HandleCommandL.

Parameters

TInt aCommandA command ID.

Reserved_MtsmObject()

IMPORT_C voidReserved_MtsmObject()[protected, virtual]

Reserved_MtsmPosition()

IMPORT_C voidReserved_MtsmPosition()[protected, virtual]

RunAppShutter()

IMPORT_C voidRunAppShutter()

Run the application shutter if it exists.

SetAliasKeyCodeResolverL(MAknAliasKeyCodeResolver *)

IMPORT_C voidSetAliasKeyCodeResolverL(MAknAliasKeyCodeResolver *aResolver)

Sets custom resolver for keycode aliases Creates iExtension if it doesn't exist S60 3.1

Parameters

MAknAliasKeyCodeResolver * aResolver

SetKeyBlockMode(TAknKeyBlockMode)

IMPORT_C voidSetKeyBlockMode(TAknKeyBlockModeaMode)[protected]

Set key block mode. In default mode, the S60 Developer Platform blocks simultaneous key presses.

Parameters

TAknKeyBlockMode aModeENoKeyBlock if no key block, otherwise EDefaultBlockMode

SimulateHashKeyMarkingEvent(const TWsEvent &)

TBool SimulateHashKeyMarkingEvent(const TWsEvent &aEvent)[private]

Parameters

const TWsEvent & aEvent

StatusPane()

IMPORT_C CEikStatusPane *StatusPane()

Gets a pointer to the status pane. Pointer to the status pane

StopDisplayingPopupToolbar()

voidStopDisplayingPopupToolbar()

Hides popup toolbar if it is visible S60 3.1

TouchPane()

IMPORT_C CAknTouchPane *TouchPane()

Gets a pointer to the touch pane. Pointer to the the touch pane

S60 5.0

UpdateKeyBlockMode()

voidUpdateKeyBlockMode()[private]

Member Data Documentation

CAknAppShutter * iAppShutter

CAknAppShutter *iAppShutter[private]

TAknKeyBlockMode iBlockMode

TAknKeyBlockMode iBlockMode[private]

TBool iDumpNextControl

TBool iDumpNextControl[private]

CAknAppUiExtension * iExtension

CAknAppUiExtension *iExtension[private]