MGUI::DLG_QUESTION Class Reference

Dialog to display question to user with pushbutton responses. More...

#include <mgui/dlgquestion.h>

Inheritance diagram for MGUI::DLG_QUESTION:

[legend]

List of all members.

Public Types
enum	TOGGLETYPE { TOGGLETYPE_NeverAsk, TOGGLETYPE_AlwaysAsk }
Public Member Functions
	DLG_QUESTION (const MISTRING &dlgtitle, const MISTRING &text, DLGQ_STYLE style, INT32 dftresponse, HELPID helpid=HELPID__None)
	~DLG_QUESTION ()
void	AddButton (const MISTRING &text, INT32 response)
bool	CheckNoShow () const
INT32	GetResponse () const
bool	SetupToggle (const char *IniGroup, const char *IniName, const MISTRING &ToggleText, TOGGLETYPE ToggleType)

---

Detailed Description

Dialog to display question to user with pushbutton responses.

Also allows for optional toggle to always show / never show.

See also:

MdlgQuestion.

---

Member Enumeration Documentation

enum MGUI::DLG_QUESTION::TOGGLETYPE

Enumerator:

TOGGLETYPE_NeverAsk	Toggle "on" to never ask again, default is "off".
TOGGLETYPE_AlwaysAsk	Toggle "on" to always ask, default is "on".

---

Constructor & Destructor Documentation

MGUI::DLG_QUESTION::DLG_QUESTION	(	const MISTRING &	dlgtitle,
		const MISTRING &	text,
		DLGQ_STYLE	style,
		INT32	dftresponse,
		HELPID	helpid = HELPID__None
	)

Constructor.

Parameters:

	dlgtitle	Text for title
	text	Text for question
	style	Dialog style
	dftresponse	Default response value
	helpid	Help ID

MGUI::DLG_QUESTION::~DLG_QUESTION

(

)

Destructor.

---

Member Function Documentation

void MGUI::DLG_QUESTION::AddButton	(	const MISTRING &	text,
		INT32	response
	)

Add non-standard button with text and response.

Button will be added to left of any "standard" buttons used.

bool MGUI::DLG_QUESTION::CheckNoShow

(

)

const

Determine if user doesn't want to see question again.

Returns:

true if user does not want to see question, false if does.

INT32 MGUI::DLG_QUESTION::GetResponse

(

)

const [inline]

Get response from dialog.

bool MGUI::DLG_QUESTION::SetupToggle	(	const char *	IniGroup,
		const char *	IniName,
		const MISTRING &	ToggleText,
		TOGGLETYPE	ToggleType
	)

Set up toggle for whether user wants to see question again.

Returns:

true if user does not want to see question, false if does.

Parameters:

	IniGroup	Ini group
	IniName	Ini name to store toggle state
	ToggleText	Text to show for toggle
	ToggleType	Meaning of toggle

---

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

• mgui/dlgquestion.h