CAknAppUi Class Reference

Destructor.

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:

aAppUiFlags

Application user interface flags.

Reimplemented from CAknAppUiBase.

Reimplemented in CAknViewAppUi.

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

Since:

S60 V3.2

Parameters:

	aKeycode	The key code for the key to be captured. Key codes for special keys are defined in TKeyCode.
	aModifier	Mask Only the modifier keys in this mask are tested against the states specified in aModifier.
	aModifier	The 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.

Returns:

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.

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

Since:

S60 V3.2

Parameters:

	aKeycode	The key code for the key to be captured. Key codes for special keys are defined in TKeyCode.
	aModifier	Mask Only the modifier keys in this mask are tested against the states specified in aModifier.
	aModifier	The 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.
	aHandle	identifying the capture key. Handles should be kept in order to be passed to CancelCaptureKey() later.

Gets a pointer to the Command Button Area.

Returns:

Pointer to the CBA

From CEikAppUi.

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

Reimplemented from CAknAppUiBase.

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

Returns:

Pointer to the current fixed toolbar or NULL

Since:

S60 5.0

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

Returns:

Pointer to the current toolbar or NULL

Since:

S60 3.1

Try to set window server buffer size to KAknDefaultWsBufferSize.

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

Since:

S60 V5.0

Parameters:

aScanCode

Scan code of disabled key.

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.

Since:

S60 V5.0

Returns:

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

Gets keyboard layout specific keycode.

Uses given resolver SetAliasKeyCodeResolverL() if set, by default fetches alternative code from avkon server.

Since:

S60 3.1

Parameters:

	aCode	reference to variable to contain new keycode
	aKeyEvent	reference to original, complete, event
	aType	indicating original event type

Handles errors.

Parameters:

	aError	The error code.
	aExtErr	For extended error messages. Not used.
	aErrorText	Error text. Not used.
	aContextText	Text describing the context of the error. Not used.

Returns:

ENoDisplay if Error handled proper way, else EErrorNotHandled

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

Parameters:

aForeground

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

Reimplemented from CAknAppUiBase.

Reimplemented in CAknViewAppUi.

From MEikStatusPaneObserver.

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

Implements MEikStatusPaneObserver.

Reimplemented in CAknViewAppUi.

From CCoeAppUi.

Handles system events generated by the window server.

Parameters:

aEvent

The window server event that occurred.

From .

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

Implements MAknTouchPaneObserver.

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:

	aViewIdToBeDeactivated
	aNewlyActivatedViewId

Handles window server events.

Parameters:

	aEvent	The window server event that occurred.
	aDestination	The control associated with the event.

Reimplemented in CAknViewAppUi.

Hide application from Fast-swap window.

Since:

S60 2.6

Parameters:

aHide

ETrue if application is hided from Fast-swap window, otherwise EFalse

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.

Since:

S60 V5.0

Determines whether the application is hidden in background.

(i.e. HideInBackground has been called and application has not yet been activated)

Returns:

ETrue if application is hidden in background.

Determines whether the application shutter is active.

Returns:

ETrue if application shutter is active.

Gets a pointer to the application toolbar.

Returns:

Pointer to the applicaton toolbar or NULL

Since:

S60 3.1

From CCoeAppUiBase.

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

Reimplemented from CAknAppUiBase.

Processes user commands.

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

Parameters:

aCommand

A command ID.

Reimplemented in CAknViewAppUi.

Run the application shutter if it exists.

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

Since:

S60 3.1

Parameters:

aHandler

instance implementing MAknAliasKeyCodeResolver

Set key block mode.

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

Parameters:

aMode

ENoKeyBlock if no key block, otherwise EDefaultBlockMode

Gets a pointer to the status pane.

Returns:

Pointer to the status pane

Hides popup toolbar if it is visible.

Since:

S60 3.1

Gets a pointer to the touch pane.

Returns:

Pointer to the the touch pane

Since:

S60 5.0