TFontPresentation Class Reference

#include <txtfrmat.h>

Link against: etext.lib

class TFontPresentation

Public Attributes
TBool	iHiddenText
TLogicalRgb	iHighlightColor
TFontHighlightStyle	iHighlightStyle
TAlignment	iPictureAlignment
TFontStrikethrough	iStrikethrough
TLogicalRgb	iTextColor
TFontUnderline	iUnderline

Public Member Enumerations
enum	TAlignment { EAlignTop, EAlignBottom, EAlignCentered, EAlignBaseLine }
enum	TFontHighlightStyle { EFontHighlightNone, EFontHighlightNormal, EFontHighlightRounded, EFontHighlightShadow, ..., EFontHighlightLastCustomStyle }

Public Member Functions
	TFontPresentation()
IMPORT_C TBool	IsEqual(const TFontPresentation &, const TCharFormatMask &)

Detailed 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).

Member Attribute Documentation

iHiddenText

TBool

iHiddenText

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.

iHighlightColor

TLogicalRgb

iHighlightColor

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

iHighlightStyle

TFontHighlightStyle

iHighlightStyle

Style for character highlighting. By default EFontHighlightNone.

iPictureAlignment

TAlignment

iPictureAlignment

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

iStrikethrough

TFontStrikethrough

iStrikethrough

The value of the strikethrough attribute. By default EStrikethroughOff.

iTextColor

TLogicalRgb

iTextColor

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

iUnderline

TFontUnderline

iUnderline

The value of the underline attribute. By default EUnderlineOff.

Member Enumeration Documentation

Enum TAlignment

Vertical picture alignment

Enumerator	Value	Description
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.

Enum TFontHighlightStyle

Highlight style

Enumerator	Value	Description
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	128	First custom highlighting style is used. See also: MFormCustomDraw::DrawText().
EFontHighlightLastCustomStyle	255	Second custom highlighting style is used. See also: MFormCustomDraw::DrawText().

Constructor & Destructor Documentation

TFontPresentation ( )

IMPORT_C

TFontPresentation

(

)

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

Member Function Documentation

IsEqual ( const TFontPresentation &, const TCharFormatMask & )

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

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

Parameter	Description
aFontPresentation	Contains the attribute values to compare.
aMask	Bitmask specifying the attributes involved in the comparison.

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