MGUI::DLG_SELECT_RADIO Class Reference

Dialog to display a set of radiobutton choices to select from. More...

#include <mgui/dlgselectradio.h>

Inheritance diagram for MGUI::DLG_SELECT_RADIO:

[legend]

List of all members.

Public Member Functions
	DLG_SELECT_RADIO (const MISTRING &dlgtitle, const MISTRING &prompt, HELPID helpid=HELPID__None)
	DLG_SELECT_RADIO (const MISTRING &dlgtitle, HELPID helpid=HELPID__None)
	~DLG_SELECT_RADIO ()
void	AddChoice (MGUI::ID id, const MISTRING &string)
MGUI::ID	GetSelectedChoiceID ()
void	SetDefaultChoiceID (MGUI::ID id)

---

Detailed Description

Dialog to display a set of radiobutton choices to select from.

---

Constructor & Destructor Documentation

MGUI::DLG_SELECT_RADIO::DLG_SELECT_RADIO	(	const MISTRING &	dlgtitle,
		HELPID	helpid = HELPID__None
	)			[explicit]

Construct with title.

Parameters:

	dlgtitle	Text for title
	helpid	Help ID

MGUI::DLG_SELECT_RADIO::DLG_SELECT_RADIO	(	const MISTRING &	dlgtitle,
		const MISTRING &	prompt,
		HELPID	helpid = HELPID__None
	)

Constructor with title and prompt string.

Parameters:

	dlgtitle	Text for title
	prompt	Text for prompt
	helpid	Help ID

MGUI::DLG_SELECT_RADIO::~DLG_SELECT_RADIO

(

)

Destructor.

---

Member Function Documentation

void MGUI::DLG_SELECT_RADIO::AddChoice	(	MGUI::ID	id,
		const MISTRING &	string
	)

Add choice, must be used before the call to DoModal().

Parameters:

	id	MGUI::ID to assign to the item
	string	The string to show

MGUI::ID MGUI::DLG_SELECT_RADIO::GetSelectedChoiceID

(

)

[inline]

Get the selected choice ID.

If the dialog is created using FLAG_AllowNone and the user selects <None>, the return value will be EUserCancel

Returns:

MGUI::ID of the selected choice.

void MGUI::DLG_SELECT_RADIO::SetDefaultChoiceID

(

MGUI::ID

id

)

[inline]

Set the default choice using the MGUI::ID given in AddChoice().

---

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

• mgui/dlgselectradio.h