Class XCoeTextDrawer

class XCoeTextDrawer;

Description

XCoeTextDrawer: This class serves as a handle to the class CCoeTextDrawerBase. Specifically it enables access to the CCoeTextDrawerBase's private DrawText() method. The class also manages the life of the heap allocated CCoeTextDrawerBase (deleting it or resetting it depending on whether the object is reusable or not). XCoeTextDrawer shall be allocated on the stack in the control's Draw() method and initialized with a heap allocated CCoeTextDrawerBase object fetched from the control's own skin, or from its parent or background through the CCoeControl::TextDrawer() method.

Note that an overload of the '->' operator is implemented in this class. Invoking -> on an XCoeTextDrawer object will return the iTextDrawer data member which is a pointer to a CCoeTextDrawerBase object. Using this the accessor and set methods in CCoeTextDrawerBase can be invoked. For example issuing xCoeTextDrawerObject -> Margins(); will invoke (iTextDrawer*).Margins();

Members

Defined in XCoeTextDrawer:
ClipRect(), DrawDisplayOrderedText(), DrawText(), SetClipRect(), XCoeTextDrawer(), operator->(), operator=(), ~XCoeTextDrawer()

IMPORT_C XCoeTextDrawer(CCoeTextDrawerBase &aTextDrawer);

Description

Constructor

Parameters

IMPORT_C ~XCoeTextDrawer();

Description

Destructor

IMPORT_C void operator=(CCoeTextDrawerBase &aTextDrawer);

Description

Override of assignment operator Used to set the iTextDrawer data member with a CCoeTextDrawerBase object.

Parameters

IMPORT_C CCoeTextDrawerBase *operator->();

Description

Override of -> operator. This operator is used to access the methods of the iTextDrawer (CCoeTextDrawerBase pointer) data member. Invoking -> on an XCoeTextDrawer object will return the iTextDrawer data member which is a pointer to a CCoeTextDrawerBase object. Using this the accessor and set methods in CCoeTextDrawerBase can be invoked. For example issuing xCoeTextDrawerObject -> Margins(); will invoke (iTextDrawer*).Margins();

Return value

IMPORT_C void DrawText(CGraphicsContext &aGc, const TBidiText &aText, const TRect &aTextRect, const CFont &aFont) const;

Description

Draw method. Uses its CCoeTextDrawerBase derived data member to draw the text passed as parameter.

Parameters

IMPORT_C void DrawDisplayOrderedText(CGraphicsContext &aGc, const TDesC &aText, const TRect &aTextRect, const CFont &aFont) const;

Description

Draw method. Uses its CCoeTextDrawerBase derived data member to draw the text passed as parameter.

Parameters

IMPORT_C TRect ClipRect() const;

Description

Retrieve the iClipRect value.

Return value

IMPORT_C void SetClipRect(const TRect &aClipRect);

Description

Sets the iClipRect data member.

Parameters