MTmCustom Class Reference

class MTmCustom : public MLineBreaker

The text customization interface. You can customize the colors, word spacing, line breaking, line height calculation, background drawing, and text appearance, of a text object by supplying an implementation of the MTmCustom class, either directly (as in CTmText::CustomizeL, which takes a pointer to MTmCustom) or indirectly, making use of the fact that MTmSource is derived from MTmCustom (as in CTmTextLayout::SetTextL, which takes a reference to MTmSource).

Inherits from

MTmCustom
- MLineBreaker

Nested Classes and Structures

MTmCustom::TLineHeightParam

Public Member Functions
IMPORT_C void	DrawBackground(CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb &, TRect &)
IMPORT_C void	DrawLineGraphics(CGraphicsContext &, const TPoint &, const TRect &, const TTmLineInfo &)
IMPORT_C void	DrawPicture(CGraphicsContext &, const TPoint &, const TRect &, MGraphicsDeviceMap &, const CPicture &)
IMPORT_C void	DrawText(CGraphicsContext &, const TPoint &, const TRect &, const TTmLineInfo &, const TTmCharFormat &, const TDesC &, const TPoint &, TInt)
IMPORT_C TBool	GetLineBreakInContext(const TDesC &, TInt, TInt, TBool, TInt &)
IMPORT_C TBool	IsHangingCharacter(TUint)
IMPORT_C TUint	LineBreakClass(TUint, TUint &, TUint &)
IMPORT_C TBool	LineBreakPossible(TUint, TUint, TBool)
IMPORT_C TUint	Map(TUint)
IMPORT_C void	SetBrushColor(CGraphicsContext &, TLogicalRgb)
IMPORT_C void	SetLineHeight(const TLineHeightParam &, TInt &, TInt &)
IMPORT_C void	SetPenColor(CGraphicsContext &, TLogicalRgb)
IMPORT_C TInt	Stretch(TUint)
IMPORT_C TRgb	SystemColor(TUint, TRgb)
IMPORT_C TRgb	SystemColor(TLogicalRgb)

Inherited Functions
	MLineBreaker::ExtendedInterface(TUid &)const
	MLineBreaker::GetLineBreak(const TDesC16 &,TInt,TInt,TBool,MContingentLineBreaker *,TInt &,TInt &)const
	MLineBreaker::GetLineBreakL(const TDesC16 &,TInt,TInt,TBool,MContingentLineBreakerL *,TInt &,TInt &)const

Public Member Enumerations
enum	anonymous { EOpLineBreakClass, EClLineBreakClass, EQuLineBreakClass, EGlLineBreakClass, ENsLineBreakClass, EExLineBreakClass, ESyLineBreakClass, EIsLineBreakClass, EPrLineBreakClass, EPoLineBreakClass, ENuLineBreakClass, EAlLineBreakClass, EIdLineBreakClass, EInLineBreakClass, EHyLineBreakClass, EBaLineBreakClass, EBbLineBreakClass, EB2LineBreakClass, EZwLineBreakClass, ECmLineBreakClass, EBkLineBreakClass, ECrLineBreakClass, ELfLineBreakClass, ESgLineBreakClass, ECbLineBreakClass, ESpLineBreakClass, ESaLineBreakClass, EAiLineBreakClass, EXxLineBreakClass, ELineBreakClasses }

Public Member Enumerations

enum

anonymous {
EOpLineBreakClass, EClLineBreakClass, EQuLineBreakClass, EGlLineBreakClass, ENsLineBreakClass, EExLineBreakClass, ESyLineBreakClass, EIsLineBreakClass, EPrLineBreakClass, EPoLineBreakClass, ENuLineBreakClass, EAlLineBreakClass, EIdLineBreakClass, EInLineBreakClass, EHyLineBreakClass, EBaLineBreakClass, EBbLineBreakClass, EB2LineBreakClass, EZwLineBreakClass, ECmLineBreakClass, EBkLineBreakClass, ECrLineBreakClass, ELfLineBreakClass, ESgLineBreakClass, ECbLineBreakClass, ESpLineBreakClass, ESaLineBreakClass, EAiLineBreakClass, EXxLineBreakClass, ELineBreakClasses
}

Inherited Enumerations
	MLineBreaker:@126

Member Functions Documentation

DrawBackground(CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb &, TRect &)

IMPORT_C void	DrawBackground	(	CGraphicsContext &	aGc,
			const TPoint &	aTextLayoutTopLeft,
			const TRect &	aRect,
			const TLogicalRgb &	aBackground,
			TRect &	aRectDrawn
		)	const [virtual]

Parameters

CGraphicsContext & aGc
const TPoint & aTextLayoutTopLeft
const TRect & aRect
const TLogicalRgb & aBackground
TRect & aRectDrawn

DrawLineGraphics(CGraphicsContext &, const TPoint &, const TRect &, const TTmLineInfo &)

IMPORT_C void	DrawLineGraphics	(	CGraphicsContext &	aGc,
			const TPoint &	aTextLayoutTopLeft,
			const TRect &	aRect,
			const TTmLineInfo &	aLineInfo
		)	const [virtual]

Parameters

CGraphicsContext & aGc
const TPoint & aTextLayoutTopLeft
const TRect & aRect
const TTmLineInfo & aLineInfo

DrawPicture(CGraphicsContext &, const TPoint &, const TRect &, MGraphicsDeviceMap &, const CPicture &)

IMPORT_C void	DrawPicture	(	CGraphicsContext &	aGc,
			const TPoint &	aTextLayoutTopLeft,
			const TRect &	aRect,
			MGraphicsDeviceMap &	aDevice,
			const CPicture &	aPicture
		)	const [virtual]

Parameters

CGraphicsContext & aGc
const TPoint & aTextLayoutTopLeft
const TRect & aRect
MGraphicsDeviceMap & aDevice
const CPicture & aPicture

DrawText(CGraphicsContext &, const TPoint &, const TRect &, const TTmLineInfo &, const TTmCharFormat &, const TDesC &, const TPoint &, TInt)

IMPORT_C void	DrawText	(	CGraphicsContext &	aGc,
			const TPoint &	aTopLeft,
			const TRect &	aRect,
			const TTmLineInfo &	aLineInfo,
			const TTmCharFormat &	aFormat,
			const TDesC &	aText,
			const TPoint &	aTextOrigin,
			TInt	aExtraPixels
		)	const [virtual]

Parameters

CGraphicsContext & aGc
const TPoint & aTopLeft
const TRect & aRect
const TTmLineInfo & aLineInfo
const TTmCharFormat & aFormat
const TDesC & aText
const TPoint & aTextOrigin
TInt aExtraPixels

GetLineBreakInContext(const TDesC &, TInt, TInt, TBool, TInt &)

IMPORT_C TBool	GetLineBreakInContext	(	const TDesC &	aText,
			TInt	aMinBreakPos,
			TInt	aMaxBreakPos,
			TBool	aForwards,
			TInt &	aBreakPos
		)	const [virtual]

Parameters

const TDesC & aText
TInt aMinBreakPos
TInt aMaxBreakPos
TBool aForwards
TInt & aBreakPos

IsHangingCharacter(TUint)

IMPORT_C TBool

IsHangingCharacter

(

TUint

aChar

)

const [virtual]

Parameters

TUint aChar

LineBreakClass(TUint, TUint &, TUint &)

IMPORT_C TUint	LineBreakClass	(	TUint	aCode,
			TUint &	aRangeStart,
			TUint &	aRangeEnd
		)	const [virtual]

Parameters

TUint aCode
TUint & aRangeStart
TUint & aRangeEnd

LineBreakPossible(TUint, TUint, TBool)

IMPORT_C TBool	LineBreakPossible	(	TUint	aPrevClass,
			TUint	aNextClass,
			TBool	aHaveSpaces
		)	const [virtual]

Parameters

TUint aPrevClass
TUint aNextClass
TBool aHaveSpaces

Map(TUint)

IMPORT_C TUint

Map

(

TUint

aChar

)

const [virtual]

Parameters

TUint aChar

SetBrushColor(CGraphicsContext &, TLogicalRgb)

IMPORT_C void	SetBrushColor	(	CGraphicsContext &	aGc,
			TLogicalRgb	aColor
		)	const

Parameters

CGraphicsContext & aGc
TLogicalRgb aColor

SetLineHeight(const TLineHeightParam &, TInt &, TInt &)

IMPORT_C void	SetLineHeight	(	const TLineHeightParam &	aParam,
			TInt &	aAscent,
			TInt &	aDescent
		)	const [virtual]

Parameters

const TLineHeightParam & aParam
TInt & aAscent
TInt & aDescent

SetPenColor(CGraphicsContext &, TLogicalRgb)

IMPORT_C void	SetPenColor	(	CGraphicsContext &	aGc,
			TLogicalRgb	aColor
		)	const

Parameters

CGraphicsContext & aGc
TLogicalRgb aColor

Stretch(TUint)

IMPORT_C TInt

Stretch

(

TUint

aChar

)

const [virtual]

Parameters

TUint aChar

SystemColor(TUint, TRgb)

IMPORT_C TRgb	SystemColor	(	TUint	aColorIndex,
			TRgb	aDefaultColor
		)	const [virtual]

Parameters

TUint aColorIndex
TRgb aDefaultColor

SystemColor(TLogicalRgb)

IMPORT_C TRgb

SystemColor

(

TLogicalRgb

aColor

)

const

Parameters

TLogicalRgb aColor

Member Enumerations Documentation

Enum anonymous

The Unicode line breaking classes; see Unicode Technical Report 14. Not a named enumerated type, so that overriding applications can add new line breaking classes freely. The description of each constant gives the name of the line-breaking class, an example and a brief, imprecise description of the default behaviour of characters of that class.

Enumerators

EOpLineBreakClass	Opening Punctuation (e.g. '['). Breaking after prohibited.
EClLineBreakClass	Closing Punctuation (e.g. ']'). Breaking before prohibited.
EQuLineBreakClass	Ambiguous Quotes (e.g. '"'). Breaking before and after prohibited.
EGlLineBreakClass	Glue (e.g. Non-breaking space). Breaking before and after prohibited unless spaces are present.
ENsLineBreakClass	Non-Starter (e.g. small Japanese kana). Breaking before prohibited if no spaces present.
EExLineBreakClass	Exclamation or Interrogation (e.g. '?'). Like closing punctuation except before Postfix or Non-starter.
ESyLineBreakClass	Symbol (e.g. '/'. Like Alphabetic, but allows breaking before Alphabetic.
EIsLineBreakClass	Numeric Infix Separator (e.g. ','). Forbids breaking after any and before Numeric.
EPrLineBreakClass	Numeric Prefix (e.g. '$'). Forbids breaking before Numeric.
EPoLineBreakClass	Numeric Postfix (e.g. ''). Forbids breaking after Numeric.
ENuLineBreakClass	Numeric (e.g. '1').
EAlLineBreakClass	Alphabetic (e.g. 'a').
EIdLineBreakClass	Ideographic (e.g. Japanese Kanji). Generally break before or after
EInLineBreakClass	Inseparable (e.g. ellipsis). Forbid breaks between Inseparables.
EHyLineBreakClass	Hyphen (e.g. '-'). Allows a break after except before Numeric.
EBaLineBreakClass	Break After. Generally allow a break after. Breaking between Break Afters not separated by spaces is prohibited.
EBbLineBreakClass	Break Before. Generally allow a break before. Breaking between Break Befores not separated by spaces is prohibited.
EB2LineBreakClass	Break Before and After. Generally allow a break before or after. Breaking between Break Before and Afters is prohibited, even if spaces are present.
EZwLineBreakClass	Zero-Width Space. Allow a break.
ECmLineBreakClass	Combining Mark. Takes on the class of its base class.
EBkLineBreakClass	Mandatory Break.
ECrLineBreakClass	Carriage Return. Break after unless part of a CRLF pair.
ELfLineBreakClass	Line Feed. Break after.
ESgLineBreakClass	Surrogate. Half of a surrogate pair.
ECbLineBreakClass	Contingent Break (e.g. embedded pictures). Uses external information
ESpLineBreakClass	Space. Intervening characters of class Space are indicated by aHaveSpaces in LineBreakPossible.
ESaLineBreakClass	Complex Context (e.g. Thai). Runs of Complex Context are passed to GetLineBreakInContext.
EAiLineBreakClass	Ambiguous. Characters of ambiguous East Asian width are treated as Alphabetic, unless they are resolved as being "Wide", in which case they are treated as Ideographic.
EXxLineBreakClass	The Xx class is used when the class is unknown; e.g.; outside the provided context.
ELineBreakClasses	The number of Unicode line break classes.