CAknEnv Class Reference
| class CAknEnv : public CBase |
This class is a Series 60 extension to CEikonEnv. Every Avkon application is provided with an instance of CAvkEnv by the framework, which can be accessed through the iAvkonEnv macro.
Nested Classes and Structures
Constructor & Destructor Documentation
CAknEnv()
| IMPORT_C | CAknEnv | ( | ) | [private] |
Member Functions Documentation
AknLayout()
Accessor method to layout.
AppWithShutterRunning()
| IMPORT_C CAknAppUi * | AppWithShutterRunning | ( | ) | [static] |
Get pointer to the most embedded application UI with Dialog Shutter running.
AssertLayoutLoaded()
| void | AssertLayoutLoaded | ( | ) | [private] |
AvkonColor(TInt)
Gets the TRgb value of the entry at the specified index in the colour lookup table.
CancelWsBufferRequest(TInt)
| IMPORT_C void | CancelWsBufferRequest | ( | TInt | aRequestID | ) | |
Cancels a request made by call RequestWsBuffer. This should be called in order to save RAM when higher than normal buffer size is no longer required.
Parameters
| TInt aRequestID | The request ID returned by the RequestWsBuffer call which is to be canceled. Negative values are treated as error codes and ignored. |
CloseAllIntermediateStates()
| IMPORT_C void | CloseAllIntermediateStates | ( | ) | |
Closes all intermediate states as a low-priority process.
ConstructL()
| IMPORT_C void | ConstructL | ( | ) | [private] |
CreateCbaObserverL(CEikButtonGroupContainer *, CEikListBox *)
| IMPORT_C void | CreateCbaObserverL | ( | CEikButtonGroupContainer * | aCba, |
| | CEikListBox * | aListBox |
| | ) | |
Create CBA observer. The possible existing one is removed first.
Parameters
| CEikButtonGroupContainer * aCba | A control which ProcessCommandL handles the command. |
| CEikListBox * aListBox | Stored to data member iListBox. |
DoSchedulerStoppedCallBack()
| void | DoSchedulerStoppedCallBack | ( | ) | [private] |
EditingStateIndicator()
Get the editing state indicator.
EndCommandMediation(MEikCommandObserver &)
Ends mediating MSK commands to specified command observer. If commands are being mediated to the specifed observer, the command mediator is removed from the CBA to end mediation.
ExecuteEmptyPopupListL(const TDesC *)
| IMPORT_C void | ExecuteEmptyPopupListL | ( | const TDesC * | aEmptyText = 0 | ) | |
Executes empty popup list.
Parameters
| const TDesC * aEmptyText = 0 | Text indicating empty popup list. NULL if R_AVKON_EMPTY_POPUP_LIST_TEXT used. |
ExecuteEmptyPopupListL(const TDesC *, const TDesC *, TInt)
| IMPORT_C void | ExecuteEmptyPopupListL | ( | const TDesC * | aEmptyText, |
| | const TDesC * | aTitle, |
| | TInt | aSoftkeyId = 0 |
| | ) | |
Executes empty popup list. aSoftkeyId is soft key rescource used, but shown without left soft key (except R_AVKON_SOFTKEYS_OK_EMPTY).
Parameters
| const TDesC * aEmptyText | Text indicating empty popup list. NULL if R_AVKON_EMPTY_POPUP_LIST_TEXT used. |
| const TDesC * aTitle | A title of the popup list. |
| TInt aSoftkeyId = 0 | |
ExitForegroundAppL()
| IMPORT_C void | ExitForegroundAppL | ( | ) | [static] |
Exit foreground application.
FepMenuObserver()
Get the FEP menu observer.
FontRegistry()
| CAknFontRegistry & | FontRegistry | ( | ) | const |
Access to the registry of CAknLayoutFont pointers. Used for runtime checking of CFont pointers.
GetCurrentGlobalUiZoom(TAknUiZoom &)
| IMPORT_C void | GetCurrentGlobalUiZoom | ( | TAknUiZoom & | aCurrentGlobalUiZoom | ) | const |
Get current global zoom
- Since
- 3.1
Parameters
| TAknUiZoom & aCurrentGlobalUiZoom | On return, contains current global zoom. |
GetCurrentLayoutId(TAknLayoutId &)
| IMPORT_C void | GetCurrentLayoutId | ( | TAknLayoutId & | aCurrentLayoutId | ) | const |
Get current layout ID.
- Since
- Series 60 2.0
Parameters
| TAknLayoutId & aCurrentLayoutId | On return, contains current layout ID. |
InformCbaDeletion(CEikButtonGroupContainer *)
| IMPORT_C void | InformCbaDeletion | ( | CEikButtonGroupContainer * | aCba | ) | |
Remove CBA observer if the right one.
Parameters
| CEikButtonGroupContainer * aCba | CBA to be checked. |
InstallAknEnvAsExtensionL(CEikonEnv *)
| IMPORT_C void | InstallAknEnvAsExtensionL | ( | CEikonEnv * | aEnv | ) | [private, static] |
IsFeatureLanguage(TInt)
|
TBool
| IsFeatureLanguage | ( | TInt | aFeatureLanguage | ) | |
LoadAknLayoutL()
| IMPORT_C TBool | LoadAknLayoutL | ( | ) | |
Load an appropriate Avkon layout.
LoadAknLayoutL(const TAknLayoutConfigScreenMode &)
| IMPORT_C TBool | LoadAknLayoutL | ( | const TAknLayoutConfigScreenMode & | aScreenMode | ) | |
Load an appropriate Avkon layout for a particular screen mode.
Parameters
| const TAknLayoutConfigScreenMode & aScreenMode | The screen mode which the layout is required for |
LoadAknLayoutL(TAknLayoutId, const TAknLayoutConfigScreenMode &, TAknUiZoom)
PrepareRunInfoArray(const TDesC &)
|
TInt
| PrepareRunInfoArray | ( | const TDesC & | aLogicalText | ) | [private] |
Tests how big run info array the given text requires and tries to increase the size of the array if required.
Parameters
| const TDesC & aLogicalText | Text in logical order. |
RealCloseIntermediateStates(TAny *)
|
TInt
| RealCloseIntermediateStates | ( | TAny * | aEnv | ) | [private, static] |
RegisterIntermediateStateL(MAknIntermediateState *)
Register the control implementing intermediate states. Call iAvkonEnv->RegisterIntermediateState(this) in control's ActivateL().
ReloadAknLayoutL()
Re-load the current Avkon layout, in case there are new layout instances present.
RemoveCbaObserver()
| IMPORT_C void | RemoveCbaObserver | ( | ) | |
RequestCommandMediationL(CEikButtonGroupContainer &, MEikCommandObserver &)
| IMPORT_C void | RequestCommandMediationL | ( | CEikButtonGroupContainer & | aCba, |
| | MEikCommandObserver & | aCommandObserver |
| | ) | |
Requests mediation of MSK commmands from specified CBA to the given observer. When called for the first time, this method creates an observer that is added to specified CBA to observe MSK commands and to mediate all received events to the given observer. The created observer exists until the CAknEnv instance is destroyed. All subsequent calls to this method replace the previously requested mediation.
Parameters
| CEikButtonGroupContainer & aCba | CBA whose MSK is to be observed. |
| MEikCommandObserver & aCommandObserver | An observer for which the commands are sent. |
RequestWsBuffer(TInt)
| IMPORT_C TInt | RequestWsBuffer | ( | TInt | aRequestedBufferSize | ) | |
Requests Window Server client buffer used by the application to be of at least the given size. All code that wants to increase (to avoid flicker) or decrease (to save RAM) the buffer compared to the default size should call this method instead of using WS interface directly. A list of all requests is maintained and the highest request is always effective. Only if there are no requests done, the default buffer size is used.
Parameters
| TInt aRequestedBufferSize | requested Window Server client buffer size. |
RunAppShutter()
| IMPORT_C void | RunAppShutter | ( | ) | [static] |
RunInfoArray(TInt &)
Returns run info array owned by AknEnv.
Parameters
| TInt & aLength | Length of the array is returned here. |
SchedulerStoppedCallBack(TAny *)
|
TInt
| SchedulerStoppedCallBack | ( | TAny * | aWaitNote | ) | [private, static] |
SetConeFontSizeArrayL()
| void | SetConeFontSizeArrayL | ( | ) | const [private] |
Use the currently loaded layout to set the values of the font size array used by CCoeFontProvider.
SetFepMenuObserver(MEikMenuObserver *)
Set the FEP menu observer.
SetLayoutRequirementsL()
| void | SetLayoutRequirementsL | ( | ) | [private] |
SetRequiredRunInfoArraySize(TInt)
|
TInt
| SetRequiredRunInfoArraySize | ( | TInt | aLength | ) | [private] |
Tries to increase the size of the run info array if it is currently smaller than given length.
Parameters
| TInt aLength | Length of the new run info array to be allocated. |
SetWsBufferSize()
| void | SetWsBufferSize | ( | ) | [private] |
SetWsBufferSize(TInt)
| void | SetWsBufferSize | ( | TInt | aRequestedBufferSize | ) | [private] |
Parameters
| TInt aRequestedBufferSize | |
SettingCache()
| IMPORT_C CAknSettingCache & | SettingCache | ( | ) | const |
ShutOrHideAppL()
| void | ShutOrHideAppL | ( | ) | [static] |
SplitViewActive()
| IMPORT_C TBool | SplitViewActive | ( | ) | const |
Checks if split view is active.
- Since
- Series 60 5.0
SplitViewActive(const TBool)
| void | SplitViewActive | ( | const TBool | aSplitViewActive | ) | |
Sets split view flag.
- Since
- Series 60 5.0
Parameters
| const TBool aSplitViewActive | Etrue if split view is active. |
Static()
Gets the CAknEnv maintained by the framework for the application. Compare CCoeEnv::Static().
This function should never be run in a thread where such a static Avkon environment does not exist. Code that may run on the server side of an application server is one such case.
StatusPaneResIdForCurrentLayout(TInt)
| IMPORT_C TInt | StatusPaneResIdForCurrentLayout | ( | TInt | aResId | ) | const |
Tells the type of status pane layout for UI.
- Since
- Series 60 2.0
Parameters
| TInt aResId | resource id for current layout. |
StopSchedulerWaitWithBusyMessage(CActiveSchedulerWait &)
Stop the scheduler. If the waiting control can't stop the scheduler immediately, then trying to show a busy note.
SwapEditingStateIndicator(MAknEditingStateIndicator *)
Swap the editing state indicator.
SystemFontArray()
Access to the system font array that is owned by CEikonEnv. The member accessed by this is set during CEikonEnv construction and may be null during application startup.
TransitionEvent(TInt, const TUid &)
| void | TransitionEvent | ( | TInt | aEvent, |
| | const TUid & | aAppUid |
| | ) | |
TransitionEvent(TInt)
| void | TransitionEvent | ( | TInt | aEvent | ) | |
TransparencyEnabled()
| IMPORT_C TBool | TransparencyEnabled | ( | ) | const |
Return if Transparency is Enabled .
TryLoadAknLayoutL(TAknLayoutId, const TAknLayoutConfigScreenMode &, TAknUiZoom)
UnRegisterIntermediateState(MAknIntermediateState *)
Unregister the control implementing intermediate states. Call iAvkonEnv->UnRegisterIntermediateState(this) in control's destructor.
Member Data Documentation
TInt
iBusyMsgCount
|
TInt
| iBusyMsgCount | [private] |
CAknWaitDialog * iBusyMsgDialog
| CAknWaitDialog * | iBusyMsgDialog | [private] |
MEikCommandObserver * iCbaCommandObserver
CCdlEngineRef * iCdlEngRef
| CCdlEngineRef * | iCdlEngRef | [private] |
CAknCommandMediator * iCommandMediator
| CAknCommandMediator * | iCommandMediator | [private] |
TInt
iCurrentWsBufferRequest
|
TInt
| iCurrentWsBufferRequest | [private] |
CArrayPtr< CBase > * iDeleteArray
MAknEditingStateIndicator * iEditStateIndicator
TInt
iFeatureLanguage
|
TInt
| iFeatureLanguage | [private] |
MEikMenuObserver * iFepMenuObserver
CAknFontRegistry * iFontRegistry
| CAknFontRegistry * | iFontRegistry | [private] |
TAknLayoutId
iLastLayoutId
TInt
iLastScreenMode
|
TInt
| iLastScreenMode | [private] |
const AknLayout::CInstance * iLayout
TInt
iRequestIdCounter
|
TInt
| iRequestIdCounter | [private] |
TBidirectionalState::TRunInfo * iRunInfoArray
TInt
iRunInfoArrayLength
|
TInt
| iRunInfoArrayLength | [private] |
CAknSettingCache * iSettingCache
| CAknSettingCache * | iSettingCache | [private] |
TBool
iSplitViewActive
|
TBool
| iSplitViewActive | [private] |
CArrayPtr< MAknIntermediateState > * iStateArray
CArrayPtr< CAknSystemFont > * iSystemFontArray
CTransitionManager * iTransitionManager
| CTransitionManager * | iTransitionManager | [private] |
RArray< TWsBufferRequest > iWsBufferRequestArray
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.