CAknAppUiBase Class Reference
class CAknAppUiBase : public CEikAppUi |
Abstract Avkon application UI base class
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() |
Public Member Enumerations |
---|
enum | anonymous { EAknEnableSkin = EAknEnableSkinFlag, EAppOrientationPortrait = EAppOrientationSpecifiedFlag, EAppOrientationLandscape = EAppOrientationSpecifiedFlag | EAppOrientationLandscapeFlag, EAppOrientationAutomatic = EAppOrientationSpecifiedFlag | EAppOrientationAutomaticFlag, EAknDisableHighlightAnimation = EAknDisableHighlightAnimationFlag, EAknEnableMSK = EAknEnableMSKflag, EAknExplicitStartupEffectCompletion = EAknExplicitStartupEffectCompletionFlag, EAknTouchCompatible = EAknTouchCompatibleFlag, EAknSingleClickCompatible = EAknSingleClickCompatibleFlag, EAknDisableAnimationBackground = EAknDisableAnimationBackgroundFlag } |
enum | TAppUiOrientation { EAppUiOrientationUnspecified, EAppUiOrientationPortrait, EAppUiOrientationLandscape, EAppUiOrientationAutomatic } |
enum | TKeyEventFlag { EDisableSendKeyShort = 0x01, EDisableSendKeyLong = 0x02 } |
Constructor & Destructor Documentation
Member Functions Documentation
AlwaysForwardEvent(TInt)
TBool
| AlwaysForwardEvent | ( | TInt | aEventId | ) | [private] |
ApplicationRect()
IMPORT_C TRect | ApplicationRect | ( | ) | const [virtual] |
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.
ApplyLayoutChangeL(TBool)
IMPORT_C void | ApplyLayoutChangeL | ( | TBool | aReportChange | ) | |
BaseConstructL(TInt)
IMPORT_C void | BaseConstructL | ( | TInt | aAppUiFlags | ) | |
Initialises this Avkon base app UI with standard values. aAppUiFlags values are common with CEikAppUi::BaseConstructL(aAppUiFlags).
Parameters
TInt aAppUiFlags | Application user interface flags. |
ConstructL()
IMPORT_C void | ConstructL | ( | ) | [virtual] |
EventForForegroundState(TBool, TBool)
Simply return KEikPartialForeground if aPartialFg == ETrue, otherwise if aForeground == ETrue then return EEventFocusGained else return EEventFocusLost.
EventMonitor()
Returns the object which allows events to be spyed upon in addition to normal event handling.
Exit()
IMPORT_C void | Exit | ( | ) | [virtual] |
FindAppWgIdBelowMeL()
TInt
| FindAppWgIdBelowMeL | ( | ) | |
Find 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] |
From CCoeAppUi. Handles an application specific event.
Parameters
TInt aType | The type of the event that occurred. This should be a unique identifier constant. |
const TWsEvent & aEvent | The window server event that occurred. |
HandleForegroundEventL(TBool)
IMPORT_C void | HandleForegroundEventL | ( | TBool | aForeground | ) | [virtual] |
Parameters
TBool aForeground | ETrue if the application is in the foreground, otherwise EFalse. |
HandleResourceChangeL(TInt)
IMPORT_C void | HandleResourceChangeL | ( | TInt | aType | ) | [virtual] |
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
TInt aType | The type of resources that have changed. |
HandleScreenDeviceChangedL()
IMPORT_C void | HandleScreenDeviceChangedL | ( | ) | [protected, virtual] |
HasFullOrPartialForeground()
TBool
| HasFullOrPartialForeground | ( | ) | const |
Checks if application UI has full or partial foreground status.
- Since
- 3.2
IsAppClosing()
TBool
| IsAppClosing | ( | ) | const |
Determines whether the application is closing. In practice this means that
CEikonEnv has been destroyed.
- Since
- 3.2
IsFaded()
IMPORT_C TBool | IsFaded | ( | ) | const |
Determines whether the system is faded.
IsForeground()
IMPORT_C TBool | IsForeground | ( | ) | const |
Determines whether the application is foreground.
IsFullScreenApp()
IMPORT_C TBool | IsFullScreenApp | ( | ) | const |
Determines whether the application is full screen application.
IsLayoutAwareApp()
IMPORT_C TBool | IsLayoutAwareApp | ( | ) | const |
Determines whether the application is layout aware.
IsMSKEnabledApp()
TBool
| IsMSKEnabledApp | ( | ) | const |
Determines whether the application has MSK enabled.
- Since
- 3.1
IsPartialForeground()
IMPORT_C TBool | IsPartialForeground | ( | ) | const |
Determines whether 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.
IsTouchCompatible()
IMPORT_C TBool | IsTouchCompatible | ( | ) | const |
Checks if the application is touch compatible i.e. it has been constructed with the flag EAknTouchCompatible.
KeySounds()
IMPORT_C CAknKeySoundSystem * | KeySounds | ( | ) | const |
Gets a pointer to KeySound API object.
LocalUiZoom()
Gets the application local zoom
- Since
- 3.1
MopSupplyObject(TTypeUid)
Orientation()
Gets the 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
PointerEventModifier()
IMPORT_C CAknPointerEventModifier * | PointerEventModifier | ( | ) | |
Returns a pointer to appui's pointer event modifier. This method is intended for internal usage only.
PrepareToExit()
IMPORT_C void | PrepareToExit | ( | ) | [virtual] |
From CCoeAppUiBase. Performs pre-exit processing by calling CEikAppUi::PrepareToExit() to ensure the application will exit cleanly.
RelinquishPriorityToForegroundAppLC()
void | RelinquishPriorityToForegroundAppLC | ( | ) | [private] |
ReplaceKeySoundsL(TInt)
IMPORT_C void | ReplaceKeySoundsL | ( | TInt | aUid | ) | [protected] |
Replace current key sound server with new one.
Parameters
TInt aUid | ID of the new key sound server. |
SetAppUiAndLeaveIfErrorL(TInt)
void | SetAppUiAndLeaveIfErrorL | ( | TInt | aError | ) | [private] |
SetFadedL(TBool)
IMPORT_C void | SetFadedL | ( | TBool | aFaded | ) | [virtual] |
From CEikAppUi. Sets whether the windows are faded.
Parameters
TBool 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.
Parameters
TBool 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
Parameters
const TInt aFlags | which can be a combination of flags declared in enumeration TKeyEventFlag |
SetLayoutAwareApp(TBool)
IMPORT_C void | SetLayoutAwareApp | ( | TBool | aLayoutAwareApp | ) | |
Set application layout aware.
Parameters
TBool aLayoutAwareApp | ETrue if the application is layout aware, EFlase otherwise. |
SetLocalUiZoom(TAknUiZoom)
Sets the application local zoom. However, in order to have any effect, it may be necessary to make a subsequent call to ApplyLayoutChangeL.
SetOrientationL(TAppUiOrientation)
Sets the application screen orientation. Note: this API has no effect on non-full-screen app UIs.
SetScreenModeL(TInt)
void | SetScreenModeL | ( | TInt | aModeNumber | ) | |
SimulateWsEventL(TInt)
void | SimulateWsEventL | ( | TInt | aEvent | ) | |
Simulates an event being received from wserv
Parameters
TInt aEvent | the event id being simulated. |
ThreadIsForeground()
TBool
| ThreadIsForeground | ( | ) | const |
Determines whether the thread owning this application window group is foreground.
UpdateSettingCacheAndForwardEventL(TInt)
void | UpdateSettingCacheAndForwardEventL | ( | TInt | aEventId | ) | [private] |
Member Enumerations Documentation
Enum anonymous
Enumerators
EAppOrientationSpecifiedFlag = 0x00010000 | |
EAppOrientationLandscapeFlag = 0x00020000 | |
EAppOrientationAutomaticFlag = 0x00040000 | |
EAknEnableSkinFlag = 0x00080000 | |
EAknDisableHighlightAnimationFlag = 0x00100000 | |
EAknEnableMSKflag = 0x00200000 | |
EAknExplicitStartupEffectCompletionFlag = 0x00400000 |
When enabled, avkon does not complete startup effect application has to do it by itself.
|
EAknTouchCompatibleFlag = 0x00800000 |
Application supports touch (doesn't need keyboard). If the flag is missing and compatibility mode is enabled in a device, application is run in a compatibility mode (QVGA window with a virtual keypad.
|
EAknSingleClickCompatibleFlag = 0x01000000 |
Application supports single click.
|
EAknDisableAnimationBackgroundFlag = 0x02000000 |
Application disables animation background
|
Enum anonymous
Enumerators
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.
|
EAppOrientationPortrait = EAppOrientationSpecifiedFlag | |
EAppOrientationLandscape = EAppOrientationSpecifiedFlag | EAppOrientationLandscapeFlag | |
EAppOrientationAutomatic = EAppOrientationSpecifiedFlag | EAppOrientationAutomaticFlag | |
EAknDisableHighlightAnimation = EAknDisableHighlightAnimationFlag | |
EAknEnableMSK = EAknEnableMSKflag | |
EAknExplicitStartupEffectCompletion = EAknExplicitStartupEffectCompletionFlag | |
EAknTouchCompatible = EAknTouchCompatibleFlag | |
EAknSingleClickCompatible = EAknSingleClickCompatibleFlag | |
EAknDisableAnimationBackground = EAknDisableAnimationBackgroundFlag | |
Enum TAppUiOrientation
Enumerators
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
Enumerators
EDisableSendKeyShort = 0x01 | |
EDisableSendKeyLong = 0x02 | |
Member Data Documentation
CAknAppUiBaseExtension * iAppUiBaseExtension
CAknAppUiBaseExtension * | iAppUiBaseExtension | [private] |
CAknWsEventMonitor * iEventMonitor
CAknKeySoundSystem * iKeySounds
CAknKeySoundSystem * | iKeySounds | [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.