A WDialog shows a dialog. More...
#include <Wt/WDialog>
Public Types | |
enum | DialogCode { Rejected, Accepted } |
The result of a modal dialog execution. More... | |
Public Member Functions | |
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... | |
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 () |
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... | |
![]() | |
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... | |
Signal & | hidden () |
Signal emitted when the popup is hidden. More... | |
Signal & | shown () |
Signal emitted when the popup is shown. More... | |
![]() | |
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< Side > | clearSides () 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 WCssDecorationStyle & | decorationStyle () |
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 WString & | toolTip () 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 WWidget * | find (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... | |
![]() | |
virtual | ~WWidget () |
Destructor. More... | |
WWidget * | parent () 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... | |
![]() | |
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. | |
WObject * | parent () const |
Returns the parent object. | |
Protected Member Functions | |
void | render (WFlags< RenderFlag > flags) |
Renders the widget. More... | |
Additional Inherited Members | |
![]() | |
static WString | tr (const char *key) |
Short hand for WString::tr() More... | |
![]() | |
static WObject * | sender () |
Returns the sender of the current slot call. More... | |
A WDialog shows a dialog.
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).
A modal dialog can be instantiated synchronously or asynchronously. A non-modal dialog can only be instantiated asynchronously.
When using a dialog asynchronously, there is no API call that waits for the dialog to be closed. Then, the usage is similar to instantiating any other 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(false) to show the dialog.
The synchronous use of a dialog involves a call to exec() which will block (suspend the thread) until the dialog window is closed, and return the dialog result. Events within dialog are handled using a so-called recursive event loop. 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, a thread is locked until exec() returns. A thread that is locked by a recursive event loop cannot be used to process requests from another sessions. When all threads in the threadpool are locked in recursive event loops, the server will be unresponsive to requests from any other session. In practical terms, this means you must not use exec(), unless your application will never be used by more concurrent users than the amount of threads in your threadpool (like on some intranets or extranets).
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 (not recommended):
Usage example, using the asynchronous method (recommended):
This dialog looks like this (using the default css themes):
![]()
A simple custom dialog (default) | ![]()
A simple custom dialog (polished) |
Wt::WDialog::WDialog | ( | WObject * | parent = 0 ) |
Constructs a new dialog.
Unlike other widgets, the dialog does not require a parent container since it is a top-level widget. You may however still provide a parent object to let the dialog be deleted together with its parent.
Constructs a dialog with a given window title.
Unlike other widgets, the dialog does not require a parent container since it is a top-level widget. You may however still provide a parent object to let the dialog be deleted together with its parent.
|
virtual |
Closes the dialog, with result is Accepted.
WString Wt::WDialog::caption | ( | ) | const |
Returns the dialog caption (deprecated).
WContainerWidget* Wt::WDialog::contents | ( | ) | const |
Returns the dialog contents container.
Content to the dialog window may be added to this container widget.
|
virtual |
Stops 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.
WDialog::DialogCode Wt::WDialog::exec | ( | const WAnimation & | animation = WAnimation() ) |
Executes the dialog in a recursive event loop.
Executes the dialog synchronously. 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 until exec returns, so the entire server will be unresponsive when the thread pool is exhausted.
Signal<DialogCode>& Wt::WDialog::finished | ( | ) |
Signal emitted when the dialog is closed.
WContainerWidget * Wt::WDialog::footer | ( | ) | const |
Returns the dialog footer container.
This is an optional section which is typically used for buttons.
bool Wt::WDialog::isModal | ( | ) | const |
Returns whether the dialog is modal.
bool Wt::WDialog::isTitleBarEnabled | ( | ) | const |
Returns whether the title bar is enabled.
|
virtual |
Positions a widget next to another widget.
Positions this absolutely positioned widget next to another widget
. Both widgets must be visible.
When orientation
= Wt::Vertical, the widget is displayed below the other widget (or above in case there is not enough room below). It is aligned so that the left edges align (or the right edges if there is not enough room to the right).
Conversely, when orientation
= Wt::Horizontal, the widget is displayed to the right of the other widget (or to the left in case there is not enough room to the right). It is aligned so that the top edges align (or the bottom edges if there is not enough room below).
Reimplemented from Wt::WWidget.
|
virtual |
Closes the dialog, with result is Rejected.
void Wt::WDialog::rejectWhenEscapePressed | ( | ) |
Lets pressing the escape key reject the dialog.
Before Wt 3.1.5, pressing escape automatically rejected the dialog. Since 3.1.4 this behaviour is no longer the default since it may interfere with other functionality in the dialog. Use this method to enable this behaviour.
|
protectedvirtual |
Renders the widget.
This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().
The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.
Reimplemented from Wt::WPopupWidget.
bool Wt::WDialog::resizable | ( | ) | const |
Returns whether the dialog has a resize handle.
DialogCode Wt::WDialog::result | ( | ) | const |
Returns the result that was set for this dialog.
void Wt::WDialog::setCaption | ( | const WString & | caption) |
Sets the dialog caption (deprecated).
void Wt::WDialog::setClosable | ( | bool | closable) |
Adds a close button to the titlebar.
The close button is shown in the title bar. Clicking the close button will reject the dialog.
|
virtual |
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().
Reimplemented from Wt::WPopupWidget.
Sets a maximum size.
Specifies a maximum size for this widget, setting CSS max-width
and max-height
properties.
The default the maximum width and height are WLength::Auto, indicating no maximum size. A WLength::Percentage size should not be used, as this is (in virtually all cases) undefined behaviour.
When the widget is a container widget that contains a layout manager, then setting a maximum size will have the effect of letting the size of the container to reflect the preferred size of the contents (rather than constraining the size of the children based on the size of the container), up to the specified maximum size.
Reimplemented from Wt::WCompositeWidget.
Sets a minimum size.
Specifies a minimum size for this widget, setting CSS min-width
and min-height
properties.
The default minimum width and height is 0. The special value WLength::Auto indicates that the initial width is used as minimum size. A WLength::Percentage size should not be used, as this is (in virtually all cases) undefined behaviour.
When the widget is inserted in a layout manager, then the minimum size will be taken into account.
Reimplemented from Wt::WCompositeWidget.
void Wt::WDialog::setModal | ( | bool | modal) |
Sets whether the dialog is modal.
A modal dialog will block the underlying user interface. A modal dialog can be shown synchronously or asynchronously. A non-modal dialog can only be shown asynchronously.
By default a dialog is modal.
void Wt::WDialog::setResizable | ( | bool | resizable) |
Adds a resize handle to the dialog.
The resize handle is shown in the bottom right corner of the dialog, and allows the user to resize the dialog (but not smaller than the content allows).
This also sets the minimum width and height to WLength::Auto to use the initial width and height as minimum sizes. You may want to provide other values for minimum width and height to allow the dialog to be reduced in size.
void Wt::WDialog::setTitleBarEnabled | ( | bool | enabled) |
Enables or disables the title bar.
The titlebar is enabled by default.
void Wt::WDialog::setWindowTitle | ( | const WString & | title) |
Sets the dialog window title.
The window title is displayed in the title bar.
WContainerWidget* Wt::WDialog::titleBar | ( | ) | const |
Returns the dialog title bar container.
The title bar contains a single text that contains the caption. You may customize the title bar by for example adding other content.
WString Wt::WDialog::windowTitle | ( | ) | const |
Returns the dialog window title.