Class TFontStyle

class TFontStyle;

Description

Encapsulates a font style.

The font style information is comprised of:

the posture of the font upright or italic

the stroke weight of the font normal or bold

the print position of the font normal, subscript or superscript

Note that the underline and strike-through attributes are not included in this class, but are set in the graphics context.

Members

Defined in TFontStyle:

• BitmapType()constGets the anti-aliasing setting for the font, as set by TFontStyle::SetBitmapType...
• Effects()constGets the font effects flags.
• ExternalizeL(RWriteStream &)constExternalises the font style to a write stream.
• InternalizeL(RReadStream &)Internalises a font style from a read stream.
• Posture()constGets the posture attribute.
• PrintPosition()constGets the print position attribute.
• SetBitmapType(TGlyphBitmapType)Sets whether the font should be drawn using anti-aliasing. If set, this value ov...
• SetEffects(TUint32)Sets the font effects flags.
• SetPosture(TFontPosture)Sets the posture attribute.
• SetPrintPosition(TFontPrintPosition)Sets the print position attribute.
• SetStrokeWeight(TFontStrokeWeight)Sets the stroke weight attribute.
• StrokeWeight()constGets the stroke weight attribute.
• TFontStyle()Default C++ constructor.
• TFontStyle(TFontPosture,TFontStrokeWeight,TFontPrintPosition)Constructs a TFontStyle object with the specified attributes.
• operator==(const TFontStyle &)constCompares a font style for equality.

See also:

• CGraphicsContext::SetUnderlineStyle(TFontUnderline)Sets the underline style.
• CGraphicsContext::SetStrikethroughStyle(TFontStrikethrough)Sets the strikethrough style.

IMPORT_C TFontStyle();

Description

Default C++ constructor.

IMPORT_C TFontStyle(TFontPosture aPost, TFontStrokeWeight aStrWgt, TFontPrintPosition aPrintPos);

Description

Constructs a TFontStyle object with the specified attributes.

Parameters

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a font style from a read stream.

The presence of this function means that the standard templated operator>>(RReadStream &,T &) (defined in s32strm.h) is available to internalise objects of this class.

Parameters

Leave codes

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the font style to a write stream.

The presence of this function means that the standard templated operator<<(RWriteStream &,const T &) (defined in s32strm.h) is available to externalise objects of this class.

Parameters

Leave codes

IMPORT_C TFontPosture Posture() const;

Description

Gets the posture attribute.

Return value

IMPORT_C TFontStrokeWeight StrokeWeight() const;

Description

Gets the stroke weight attribute.

Return value

IMPORT_C TFontPrintPosition PrintPosition() const;

Description

Gets the print position attribute.

Return value

IMPORT_C void SetPosture(TFontPosture aPosture);

Description

Sets the posture attribute.

Parameters

IMPORT_C void SetStrokeWeight(TFontStrokeWeight aStrokeWeight);

Description

Sets the stroke weight attribute.

Parameters

IMPORT_C void SetPrintPosition(TFontPrintPosition aPrintPosition);

Description

Sets the print position attribute.

Parameters

inline TGlyphBitmapType BitmapType() const;

Description

Gets the anti-aliasing setting for the font, as set by TFontStyle::SetBitmapType(TGlyphBitmapType).

Return value

inline void SetBitmapType(TGlyphBitmapType aBitmapType);

Description

Sets whether the font should be drawn using anti-aliasing. If set, this value overrides the default setting (set by CFbsTypefaceStore::SetDefaultBitmapType()) for this font.

Anti-aliasing can only be used for scalable fonts. There is currently no anti-aliasing support for bitmapped fonts.

Parameters

IMPORT_C TBool operator==(const TFontStyle &aFontStyle) const;

Description

Compares a font style for equality.

Parameters

Return value

IMPORT_C TUint32 Effects() const;

Description

Gets the font effects flags.

Return value

See also:

• TFontStyle::SetEffects(TUint32)Sets the font effects flags.

IMPORT_C TBool IsEffectOn(FontEffect::TEffect aEffect) const;

Description

Checks if a font effect is on.

Parameters

Return value

See also:

• TFontStyle::SetEffects(TUint32)Sets the font effects flags.

IMPORT_C void SetEffects(TUint32 aEffects);

Description

Sets the font effects flags.

Parameters

See also:

• TFontStyle::Effects()constGets the font effects flags.

IMPORT_C void SetEffects(FontEffect::TEffect aEffect, TBool aOn);

Description

Sets a font effect to the given state.

Parameters

See also:

• TFontStyle::IsEffectOn(FontEffect::TEffect)constChecks if a font effect is on.