Symbian^3 Application Developer Library >

CBitmapFont Class Reference

class CBitmapFont : public CFont

Bitmap font class. An object of this class may either access and use a bitmap font (a CFontBitmap) or an open font (a COpenFont ). Stored in a CFontStore .

Inherits from

Public Member Functions
IMPORT_C TInt BitmapEncoding ()
IMPORT_C TCharacterMetrics CharacterMetrics ( TInt , const TUint8 *&)
IMPORT_C TBool CharacterNeedsToBeRasterized ( TInt , TInt )
IMPORT_C void DeleteShape ( TInt , TShapeHeader *)
IMPORT_C TBool GetCharacterData ( TInt , TInt , TOpenFontCharMetrics &, const TUint8 *&)
IMPORT_C TBool GetFaceAttrib ( TOpenFontFaceAttrib &)
IMPORT_C void GetFontMetrics ( TOpenFontMetrics &)
TGlyphBitmapType GlyphBitmapType ()
IMPORT_C TBool HasCharacterL ( TInt )
TBool IsOpenFont ()
COpenFont * OpenFont ()
IMPORT_C TBool Rasterize ( TInt , TInt , TOpenFontGlyphData *)
IMPORT_C TShapeHeader * ShapeTextL (const TDesC16 &, TInt , const TShapeMessageParameters &)
TUid Uid ()
IMPORT_C TUint32 UniqueFontId ()
IMPORT_C void operator delete ( TAny *)
Private Member Functions
CBitmapFont ( RHeap *, const TFontSpec &, const TAlgStyle &, CFontBitmap *)
CBitmapFont ( RHeap *, const TFontSpec &, const TAlgStyle &, COpenFont *)
~CBitmapFont ()
void ConstructL ()
IMPORT_C TInt DoAscentInPixels ()
IMPORT_C TInt DoBaselineOffsetInPixels ()
IMPORT_C TInt DoCharWidthInPixels ( TChar )
IMPORT_C TInt DoExtendedFunction ( TUid , TAny *)
IMPORT_C TFontSpec DoFontSpecInTwips ()
IMPORT_C TInt DoHeightInPixels ()
IMPORT_C TInt DoMaxCharWidthInPixels ()
IMPORT_C TInt DoMaxNormalCharWidthInPixels ()
IMPORT_C TInt DoTextCount (const TDesC &, TInt )
IMPORT_C TInt DoTextCount (const TDesC &, TInt , TInt &)
IMPORT_C TInt DoTextWidthInPixels (const TDesC &)
TInt DoTextWidthInPixels (const TDesC &, const TMeasureTextInput *)
IMPORT_C TUid DoTypeUid ()
CFontBitmap * FontBitmap ()
TInt Height ( TInt )
void InstallOpenFontShaper ( COpenFont *, CShaper::TInput &)
CBitmapFont * NewL ( RHeap *, const TFontSpec &, const TAlgStyle &, CFontBitmap *)
CBitmapFont * NewL ( RHeap *, const TFontSpec &, const TAlgStyle &, COpenFont *)
void SetUniqueFontId ( TUint32 )
TInt Width ( TInt )
void operator delete ( TAny *, TAny *)
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()
CFont::AscentInPixels()const
CFont::BaselineOffsetInPixels()const
CFont::CharWidthInPixels(TChar)const
CFont::CharactersJoin(TInt,TInt)
CFont::DescentInPixels()const
CFont::DoGetCharacterData(TUint,TOpenFontCharMetrics &,const TUint8 *&,TSize &)const
CFont::DoGetCharacterPosition(TPositionParam &)const
CFont::ExtendedFunction(TUid,TAny *)const
CFont::FontCapitalAscent()const
CFont::FontLineGap()const
CFont::FontMaxAscent()const
CFont::FontMaxDescent()const
CFont::FontMaxHeight()const
CFont::FontSpecInTwips()const
CFont::FontStandardDescent()const
CFont::GetCharacterData(TUint,TOpenFontCharMetrics &,const TUint8 *&,TSize &)const
CFont::GetCharacterPosition(TPositionParam &)const
CFont::GetCharacterPosition2(TPositionParam &,RShapeInfo &)const
CFont::HeightInPixels()const
CFont::MaxCharWidthInPixels()const
CFont::MaxNormalCharWidthInPixels()const
CFont::MeasureText(const TDesC &,const TMeasureTextInput *,TMeasureTextOutput *)const
CFont::TextCount(const TDesC &,TInt)const
CFont::TextCount(const TDesC &,TInt,TInt &)const
CFont::TextWidthInPixels(const TDesC &)const
CFont::TextWidthInPixels(const TDesC &,const TMeasureTextInput *)const
CFont::TypeUid()const
CFont::WidthZeroInPixels()const
CFont::~CFont()
Inherited Enumerations
CFont:TCharacterDataAvailability
CFont:TTextDirection
Public Attributes
TAlgStyle iAlgStyle
Private Attributes
TInt iFontBitmapOffset
TFontSpec iFontSpecInTwips
RHeap * iHeap
COpenFont * iOpenFont
TUint32 iReserved
TUint32 iUniqueFontId

Constructor & Destructor Documentation

CBitmapFont(RHeap *, const TFontSpec &, const TAlgStyle &, CFontBitmap *)

CBitmapFont ( RHeap * aHeap,
const TFontSpec & aFontSpecInTwips,
const TAlgStyle & aAlgStyle,
CFontBitmap * aFontBitmap
) [private]

Parameters

RHeap * aHeap
const TFontSpec & aFontSpecInTwips
const TAlgStyle & aAlgStyle
CFontBitmap * aFontBitmap

CBitmapFont(RHeap *, const TFontSpec &, const TAlgStyle &, COpenFont *)

CBitmapFont ( RHeap * aHeap,
const TFontSpec & aFontSpecInTwips,
const TAlgStyle & aAlgStyle,
COpenFont * aOpenFont
) [private]

Parameters

RHeap * aHeap
const TFontSpec & aFontSpecInTwips
const TAlgStyle & aAlgStyle
COpenFont * aOpenFont

~CBitmapFont()

~CBitmapFont ( ) [private]

Member Functions Documentation

BitmapEncoding()

IMPORT_C TInt BitmapEncoding ( ) const

CharacterMetrics(TInt, const TUint8 *&)

IMPORT_C TCharacterMetrics CharacterMetrics ( TInt aCode,
const TUint8 *& aBytes
) const

Parameters

TInt aCode
const TUint8 *& aBytes

CharacterNeedsToBeRasterized(TInt, TInt)

IMPORT_C TBool CharacterNeedsToBeRasterized ( TInt aSessionHandle,
TInt aCode
) const

Parameters

TInt aSessionHandle
TInt aCode

ConstructL()

void ConstructL ( ) [private]

DeleteShape(TInt, TShapeHeader *)

IMPORT_C void DeleteShape ( TInt aSessionHandle,
TShapeHeader * aHeader
)

Parameters

TInt aSessionHandle
TShapeHeader * aHeader

DoAscentInPixels()

IMPORT_C TInt DoAscentInPixels ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

DoBaselineOffsetInPixels()

IMPORT_C TInt DoBaselineOffsetInPixels ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

DoCharWidthInPixels(TChar)

IMPORT_C TInt DoCharWidthInPixels ( TChar aChar ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

Parameters

TChar aChar

DoExtendedFunction(TUid, TAny *)

IMPORT_C TInt DoExtendedFunction ( TUid aFunctionId,
TAny * aParam = NULL
) const [private, virtual]

Parameters

TUid aFunctionId
TAny * aParam = NULL

DoFontSpecInTwips()

IMPORT_C TFontSpec DoFontSpecInTwips ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

DoHeightInPixels()

IMPORT_C TInt DoHeightInPixels ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

DoMaxCharWidthInPixels()

IMPORT_C TInt DoMaxCharWidthInPixels ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

DoMaxNormalCharWidthInPixels()

IMPORT_C TInt DoMaxNormalCharWidthInPixels ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

DoTextCount(const TDesC &, TInt)

IMPORT_C TInt DoTextCount ( const TDesC & aText,
TInt aWidthInPixels
) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

Parameters

const TDesC & aText
TInt aWidthInPixels

DoTextCount(const TDesC &, TInt, TInt &)

IMPORT_C TInt DoTextCount ( const TDesC & aText,
TInt aWidthInPixels,
TInt & aExcessWidthInPixels
) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

Parameters

const TDesC & aText
TInt aWidthInPixels
TInt & aExcessWidthInPixels

DoTextWidthInPixels(const TDesC &)

IMPORT_C TInt DoTextWidthInPixels ( const TDesC & aText ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

Parameters

const TDesC & aText

DoTextWidthInPixels(const TDesC &, const TMeasureTextInput *)

TInt DoTextWidthInPixels ( const TDesC & aText,
const TMeasureTextInput * aParam
) const [private]

Parameters

const TDesC & aText
const TMeasureTextInput * aParam

DoTypeUid()

IMPORT_C TUid DoTypeUid ( ) const [private, virtual]

WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. Please see derived class for implementation.

FontBitmap()

CFontBitmap * FontBitmap ( ) const [private]

GetCharacterData(TInt, TInt, TOpenFontCharMetrics &, const TUint8 *&)

IMPORT_C TBool GetCharacterData ( TInt aSessionHandle,
TInt aCode,
TOpenFontCharMetrics & aMetrics,
const TUint8 *& aBitmap
) const

Parameters

TInt aSessionHandle
TInt aCode
TOpenFontCharMetrics & aMetrics
const TUint8 *& aBitmap

GetFaceAttrib(TOpenFontFaceAttrib &)

IMPORT_C TBool GetFaceAttrib ( TOpenFontFaceAttrib & aAttrib ) const

Parameters

TOpenFontFaceAttrib & aAttrib

GetFontMetrics(TOpenFontMetrics &)

IMPORT_C void GetFontMetrics ( TOpenFontMetrics & aMetrics ) const

Parameters

TOpenFontMetrics & aMetrics

GlyphBitmapType()

TGlyphBitmapType GlyphBitmapType ( ) const [inline]

Gets the anti-aliasing setting for the font, see TGlyphBitmapType for the range of values.

This is only applicable to open fonts (COpenFonts) not bitmap fonts (CBitmapFonts).

Note that this setting is stored in the device-independent font specification which is set when the bitmap font object is constructed.

IsOpenFont() TGlyphBitmapType COpenFont CBitmapFont

HasCharacterL(TInt)

IMPORT_C TBool HasCharacterL ( TInt aCode ) const

Parameters

TInt aCode

Height(TInt)

TInt Height ( TInt aNum ) const [private]

Parameters

TInt aNum

InstallOpenFontShaper(COpenFont *, CShaper::TInput &)

void InstallOpenFontShaper ( COpenFont * aOpenFont,
CShaper::TInput & aShaperInput
) [private]

Parameters

COpenFont * aOpenFont
CShaper::TInput & aShaperInput

IsOpenFont()

TBool IsOpenFont ( ) const [inline]

Returns whether the bitmap font object is an open font (a COpenFont ) rather than a bitmap font (a CFontBitmap).

OpenFont()

NewL(RHeap *, const TFontSpec &, const TAlgStyle &, CFontBitmap *)

CBitmapFont * NewL ( RHeap * aHeap,
const TFontSpec & aFontSpecInTwips,
const TAlgStyle & aAlgStyle,
CFontBitmap * aFontBitmap
) [private, static]

Parameters

RHeap * aHeap
const TFontSpec & aFontSpecInTwips
const TAlgStyle & aAlgStyle
CFontBitmap * aFontBitmap

NewL(RHeap *, const TFontSpec &, const TAlgStyle &, COpenFont *)

CBitmapFont * NewL ( RHeap * aHeap,
const TFontSpec & aFontSpecInTwips,
const TAlgStyle & aAlgStyle,
COpenFont * aOpenFont
) [private, static]

Parameters

RHeap * aHeap
const TFontSpec & aFontSpecInTwips
const TAlgStyle & aAlgStyle
COpenFont * aOpenFont

OpenFont()

COpenFont * OpenFont ( ) const [inline]

Returns a pointer to the open font being used by the bitmap font object.

IsOpenFont()

Rasterize(TInt, TInt, TOpenFontGlyphData *)

IMPORT_C TBool Rasterize ( TInt aSessionHandle,
TInt aCode,
TOpenFontGlyphData * aGlyphData
) const

Parameters

TInt aSessionHandle
TInt aCode
TOpenFontGlyphData * aGlyphData

SetUniqueFontId(TUint32)

void SetUniqueFontId ( TUint32 aUniqueFontId ) [private]

Parameters

TUint32 aUniqueFontId

ShapeTextL(const TDesC16 &, TInt, const TShapeMessageParameters &)

IMPORT_C TShapeHeader * ShapeTextL ( const TDesC16 & aText,
TInt aSessionHandle,
const TShapeMessageParameters & aParams
)

Parameters

const TDesC16 & aText
TInt aSessionHandle
const TShapeMessageParameters & aParams

Uid()

TUid Uid ( ) const

UniqueFontId()

IMPORT_C TUint32 UniqueFontId ( )

Width(TInt)

TInt Width ( TInt aNum ) const [private]

Parameters

TInt aNum

operator delete(TAny *)

IMPORT_C void operator delete ( TAny * )

Parameters

TAny *

operator delete(TAny *, TAny *)

void operator delete ( TAny * ,
TAny *
) [private, inline]

Parameters

TAny *
TAny *

Member Data Documentation

TAlgStyle iAlgStyle

TAlgStyle iAlgStyle

The algorithmic font style.

TInt iFontBitmapOffset

TInt iFontBitmapOffset [private]

TFontSpec iFontSpecInTwips

TFontSpec iFontSpecInTwips [private]

RHeap * iHeap

RHeap * iHeap [private]

COpenFont * iOpenFont

COpenFont * iOpenFont [private]

TUint32 iReserved

TUint32 iReserved [private]

TUint32 iUniqueFontId

TUint32 iUniqueFontId [private]

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.