FontUtils Class Reference

#include <mw/gulutil.h>

Link against: egul.lib

class FontUtils

Public Member Functions
IMPORT_C void	GetAvailableFontsL(const CGraphicsDevice &, CDesCArray &, TInt)
IMPORT_C TInt	GetAvailableHeightsInTwipsAndPointsL(const CGraphicsDevice &, const TDesC &, CArrayFix< TInt > &, CDesCArray &)
IMPORT_C TInt	GetAvailableHeightsInTwipsL(const CGraphicsDevice &, const TDesC &, CArrayFix< TInt > &)
IMPORT_C TInt	IndexOfNearestHeight(CArrayFix< TInt > &, TInt)
IMPORT_C TInt	PointsFromTwips(TInt)
IMPORT_C TInt	TwipsFromPoints(TInt)
IMPORT_C TInt	TwipsFromPoints(const TDesC &)
IMPORT_C TInt	TypefaceAttributes(const CGraphicsDevice &, const TDesC &)

Detailed Description

Provides static functions for getting information about the fonts supported by a graphics device.

Member Function Documentation

GetAvailableFontsL ( const CGraphicsDevice &, CDesCArray &, TInt )

IMPORT_C void	GetAvailableFontsL	(	const CGraphicsDevice &	aDevice,
			CDesCArray &	aFontNameList,
			TInt	aFonts = EGulNoSymbolFonts
		)	[static]

Gets the list of typeface names available for the graphics device.

Parameters
aDevice	The graphics device.
aFontNameList	On return, contains the list of typeface names.
aFonts	Can be used to specify which sorts of typefaces are required. For possible values, see the flags defined in gulftflg.hrh beginning with EGulAllFonts.

GetAvailableHeightsInTwipsAndPointsL ( const CGraphicsDevice &, const TDesC &, CArrayFix< TInt > &, CDesCArray & )

IMPORT_C TInt	GetAvailableHeightsInTwipsAndPointsL	(	const CGraphicsDevice &	aDevice,
			const TDesC &	aTypefaceName,
			CArrayFix< TInt > &	aTwipsList,
			CDesCArray &	aPointsList
		)	[static]

Gets a list of all heights in twips, available for the named typeface and the graphics device specified.

Also gets a list of heights in points, represented as character strings.

Parameters
aDevice	The graphics device.
aTypefaceName	The name of the typeface.
aTwipsList	On return, contains all available heights for the typeface, in twips.
aPointsList	On return, the heights in points, represented as character strings.

Return Value: KErrNotSupported if the named typeface is not supported by the graphics device, otherwise KErrNone.

GetAvailableHeightsInTwipsL ( const CGraphicsDevice &, const TDesC &, CArrayFix< TInt > & )

IMPORT_C TInt	GetAvailableHeightsInTwipsL	(	const CGraphicsDevice &	aDevice,
			const TDesC &	aTypefaceName,
			CArrayFix< TInt > &	aHeightList
		)	[static]

Gets a list of all heights in twips, available for the named typeface and the graphics device specified.

Parameters
aDevice	The graphics device.
aTypefaceName	The name of the typeface.
aHeightList	On return, contains all available heights for the typeface, in twips.

Return Value: KErrNotSupported if the named typeface is not supported by the graphics device, otherwise KErrNone.

IndexOfNearestHeight ( CArrayFix< TInt > &, TInt )

IMPORT_C TInt	IndexOfNearestHeight	(	CArrayFix< TInt > &	aTwipsList,
			TInt	aHeight
		)	[static]

Gets the index into the supplied list of font heights of the closest match to the font height specified.

Parameters
aTwipsList	The twips list.
aHeight	The requested font height. This may be generated by a call to GetAvailableHeightsInTwipsL() or GetAvailableHeightsInTwipsAndPointsL().

Return Value: The index into the list of the closest font height to aHeight.

PointsFromTwips ( TInt )

IMPORT_C TInt

PointsFromTwips

(

TInt

aTwips

)

[static]

Converts a number of twips to points.

Parameters
aTwips	A number of twips.

Return Value: A number of points.

TwipsFromPoints ( TInt )

IMPORT_C TInt

TwipsFromPoints

(

TInt

aPoints

)

[static]

Converts a number of points into twips.

Parameters
aPoints	A number of points.

Return Value: A number of twips.

TwipsFromPoints ( const TDesC & )

IMPORT_C TInt

TwipsFromPoints

(

const TDesC &

aPoints

)

[static]

Converts a number of points held as text to twips.

Parameters
aPoints	A number of points as text.

Return Value: A number of twips.

TypefaceAttributes ( const CGraphicsDevice &, const TDesC & )

IMPORT_C TInt	TypefaceAttributes	(	const CGraphicsDevice &	aDevice,
			const TDesC &	aTypefaceName
		)	[static]

Gets the attributes of a named typeface, if supported by the graphics device.

Parameters
aDevice	The graphics device.
aTypefaceName	The name of the typeface.

Return Value: The typeface attributes. Attributes are zero if the typeface is not supported by the graphics device. Attribute values are defined in TTypeface.