Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

CUILabel Class Reference

Represents a static text that does not reacts on any events. More...

#include <CUILabel.h>

Inheritance diagram for CUILabel:

MUIWidget CUIBitmap List of all members.

Public Member Functions

 CUILabel (const CUIRect &aRectangle, const char *aTitle)
 Creates CUILabel object.

virtual void Draw ()
 Draws this widget on the virtual screen.

virtual bool HandlePenEvent (MInputReader::TTouchEventData &aData)
 Reacts on touch screen event.

virtual bool HandleKeyEvent (MInputReader::TKeyEventData &aData)
 Reacts on keyboard or remote control input event.

virtual bool SetEnabled (bool aEnabled)
 Changes widget's enabled state. Keyboard and touchscreen events are not sent to disabled widgets.

virtual bool SetActive (bool aActive)
 Changes the iActive property of this widget.

virtual CDesktop::TColor GetColor ()
 Returns the color to draw this label with.


Public Attributes

CDesktop::TColor iColor

Detailed Description

Represents a static text that does not reacts on any events.

The label is always disabled


Constructor & Destructor Documentation

CUILabel::CUILabel const CUIRect aRectangle,
const char *  aTitle
 

Creates CUILabel object.

Parameters:
aRectangle Position and size of the label
aTitle Text to display. Can be NULL


Member Function Documentation

virtual void CUILabel::Draw  )  [virtual]
 

Draws this widget on the virtual screen.

The library does not provide any clipping mechanism, so the widget is completely responsible for drawing in its iRectangle. If the widget should be drawn fully or partially transparently over its iParent, it should call iParent->RestoreBackground() for every transparent region

Implements MUIWidget.

Reimplemented in CUIBitmap.

virtual bool CUILabel::HandleKeyEvent MInputReader::TKeyEventData aData  )  [virtual]
 

Reacts on keyboard or remote control input event.

It is permitted to re-draw this or other widgets as a response on this event. In this case the CUIEventLoop flushes the virtual screen automatically to ensure that it is displayed. In some cases it's necessary to completely re-draw the whole screen. If it's needed, the handling code should set CUIEventLoop::GetEventLoop().iForceFullRedraw to true.

Warning:
The full screen redraw could be very time consuming and should be used carefully

Implements MUIWidget.

virtual bool CUILabel::HandlePenEvent MInputReader::TTouchEventData aData  )  [virtual]
 

Reacts on touch screen event.

Returns true if the event was consumed.

It is permitted to re-draw this or other widgets as a response on this event. In this case the CUIEventLoop flushes the virtual screen automatically to ensure that it is displayed. In some cases it's necessary to completely re-draw the whole screen. If it's needed, the handling code should set CUIEventLoop::GetEventLoop().iForceFullRedraw to true. Note that because of nature of the touchscreen, the widget could receive PenUp event (aData.iPressure == 0) with the aData.iX and aData.iY pointing outside of iRectangle of this widget. In this case the widget should not react for such an event or perform necessary cleanup if it has reacted on PenDown event (aData.iPressure != 0 ).

Warning:
The full screen redraw could be very time consuming and should be used carefully

Implements MUIWidget.

virtual bool CUILabel::SetActive bool  aActive  )  [virtual]
 

Changes the iActive property of this widget.

Returns true if the state was changed

Active widgets may Draw themselves with differently and they receive keyboard and remote control events. Only one visible widget could be active at a time.

Reimplemented from MUIWidget.

virtual bool CUILabel::SetEnabled bool  aEnabled  )  [virtual]
 

Changes widget's enabled state. Keyboard and touchscreen events are not sent to disabled widgets.

Returns true is the state was changed

Reimplemented from MUIWidget.


Member Data Documentation

CDesktop::TColor CUILabel::iColor
 

Color to draw this label with. If zero, GetColorScheme()->ButtonFontColor() is used


The documentation for this class was generated from the following file:
Generated on Fri Jul 15 16:46:44 2005 for TomTom GO User Interface library by doxygen 1.3.5