CAknAppUiBase Class Reference

enum CAknAppUiBase::TAppUiOrientation

Enumerator:

EAknEnableSkin�	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.
EAppOrientationPortrait�
EAppOrientationLandscape�
EAppOrientationAutomatic�
EAknDisableHighlightAnimation�

IMPORT_C CAknAppUiBase::~CAknAppUiBase

Enumerator:

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.

Constructor & Destructor Documentation

IMPORT_C CAknAppUiBase::CAknAppUiBase

�	Destructor.

IMPORT_C TRect CAknAppUiBase::ApplicationRect

�	C++ Default constructor.

Member Function Documentation

IMPORT_C void CAknAppUiBase::ApplyLayoutChangeL

�	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.

Can be used to apply changes to settings that affect the current layout, such as changes to the local zoom.

Optionally reports the change to the layout to all controls in the application. There are a number of different possible usages of this API:

Can be used to immediately change the local zoom, by passing in ETrue for the reporting parameter.
Can be called before BaseConstructL without leaving, the effect is the same as passing EFalse for the reporting parameter, as the correct layout data is picked up later on during control layout.
Can be used by implementors of the MAknSettingCacheUpdatePlugin interface, in order to set the local zoom whilst updating the settings cache. By passing in EFalse for the reporting parameter, the layout switch is deferred to the usual processing in UpdateSettingCacheAndForwardEventL.
Can be used by controls that require a different local zoom to the underlying application, such as a dialog. By not reporting the change during construction, the dialog will lay itself out correctly. However, the dialog must then report the change back to the app zoom level when it closes, ignoring the resulting resource changed layout switch event.

Parameters:

aReportChange�

if this is true, then the layout event will be reported to controls on the control stack Public since 3rd Ed FP1

IMPORT_C void CAknAppUiBase::BaseConstructL

Initialises this Avkon base app UI with standard values.

aAppUiFlags values are common with CEikAppUi::BaseConstructL(aAppUiFlags).

Parameters:

aAppUiFlags�

Application user interface flags.

Reimplemented in CAknAppUi, and CAknViewAppUi.

IMPORT_C void CAknAppUiBase::ConstructL

IMPORT_C CAknWsEventMonitor* CAknAppUiBase::EventMonitor

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

TInt CAknAppUiBase::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.

IMPORT_C void CAknAppUiBase::Exit

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

TInt CAknAppUiBase::FindAppWgIdBelowMeL

�	From `CEikAppUi`. Closes the app UI.

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

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

IMPORT_C void CAknAppUiBase::HandleForegroundEventL

From CCoeAppUi.

Handles an application specific event.

Parameters:

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

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

This function calls CEikAppUi::HandleForegroundEventL.

Parameters:

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

Reimplemented in CAknAppUi, and CAknViewAppUi.

IMPORT_C void CAknAppUiBase::HandleResourceChangeL

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:

aType�

The type of resources that have changed.

virtual IMPORT_C void CAknAppUiBase::HandleScreenDeviceChangedL (� �)� [protected, virtual]

�	From `CCoeAppUiBase`. Calls CCoeAppUi::HandleScreenDeviceChangedL().

IMPORT_C TBool CAknAppUiBase::IsFaded

IMPORT_C TBool CAknAppUiBase::IsForeground

�	Determines whether the system is faded. Returns: `ETrue` if system is faded

IMPORT_C TBool CAknAppUiBase::IsFullScreenApp

�	Determines whether the application is foreground. Returns: `ETrue` if the application is foreground.

IMPORT_C TBool CAknAppUiBase::IsLayoutAwareApp

�	Determines whether the application is full screen application. Returns: `ETrue` if the application is full screen application.

TBool CAknAppUiBase::IsMSKEnabledApp

�	Determines whether the application is layout aware. Returns: `ETrue` if the application is layout aware.

IMPORT_C TBool CAknAppUiBase::IsPartialForeground

�	Determines whether the application has MSK enabled. Public since 3rd Ed FP1 Returns: `ETrue` if the application has MSK enabled.

IMPORT_C CAknKeySoundSystem* CAknAppUiBase::KeySounds

�	Determines whether the application is partially foreground. Returns: `ETrue` if the application is partially foreground.

IMPORT_C TAknUiZoom CAknAppUiBase::LocalUiZoom

�	Gets a pointer to KeySound API object. Returns: Pointer to KeySound API object.

�	Gets the application local zoom. Returns: Application local zoom

virtual IMPORT_C TTypeUid::Ptr CAknAppUiBase::MopSupplyObject (� TTypeUid� aId �)� [protected, virtual]

IMPORT_C TAppUiOrientation CAknAppUiBase::Orientation

IMPORT_C void CAknAppUiBase::PrepareToExit

�	Gets the application screen orientation. Returns: Application screen orientation.

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

IMPORT_C void CAknAppUiBase::ReplaceKeySoundsL (� TInt� aUid �)� [protected]

ID of the new key sound server.

Replace current key sound server with new one.

Parameters:

aUid�

TInt CAknAppUiBase::ScreenMode

IMPORT_C void CAknAppUiBase::SetFadedL

�	Public Since 3rd Ed FP1.

From CEikAppUi.

Sets whether the windows are faded.

Parameters:

aFaded� ETrue if windows are faded, otherwise windows are unfaded.

IMPORT_C void CAknAppUiBase::SetFullScreenApp (� TBool� aIsFullScreen �)� [protected]

IMPORT_C void CAknAppUiBase::SetLayoutAwareApp

Set the application to be a full screen application.

Parameters:

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

Set application layout aware.

Parameters:

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

IMPORT_C void CAknAppUiBase::SetLocalUiZoom

Sets the application local zoom.

However, in order to have any effect, it may be necessary to make a subsequent call to ApplyLayoutChangeL.

Parameters:

aZoom�

application local zoom

IMPORT_C void CAknAppUiBase::SetOrientationL

Sets the application screen orientation.

Note: this API has no effect on non-full-screen app UIs.

Parameters:

aOrientation�

application screen orientation.

void CAknAppUiBase::SetScreenModeL

�	Public Since 3rd Ed FP1.

void CAknAppUiBase::SimulateWsEventL

Simulates an event being received from wserv.

Parameters:

aEvent�

the event id being simulated.

TBool CAknAppUiBase::ThreadIsForeground

friend class CAknAppUi [friend]

�	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.

Friends And Related Function Documentation