Wt  3.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
Wt::WMessageBox Class Reference

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

#include <Wt/WMessageBox>

Inheritance diagram for Wt::WMessageBox:
Inheritance graph
[legend]

Public Member Functions

 WMessageBox (WObject *parent=0)
 Creates an empty message box.
 
 WMessageBox (const WString &caption, const WString &text, Icon icon, WFlags< StandardButton > buttons, WObject *parent=0)
 Creates a message box with given caption, text, icon, and buttons.
 
void setText (const WString &text)
 Sets the text for the message box.
 
const WStringtext () const
 Returns the message box text.
 
WTexttextWidget () const
 Returns the text widget. More...
 
void setIcon (Icon icon)
 Sets the icon.
 
Icon icon () const
 Returns the icon.
 
WPushButtonaddButton (const WString &text, StandardButton result)
 Add a custom button with given text. More...
 
void setButtons (WFlags< StandardButton > buttons)
 Sets standard buttons for the message box.
 
WFlags< StandardButtonbuttons () const
 Returns the standard buttons.
 
WPushButtonbutton (StandardButton b)
 Returns the button widget for the given standard button. More...
 
StandardButton buttonResult ()
 Returns the result of this message box. More...
 
Signal< StandardButton > & buttonClicked ()
 Signal emitted when a button is clicked.
 
- Public Member Functions inherited from Wt::WDialog
 WDialog (WObject *parent=0)
 Constructs a new dialog. More...
 
 WDialog (const WString &windowTitle, WObject *parent=0)
 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 setCaption (const WString &caption)
 Sets the dialog caption (deprecated). More...
 
WString caption () const
 Returns the dialog caption (deprecated). More...
 
void setTitleBarEnabled (bool enabled)
 Enables or disables the title bar. More...
 
bool isTitleBarEnabled () const
 Returns whether the title bar is enabled. More...
 
WContainerWidgettitleBar () const
 Returns the dialog title bar container. More...
 
WContainerWidgetcontents () const
 Returns the dialog contents container. More...
 
WContainerWidgetfooter () 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 ()
 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 setClosable (bool closable)
 Adds a close button to the titlebar. More...
 
bool closable () const
 Returns whether the dialog can be closed.
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Vertical)
 Positions a widget next to another widget. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height)
 Sets a minimum size. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height)
 Sets a maximum size. More...
 
- Public Member Functions inherited from Wt::WPopupWidget
 WPopupWidget (WWidget *impl, WObject *parent=0)
 Constructor. More...
 
virtual ~WPopupWidget ()
 Destructor.
 
void setAnchorWidget (WWidget *widget, 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...
 
Signalhidden ()
 Signal emitted when the popup is hidden. More...
 
Signalshown ()
 Signal emitted when the popup is shown. More...
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget (WContainerWidget *parent=0)
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (WWidget *implementation, WContainerWidget *parent)
 Creates a WCompositeWidget with given implementation.
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setPositionScheme (PositionScheme scheme)
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=All)
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WLength width () const
 Returns the width. More...
 
virtual WLength height () const
 Returns the height. More...
 
virtual WLength minimumWidth () const
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const
 Returns the minimum height. More...
 
virtual WLength maximumWidth () const
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height)
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s)
 Specifies a CSS float side. More...
 
virtual Side floatSide () const
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides)
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=All)
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled)
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual bool isPopup () const
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline)
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style)
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle ()
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass)
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false)
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false)
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual const WStringtoolTip () const
 Returns the tooltip.
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void setAttributeValue (const std::string &name, const WString &value)
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value)
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args)
 Calls a JavaScript member. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool loaded () const
 Returns whether this widget has been loaded. More...
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
virtual void setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &js)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. 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...
 
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
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. More...
 
void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. 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...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
void addChild (WObject *child)
 Adds a child object. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

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...
 

Additional Inherited Members

- Public Types inherited from Wt::WDialog
enum  DialogCode { Rejected, Accepted }
 The result of a modal dialog execution. More...
 
- Protected Member Functions inherited from Wt::WDialog
void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. 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. Then, the usage is similar to instantiating a WDialog (or any other widget). You need to connect to the buttonClicked signal with a method that interpretes the result and deletes 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. See documentation of WDialog for more details.

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

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

This will show a message box that looks like this:

WMessageBox-default-1.png
Example of a WMessageBox (default)
WMessageBox-polished-1.png
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:

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 ( )

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,
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.

WText* Wt::WMessageBox::textWidget ( ) const

Returns the text widget.

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


Generated on Fri May 31 2013 for the C++ Web Toolkit (Wt) by doxygen 1.8.3.1