Collapse all Symbian^3 Product Developer Library

TCharFormat Class Reference

class TCharFormat

A transient container of character format attributes, including font-dependent and font-independent attributes.

The font-independent attributes are stored in a TFontPresentation object. Rich and global text objects store character formatting using character format layers (see class CCharFormatLayer). The TCharFormat class is used to store the relevant attribute values when setting or sensing a CCharFormatLayer. It is normally used in combination with a TCharFormatMask, to specify which attributes are relevant to the function concerned.

Public Member Functions
	TCharFormat()
	TCharFormat(const TDesC &, TInt)
IMPORT_C TBool	IsEqual(const TCharFormat &, const TCharFormatMask &)
IMPORT_C TBool	IsEqual(const TCharFormat &)

Public Attributes
TFontPresentation	iFontPresentation
TFontSpec	iFontSpec
TInt32	iLanguage

Constructor & Destructor Documentation

TCharFormat()

IMPORT_C

TCharFormat

(

)

Allocates and constructs a TCharFormat object. The font-independent attributes are initialised with default values. The language is initialised to zero. The font (iFontSpec) is set to be proportional and serif and to have a height of 200 twips. The typeface name is not initialised.

TCharFormat(const TDesC &, TInt)

IMPORT_C	TCharFormat	(	const TDesC &	aTypefaceName,
			TInt	aHeight
		)

Parameters

const TDesC & aTypefaceName
TInt aHeight

Member Functions Documentation

IsEqual(const TCharFormat &, const TCharFormatMask &)

IMPORT_C TBool	IsEqual	(	const TCharFormat &	aFormat,
			const TCharFormatMask &	aMask
		)	const

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

Parameters

const TCharFormat & aFormat	Contains the attribute values to compare.
const TCharFormatMask & aMask	Bitmask specifying the attributes to compare.

IsEqual(const TCharFormat &)

IMPORT_C TBool

IsEqual

(

const TCharFormat &

aFormat

)

const

Parameters

const TCharFormat & aFormat

Member Data Documentation

TFontPresentation iFontPresentation

TFontPresentation

iFontPresentation

Font independent character format attributes.

TFontSpec iFontSpec

TFontSpec

iFontSpec

Device independent font specification.

TInt32 iLanguage

TInt32

iLanguage

Specifies the language of individual characters for proofing. Used for example when spell checking a document which contains text in more than one language, so that the program recognises the text as being in another language. Language is also a paragraph format attribute. If the language setting of a character is different from the language setting of the containing paragraph, the character's setting takes precedence.