Class CBandedDevice

class CBandedDevice : public CGraphicsDevice;

Description

Derivation

• 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

• CBandedDevice - (No abstract)

Members

Defined in CBandedDevice:
BandBitmap(), BandRect(), BandingDirection(), CreateContext(), DisplayMode(), FontHeightInTwips(), FullOriginToBandOrigin(), GetNearestFontInTwips(), GetNearestFontToDesignHeightInTwips(), GetNearestFontToMaxHeightInTwips(), GetPalette(), HorizontalPixelsToTwips(), HorizontalTwipsToPixels(), NewL(), NextBand(), NumBands(), NumTypefaces(), PaletteAttributes(), ReleaseFont(), Reset(), SetPalette(), SizeInPixels(), SizeInTwips(), TypefaceSupport(), VerticalPixelsToTwips(), VerticalTwipsToPixels(), ~CBandedDevice()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from MGraphicsDeviceMap:
PixelsToTwips(), TwipsToPixels()

IMPORT_C ~CBandedDevice();

Description

static IMPORT_C CBandedDevice *NewL(TRect aRectInPixels, TSize aKPixelSizeInTwips, TDisplayMode aDisplayMode, TBandingDirection aBandingDirection=EBandingTopToBottom, TInt aScanLinesPerBand=0);

Description

Parameters

TRect aRectInPixels TSize aKPixelSizeInTwips TDisplayMode aDisplayMode TBandingDirection aBandingDirection TInt aScanLinesPerBand

Return value

CBandedDevice *

virtual IMPORT_C TInt HorizontalTwipsToPixels(TInt aTwips) const;

Description

Converts a horizontal dimension from twips to pixels.

An implementation is supplied by a derived class.

Parameters

TInt aTwips A horizontal dimension of a device in twips.

Return value

TInt A horizontal dimension of a device in pixels.

virtual IMPORT_C TInt VerticalTwipsToPixels(TInt aTwips) const;

Description

Converts a vertical dimension from twips to pixels.

An implementation is supplied by a derived class.

Parameters

TInt aTwips A vertical dimension of a device in twips.

Return value

TInt A vertical dimension of a device in pixels.

virtual IMPORT_C TInt HorizontalPixelsToTwips(TInt aPixels) const;

Description

Converts a horizontal dimension from pixels to twips.

An implementation is supplied by a derived class.

Parameters

TInt aPixels A horizontal dimension of a device in pixels.

Return value

TInt A horizontal dimension of a device in twips.

virtual IMPORT_C TInt VerticalPixelsToTwips(TInt aPixels) const;

Description

Converts a vertical dimension from pixels to twips.

An implementation is supplied by a derived class.

Parameters

TInt aPixels A vertical dimension of a device in pixels.

Return value

TInt A vertical dimension of a device in twips.

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

Description

Creates a font from those available in the printer device's typeface store that most closely matches a font specification.

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

This function is replaced by GetNearestFontToDesignHeightInTwips()

Parameters

CFont *&aFont On return, points to the font which most closely matches the specified font. const TFontSpec &aFontSpec An absolute font specification. Its iHeight member is interpreted as being in twips.

Return value

TInt KErrNone if successful; otherwise, another one of the system-wide error codes.

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

Description

Creates a font from those available in the printer device's typeface store that most closely matches a font specification.

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

This function replaces GetNearestFontInTwips()

Parameters

CFont *&aFont On return, points to the font which most closely matches the specified font. const TFontSpec &aFontSpec An absolute font specification. Its iHeight member is interpreted as being in twips.

Return value

TInt KErrNone if successful; otherwise, another one of the system-wide error codes.

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

Description

This call is defined because it had to be - it appeared as an abstract virtual in the base class. But it should never actually get called for this class.

Parameters

CFont *&aFont const TFontSpec &aFontSpec TInt aMaxHeight

Return value

TInt

virtual IMPORT_C void ReleaseFont(CFont *aFont);

Description

Releases the specified font.

It is used to indicate that the specified font is no longer needed for use by the device map. 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 particular device map.

An implementation is supplied by a derived class.

Parameters

CFont *aFont A pointer to the font to be released.

virtual IMPORT_C TDisplayMode DisplayMode() const;

Description

Gets the display mode of the device.

Return value

TDisplayMode The display mode of the device.

virtual IMPORT_C TSize SizeInPixels() const;

Description

Gets the size of the device area in pixels.

Return value

TSize The width and height of the device area, in pixels

virtual IMPORT_C TSize SizeInTwips() const;

Description

Gets the size of the device area in twips.

Return value

TSize The width and height of the device area, in twips

virtual IMPORT_C TInt CreateContext(CGraphicsContext *&aGC);

Description

Creates a graphics context for the device.

Parameters

CGraphicsContext *&aGC On return, contains a pointer to the created graphics context.

Return value

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

virtual IMPORT_C TInt NumTypefaces() const;

Description

Gets the number of typefaces supported by the graphics device.

Return value

TInt The number of typefaces supported.

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

Description

Gets typeface information for a specified typeface.

This information is returned in aTypefaceSupport, and includes:

the typeface name and typeface attributes

the number of font heights

the maximum and minimum font heights

whether it is a scalable typeface

Parameters

TTypefaceSupport &aTypefaceSupport On return, contains the typeface information. TInt aTypefaceIndex A typeface index number, in the range: zero to (NumTypefaces() - 1).

See also:

• NumTypefaces()

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

Description

Get the height of a font in twips.

The font is identified by typeface and height.

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

Parameters

TInt aTypefaceIndex An index identifying the typeface, in the range: 0 to (NumTypefaces() - 1). TInt aHeightIndex An index identifying the font height, in the range: 0 to (iNumHeights - 1). Note that iNumHeights is in the TTypefaceSupport object returned by TypefaceSupport().

Return value

TInt The height of the font, in twips.

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

Description

Gets the palette attributes of the device.

Parameters

TBool &aModifiable On return, holds information on whether or not the device's palette is modifiable (ETrue) or fixed (EFalse). TInt &aNumEntries On return, holds the number of entries in the device's palette.

virtual IMPORT_C void SetPalette(CPalette *aPalette);

Description

Sets the device's palette.

Parameters

CPalette *aPalette The new palette for the device.

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

Description

Gets the device's current palette.

Parameters

CPalette *&aPalette On return, holds the device's current palette.

Return value

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

IMPORT_C TInt NumBands() const;

Description

Return value

TInt

IMPORT_C TInt NextBand();

Description

Return value

TInt

IMPORT_C TRect BandRect() const;

Description

Return value

TRect

IMPORT_C TPoint FullOriginToBandOrigin(const TPoint &aPoint) const;

Description

Parameters

const TPoint &aPoint

Return value

TPoint

IMPORT_C void Reset();

Description

inline TBandingDirection BandingDirection() const;

Description

Return value

TBandingDirection

inline CFbsBitmap *BandBitmap() const;

Description

Return value

CFbsBitmap *