Wt::WMessageBox Class Reference

A standard dialog for confirmation or to get simple user input. More...

#include <Wt/WMessageBox>

Inherits Wt::WDialog.

List of all members.

Public Member Functions
	WMessageBox (bool i18n=false)
	Creates an empty message box.
	WMessageBox (const WString &caption, const WString &text, Icon icon, WFlags< StandardButton > buttons, bool i18n=false)
	Creates a message box with given caption, text, icon, and buttons.
void	setText (const WString &text)
	Sets the text for the message box.
const WString &	text () const
	Returns the message box text.
WText *	textWidget () const
	Returns the text widget.
void	setIcon (Icon icon)
	Sets the icon.
Icon	icon () const
	Returns the icon.
WPushButton *	addButton (const WString &text, StandardButton result)
	Add a custom button with given text.
void	setButtons (WFlags< StandardButton > buttons)
	Sets standard buttons for the message box.
WFlags< StandardButton >	buttons () const
	Returns the standard buttons.
WPushButton *	button (StandardButton b)
	Returns the button widget for the given standard button.
StandardButton	buttonResult ()
	Returns the result of this message box.
Signal< StandardButton > &	buttonClicked ()
	Signal emitted when a button is clicked.
Static Public Member Functions
static StandardButton	show (const WString &caption, const WString &text, WFlags< StandardButton > buttons, bool i18n=false)
	Convenience method to show a message box, blocking the current thread.

---

Detailed Description

A standard dialog for confirmation or to get simple user input.

The message box shows a message in a dialog window, with a number of buttons. These buttons may be standard buttons, or customized.

There are two distinct ways for using a WMessageBox, which reflect the two ways of dealing with a WDialog box.

The easiest way is using the static show() method, which shows a message box, blocks the current thread, and returns the button that was pressed by the user. Since this uses the WDialog::exec(), it suffers from the same scalability issues.

The more elaborate way is by creating a WMessageBox, and connecting the buttonClicked signal to a method. This method then interpretes the result and deletes the message box.

Example code (using the exec() method):

 StandardButton
   result = WMessageBox::show("Confirm", "About to wreak havoc... Continue ?",
                              Ok | Cancel);

This will show a message box that looks like this:

Example of a WMessageBox (default)

Example of a WMessageBox (polished)

CSS

A WMessageBox can be styled using the Wt-dialog and Wt-outset style classes from it's superclass WDialog. The messagebox' buttons can be styled using Wt-msgbox-buttons style class.

---

Constructor & Destructor Documentation

Wt::WMessageBox::WMessageBox

(

bool

i18n = false

)

Creates an empty message box.

The button labels may be set fixed English (if i18n = false), or fetched from a resource bundle if i18n = true. In that case, the key for each button is exactly the same as the English text.

Wt::WMessageBox::WMessageBox	(	const WString &	caption,
		const WString &	text,
		Icon	icon,
		WFlags< StandardButton >	buttons,
		bool	i18n = false
	)

Creates a message box with given caption, text, icon, and buttons.

The button labels may be set fixed English (if i18n = false), or fetched from a resource bundle if i18n = true.

In that case, the key for each button is exactly the same as the English text.

---

Member Function Documentation

WPushButton * Wt::WMessageBox::addButton	(	const WString &	text,
		StandardButton	result
	)

Add a custom button with given text.

When the button is clicked, the associated result will be returned.

WPushButton * Wt::WMessageBox::button

(

StandardButton

b

)

Returns the button widget for the given standard button.

This may be useful to customize the style or layout of the button.

StandardButton Wt::WMessageBox::buttonResult

(

)

[inline]

Returns the result of this message box.

This value is only defined after a button has been clicked.

StandardButton Wt::WMessageBox::show	(	const WString &	caption,
		const WString &	text,
		WFlags< StandardButton >	buttons,
		bool	i18n = false
	)			[static]

Convenience method to show a message box, blocking the current thread.

Show a message box, blocking the current thread until the message box is closed, and return the result.

WText* Wt::WMessageBox::textWidget

(

)

const [inline]

Returns the text widget.

This may be useful to customize the style or layout of the displayed text.