TAknScreenModes Class Reference

class TAknScreenModes

TAknScreenModes is a collection of available screen modes on this device, with API for setting an application's screen mode.

Since
3.1
Public Member Functions
TAknScreenModes(const SAknLayoutConfig &)
IMPORT_C TIntCount()
IMPORT_C TAknScreenModesGetModes()
IMPORT_C voidSetAppUiScreenModeL(CAknAppUiBase *, const TAknScreenMode &)
IMPORT_C TAknScreenModeoperator[](TInt)
Protected Attributes
const SAknLayoutConfig &iInfo

Constructor & Destructor Documentation

TAknScreenModes(const SAknLayoutConfig &)

TAknScreenModes(const SAknLayoutConfig &aInfo)

Parameters

const SAknLayoutConfig & aInfo

Member Functions Documentation

Count()

IMPORT_C TIntCount()const

Get the number of screen modes.

GetModes()

IMPORT_C TAknScreenModesGetModes()[static]

Factory function.

SetAppUiScreenModeL(CAknAppUiBase *, const TAknScreenMode &)

IMPORT_C voidSetAppUiScreenModeL(CAknAppUiBase *aAppUi,
const TAknScreenMode &aMode
)[static]

Set the screen mode for an application UI. The application will be displayed in the selected screen mode. The application will no longer respond to hardware or software events which would normally affect screen mode. It will be permanently fixed to the selected screen mode. By using this API, the application effectively declares itself to be non-scalable. Notifier dialogs and other non-full-screen UI will appear in the selected screen mode when displayed over this app. Other full-screen applications will not be affected by this call, except in that switching between this app and other apps using different screen modes will be slow. The screen mode selected must be one returned through the API of this class. There are no fixed screen modes which will appear on every device. The emulator may support many screen modes, but any particular device will probably only support one or two modes. Setting a screen mode may result in the application looking low resolution, badly positioned, the wrong shape, incorrect for certain hardware configurations (eg softkeys in the wrong place), only taking up part of the screen, other applications being visible behind it and generally bad in many other ways. It is strongly recommended that application authors write their applications to be scalable, rather than use this API. If an application wants a fixed orientation, it should use CAknAppUiBase::SetOrientationL(). Note: this API has no effect on non-full-screen app UIs.

Parameters

CAknAppUiBase * aAppUiThe app UI.
const TAknScreenMode & aModeA screen mode accessed through this API.

operator[](TInt)

IMPORT_C TAknScreenModeoperator[](TIntaIndex)const

Get screen mode information by index.

Parameters

TInt aIndex

Member Data Documentation

const SAknLayoutConfig & iInfo

const SAknLayoutConfig &iInfo[protected]