Collapse all Symbian^3 Application Developer Library

CCoeTextDrawerBase Class Reference

class CCoeTextDrawerBase : public CBase

This is the base class for all text drawers implementing different text effects (for example shadow or glowing/outlined text). The object can be created and deleted each time it's used, or Reset() and reused if it IsReusable() . The latter is recommended.

Note that the pure virtual DrawText() method is private. This ensures that the object is used through the XCoeTextDrawer class (which manages its life).

Note also that the accessor and set methods should be used via the owning XCoeTextDrawer object, and that the MObjectProvider mechanism can be used to identify the actual text drawer implementation.

Inherits from

CCoeTextDrawerBase
- CBase

Public Member Functions
	~CCoeTextDrawerBase ()
IMPORT_C TGulAlignment	Alignment ()
IMPORT_C TMargins8	EffectMargins ()
IMPORT_C TBool	IsReusable ()
IMPORT_C TInt	LineGapInPixels ()
IMPORT_C TMargins8	Margins ()
IMPORT_C void	Reset ()
IMPORT_C void	SetAlignment (const TGulAlignment &)
IMPORT_C void	SetAppLanguage ( TLanguage )
IMPORT_C void	SetLineGapInPixels ( TInt )
IMPORT_C void	SetMargins (const TMargins8 &)
IMPORT_C void	SetReusable ( TBool )
void	SetTextColor ( TRgb )
TRgb	TextColor ()

Protected Member Functions
	CCoeTextDrawerBase ()
IMPORT_C TGulHAlignment	ActualHorizontalAlignment (const TCoeTextTypeAdaptor &)
IMPORT_C TInt	Construct ()

Private Member Functions
IMPORT_C void	CCoeTextDrawerBase_Reserved10 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved3 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved4 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved5 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved6 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved7 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved8 ()
IMPORT_C void	CCoeTextDrawerBase_Reserved9 ()
void	DrawText ( CGraphicsContext &, const TCoeTextTypeAdaptor &, const CFont &, const TRect &, const TRect &)
IMPORT_C void	DrawTextVertical ( CGraphicsContext &, const TCoeTextTypeAdaptor &, const CFont &, const TRect &, const TRect &, TBool )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TGulAlignment	iAlignment
CCoeTextDrawerBaseExt *	iExtension
TBool	iIsReusable
TInt	iLineGap
TMargins8	iMargins

Constructor & Destructor Documentation

CCoeTextDrawerBase()

IMPORT_C

CCoeTextDrawerBase

(

)

[protected]

Constructor.

~CCoeTextDrawerBase()

IMPORT_C

~CCoeTextDrawerBase

(

)

Destructor.

Member Functions Documentation

ActualHorizontalAlignment(const TCoeTextTypeAdaptor &)

IMPORT_C TGulHAlignment

ActualHorizontalAlignment

(

const TCoeTextTypeAdaptor &

aText

)

const [protected]

This method returns the actual (absolute) horizontal text alignment to be used when drawing text in any CCoeTextDrawerBase-derived DrawText() implementation. The actual alignment depends on the application language directionality if the application language has been set calling CCoeTextDrawerBase::SetAppLanguage() , or otherwise on the directionality of the actual text being printed. If the directionality is right-to-left (and the horizontal alignment has not been set to be absolute, using TGulAlignment::SetAbsoluteHAlignment() ), left and right alignment (set using XCoeTextDrawer::SetAlignment() ) will be swapped.

Parameters

const TCoeTextTypeAdaptor & aText

Alignment()

IMPORT_C TGulAlignment

Alignment

(

)

const

Returns the text alignment that will be used by DrawText() and DrawDisplayOrderedText(). Note that left and right alignment will be swapped for right-to-left scripts, unless the alignment has been set to be absolute (see TGulAlignment ).

A typical user of the text drawer mechanism will use the XCoeTextDrawer version of this API.

CCoeTextDrawerBase_Reserved10()

IMPORT_C void

CCoeTextDrawerBase_Reserved10

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved3()

IMPORT_C void

CCoeTextDrawerBase_Reserved3

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved4()

IMPORT_C void

CCoeTextDrawerBase_Reserved4

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved5()

IMPORT_C void

CCoeTextDrawerBase_Reserved5

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved6()

IMPORT_C void

CCoeTextDrawerBase_Reserved6

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved7()

IMPORT_C void

CCoeTextDrawerBase_Reserved7

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved8()

IMPORT_C void

CCoeTextDrawerBase_Reserved8

(

)

[private, virtual]

CCoeTextDrawerBase_Reserved9()

IMPORT_C void

CCoeTextDrawerBase_Reserved9

(

)

[private, virtual]

Construct()

IMPORT_C TInt

Construct

(

)

[protected]

Second phase object construction. Note that this method is non-leaving as it may be called indirectly from a Draw() method, which must not leave.

DrawText(CGraphicsContext &, const TCoeTextTypeAdaptor &, const CFont &, const TRect &, const TRect &)

void	DrawText	(	CGraphicsContext &	aGc,
			const TCoeTextTypeAdaptor &	aText,
			const CFont &	aFont,
			const TRect &	aTextRect,
			const TRect &	aClipRect
		)	const [private, pure virtual]

Any actual text drawer must implement this method to draw the text passed as argument. The implementation must draw the text inside the text rectangle, cropped to the clipping rectangle, and with the given margins and alignment taken into account.

Note that the actual horizontal alignment shall depend on the script directionality. Calling ActualHorizontalAlignment() will return the horizontal alignment where left and right has been swapped for right-to-left scripts.

Parameters

CGraphicsContext & aGc
const TCoeTextTypeAdaptor & aText
const CFont & aFont
const TRect & aTextRect
const TRect & aClipRect

DrawTextVertical(CGraphicsContext &, const TCoeTextTypeAdaptor &, const CFont &, const TRect &, const TRect &, TBool)

IMPORT_C void	DrawTextVertical	(	CGraphicsContext &	aGc,
			const TCoeTextTypeAdaptor &	aText,
			const CFont &	aFont,
			const TRect &	aTextRect,
			const TRect &	aClipRect,
			TBool	aUp
		)	const [private, virtual]

Draws the text vertically inside the text rectangle, cropped to the clipping rectangle, and with the given margins and alignment taken into account. If aUp is ETrue, text is rotated 90 degrees anti-clockwise; EFalse, text is rotated 90 degrees clockwise.

Draws the vertical text provided as parameter.

Parameters

CGraphicsContext & aGc	The graphics context.
const TCoeTextTypeAdaptor & aText	The TCoeTextTypeAdaptor text object to draw.
const CFont & aFont	Font to be used for drawing the text.
const TRect & aTextRect	The rectangle to draw the text in.
const TRect & aClipRect	The clipping rectangle.
TBool aUp	ETrue, text is rotated 90 degrees anti-clockwise; EFalse, text is rotated 90 degrees clockwise.

EffectMargins()

IMPORT_C TMargins8

EffectMargins

(

)

[virtual]

Any text drawer implementation must override this method, returning the "margins" that the text effect will add to the text extent. I.e. a one-pixel drop-shadow to the lower right will add an effect margin of TMargins8(0,0,1,1), while a one-pixel all-around outline will add an effect margin of TMargins8(1,1,1,1).

IsReusable()

IMPORT_C TBool

IsReusable

(

)

const

Returns whether the CCoeTextDrawerBase-derived text drawer object has been set to be reusable or not. If reusable, the text drawer is assumed to have an owner that will delete it when appropriate. If not reusable, the XCoeTextDrawer will delete it in its destructor.

LineGapInPixels()

IMPORT_C TInt

LineGapInPixels

(

)

const

Returns the gap (in pixels) between lines of text. Default gap is 1 (one) pixel.

A typical user of the text drawer mechanism will use the XCoeTextDrawer version of this API.

Margins()

IMPORT_C TMargins8

Margins

(

)

const

Returns the text margins that will be used by DrawText() and DrawDisplayOrderedText().

A typical user of the text drawer mechanism will use the XCoeTextDrawer version of this API.

Reset()

IMPORT_C void

Reset

(

)

[virtual]

This method is called from the destructor of the XCoeTextDrawer object managing the life of the CCoeTextDrawerBase object, if the CCoeTextDrawerBase object has been set to be reusable (by its owner calling SetReusable() ).

Any derived class must override this method to reset its drawing parameters to their defaults, so that the object is ready to be used again. Any overriding implementation must call the base implementation as well.

SetAlignment(const TGulAlignment &)

IMPORT_C void

SetAlignment

(

const TGulAlignment &

aAlignment

)

Set the text alignment that will be used by DrawText() and DrawDisplayOrderedText(). Note that left and right alignment will be swapped for right-to-left scripts, unless the alignment has been set to be absolute (see TGulAlignment ).

A typical user of the text drawer mechanism will use the XCoeTextDrawer version of this API.

Parameters

const TGulAlignment & aAlignment

TGulAlignment value.

SetAppLanguage(TLanguage)

IMPORT_C void

SetAppLanguage

(

TLanguage

aAppLang

)

Unless absolute horizontal aligment has been selected (see TGulAlignment ), the actual horizontal text alignment used when drawing text depends on whether the directionality of the scrip is left-to-right or right-to-left. In the latter case left and right is swapped. By default, the directionality of the actual text being drawn will define whether the horizontal alignment will be swapped or not. However, if (as recommended) the directionality of the application's main language shall be considered instead (rather than the directionality of the text being printed at the moment), then call this method.

If ELangNone is specified, the text drawer will be reset to swap horizontal alignment depending on the directionality of the text being printed.

Parameters

TLanguage aAppLang

The application language (e.g. from CEikonEnv::ApplicationLanguage()).

SetLineGapInPixels(TInt)

IMPORT_C void

SetLineGapInPixels

(

TInt

aLineGapInPixels

)

Set the gap (in pixels) between lines of text. Default gap is 1 (one) pixel.

A typical user of the text drawer mechanism will use the XCoeTextDrawer version of this API.

Parameters

TInt aLineGapInPixels

The gap between lines of text, in pixels.

SetMargins(const TMargins8 &)

IMPORT_C void

SetMargins

(

const TMargins8 &

aMargins

)

Set the text margins that will be used by DrawText() and DrawDisplayOrderedText().

A typical user of the text drawer mechanism will use the XCoeTextDrawer version of this API.

Parameters

const TMargins8 & aMargins

The margins between the text rect and the actual text, in pixels.

SetReusable(TBool)

IMPORT_C void

SetReusable

(

TBool

aIsReusable

)

Set whether the text drawer is reusable or not. A reusable text drawer will be reset (through a call to Reset() ) rather than deleted when the XCoeTextDrawer referring to it is deleted. This decision has to be made by the creator of the CCoeTextDrawerBase object. I.e. this method must not be called by a mere user of the XCoeTextDrawer .

Parameters

TBool aIsReusable

Boolean indicating whether the text drawer can be re-used.

SetTextColor(TRgb)

void

SetTextColor

(

TRgb

aColor

)

[pure virtual]

This method sets the main color to use to draw text.

Parameters

TRgb aColor

The color to use to draw text.

TextColor()

TRgb

TextColor

(

)

const [pure virtual]

This method returns the main color used by the CCoeTextDrawer to draw text.

Member Data Documentation

TGulAlignment iAlignment

TGulAlignment

iAlignment

[private]

CCoeTextDrawerBaseExt * iExtension

CCoeTextDrawerBaseExt *

iExtension

[private]

TBool iIsReusable

TBool

iIsReusable

[private]

TInt iLineGap

TInt

iLineGap

[private]

TMargins8 iMargins

TMargins8

iMargins

[private]