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

CUIRadioButtonListBox Class Reference

A List Box that contains a number of CUIRadioButton. More...

#include <UIListBoxes.h>

Inheritance diagram for CUIRadioButtonListBox:

CUIListBox CUIWidgetGroup MUIWidget List of all members.

Public Member Functions

 CUIRadioButtonListBox (const CUIRect &aRectangle, const char *aTitle=NULL, MUIWidgetEvents *aObserver=NULL)
 Constructs the CUIRadioButtonListBox object.

virtual unsigned int GetItemsNumber ()
 Returns the number of items in the ListBox.

virtual unsigned int GetItemHeight (unsigned int aItemIndex)
 Returns the height of item with given index.

virtual void DrawItem (unsigned int aItemIndex, CUIRect &aRect)
 Draws specified item in a given rectangle.

bool AddRadioButton (const char *aTitle, bool aNewGroup=false)
 Adds a new CUIRadioButton to the List Box.

bool IsChecked (unsigned int aRadioButtonIndex)
 Returns true if Radio Button with specified index is checked.

void SetChecked (unsigned int aRadioButtonIndex, bool aChecked)
 Sets the check state of Radio Button with specified index.

const char * GetItemTitle (unsigned int aRadioButtonIndex)
 Returns title of Radio Button with given index.

void SetItemTitle (unsigned int aRadioButtonIndex, const char *aTitle)
 Sets the title of Radio Button with given index.


Detailed Description

A List Box that contains a number of CUIRadioButton.

CUIRadioButton could be grouped in a number of independent groups. Only one Radio Button from a group could be checked in any moment of time. However, the CUIRadioButtonListBox


Member Function Documentation

bool CUIRadioButtonListBox::AddRadioButton const char *  aTitle,
bool  aNewGroup = false
 

Adds a new CUIRadioButton to the List Box.

Parameters:
aTitle Title for new Radio Button. Can not be NULL
aNewGroup Instruct the CUIRadioButtonListBox to start a new group of Radio Buttons from this Radio Button

virtual unsigned int CUIRadioButtonListBox::GetItemHeight unsigned int  aItemIndex  )  [virtual]
 

Returns the height of item with given index.

If KConstItemHeight is among the iOptions only GetItemHeight(0) is called by the CUIListBox. GetItemHeight( 0 ) is also called from the CalculateParameters() so the derived class must be ready to return a correct value even if the ListBox contains no items yet.

Implements CUIListBox.

void CUIRadioButtonListBox::SetChecked unsigned int  aRadioButtonIndex,
bool  aChecked
 

Sets the check state of Radio Button with specified index.

If aChecked parameter is true, all other Radio Buttons from the group Radio Button with given index belong to will be unchecked


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