Class CWsScreenDevice

class CWsScreenDevice : public CBitmapDevice, public MWsClientClass;

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.

Derivation

• MWsClientClass - Base class for all classes whose objects are clients of the window server.

• MGraphicsDeviceMap - Interface class for mapping between twips and device-specific units (pixels).
• CBase - Base class for all classes to be instantiated on the heap.

• CGraphicsDevice - Specifies the interface for concrete device classes.

• CBitmapDevice - Defines an abstract interface for the capabilities and attributes of a bitmapped...

• CWsScreenDevice - Software device screen.

Members

Defined in CWsScreenDevice:

• AddFile(const TDesC &,TInt &)Adds a font file to the device's typeface store. The specified font file must be...
• CWsScreenDevice()Default constructor. Developers should use the other constructor overload.
• CWsScreenDevice(RWsSession &)Constructs a new screen device attached to a particular window server session.
• Construct()Completes construction of the object.
• Construct(TInt)Completes construction of the object.
• CopyScreenToBitmap(const CFbsBitmap *)constSaves the entire screen to a bitmap.
• CopyScreenToBitmap(const CFbsBitmap *,const TRect &)constSaves a region of the screen to a bitmap.
• CreateContext(CGraphicsContext *&)Creates a graphics context for this device.
• CreateContext(CWindowGc *&)Creates a graphics context for this device.
• CurrentScreenMode()constGets the current screen mode index.
• DisplayMode()constGets the device's display mode.
• EIncludeSpriteThis enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(...
• EIncludeTextCursorThis enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(...
• ERemoveSpriteThis enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(...
• FontHeightInPixels(TInt,TInt)constGets the height of the specified font in pixels.
• FontHeightInTwips(TInt,TInt)constGets the height in twips of the specified font.
• GetCurrentScreenModeScale()constGets the scale for the current screen mode.
• GetCurrentScreenModeScaledOrigin()constGets the current screen mode's scaled origin.
• GetDefaultScreenModeOrigin()constGets the origin for the current screen mode
• GetDefaultScreenSizeAndRotation(TPixelsAndRotation &)constGets the current screen size (in pixels) and the rotation.
• GetDefaultScreenSizeAndRotation(TPixelsTwipsAndRotation &)constGets the current screen size (in both pixels and twips) and rotation.
• GetFontById(CFont *&,TUid,const TAlgStyle &)Gets a font by its bitmap UID.
• GetNearestFontInPixels(CFont *&,const TFontSpec &)Gets the nearest font to that specified for use by a bitmapped graphics device.
• GetNearestFontInTwips(CFont *&,const TFontSpec &)Gets the nearest font, in twips, to that in the specified font specification.
• GetNearestFontToDesignHeightInPixels(CFont *&,const TFontSpec &)Gets the nearest font in pixels to that specified.
• GetNearestFontToDesignHeightInTwips(CFont *&,const TFontSpec &)Gets the nearest font in twips to that specified.
• GetNearestFontToMaxHeightInPixels(CFont *&,const TFontSpec &,TInt)Gets the nearest font in pixels to that specified.
• GetNearestFontToMaxHeightInTwips(CFont *&,const TFontSpec &,TInt)Gets the nearest font, in twips, to that specified.
• GetPalette(CPalette *&)constGets the screen device's palette.
• GetPixel(TRgb &,const TPoint &)constGets the RGB colour of an individual pixel on a screen device.
• GetRotationsList(TInt,CArrayFixFlat< TInt > *)constGets the list of valid rotations for a particular screen size.
• GetScanLine(TDes8 &,const TPoint &,TInt,TDisplayMode)constGets a scanline into a buffer.
• GetScreenModeDisplayMode(const TInt &)constGets the display mode of the screen for the specified screen mode
• GetScreenModeOrigin(TInt)constGet the origin of the screen for the specified screen mode.
• GetScreenModeScale(TInt)constGets the scale for the specified screen mode.
• GetScreenModeScaledOrigin(TInt)constGets the specfied screen mode's scaled origin.
• GetScreenModeSizeAndRotation(TInt,TPixelsAndRotation &)constGet the screen rotation and size (in pixels) for the specified screen mode.
• GetScreenModeSizeAndRotation(TInt,TPixelsTwipsAndRotation &)constGet the screen rotation and size, in both pixels and twips, for the specified sc...
• GetScreenNumber()constGet device's screen number
• GetScreenSizeModeList(RArray< TInt > *)Gets the available screen size modes.
• HorizontalPixelsToTwips(TInt)constTranslates a specified pixel value to a twips value.
• HorizontalTwipsToPixels(TInt)constTranslates a twips to a pixel value.
• NumScreenModes()constGets the number of available screen modes.
• NumTypefaces()constGets the number of typefaces supported by the screen device.
• PaletteAttributes(TBool &,TInt &)constGets the attributes of the device's palette.
• PointerRect()constGets the active area for the pointing device.
• RectCompare(const TRect &,const TRect &)Compares two areas of the screen to see if they have the same content.
• RectCompare(const TRect &,const TRect &,TUint)constCompares two areas of the screen to see if they have the same content.
• ReleaseFont(CFont *)Releases a specified font.
• RemoveFile(TInt)Removes a font file from the font store.
• ScreenModeEnforcement()constGets the current screen mode enforcement settings.
• SetAppScreenMode(TInt)Sets the application's screen mode; this also sets all the attributes of the scr...
• SetBackLight(TBool)Set the back light state.
• SetCustomPalette(const CPalette *)Sets the custom palette.
• SetPalette(CPalette *)Sets the screen device's palette.
• SetScreenSizeAndRotation(const TPixelsAndRotation &)Sets the current screen size in pixels, and the rotation for the screen device.
• SetScreenSizeAndRotation(const TPixelsTwipsAndRotation &)Sets the current screen size in twips and pixels, and the rotation for the scree...
• SizeInPixels()constGets the size of the screen device area in pixels.
• SizeInTwips()constGets the size of the screen device area in twips.
• TSpriteInCompareWhether or not to include sprites when comparing areas of the screen
• TypefaceSupport(TTypefaceSupport &,TInt)constGets typeface information for a particular typeface index number.
• VerticalPixelsToTwips(TInt)constTranslates a vertical dimension of a screen device in pixels into twips.
• VerticalTwipsToPixels(TInt)constTranslates a vertical dimension of a screen device in twips into pixels.
• ~CWsScreenDevice()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CBitmapDevice:

• CreateBitmapContext(CBitmapContext *&)Creates a bitmap context for this bitmap device.

Inherited from MGraphicsDeviceMap:

• PixelsToTwips(const TPoint &)constConverts a point in pixels to a point in twips.
• PixelsToTwips(const TRect &)constConverts a rectangle in pixels to a rectangle in twips.
• TwipsToPixels(const TPoint &)constConverts a point in twips to a point in pixels.
• TwipsToPixels(const TRect &)constConverts a rectangle in twips to a rectangle in pixels.

Inherited from MWsClientClass:

• WsHandle()constGets the server side handle for the object.

See also:

• CFbsScreenDeviceA graphics device interface that provides direct access to the screen, without t...

IMPORT_C CWsScreenDevice();

Description

Default constructor. Developers should use the other constructor overload.

IMPORT_C CWsScreenDevice(RWsSession &aWs);

Description

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

Parameters

IMPORT_C ~CWsScreenDevice();

Description

Destructor.

IMPORT_C TInt Construct();

Description

Completes construction of the object.

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

Return value

IMPORT_C TInt Construct(TInt aDefaultScreenNumber);

Description

Completes construction of the object.

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

Parameters

Return value

IMPORT_C virtual TDisplayMode DisplayMode() const;

Description

Gets the device's display mode.

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

Return value

See also:

• CGraphicsDevice::DisplayMode()constGets the display mode of the device.

IMPORT_C virtual TSize SizeInPixels() const;

Description

Gets the size of the screen device area in pixels.

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

Return value

See also:

• CGraphicsDevice::SizeInPixels()constGets the size of the device area in pixels.

IMPORT_C virtual TSize SizeInTwips() const;

Description

Gets the size of the screen device area in twips.

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

Return value

See also:

• CGraphicsDevice::SizeInTwips()constGets the size of the device area in twips.

IMPORT_C virtual TInt HorizontalTwipsToPixels(TInt aTwips) const;

Description

Translates a twips to a pixel value.

Parameters

Return value

See also:

• MGraphicsDeviceMap::HorizontalTwipsToPixels(TInt)constConverts a horizontal dimension from twips to pixels.

IMPORT_C virtual TInt VerticalTwipsToPixels(TInt aTwips) const;

Description

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

Parameters

Return value

IMPORT_C virtual TInt HorizontalPixelsToTwips(TInt aPixels) const;

Description

Translates a specified pixel value to a twips value.

Parameters

Return value

IMPORT_C virtual TInt VerticalPixelsToTwips(TInt aPixels) const;

Description

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

Parameters

Return value

See also:

• MGraphicsDeviceMap::VerticalPixelsToTwips(TInt)constConverts a vertical dimension from pixels to twips.

IMPORT_C TRect PointerRect() const;

Description

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.

Return value

IMPORT_C virtual TInt CreateContext(CGraphicsContext *&aGc);

Description

Creates a graphics context for this device.

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

Parameters

Return value

See also:

• CGraphicsDevice::CreateContext(CGraphicsContext *&)Creates a graphics context for the device.

inline TInt CreateContext(CWindowGc *&aGc);

Description

Creates a graphics context for this device.

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

Parameters

Return value

See also:

• CGraphicsDevice::CreateContext(CGraphicsContext *&)Creates a graphics context for the device.

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

Description

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

When the font is no longer needed, call ReleaseFont() .

Note that this deprecated function is replaced by the new GetNearestFontToDesignHeightInTwips() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInTwips() function instead. This will guarantee that every character within any given text string will fit within the given amount of twips, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

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

Parameters

Return value

See also:

• MGraphicsDeviceMap::GetNearestFontInTwips(CFont *&,const TFontSpec &)Gets the font which is the nearest to the given font specification.

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

Description

Gets the nearest font in twips to that specified.

When the font is no longer needed, call ReleaseFont() .

This new function replaces the deprecated GetNearestFontInTwips() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInTwips() function instead. This will guarantee that every character within any given text string will fit within the given amount of twips, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

Parameters

Return value

See also:

• MGraphicsDeviceMap::GetNearestFontToDesignHeightInTwips(CFont *&,const TFontSpec &)Gets the font which is the nearest to the given font specification.

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

Description

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

When the font is no longer needed, call ReleaseFont() .

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.

Parameters

Return value

See also:

• MGraphicsDeviceMap::GetNearestFontToMaxHeightInTwips(CFont *&,const TFontSpec &,TInt)Gets the font which is the nearest to the given font specification.

IMPORT_C virtual TInt NumTypefaces() const;

Description

Gets the number of typefaces supported by the screen device.

Return value

See also:

• CGraphicsDevice::NumTypefaces()constGets the number of typefaces supported by the graphics device.

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

Description

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.

Parameters

See also:

• CGraphicsDevice::TypefaceSupport(TTypefaceSupport &,TInt)constGets typeface information for a specified typeface.

IMPORT_C virtual TInt FontHeightInTwips(TInt aTypefaceIndex, TInt aHeightIndex) const;

Description

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.

Parameters

Return value

See also:

• CGraphicsDevice::FontHeightInTwips(TInt,TInt)constGet the height of a font in twips.

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

Description

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

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

Parameters

See also:

• CBitmapDevice::GetPixel(TRgb &,const TPoint &)constGets the RGB colour of an individual pixel on a bitmapped graphics device.

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

Description

Gets a scanline into a buffer.

The pixels are converted from the current screen 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 row of screen pixels may be copied.

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

Parameters

See also:

• CBitmapDevice::GetScanLine(TDes8 &,const TPoint &,TInt,TDisplayMode)constCopies a scanline into a buffer.

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

Description

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.

Parameters

Return value

See also:

• CBitmapDevice::AddFile(const TDesC &,TInt &)Adds a font file to the device's typeface store. The specified font file must be...

IMPORT_C virtual void RemoveFile(TInt aId=0);

Description

Removes a font file from the font store.

Parameters

See also:

• CBitmapDevice::RemoveFile(TInt)Removes a font file from the font store.

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

Description

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

When the font is no longer needed, call ReleaseFont() .

Note that this deprecated function is replaced by the new GetNearestFontToDesignHeightInPixels() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInPixels() function instead. This will guarantee that every character within any given text string will fit within the given amount of pixels, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

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

Parameters

Return value

See also:

• CBitmapDevice::GetNearestFontInPixels(CFont *&,const TFontSpec &)Gets the font which is the nearest to the given font specification.

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

Description

Gets the nearest font in pixels to that specified.

When the font is no longer needed, call ReleaseFont() .

This new function replaces the deprecated GetNearestFontInPixels() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInPixels() function instead. This will guarantee that every character within any given text string will fit within the given amount of pixels, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

Parameters

Return value

See also:

• CBitmapDevice::GetNearestFontToDesignHeightInPixels(CFont *&,const TFontSpec &)Gets the font which is the nearest to the given font specification.

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

Description

Gets the nearest font in pixels to that specified.

When the font is no longer needed, call ReleaseFont() .

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.

Parameters

Return value

See also:

• CBitmapDevice::GetNearestFontToMaxHeightInPixels(CFont *&,const TFontSpec &,TInt)Gets the font which is the nearest to the given font specification.

IMPORT_C virtual TInt FontHeightInPixels(TInt aTypefaceIndex, TInt aHeightIndex) const;

Description

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.

Parameters

Return value

See also:

• CBitmapDevice::FontHeightInPixels(TInt,TInt)constGets the height, in pixels, of the specified typeface at one of its defined heig...

IMPORT_C virtual void ReleaseFont(CFont *aFont);

Description

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.

Parameters

See also:

• MGraphicsDeviceMap::ReleaseFont(CFont *)Releases the specified font.

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

Description

Gets the attributes of the device's palette.

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

Parameters

See also:

• CFbsScreenDevice::PaletteAttributes(TBool &,TInt &)constGets the palette attributes of the device.

IMPORT_C virtual void SetPalette(CPalette *aPalette);

Description

Sets the screen device's palette.

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

Parameters

Panic codes

IMPORT_C virtual TInt GetPalette(CPalette *&aPalette) const;

Description

Gets the screen device's palette.

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

Parameters

Return value

See also:

• CFbsScreenDevice::GetPalette(CPalette *&)constGets the devices current palette.

IMPORT_C TInt SetCustomPalette(const CPalette *aPalette);

Description

Sets the custom palette.

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

Parameters

Return value

Panic codes

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

Description

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.

Parameters

Return value

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

Description

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.

Parameters

Return value

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

Description

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.

Parameters

Return value

IMPORT_C TInt CopyScreenToBitmap(const CFbsBitmap *aBitmap) const;

Description

Saves the entire screen to a bitmap.

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

Parameters

Return value

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

Description

Saves a region of the screen to a bitmap.

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

Parameters

Return value

IMPORT_C TInt SetBackLight(TBool aBackLight);

Description

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.

Parameters

Return value

IMPORT_C void SetScreenSizeAndRotation(const TPixelsTwipsAndRotation &aSizeAndRotation);

Description

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

Parameters

IMPORT_C void GetDefaultScreenSizeAndRotation(TPixelsTwipsAndRotation &aSizeAndRotation) const;

Description

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

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

Parameters

IMPORT_C void SetScreenSizeAndRotation(const TPixelsAndRotation &aSizeAndRotation);

Description

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.

Parameters

IMPORT_C void GetDefaultScreenSizeAndRotation(TPixelsAndRotation &aSizeAndRotation) const;

Description

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

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

Parameters

IMPORT_C TScreenModeEnforcement ScreenModeEnforcement() const;

Description

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 CWsScreenDevice::SetScreenModeEnforcement(TScreenModeEnforcement)const.

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

Return value

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

Description

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.

Parameters

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

Description

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

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

Parameters

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

Description

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.

Parameters

Return value

IMPORT_C TInt NumScreenModes() const;

Description

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.

Return value

IMPORT_C TInt CurrentScreenMode() const;

Description

Gets the current screen mode index.

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

Return value

IMPORT_C void SetAppScreenMode(TInt aMode);

Description

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.

Parameters

IMPORT_C TPoint GetDefaultScreenModeOrigin() const;

Description

Gets the origin for the current screen mode

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

Return value

IMPORT_C TPoint GetScreenModeOrigin(TInt aMode) const;

Description

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

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

Parameters

Return value

IMPORT_C TSize GetCurrentScreenModeScale() const;

Description

Gets the scale for the current screen mode.

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

Return value

IMPORT_C TSize GetScreenModeScale(TInt aMode) const;

Description

Gets the scale for the specified screen mode.

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

Parameters

Return value

IMPORT_C TPoint GetCurrentScreenModeScaledOrigin() const;

Description

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.

Return value

IMPORT_C TPoint GetScreenModeScaledOrigin(TInt aMode) const;

Description

Gets the specfied screen mode's scaled origin.

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

It always causes a flush of the window server buffer.

Parameters

Return value

IMPORT_C TInt GetScreenSizeModeList(RArray< TInt > *aModeList);

Description

Gets the available screen size modes.

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

Parameters

Return value

IMPORT_C TDisplayMode GetScreenModeDisplayMode(const TInt &aMode) const;

Description

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

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

Parameters

Return value

IMPORT_C TInt GetScreenNumber() const;

Description

Get device's screen number

Return value

See also:

• CWsScreenDevice::Construct(TInt)Completes construction of the object.

TSpriteInCompare

Description

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