MFormatText Class Reference

class MFormatText

Specifies the mixin protocol for getting and setting character and paragraph format attributes.

It is inherited by classes which support character and paragraph formatting, e.g. CRichText and CGlobalText. Its purpose is to allow developers to apply and retrieve formatting without needing to know which type of editable text is involved.

All functions defined in this class use a document position and a length. These values are only relevant to rich text. In general, they must be valid (i.e. the range must not extend beyond the bounds of the document), or a panic occurs. In global text, formatting is applied globally, so that the length and position values are ignored.

Public Member Functions
void	ApplyCharFormatL(const TCharFormat &, const TCharFormatMask &, TInt, TInt)
void	ApplyParaFormatL(const CParaFormat *, const TParaFormatMask &, TInt, TInt)
void	GetCharFormat(TCharFormat &, TCharFormatMask &, TInt, TInt)
void	GetParaFormatL(CParaFormat *, TParaFormatMask &, TInt, TInt, CParaFormat::TParaFormatGetMode)

Member Functions Documentation

ApplyCharFormatL(const TCharFormat &, const TCharFormatMask &, TInt, TInt)

void	ApplyCharFormatL	(	const TCharFormat &	aFormat,
			const TCharFormatMask &	aMask,
			TInt	aPos,
			TInt	aLength
		)	[pure virtual]

Applies character formatting to a range of characters. The attributes which are set in the mask are taken from aFormat and applied. The attributes which are not set in the mask are not applied.

Parameters

const TCharFormat & aFormat	Contains the character format attribute values to apply.
const TCharFormatMask & aMask	Bitmask specifying which character format attributes should be applied.
TInt aPos	Document position from which to apply the new character formatting.
TInt aLength	The number of characters to which the new formatting should be applied.

ApplyParaFormatL(const CParaFormat *, const TParaFormatMask &, TInt, TInt)

void	ApplyParaFormatL	(	const CParaFormat *	aFormat,
			const TParaFormatMask &	aMask,
			TInt	aPos,
			TInt	aLength
		)	[pure virtual]

Applies paragraph formatting to a range of paragraphs. The attributes which are set in the mask are taken from aFormat and applied. The attributes which are not set in the mask are not applied.

Parameters

const CParaFormat * aFormat	Contains the paragraph format attribute values to apply.
const TParaFormatMask & aMask	Specifies which paragraph format attributes should be applied.
TInt aPos	The document position of the start of the range.
TInt aLength	The number of characters in the range.

GetCharFormat(TCharFormat &, TCharFormatMask &, TInt, TInt)

void	GetCharFormat	(	TCharFormat &	aFormat,
			TCharFormatMask &	aVaries,
			TInt	aPos,
			TInt	aLength
		)	const [pure virtual]

Gets the effective character formatting which applies to a range of characters. Also gets a bit mask which indicates which values change over the region, and whose value is therefore indeterminate.

Parameters

TCharFormat & aFormat	On return, contains the character format values for the range of characters. For global text, this is the character formatting of the entire text object.
TCharFormatMask & aVaries	On return, indicates which character format attributes vary over the range and whose values are therefore indeterminate. For global text, this mask contains a value of zero for every attribute because formatting is applied globally.
TInt aPos	The document position of the start of the range.
TInt aLength	The number of characters in the range.

GetParaFormatL(CParaFormat *, TParaFormatMask &, TInt, TInt, CParaFormat::TParaFormatGetMode)

void	GetParaFormatL	(	CParaFormat *	aFormat,
			TParaFormatMask &	aVaries,
			TInt	aPos,
			TInt	aLength,
			CParaFormat::TParaFormatGetMode	aMode = CParaFormat::EAllAttributes
		)	const [pure virtual]

Gets the effective paragraph formatting which applies to a range of paragraphs. Also gets a bit mask which indicates which values change over the region, and whose value is therefore indeterminate.

Parameters

CParaFormat * aFormat	On return, contains the effective paragraph formatting for the range of paragraphs. For global text, this is the paragraph formatting of the entire text object.
TParaFormatMask & aVaries	On return, a bitmask indicating which paragraph format attributes vary over the range of characters selected. For global text, this mask contains a value of zero for every attribute because formatting is applied globally.
TInt aPos	The document position of the start of the range.
TInt aLength	The number of characters in the range.
CParaFormat::TParaFormatGetMode aMode = CParaFormat::EAllAttributes	The default, EAllAttributes means that values for all paragraph format attributes are written to aFormat. EFixedAttributes means that tabs, bullets and borders are not written to aFormat.