Class TFontPresentation

class TFontPresentation;

Description

Specifies the font-independent character format attributes, including bold, italics and underlining.

An instance of this class is owned by the character formatting container (class TCharFormat).

Members

Defined in TFontPresentation:
EAlignBaseLine, EAlignBottom, EAlignCentered, EAlignTop, EFontHighlightFirstCustomStyle, EFontHighlightLastCustomStyle, EFontHighlightNoMatchesIndicator, EFontHighlightNone, EFontHighlightNormal, EFontHighlightRounded, EFontHighlightShadow, IsEqual(), TAlignment, TFontHighlightStyle, TFontPresentation(), iHiddenText, iHighlightColor, iHighlightStyle, iPictureAlignment, iStrikethrough, iTextColor, iUnderline

IMPORT_C TFontPresentation();

Description

The default C++ constructor constructs a TFontPresentation object, initializing all member data to default values. For details of these values, see the table below.

IMPORT_C TBool IsEqual(const TFontPresentation &aFontPresentation, const TCharFormatMask &aMask) const;

Description

Compares selected attribute values for equality. Only the attributes specified in the mask are involved in the comparison.

Parameters

const TFontPresentation &aFontPresentation Contains the attribute values to compare. const TCharFormatMask &aMask Bitmask specifying the attributes involved in the comparison.

Return value

TBool ETrue if the two objects have the same values for the attributes specified in the mask, EFalse if not.

TFontHighlightStyle

Description

Highlight style

EFontHighlightNone No highlighting used. EFontHighlightNormal Normal (square cornered) highlighting used. EFontHighlightRounded Rounded corner highlighting used. EFontHighlightShadow Text is drawn offset towards the bottom-right in the highlight colour, (iHighlightColor) before being drawn again in the text colour, (iTextColor) creating a shadow effect. EFontHighlightNoMatchesIndicator Placeholder for "unrecognised word" highlighting style for FEPs EFontHighlightFirstCustomStyle First custom highlighting style is used. EFontHighlightLastCustomStyle Second custom highlighting style is used.

TAlignment

Description

Vertical picture alignment

EAlignTop The top of the picture is aligned flush with the top of the font's ascent, so that the picture may descend below the line. EAlignBottom The bottom of the picture is aligned flush with the bottom of the font's descent so that the picture may extend above the line. EAlignCentered The picture is aligned so that its centre is positioned at the baseline of the line. EAlignBaseLine The bottom of the picture is aligned with the baseline of the font. This is the default.

TLogicalRgb iTextColor;

Description

The text colour. By default, the default system foreground colour.

TLogicalRgb iHighlightColor;

Description

The highlight colour for selected text. Only takes effect if iHighlightStyle is not EFontHighlightNone. By default, the default system foreground colour.

TFontHighlightStyle iHighlightStyle;

Description

Style for character highlighting. By default EFontHighlightNone.

TFontStrikethrough iStrikethrough;

Description

The value of the strikethrough attribute. By default EStrikethroughOff.

TFontUnderline iUnderline;

Description

The value of the underline attribute. By default EUnderlineOff.

TBool iHiddenText;

Description

Specifies whether or not text is hidden. Note that hidden text is not currently supported by the text layout engine. This attribute is provided to preserve information when copying from and to devices which support hidden text. By default EFalse.

TAlignment iPictureAlignment;

Description

The vertical alignment of a picture character. By default EAlignBaseLine.