#include <Wt/WDialog>
Public Types | |
enum | DialogCode { Rejected, Accepted } |
The result of a modal dialog execution. More... | |
Public Member Functions | |
WDialog (const WString &windowTitle=WString()) | |
Construct a WDialog with a given window title. | |
~WDialog () | |
Destruct a WDialog. | |
void | setCaption (const WString &caption) |
Set the dialog caption (deprecated). | |
const WString & | caption () const |
Get the dialog caption (deprecated). | |
void | setWindowTitle (const WString &title) |
Set the dialog window title. | |
const WString & | windowTitle () const |
Get the dialog window title. | |
void | setTitleBarEnabled (bool enabled) |
Enable or disable the title bar. | |
bool | isTitleBarEnabled () const |
Returns whether the title bar is enabled. | |
WContainerWidget * | contents () const |
Get the dialog contents container. | |
DialogCode | exec () |
Execute the dialog in a recursive event loop. | |
virtual void | done (DialogCode r) |
Stop the dialog. | |
virtual void | accept () |
Close the dialog, with result is Accepted. | |
virtual void | reject () |
Close the dialog, with result is Rejected. | |
Signal< DialogCode > & | finished () |
Signal emitted when the dialog is closed. | |
DialogCode | result () const |
Get the result that was set for this dialog. | |
void | setModal (bool modal) |
Set whether the dialog is modal. | |
bool | isModal () const |
Returns whether the dialog is modal. | |
virtual void | setHidden (bool hidden) |
Sets whether the widget is hidden. | |
virtual void | resize (const WLength &width, const WLength &height) |
Resizes the widget. |
By default, the dialog is modal. A modal window blocks the user interface, and does not allow the user to interact with any other part of the user interface until the dialog is closed (this is enforced at the server side, so you may rely on this behavior).
There are two distinct ways for using a WDialog window.
A WDialog can be used as any other widget. In this case, the WDialog is simply instantiated as another widget. The dialog may be closed by calling accept(), reject() or done() (or connecting a signal to one of these methods). This will hide the dialog and emit the finished() signal, which you then can listen for to process the dialog result and delete the dialog. Unlike other widgets, a dialog does not need to be added to a parent widget, but is hidden by default. You must use the method show() or setHidden(true) to show the dialog.
The easiest way to display a modal dialog is using exec(): after creating a WDialog window, a call to exec() will block (suspend the thread) until the dialog window is closed, and return the dialog result. Typically, an OK button will be connected to accept(), and in some cases a Cancel button to reject(). This solution has the drawback that it is not scalable to many concurrent sessions, since for every session with a recursive event loop (which is running durring the exec() method), a thread is locked. In practical terms, this means it is only suitable for software with restricted access or deployed on an intranet or extranet.
Use setModal(false) to create a non-modal dialog. A non-modal dialog does not block the underlying user interface: the user must not first deal with the dialog before interacting with the rest of the user interface.
Contents for the dialog is defined by adding it to the contents() widget.
Usage example, using the exec() method:
Wt::WDialog dialog("Personalia"); new Wt::WText("Enter your name: ", dialog.contents()); Wt::WLineEdit edit(dialog.contents()); new Wt::WBreak(dialog.contents()); Wt::WPushButton ok("Ok", dialog.contents()); // these events will accept() the Dialog edit.enterPressed().connect(SLOT(&dialog, Wt::WDialog::accept)); ok.clicked().connect(SLOT(&dialog, Wt::WDialog::accept)); if (dialog.exec() == Wt::WDialog::Accepted) setStatus("Welcome, " + edit.text());
This dialog looks like this (using the standard look):
A simple custom dialog
Construct a WDialog with a given window title.
Only a single Dialog may be constructed at any time. Unlike other widgets, a dialog does not need to be added to a container widget.
void Wt::WDialog::setCaption | ( | const WString & | caption | ) |
const WString & Wt::WDialog::caption | ( | ) | const |
void Wt::WDialog::setWindowTitle | ( | const WString & | title | ) |
Set the dialog window title.
The window title is displayed in the title bar.
const WString & Wt::WDialog::windowTitle | ( | ) | const |
void Wt::WDialog::setTitleBarEnabled | ( | bool | enabled | ) |
Enable or disable the title bar.
The titlebar is enabled by default.
bool Wt::WDialog::isTitleBarEnabled | ( | ) | const [inline] |
WContainerWidget* Wt::WDialog::contents | ( | ) | const [inline] |
Get the dialog contents container.
Content to the dialog window may be added to this container widget.
WDialog::DialogCode Wt::WDialog::exec | ( | ) |
Execute the dialog in a recursive event loop.
Executes the dialog. This blocks the current thread of execution until one of done(DialogCode), accept() or reject() is called.
Warning: using exec() does not scale to many concurrent sessions, since the thread is locked.
void Wt::WDialog::done | ( | DialogCode | r | ) | [virtual] |
Stop the dialog.
Sets the dialog result, and emits the finished() signal.
If a recursive event loop was started using the exec() method, it is ended.
void Wt::WDialog::accept | ( | ) | [virtual] |
void Wt::WDialog::reject | ( | ) | [virtual] |
Signal<DialogCode>& Wt::WDialog::finished | ( | ) | [inline] |
DialogCode Wt::WDialog::result | ( | ) | const [inline] |
void Wt::WDialog::setModal | ( | bool | modal | ) |
Set whether the dialog is modal.
A modal dialog will block the underlying user interface.
By default a dialog is modal.
bool Wt::WDialog::isModal | ( | ) | const [inline] |
void Wt::WDialog::setHidden | ( | bool | hidden | ) | [virtual] |
Sets whether the widget is hidden.
Hides or show the widget (including all its descendant widgets). setHidden(false) will show this widget and all descendant widgets that are not hidden. A widget is only visible if it and all its ancestors in the widget tree are visible, which may be checked using isVisible().
Reimplemented from Wt::WCompositeWidget.
Resizes the widget.
Specify a new size for this widget, by specifying width and height. By default a widget has automatic width and height, see WLength::isAuto().
This applies to CSS-based layout, and only block widgets can be given a size reliably.
Reimplemented from Wt::WCompositeWidget.