CWsScreenDevice Class Reference

#include <w32std.h>

Link against: ws32_nga.lib

class CWsScreenDevice : public CBitmapDevice

Inherits from

CWsScreenDevice

Nested Classes and Structures

CWsScreenDevice::CScrDevExtension

Public Member Enumerations
enum	TSpriteInCompare { ERemoveSprite, EIncludeSprite, EIncludeTextCursor }

Public Member Functions
	CWsScreenDevice()
	CWsScreenDevice(RWsSession &)
	~CWsScreenDevice()
virtual IMPORT_C TInt	AddFile(const TDesC &, TInt &)
IMPORT_C TInt	Construct()
IMPORT_C TInt	Construct(TInt)
IMPORT_C TInt	CopyScreenToBitmap(const CFbsBitmap *)
IMPORT_C TInt	CopyScreenToBitmap(const CFbsBitmap *, const TRect &)
virtual IMPORT_C TInt	CreateContext(CGraphicsContext *&)
TInt	CreateContext(CWindowGc *&)
IMPORT_C TInt	CurrentScreenMode()
virtual IMPORT_C TDisplayMode	DisplayMode()
virtual IMPORT_C TInt	FontHeightInPixels(TInt, TInt)
virtual IMPORT_C TInt	FontHeightInTwips(TInt, TInt)
IMPORT_C TSizeMode	GetCurrentScreenModeAttributes()
IMPORT_C TSize	GetCurrentScreenModeScale()
IMPORT_C TPoint	GetCurrentScreenModeScaledOrigin()
IMPORT_C TPoint	GetDefaultScreenModeOrigin()
IMPORT_C void	GetDefaultScreenSizeAndRotation(TPixelsTwipsAndRotation &)
IMPORT_C void	GetDefaultScreenSizeAndRotation(TPixelsAndRotation &)
IMPORT_C TInt	GetFontById(CFont *&, TUid, const TAlgStyle &)
IMPORT_C TAny *	GetInterface(TUint)
const TAny *	GetInterface(TUint)
virtual IMPORT_C TInt	GetNearestFontInPixels(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontInTwips(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontToDesignHeightInPixels(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontToDesignHeightInTwips(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontToMaxHeightInPixels(CFont *&, const TFontSpec &, TInt)
virtual IMPORT_C TInt	GetNearestFontToMaxHeightInTwips(CFont *&, const TFontSpec &, TInt)
virtual IMPORT_C TInt	GetPalette(CPalette *&)
virtual IMPORT_C void	GetPixel(TRgb &, const TPoint &)
IMPORT_C TInt	GetRotationsList(TInt, CArrayFixFlat< TInt > *)
virtual IMPORT_C void	GetScanLine(TDes8 &, const TPoint &, TInt, TDisplayMode)
IMPORT_C TDisplayMode	GetScreenModeDisplayMode(const TInt &)
IMPORT_C TPoint	GetScreenModeOrigin(TInt)
IMPORT_C TSize	GetScreenModeScale(TInt)
IMPORT_C TPoint	GetScreenModeScaledOrigin(TInt)
IMPORT_C void	GetScreenModeSizeAndRotation(TInt, TPixelsTwipsAndRotation &)
IMPORT_C void	GetScreenModeSizeAndRotation(TInt, TPixelsAndRotation &)
IMPORT_C TInt	GetScreenNumber()
IMPORT_C TInt	GetScreenSizeModeList(RArray< TInt > *)
IMPORT_C TInt	HorizontalPixelsToTwips(TInt)
IMPORT_C TInt	HorizontalTwipsToPixels(TInt)
IMPORT_C TBool	IsCurrentModeDynamic()
IMPORT_C TBool	IsModeDynamic(TInt)
IMPORT_C TInt	NumScreenModes()
virtual IMPORT_C TInt	NumTypefaces()
virtual IMPORT_C void	PaletteAttributes(TBool &, TInt &)
IMPORT_C TRect	PointerRect()
IMPORT_C TBool	RectCompare(const TRect &, const TRect &)
IMPORT_C TBool	RectCompare(const TRect &, const TRect &, TUint)
IMPORT_C void	ReleaseFont(CFont *)
virtual IMPORT_C void	RemoveFile(TInt)
IMPORT_C TScreenModeEnforcement	ScreenModeEnforcement()
IMPORT_C void	SetAppScreenMode(TInt)
IMPORT_C TInt	SetBackLight(TBool)
IMPORT_C void	SetCurrentRotations(TInt, CFbsBitGc::TGraphicsOrientation)
IMPORT_C void	SetCurrentScreenModeAttributes(const TSizeMode &)
IMPORT_C TInt	SetCustomPalette(const CPalette *)
virtual IMPORT_C void	SetPalette(CPalette *)
IMPORT_C void	SetScreenMode(TInt)
IMPORT_C void	SetScreenModeEnforcement(TScreenModeEnforcement)
IMPORT_C void	SetScreenSizeAndRotation(const TPixelsTwipsAndRotation &)
IMPORT_C void	SetScreenSizeAndRotation(const TPixelsAndRotation &)
virtual IMPORT_C TSize	SizeInPixels()
virtual IMPORT_C TSize	SizeInTwips()
virtual IMPORT_C void	TypefaceSupport(TTypefaceSupport &, TInt)
IMPORT_C TInt	VerticalPixelsToTwips(TInt)
IMPORT_C TInt	VerticalTwipsToPixels(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()
	CBitmapDevice::CreateBitmapContext(CBitmapContext *&)

Detailed Description

Software device screen.

An object of this class can be used to enquire or set parameters of the software screen, and determine the physical limits of the device.

CWsScreenDevice gives access to the list of screen modes. These are the combinations of screen rotation and screen size supported by the device. One of them is selected as the current screen mode. The possible screen modes are initialised in wsini.ini.

Member Enumeration Documentation

Enum TSpriteInCompare

Whether or not to include sprites when comparing areas of the screen

Enumerator	Value	Description
ERemoveSprite	0	This enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(const TRect &aRect1, const TRect &aRect2,TUint aFlags). When called with the value ERemoveSprite if there are any sprites visible in the areas of the screen being compared then these will not be included in the comparison. The function CWsScreenDevice::RectCompare(const TRect &aRect1,const TRect &aRect2) will not include sprites in the comparison.
EIncludeSprite	1	This enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(const TRect &aRect1, const TRect &aRect2,TUint aFlags). When called with the value EIncludeSprite if there are any sprites visible in the areas of the screen being compared then these will be included in the comparison.
EIncludeTextCursor	2	This enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(const TRect &aRect1, const TRect &aRect2,TUint aFlags). When called with the value EIncludeTextCursor if there are any text cursors visible in the areas of the screen being compared then these will be included in the comparison.

Constructor & Destructor Documentation

CWsScreenDevice ( )

IMPORT_C

CWsScreenDevice

(

)

Default constructor. Developers should use the other constructor overload.

CWsScreenDevice ( RWsSession & )

IMPORT_C

CWsScreenDevice

(

RWsSession &

aWs

)

Constructs a new screen device attached to a particular window server session.

Parameter	Description
aWs	The window server session this screen should be attached to.

~CWsScreenDevice ( )

IMPORT_C

~CWsScreenDevice

(

)

Destructor.

Member Function Documentation

AddFile ( const TDesC &, TInt & )

IMPORT_C TInt	AddFile	(	const TDesC &	aName,
			TInt &	aId
		)	[virtual]

Reimplemented from CBitmapDevice::AddFile(const TDesC &,TInt &)

Adds a font file to the device's typeface store. The specified font file must be accessible to any process, i.e. not located inside an application's private directory.

Parameter	Description
aName	Name of the font file.
aId	ID for the font file.

Construct ( )

IMPORT_C TInt

Construct

(

)

Completes construction of the object.

This method invokes Construct(TInt aDefaultScreenNumber) with default Screen number.

Returns: KErrNone if successful, otherwise another of the system-wide error codes.

Construct ( TInt )

IMPORT_C TInt

Construct

(

TInt

aDefaultScreenNumber

)

Completes construction of the object.

This function always causes a flush of the window server buffer.

panic: TW32Panic 17 in debug builds if called on an already constructed object.

Parameter	Description
aDefaultScreenNumber	- This is the screen on which an application will start

Returns: KErrNone if successful, otherwise another of the system-wide error codes.

CopyScreenToBitmap ( const CFbsBitmap * )

IMPORT_C TInt

CopyScreenToBitmap

(

const CFbsBitmap *

aBitmap

)

const

Saves the entire screen to a bitmap.

This function always causes a flush of the window server buffer.

Parameter	Description
aBitmap	Bitmap to be filled with the screen image.

Returns: KErrNone if successful, otherwise one of the system-wide error codes.

CopyScreenToBitmap ( const CFbsBitmap *, const TRect & )

IMPORT_C TInt	CopyScreenToBitmap	(	const CFbsBitmap *	aBitmap,
			const TRect &	aRect
		)	const

Saves a region of the screen to a bitmap.

This function always causes a flush of the window server buffer.

Parameter	Description
aBitmap	Bitmap to be filled with the screen region image.
aRect	Screen region to be saved.

Returns: KErrNone if successful, otherwise one of the system-wide error codes.

CreateContext ( CGraphicsContext *& )

IMPORT_C TInt

CreateContext

(

CGraphicsContext *&

aGc

)

[virtual]

Reimplemented from CGraphicsDevice::CreateContext(CGraphicsContext *&)

Creates a graphics context for this device.

This function always causes a flush of the window server buffer.

Parameter	Description
aGc	On successful return, contains a new graphics context referring to this screen device.

Returns: KErrNone if successful, otherwise one of the system-wide error codes.

CreateContext ( CWindowGc *& )

TInt

CreateContext

(

CWindowGc *&

aGc

)

[inline]

Creates a graphics context for this device.

This function always causes a flush of the window server buffer.

Parameter	Description
aGc	On successful return, contains a new graphics context referring to this screen device.

Returns: KErrNone if successful, otherwise one of the system-wide error codes.

CurrentScreenMode ( )

IMPORT_C TInt

CurrentScreenMode

(

)

const

Gets the current screen mode index.

This function always causes a flush of the window server buffer.

Returns: The index into the list of available screen modes of the current screen mode.

DisplayMode ( )

IMPORT_C TDisplayMode

DisplayMode

(

)

const [virtual]

Reimplemented from CGraphicsDevice::DisplayMode()const

Gets the device's display mode.

This function always causes a flush of the window server buffer.

Returns: The device's display mode.

FontHeightInPixels ( TInt, TInt )

IMPORT_C TInt	FontHeightInPixels	(	TInt	aTypefaceIndex,
			TInt	aHeightIndex
		)	const [virtual]

Reimplemented from CBitmapDevice::FontHeightInPixels(TInt,TInt)const

Gets the height of the specified font in pixels.

The value returned is rounded up or down to the nearest font height in pixels.

The specified font is the one with height index number aHeightIndex of the typeface with index number aTypefaceIndex.

Parameter	Description
aTypefaceIndex	A typeface index number, in the range: 0 to (NumTypefaces() - 1).
aHeightIndex	A font height index number, in the range: 0 to (iNumHeights - 1).

Returns: The height of the font in pixels.

FontHeightInTwips ( TInt, TInt )

IMPORT_C TInt	FontHeightInTwips	(	TInt	aTypefaceIndex,
			TInt	aHeightIndex
		)	const [virtual]

Reimplemented from CGraphicsDevice::FontHeightInTwips(TInt,TInt)const

Gets the height in twips of the specified font.

The value returned is rounded up or down to the nearest font height in twips.

The specified font is the one with height index number aHeightIndex of the typeface with index number aTypefaceIndex.

Parameter	Description
aTypefaceIndex	A typeface index number, in the range: 0 to (NumTypefaces() - 1).
aHeightIndex	A font height index number, in the range: 0 to (iNumHeights - 1).

Returns: The height of the font in twips.

GetCurrentScreenModeAttributes ( )

IMPORT_C TSizeMode

GetCurrentScreenModeAttributes

(

)

const

Used for testing purposes only.

Returns: The present screen mode.

GetCurrentScreenModeScale ( )

IMPORT_C TSize

GetCurrentScreenModeScale

(

)

const

Gets the scale for the current screen mode.

This function always causes a flush of the window server buffer.

Returns: The scale for the current screen mode.

GetCurrentScreenModeScaledOrigin ( )

IMPORT_C TPoint

GetCurrentScreenModeScaledOrigin

(

)

const

Gets the current screen mode's scaled origin.

The formula used is (A+B-1)/B

where:

A is the screen mode origin in physical coordinates,
B is the screen mode scale width.

The result obtained is the scaled origin of the present screen mode.

Returns: The scaled origin for the current screen mode.

GetDefaultScreenModeOrigin ( )

IMPORT_C TPoint

GetDefaultScreenModeOrigin

(

)

const

Gets the origin for the current screen mode

This function always causes a flush of the window server buffer.

GetDefaultScreenSizeAndRotation ( TPixelsTwipsAndRotation & )

IMPORT_C void

GetDefaultScreenSizeAndRotation

(

TPixelsTwipsAndRotation &

aSizeAndRotation

)

const

Gets the current screen size (in both pixels and twips) and rotation.

This function always causes a flush of the window server buffer.

Parameter	Description
aSizeAndRotation	The default screen size and rotation, defining screen size in both pixels and twips.

GetDefaultScreenSizeAndRotation ( TPixelsAndRotation & )

IMPORT_C void

GetDefaultScreenSizeAndRotation

(

TPixelsAndRotation &

aSizeAndRotation

)

const

Gets the current screen size (in pixels) and the rotation.

This function always causes a flush of the window server buffer.

Parameter	Description
aSizeAndRotation	The default screen size in pixels and the rotation.

GetFontById ( CFont *&, TUid, const TAlgStyle & )

IMPORT_C TInt	GetFontById	(	CFont *&	aFont,
			TUid	aUid,
			const TAlgStyle &	aAlgStyle
		)

Gets a font by its bitmap UID.

Within a font file each font has its own UID. An algorithmic style is not part of the actual font description, but is applied to it. For example algorithmic bolding applies an algorithm to increase the apparent weight of each character in the font. Note that the algorithm is applied blindly, and that a typeface may already have a style e.g. it may already be bold or italic. Thus a bold face will appear extra-bold if algorithmic bolding is applied to it. Algorithmic effects are not necessarily a substitute for typeface design and should be used with care.

Parameter	Description
aFont	On a successful return, contains a pointer to the new CFont.
aUid	UID of the bitmap font.
aAlgStyle	The algorithmic style to apply.

Returns: KErrNone if successful, otherwise one of the system-wide error codes.

GetInterface ( TUint )

IMPORT_C TAny *

GetInterface

(

TUint

aInterfaceId

)

Interface Extension capability Use of this interface going forward will allow the published client interface to be dynamically extended. Note that the pointer returned is only good for the lifetime of the called CBase derived object.

Parameter	Description
aInterfaceId	uniqueid or well known id of interface

Returns: pointer to interface object matching this ID or NULL if no match.

GetInterface ( TUint )

const TAny *

GetInterface

(

TUint

aInterfaceId

)

const [inline]

GetNearestFontInPixels ( CFont *&, const TFontSpec & )

IMPORT_C TInt	GetNearestFontInPixels	(	CFont *&	aFont,
			const TFontSpec &	aFontSpec
		)	[virtual]

Reimplemented from CBitmapDevice::GetNearestFontInPixels(CFont *&,const TFontSpec &)

Gets the nearest font to that specified for use by a bitmapped graphics device.

This function is replaced by GetNearestFontToDesignHeightInPixels()

The font and bitmap server returns a pointer to the nearest matching font from those available, in aFont.

Deprecated

Parameter	Description
aFont	On return, this is set to point to the device font that is closest to the font specification passed in the second argument
aFontSpec	An absolute font specification

Returns: KErrNone if successful, otherwise another of the system-wide error codes.

GetNearestFontInTwips ( CFont *&, const TFontSpec & )

IMPORT_C TInt	GetNearestFontInTwips	(	CFont *&	aFont,
			const TFontSpec &	aFontSpec
		)	[virtual]

Gets the nearest font, in twips, to that in the specified font specification.

This function is replaced by GetNearestFontToDesignHeightInTwips()

The font and bitmap server returns a pointer to the nearest matching font from those available, in aFont.

Deprecated

Parameter	Description
aFont	On return, this is set to point to the device font closest to the font specification passed in the second argument.
aFontSpec	An absolute font specification.

Returns: KErrNone if successful, otherwise another of the system-wide error codes.

GetNearestFontToDesignHeightInPixels ( CFont *&, const TFontSpec & )

IMPORT_C TInt	GetNearestFontToDesignHeightInPixels	(	CFont *&	aFont,
			const TFontSpec &	aFontSpec
		)	[virtual]

Reimplemented from CBitmapDevice::GetNearestFontToDesignHeightInPixels(CFont *&,const TFontSpec &)

Gets the nearest font in pixels to that specified.

The font and bitmap server returns a pointer to the nearest matching font from those available. Matches to design height of font - this gives no guarantees on the actual physical size of the font.

This function replaces GetNearestFontInTwips

Parameter	Description
aFont	On return, the pointer is set to point to the device font which most closely approximates to the required font specification.
aFontSpec	An absolute font specification.

Returns: KErrNone, if successful; otherwise, another of the system-wide error codes.

GetNearestFontToDesignHeightInTwips ( CFont *&, const TFontSpec & )

IMPORT_C TInt	GetNearestFontToDesignHeightInTwips	(	CFont *&	aFont,
			const TFontSpec &	aFontSpec
		)	[virtual]

Gets the nearest font in twips to that specified.

The font and bitmap server returns a pointer to the nearest matching font from those available. Matches to design height of font - this gives no guarantees on the actual physical size of the font.

This function replaces GetNearestFontInTwips

Parameter	Description
aFont	On return, the pointer is set to point to the device font which most closely approximates to the required font specification.
aFontSpec	An absolute font specification.

Returns: KErrNone, if successful; otherwise, another of the system-wide error codes.

GetNearestFontToMaxHeightInPixels ( CFont *&, const TFontSpec &, TInt )

IMPORT_C TInt	GetNearestFontToMaxHeightInPixels	(	CFont *&	aFont,
			const TFontSpec &	aFontSpec,
			TInt	aMaxHeight
		)	[virtual]

Reimplemented from CBitmapDevice::GetNearestFontToMaxHeightInPixels(CFont *&,const TFontSpec &,TInt)

Gets the nearest font in pixels to that specified.

The font and bitmap server returns a pointer to the nearest matching font from those available. Matches to max height of font - this does its best to return a font that will fit within the maximum height specified (but note that variations due to hinting algorithms may rarely result in this height being exceeded by up to one pixel). Problems can also be encountered with bitmap fonts where the typeface exists but doesn't have a font small enough.

Parameter	Description
aFont	On return, the pointer is set to point to the device font which most closely approximates to the required font specification.
aFontSpec	An absolute font specification.
aMaxHeight	The maximum height within which the font must fit - this overrides the height specified in the TFontSpec. If maximum height is greater than 1024 pixels, the function returns KErrTooBig. And returns KErrArgument if equals to 1 pixel.

Returns: KErrNone, if successful; otherwise, another of the system-wide error codes.

GetNearestFontToMaxHeightInTwips ( CFont *&, const TFontSpec &, TInt )

IMPORT_C TInt	GetNearestFontToMaxHeightInTwips	(	CFont *&	aFont,
			const TFontSpec &	aFontSpec,
			TInt	aMaxHeight
		)	[virtual]

Gets the nearest font, in twips, to that specified.

Parameter	Description
aFont	On return, the pointer is set to point to the device font which most closely approximates to the required font specification.
aFontSpec	An absolute font specification.
aMaxHeight	The maximum height within which the font must fit - this overrides the height specified in the TFontSpec. If maximum height is greater than 1024 pixels, the function returns KErrTooBig. And returns KErrArgument if equals to 1 pixel.

Returns: KErrNone, if successful; otherwise, another of the system-wide error codes.

GetPalette ( CPalette *& )

IMPORT_C TInt

GetPalette

(

CPalette *&

aPalette

)

const [virtual]

Reimplemented from CGraphicsDevice::GetPalette(CPalette *&)const

Gets the screen device's palette.

This function always causes a flush of the window server buffer.

Parameter	Description
aPalette	On return, contains the screen device's palette. The caller takes responsibility for discarding the palette.

Returns: KErrNone if successful, otherwise another of the system-wide error codes.

GetPixel ( TRgb &, const TPoint & )

IMPORT_C void	GetPixel	(	TRgb &	aColor,
			const TPoint &	aPixel
		)	const [virtual]

Reimplemented from CBitmapDevice::GetPixel(TRgb &,const TPoint &)const

Gets the RGB colour of an individual pixel on a screen device.

This function always causes a flush of the window server buffer.

GetRotationsList ( TInt, CArrayFixFlat< TInt > * )

IMPORT_C TInt	GetRotationsList	(	TInt	aMode,
			CArrayFixFlat< TInt > *	aRotationList
		)	const

Gets the list of valid rotations for a particular screen size.

The list is initialised in wsini.ini.

This function always causes a flush of the window server buffer.

GetScanLine ( TDes8 &, const TPoint &, TInt, TDisplayMode )

IMPORT_C void	GetScanLine	(	TDes8 &	aScanLine,
			const TPoint &	aStartPixel,
			TInt	aPixelLength,
			TDisplayMode	aDispMode
		)	const [virtual]

Reimplemented from CBitmapDevice::GetScanLine(TDes8 &,const TPoint &,TInt,TDisplayMode)const

Gets a scanline into a buffer.

The pixels are converted from the bitmapped graphics device display mode format to the format of the specified device display mode.

By specifying the start pixel and number of pixels either the whole or a portion of a bitmapped graphics device pixel row may be copied.

This function always causes a flush of the window server buffer.

GetScreenModeDisplayMode ( const TInt & )

IMPORT_C TDisplayMode

GetScreenModeDisplayMode

(

const TInt &

aMode

)

const

Gets the display mode of the screen for the specified screen mode

This function always causes a flush of the window server buffer.

Parameter	Description
aMode	The index of the screen mode for which the display mode is required

Returns: The display mode for the specified screen mode.

GetScreenModeOrigin ( TInt )

IMPORT_C TPoint

GetScreenModeOrigin

(

TInt

aMode

)

const

Get the origin of the screen for the specified screen mode.

This function always causes a flush of the window server buffer.

Parameter	Description
aMode	The index of the screen mode for which the screen origin is required.

GetScreenModeScale ( TInt )

IMPORT_C TSize

GetScreenModeScale

(

TInt

aMode

)

const

Gets the scale for the specified screen mode.

This function always causes a flush of the window server buffer.

Parameter	Description
aMode	The index of the screen mode for which the screen scale is required.

Returns: The scale for the specified screen mode.

GetScreenModeScaledOrigin ( TInt )

IMPORT_C TPoint

GetScreenModeScaledOrigin

(

TInt

aMode

)

const

Gets the specfied screen mode's scaled origin.

The functionality is same as CWsScreenDevice::GetCurrentScreenModeScaledOrigin().

It always causes a flush of the window server buffer.

Parameter	Description
aMode	The index of the screen mode for which the scaled origin is required.

Returns: The scaled origin for the specified screen mode.

GetScreenModeSizeAndRotation ( TInt, TPixelsTwipsAndRotation & )

IMPORT_C void	GetScreenModeSizeAndRotation	(	TInt	aMode,
			TPixelsTwipsAndRotation &	aSizeAndRotation
		)	const

Get the screen rotation and size, in both pixels and twips, for the specified screen mode.

This function always causes a flush of the window server buffer.

Parameter	Description
aMode	The index of the screen mode for which the screen size and rotation are required.
aSizeAndRotation	The orientation of the specified screen mode, and its size in both pixels and twips.

GetScreenModeSizeAndRotation ( TInt, TPixelsAndRotation & )

IMPORT_C void	GetScreenModeSizeAndRotation	(	TInt	aMode,
			TPixelsAndRotation &	aSizeAndRotation
		)	const

Get the screen rotation and size (in pixels) for the specified screen mode.

This function always causes a flush of the window server buffer.

Parameter	Description
aMode	The index of the screen mode for which the screen size and rotation are required.
aSizeAndRotation	The orientation of the specified screen mode, and its size in pixels.

GetScreenNumber ( )

IMPORT_C TInt

GetScreenNumber

(

)

const

Get device's screen number

Returns: The device's screen number

GetScreenSizeModeList ( RArray< TInt > * )

IMPORT_C TInt

GetScreenSizeModeList

(

RArray< TInt > *

aModeList

)

const

Gets the available screen size modes.

This function retrieves all available screen size modes which are supported by the server.

Parameter	Description
aModeList	On return, the list of available screen size modes.

Returns: The number of supported screen size modes if successful otherwise returns KErrNoMemory if there is insufficient memory to create the array.

HorizontalPixelsToTwips ( TInt )

IMPORT_C TInt

HorizontalPixelsToTwips

(

TInt

aPixels

)

const

Translates a specified pixel value to a twips value.

Parameter	Description
aPixels	The value in pixels to be translated.

Returns: The equivalent number of twips.

HorizontalTwipsToPixels ( TInt )

IMPORT_C TInt

HorizontalTwipsToPixels

(

TInt

aTwips

)

const

Translates a twips to a pixel value.

Parameter	Description
aTwips	The value in twips.

Returns: The equivalent number of pixels.

IsCurrentModeDynamic ( )

IMPORT_C TBool

IsCurrentModeDynamic

(

)

const

Returns whether the current screen size mode is dynamic or not.

IsModeDynamic ( TInt )

IMPORT_C TBool

IsModeDynamic

(

TInt

aSizeMode

)

const

Returns whether the given screen size mode is dynamic or not. Dynamic screen size modes may change their size in pixels and/or twips and other attributes at run time, so they must not be cached. Static size mode attributes will not change at run time, but may not make full use of the display. Invalid size modes shall return EFalse.

Parameter	Description
aSizeMode	The screen size mode to check.

Returns: ETrue if the given screen size mode is dynamic, EFalse otherwise.

NumScreenModes ( )

IMPORT_C TInt

NumScreenModes

(

)

const

Gets the number of available screen modes.

Each mode has a different size, and one or more possible rotations/orientations.

This function always causes a flush of the window server buffer.

Returns: The number of screen modes.

NumTypefaces ( )

IMPORT_C TInt

NumTypefaces

(

)

const [virtual]

Reimplemented from CGraphicsDevice::NumTypefaces()const

Gets the number of typefaces supported by the screen device.

Returns: The number of typefaces supported.

PaletteAttributes ( TBool &, TInt & )

IMPORT_C void	PaletteAttributes	(	TBool &	aModifiable,
			TInt &	aNumEntries
		)	const [virtual]

Reimplemented from CGraphicsDevice::PaletteAttributes(TBool &,TInt &)const

Gets the attributes of the device's palette.

This function always causes a flush of the window server buffer.

Parameter	Description
aModifiable	On return, indicates whether or not the device's palette is modifiable (true) or fixed (false).
aNumEntries	On return, holds the number of entries in the device's palette.

PointerRect ( )

IMPORT_C TRect

PointerRect

(

)

const

Gets the active area for the pointing device.

This is a device-dependent parameter, and will typically depend on the screen size and other factors.

This function always causes a flush of the window server buffer.

Returns: The active area, measured in pixels.

RectCompare ( const TRect &, const TRect & )

IMPORT_C TBool	RectCompare	(	const TRect &	aRect1,
			const TRect &	aRect2
		)	const

Compares two areas of the screen to see if they have the same content.

If there are any sprites on the screen they are not included in the comparison.

This function always causes a flush of the window server buffer.

Parameter	Description
aRect1	A rectangle.
aRect2	Another rectangle.

Returns: ETrue if the two screen areas are identical.

RectCompare ( const TRect &, const TRect &, TUint )

IMPORT_C TBool	RectCompare	(	const TRect &	aRect1,
			const TRect &	aRect2,
			TUint	aFlags
		)	const

Compares two areas of the screen to see if they have the same content.

This function always causes a flush of the window server buffer.

Parameter	Description
aRect1	A rectangle.
aRect2	Another rectangle.
aFlags	EIncludeSprite to include any visible sprites in the comparison, ERemoveSprite to remove the sprites, or EIncludeTextCursor to include any visible text cursors in the comparison. EIncludeSprite and EIncludeTextCursor can be combined (logically ORed) to include both visible sprites and visible text cursors in the comparison. These values are defined in the enum TSpriteInCompare in this class.

Returns: ETrue if the two screen areas are identical.

ReleaseFont ( CFont * )

IMPORT_C void

ReleaseFont

(

CFont *

aFont

)

Releases a specified font.

This function is used to indicate that the specified font is no longer needed for use by the screen device. As fonts can be shared between applications, this function does not delete the copy of the font from RAM, unless the font was only being used by this device.

Parameter	Description
aFont	A pointer to the font to be released.

RemoveFile ( TInt )

IMPORT_C void

RemoveFile

(

TInt

aId = 0

)

[virtual]

Reimplemented from CBitmapDevice::RemoveFile(TInt)

Removes a font file from the font store.

ScreenModeEnforcement ( )

IMPORT_C TScreenModeEnforcement

ScreenModeEnforcement

(

)

const

Gets the current screen mode enforcement settings.

The global screen mode enforcement setting defines the requirements that a group window must meet to be displayed. The requirements may have been set in wsini.ini, or using SetScreenModeEnforcement().

This function always causes a flush of the window server buffer.

Returns: The screen mode enforcement requirements.

SetAppScreenMode ( TInt )

IMPORT_C void

SetAppScreenMode

(

TInt

aMode

)

Sets the application's screen mode; this also sets all the attributes of the screen mode.

Note: although this API was added in Symbian OS v8.0, the functionality is only available from Symbian OS v8.1 onwards.

Parameter	Description
aMode	The index of the application's new screen mode.

SetBackLight ( TBool )

IMPORT_C TInt

SetBackLight

(

TBool

aBackLight

)

Set the back light state.

If the back light is disabled, or the client process SID does not match the EikSrv one (0x10003a4a), KErrPermissionDenied is returned. If the system is in a low power state, KErrBadPower may be returned.

Returns: KErrNone if successful, otherwise a system-wide error code.

SetCurrentRotations ( TInt, CFbsBitGc::TGraphicsOrientation )

IMPORT_C void	SetCurrentRotations	(	TInt	aMode,
			CFbsBitGc::TGraphicsOrientation	aRotation
		)	const

Sets the screen rotation that should be used with a particular screen size.

After calling this function, whenever you change into the screen size specified by aMode you will have the rotation aRotation. The setting remains in force until it is explicitly changed using this function.

Panics if the specified rotation is not allowed by the given screen mode.

SetCurrentScreenModeAttributes ( const TSizeMode & )

IMPORT_C void

SetCurrentScreenModeAttributes

(

const TSizeMode &

aModeAtt

)

Used for testing purposes only.

Parameter	Description
aModeAtt	Screen size mode to be set.

SetCustomPalette ( const CPalette * )

IMPORT_C TInt

SetCustomPalette

(

const CPalette *

aPalette

)

Sets the custom palette.

This function always causes a flush of the window server buffer.

panic: W32 6 aPalette is NULL.

capability: WriteDeviceData

Parameter	Description
aPalette	The custom palette.

Returns: KErrNone if sucessful, or one of the system error codes.

SetPalette ( CPalette * )

IMPORT_C void

SetPalette

(

CPalette *

aPalette

)

[virtual]

Reimplemented from CGraphicsDevice::SetPalette(CPalette *)

Sets the screen device's palette.

This function always causes a flush of the window server buffer.

Deprecated SetCustomPalette() should be used instead.

panic: W32 6 aPalette is NULL.

capability: WriteDeviceData

Parameter	Description
aPalette	The screen device's new palette.

SetScreenMode ( TInt )

IMPORT_C void

SetScreenMode

(

TInt

aMode

)

Sets the current screen mode.

Note that this function is only useful for testing. This is because the screen mode normally reflects the state of real hardware, e.g. whether the cover is open or closed on a phone that supports screen flipping.

This function always causes a flush of the window server buffer.

capability: WriteDeviceData

Parameter	Description
aMode	The screen mode index, starting from zero.

SetScreenModeEnforcement ( TScreenModeEnforcement )

IMPORT_C void

SetScreenModeEnforcement

(

TScreenModeEnforcement

aMode

)

const

Sets the screen mode enforcement requirements.

This global setting defines the requirements that a group window must meet to be displayed. The value may be set using this function, but is more likely to be defined in wsini.ini.

capability: WriteDeviceData

Parameter	Description
aMode	The screen mode enforcement requirements.

SetScreenSizeAndRotation ( const TPixelsTwipsAndRotation & )

IMPORT_C void

SetScreenSizeAndRotation

(

const TPixelsTwipsAndRotation &

aSizeAndRotation

)

Sets the current screen size in twips and pixels, and the rotation for the screen device.

Parameter	Description
aSizeAndRotation	The new rotation and the screen size in both pixels and twips.

SetScreenSizeAndRotation ( const TPixelsAndRotation & )

IMPORT_C void

SetScreenSizeAndRotation

(

const TPixelsAndRotation &

aSizeAndRotation

)

Sets the current screen size in pixels, and the rotation for the screen device.

This function always causes a flush of the window server buffer.

Parameter	Description
aSizeAndRotation	The new rotation and the screen size in pixels.

SizeInPixels ( )

IMPORT_C TSize

SizeInPixels

(

)

const [virtual]

Reimplemented from CGraphicsDevice::SizeInPixels()const

Gets the size of the screen device area in pixels.

This function always causes a flush of the window server buffer.

Returns: The x and y dimensions of the screen device area, in pixels.

SizeInTwips ( )

IMPORT_C TSize

SizeInTwips

(

)

const [virtual]

Reimplemented from CGraphicsDevice::SizeInTwips()const

Gets the size of the screen device area in twips.

This function always causes a flush of the window server buffer.

Returns: The x and y dimensions of the screen device area, in twips.

TypefaceSupport ( TTypefaceSupport &, TInt )

IMPORT_C void	TypefaceSupport	(	TTypefaceSupport &	aTypefaceSupport,
			TInt	aTypefaceIndex
		)	const [virtual]

Reimplemented from CGraphicsDevice::TypefaceSupport(TTypefaceSupport &,TInt)const

Gets typeface information for a particular typeface index number.

This information is returned in aTypefaceSupport, and includes: the typeface name and typeface attributes (in a TTypeface object), the number of font heights, the maximum and minimum font heights and whether it is a scalable typeface.

Parameter	Description
aTypefaceSupport	On return, if the function executed successfully, this contains the typeface information.
aTypefaceIndex	A typeface index number, in the range zero to (NumTypefaces()1).

VerticalPixelsToTwips ( TInt )

IMPORT_C TInt

VerticalPixelsToTwips

(

TInt

aPixels

)

const

Translates a vertical dimension of a screen device in pixels into twips.

Parameter	Description
aPixels	A vertical dimension of a device in pixels.

Returns: The vertical dimension in twips.

VerticalTwipsToPixels ( TInt )

IMPORT_C TInt

VerticalTwipsToPixels

(

TInt

aTwips

)

const

Translates a vertical dimension of a screen device in twips into pixels.

Parameter	Description
aTwips	A vertical dimension of a device in twips.

Returns: The vertical dimension in pixels.

Parameter	Description
aColor	On return, contains the RGB colour of the pixel.
aPixel	The x,y co-ordinates of the pixel. The top left pixel is (0,0).

Parameter	Description
aScanLine	A buffer into which pixels are copied, it must be sufficiently large to store all the scanline pixels.
aStartPixel	The (x,y) co-ordinates of the first pixel of the bitmap scanline to be put into the buffer.
aPixelLength	The number of pixels to put into the buffer.
aDispMode	The display mode into which to convert the pixels.

Parameter	Description
aMode	The index of the screen mode the rotation applies to.
aRotation	The new screen orientation.