Collapse all Symbian^3 Product Developer Library

CMetafileDevice Class Reference

class CMetafileDevice : public CGraphicsDevice

Internal to Symbian

Inherits from

CMetafileDevice
- CGraphicsDevice
  - CBase

Public Member Functions
	~CMetafileDevice()
IMPORT_C TInt	CreateContext(CGraphicsContext *&)
IMPORT_C TDisplayMode	DisplayMode()
IMPORT_C void	EndOfStreamL()
IMPORT_C TInt	FontHeightInTwips(TInt, TInt)
IMPORT_C TInt	GetNearestFontInTwips(CFont *&, const TFontSpec &)
IMPORT_C TInt	GetNearestFontToDesignHeightInTwips(CFont *&, const TFontSpec &)
IMPORT_C TInt	GetNearestFontToMaxHeightInTwips(CFont *&, const TFontSpec &, TInt)
IMPORT_C TInt	GetPalette(CPalette *&)
IMPORT_C TInt	HorizontalPixelsToTwips(TInt)
IMPORT_C TInt	HorizontalTwipsToPixels(TInt)
IMPORT_C CMetafileDevice *	NewL(CGraphicsDevice *)
IMPORT_C TInt	NumTypefaces()
IMPORT_C void	PaletteAttributes(TBool &, TInt &)
IMPORT_C void	ReleaseFont(CFont *)
IMPORT_C void	SetPalette(CPalette *)
IMPORT_C TSize	SizeInPixels()
IMPORT_C TSize	SizeInTwips()
IMPORT_C void	StartOutputStreamL(RWriteStream &)
IMPORT_C void	TypefaceSupport(TTypefaceSupport &, TInt)
IMPORT_C void	UseGcL(TInt)
IMPORT_C TInt	VerticalPixelsToTwips(TInt)
IMPORT_C TInt	VerticalTwipsToPixels(TInt)
IMPORT_C RWriteStream &	WriteStream()

Protected Member Functions
	CMetafileDevice(CGraphicsDevice *)

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

Private Attributes
TInt	iGcCount
TInt	iGcIndex
CGraphicsDevice *	iRealDevice
RWriteStream *	iWriteStream

Constructor & Destructor Documentation

CMetafileDevice(CGraphicsDevice *)

IMPORT_C

CMetafileDevice

(

CGraphicsDevice *

aDevice

)

[protected]

Parameters

CGraphicsDevice * aDevice

~CMetafileDevice()

IMPORT_C

~CMetafileDevice

(

)

Member Functions Documentation

CreateContext(CGraphicsContext *&)

IMPORT_C TInt

CreateContext

(

CGraphicsContext *&

aGC

)

[virtual]

Creates a graphics context for the device.

Parameters

CGraphicsContext *& aGC

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

DisplayMode()

IMPORT_C TDisplayMode

DisplayMode

(

)

const [virtual]

Gets the display mode of the device.

EndOfStreamL()

IMPORT_C void

EndOfStreamL

(

)

FontHeightInTwips(TInt, TInt)

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

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

GetNearestFontInTwips(CFont *&, const TFontSpec &)

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

Parameters

CFont *& aFont
const TFontSpec & aFontSpec

GetNearestFontToDesignHeightInTwips(CFont *&, const TFontSpec &)

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

Parameters

CFont *& aFont
const TFontSpec & aFontSpec

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

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

Parameters

CFont *& aFont
const TFontSpec & aFontSpec
TInt aMaxHeight

GetPalette(CPalette *&)

IMPORT_C TInt

GetPalette

(

CPalette *&

aPalette

)

const [virtual]

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

Parameters

CPalette *& aPalette

On return, holds the device's current palette.

HorizontalPixelsToTwips(TInt)

IMPORT_C TInt

HorizontalPixelsToTwips

(

TInt

aPixels

)

const

Parameters

TInt aPixels

HorizontalTwipsToPixels(TInt)

IMPORT_C TInt

HorizontalTwipsToPixels

(

TInt

aTwips

)

const

Parameters

TInt aTwips

NewL(CGraphicsDevice *)

IMPORT_C CMetafileDevice *

NewL

(

CGraphicsDevice *

aDevice

)

[static]

Parameters

CGraphicsDevice * aDevice

NumTypefaces()

IMPORT_C TInt

NumTypefaces

(

)

const [virtual]

Gets the number of typefaces supported by the graphics device.

PaletteAttributes(TBool &, TInt &)

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

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.

ReleaseFont(CFont *)

IMPORT_C void

ReleaseFont

(

CFont *

aFont

)

Parameters

CFont * aFont

SetPalette(CPalette *)

IMPORT_C void

SetPalette

(

CPalette *

aPalette

)

[virtual]

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

Parameters

CPalette * aPalette

The new palette for the device.

SizeInPixels()

IMPORT_C TSize

SizeInPixels

(

)

const [virtual]

Gets the size of the device area in pixels.

SizeInTwips()

IMPORT_C TSize

SizeInTwips

(

)

const [virtual]

Gets the size of the device area in twips.

StartOutputStreamL(RWriteStream &)

IMPORT_C void

StartOutputStreamL

(

RWriteStream &

aStream

)

Parameters

RWriteStream & aStream

TypefaceSupport(TTypefaceSupport &, TInt)

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

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

NumTypefaces()

Parameters

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

UseGcL(TInt)

IMPORT_C void

UseGcL

(

TInt

aGcIndex

)

Parameters

TInt aGcIndex

VerticalPixelsToTwips(TInt)

IMPORT_C TInt

VerticalPixelsToTwips

(

TInt

aPixels

)

const

Parameters

TInt aPixels

VerticalTwipsToPixels(TInt)

IMPORT_C TInt

VerticalTwipsToPixels

(

TInt

aTwips

)

const

Parameters

TInt aTwips

WriteStream()

IMPORT_C RWriteStream &

WriteStream

(

)

Member Data Documentation

TInt iGcCount

TInt

iGcCount

[private]

TInt iGcIndex

TInt

iGcIndex

[private]

CGraphicsDevice * iRealDevice

CGraphicsDevice *

iRealDevice

[private]

RWriteStream * iWriteStream

RWriteStream *

iWriteStream

[private]