CAknAppUiBase Class Reference

class CAknAppUiBase : public CEikAppUi

Abstract Avkon application UI base class

S60 3.0

Inherits from

Public Member Functions
CAknAppUiBase()
~CAknAppUiBase()
IMPORT_C TRectApplicationRect()
IMPORT_C voidApplyLayoutChangeL(TBool)
IMPORT_C voidBaseConstructL(TInt)
IMPORT_C voidConstructL()
TInt EventForForegroundState(TBool, TBool)
IMPORT_C CAknWsEventMonitor *EventMonitor()
IMPORT_C voidExit()
TInt FindAppWgIdBelowMeL()
IMPORT_C voidHandleForegroundEventL(TBool)
IMPORT_C voidHandleResourceChangeL(TInt)
TBool HasFullOrPartialForeground()
TBool IsAppClosing()
IMPORT_C TBoolIsFaded()
IMPORT_C TBoolIsForeground()
IMPORT_C TBoolIsFullScreenApp()
IMPORT_C TBoolIsLayoutAwareApp()
TBool IsMSKEnabledApp()
IMPORT_C TBoolIsPartialForeground()
IMPORT_C TBoolIsSingleClickCompatible()
IMPORT_C TBoolIsTouchCompatible()
IMPORT_C CAknKeySoundSystem *KeySounds()
IMPORT_C TAknUiZoomLocalUiZoom()
IMPORT_C TAppUiOrientationOrientation()
IMPORT_C TBoolOrientationCanBeChanged()
IMPORT_C CAknPointerEventModifier *PointerEventModifier()
IMPORT_C voidPrepareToExit()
TInt ScreenMode()
IMPORT_C voidSetFadedL(TBool)
IMPORT_C voidSetKeyEventFlags(const TInt)
IMPORT_C voidSetLayoutAwareApp(TBool)
IMPORT_C voidSetLocalUiZoom(TAknUiZoom)
IMPORT_C voidSetOrientationL(TAppUiOrientation)
voidSetScreenModeL(TInt)
voidSimulateWsEventL(TInt)
TBool ThreadIsForeground()
Protected Member Functions
IMPORT_C voidHandleApplicationSpecificEventL(TInt, const TWsEvent &)
IMPORT_C voidHandleScreenDeviceChangedL()
IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUid)
IMPORT_C voidReplaceKeySoundsL(TInt)
IMPORT_C voidSetFullScreenApp(TBool)
Private Member Functions
TBool AlwaysForwardEvent(TInt)
voidRelinquishPriorityToForegroundAppLC()
voidSetAppUiAndLeaveIfErrorL(TInt)
voidUpdateSettingCacheAndForwardEventL(TInt)
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()
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::HandleError(TInt,const SExtendedError &,TDes &,TDes &)
CEikAppUi::HandleMessageL(TUint32,TUid,const TDesC8 &)
CEikAppUi::HandleModelChangeL()
CEikAppUi::HandleSideBarMenuL(TInt,const TPoint &,TInt,const CEikHotKeyTable *)
CEikAppUi::HandleSystemEventL(const TWsEvent &)
CEikAppUi::HandleWsEventL(const TWsEvent &,CCoeControl *)
CEikAppUi::LaunchPopupMenuL(TInt,const TPoint &,TPopupTargetPosType,const CEikHotKeyTable *)
CEikAppUi::MopNext()
CEikAppUi::OpenFileL(const TDesC &)
CEikAppUi::ProcessCommandL(TInt)
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()
Public Member Enumerations
enumanonymous {
EAknEnableSkin = EAknEnableSkinFlag, EAppOrientationPortrait = EAppOrientationSpecifiedFlag, EAppOrientationLandscape = EAppOrientationSpecifiedFlag | EAppOrientationLandscapeFlag, EAppOrientationAutomatic = EAppOrientationSpecifiedFlag | EAppOrientationAutomaticFlag, EAknDisableHighlightAnimation = EAknDisableHighlightAnimationFlag, EAknEnableMSK = EAknEnableMSKflag, EAknExplicitStartupEffectCompletion = EAknExplicitStartupEffectCompletionFlag, EAknTouchCompatible = EAknTouchCompatibleFlag, EAknSingleClickCompatible = EAknSingleClickCompatibleFlag
}
enumTAppUiOrientation { EAppUiOrientationUnspecified, EAppUiOrientationPortrait, EAppUiOrientationLandscape, EAppUiOrientationAutomatic }
enumTKeyEventFlag { EDisableSendKeyShort = 0x01, EDisableSendKeyLong = 0x02 }
Private Member Enumerations
enumanonymous {
EAppOrientationSpecifiedFlag = 0x00010000, EAppOrientationLandscapeFlag = 0x00020000, EAppOrientationAutomaticFlag = 0x00040000, EAknEnableSkinFlag = 0x00080000, EAknDisableHighlightAnimationFlag = 0x00100000, EAknEnableMSKflag = 0x00200000, EAknExplicitStartupEffectCompletionFlag = 0x00400000, EAknTouchCompatibleFlag = 0x00800000, EAknSingleClickCompatibleFlag = 0x01000000
}
Inherited Enumerations
CEikAppUi:@154
Private Attributes
TBitFlags iAknFlags
CAknAppUiBaseExtension *iAppUiBaseExtension
CAknWsEventMonitor *iEventMonitor
CAknKeySoundSystem *iKeySounds
Inherited Attributes
CCoeAppUi::iCoeEnv
CEikAppUi::iContainerAppUi
CEikAppUi::iDocument
CEikAppUi::iDoorObserver
CEikAppUi::iEmbeddedAndReadOnly
CEikAppUi::iFlags

Constructor & Destructor Documentation

CAknAppUiBase()

IMPORT_CCAknAppUiBase()

C++ Default constructor.

~CAknAppUiBase()

IMPORT_C~CAknAppUiBase()

Destructor.

Member Functions Documentation

AlwaysForwardEvent(TInt)

TBool AlwaysForwardEvent(TIntaEventId)[private]

Parameters

TInt aEventId

ApplicationRect()

IMPORT_C TRectApplicationRect()const [virtual]

From CEikAppUi. Gets the total area of the screen available to the application. This includes the space that is available for a toolbar, toolband or title band, if the application requires them. The total area of the screen available to the application.

ApplyLayoutChangeL(TBool)

IMPORT_C voidApplyLayoutChangeL(TBoolaReportChange)

Parameters

TBool aReportChange

BaseConstructL(TInt)

IMPORT_C voidBaseConstructL(TIntaAppUiFlags)

Initialises this Avkon base app UI with standard values. aAppUiFlags values are common with CEikAppUi::BaseConstructL(aAppUiFlags).

Parameters

TInt aAppUiFlagsApplication user interface flags.

ConstructL()

IMPORT_C voidConstructL()[virtual]

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

EventForForegroundState(TBool, TBool)

TInt EventForForegroundState(TBoolaPartialFg,
TBoolaForeground
)

Simply return KEikPartialForeground if aPartialFg == ETrue, otherwise if aForeground == ETrue then return EEventFocusGained else return EEventFocusLost. if aPartialFg then return KEikPartialForeground.

Parameters

TBool aPartialFg
TBool aForeground

EventMonitor()

IMPORT_C CAknWsEventMonitor *EventMonitor()const

Returns the object which allows events to be spyed upon in addition to normal event handling. Pointer to window server event monitor object.

Exit()

IMPORT_C voidExit()[virtual]

From CEikAppUi. Closes the app UI.

FindAppWgIdBelowMeL()

TInt FindAppWgIdBelowMeL()

Find the window group ID of the application below this application. the window group ID of the application below this application.

HandleApplicationSpecificEventL(TInt, const TWsEvent &)

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

From CCoeAppUi. Handles an application specific event.

Parameters

TInt aTypeThe type of the event that occurred. This should be a unique identifier constant.
const TWsEvent & aEventThe window server event that occurred.

HandleForegroundEventL(TBool)

IMPORT_C voidHandleForegroundEventL(TBoolaForeground)[virtual]

Handles changes in keyboard focus when an application switches to, or from, the foreground. This function calls CEikAppUi::HandleForegroundEventL.

Parameters

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

HandleResourceChangeL(TInt)

IMPORT_C voidHandleResourceChangeL(TIntaType)[virtual]

From CEikAppUi. Handles a change to the application's resources which are shared across the environment. This function calls CEikAppUi::HandleResourceChangeL except when aType is KEikDynamicLayoutVariantSwitch.

Parameters

TInt aTypeThe type of resources that have changed.

HandleScreenDeviceChangedL()

IMPORT_C voidHandleScreenDeviceChangedL()[protected, virtual]

From CCoeAppUiBase. Calls CCoeAppUi::HandleScreenDeviceChangedL().

HasFullOrPartialForeground()

TBool HasFullOrPartialForeground()const

Checks if application UI has full or partial foreground status. 3.2

ETrue if application UI has full or partial foreground status. Otherwise EFalse.

IsAppClosing()

TBool IsAppClosing()const

Determines whether the application is closing. In practice this means that CEikonEnv has been destroyed. ETrue if the application is closing.

3.2

IsFaded()

IMPORT_C TBoolIsFaded()const

Determines whether the system is faded. ETrue if system is faded

IsForeground()

IMPORT_C TBoolIsForeground()const

Determines whether the application is foreground. ETrue if the application is foreground.

IsFullScreenApp()

IMPORT_C TBoolIsFullScreenApp()const

Determines whether the application is full screen application. ETrue if the application is full screen application.

IsLayoutAwareApp()

IMPORT_C TBoolIsLayoutAwareApp()const

Determines whether the application is layout aware. ETrue if the application is layout aware.

IsMSKEnabledApp()

TBool IsMSKEnabledApp()const

Determines whether the application has MSK enabled. ETrue if the application has MSK enabled.

3.1

IsPartialForeground()

IMPORT_C TBoolIsPartialForeground()const

Determines whether the application is partially foreground. ETrue if the application is partially foreground.

IsSingleClickCompatible()

IMPORT_C TBoolIsSingleClickCompatible()const

Checks if the application is single click compatible i.e. it has been constructed with the flag EAknSingleClickCompatible.

S60 v5.0

ETrue if the application is single click compatible

IsTouchCompatible()

IMPORT_C TBoolIsTouchCompatible()const

Checks if the application is touch compatible i.e. it has been constructed with the flag EAknTouchCompatible.

S60 v5.0

ETrue if the application is touch compatible

KeySounds()

IMPORT_C CAknKeySoundSystem *KeySounds()const

Gets a pointer to KeySound API object. Pointer to KeySound API object.

LocalUiZoom()

IMPORT_C TAknUiZoomLocalUiZoom()const

Gets the application local zoom Application local zoom

3.1

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUidaId)[protected, virtual]

Parameters

TTypeUid aId

Orientation()

IMPORT_C TAppUiOrientationOrientation()const

Gets the application screen orientation. Application screen orientation.

OrientationCanBeChanged()

IMPORT_C TBoolOrientationCanBeChanged()const

Tests whether it is possible for this app to have a practical effect on the screen orientation, through SetOrientationL(). S60 3.2

ETrue if SetOrientationL can change the orientation, EFalse otherwise.

PointerEventModifier()

IMPORT_C CAknPointerEventModifier *PointerEventModifier()

Returns a pointer to appui's pointer event modifier. This method is intended for internal usage only.

S60 v5.0

pointer event modifier

PrepareToExit()

IMPORT_C voidPrepareToExit()[virtual]

From CCoeAppUiBase. Performs pre-exit processing by calling CEikAppUi::PrepareToExit() to ensure the application will exit cleanly.

RelinquishPriorityToForegroundAppLC()

voidRelinquishPriorityToForegroundAppLC()[private]

ReplaceKeySoundsL(TInt)

IMPORT_C voidReplaceKeySoundsL(TIntaUid)[protected]

Replace current key sound server with new one.

Parameters

TInt aUidID of the new key sound server.

ScreenMode()

TInt ScreenMode()const

SetAppUiAndLeaveIfErrorL(TInt)

voidSetAppUiAndLeaveIfErrorL(TIntaError)[private]

Parameters

TInt aError

SetFadedL(TBool)

IMPORT_C voidSetFadedL(TBoolaFaded)[virtual]

From CEikAppUi. Sets whether the windows are faded.

Parameters

TBool aFadedETrue if windows are faded, otherwise windows are unfaded.

SetFullScreenApp(TBool)

IMPORT_C voidSetFullScreenApp(TBoolaIsFullScreen)[protected]

Set the application to be a full screen application.

Parameters

TBool aIsFullScreenis ETrue if the application is a full screen application, EFlase otherwise.

SetKeyEventFlags(const TInt)

IMPORT_C voidSetKeyEventFlags(const TIntaFlags)

Sets the flags for default key event handling 5.0

Parameters

const TInt aFlagswhich can be a combination of flags declared in enumeration TKeyEventFlag

SetLayoutAwareApp(TBool)

IMPORT_C voidSetLayoutAwareApp(TBoolaLayoutAwareApp)

Set application layout aware.

Parameters

TBool aLayoutAwareAppETrue if the application is layout aware, EFlase otherwise.

SetLocalUiZoom(TAknUiZoom)

IMPORT_C voidSetLocalUiZoom(TAknUiZoomaZoom)

Sets the application local zoom. However, in order to have any effect, it may be necessary to make a subsequent call to ApplyLayoutChangeL.

3.1

Parameters

TAknUiZoom aZoomapplication local zoom

SetOrientationL(TAppUiOrientation)

IMPORT_C voidSetOrientationL(TAppUiOrientationaOrientation)

Sets the application screen orientation. Note: this API has no effect on non-full-screen app UIs.

Parameters

TAppUiOrientation aOrientationapplication screen orientation.

SetScreenModeL(TInt)

voidSetScreenModeL(TIntaModeNumber)

Parameters

TInt aModeNumber

SimulateWsEventL(TInt)

voidSimulateWsEventL(TIntaEvent)

Simulates an event being received from wserv

Parameters

TInt aEventthe event id being simulated.

ThreadIsForeground()

TBool ThreadIsForeground()const

Determines whether the thread owning this application window group is foreground. ETrue if the thread owning this application window group is foreground, EFlase otherwise.

UpdateSettingCacheAndForwardEventL(TInt)

voidUpdateSettingCacheAndForwardEventL(TIntaEventId)[private]

Parameters

TInt aEventId

Member Enumerations Documentation

Enum anonymous

Enumerators

EAppOrientationSpecifiedFlag = 0x00010000
EAppOrientationLandscapeFlag = 0x00020000
EAppOrientationAutomaticFlag = 0x00040000
EAknEnableSkinFlag = 0x00080000
EAknDisableHighlightAnimationFlag = 0x00100000
EAknEnableMSKflag = 0x00200000
EAknExplicitStartupEffectCompletionFlag = 0x00400000

When enabled, avkon does not complete startup effect application has to do it by itself.

S60 3.2

EAknTouchCompatibleFlag = 0x00800000

Application supports touch (doesn't need keyboard). If the flag is missing and compatibility mode is enabled in a device, application is run in a compatibility mode (QVGA window with a virtual keypad.

S60 5.0

EAknSingleClickCompatibleFlag = 0x01000000

Application supports single click.

S60 5.2

Enum anonymous

Enumerators

EAknEnableSkin = EAknEnableSkinFlag

Flag indicating that default skin parameters should be provided by UI controls created within the scope of this AppUi instance. This value (or binary combination with some other values) should be given as a parameter to BaseConstructL in case the application wants to enable default skin parameters for all the Avkon controls supporting them.

Note: The value can be queried by using AknsUtils::AvkonSkinEnabled() from AknSkins.lib.

S60 2.0

EAppOrientationPortrait = EAppOrientationSpecifiedFlag
EAppOrientationLandscape = EAppOrientationSpecifiedFlag | EAppOrientationLandscapeFlag
EAppOrientationAutomatic = EAppOrientationSpecifiedFlag | EAppOrientationAutomaticFlag
EAknDisableHighlightAnimation = EAknDisableHighlightAnimationFlag
EAknEnableMSK = EAknEnableMSKflag
EAknExplicitStartupEffectCompletion = EAknExplicitStartupEffectCompletionFlag
EAknTouchCompatible = EAknTouchCompatibleFlag
EAknSingleClickCompatible = EAknSingleClickCompatibleFlag

Enum TAppUiOrientation

Enumerators

EAppUiOrientationUnspecified

Use the default device screen rotation of the product for this application. This is the default rotation setting for an application, and it should be used by nearly all applications.

EAppUiOrientationPortrait

Use a portrait screen rotation for this application. This should only be used when an application specifically wants portrait rotation. The device will select an appropriate portrait rotation, if one is available.

EAppUiOrientationLandscape

Use a landscape screen rotation for this application. This should only be used when an application specifically wants landscape rotation. The device will select an appropriate landscape rotation, if one is available.

EAppUiOrientationAutomatic

Use the normal device screen rotation for this application. Both portrait and landscape screen rotations are possible. The application rotation follows device screen rotation.

Enum TKeyEventFlag

Enumerators

EDisableSendKeyShort = 0x01
EDisableSendKeyLong = 0x02

Member Data Documentation

TBitFlags iAknFlags

TBitFlags iAknFlags[private]

CAknAppUiBaseExtension * iAppUiBaseExtension

CAknAppUiBaseExtension *iAppUiBaseExtension[private]

CAknWsEventMonitor * iEventMonitor

CAknWsEventMonitor *iEventMonitor[private]

CAknKeySoundSystem * iKeySounds

CAknKeySoundSystem *iKeySounds[private]