CFbsTypefaceStore Class Reference

#include <fbs.h>

class CFbsTypefaceStore : public CTypefaceStore

Inherits from

CFbsTypefaceStore

Public Member Functions
	~CFbsTypefaceStore()
IMPORT_C TInt	AddFile(const TDesC &, TInt &)
IMPORT_C TGlyphBitmapType	DefaultBitmapType()
IMPORT_C TInt	FontHeightInPixels(TInt, TInt)
virtual IMPORT_C TInt	FontHeightInTwips(TInt, TInt)
IMPORT_C TInt	GetFontById(CFont *&, TUid, const TAlgStyle &)
IMPORT_C void	GetLinkedTypefaceL(CLinkedTypefaceSpecification &)
IMPORT_C TInt	GetNearestFontInPixels(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontInTwips(CFont *&, const TFontSpec &)
IMPORT_C TInt	GetNearestFontToDesignHeightInPixels(CFont *&, const TFontSpec &)
virtual IMPORT_C TInt	GetNearestFontToDesignHeightInTwips(CFont *&, const TFontSpec &)
IMPORT_C TInt	GetNearestFontToMaxHeightInPixels(CFont *&, const TFontSpec &, TInt)
virtual IMPORT_C TInt	GetNearestFontToMaxHeightInTwips(CFont *&, const TFontSpec &, TInt)
IMPORT_C TInt	InstallFile(const TDesC &, TInt &)
IMPORT_C CFbsTypefaceStore *	NewL(CGraphicsDevice *)
virtual IMPORT_C TInt	NumTypefaces()
IMPORT_C TInt	RegisterLinkedTypeface(const CLinkedTypefaceSpecification &, TInt &)
IMPORT_C TInt	RegisterLinkedTypeface(const CLinkedTypefaceSpecification &)
IMPORT_C void	ReleaseTwipsCache()
IMPORT_C void	RemoveFile(TInt)
IMPORT_C void	RemoveFontFileLocksL()
IMPORT_C void	RemoveFontFileLocksL(const TDesC &, TBool)
IMPORT_C void	RemoveFontFileLocksL(const TDesC &)
IMPORT_C void	SetDefaultBitmapType(TGlyphBitmapType)
IMPORT_C void	SetDefaultLanguageForMetrics(TLanguage)
IMPORT_C void	SetFontNameAliasL(const TDesC &, const TDesC &)
IMPORT_C void	SetSystemDefaultTypefaceNameL(const TDesC &)
virtual IMPORT_C void	TypefaceSupport(TTypefaceSupport &, TInt)
IMPORT_C TInt	UpdateLinkedTypeface(const CLinkedTypefaceSpecification &)

Inherited Attributes
	CTypefaceStore::iFontAccess

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()
	CTypefaceStore::AddFontL(CFont *)
	CTypefaceStore::BaselineOffset(TInt,TFontPrintPosition)
	CTypefaceStore::CTypefaceStore()
	CTypefaceStore::IncrementFontCount(const CFont *)
	CTypefaceStore::ReleaseFont(CFont *)
	CTypefaceStore::SuperSubHeight(TInt,TFontPrintPosition)
	CTypefaceStore::~CTypefaceStore()

Detailed Description

Font and bitmap server typeface store.

Constructor & Destructor Documentation

~CFbsTypefaceStore ( )

IMPORT_C

~CFbsTypefaceStore

(

)

Member Function Documentation

AddFile ( const TDesC &, TInt & )

IMPORT_C TInt	AddFile	(	const TDesC &	aName,
			TInt &	aId
		)

Adds a font store file to the typeface store. All the fonts in added and installed font files are available to the GetNearestFont...() family of functions. Additionally Bitmap Fonts are also available to GetFontById().

This function adds the typeface to a reference counted list of fonts. Each client that adds the typeface to the store increases the reference count. The count is decremented when a client using the typeface is destroyed or calls the RemoveFile() function. The typeface is removed from the store only when the the reference count is zero (it is not being used by any clients). The InstallFile() function is similar, except that the typeface is not reference counted, and is hence not removed when all the clients using it are destroyed.

Parameter	Description
aName	A descriptor containing the filename of the typeface store
aId	On return, contains the id of the typeface.

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

DefaultBitmapType ( )

IMPORT_C TGlyphBitmapType

DefaultBitmapType

(

)

const

Gets the default anti-aliasing setting for scalable fonts.

Returns: Indicates whether or not scalable fonts should be drawn using anti-aliasing.

FontHeightInPixels ( TInt, TInt )

IMPORT_C TInt	FontHeightInPixels	(	TInt	aTypefaceIndex,
			TInt	aHeightIndex
		)	const

Gets the height of the font with specified height and typeface indices, in pixels. The value returned is rounded up or down to the nearest font height in pixels.

If aTypefaceIndex<0 the function panics with EFbsTypefaceIndexOutOfRange. If aTypefaceIndex is greater than the number of typefaces or aHeightIndex<0 then the function returns 0. If aHeightIndex is greater than the number of heights then the function returns the biggest height.

Parameter	Description
aTypefaceIndex	A typeface index number, in the range: 0 to (NumTypefaces() - 1).
aHeightIndex	A font height index number, in the range: 0 to (TTypefaceSupport::iNumHeights - 1). Note: TTypefaceSupport::iNumHeights is returned by TypefaceSupport().

Returns: The height of the font, in pixels.

FontHeightInTwips ( TInt, TInt )

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

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

Gets the height of the font with specified height and typeface indices, in twips. The value returned is rounded up or down to the nearest font height in twips.

Parameter	Description
aTypefaceIndex	A typeface index number, in the range: 0 to (NumTypefaces() - 1).
aHeightIndex	A font height index number, in the range: 0 to (TTypefaceSupport::iNumHeights - 1). Note: TTypefaceSupport::iNumHeights is returned by TypefaceSupport().

Returns: The height of the font, in twips.

GetFontById ( CFont *&, TUid, const TAlgStyle & )

IMPORT_C TInt	GetFontById	(	CFont *&	aFont,
			TUid	aUid,
			const TAlgStyle &	aAlgStyle
		)

Gets a Bitmap Font by unique identifier and algorithmic drawing style. Chooses from the Bitmap fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

Parameter	Description
aFont	On return, contains a pointer to the retrieved font.
aUid	The unique identifier of the font to be retrieved.
aAlgStyle	Algorithmic style to be applied. e.g. Sets things like algorithmic bolding, or slant for pseudo-italics.

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

GetLinkedTypefaceL ( CLinkedTypefaceSpecification & )

IMPORT_C void

GetLinkedTypefaceL

(

CLinkedTypefaceSpecification &

aLinkedTypefaceSpec

)

Function to retrieve a linked typeface specification from the installed rasterizer. If there is not a rasterizer present supporting font linking then KErrNotSupported will be returned. The rasterizer is name specified within the passed specification and fills in the elements and groups if the typeface exists.

leave: KErrNoMemory if there is insufficient memory available

leave: KErrServerTerminated if the server no longer present

leave: KErrServerBusy if there are no message slots available

GetNearestFontInPixels ( CFont *&, const TFontSpec & )

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

Gets the font which is the nearest to the given font specification.

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

Note that this deprecated function is replaced by the new GetNearestFontToDesignHeightInPixels() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInPixels() function instead. This will guarantee that every character within any given text string will fit within the given amount of pixels, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

Chooses from the fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

DeprecatedUse GetNearestFontToDesignHeightInPixels

Parameter	Description
aFont	On return, contains a pointer to the nearest font.
aFontSpec	The specification of the font to be matched.

Returns: KErrNone if successful; a system-wide error code otherwise.

GetNearestFontInTwips ( CFont *&, const TFontSpec & )

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

Reimplemented from CTypefaceStore::GetNearestFontInTwips(CFont *&,const TFontSpec &)

Gets the font which is the nearest to the given font specification.

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

Note that this deprecated function is replaced by the new GetNearestFontToDesignHeightInTwips() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInTwips() function instead. This will guarantee that every character within any given text string will fit within the given amount of twips, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

Chooses from the fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

Parameter	Description
aFont	On return, contains a pointer to the nearest font.
aFontSpec	The specification of the font to be matched.

Returns: KErrNone if successful; a system-wide error code otherwise.

GetNearestFontToDesignHeightInPixels ( CFont *&, const TFontSpec & )

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

Gets the font which is the nearest to the given font specification.

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

This new function replaces the deprecated GetNearestFontInPixels() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInPixels() function instead. This will guarantee that every character within any given text string will fit within the given amount of pixels, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

Chooses from the fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

Parameter	Description
aFont	On return, contains a pointer to the nearest font.
aFontSpec	The specification of the font to be matched.

Returns: KErrNone if successful; a system-wide error code otherwise.

GetNearestFontToDesignHeightInTwips ( CFont *&, const TFontSpec & )

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

Reimplemented from CTypefaceStore::GetNearestFontToDesignHeightInTwips(CFont *&,const TFontSpec &)

Gets the font which is the nearest to the given font specification.

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

This new function replaces the deprecated GetNearestFontInTwips() yielding (virtually) the same result. However clients are strongly encouraged to use the new GetNearestFontToMaxHeightInTwips() function instead. This will guarantee that every character within any given text string will fit within the given amount of twips, whereas the design height is an aesthetic unit decided by the font designer without strict physical meaning, which may result in cropped characters.

Chooses from the fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

Parameter	Description
aFont	On return, contains a pointer to the nearest font.
aFontSpec	The specification of the font to be matched.

Returns: KErrNone if successful; a system-wide error code otherwise.

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

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

Gets the font which is the nearest to the given font specification.

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

The font and bitmap server returns a pointer to the nearest matching font from those available. Matches to max height of font - this does its best to return a font that will fit within the maximum height specified (but note that variations due to hinting algorithms may rarely result in this height being exceeded by up to one pixel). Problems can also be encountered with bitmap fonts where the typeface exists but doesn't have a font small enough.

Chooses from the fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

Parameter	Description
aFont	On return, contains a pointer to the nearest font.
aFontSpec	The specification of the font to be matched.
aMaxHeight	The maximum height within which the font must fit. This overrides the height specified in aFontSpec.

Returns: KErrNone if successful; a system-wide error code otherwise.

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

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

Reimplemented from CTypefaceStore::GetNearestFontToMaxHeightInTwips(CFont *&,const TFontSpec &,TInt)

Gets the font which is the nearest to the given font specification.

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

Chooses from the fonts loaded at system startup or through the AddFile() or InstallFile() APIs.

Parameter	Description
aFont	On return, contains a pointer to the nearest font.
aFontSpec	The specification of the font to be matched.
aMaxHeight	The maximum height within which the font must fit. This overrides the height specified in aFontSpec.

Returns: KErrNone if successful; a system-wide error code otherwise.

InstallFile ( const TDesC &, TInt & )

IMPORT_C TInt	InstallFile	(	const TDesC &	aName,
			TInt &	aId
		)

Installs a font store file into the typeface store. All the fonts in added and installed font files are available to the GetNearestFont...() family of functions. Additionally Bitmap Fonts are also available to GetFontById().

Installed files remain in the typeface store even after the client which added them is destroyed. They can be removed using RemoveFile().

Parameter	Description
aName	The name of the file to be installed.
aId	On return, contains the id of the installed file.

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

NewL ( CGraphicsDevice * )

IMPORT_C CFbsTypefaceStore *

NewL

(

CGraphicsDevice *

aDevice

)

[static]

Allocates and constructs a CFbsTypefaceStore, specifying a graphics device.

Parameter	Description
aDevice	A pointer to a graphics device.

Returns: A pointer to the newly created typeface store.

NumTypefaces ( )

IMPORT_C TInt

NumTypefaces

(

)

const [virtual]

Reimplemented from CTypefaceStore::NumTypefaces()const

Gets the number of typefaces supported by this store.

Returns: The number of supported typefaces.

RegisterLinkedTypeface ( const CLinkedTypefaceSpecification &, TInt & )

IMPORT_C TInt	RegisterLinkedTypeface	(	const CLinkedTypefaceSpecification &	aLinkedTypefaceSpec,
			TInt &	aId
		)

Function to add a CLinkedTypefaceSpecification to the font and bitmap server typeface store.

capability: ECapabilityWriteDeviceData

Parameter	Description
aLinkedTypefaceSpec	The typeface specification to be added. Ownership is not transferred.
aId	A unique identifier

RegisterLinkedTypeface ( const CLinkedTypefaceSpecification & )

IMPORT_C TInt

RegisterLinkedTypeface

(

const CLinkedTypefaceSpecification &

aLinkedTypefaceSpec

)

Function to add a CLinkedTypefaceSpecification to the font and bitmap server typeface store.

capability: ECapabilityWriteDeviceData

ReleaseTwipsCache ( )

IMPORT_C void

ReleaseTwipsCache

(

)

Reset the twips cache.

The Typeface Store remembers font matches found through GetNearestFont...InTwips() family of functions in a cache for quicker matching. This function empties the cache, and should be called after the screen mode is changed as the Twips to pixels relationship may have changed.

RemoveFile ( TInt )

IMPORT_C void

RemoveFile

(

TInt

aId = 0

)

Decrements the reference count of a file which was added using AddFile(), and removes it from the store if the reference count reaches zero. If the font was not found in the list of reference-counted files (see AddFile()) it is assumed to be an installed file (see InstallFile()) and an attempt is made to remove it anyway.

If the id given is 0, an attempt is made to remove all font objects from the font store provided none of the fonts in the store are currently accessed, otherwise it has no effect.

Note: The id passed to this function has a different meaning depending on whether or not the file is a Symbian-format bitmap file. If it is a Symbian-format bitmap file the id is a UID, and is the same from one session to the next. If it is an Open Font System file (e.g., a TrueType file) the id is an arbitrary number. Consequently the id may vary from one session to the next, and should not be saved in a file: however it may be kept and used by a client as long as the client is running.

Parameter	Description
aId	The id of the file to be removed/decremented, set by AddFile() or InstallFile().

RemoveFontFileLocksL ( )

IMPORT_C void

RemoveFontFileLocksL

(

)

[static]

Unload all fonts loaded from RAM or removable media Deprecated

RemoveFontFileLocksL ( const TDesC &, TBool )

IMPORT_C void	RemoveFontFileLocksL	(	const TDesC &	aDrive,
			TBool	aAllFonts
		)	[static]

Unload all fonts (of specified type) loaded from named drive

RemoveFontFileLocksL ( const TDesC & )

IMPORT_C void

RemoveFontFileLocksL

(

const TDesC &

aFileName

)

[static]

Unload the named font file

SetDefaultBitmapType ( TGlyphBitmapType )

IMPORT_C void

SetDefaultBitmapType

(

TGlyphBitmapType

aType

)

const

Sets the default anti-aliasing setting for scalable fonts. Unless this default setting is overridden so that a font is explicitly requested with anti-aliasing turned on or off, (see TOpenFontSpec::SetBitmapType() or TFontStyle::SetBitmapType()), fonts will use the default setting. The default setting would typically only be changed via the Control Panel. The new setting affects fonts requested after the change has been made. There is currently no anti-aliasing support for bitmapped fonts.

Parameter	Description
aType	Indicates whether or not scalable fonts should be drawn using anti-aliasing.

SetDefaultLanguageForMetrics ( TLanguage )

IMPORT_C void

SetDefaultLanguageForMetrics

(

TLanguage

aLanguage

)

const

Specifies the default language with which font metrics calculation will be based on. The default language will be used if none is set on the font specification.

SetFontNameAliasL ( const TDesC &, const TDesC & )

IMPORT_C void	SetFontNameAliasL	(	const TDesC &	aFontAlias,
			const TDesC &	aFontName
		)	const

Sets an alias for a font name.

If a requested font cannot be found and its name occurs in the alias list then it will be searched for again using the font name corresponding to that alias. If an empty font name is passed then the alias will be removed the list.

SetSystemDefaultTypefaceNameL ( const TDesC & )

IMPORT_C void

SetSystemDefaultTypefaceNameL

(

const TDesC &

aFontTypefaceName

)

Sets the system default font typeface. This font will be used when finding the nearest font and the font specified is an empty descriptor. If the system default font is not set, then the default behaviour is to find the nearest match.

capability: WriteDeviceData

TypefaceSupport ( TTypefaceSupport &, TInt )

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

Reimplemented from CTypefaceStore::TypefaceSupport(TTypefaceSupport &,TInt)const

Gets typeface information for a specified typeface index. 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, and whether it is a scaleable typeface.

Returns benignly with an empty TTypefaceSupport if the index is too high; this can happen if another process removes a typeface after the first process has already got the number of typefaces. However, if the aTypefaceIndex<0 the function panics with EFbsTypefaceIndexOutOfRange.

Parameter	Description
aTypefaceSupport	On return, if the function executed successfully, this object contains the typeface information.
aTypefaceIndex	A typeface index number, in the range: zero to (NumTypefaces() - 1).

UpdateLinkedTypeface ( const CLinkedTypefaceSpecification & )

IMPORT_C TInt

UpdateLinkedTypeface

(

const CLinkedTypefaceSpecification &

aLinkedTypefaceSpec

)

Function to update an existing linked typeface with a new specification. If successful a temporary file is generated and this will replace the linked font after a reboot. Calls to FetchLinkedTypefaceSpecificationL will return the currently loaded linked font spec and not the updated specification.

panic: EFbsPanicNoConnection There is no connection to FontBitmap Server

Parameter	Description
aLinkedTypefaceSpec	A new linked font specification to replace an existing file

Returns: TInt One of the system wide error codes