class CAknAppUiBase : public CEikAppUi |
Abstract Avkon application UI base class
S60 3.0
Protected Member Functions | |
---|---|
IMPORT_C void | HandleApplicationSpecificEventL(TInt, const TWsEvent &) |
IMPORT_C void | HandleScreenDeviceChangedL() |
IMPORT_C TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
IMPORT_C void | ReplaceKeySoundsL(TInt) |
IMPORT_C void | SetFullScreenApp(TBool) |
Private Member Functions | |
---|---|
TBool | AlwaysForwardEvent(TInt) |
void | RelinquishPriorityToForegroundAppLC() |
void | SetAppUiAndLeaveIfErrorL(TInt) |
void | UpdateSettingCacheAndForwardEventL(TInt) |
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 } |
enum | TAppUiOrientation { EAppUiOrientationUnspecified, EAppUiOrientationPortrait, EAppUiOrientationLandscape, EAppUiOrientationAutomatic } |
enum | TKeyEventFlag { EDisableSendKeyShort = 0x01, EDisableSendKeyLong = 0x02 } |
Private Member Enumerations | |
---|---|
enum | anonymous { EAppOrientationSpecifiedFlag = 0x00010000, EAppOrientationLandscapeFlag = 0x00020000, EAppOrientationAutomaticFlag = 0x00040000, EAknEnableSkinFlag = 0x00080000, EAknDisableHighlightAnimationFlag = 0x00100000, EAknEnableMSKflag = 0x00200000, EAknExplicitStartupEffectCompletionFlag = 0x00400000, EAknTouchCompatibleFlag = 0x00800000, EAknSingleClickCompatibleFlag = 0x01000000 } |
Inherited Enumerations | |
---|---|
CEikAppUi:@154 |
Private Attributes | |
---|---|
TBitFlags | iAknFlags |
CAknAppUiBaseExtension * | iAppUiBaseExtension |
CAknWsEventMonitor * | iEventMonitor |
CAknKeySoundSystem * | iKeySounds |
Inherited Attributes | |
---|---|
CCoeAppUi::iCoeEnv | |
CEikAppUi::iContainerAppUi | |
CEikAppUi::iDocument | |
CEikAppUi::iDoorObserver | |
CEikAppUi::iEmbeddedAndReadOnly | |
CEikAppUi::iFlags |
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. The total area of the screen available to the application.
IMPORT_C void | ApplyLayoutChangeL | ( | TBool | aReportChange | ) |
TBool aReportChange |
IMPORT_C void | BaseConstructL | ( | TInt | aAppUiFlags | ) |
Initialises this Avkon base app UI with standard values. aAppUiFlags values are common with CEikAppUi::BaseConstructL(aAppUiFlags).
TInt aAppUiFlags | Application user interface flags. |
IMPORT_C void | ConstructL | ( | ) | [virtual] |
From CEikAppUi. Completes construction. The implementation of ConstructL() in CAknAppUiBase simply calls BaseConstructL().
TInt | EventForForegroundState | ( | TBool | aPartialFg, |
TBool | aForeground | |||
) |
Simply return KEikPartialForeground if aPartialFg == ETrue, otherwise if aForeground == ETrue then return EEventFocusGained else return EEventFocusLost. if aPartialFg then return KEikPartialForeground.
IMPORT_C CAknWsEventMonitor * | EventMonitor | ( | ) | const |
Returns the object which allows events to be spyed upon in addition to normal event handling. Pointer to window server event monitor object.
TInt | FindAppWgIdBelowMeL | ( | ) |
Find the window group ID of the application below this application. the window group ID of the application below this application.
IMPORT_C void | HandleApplicationSpecificEventL | ( | TInt | aType, |
const TWsEvent & | aEvent | |||
) | [protected, virtual] |
From CCoeAppUi. Handles an application specific event.
IMPORT_C void | HandleForegroundEventL | ( | TBool | aForeground | ) | [virtual] |
Handles changes in keyboard focus when an application switches to, or from, the foreground. This function calls CEikAppUi::HandleForegroundEventL.
TBool aForeground | ETrue if the application is in the foreground, otherwise EFalse. |
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.
TInt aType | The type of resources that have changed. |
IMPORT_C void | HandleScreenDeviceChangedL | ( | ) | [protected, virtual] |
From CCoeAppUiBase. Calls CCoeAppUi::HandleScreenDeviceChangedL().
TBool | HasFullOrPartialForeground | ( | ) | const |
Checks if application UI has full or partial foreground status. 3.2
ETrue if application UI has full or partial foreground status. Otherwise EFalse.
TBool | IsAppClosing | ( | ) | const |
Determines whether the application is closing. In practice this means that CEikonEnv has been destroyed. ETrue if the application is closing.
3.2
IMPORT_C TBool | IsFaded | ( | ) | const |
Determines whether the system is faded. ETrue if system is faded
IMPORT_C TBool | IsForeground | ( | ) | const |
Determines whether the application is foreground. ETrue if the application is foreground.
IMPORT_C TBool | IsFullScreenApp | ( | ) | const |
Determines whether the application is full screen application. ETrue if the application is full screen application.
IMPORT_C TBool | IsLayoutAwareApp | ( | ) | const |
Determines whether the application is layout aware. ETrue if the application is layout aware.
TBool | IsMSKEnabledApp | ( | ) | const |
Determines whether the application has MSK enabled. ETrue if the application has MSK enabled.
3.1
IMPORT_C TBool | IsPartialForeground | ( | ) | const |
Determines whether the application is partially foreground. ETrue if the application is partially foreground.
IMPORT_C TBool | IsSingleClickCompatible | ( | ) | const |
Checks if the application is single click compatible i.e. it has been constructed with the flag EAknSingleClickCompatible.
S60 v5.0
ETrue if the application is single click compatible
IMPORT_C TBool | IsTouchCompatible | ( | ) | const |
Checks if the application is touch compatible i.e. it has been constructed with the flag EAknTouchCompatible.
S60 v5.0
ETrue if the application is touch compatible
IMPORT_C CAknKeySoundSystem * | KeySounds | ( | ) | const |
Gets a pointer to KeySound API object. Pointer to KeySound API object.
IMPORT_C TAknUiZoom | LocalUiZoom | ( | ) | const |
Gets the application local zoom Application local zoom
3.1
IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected, virtual] |
TTypeUid aId |
IMPORT_C TAppUiOrientation | Orientation | ( | ) | const |
Gets the application screen orientation. Application screen orientation.
IMPORT_C TBool | OrientationCanBeChanged | ( | ) | const |
Tests whether it is possible for this app to have a practical effect on the screen orientation, through SetOrientationL(). S60 3.2
ETrue if SetOrientationL can change the orientation, EFalse otherwise.
IMPORT_C CAknPointerEventModifier * | PointerEventModifier | ( | ) |
Returns a pointer to appui's pointer event modifier. This method is intended for internal usage only.
S60 v5.0
pointer event modifier
IMPORT_C void | PrepareToExit | ( | ) | [virtual] |
From CCoeAppUiBase. Performs pre-exit processing by calling CEikAppUi::PrepareToExit() to ensure the application will exit cleanly.
IMPORT_C void | ReplaceKeySoundsL | ( | TInt | aUid | ) | [protected] |
Replace current key sound server with new one.
TInt aUid | ID of the new key sound server. |
void | SetAppUiAndLeaveIfErrorL | ( | TInt | aError | ) | [private] |
TInt aError |
IMPORT_C void | SetFadedL | ( | TBool | aFaded | ) | [virtual] |
From CEikAppUi. Sets whether the windows are faded.
TBool aFaded | ETrue if windows are faded, otherwise windows are unfaded. |
IMPORT_C void | SetFullScreenApp | ( | TBool | aIsFullScreen | ) | [protected] |
Set the application to be a full screen application.
TBool aIsFullScreen | is ETrue if the application is a full screen application, EFlase otherwise. |
IMPORT_C void | SetKeyEventFlags | ( | const TInt | aFlags | ) |
Sets the flags for default key event handling 5.0
const TInt aFlags | which can be a combination of flags declared in enumeration TKeyEventFlag |
IMPORT_C void | SetLayoutAwareApp | ( | TBool | aLayoutAwareApp | ) |
Set application layout aware.
TBool aLayoutAwareApp | ETrue if the application is layout aware, EFlase otherwise. |
IMPORT_C void | SetLocalUiZoom | ( | TAknUiZoom | aZoom | ) |
Sets the application local zoom. However, in order to have any effect, it may be necessary to make a subsequent call to ApplyLayoutChangeL.
3.1
TAknUiZoom aZoom | application local zoom |
IMPORT_C void | SetOrientationL | ( | TAppUiOrientation | aOrientation | ) |
Sets the application screen orientation. Note: this API has no effect on non-full-screen app UIs.
TAppUiOrientation aOrientation | application screen orientation. |
void | SimulateWsEventL | ( | TInt | aEvent | ) |
Simulates an event being received from wserv
TInt aEvent | the event id being simulated. |
TBool | ThreadIsForeground | ( | ) | const |
Determines whether the thread owning this application window group is foreground. ETrue if the thread owning this application window group is foreground, EFlase otherwise.
void | UpdateSettingCacheAndForwardEventL | ( | TInt | aEventId | ) | [private] |
TInt aEventId |
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. S60 3.2 |
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. S60 5.0 |
EAknSingleClickCompatibleFlag = 0x01000000 |
Application supports single click. S60 5.2 |
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. S60 2.0 |
EAppOrientationPortrait = EAppOrientationSpecifiedFlag | |
EAppOrientationLandscape = EAppOrientationSpecifiedFlag | EAppOrientationLandscapeFlag | |
EAppOrientationAutomatic = EAppOrientationSpecifiedFlag | EAppOrientationAutomaticFlag | |
EAknDisableHighlightAnimation = EAknDisableHighlightAnimationFlag | |
EAknEnableMSK = EAknEnableMSKflag | |
EAknExplicitStartupEffectCompletion = EAknExplicitStartupEffectCompletionFlag | |
EAknTouchCompatible = EAknTouchCompatibleFlag | |
EAknSingleClickCompatible = EAknSingleClickCompatibleFlag |
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. |