CAknEnv Class Reference

IMPORT_C const AknLayout::CInstance& CAknEnv::AknLayout

�	Destructor.

Member Function Documentation

�	Accessor method to layout. Returns: Reference to the Layout.

static IMPORT_C CAknAppUi* CAknEnv::AppWithShutterRunning (� �)� [static]

�	Get pointer to the most embedded application UI with Dialog Shutter running. Returns: Pointer to the most embedded application UI with Dialog Shutter running. `NULL` if no any Dialog Shutter running.

static IMPORT_C TRgb CAknEnv::AvkonColor (� TInt� �)� [static]

aIndex of the colour lookup table, integer between 0 and 255.

Gets the TRgb value of the entry at the specified index in the colour lookup table.

Parameters:

The�

Returns:: The TRgb value of the colour lookup table at the aIndex.

IMPORT_C void CAknEnv::CancelWsBufferRequest

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:

aRequestID� The request ID returned by the RequestWsBuffer call which is to be canceled. Negative values are treated as error codes and ignored.

IMPORT_C void CAknEnv::CloseAllIntermediateStates

�	Closes all intermediate states as a low-priority process.

IMPORT_C void CAknEnv::CreateCbaObserverL	(�	CEikButtonGroupContainer *�	aCba,
		CEikListBox *�	aListBox
	)�

IMPORT_C MAknEditingStateIndicator* CAknEnv::EditingStateIndicator

Create CBA observer.

The possible existing one is removed first.

Parameters:

	aCba�	A control which `ProcessCommandL` handles the command.
	aListBox�	Stored to data member `iListBox`.

�	Get the editing state indicator. Returns: Pointer to the editing state indicator.

IMPORT_C void CAknEnv::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:

	aEmptyText�	Text indicating empty popup list. NULL if `R_AVKON_EMPTY_POPUP_LIST_TEXT` used.
	aTitle�	A title of the popup list.
	aSoftKeyId�	CBA resource to be used as a base. 0 if `R_AVKON_SOFTKEYS_CANCEL` is used.

IMPORT_C void CAknEnv::ExecuteEmptyPopupListL (� const TDesC *� aEmptyText = 0 �)�

IMPORT_C MEikMenuObserver* CAknEnv::FepMenuObserver

Executes empty popup list.

Parameters:

aEmptyText� Text indicating empty popup list. NULL if R_AVKON_EMPTY_POPUP_LIST_TEXT used.

static IMPORT_C void CAknEnv::ExitForegroundAppL (� �)� [static]

�	Exit foreground application.

CAknFontRegistry& CAknEnv::FontRegistry

�	Get the FEP menu observer. Returns: Pointer to the FEP menu observer.

IMPORT_C void CAknEnv::GetCurrentGlobalUiZoom

�	Access to the registry of CAknLayoutFont pointers. Used for runtime checking of CFont pointers.

TAknUiZoom &�

aCurrentGlobalUiZoom

On return, contains current global zoom.

Get current global zoom.

Parameters:

aCurrentGlobalUiZoom�

IMPORT_C void CAknEnv::GetCurrentLayoutId

Get current layout ID.

Parameters:

aCurrentLayoutId�

On return, contains current layout ID.

IMPORT_C void CAknEnv::InformCbaDeletion

CEikButtonGroupContainer *�

aCba

IMPORT_C TBool CAknEnv::LoadAknLayoutL

Remove CBA observer if the right one.

Parameters:

aCba�

CBA to be checked.

const TAknLayoutConfigScreenMode &�

aScreenMode

The screen mode which the layout is required for

Load an appropriate Avkon layout for a particular screen mode.

Public since 3rd Ed FP1

Parameters:

aScreenMode�

Returns:: EFalse if the layout is already loaded.

IMPORT_C TBool CAknEnv::LoadAknLayoutL

IMPORT_C void CAknEnv::RegisterIntermediateStateL

�	Load an appropraite Avkon layout. Public Since 3rd Ed FP1 Returns: `EFalse` if the layout is already loaded.

MAknIntermediateState *�

aState

The control implementing intermediate states.

Call iAvkonEnv->RegisterIntermediateState(this) in control's ActivateL().

Parameters:

aState�

IMPORT_C void CAknEnv::RemoveCbaObserver

IMPORT_C TInt CAknEnv::RequestWsBuffer

�	Remove CBA observer.

TInt�

aRequestedBufferSize

requested Window Server client buffer size.

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:

aRequestedBufferSize�

Returns:: Request ID. This is used when the request is canceled. In OOM situation, KErrNoMemory is returned. CancelWsBufferRequest ignores negative values as error codes so it is OK to pass any value returned by this method to CancelWsBufferRequest.

static IMPORT_C void CAknEnv::RunAppShutter (� �)� [static]

�	Run application shutter.

IMPORT_C void CAknEnv::SetFepMenuObserver

Set the FEP menu observer.

Parameters:

aObserver�

the FEP menu observer.

IMPORT_C CAknSettingCache& CAknEnv::SettingCache

void CAknEnv::SplitViewActive

Sets split view flag.

Parameters:

aSplitViewActive�

Etrue if split view is active.

IMPORT_C TBool CAknEnv::SplitViewActive

�	Checks if split view is active. Returns: ETrue if split view is active.

static IMPORT_C CAknEnv* CAknEnv::Static (� �)� [static]

IMPORT_C TInt CAknEnv::StatusPaneResIdForCurrentLayout

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.

Returns:: A static CAknEnv.

Tells the type of status pane layout for UI.

Parameters:

aResId�

resource id for current layout.

Returns:: Resource id equivalent type of status pane layout.

static IMPORT_C void CAknEnv::StopSchedulerWaitWithBusyMessage (� CActiveSchedulerWait &� aWait �)� [static]

Scheduler object to be stopped.

Stop the scheduler.

If the waiting control can't stop the scheduler immediately, then trying to show a busy note.

Parameters:

aWait�

IMPORT_C MAknEditingStateIndicator* CAknEnv::SwapEditingStateIndicator

MAknEditingStateIndicator *�

aIndicator

The new editing state indicator.

Swap the editing state indicator.

Parameters:

aIndicator�

Returns:: The old editing state indicator.

CArrayPtr<CAknSystemFont>* CAknEnv::SystemFontArray

IMPORT_C void CAknEnv::UnRegisterIntermediateState

�	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.

MAknIntermediateState *�

aState