Wt::WMessageBox Class Reference

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

#include <Wt/WMessageBox.h>

Inheritance diagram for Wt::WMessageBox:

Public Member Functions
	WMessageBox ()
	Creates an empty message box.
	WMessageBox (const WString &caption, const WString &text, Icon icon, WFlags< StandardButton > buttons)
	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. More...
void	setIcon (Icon icon)
	Sets the icon.
Icon	icon () const
	Returns the icon.
void	addButton (std::unique_ptr< WPushButton > button, const StandardButton result)
	Adds a custom button. More...
WPushButton *	addButton (const WString &text, StandardButton result)
	Adds a custom button with given text. More...
WPushButton *	addButton (StandardButton result)
	Adds a standard button.
void	setStandardButtons (WFlags< StandardButton > buttons)
	Sets standard buttons for the message box.
WFlags< StandardButton >	standardButtons () const
	Returns the standard buttons. More...
std::vector< WPushButton * >	buttons () const
	Returns the buttons. More...
WPushButton *	button (StandardButton button)
	Returns the button widget for the given standard button. More...
void	setDefaultButton (WPushButton *button)
	Sets the button as the default button. More...
void	setDefaultButton (StandardButton button)
	Sets the button as the default button. More...
WPushButton *	defaultButton () const
	Returns the default button. More...
void	setEscapeButton (WPushButton *button)
	Sets the escape button. More...
void	setEscapeButton (StandardButton button)
	Sets the escape button. More...
WPushButton *	escapeButton () const
	Returns the escape button. More...
StandardButton	buttonResult ()
	Returns the result of this message box. More...
Signal< StandardButton > &	buttonClicked ()
	Signal emitted when a button is clicked.
virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
	Hides or shows the widget. More...
Public Member Functions inherited from Wt::WDialog
	WDialog ()
	Constructs a new dialog. More...
	WDialog (const WString &windowTitle)
	Constructs a dialog with a given window title. More...
	~WDialog ()
	Deletes a dialog.
void	setWindowTitle (const WString &title)
	Sets the dialog window title. More...
WString	windowTitle () const
	Returns the dialog window title. More...
void	setTitleBarEnabled (bool enabled)
	Enables or disables the title bar. More...
bool	isTitleBarEnabled () const
	Returns whether the title bar is enabled. More...
WContainerWidget *	titleBar () const
	Returns the dialog title bar container. More...
WContainerWidget *	contents () const
	Returns the dialog contents container. More...
WContainerWidget *	footer () const
	Returns the dialog footer container. More...
DialogCode	exec (const WAnimation &animation=WAnimation())
	Executes the dialog in a recursive event loop. More...
virtual void	done (DialogCode r)
	Stops the dialog. More...
virtual void	accept ()
	Closes the dialog, with result is Accepted. More...
virtual void	reject ()
	Closes the dialog, with result is Rejected. More...
void	rejectWhenEscapePressed (bool enable=true)
	Lets pressing the escape key reject the dialog. More...
Signal< DialogCode > &	finished ()
	Signal emitted when the dialog is closed. More...
DialogCode	result () const
	Returns the result that was set for this dialog. More...
void	setModal (bool modal)
	Sets whether the dialog is modal. More...
bool	isModal () const
	Returns whether the dialog is modal. More...
void	setResizable (bool resizable)
	Adds a resize handle to the dialog. More...
bool	resizable () const
	Returns whether the dialog has a resize handle. More...
void	setMovable (bool movable)
	Allows the dialog to be moved. More...
bool	movable () const
	Returns whether the dialog can be moved. More...
void	setClosable (bool closable)
	Adds a close button to the titlebar. More...
bool	closable () const
	Returns whether the dialog can be closed.
void	setAutoFocus (bool enable)
	Set focus on the first widget in the dialog. More...
virtual void	positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical) override
	Positions a widget next to another widget. More...
void	positionAt (const Wt::WMouseEvent &ev)
	Set the position of the widget at the mouse position.
void	raiseToFront ()
	Raises this dialog to be the top-most dialog.
virtual void	setMinimumSize (const WLength &width, const WLength &height) override
	Sets a minimum size. More...
virtual void	setMaximumSize (const WLength &width, const WLength &height) override
	Sets a maximum size. More...
JSignal< int, int > &	resized ()
	Signal emitted when the dialog is being resized by the user. More...
JSignal< int, int > &	moved ()
	Signal emitted when the dialog is being moved by the user. More...
EventSignal< WTouchEvent > &	touchStarted ()
	Event signal emitted when a finger is placed on the screen.
EventSignal< WTouchEvent > &	touchEnded ()
	Event signal emitted when a finger is removed from the screen.
EventSignal< WTouchEvent > &	touchMoved ()
	Event signal emitted when a finger, which is already placed on the screen, is moved across the screen.
EventSignal< WKeyEvent > &	keyWentDown ()
	Event signal emitted when a keyboard key is pushed down. More...
EventSignal< WKeyEvent > &	keyPressed ()
	Event signal emitted when a "character" was entered. More...
EventSignal< WKeyEvent > &	keyWentUp ()
	Event signal emitted when a keyboard key is released. More...
EventSignal &	enterPressed ()
	Event signal emitted when enter was pressed. More...
EventSignal &	escapePressed ()
	Event signal emitted when escape was pressed. More...
Public Member Functions inherited from Wt::WPopupWidget
	WPopupWidget (std::unique_ptr< WWidget > impl)
	Constructor. More...
virtual	~WPopupWidget ()
	Destructor.
void	setAnchorWidget (WWidget *widget, Orientation orientation=Orientation::Vertical)
	Sets an anchor widget. More...
Orientation	orientation () const
	Returns the orientation. More...
void	setTransient (bool transient, int autoHideDelay=0)
	Sets transient property. More...
bool	isTransient () const
	Returns whether the popup is transient. More...
int	autoHideDelay () const
	Returns the auto-hide delay. More...
Signal &	hidden ()
	Signal emitted when the popup is hidden. More...
Signal &	shown ()
	Signal emitted when the popup is shown. More...
Public Member Functions inherited from Wt::WCompositeWidget
	WCompositeWidget ()
	Creates a WCompositeWidget. More...
	WCompositeWidget (std::unique_ptr< WWidget > implementation)
	Creates a WCompositeWidget with given implementation. More...
virtual std::vector< WWidget * >	children () const override
	Returns child widgets. More...
virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget) override
	Removes a child widget.
virtual void	setObjectName (const std::string &name) override
	Sets an object name. More...
virtual std::string	objectName () const override
	Returns the object name. More...
virtual const std::string	id () const override
	Returns the (unique) identifier for this object. More...
virtual void	setPositionScheme (PositionScheme scheme) override
	Sets the CSS position scheme. More...
virtual PositionScheme	positionScheme () const override
	Returns the CSS position scheme. More...
virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
	Sets CSS offsets for a non-statically positioned widget. More...
virtual WLength	offset (Side s) const override
	Returns a CSS offset. More...
virtual void	resize (const WLength &width, const WLength &height) override
	Resizes the widget. More...
virtual WLength	width () const override
	Returns the width. More...
virtual WLength	height () const override
	Returns the height. More...
virtual WLength	minimumWidth () const override
	Returns the minimum width. More...
virtual WLength	minimumHeight () const override
	Returns the minimum height. More...
virtual WLength	maximumWidth () const override
	Returns the maximum width. More...
virtual WLength	maximumHeight () const override
	Returns the maximum height. More...
virtual void	setLineHeight (const WLength &height) override
	Sets the CSS line height for contained text.
virtual WLength	lineHeight () const override
	Returns the CSS line height for contained text. More...
virtual void	setFloatSide (Side s) override
	Specifies a CSS float side. More...
virtual Side	floatSide () const override
	Returns the CSS float side. More...
virtual void	setClearSides (WFlags< Side > sides) override
	Sets the sides that should be cleared of floats. More...
virtual WFlags< Side >	clearSides () const override
	Returns the sides that should remain empty. More...
virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
	Sets CSS margins around the widget. More...
virtual WLength	margin (Side side) const override
	Returns a CSS margin set. More...
virtual void	setHiddenKeepsGeometry (bool enabled) override
	Sets whether the widget keeps its geometry when hidden. More...
virtual bool	hiddenKeepsGeometry () const override
	Returns whether the widget keeps its geometry when hidden. More...
virtual bool	isHidden () const override
	Returns whether the widget is set hidden. More...
virtual bool	isVisible () const override
	Returns whether the widget is visible. More...
virtual void	setDisabled (bool disabled) override
	Sets whether the widget is disabled. More...
virtual bool	isDisabled () const override
	Returns whether the widget is set disabled. More...
virtual bool	isEnabled () const override
	Returns whether the widget is enabled. More...
virtual void	setPopup (bool popup) override
	Lets the widget overlay over other sibling widgets. More...
virtual bool	isPopup () const override
	Returns whether the widget is overlayed. More...
virtual void	setInline (bool isInline) override
	Sets whether the widget is displayed inline or as a block. More...
virtual bool	isInline () const override
	Returns whether the widget is displayed inline or as block. More...
virtual void	setDecorationStyle (const WCssDecorationStyle &style) override
	Sets a CSS decoration style. More...
virtual WCssDecorationStyle &	decorationStyle () override
	Returns the decoration style of this widget. More...
virtual void	setStyleClass (const WString &styleClass) override
	Sets (one or more) CSS style classes. More...
virtual WString	styleClass () const override
	Returns the CSS style class. More...
virtual void	addStyleClass (const WString &styleClass, bool force=false) override
	Adds a CSS style class. More...
virtual void	removeStyleClass (const WString &styleClass, bool force=false) override
	Removes a CSS style class. More...
virtual bool	hasStyleClass (const WString &styleClass) const override
	Returns whether the widget has a style class.
virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto) override
	Sets the vertical alignment. More...
virtual AlignmentFlag	verticalAlignment () const override
	Returns the vertical alignment. More...
virtual WLength	verticalAlignmentLength () const override
	Returns the fixed vertical alignment that was set. More...
virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
	Sets a tooltip. More...
virtual WString	toolTip () const override
	Returns the tooltip.
virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
	Enable deferred tooltip. More...
virtual void	refresh () override
	Refresh the widget. More...
virtual void	setAttributeValue (const std::string &name, const WString &value) override
	Sets an attribute value. More...
virtual WString	attributeValue (const std::string &name) const override
	Returns an attribute value. More...
virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override
	Sets a JavaScript member. More...
virtual std::string	javaScriptMember (const std::string &name) const override
	Returns the value of a JavaScript member. More...
virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override
	Calls a JavaScript member. More...
virtual void	load () override
	Loads content just before the widget is used. More...
virtual bool	loaded () const override
	Returns whether this widget has been loaded. More...
virtual void	setCanReceiveFocus (bool enabled) override
	Sets whether the widget can receive focus. More...
virtual bool	canReceiveFocus () const override
	Returns whether the widget can receive focus. More...
virtual void	setFocus (bool focus) override
	Sets focus. More...
virtual bool	setFirstFocus () override
	Set focus on the widget's first descendant. More...
virtual bool	hasFocus () const override
	Returns whether the widget currently has the focus.
virtual void	setTabIndex (int index) override
	Sets the tab index. More...
virtual int	tabIndex () const override
	Returns the tab index. More...
virtual void	setId (const std::string &id) override
	Sets the CSS Id. More...
virtual WWidget *	find (const std::string &name) override
	Finds a descendent widget by name. More...
virtual WWidget *	findById (const std::string &name) override
	Finds a descendent widget by id.
virtual void	setSelectable (bool selectable) override
	Sets as selectable. More...
virtual void	doJavaScript (const std::string &js) override
	Executes the given JavaScript statements when the widget is rendered or updated. More...
virtual void	propagateSetEnabled (bool enabled) override
	Propagates that a widget was enabled or disabled through children. More...
virtual bool	scrollVisibilityEnabled () const final override
	Returns whether scroll visibility detection is enabled for this widget. More...
virtual void	setScrollVisibilityEnabled (bool enabled) final override
	Sets whether scroll visibility detection is enabled for this widget. More...
virtual int	scrollVisibilityMargin () const final override
	Returns the margin around the viewport within which the widget is considered visible. More...
virtual void	setScrollVisibilityMargin (int margin) final override
	Sets the margin around the viewport within which the widget is considered visible. More...
virtual Signal< bool > &	scrollVisibilityChanged () final override
	Signal triggered when the scroll visibility of this widget changes. More...
virtual bool	isScrollVisible () const final override
	Returns whether this widget is currently considered scroll visible. More...
virtual void	setThemeStyleEnabled (bool enabled) final override
	Sets whether theme styling for a widget is enabled or disabled. More...
virtual bool	isThemeStyleEnabled () const final override
	Returns whether this widget is currently styled by the chosen theme. More...
virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)
	Removes a child widget.
template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...
void	setFocus ()
	Sets focus. More...
virtual void	setFocus (bool focus)=0
	Sets focus. More...
Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...
WWidget *	parent () const
	Returns the parent widget.
template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...
std::unique_ptr< WWidget >	removeFromParent ()
	Removes the widget from its parent. More...
void	setWidth (const WLength &width)
	Sets the width. More...
void	setHeight (const WLength &height)
	Sets the height. More...
virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)
	Toggles a CSS style class.
std::string	jsRef () const
	Returns a JavaScript expression to the corresponding DOM node. More...
void	setFocus ()
	Sets focus. More...
virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping. More...
virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping. More...
virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation. More...
bool	isRendered () const
	Returns whether the widget is rendered. More...
void	hide ()
	Hides the widget. More...
void	animateHide (const WAnimation &animation)
	Hides the widget using an animation. More...
void	show ()
	Shows the widget. More...
void	animateShow (const WAnimation &animation)
	Shows the widget using an animation. More...
void	enable ()
	Enables the widget. More...
void	disable ()
	Disable thes widget. More...
bool	layoutSizeAware () const
	Returns whether the widget is layout size aware. More...
Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)
	Add a child WObject whose lifetime is determined by this WObject.
template<typename Child >
Child *	addChild (std::unique_ptr< Child > child)
	Add a child WObject, returning a raw pointer. More...
std::unique_ptr< WObject >	removeChild (WObject *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject.
template<typename Child >
std::unique_ptr< Child >	removeChild (Child *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject. More...
void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...
template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...
template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
template<class T >
WStatelessSlot *	implementStateless (void(T::*method)(), void(T::*undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...
void	isNotStateless ()
	Marks the current function as not stateless. More...
template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...
Public Member Functions inherited from Wt::Core::observable
	observable () noexcept
	Default constructor.
virtual	~observable ()
	Destructor. More...
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...)) noexcept
	Protects a method call against object destruction. More...
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...) const) const noexcept
	Protects a const method call against object destruction. More...
template<typename Function >
auto	bindSafe (const Function &function) noexcept
	Protects a function against object destruction. More...

Static Public Member Functions
static StandardButton	show (const WString &caption, const WString &text, WFlags< StandardButton > buttons, const WAnimation &animation=WAnimation())
	Convenience method to show a message box, blocking the current thread. More...
Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
	Short hand for WString::tr() More...

Additional Inherited Members
Public Types inherited from Wt::WDialog
typedef DialogCode	Code
	Typedef for enum Wt::DialogCode.
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.
Protected Member Functions inherited from Wt::WDialog
virtual void	render (WFlags< RenderFlag > flags) override
	Renders the widget. More...
Protected Member Functions inherited from Wt::WCompositeWidget
virtual void	enableAjax () override
	Progresses to an Ajax-enabled widget. More...
void	setImplementation (std::unique_ptr< WWidget > widget)
	Set the implementation widget. More...
template<typename Widget >
Widget *	setImplementation (std::unique_ptr< Widget > widget)
	Sets the implementation widget, returning a raw pointer. More...
template<typename W , typename... Args>
W *	setNewImplementation (Args &&... args)
	Creates the implementation widget and sets it, returning a raw pointer. More...
WWidget *	implementation ()
	Get the implementation widget. More...
virtual int	boxPadding (Orientation orientation) const override
	Returns the widget's built-in padding. More...
virtual int	boxBorder (Orientation orientation) const override
	Returns the widget's built-in border width. More...
Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)
	Sets the widget to be aware of its size set by a layout manager. More...
virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change. More...
	WWidget ()
	Creates a widget.
virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event. More...
void	scheduleRender (WFlags< RepaintFlag > flags=None)
	Schedules rerendering of the widget. More...
virtual WStatelessSlot *	getStateless (Method method) override
	On-demand stateless slot implementation. More...

Detailed Description

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

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

A messagebox is (usually) modal, and can be instantiated synchronously or asynchronously.

When using a messagebox asynchronously, there is no API call that waits for the messagebox to be processed. Instead, the usage is similar to instantiating a WDialog (or any other widget). You need to connect to the buttonClicked() signal to interpret the result and delete the message box.

The synchronous use of a messagebox involves the use of the static show() method, which blocks the current thread until the user has processed the messabebox. Since this uses the WDialog::exec(), it suffers from the same scalability issues as well as limitations. See documentation of WDialog for more details.

Example code (using the exec() method, not recommended):

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

This will show a message box that looks like this:

Example of a WMessageBox (default)

Example of a WMessageBox (polished)

i18n

The strings used in the WMessageBox buttons can be translated by overriding the default values for the following localization keys:

• Wt.WMessageBox.Abort: Abort
• Wt.WMessageBox.Cancel: Cancel
• Wt.WMessageBox.Ignore: Ignore
• Wt.WMessageBox.No: No
• Wt.WMessageBox.NoToAll: No To All
• Wt.WMessageBox.Ok: Ok
• Wt.WMessageBox.Retry: Retry
• Wt.WMessageBox.Yes: Yes
• Wt.WMessageBox.YesToAll: Yes to All

Member Function Documentation

addButton() [1/2]

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

Adds a custom button with given text.

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

addButton() [2/2]

void Wt::WMessageBox::addButton	(	std::unique_ptr< WPushButton >	button,
		const StandardButton	result
	)

Adds a custom button.

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

button()

WPushButton * Wt::WMessageBox::button

(

StandardButton

button

)

Returns the button widget for the given standard button.

Returns 0 if the button isn't in the message box.

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

buttonResult()

StandardButton Wt::WMessageBox::buttonResult

(

)

Returns the result of this message box.

This value is only defined after the dialog is finished.

buttons()

std::vector< WPushButton * > Wt::WMessageBox::buttons

(

)

const

Returns the buttons.

Note

buttons() returning WFlags<StandardButton> has been renamed to standardButtons() in Wt 3.3.1

defaultButton()

WPushButton* Wt::WMessageBox::defaultButton

(

)

const

Returns the default button.

See also

setDefaultButton()

escapeButton()

WPushButton* Wt::WMessageBox::escapeButton

(

)

const

Returns the escape button.

See also

setEscapeButton()

setDefaultButton() [1/2]

void Wt::WMessageBox::setDefaultButton

(

StandardButton

button

)

Sets the button as the default button.

The default button is pressed when the user presses enter. Only one button can be the default button.

The default value is 0 (no default button).

setDefaultButton() [2/2]

void Wt::WMessageBox::setDefaultButton

(

WPushButton *

button

)

Sets the button as the default button.

The default button is pressed when the user presses enter. Only one button can be the default button.

If no default button is set, Wt will take a button that is associated with a Wt::StandardButton::Ok or Wt::StandardButton::Yes result.

setEscapeButton() [1/2]

void Wt::WMessageBox::setEscapeButton

(

StandardButton

button

)

Sets the escape button.

The escape button is pressed when the user presses escapes.

If no escape button is set, Wt will take a button that is associated with a Wt::StandardButton::Cancel or Wt::StandardButton::No result.

setEscapeButton() [2/2]

void Wt::WMessageBox::setEscapeButton

(

WPushButton *

button

)

Sets the escape button.

The escape button is pressed when the user presses escapes.

If no escape button is set, Wt will take a button that is associated with a Wt::StandardButton::Cancel or Wt::StandardButton::No result.

setHidden()

void Wt::WMessageBox::setHidden ( bool  hidden, const WAnimation &  animation = WAnimation()  )

overridevirtual

Hides or shows the widget.

Hides or show the widget (including all its descendant widgets). When setting hidden = false, this widget and all descendant widgets that are not hidden will be shown. A widget is only visible if it and all its ancestors in the widget tree are visible, which may be checked using isVisible().

Note

hide() and show() are considered to be stateless slots by default. If you override setHidden() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().

Reimplemented from Wt::WDialog.

show()

StandardButton Wt::WMessageBox::show ( const WString &  caption, const WString &  text, WFlags< StandardButton >  buttons, const WAnimation &  animation = WAnimation()  )

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. The use of this method is not recommended since it uses WDialog::exec(). See documentation of WDialog for detailed information.

standardButtons()

WFlags< StandardButton > Wt::WMessageBox::standardButtons

(

)

const

Returns the standard buttons.

See also

setStandardButtons(), addButton()

textWidget()

WText* Wt::WMessageBox::textWidget

(

)

const

Returns the text widget.

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