class CFbsTypefaceStore : public CTypefaceStore |
Font and bitmap server typeface store.
Private Member Functions | |
---|---|
CFbsTypefaceStore(CGraphicsDevice *) | |
void | ConstructL() |
TInt | CreateFont(CFont *&, const TFontInfo &) |
TInt | FontHeight(TInt, TInt, TInt) |
TInt | GetNearestFontInTwipsAndCreateFont(CFont *&, TInt, const TFontSpec &, TInt) |
void | GetPixelSizeInTwips(TSize &) |
TBool | IsFontLoaded(CFont *&, const TFontInfo &) |
TInt | SendGetNearestFontCommandNCreateFont(CFont *&, TInt, const TFontSpec &, TInt) |
Private Attributes | |
---|---|
CGraphicsDevice * | iDevice |
RFbsSession * | iFbs |
CFontCache * | iTwipsCache |
Inherited Attributes | |
---|---|
CTypefaceStore::iFontAccess |
CFbsTypefaceStore | ( | CGraphicsDevice * | aDevice | ) | [private] |
CGraphicsDevice * aDevice |
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. InstallFile() RemoveFile() GetFontById() GetNearestFontToDesignHeightInTwips() GetNearestFontToDesignHeightInPixels() GetNearestFontToMaxHeightInTwips() GetNearestFontToMaxHeightInPixels()
TInt | CreateFont | ( | CFont *& | aFont, |
const TFontInfo & | aFontInfo | |||
) | [private] |
IMPORT_C TGlyphBitmapType | DefaultBitmapType | ( | ) | const |
Gets the default anti-aliasing setting for scalable fonts.
TInt | FontHeight | ( | TInt | aTypefaceIndex, |
TInt | aHeightIndex, | |||
TInt | aMessage | |||
) | const [private] |
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.
IMPORT_C TInt | FontHeightInTwips | ( | TInt | aTypefaceIndex, |
TInt | aHeightIndex | |||
) | const [virtual] |
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.
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.
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.
GetNearestFontToMaxHeightInTwips() GetNearestFontToDesignHeightInTwips() GetNearestFontToMaxHeightInPixels() GetNearestFontToDesignHeightInPixels() AddFile() InstallFile()
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.
CLinkedTypefaceSpecification & aLinkedTypefaceSpec |
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.
Use GetNearestFontToDesignHeightInPixels GetNearestFontToDesignHeightInPixels() GetNearestFontToMaxHeightInPixels() AddFile() InstallFile()
IMPORT_C TInt | GetNearestFontInTwips | ( | CFont *& | aFont, |
const TFontSpec & | aFontSpec | |||
) | [virtual] |
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.
GetNearestFontToDesignHeightInTwips() GetNearestFontToMaxHeightInTwips() AddFile() InstallFile()
TInt | GetNearestFontInTwipsAndCreateFont | ( | CFont *& | aFont, |
TInt | aFbsMessage, | |||
const TFontSpec & | aFontSpec, | |||
TInt | aMaxHeight = 0 | |||
) | [private] |
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.
IMPORT_C TInt | GetNearestFontToDesignHeightInTwips | ( | CFont *& | aFont, |
const TFontSpec & | aFontSpec | |||
) | [virtual] |
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.
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.
GetNearestFontToDesignHeightInPixels() AddFile() InstallFile()
IMPORT_C TInt | GetNearestFontToMaxHeightInTwips | ( | CFont *& | aFont, |
const TFontSpec & | aFontSpec, | |||
TInt | aMaxHeight | |||
) | [virtual] |
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.
GetNearestFontToDesignHeightInTwips() AddFile() InstallFile()
void | GetPixelSizeInTwips | ( | TSize & | aSize | ) | const [private] |
get pixel size in Twips * 1000
TSize & aSize |
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(). AddFile() RemoveFile() GetFontById() GetNearestFontToDesignHeightInTwips() GetNearestFontToDesignHeightInPixels() GetNearestFontToMaxHeightInTwips() GetNearestFontToMaxHeightInPixels()
TBool | IsFontLoaded | ( | CFont *& | aFont, |
const TFontInfo & | aFontInfo | |||
) | const [private] |
CFontStore::IsFontLoaded CPdrTypefaceStore::IsFontLoaded
IMPORT_C CFbsTypefaceStore * | NewL | ( | CGraphicsDevice * | aDevice | ) | [static] |
Allocates and constructs a CFbsTypefaceStore, specifying a graphics device.
CGraphicsDevice * aDevice | A pointer to a graphics device. |
IMPORT_C TInt | NumTypefaces | ( | ) | const [virtual] |
Gets the number of typefaces supported by this store. CTypefaceStore::NumTypefaces()
IMPORT_C TInt | RegisterLinkedTypeface | ( | const CLinkedTypefaceSpecification & | aLinkedTypefaceSpec, |
TInt & | aId | |||
) |
const CLinkedTypefaceSpecification & aLinkedTypefaceSpec | The typeface specification to be added. Ownership is not transferred. |
TInt & aId | A unique identifier |
IMPORT_C TInt | RegisterLinkedTypeface | ( | const CLinkedTypefaceSpecification & | aLinkedTypefaceSpec | ) |
const CLinkedTypefaceSpecification & aLinkedTypefaceSpec |
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.
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.
TInt aId = 0 | The id of the file to be removed/decremented, set by AddFile() or InstallFile(). |
IMPORT_C void | RemoveFontFileLocksL | ( | ) | [static] |
Unload all fonts loaded from RAM or removable media
IMPORT_C void | RemoveFontFileLocksL | ( | const TDesC & | aDrive, |
TBool | aAllFonts | |||
) | [static] |
Unload all fonts (of specified type) loaded from named drive
IMPORT_C void | RemoveFontFileLocksL | ( | const TDesC & | aFileName | ) | [static] |
Unload the named font file
const TDesC & aFileName |
TInt | SendGetNearestFontCommandNCreateFont | ( | CFont *& | aFont, |
TInt | aFbsMessage, | |||
const TFontSpec & | aFontSpec, | |||
TInt | aMaxHeight = 0 | |||
) | [private] |
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. TOpenFontSpec::SetBitmapType() TFontStyle::SetBitmapType()
TGlyphBitmapType aType | Indicates whether or not scalable fonts should be drawn using anti-aliasing. |
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. TFontSpec::SetScriptTypeForMetrics
TLanguage aLanguage |
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.
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.
const TDesC & aFontTypefaceName |
IMPORT_C void | TypefaceSupport | ( | TTypefaceSupport & | aTypefaceSupport, |
TInt | aTypefaceIndex | |||
) | const [virtual] |
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.
TTypefaceSupport & aTypefaceSupport | On return, if the function executed successfully, this object contains the typeface information. |
TInt aTypefaceIndex | A typeface index number, in the range: zero to (NumTypefaces() - 1). |
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.
const CLinkedTypefaceSpecification & aLinkedTypefaceSpec | A new linked font specification to replace an existing file |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.