CUIRadioButton Class Reference

Represents a Radio Button. More...

#include <CUIRadioButton.h>

Inheritance diagram for CUIRadioButton:

List of all members.

Public Member Functions
	CUIRadioButton (const CUIRect &aRectangle, const char *aTitle, MUIWidgetEvents *aObserver, CUIRadioButton *aPrevButton, CUIRadioButton *aNextButton)
	Constructs CUIRadioButton 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 void	SetChecked (bool aChecked)
	Changes the iChecked state of the Radio Button and redraws it if necessary.
Public Attributes
bool	iChecked
CUIRadioButton *	iPrevButton
CUIRadioButton *	iNextButton

---

Detailed Description

Represents a Radio Button.

Radio Button could have two states that are stored in its iChecked member Radio Buttons can be put together into groups. Only one Radio Button from a group could have iChecked property equal to true

Radio Button generates MUIWidget::MUIWidgetEvents::FiredPressEvent() when it is pressed and had changed its iChecked property

---

Constructor & Destructor Documentation

CUIRadioButton::CUIRadioButton (  const CUIRect &  aRectangle, const char *  aTitle, MUIWidgetEvents *  aObserver, CUIRadioButton *  aPrevButton, CUIRadioButton *  aNextButton )

Constructs CUIRadioButton object. Parameters: aRectangle  Position and size aTitle  Text to write on at the right side of check box image. Can be NULL aObserver  Observer for events. Can be NULL aPrevButton  Pointer to previous Radio Button in this group. Can be NULL. aNextButton  Pointer to next Radio Button in this group. Can be NULL.

---

Member Function Documentation

virtual void CUIRadioButton::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.

virtual bool CUIRadioButton::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 CUIRadioButton::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 void CUIRadioButton::SetChecked (  bool  aChecked  )  [virtual]

Changes the iChecked state of the Radio Button and redraws it if necessary. If the aChecked is equal to true, all other Radio Buttons that form the same group as this Radio Button, will have iChecked equal to false

---

Member Data Documentation

bool CUIRadioButton::iChecked

Keeps the state of the Check Box

CUIRadioButton* CUIRadioButton::iNextButton

Pointer to next Radio Button in this group

CUIRadioButton* CUIRadioButton::iPrevButton

Pointer to previous Radio Button in this group

---

The documentation for this class was generated from the following file:

• CUIRadioButton.h

---