Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: coetextdrawer.h
Link against: cone.lib

Class CCoePlainTextDrawer

class CCoePlainTextDrawer : public CCoeTextDrawerBase;

Description

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.

Derivation

Members

Defined in CCoePlainTextDrawer:
DrawText(), ETypeId, MopSupplyObject(), New(), Reset(), SetTextColor(), TextColor(), anonymous

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeTextDrawerBase:
ActualHorizontalAlignment(), Alignment(), Construct(), EffectMargins(), IsReusable(), LineGapInPixels(), Margins(), SetAlignment(), SetAppLanguage(), SetLineGapInPixels(), SetMargins(), SetReusable()

Inherited from MObjectProvider:
MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining(), MopNext()


Member functions


New()

static IMPORT_C CCoePlainTextDrawer *New(TRgb aTextColor);

Description

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().

Parameters

TRgb aTextColor

The color that will be used to draw text.

Return value

CCoePlainTextDrawer *

A new CCoePlainTextDrawer instance or null if the creation of a new instance failed.


TextColor()

virtual IMPORT_C TRgb TextColor() const;

Description

See CCoeTextDrawerBase::TextColor().

Return value

TRgb

See also:


SetTextColor()

virtual IMPORT_C void SetTextColor(TRgb aTextColor);

Description

See CCoeTextDrawerBase::SetTextColor().

Parameters

TRgb aTextColor

See also:


MopSupplyObject()

protected: virtual IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

Description

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

Parameters

TTypeUid aId

The type of the desired object.

Return value

TTypeUid::Ptr

A pointer to an object.

See also:


DrawText()

private: virtual void DrawText(CGraphicsContext &aGc, const TCoeTextTypeAdaptor &aText, const CFont &aFont, const TRect &aTextRect, const TRect &aClipRect) const;

Description

Draws the 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.

See also:


Reset()

private: virtual void Reset();

Description

See CCoeTextDrawerBase::Reset().

[Top]


Member enumerations


Enum anonymous

n/a

Description

ETypeId