S60 3rd Edition API Reference: CAknAppUi Class Reference

CAknAppUi Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikcore.lib eiksrv.lib

Capability Information

Required Capabilities

None


#include <aknappui.h>

Inherits CAknAppUiBase, MEikStatusPaneObserver, and MAknTouchPaneObserver.

Inherited by CAknViewAppUi.


Detailed Description

Abstract Avkon application UI class.

Public Member Functions

IMPORT_C void BaseConstructL (TInt aAppUiFlags=EStandardApp)
 Initialises this Avkon app UI with standard values.
IMPORT_C ~CAknAppUi ()
 Destructor.
IMPORT_C void ConstructL ()
 From CEikAppUi.
IMPORT_C CEikStatusPaneStatusPane ()
 Gets a pointer to the status pane.
IMPORT_C CEikButtonGroupContainerCba ()
 Gets a pointer to the Command Button Area.
IMPORT_C CAknTouchPane * TouchPane ()
 Gets a pointer to the touch pane.
IMPORT_C CAknToolbar * PopupToolbar () const
 Gets a pointer to the application toolbar.
IMPORT_C CAknToolbar * CurrentPopupToolbar () const
 Gets a pointer to the current toolbar( view toolbar is priority ).
void StopDisplayingPopupToolbar ()
 Hides popup toolbar if it is visible.
IMPORT_C void ProcessCommandL (TInt aCommand)
 Processes user commands.
IMPORT_C TErrorHandlerResponse HandleError (TInt aError, const SExtendedError &aExtErr, TDes &aErrorText, TDes &aContextText)
 Handles errors.
IMPORT_C void RunAppShutter ()
 Run the application shutter if it exists.
IMPORT_C TBool IsAppShutterRunning () const
 Determines whether the application shutter is active.
virtual IMPORT_C void HandleViewDeactivation (const TVwsViewId &aViewIdToBeDeactivated, const TVwsViewId &aNewlyActivatedViewId)
 From MCoeViewDeactivationObserver.
IMPORT_C void PrepareToExit ()
 From CCoeAppUiBase.
IMPORT_C void HandleTouchPaneSizeChange ()
 From .
IMPORT_C void HideApplicationFromFSW (TBool aHide=ETrue)
 Hide application from Fast-swap window.
IMPORT_C void GetAliasKeyCodeL (TUint &aCode, const TKeyEvent &aKeyEvent, TEventCode aType)
 Gets keyboard layout specific keycode.
IMPORT_C void SetAliasKeyCodeResolverL (MAknAliasKeyCodeResolver *aResolver)
 Sets custom resolver for keycode aliases Creates iExtension if it doesn't exist Public since 3rd Ed FP1.

Protected Member Functions

IMPORT_C void HandleStatusPaneSizeChange ()
 From MEikStatusPaneObserver.
IMPORT_C void HandleSystemEventL (const TWsEvent &aEvent)
 From CCoeAppUi.
virtual IMPORT_C void Reserved_MtsmPosition ()
virtual IMPORT_C void Reserved_MtsmObject ()
IMPORT_C void HandleForegroundEventL (TBool aForeground)
 Handles changes in keyboard focus when an application switches to, or from, the foreground.
IMPORT_C void HandleWsEventL (const TWsEvent &aEvent, CCoeControl *aDestination)
 Handles window server events.
IMPORT_C void SetKeyBlockMode (TAknKeyBlockMode aMode)
 Set key block mode.
IMPORT_C void HandleErrorL (TInt aError, HBufC **aErrorDesc, TBool aShowNote=ETrue)
void DecideWsClientBufferSizesL ()
 Try to set window server buffer size to KAknDefaultWsBufferSize.

Constructor & Destructor Documentation

IMPORT_C CAknAppUi::~CAknAppUi  ) 
 

Destructor.


Member Function Documentation

IMPORT_C void CAknAppUi::BaseConstructL TInt  aAppUiFlags = 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:
aAppUiFlags Application user interface flags.

Reimplemented from CAknAppUiBase.

Reimplemented in CAknViewAppUi.

IMPORT_C CEikButtonGroupContainer* CAknAppUi::Cba  ) 
 

Gets a pointer to the Command Button Area.

Returns:
Pointer to the CBA
IMPORT_C void CAknAppUi::ConstructL  ) 
 

From CEikAppUi.

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

Reimplemented from CAknAppUiBase.

IMPORT_C CAknToolbar* CAknAppUi::CurrentPopupToolbar  )  const
 

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

Returns:
Pointer to the current toolbar or NULL
void CAknAppUi::DecideWsClientBufferSizesL  )  [protected]
 

Try to set window server buffer size to KAknDefaultWsBufferSize.

IMPORT_C void CAknAppUi::GetAliasKeyCodeL TUint &  aCode,
const TKeyEvent &  aKeyEvent,
TEventCode  aType
 

Gets keyboard layout specific keycode.

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

Public since 3rd Ed FP1

Parameters:
aCode reference to variable to contain new keycode
aKeyEvent reference to original, complete, event
aType indicating original event type
IMPORT_C TErrorHandlerResponse CAknAppUi::HandleError TInt  aError,
const SExtendedError &  aExtErr,
TDes &  aErrorText,
TDes &  aContextText
 

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
IMPORT_C void CAknAppUi::HandleErrorL TInt  aError,
HBufC **  aErrorDesc,
TBool  aShowNote = ETrue
[protected]
 
IMPORT_C void CAknAppUi::HandleForegroundEventL TBool  aForeground  )  [protected]
 

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.

IMPORT_C void CAknAppUi::HandleStatusPaneSizeChange  )  [protected, virtual]
 

From MEikStatusPaneObserver.

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

Implements MEikStatusPaneObserver.

Reimplemented in CAknViewAppUi.

IMPORT_C void CAknAppUi::HandleSystemEventL const TWsEvent &  aEvent  )  [protected]
 

From CCoeAppUi.

Handles system events generated by the window server.

Parameters:
aEvent The window server event that occurred.
IMPORT_C void CAknAppUi::HandleTouchPaneSizeChange  )  [virtual]
 

From .

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

Implements MAknTouchPaneObserver.

virtual IMPORT_C void CAknAppUi::HandleViewDeactivation 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:
aViewIdToBeDeactivated 
aNewlyActivatedViewId 
IMPORT_C void CAknAppUi::HandleWsEventL const TWsEvent &  aEvent,
CCoeControl *  aDestination
[protected]
 

Handles window server events.

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

Reimplemented in CAknViewAppUi.

IMPORT_C void CAknAppUi::HideApplicationFromFSW TBool  aHide = ETrue  ) 
 

Hide application from Fast-swap window.

Public Since 3rd Ed FP1

Parameters:
aHide ETrue if application is hided from Fast-swap window, otherwise EFalse
IMPORT_C TBool CAknAppUi::IsAppShutterRunning  )  const
 

Determines whether the application shutter is active.

Returns:
ETrue if application shutter is active.
IMPORT_C CAknToolbar* CAknAppUi::PopupToolbar  )  const
 

Gets a pointer to the application toolbar.

Returns:
Pointer to the applicaton toolbar or NULL
IMPORT_C void CAknAppUi::PrepareToExit  ) 
 

From CCoeAppUiBase.

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

Reimplemented from CAknAppUiBase.

IMPORT_C void CAknAppUi::ProcessCommandL TInt  aCommand  ) 
 

Processes user commands.

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

Parameters:
aCommand A command ID.

Reimplemented in CAknViewAppUi.

virtual IMPORT_C void CAknAppUi::Reserved_MtsmObject  )  [protected, virtual]
 
virtual IMPORT_C void CAknAppUi::Reserved_MtsmPosition  )  [protected, virtual]
 
IMPORT_C void CAknAppUi::RunAppShutter  ) 
 

Run the application shutter if it exists.

IMPORT_C void CAknAppUi::SetAliasKeyCodeResolverL MAknAliasKeyCodeResolver aResolver  ) 
 

Sets custom resolver for keycode aliases Creates iExtension if it doesn't exist Public since 3rd Ed FP1.

Parameters:
aHandler instance implementing MAknAliasKeyCodeResolver
IMPORT_C void CAknAppUi::SetKeyBlockMode TAknKeyBlockMode  aMode  )  [protected]
 

Set key block mode.

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

Parameters:
aMode ENoKeyBlock if no key block, otherwise EDefaultBlockMode
IMPORT_C CEikStatusPane* CAknAppUi::StatusPane  ) 
 

Gets a pointer to the status pane.

Returns:
Pointer to the status pane
void CAknAppUi::StopDisplayingPopupToolbar  ) 
 

Hides popup toolbar if it is visible.

IMPORT_C CAknTouchPane* CAknAppUi::TouchPane  ) 
 

Gets a pointer to the touch pane.

Returns:
Pointer to the the touch pane

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top