TTmCharFormat Class Reference

#include <tagma.h>

class TTmCharFormat
Public Attributes
TLogicalRgb iBackgroundColor
TUint iEffects
TOpenFontSpec iFontSpec
TUint iLanguage
TPictureAlignment iPictureAlignment
TUint iTag
TLogicalRgb iTextColor
Public Member Enumerations
enumanonymous { EBackground, ERounded, EUnderline, EStrikethrough, ..., ECustomDrawEffectIsExternallyDefined }
enumTPictureAlignment { EPictureAlignBaseline, EPictureAlignTop, EPictureAlignBottom, EPictureAlignCenter }
Public Member Functions
TTmCharFormat()
TTmCharFormat(const TDesC &, TInt)
TTmCharFormat(const TCharFormat &)
IMPORT_C voidGetTCharFormat(TCharFormat &)
TBool operator!=(const TTmCharFormat &)
IMPORT_C voidoperator=(const TCharFormat &)
IMPORT_C TBooloperator==(const TTmCharFormat &)

Detailed Description

A character format; all dimensions are in twips. A character format object stores all text style attributes that can differ from any one character to the next. Attributes that affect an entire paragraph only are kept in RTmParFormat objects. The class should only be used internally by FORM component.

Member Attribute Documentation

iBackgroundColor

TLogicalRgb iBackgroundColor

iEffects

TUint iEffects

iFontSpec

TOpenFontSpec iFontSpec

iLanguage

TUint iLanguage

iPictureAlignment

TPictureAlignment iPictureAlignment

iTag

TUint iTag

iTextColor

TLogicalRgb iTextColor

Member Enumeration Documentation

Enum anonymous

Bit assignments for effects

EnumeratorValueDescription
EBackground1Text background is drawn in the background colour.
ERounded2Text background (if any) has rounded corners.
EUnderline4Text is underlined.
EStrikethrough8Text is struck through with a horizontal line.
EShadow16Text has a drop shadow.
EUserDefinedMask0xFF000000

Bits 24-31 are reserved for styles defined by the custom drawer.

EUserDefinedShift24

Shift TCharFormat highlight styles left by this to get the TTmCharFormat effects portion.

ENoMatchesIndicator0x4000000

For custom drawers: draw whatever is wanted for "no matches" in the FEP.

ECustomDrawEffectIsExternallyDefined0x80000000

Reset if the effect in bits 24-30 is defined defined by Symbian, set if it is defined externally.

Enum TPictureAlignment

Constructor & Destructor Documentation

TTmCharFormat ( )

IMPORT_CTTmCharFormat()

TTmCharFormat ( const TDesC &, TInt )

IMPORT_CTTmCharFormat(const TDesC &aFontName,
TIntaFontHeight
)

TTmCharFormat ( const TCharFormat & )

TTmCharFormat(const TCharFormat &aFormat)[inline]

Constructs a TTmCharFormat by converting the information in a TCharFormat.

Member Function Documentation

GetTCharFormat ( TCharFormat & )

IMPORT_C voidGetTCharFormat(TCharFormat &aFormat)const

operator!= ( const TTmCharFormat & )

TBool operator!=(const TTmCharFormat &aFormat)const [inline]

The inequality operator. Return TRUE if this object and aFormat differ in any way.

operator= ( const TCharFormat & )

IMPORT_C voidoperator=(const TCharFormat &aFormat)

operator== ( const TTmCharFormat & )

IMPORT_C TBooloperator==(const TTmCharFormat &aFormat)const