#include <WMessageBox>
Public Member Functions | |
WMessageBox (bool i18n=false) | |
Create an empty message box. | |
WMessageBox (const WString &caption, const WString &text, Icon icon, int buttons, bool i18n=false) | |
Create a message box with given caption, text, icon, and buttons. | |
void | setText (const WString &text) |
Set the text for the message box. | |
const WString & | text () const |
Get the message box text. | |
WText * | textWidget () const |
Get the text widget. | |
void | setIcon (Icon icon) |
Set the icon. | |
Icon | icon () const |
Get the icon. | |
WPushButton * | addButton (const WString &text, StandardButton result) |
Add a custom button with given text. | |
void | setButtons (int buttons) |
Set standard buttons for the message box. | |
int | buttons () const |
Get the standard buttons. | |
WPushButton * | button (StandardButton b) |
Get the button widget for the given standard button. | |
StandardButton | result () |
Get the result of this message box. | |
Static Public Member Functions | |
static StandardButton | show (const WString &caption, const WString &text, int buttons, bool i18n=false) |
Convenience method to show a message box, blocking the current thread. | |
Public Attributes | |
Signal< StandardButton > | buttonClicked |
Signal emitted when a button is clicked. |
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
Wt::WMessageBox::WMessageBox | ( | bool | i18n = false |
) |
Create 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, | |||
int | buttons, | |||
bool | i18n = false | |||
) |
Create 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.
WText* Wt::WMessageBox::textWidget | ( | ) | const [inline] |
Get the text widget.
This may be useful to customize the style or layout of the displayed text.
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 | ) |
Get the button widget for the given standard button.
This may be useful to customize the style or layout of the button.
StandardButton Wt::WMessageBox::result | ( | ) | [inline] |
Get 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, | |||
int | 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.