CBandedDevice

#include <banddev.h>

Link against: pdrstr.lib

class CBandedDevice : public CGraphicsDevice

Inherits from

CBandedDevice

Public Member Functions
	~CBandedDevice()
CFbsBitmap *	BandBitmap()
IMPORT_C TRect	BandRect()
TBandingDirection	BandingDirection()
virtual IMPORT_C TInt	CreateContext(CGraphicsContext *&)
virtual IMPORT_C TDisplayMode	DisplayMode()
virtual IMPORT_C TInt	FontHeightInTwips(TInt, TInt)
IMPORT_C TPoint	FullOriginToBandOrigin(const TPoint &)
virtual IMPORT_C TInt	GetNearestFontInTwips(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontToDesignHeightInTwips(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontToMaxHeightInTwips(CFont *&, const TFontSpec &, TInt)
virtual IMPORT_C TInt	GetPalette(CPalette *&)
IMPORT_C TInt	HorizontalPixelsToTwips(TInt)
IMPORT_C TInt	HorizontalTwipsToPixels(TInt)
IMPORT_C CBandedDevice *	NewL(TRect, TSize, TDisplayMode, TBandingDirection, TInt)
IMPORT_C TInt	NextBand()
IMPORT_C TInt	NumBands()
virtual IMPORT_C TInt	NumTypefaces()
virtual IMPORT_C void	PaletteAttributes(TBool &, TInt &)
IMPORT_C void	ReleaseFont(CFont *)
IMPORT_C void	Reset()
virtual IMPORT_C void	SetPalette(CPalette *)
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()

Constructor & Destructor Documentation

~CBandedDevice ( )

IMPORT_C

~CBandedDevice

(

)

Member Function Documentation

BandBitmap ( )

CFbsBitmap *

BandBitmap

(

)

const [inline]

BandRect ( )

IMPORT_C TRect

BandRect

(

)

const

BandingDirection ( )

TBandingDirection

BandingDirection

(

)

const [inline]

CreateContext ( CGraphicsContext *& )

IMPORT_C TInt

CreateContext

(

CGraphicsContext *&

aGC

)

[virtual]

Reimplemented from CGraphicsDevice::CreateContext(CGraphicsContext *&)

Creates a graphics context for the device.

Parameter	Description
aGC	On return, contains a pointer to the created graphics context.

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

DisplayMode ( )

IMPORT_C TDisplayMode

DisplayMode

(

)

const [virtual]

Reimplemented from CGraphicsDevice::DisplayMode()const

Gets the display mode of the device.

Returns: The display mode of the device.

FontHeightInTwips ( TInt, TInt )

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

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

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.

Parameter	Description
aTypefaceIndex	An index identifying the typeface, in the range: 0 to (NumTypefaces() - 1).
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().

Returns: The height of the font, in twips.

FullOriginToBandOrigin ( const TPoint & )

IMPORT_C TPoint

FullOriginToBandOrigin

(

const TPoint &

aPoint

)

const

GetNearestFontInTwips ( CFont *&, const TFontSpec & )

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

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

Deprecated

Parameter	Description
aFont	On return, points to the font which most closely matches the specified font.
aFontSpec	An absolute font specification. Its iHeight member is interpreted as being in twips.

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

GetNearestFontToDesignHeightInTwips ( CFont *&, const TFontSpec & )

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

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

Parameter	Description
aFont	On return, points to the font which most closely matches the specified font.
aFontSpec	An absolute font specification. Its iHeight member is interpreted as being in twips.

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

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

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

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.

GetPalette ( CPalette *& )

IMPORT_C TInt

GetPalette

(

CPalette *&

aPalette

)

const [virtual]

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

Gets the device's current palette.

This function is only supported if the device has a modifiable palette, which can be determined by calling PaletteAttributes().

Parameter	Description
aPalette	On return, holds the device's current palette.

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

HorizontalPixelsToTwips ( TInt )

IMPORT_C TInt

HorizontalPixelsToTwips

(

TInt

aPixels

)

const

HorizontalTwipsToPixels ( TInt )

IMPORT_C TInt

HorizontalTwipsToPixels

(

TInt

aTwips

)

const

NewL ( TRect, TSize, TDisplayMode, TBandingDirection, TInt )

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

NextBand ( )

IMPORT_C TInt

NextBand

(

)

NumBands ( )

IMPORT_C TInt

NumBands

(

)

const

NumTypefaces ( )

IMPORT_C TInt

NumTypefaces

(

)

const [virtual]

Reimplemented from CGraphicsDevice::NumTypefaces()const

Gets the number of typefaces supported by the graphics 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 palette attributes of the device.

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

ReleaseFont ( CFont * )

IMPORT_C void

ReleaseFont

(

CFont *

aFont

)

Reset ( )

IMPORT_C void

Reset

(

)

SetPalette ( CPalette * )

IMPORT_C void

SetPalette

(

CPalette *

aPalette

)

[virtual]

Reimplemented from CGraphicsDevice::SetPalette(CPalette *)

Sets the device's palette.

Setting the palette is only possible if the device has a modifiable palette, which can be determined by calling PaletteAttributes().

Parameter	Description
aPalette	The new palette for the device.

SizeInPixels ( )

IMPORT_C TSize

SizeInPixels

(

)

const [virtual]

Reimplemented from CGraphicsDevice::SizeInPixels()const

Gets the size of the device area in pixels.

Returns: The width and height of the device area, in pixels

SizeInTwips ( )

IMPORT_C TSize

SizeInTwips

(

)

const [virtual]

Reimplemented from CGraphicsDevice::SizeInTwips()const

Gets the size of the device area in twips.

Returns: The width and height of the 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 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

Parameter	Description
aTypefaceSupport	On return, 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

VerticalTwipsToPixels ( TInt )

IMPORT_C TInt

VerticalTwipsToPixels

(

TInt

aTwips

)

const

CBandedDevice Class Reference

Inherits from

Constructor & Destructor Documentation

~CBandedDevice ( )

Member Function Documentation

BandBitmap ( )

BandRect ( )

BandingDirection ( )

CreateContext ( CGraphicsContext *& )

DisplayMode ( )

FontHeightInTwips ( TInt, TInt )

FullOriginToBandOrigin ( const TPoint & )

GetNearestFontInTwips ( CFont *&, const TFontSpec & )

GetNearestFontToDesignHeightInTwips ( CFont *&, const TFontSpec & )

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

GetPalette ( CPalette *& )

HorizontalPixelsToTwips ( TInt )

HorizontalTwipsToPixels ( TInt )

NewL ( TRect, TSize, TDisplayMode, TBandingDirection, TInt )

NextBand ( )

NumBands ( )

NumTypefaces ( )

PaletteAttributes ( TBool &, TInt & )

ReleaseFont ( CFont * )

Reset ( )

SetPalette ( CPalette * )

SizeInPixels ( )

SizeInTwips ( )

TypefaceSupport ( TTypefaceSupport &, TInt )

VerticalPixelsToTwips ( TInt )

VerticalTwipsToPixels ( TInt )