Collapse all Symbian^3 Application Developer Library

TTmCharFormat Class Reference

class TTmCharFormat

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.

Public Member Functions
	TTmCharFormat ()
	TTmCharFormat (const TDesC &, TInt )
	TTmCharFormat (const TCharFormat &)
IMPORT_C void	GetTCharFormat ( TCharFormat &)
TBool	operator!= (const TTmCharFormat &)
IMPORT_C void	operator= (const TCharFormat &)
IMPORT_C TBool	operator== (const TTmCharFormat &)

Public Member Enumerations
enum	anonymous { EBackground = 1, ERounded = 2, EUnderline = 4, EStrikethrough = 8, EShadow = 16, EUserDefinedMask = 0xFF000000, EUserDefinedShift = 24, ENoMatchesIndicator = 0x4000000, ECustomDrawEffectIsExternallyDefined = 0x80000000 }
enum	TPictureAlignment { EPictureAlignBaseline , EPictureAlignTop , EPictureAlignBottom , EPictureAlignCenter }

Public Attributes
TLogicalRgb	iBackgroundColor
TUint	iEffects
TOpenFontSpec	iFontSpec
TUint	iLanguage
TPictureAlignment	iPictureAlignment
TUint	iTag
TLogicalRgb	iTextColor

Constructor & Destructor Documentation

TTmCharFormat()

IMPORT_C

TTmCharFormat

(

)

TTmCharFormat(const TDesC &, TInt)

IMPORT_C	TTmCharFormat	(	const TDesC &	aFontName,
			TInt	aFontHeight
		)

Parameters

const TDesC & aFontName
TInt aFontHeight

TTmCharFormat(const TCharFormat &)

TTmCharFormat

(

const TCharFormat &

aFormat

)

[inline]

Constructs a TTmCharFormat by converting the information in a TCharFormat .

Parameters

const TCharFormat & aFormat

Member Functions Documentation

GetTCharFormat(TCharFormat &)

IMPORT_C void

GetTCharFormat

(

TCharFormat &

aFormat

)

const

Parameters

TCharFormat & aFormat

operator!=(const TTmCharFormat &)

TBool

operator!=

(

const TTmCharFormat &

aFormat

)

const [inline]

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

Parameters

const TTmCharFormat & aFormat

operator=(const TCharFormat &)

IMPORT_C void

operator=

(

const TCharFormat &

aFormat

)

Parameters

const TCharFormat & aFormat

operator==(const TTmCharFormat &)

IMPORT_C TBool

operator==

(

const TTmCharFormat &

aFormat

)

const

Parameters

const TTmCharFormat & aFormat

Member Enumerations Documentation

Enum anonymous

Bit assignments for effects

Enumerators

EBackground = 1
ERounded = 2
EUnderline = 4
EStrikethrough = 8
EShadow = 16
EUserDefinedMask = 0xFF000000	Bits 24-31 are reserved for styles defined by the custom drawer.
EUserDefinedShift = 24	Shift TCharFormat highlight styles left by this to get the TTmCharFormat effects portion.
ENoMatchesIndicator = 0x4000000	For custom drawers: draw whatever is wanted for "no matches" in the FEP.
ECustomDrawEffectIsExternallyDefined = 0x80000000	Reset if the effect in bits 24-30 is defined defined by Symbian, set if it is defined externally.