MGUI::FORM_RADIOBUTTONS Class Reference

Form containing set of radio buttons, with enforcement of radio behavior. More...

#include <mgui/formradiobuttons.h>

Inheritance diagram for MGUI::FORM_RADIOBUTTONS:

[legend]

List of all members.

Public Member Functions
	FORM_RADIOBUTTONS ()
virtual	~FORM_RADIOBUTTONS ()
void	AddButton (ID id, const MISTRING &string)
void	AddButton (ID id, ICONID iconid, const MISTRING &tooltip, UINT16 iconsize=0)
void	AddButton (ID id, const ICON &icon, const MISTRING &tooltip)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, MGUI::LAYOUT_ORIENTATION orientation, int NumPerRowOrColumn, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize, int Spacing=4, int Margin=0)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Vertical, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize, int Spacing=4, int Margin=0)
const ICON &	GetIcon (ID id) const
const ICON &	GetSelectedIcon () const
ID	GetSelectedID () const
void	SetDelegateOnSelection (DELEGATE_VOID_NOPARMS delegate)
void	SetEnabledID (ID id, bool enabled=true)
void	SetSelectedID (ID id)
void	SetToggleButtonStyle (CTRL_TOGGLEBUTTON::STYLE ToggleStyle)

---

Detailed Description

Form containing set of radio buttons, with enforcement of radio behavior.

---

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,
		const MISTRING &	string
	)

Add button with text label (no icon).

Button may be added before or after Create.

Parameters:

	id	ID to attach to button
	string	String for button

void MGUI::FORM_RADIOBUTTONS::AddButton	(	ID	id,
		ICONID	iconid,
		const MISTRING &	tooltip,
		UINT16	iconsize = 0
	)

Add icon button with ICONID.

Button may be added before or after Create.

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,
		const ICON &	icon,
		const MISTRING &	tooltip
	)

Add icon button with ICON.

Button may be added before or after Create.

Parameters:

	id	ID to attach to button
	icon	Icon
	tooltip	ToolTip string

void MGUI::FORM_RADIOBUTTONS::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		MGUI::LAYOUT_ORIENTATION	orientation,
		int	NumPerRowOrColumn,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
		int	Spacing = 4,
		int	Margin = 0
	)

Create form with buttons in multiple rows or columns.

Parameters:

	ParentPane	Parent pane
	orientation	Primary orientation
	NumPerRowOrColumn	Number of buttons per row (for Horizontal) or column (for Vertical)
	Spacing	Spacing between buttons
	Margin	Margin around form

void MGUI::FORM_RADIOBUTTONS::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		MGUI::LAYOUT_ORIENTATION	orientation = MGUI::LAYOUT_ORIENTATION_Vertical,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
		int	Spacing = 4,
		int	Margin = 0
	)

Create form with buttons in single column or row.

Parameters:

	ParentPane	Parent pane
	Spacing	Spacing between buttons
	Margin	Margin around form

const ICON& MGUI::FORM_RADIOBUTTONS::GetIcon

(

ID

id

)

const

Get ICON for button.

Parameters:

id

ID of button

const ICON& MGUI::FORM_RADIOBUTTONS::GetSelectedIcon

(

)

const

ID MGUI::FORM_RADIOBUTTONS::GetSelectedID

(

)

const

Get ID of currently selected button.

Returns:

ID or -1 if none selected.

void MGUI::FORM_RADIOBUTTONS::SetDelegateOnSelection

(

DELEGATE_VOID_NOPARMS

delegate

)

Set delegate to all 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

void MGUI::FORM_RADIOBUTTONS::SetToggleButtonStyle

(

CTRL_TOGGLEBUTTON::STYLE

ToggleStyle

)

Set togglebutton style.

Must be done before Create.

Parameters:

ToggleStyle

ToggleButton style

---

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

• mgui/formradiobuttons.h