MGUI::FORM_RADIOBUTTONS Class Reference

Container form for set of radio buttons, with enforcement of radio behavior. More...

#include <mgui/formrbtn.h>

Inheritance diagram for MGUI::FORM_RADIOBUTTONS:

[legend]List of all members.

Public Member Functions
void	AddButton (ID id, ICONID iconid, const UNICODE *tooltip, int iconsize=0)
void	AddButton (ID id, ICONID iconid, const char *tooltip, int iconsize=0)
void	AddButton (ID id, const UNICODE *string)
void	AddButton (ID id, const char *string)
void	AddButtons (const MGUI::LISTITEMDEF *buttons)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MGUI::LISTITEMDEF *buttons=0, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize, int ChildSpacing=4)
	FORM_RADIOBUTTONS ()
ID	GetSelectedID () const
void	SetEnabledID (ID id, bool enabled=true)
void	SetSelectedID (ID id)
virtual	~FORM_RADIOBUTTONS ()
Protected Member Functions
virtual void	OnSelection ()

---

Detailed Description

Container form for set of radio buttons, with enforcement of radio behavior.

Definition at line 56 of file formrbtn.h.

---

Constructor & Destructor Documentation

MGUI::FORM_RADIOBUTTONS::FORM_RADIOBUTTONS (   )

Constructor.

virtual MGUI::FORM_RADIOBUTTONS::~FORM_RADIOBUTTONS (   )  [virtual]

Destructor.

---

Member Function Documentation

void MGUI::FORM_RADIOBUTTONS::AddButton (  ID  id, ICONID  iconid, const UNICODE *  tooltip, int  iconsize = 0 )

Add icon button with Unicode tooltip. Parameters: id  ID to attach to button iconid  Icon ID tooltip  ToolTip string iconsize  Icon size, 0 for default

void MGUI::FORM_RADIOBUTTONS::AddButton (  ID  id, ICONID  iconid, const char *  tooltip, int  iconsize = 0 )

Add icon button with tooltip from resource lookup. Parameters: id  ID to attach to item iconid  Icon ID tooltip  ToolTip for resource lookup iconsize  Icon size, 0 for default

void MGUI::FORM_RADIOBUTTONS::AddButton (  ID  id, const UNICODE *  string )

Add button with Unicode string. Parameters: id  ID to attach to button string  String for button

void MGUI::FORM_RADIOBUTTONS::AddButton (  ID  id, const char *  string )

Add button with string from resource lookup. Parameters: id  ID to attach to item string  String for resource lookup

void MGUI::FORM_RADIOBUTTONS::AddButtons (  const MGUI::LISTITEMDEF *  buttons  )

Add multiple buttons. Parameters: buttons  Buttons to add, terminated by button with NULL string

void MGUI::FORM_RADIOBUTTONS::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, const MGUI::LISTITEMDEF *  buttons = 0, MGUI::LAYOUT_ORIENTATION  orientation = MGUI::LAYOUT_ORIENTATION_Vertical, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize, int  ChildSpacing = 4 )

Create control. Parameters: ParentPane  Parent pane buttons  Initial button set, 0 for none ChildSpacing  Spacing between children

ID MGUI::FORM_RADIOBUTTONS::GetSelectedID (   )  const

Get ID of currently selected button. Returns: ID or -1 if none selected.

virtual void MGUI::FORM_RADIOBUTTONS::OnSelection (   )  [protected, virtual]

Called when user makes selection.

void MGUI::FORM_RADIOBUTTONS::SetEnabledID (  ID  id, bool  enabled = true )

Set whether individual button is enabled or not. Parameters: id  ID of button to enable/disable enabled  'true' to enable, 'false' to disable

void MGUI::FORM_RADIOBUTTONS::SetSelectedID (  ID  id  )

Select button using ID. If button does not exist then no button will appear selected Parameters: id  ID of button to select

---

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

• mgui/formrbtn.h

---