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

• MObjectProvider - An interface that allows an object to be part of a network of object providers.
• CBase - Base class for all classes to be instantiated on the heap.

• CCoeTextDrawerBase - This is the base class for all text drawers implementing different text effects ...

• CCoePlainTextDrawer - This is a basic text drawer without any text effects. The default text drawer th...

Members

Defined in CCoePlainTextDrawer:

• DrawText(CGraphicsContext &,const TCoeTextTypeAdaptor &,const CFont &,const TRect &,const TRect &)constDraws the text provided as parameter.
• ETypeId
• MopSupplyObject(TTypeUid)This function is defined by the MObjectProvider class. It allows the actual type...
• New(TRgb)Created a new plain text drawer on the heap. This shall typically be done in the...
• Reset()See CCoeTextDrawerBase::Reset().
• SetTextColor(TRgb)See CCoeTextDrawerBase::SetTextColor(TRgb).
• TextColor()constSee CCoeTextDrawerBase::TextColor()const.
• anonymous

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CCoeTextDrawerBase:

• ActualHorizontalAlignment(const TCoeTextTypeAdaptor &)constThis method returns the actual (absolute) horizontal text alignment to be used w...
• Alignment()constReturns the text alignment that will be used by CCoeTextDrawerBase::DrawText(CGr...
• Construct()Second phase object construction. Note that this method is non-leaving as it may...
• EffectMargins()Any text drawer implementation must override this method, returning the "ma...
• IsReusable()constReturns whether the CCoeTextDrawerBase-derived text drawer object has been set t...
• LineGapInPixels()constReturns the gap (in pixels) between lines of text. Default gap is 1 (one) pixel.
• Margins()constReturns the text margins that will be used by CCoeTextDrawerBase::DrawText(CGrap...
• SetAlignment(const TGulAlignment &)Set the text alignment that will be used by CCoeTextDrawerBase::DrawText(CGraphi...
• SetAppLanguage(TLanguage)Unless absolute horizontal aligment has been selected (see TGulAlignment), the a...
• SetLineGapInPixels(TInt)Set the gap (in pixels) between lines of text. Default gap is 1 (one) pixel.
• SetMargins(const TMargins8 &)Set the text margins that will be used by CCoeTextDrawerBase::DrawText(CGraphics...
• SetReusable(TBool)Set whether the text drawer is reusable or not. A reusable text drawer will be r...

Inherited from MObjectProvider:

• MopGetObject(T *&)Gets an object of the type defined by the template parameter.
• MopGetObjectNoChaining(T *&)Gets an object of the type defined by the template parameter.

IMPORT_C static CCoePlainTextDrawer* New(TRgb aTextColor);

Description

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

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

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.

IMPORT_C virtual TRgb TextColor() const;

Description

See CCoeTextDrawerBase::TextColor()const.

Return value

TRgb

See also:

• CCoeTextDrawerBaseThis is the base class for all text drawers implementing different text effects ...

IMPORT_C virtual void SetTextColor(TRgb aTextColor);

Description

See CCoeTextDrawerBase::SetTextColor(TRgb).

Parameters

TRgb aTextColor

See also:

• CCoeTextDrawerBaseThis is the base class for all text drawers implementing different text effects ...

protected: IMPORT_C virtual 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:

• MObjectProviderAn interface that allows an object to be part of a network of object providers.

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:

• CCoeTextDrawerBaseThis is the base class for all text drawers implementing different text effects ...

private: virtual void Reset();

Description

See CCoeTextDrawerBase::Reset().

n/a

Description

ETypeId