CFbsFont in Graphics Font_and_Bitmap

class CFbsFont : public CFont;

Description

Font managed by the font and bitmap server. CFbsFont objects are used for screen and off-screen bitmap fonts. They are usually obtained by calls to the CBitmapDevice::GetNearestFontInPixels(CFont *&,const TFontSpec &) and MGraphicsDeviceMap::GetNearestFontInTwips(CFont *&,const TFontSpec &) functions. The class implements a number of functions inherited from CFont.

Derivation

CBase - Base class for all classes to be instantiated on the heap.

CFont - Abstract font interface.

CFbsFont - Font managed by the font and bitmap server. CFbsFont objects are used for screen...

Members

Defined in CFbsFont:

Address()const
CFbsFont()
CFbsFont(const CFbsFont &)
DoAscentInPixels()constGets the font ascent in pixels.
DoBaselineOffsetInPixels()constGets the baseline offset, in pixels. The offset is how far a font is raised or l...
DoCharWidthInPixels(TChar)constGets the width of the specified character in this font, in pixels.
DoFontSpecInTwips()constGets the font specification of this font in twips.
DoGetCharacterData(TUint,TOpenFontCharMetrics &,const TUint8 *&,TSize &)constGets the character metrics and the glyph bitmap.
DoHeightInPixels()constGets the font height in pixels.
DoMaxCharWidthInPixels()constGets the width of the widest character in this font, in pixels.
DoMaxNormalCharWidthInPixels()constGets the width of the widest normal character in this font, in pixels. Normal ch...
DoTextCount(const TDesC &,TInt)constGets how much of the specified descriptor can be displayed in this font without ...
DoTextCount(const TDesC &,TInt,TInt &)constGets how much of the specified descriptor can be displayed in this font without ...
DoTextWidthInPixels(const TDesC &)constGets the width of the specified descriptor when displayed in this font, in pixel...
DoTypeUid()constGets the font's UID. All CFbsFont objects have the constant UID KCFbsFontUid. It...
Duplicate(TInt)Duplicates a font. This function does not create a copy of the font. It just ass...
GetFaceAttrib(TOpenFontFaceAttrib &)constGets the typeface attributes of Open Font System fonts. Notes: Typeface attribut...
GetFontMetrics(TOpenFontMetrics &)constGets the open font metrics. If the metrics cannot be obtained the function retur...
Handle()constGets the Font and Bitmap server handle of the font.
HasCharacter(TInt)constTests whether the font contains a particular character.
IsOpenFont()constTests whether the font is an Open Font system font. Note: If this function retur...
RawTextWidthInPixels(const TDesC &)constGets the raw width of the text in the descriptor, in pixels. DEPRECATED: Same as...
Reset()
TextWidthInPixels(const TDesC &)constGets the width of the specified descriptor when displayed in this font, in pixel...
TextWidthInPixels(const TDesC &,SCharWidth &)constGets the text width, move and adjusts of the specified descriptor when displayed...
iAddressPointer
iFbs
iHandle
iServerHandle
~CFbsFont()

Inherited from CBase:

Delete(CBase *)Deletes the specified object.
Extension_(TUint,TAny *&,TAny *)Extension function
operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TAny *)Initialises the object to binary zeroes.
operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CFont:

AscentInPixels()constGets the font ascent in pixels. Note that this deprecated function is replaced b...
BaselineOffsetInPixels()constGets the baseline offset in pixels.
CharWidthInPixels(TChar)constGets the width in pixels in this font of the specified character.
CharactersJoin(TInt,TInt)Determines if aLeftCharacter and aRightCharacter affect each other's contextual ...
DescentInPixels()constGets the font descent in pixels. Note that this deprecated function is replaced ...
EAllCharacterDataAll character data is available.
ECharacterWidthOnlyWidth information only is available.
EHorizontalText is drawn horizontally.
ENoCharacterDataNo font information available.
EVerticalText is drawn vertically.
ExtendedFunction(TUid,TAny *)constEnables the caller to access a particular API extension function. N.B. Any overl...
FontCapitalAscent()constGets the ascent of an ANSI capital letter in the font whether or not there are a...
FontLineGap()constGets the suggested line gap for the font. This is the recommended baseline to ba...
FontMaxAscent()constGets the max ascent of any pre-composed glyph in the font. This will include acc...
FontMaxDescent()constGets the max descent of any pre-composed glyph in the font. This will include ac...
FontMaxHeight()constGets the (positive) maximum height in pixels of the font. This may differ from t...
FontSpecInTwips()constGets the font specification of this font in twips.
FontStandardDescent()constGets the descent of an ANSI descending character in the font. Whether or not the...
GetCharacterData(TUint,TOpenFontCharMetrics &,const TUint8 *&,TSize &)constGets the character metrics for a character.
GetCharacterPosition2(TPositionParam &,RShapeInfo &)constTakes Unicode text and produces the glyph cluster for the first character in tha...
HeightInPixels()constGets the font height in pixels. Note that this deprecated function is replaced b...
MaxCharWidthInPixels()constGets the width in pixels of the widest character in this font.
MaxNormalCharWidthInPixels()constGets the width in pixels of the widest normal character in this font.
MeasureText(const TDesC &,const TMeasureTextInput *,TMeasureTextOutput *)constText measurement function.
TCharacterDataAvailabilityData availability flags.
TMeasureTextInputInput parameter block.
TMeasureTextOutputOutput parameter block.
TPositionParamComplicated parameter block used for contextual glyph selection, ligature creati...
TTextDirectionText direction flags.
TextCount(const TDesC &,TInt)constGets how much of the specified descriptor can be displayed in this font without ...
TextCount(const TDesC &,TInt,TInt &)constGets how much of the specified descriptor can be displayed in this font without ...
TypeUid()constGets run-time identity of the actual font type. This enables safe casting to a d...
WidthZeroInPixels()constGets the width of the zero character of this font in pixels.

Description

protected: IMPORT_C ~CFbsFont();

Description

protected: IMPORT_C CFbsFont(const CFbsFont &aFont);

Description

Parameters

const CFbsFont &aFont

private: inline virtual TUid DoTypeUid() const;

Description

Gets the font's UID. All CFbsFont objects have the constant UID KCFbsFontUid. It is safe to cast from CFont* to CFbsFont* if CFont::TypeUid()const returns KCFbsFontUid.

Return value

TUid

The font's UID. This should be KCFbsFontUid.

Description

Gets the font height in pixels.

Return value

TInt

The font height in pixels.

Description

Gets the font ascent in pixels.

Return value

TInt

The font ascent in pixels.

Description

Gets the width of the specified character in this font, in pixels.

Parameters


                                 						TChar aChar

The character whose width should be determined.

Return value

TInt

The width of the specified character in this font, in pixels.

Description

Gets the width of the specified descriptor when displayed in this font, in pixels.

Parameters

const TDesC16 &aText

The descriptor whose width should be determined.

Return value

TInt

The width of the specified descriptor when displayed in this font, in pixels

Description

Gets the baseline offset, in pixels. The offset is how far a font is raised or lowered from its normal baseline.

Return value

TInt

Offset from normal baseline, in pixels.

Description

Gets how much of the specified descriptor can be displayed in this font without exceeding the specified width.

Note: This function does not display any of the descriptor itself. It is used before display, to test whether the whole descriptor can be displayed.

Parameters

`const TDesC16 &aText`	The descriptor.
`TInt aWidthInPixels`	The available width for character display

Return value

TInt

The number of characters (starting from the beginning of the descriptor) which will be able to be displayed without exceeding the specified width.

Description

Gets how much of the specified descriptor can be displayed in this font without exceeding the specified width. It also returns the excess width defined as the specified available width minus the width of the portion of the descriptor which can be displayed without exceeding the available width.

Parameters

`const TDesC16 &aText`	The descriptor.
`TInt aWidthInPixels`	The available width for character display.
`TInt &aExcessWidthInPixels`	The excess width after displaying the portion of the descriptor, in pixels.

Return value

TInt

The number of characters (starting from the beginning of the descriptor) which will be able to be displayed without exceeding the specified width.

Description

Gets the width of the widest character in this font, in pixels.

Return value

TInt

The width of the maximum width character, in pixels.

Description

Gets the width of the widest normal character in this font, in pixels. Normal characters include all character in a character set except non-alphabetic characters (e.g. the copyright symbol, or a block graphics symbol, for example).

Return value

TInt

The width of the maximum width normal character, in pixels.

Description

Gets the font specification of this font in twips.

Return value

TFontSpec

The font specification of this font (in twips).

Description

Gets the character metrics and the glyph bitmap.

Parameters

`TUint aCode`	The character code in Unicode.
`TOpenFontCharMetrics &aMetrics`	On return, contains the character metrics.
`const TUint8 *&aBitmap`	On return, contains a pointer to the compressed glyph bitmap.
`TSize &aBitmapSize`	The size of the returned glyph bitmap in pixels. This is not necessarily the same as the size implied by the returned metrics, which may incorporate algorithmic multiplication.

Return value

CFont::TCharacterDataAvailability

IMPORT_C TBool GetFontMetrics(TOpenFontMetrics &aMetrics) const;

Description

Gets the open font metrics. If the metrics cannot be obtained the function returns EFalse.

Parameters


                                 						TOpenFontMetrics &aMetrics

On return, contains the font metrics

Return value

TBool

EFalse if the metrics cannot be obtained

IMPORT_C TInt TextWidthInPixels(const TDesC &aText) const;

Description

Gets the width of the specified descriptor when displayed in this font, in pixels. Override of the base class to resolve name clash with other TextWidthInPixels variant.

Parameters

const TDesC16 &aText

The descriptor whose width should be determined.

Return value

TInt

The width of the specified descriptor when displayed in this font, in pixels

Description

Gets the text width, move and adjusts of the specified descriptor when displayed in this font.

Parameters

`const TDesC16 &aText`	The descriptor whose width should be determined.
`SCharWidth &aCharWidth`	The width of the specified descriptor when displayed in this font, in pixels (including information on the width, move and adjusts of the descriptor).

IMPORT_C TInt Handle() const;

Description

Gets the Font and Bitmap server handle of the font.

Return value

TInt

The handle of the font.

Interface status:

deprecated

IMPORT_C TInt RawTextWidthInPixels(const TDesC &aText) const;

Description

Gets the raw width of the text in the descriptor, in pixels. DEPRECATED: Same as MeasureText(const TDesC&). This is the width of the text without adjusting for side bearings, algorithmic style etc.

Parameters

const TDesC16 &aText

Any text descriptor (TPtrC, TPtr, _LIT, TBuf etc.).

Return value

TInt

The width (in pixels) of the text in the descriptor.

IMPORT_C TBool GetFaceAttrib(TOpenFontFaceAttrib &aAttrib) const;

Description

Gets the typeface attributes of Open Font System fonts. Notes: Typeface attributes are different from the font metrics; they are not metrics, which are different for every different size, but size-independent attributes of the typeface, like name and style. This function can be used if CFbsFont::IsOpenFont()const returns true i.e. the font is an Open Font.

Parameters


                                 						TOpenFontFaceAttrib &aAttrib

On return, contains the typeface attributes.

Return value

TBool

EFalse if the attributes cannot be obtained, or if the font is not an Open Font (CFbsFont::IsOpenFont()const returns EFalse).

IMPORT_C TBool IsOpenFont() const;

Description

Tests whether the font is an Open Font system font. Note: If this function returns ETrue, the function CFbsFont::GetFaceAttrib(TOpenFontFaceAttrib &)const will work.

Return value

TBool

ETrue if font is an Open Font system font (e.g. TrueType). EFalse if the font is a bitmap font loaded from a GDR file.

IMPORT_C TBool HasCharacter(TInt aCode) const;

Description

Tests whether the font contains a particular character.

Parameters


                                 						TInt aCode

Character code to be tested. This code is in the code page 1252 encoding in v5, otherwise it is in Unicode

Return value

TBool

ETrue if the font contains aCode.

protected: IMPORT_C CBitmapFont* Address() const;

Description

Return value

CBitmapFont *

protected: IMPORT_C TInt Duplicate(TInt aHandle);

Description

Duplicates a font. This function does not create a copy of the font. It just assigns another handle to the bitmap in the font and bitmap server, and sets this object's handle to that.

Parameters


                                 						TInt aHandle

The handle to an existing CFbsFont.

Return value

TInt

KErrNone if successful; KErrCouldNotConnect if no connection to the font and bitmap server could be made; KErrUnknown if no font could be found with the specified handle number.

protected: IMPORT_C void Reset();

Description

protected: RFbsSession * iFbs;

Description

protected: CBitmapFont * iAddressPointer;

Description

protected: TInt iHandle;

Description

protected: TInt iServerHandle;

Class CFbsFont

Description

Derivation

Members

See also:

Construction and destruction

CFbsFont()

Description

~CFbsFont()

Description

CFbsFont(const CFbsFont &)

Description

Parameters

Member functions

DoTypeUid()const

Description

Return value

See also:

DoHeightInPixels()const

Description

Return value

See also:

DoAscentInPixels()const

Description

Return value

See also:

DoCharWidthInPixels(TChar)const

Description

Parameters

Return value

See also:

DoTextWidthInPixels(const TDesC &)const

Description

Parameters

Return value

See also:

DoBaselineOffsetInPixels()const

Description

Return value

See also:

DoTextCount(const TDesC &,TInt)const

Description

Parameters

Return value

See also:

DoTextCount(const TDesC &,TInt,TInt &)const

Description

Parameters

Return value

See also:

DoMaxCharWidthInPixels()const

Description

Return value

See also:

DoMaxNormalCharWidthInPixels()const

Description

Return value

See also:

DoFontSpecInTwips()const

Description

Return value

See also:

DoGetCharacterData(TUint,TOpenFontCharMetrics &,const TUint8 *&,TSize &)const

Description

Parameters

Return value

GetFontMetrics(TOpenFontMetrics &)const

Description

Parameters

Return value

TextWidthInPixels(const TDesC &)const

Description

Parameters

Return value

See also:

TextWidthInPixels(const TDesC &,SCharWidth &)const

Description

Parameters

Handle()const

Description

Class `CFbsFont`

`CFbsFont()`

`~CFbsFont()`

`CFbsFont(const CFbsFont &)`

`DoTypeUid()const`

`DoHeightInPixels()const`

`DoAscentInPixels()const`

`DoCharWidthInPixels(TChar)const`

`DoTextWidthInPixels(const TDesC &)const`

`DoBaselineOffsetInPixels()const`

`DoTextCount(const TDesC &,TInt)const`

`DoTextCount(const TDesC &,TInt,TInt &)const`

`DoMaxCharWidthInPixels()const`

`DoMaxNormalCharWidthInPixels()const`

`DoFontSpecInTwips()const`

`DoGetCharacterData(TUint,TOpenFontCharMetrics &,const TUint8 *&,TSize &)const`

`GetFontMetrics(TOpenFontMetrics &)const`

`TextWidthInPixels(const TDesC &)const`

`TextWidthInPixels(const TDesC &,SCharWidth &)const`

`Handle()const`

`RawTextWidthInPixels(const TDesC &)const`

`GetFaceAttrib(TOpenFontFaceAttrib &)const`

`IsOpenFont()const`

`HasCharacter(TInt)const`

`Address()const`

`Duplicate(TInt)`

`Reset()`

`iFbs`

`iAddressPointer`

`iHandle`

`iServerHandle`