CAknAppUiBase Class Reference

#include <mw/aknappui.h>

Link against: glxcommoncommandhandlers.lib

class CAknAppUiBase : public CEikAppUi

Inherits from

CAknAppUiBase

Public Member Enumerations
enum	anonymous { EAknEnableSkin, EAppOrientationPortrait, EAppOrientationLandscape, EAppOrientationAutomatic, ..., EAknDisableAnimationBackground }
enum	TAppUiOrientation { EAppUiOrientationUnspecified, EAppUiOrientationPortrait, EAppUiOrientationLandscape, EAppUiOrientationAutomatic }
enum	TKeyEventFlag { EDisableSendKeyShort, EDisableSendKeyLong }

Public Member Functions
	CAknAppUiBase()
	~CAknAppUiBase()
virtual IMPORT_C TRect	ApplicationRect()
IMPORT_C void	ApplyLayoutChangeL(TBool)
IMPORT_C void	BaseConstructL(TInt)
virtual IMPORT_C void	ConstructL()
TInt	EventForForegroundState(TBool, TBool)
IMPORT_C CAknWsEventMonitor *	EventMonitor()
virtual IMPORT_C void	Exit()
TInt	FindAppWgIdBelowMeL()
virtual IMPORT_C void	HandleForegroundEventL(TBool)
virtual IMPORT_C void	HandleResourceChangeL(TInt)
TBool	HasFullOrPartialForeground()
TBool	IsAppClosing()
IMPORT_C TBool	IsFaded()
IMPORT_C TBool	IsForeground()
IMPORT_C TBool	IsFullScreenApp()
IMPORT_C TBool	IsLayoutAwareApp()
TBool	IsMSKEnabledApp()
IMPORT_C TBool	IsPartialForeground()
IMPORT_C TBool	IsSingleClickCompatible()
IMPORT_C TBool	IsTouchCompatible()
IMPORT_C CAknKeySoundSystem *	KeySounds()
IMPORT_C TAknUiZoom	LocalUiZoom()
IMPORT_C TAppUiOrientation	Orientation()
IMPORT_C TBool	OrientationCanBeChanged()
IMPORT_C CAknPointerEventModifier *	PointerEventModifier()
virtual IMPORT_C void	PrepareToExit()
TInt	ScreenMode()
virtual IMPORT_C void	SetFadedL(TBool)
IMPORT_C void	SetKeyEventFlags(const TInt)
IMPORT_C void	SetLayoutAwareApp(TBool)
IMPORT_C void	SetLocalUiZoom(TAknUiZoom)
IMPORT_C void	SetOrientationL(TAppUiOrientation)
void	SetScreenModeL(TInt)
void	SimulateWsEventL(TInt)
TBool	ThreadIsForeground()

Protected Member Functions
virtual IMPORT_C void	HandleApplicationSpecificEventL(TInt, const TWsEvent &)
virtual IMPORT_C void	HandleScreenDeviceChangedL()
virtual IMPORT_C TTypeUid::Ptr	MopSupplyObject(TTypeUid)
IMPORT_C void	ReplaceKeySoundsL(TInt)
IMPORT_C void	SetFullScreenApp(TBool)

Inherited Attributes
	CCoeAppUi::iCoeEnv
	CEikAppUi::iContainerAppUi
	CEikAppUi::iDocument
	CEikAppUi::iDoorObserver
	CEikAppUi::iEmbeddedAndReadOnly
	CEikAppUi::iFlags

Inherited Enumerations
	CEikAppUi:@157

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

Detailed Description

Abstract Avkon application UI base class

Since: S60 3.0

Member Enumeration Documentation

Enum anonymous

Enumerator	Value	Description
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. Since S60 2.0
EAppOrientationPortrait	EAppOrientationSpecifiedFlag
EAppOrientationLandscape	EAppOrientationSpecifiedFlag \| EAppOrientationLandscapeFlag
EAppOrientationAutomatic	EAppOrientationSpecifiedFlag \| EAppOrientationAutomaticFlag
EAknDisableHighlightAnimation	EAknDisableHighlightAnimationFlag
EAknEnableMSK	EAknEnableMSKflag
EAknExplicitStartupEffectCompletion	EAknExplicitStartupEffectCompletionFlag
EAknTouchCompatible	EAknTouchCompatibleFlag
EAknSingleClickCompatible	EAknSingleClickCompatibleFlag
EAknDisableAnimationBackground	EAknDisableAnimationBackgroundFlag

Enum TAppUiOrientation

Enumerator	Value	Description
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

Enumerator	Value	Description
EDisableSendKeyShort	0x01
EDisableSendKeyLong	0x02

Constructor & Destructor Documentation

CAknAppUiBase ( )

IMPORT_C

CAknAppUiBase

(

)

C++ Default constructor.

~CAknAppUiBase ( )

IMPORT_C

~CAknAppUiBase

(

)

Destructor.

Member Function Documentation

ApplicationRect ( )

IMPORT_C TRect

ApplicationRect

(

)

const [virtual]

Reimplemented from CEikAppUi::ApplicationRect()const

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.

Returns: The total area of the screen available to the application.

ApplyLayoutChangeL ( TBool )

IMPORT_C void

ApplyLayoutChangeL

(

TBool

aReportChange

)

BaseConstructL ( TInt )

IMPORT_C void

BaseConstructL

(

TInt

aAppUiFlags

)

Reimplemented from CEikAppUi::BaseConstructL(TInt)

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

Parameter	Description
aAppUiFlags	Application user interface flags.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[virtual]

Reimplemented from CEikAppUi::ConstructL()

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

EventForForegroundState ( TBool, TBool )

TInt	EventForForegroundState	(	TBool	aPartialFg,
			TBool	aForeground
		)

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

Returns: if aPartialFg then return KEikPartialForeground.

EventMonitor ( )

IMPORT_C CAknWsEventMonitor *

EventMonitor

(

)

const

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

Returns: Pointer to window server event monitor object.

Exit ( )

IMPORT_C void

Exit

(

)

[virtual]

Reimplemented from CEikAppUi::Exit()

From CEikAppUi. Closes the app UI.

FindAppWgIdBelowMeL ( )

TInt

FindAppWgIdBelowMeL

(

)

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

Returns: the window group ID of the application below this application.

HandleApplicationSpecificEventL ( TInt, const TWsEvent & )

IMPORT_C void	HandleApplicationSpecificEventL	(	TInt	aType,
			const TWsEvent &	aEvent
		)	[protected, virtual]

Reimplemented from CEikAppUi::HandleApplicationSpecificEventL(TInt,const TWsEvent &)

From CCoeAppUi. Handles an application specific event.

Parameter	Description
aType	The type of the event that occurred. This should be a unique identifier constant.
aEvent	The window server event that occurred.

HandleForegroundEventL ( TBool )

IMPORT_C void

HandleForegroundEventL

(

TBool

aForeground

)

[virtual]

Reimplemented from CEikAppUi::HandleForegroundEventL(TBool)

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

Parameter	Description
aForeground	ETrue if the application is in the foreground, otherwise EFalse.

HandleResourceChangeL ( TInt )

IMPORT_C void

HandleResourceChangeL

(

TInt

aType

)

[virtual]

Reimplemented from CEikAppUi::HandleResourceChangeL(TInt)

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.

Parameter	Description
aType	The type of resources that have changed.

HandleScreenDeviceChangedL ( )

IMPORT_C void

HandleScreenDeviceChangedL

(

)

[protected, virtual]

Reimplemented from CEikAppUi::HandleScreenDeviceChangedL()

From CCoeAppUiBase. Calls CCoeAppUi::HandleScreenDeviceChangedL().

HasFullOrPartialForeground ( )

TBool

HasFullOrPartialForeground

(

)

const

Checks if application UI has full or partial foreground status.

Since: 3.2

Returns: 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.

Since: 3.2

Returns: ETrue if the application is closing.

IsFaded ( )

IMPORT_C TBool

IsFaded

(

)

const

Determines whether the system is faded.

Returns: ETrue if system is faded

IsForeground ( )

IMPORT_C TBool

IsForeground

(

)

const

Determines whether the application is foreground.

Returns: ETrue if the application is foreground.

IsFullScreenApp ( )

IMPORT_C TBool

IsFullScreenApp

(

)

const

Determines whether the application is full screen application.

Returns: ETrue if the application is full screen application.

IsLayoutAwareApp ( )

IMPORT_C TBool

IsLayoutAwareApp

(

)

const

Determines whether the application is layout aware.

Returns: ETrue if the application is layout aware.

IsMSKEnabledApp ( )

TBool

IsMSKEnabledApp

(

)

const

Determines whether the application has MSK enabled.

Since: 3.1

Returns: ETrue if the application has MSK enabled.

IsPartialForeground ( )

IMPORT_C TBool

IsPartialForeground

(

)

const

Determines whether the application is partially foreground.

Returns: ETrue if the application is partially foreground.

IsSingleClickCompatible ( )

IMPORT_C TBool

IsSingleClickCompatible

(

)

const

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

Since: S60 v5.0

Returns: ETrue if the application is single click compatible

IsTouchCompatible ( )

IMPORT_C TBool

IsTouchCompatible

(

)

const

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

Since: S60 v5.0

Returns: ETrue if the application is touch compatible

KeySounds ( )

IMPORT_C CAknKeySoundSystem *

KeySounds

(

)

const

Gets a pointer to KeySound API object.

Returns: Pointer to KeySound API object.

LocalUiZoom ( )

IMPORT_C TAknUiZoom

LocalUiZoom

(

)

const

Gets the application local zoom

Since: 3.1

Returns: Application local zoom

MopSupplyObject ( TTypeUid )

IMPORT_C TTypeUid::Ptr

MopSupplyObject

(

TTypeUid

aId

)

[protected, virtual]

Reimplemented from CEikAppUi::MopSupplyObject(TTypeUid)

Orientation ( )

IMPORT_C TAppUiOrientation

Orientation

(

)

const

Gets the application screen orientation.

Returns: Application screen orientation.

OrientationCanBeChanged ( )

IMPORT_C TBool

OrientationCanBeChanged

(

)

const

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

Since: S60 3.2

Returns: 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.

Since: S60 v5.0

Returns: pointer event modifier

PrepareToExit ( )

IMPORT_C void

PrepareToExit

(

)

[virtual]

Reimplemented from CEikAppUi::PrepareToExit()

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

ReplaceKeySoundsL ( TInt )

IMPORT_C void

ReplaceKeySoundsL

(

TInt

aUid

)

[protected]

Replace current key sound server with new one.

Parameter	Description
aUid	ID of the new key sound server.

ScreenMode ( )

TInt

ScreenMode

(

)

const

SetFadedL ( TBool )

IMPORT_C void

SetFadedL

(

TBool

aFaded

)

[virtual]

Reimplemented from CEikAppUi::SetFadedL(TBool)

From CEikAppUi. Sets whether the windows are faded.

Parameter	Description
aFaded	ETrue if windows are faded, otherwise windows are unfaded.

SetFullScreenApp ( TBool )

IMPORT_C void

SetFullScreenApp

(

TBool

aIsFullScreen

)

[protected]

Set the application to be a full screen application.

Parameter	Description
aIsFullScreen	is ETrue if the application is a full screen application, EFlase otherwise.

SetKeyEventFlags ( const TInt )

IMPORT_C void

SetKeyEventFlags

(

const TInt

aFlags

)

Sets the flags for default key event handling

Since: 5.0

Parameter	Description
aFlags	which can be a combination of flags declared in enumeration TKeyEventFlag

SetLayoutAwareApp ( TBool )

IMPORT_C void

SetLayoutAwareApp

(

TBool

aLayoutAwareApp

)

Set application layout aware.

Parameter	Description
aLayoutAwareApp	ETrue if the application is layout aware, EFlase otherwise.

SetLocalUiZoom ( TAknUiZoom )

IMPORT_C void

SetLocalUiZoom

(

TAknUiZoom

aZoom

)

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

Since: 3.1

Parameter	Description
aZoom	application local zoom

SetOrientationL ( TAppUiOrientation )

IMPORT_C void

SetOrientationL

(

TAppUiOrientation

aOrientation

)

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

Parameter	Description
aOrientation	application screen orientation.

SetScreenModeL ( TInt )

void

SetScreenModeL

(

TInt

aModeNumber

)

SimulateWsEventL ( TInt )

void

SimulateWsEventL

(

TInt

aEvent

)

Simulates an event being received from wserv

Parameter	Description
aEvent	the event id being simulated.

ThreadIsForeground ( )

TBool

ThreadIsForeground

(

)

const

Determines whether the thread owning this application window group is foreground.

Returns: ETrue if the thread owning this application window group is foreground, EFlase otherwise.