CAknAppUi Class Reference
class CAknAppUi : public CAknAppUiBase |
Abstract Avkon application UI class
Public Member Functions |
---|
| ~CAknAppUi() |
IMPORT_C void | BaseConstructL(TInt) |
IMPORT_C TInt32 | CaptureKey(TUint, TUint, TUint) |
IMPORT_C void | CaptureKeyL(TUint, TUint, TUint, TInt32 &) |
IMPORT_C CEikButtonGroupContainer * | Cba() |
IMPORT_C void | ConstructL() |
IMPORT_C CAknToolbar * | CurrentFixedToolbar() |
IMPORT_C CAknToolbar * | CurrentPopupToolbar() |
IMPORT_C void | DisableNextKeySound(TInt) |
IMPORT_C TBool | ExitHidesInBackground() |
IMPORT_C void | GetAliasKeyCodeL(TUint &, const TKeyEvent &, TEventCode) |
IMPORT_C TErrorHandlerResponse | HandleError(TInt, const SExtendedError &, TDes &, TDes &) |
IMPORT_C void | HandleTouchPaneSizeChange() |
IMPORT_C void | HandleViewDeactivation(const TVwsViewId &, const TVwsViewId &) |
IMPORT_C void | HideApplicationFromFSW(TBool) |
IMPORT_C void | HideInBackground() |
TBool
| IsAppHiddenInBackground() |
IMPORT_C TBool | IsAppShutterRunning() |
IMPORT_C CAknToolbar * | PopupToolbar() |
IMPORT_C void | PrepareToExit() |
IMPORT_C void | ProcessCommandL(TInt) |
IMPORT_C void | RunAppShutter() |
IMPORT_C void | SetAliasKeyCodeResolverL(MAknAliasKeyCodeResolver *) |
IMPORT_C CEikStatusPane * | StatusPane() |
void | StopDisplayingPopupToolbar() |
IMPORT_C CAknTouchPane * | TouchPane() |
Inherited Functions |
---|
| CAknAppUiBase::ApplicationRect()const |
| CAknAppUiBase::ApplyLayoutChangeL(TBool) |
| CAknAppUiBase::CAknAppUiBase() |
| CAknAppUiBase::EventForForegroundState(TBool,TBool) |
| CAknAppUiBase::EventMonitor()const |
| CAknAppUiBase::Exit() |
| CAknAppUiBase::FindAppWgIdBelowMeL() |
| CAknAppUiBase::HandleApplicationSpecificEventL(TInt,const TWsEvent &) |
| CAknAppUiBase::HandleResourceChangeL(TInt) |
| CAknAppUiBase::HandleScreenDeviceChangedL() |
| CAknAppUiBase::HasFullOrPartialForeground()const |
| CAknAppUiBase::IsAppClosing()const |
| CAknAppUiBase::IsFaded()const |
| CAknAppUiBase::IsForeground()const |
| CAknAppUiBase::IsFullScreenApp()const |
| CAknAppUiBase::IsLayoutAwareApp()const |
| CAknAppUiBase::IsMSKEnabledApp()const |
| CAknAppUiBase::IsPartialForeground()const |
| CAknAppUiBase::IsSingleClickCompatible()const |
| CAknAppUiBase::IsTouchCompatible()const |
| CAknAppUiBase::KeySounds()const |
| CAknAppUiBase::LocalUiZoom()const |
| CAknAppUiBase::MopSupplyObject(TTypeUid) |
| CAknAppUiBase::Orientation()const |
| CAknAppUiBase::OrientationCanBeChanged()const |
| CAknAppUiBase::PointerEventModifier() |
| CAknAppUiBase::ReplaceKeySoundsL(TInt) |
| CAknAppUiBase::ScreenMode()const |
| CAknAppUiBase::SetFadedL(TBool) |
| CAknAppUiBase::SetFullScreenApp(TBool) |
| CAknAppUiBase::SetKeyEventFlags(const TInt) |
| CAknAppUiBase::SetLayoutAwareApp(TBool) |
| CAknAppUiBase::SetLocalUiZoom(TAknUiZoom) |
| CAknAppUiBase::SetOrientationL(TAppUiOrientation) |
| CAknAppUiBase::SetScreenModeL(TInt) |
| CAknAppUiBase::SimulateWsEventL(TInt) |
| CAknAppUiBase::ThreadIsForeground()const |
| CAknAppUiBase::~CAknAppUiBase() |
| 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::HandleMessageL(TUint32,TUid,const TDesC8 &) |
| CEikAppUi::HandleModelChangeL() |
| CEikAppUi::HandleSideBarMenuL(TInt,const TPoint &,TInt,const CEikHotKeyTable *) |
| CEikAppUi::LaunchPopupMenuL(TInt,const TPoint &,TPopupTargetPosType,const CEikHotKeyTable *) |
| CEikAppUi::MopNext() |
| CEikAppUi::OpenFileL(const TDesC &) |
| 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() |
Constructor & Destructor Documentation
Member Functions Documentation
BaseConstructL(TInt)
IMPORT_C void | 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
TInt aAppUiFlags = EStandardApp | Application user interface flags. |
CaptureKey(TUint, TUint, TUint)
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()
Parameters
TUint aKeycode | The key code for the key to be captured. Key codes for special keys are defined in TKeyCode. |
TUint aModifierMask | |
TUint 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. |
CaptureKeyL(TUint, TUint, TUint, TInt32 &)
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()
Parameters
TUint aKeycode | The key code for the key to be captured. Key codes for special keys are defined in TKeyCode. |
TUint aModifierMask | |
TUint 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. |
TInt32 & aHandle | identifying the capture key. Handles should be kept in order to be passed to CancelCaptureKey() later. |
Cba()
IMPORT_C CEikButtonGroupContainer * | Cba | ( | ) | |
Gets a pointer to the Command Button Area.
ConstructL()
IMPORT_C void | ConstructL | ( | ) | [virtual] |
CurrentFixedToolbar()
Gets a pointer to the current fixed toolbar( view toolbar is priority ).
- Since
- S60 5.0
CurrentPopupToolbar()
Gets a pointer to the current toolbar( view toolbar is priority ).
- Since
- S60 3.1
DecideWsClientBufferSizesL()
void | DecideWsClientBufferSizesL | ( | ) | [protected] |
Try to set window server buffer size to KAknDefaultWsBufferSize.
DisableNextKeySound(TInt)
IMPORT_C void | DisableNextKeySound | ( | TInt | aScanCode | ) | |
Disables next key sound (and repeated key sounds until pointer up event).
Parameters
TInt aScanCode | Scan code of disabled key. |
DumpControl(CCoeControl *, TInt, RDebug &)
Prints out information about the control and all its subcontrols to RDebug console.
Parameters
CCoeControl * aControl | object to be printed. |
TInt aLevel | positioning constant. |
RDebug & aDebug | stream for printing. |
ExitHidesInBackground()
IMPORT_C TBool | ExitHidesInBackground | ( | ) | const |
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.
ExitHidesInBackgroundL()
TBool
| ExitHidesInBackgroundL | ( | ) | const [private] |
GetAliasKeyCodeL(TUint &, const TKeyEvent &, TEventCode)
Gets keyboard layout specific keycode. Uses given resolver SetAliasKeyCodeResolverL() if set, by default fetches alternative code from avkon server.
Parameters
TUint & aCode | reference to variable to contain new keycode |
const TKeyEvent & aKeyEvent | reference to original, complete, event |
TEventCode aType | indicating original event type |
HandleError(TInt, const SExtendedError &, TDes &, TDes &)
Parameters
TInt aError | The error code. |
const SExtendedError & aExtErr | For extended error messages. Not used. |
TDes & aErrorText | Error text. Not used. |
TDes & aContextText | Text describing the context of the error. Not used. |
HandleErrorL(TInt, HBufC **, TBool)
IMPORT_C void | HandleErrorL | ( | TInt | aError, |
| HBufC ** | aErrorDesc, |
| TBool | aShowNote = ETrue |
| ) | [protected] |
HandleForegroundEventL(TBool)
IMPORT_C void | HandleForegroundEventL | ( | TBool | aForeground | ) | [protected, virtual] |
Handles changes in keyboard focus when an application switches to, or from, the foreground.
Parameters
TBool aForeground | ETrue if the application is in the foreground, otherwise EFalse. |
HandleStatusPaneSizeChange()
IMPORT_C void | HandleStatusPaneSizeChange | ( | ) | [protected] |
From MEikStatusPaneObserver. Handles a change in the position or size of the screen area occupied by the status pane.
HandleSystemEventL(const TWsEvent &)
IMPORT_C void | HandleSystemEventL | ( | const TWsEvent & | aEvent | ) | [protected, virtual] |
From CCoeAppUi. Handles system events generated by the window server.
Parameters
const TWsEvent & aEvent | The window server event that occurred. |
HandleTouchPaneSizeChange()
IMPORT_C void | HandleTouchPaneSizeChange | ( | ) | |
From . Handles a change in the size or position of touch pane.
HandleViewDeactivation(const TVwsViewId &, const TVwsViewId &)
IMPORT_C void | 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.
HandleWsEventL(const TWsEvent &, CCoeControl *)
IMPORT_C void | HandleWsEventL | ( | const TWsEvent & | aEvent, |
| CCoeControl * | aDestination |
| ) | [protected, virtual] |
Handles window server events.
Parameters
const TWsEvent & aEvent | The window server event that occurred. |
CCoeControl * aDestination | The control associated with the event. |
HideApplicationFromFSW(TBool)
IMPORT_C void | HideApplicationFromFSW | ( | TBool | aHide = ETrue | ) | |
Hide application from Fast-swap window.
- Since
- S60 2.6
Parameters
TBool aHide = ETrue | ETrue if application is hided from Fast-swap window, otherwise EFalse |
HideInBackground()
IMPORT_C void | HideInBackground | ( | ) | |
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
IsAppHiddenInBackground()
TBool
| IsAppHiddenInBackground | ( | ) | const |
Determines whether the application is hidden in background. (i.e. HideInBackground has been called and application has not yet been activated)
IsAppShutterRunning()
IMPORT_C TBool | IsAppShutterRunning | ( | ) | const |
Determines whether the application shutter is active.
PopupToolbar()
Gets a pointer to the application toolbar.
- Since
- S60 3.1
PrepareToExit()
IMPORT_C void | PrepareToExit | ( | ) | [virtual] |
From CCoeAppUiBase. Performs pre-exit processing to ensure the application will exit cleanly.
ProcessCommandL(TInt)
IMPORT_C void | ProcessCommandL | ( | TInt | aCommand | ) | |
Processes user commands. This function passes aCommand (except values EAknSoftkeyOptions, EAknCmdExit, EEikCmdCanceled) to user derived HandleCommandL.
Parameters
TInt aCommand | A command ID. |
Reserved_MtsmObject()
IMPORT_C void | Reserved_MtsmObject | ( | ) | [protected, virtual] |
Reserved_MtsmPosition()
IMPORT_C void | Reserved_MtsmPosition | ( | ) | [protected, virtual] |
RunAppShutter()
IMPORT_C void | RunAppShutter | ( | ) | |
Run the application shutter if it exists.
SetAliasKeyCodeResolverL(MAknAliasKeyCodeResolver *)
Sets custom resolver for keycode aliases Creates iExtension if it doesn't exist
- Since
- S60 3.1
SetKeyBlockMode(TAknKeyBlockMode)
Set key block mode. In default mode, the S60 Developer Platform blocks simultaneous key presses.
SimulateHashKeyMarkingEventL(const TWsEvent &)
TBool
| SimulateHashKeyMarkingEventL | ( | const TWsEvent & | aEvent | ) | [private] |
StatusPane()
IMPORT_C CEikStatusPane * | StatusPane | ( | ) | |
Gets a pointer to the status pane.
StopDisplayingPopupToolbar()
void | StopDisplayingPopupToolbar | ( | ) | |
Hides popup toolbar if it is visible
- Since
- S60 3.1
TouchPane()
IMPORT_C CAknTouchPane * | TouchPane | ( | ) | |
Gets a pointer to the touch pane.
- Since
- S60 5.0
UpdateKeyBlockMode()
void | UpdateKeyBlockMode | ( | ) | [private] |
Member Data Documentation
CAknAppShutter * iAppShutter
CAknAppShutter * | iAppShutter | [private] |
TAknKeyBlockMode
iBlockMode
TBool
iDumpNextControl
TBool
| iDumpNextControl | [private] |
CAknAppUiExtension * iExtension
CAknAppUiExtension * | iExtension | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.