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()const
• BandRect()const
• BandingDirection()const
• CreateContext(CGraphicsContext *&)Creates a graphics context for the device.
• DisplayMode()constGets the display mode of the device.
• FontHeightInTwips(TInt,TInt)constGet the height of a font in twips.
• FullOriginToBandOrigin(const TPoint &)const
• GetNearestFontInTwips(CFont *&,const TFontSpec &)Creates a font from those available in the printer device's typeface store that ...
• GetNearestFontToDesignHeightInTwips(CFont *&,const TFontSpec &)Creates a font from those available in the printer device's typeface store that ...
• GetNearestFontToMaxHeightInTwips(CFont *&,const TFontSpec &,TInt)This call is defined because it had to be - it appeared as an abstract virtual i...
• GetPalette(CPalette *&)constGets the device's current palette.
• HorizontalPixelsToTwips(TInt)constConverts a horizontal dimension from pixels to twips.
• HorizontalTwipsToPixels(TInt)constConverts a horizontal dimension from twips to pixels.
• NewL(TRect,TSize,TDisplayMode,TBandingDirection,TInt)
• NextBand()
• NumBands()const
• NumTypefaces()constGets the number of typefaces supported by the graphics device.
• PaletteAttributes(TBool &,TInt &)constGets the palette attributes of the device.
• ReleaseFont(CFont *)Releases the specified font.
• Reset()
• SetPalette(CPalette *)Sets the device's palette.
• SizeInPixels()constGets the size of the device area in pixels.
• SizeInTwips()constGets the size of the device area in twips.
• TypefaceSupport(TTypefaceSupport &,TInt)constGets typeface information for a specified typeface.
• VerticalPixelsToTwips(TInt)constConverts a vertical dimension from pixels to twips.
• VerticalTwipsToPixels(TInt)constConverts a vertical dimension from twips to pixels.
• ~CBandedDevice()

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 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.

IMPORT_C ~CBandedDevice();

Description

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

Description

Parameters

Return value

IMPORT_C virtual TInt HorizontalTwipsToPixels(TInt aTwips) const;

Description

Converts a horizontal dimension from twips to pixels.

An implementation is supplied by a derived class.

Parameters

Return value

IMPORT_C virtual TInt VerticalTwipsToPixels(TInt aTwips) const;

Description

Converts a vertical dimension from twips to pixels.

An implementation is supplied by a derived class.

Parameters

Return value

IMPORT_C virtual TInt HorizontalPixelsToTwips(TInt aPixels) const;

Description

Converts a horizontal dimension from pixels to twips.

An implementation is supplied by a derived class.

Parameters

Return value

IMPORT_C virtual TInt VerticalPixelsToTwips(TInt aPixels) const;

Description

Converts a vertical dimension from pixels to twips.

An implementation is supplied by a derived class.

Parameters

Return value

IMPORT_C virtual 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 CBandedDevice::ReleaseFont(CFont *).

This function is replaced by CBandedDevice::GetNearestFontToDesignHeightInTwips(CFont *&,const TFontSpec &)

Parameters

Return value

IMPORT_C virtual 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 CBandedDevice::ReleaseFont(CFont *).

This function replaces CBandedDevice::GetNearestFontInTwips(CFont *&,const TFontSpec &)

Parameters

Return value

IMPORT_C virtual 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

Return value

IMPORT_C virtual 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

IMPORT_C virtual TDisplayMode DisplayMode() const;

Description

Gets the display mode of the device.

Return value

IMPORT_C virtual TSize SizeInPixels() const;

Description

Gets the size of the device area in pixels.

Return value

IMPORT_C virtual TSize SizeInTwips() const;

Description

Gets the size of the device area in twips.

Return value

IMPORT_C virtual TInt CreateContext(CGraphicsContext *&aGC);

Description

Creates a graphics context for the device.

Parameters

Return value

IMPORT_C virtual TInt NumTypefaces() const;

Description

Gets the number of typefaces supported by the graphics device.

Return value

IMPORT_C virtual 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

See also:

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

IMPORT_C virtual 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

Return value

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

Description

Gets the palette attributes of the device.

Parameters

IMPORT_C virtual void SetPalette(CPalette *aPalette);

Description

Sets the device's palette.

Parameters

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

Description

Gets the device's current palette.

Parameters

Return value

IMPORT_C TInt NumBands() const;

Description

Return value

IMPORT_C TInt NextBand();

Description

Return value

IMPORT_C TRect BandRect() const;

Description

Return value

IMPORT_C TPoint FullOriginToBandOrigin(const TPoint &aPoint) const;

Description

Parameters

Return value

IMPORT_C void Reset();

Description

inline TBandingDirection BandingDirection() const;

Description

Return value

inline CFbsBitmap* BandBitmap() const;

Description

Return value