Collapse all Symbian^3 Product Developer Library

CCoePlainTextDrawer Class Reference

class CCoePlainTextDrawer : public CCoeTextDrawerBase

This is a basic text drawer without any text effects. The default text drawer that can be used if no other (device specific) text drawers has been added to the system.

Inherits from

CCoePlainTextDrawer
- CCoeTextDrawerBase
  - CBase

Public Member Functions
IMPORT_C CCoePlainTextDrawer *	New(TRgb)
IMPORT_C void	SetTextColor(TRgb)
IMPORT_C TRgb	TextColor()

Protected Member Functions
IMPORT_C TTypeUid::Ptr	MopSupplyObject(TTypeUid)

Private Member Functions
	CCoePlainTextDrawer(TRgb)
TInt	Construct()
void	DrawText(CGraphicsContext &, const TCoeTextTypeAdaptor &, const CFont &, const TRect &, const TRect &)
void	Reset()

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()
	CCoeTextDrawerBase::ActualHorizontalAlignment(const TCoeTextTypeAdaptor &)const
	CCoeTextDrawerBase::Alignment()const
	CCoeTextDrawerBase::CCoeTextDrawerBase()
	CCoeTextDrawerBase::EffectMargins()
	CCoeTextDrawerBase::IsReusable()const
	CCoeTextDrawerBase::LineGapInPixels()const
	CCoeTextDrawerBase::Margins()const
	CCoeTextDrawerBase::SetAlignment(const TGulAlignment &)
	CCoeTextDrawerBase::SetAppLanguage(TLanguage)
	CCoeTextDrawerBase::SetLineGapInPixels(TInt)
	CCoeTextDrawerBase::SetMargins(const TMargins8 &)
	CCoeTextDrawerBase::SetReusable(TBool)
	CCoeTextDrawerBase::~CCoeTextDrawerBase()

Private Attributes
TRgb	iTextColor

Constructor & Destructor Documentation

CCoePlainTextDrawer(TRgb)

CCoePlainTextDrawer

(

TRgb

aTextColor

)

[private]

Constructor.

Parameters

TRgb aTextColor

Member Functions Documentation

Construct()

TInt

Construct

(

)

[private]

Second-phase construction. This method is non-leaving as it will have been called indirectly from a control's draw method which cannot 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, virtual]

Draws the text provided as parameter.

CCoeTextDrawerBase

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.

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::Ptr

MopSupplyObject

(

TTypeUid

aId

)

[protected, virtual]

This function is defined by the MObjectProvider class. It allows the actual type of text drawer to be identified.

MObjectProvider

Parameters

TTypeUid aId

The type of the desired object.

New(TRgb)

IMPORT_C CCoePlainTextDrawer *

New

(

TRgb

aTextColor

)

[static]

Created a new plain text drawer on the heap. This shall typically be done in the CCoeControl::GetTextDrawer() method, or better, in the constructor of the owner of the text drawer.

Do not call this method from within a CCoeControl::Draw() method. If all you want is access to a text drawer, call CCoeControl::TextDrawer().