MGUI::DLG_SELECT_LIST Class Reference

Dialog to display a list of strings to select one of. More...

#include <mgui/dlgselectlist.h>

Inheritance diagram for MGUI::DLG_SELECT_LIST:

[legend]

List of all members.

Public Types
enum	FLAGS { FLAG_Default = 0x00, FLAG_AllowNone = 0x01 }
Public Member Functions
	DLG_SELECT_LIST (const MISTRING &dlgtitle, const MISTRING &prompt, FLAGS flags=FLAG_Default, HELPID helpid=HELPID__None)
	~DLG_SELECT_LIST ()
void	AddItem (MGUI::ID id, const MISTRING &string)
MGUI::ID	GetSelectedItemID ()
void	SetDefaultItemID (MGUI::ID id)

---

Detailed Description

Dialog to display a list of strings to select one of.

---

Member Enumeration Documentation

enum MGUI::DLG_SELECT_LIST::FLAGS

Enumerator:

FLAG_Default
FLAG_AllowNone	Add a <None> choice at the top of the list.

---

Constructor & Destructor Documentation

MGUI::DLG_SELECT_LIST::DLG_SELECT_LIST	(	const MISTRING &	dlgtitle,
		const MISTRING &	prompt,
		FLAGS	flags = FLAG_Default,
		HELPID	helpid = HELPID__None
	)

Constructor.

Parameters:

	dlgtitle	Text for title
	prompt	Text for prompt
	flags	Flags for dialog
	helpid	Help ID

MGUI::DLG_SELECT_LIST::~DLG_SELECT_LIST

(

)

Destructor.

---

Member Function Documentation

void MGUI::DLG_SELECT_LIST::AddItem	(	MGUI::ID	id,
		const MISTRING &	string
	)

Add an item to the list, must be used before the call to DoModal().

Parameters:

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

MGUI::ID MGUI::DLG_SELECT_LIST::GetSelectedItemID

(

)

Get the selected item MGUI::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 item in the list.

void MGUI::DLG_SELECT_LIST::SetDefaultItemID

(

MGUI::ID

id

)

Set the default item in the selection list using the MGUI::ID given in AddItem().

---

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

• mgui/dlgselectlist.h