Collapse all Symbian^3 Application Developer Library

CPowerSaveDisplayMode Class Reference

class CPowerSaveDisplayMode : public CBase

Adaptation API for power save display mode use

Since: Series 60 3.0

Inherits from

CPowerSaveDisplayMode
- CBase

Public Member Functions
	~CPowerSaveDisplayMode ()
IMPORT_C TInt	Exit ()
IMPORT_C CPowerSaveDisplayMode::TPowerSaveLevel	GetPowerSaveLevel ()
IMPORT_C TUint	MaxLines ()
IMPORT_C CPowerSaveDisplayMode *	NewL ( TInt )
IMPORT_C TInt	Set ( TUint , TUint , TBool )
IMPORT_C TInt	Set ( TUint , TUint , TUint16 *, TBool )
IMPORT_C TInt	SetPowerSaveLevel ( CPowerSaveDisplayMode::TPowerSaveLevel )
IMPORT_C TBool	Status ()

Private Member Functions
	CPowerSaveDisplayMode ()
void	ConstructL ( TInt )

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()

Public Member Enumerations
enum	TPowerSaveLevel { ENone = 0, ELow = 1, EMedium = 2, EHigh = 3 }

Private Attributes
TAny *	iDisplayDriver

Constructor & Destructor Documentation

CPowerSaveDisplayMode()

CPowerSaveDisplayMode

(

)

[private]

power_save_display_mode.h

~CPowerSaveDisplayMode()

IMPORT_C

~CPowerSaveDisplayMode

(

)

power_save_display_mode.h

Member Functions Documentation

ConstructL(TInt)

void

ConstructL

(

TInt

aDisplayNumber

)

[private]

power_save_display_mode.h

Parameters

TInt aDisplayNumber

Exit()

IMPORT_C TInt

Exit

(

)

Turns off power save mode. All lines on display will be shown normally. power_save_display_mode.h

GetPowerSaveLevel()

IMPORT_C CPowerSaveDisplayMode::TPowerSaveLevel

GetPowerSaveLevel

(

)

Return the current power save level. power_save_display_mode.h

MaxLines()

IMPORT_C TUint

MaxLines

(

)

Returns max number of lines that display supports in power save mode (e.g.50 lines or full screen). power_save_display_mode.h

NewL(TInt)

IMPORT_C CPowerSaveDisplayMode *

NewL

(

TInt

aDisplayNumber = 0

)

[static]

Creates object and connects to display. power_save_display_mode.h

Parameters

TInt aDisplayNumber = 0

Which display to connect to, default is primary display.

Set(TUint, TUint, TBool)

IMPORT_C TInt	Set	(	TUint	aStartRow,
			TUint	aEndRow,
			TBool	aFullColors = EFalse
		)

Enables power save mode. Sets lines between given parameters visible, other display lines are turned off and not shown.

Pre-condition: Image to display must be drawn in videobuffer before calling Set() .

power_save_display_mode.h

Parameters

TUint aStartRow	First visible line, starting from 0
TUint aEndRow	Last visible line
TBool aFullColors = EFalse	Full color mode if ETrue and hw supports that Note: full color mode consumes more power

Set(TUint, TUint, TUint16 *, TBool)

IMPORT_C TInt	Set	(	TUint	aStartRow,
			TUint	aEndRow,
			TUint16 *	aPixels,
			TBool	aFullColors = EFalse
		)

Enables power save mode. Sets lines between given parameters visible, other display lines are turned off and not shown.

Pre-condition: Image to display must be drawn in videobuffer before calling Set() .

power_save_display_mode.h

Parameters

TUint aStartRow	First visible line, starting from 0
TUint aEndRow	Last visible line
TUint16 * aPixels	Pointer to array of color of each pixel
TBool aFullColors = EFalse	Full color mode if ETrue and hw supports that Note: full color mode consumes more power

SetPowerSaveLevel(CPowerSaveDisplayMode::TPowerSaveLevel)

IMPORT_C TInt

SetPowerSaveLevel

(

CPowerSaveDisplayMode::TPowerSaveLevel

aVal

)

Changes the current power save level. power_save_display_mode.h

Parameters

CPowerSaveDisplayMode::TPowerSaveLevel aVal

New power save level

Status()

IMPORT_C TBool

Status

(

)

Returns status of power save mode. power_save_display_mode.h

Member Enumerations Documentation

Enum TPowerSaveLevel

Power save levels define how much power should be saved. Note: higher settings result in lower image quality.

Enumerators

ENone = 0
ELow = 1
EMedium = 2
EHigh = 3

Member Data Documentation

TAny * iDisplayDriver

TAny *

iDisplayDriver

[private]