<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::WDialog Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WDialog.html">WDialog</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WDialog Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WDialog" --><!-- doxytag: inherits="Wt::WCompositeWidget" -->
<p>A WDialog shows a dialog.
<a href="classWt_1_1WDialog.html#details">More...</a></p>
<p><code>#include <Wt/WDialog></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WDialog:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WDialog__inherit__graph.png" border="0" usemap="#Wt_1_1WDialog_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WDialog_inherit__map" id="Wt_1_1WDialog_inherit__map">
<area shape="rect" href="classWt_1_1Auth_1_1PasswordPromptDialog.html" title="A dialog that prompts for the user password." alt="" coords="5,304,221,331"/><area shape="rect" href="classWt_1_1WMessageBox.html" title="A standard dialog for confirmation or to get simple user input." alt="" coords="245,304,381,331"/><area shape="rect" href="classWt_1_1WCompositeWidget.html" title="A widget that hides the implementation of composite widgets." alt="" coords="132,155,295,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="164,80,263,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="165,5,261,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WDialog-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> { <a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6a8279eafdc9665e6c91d98d2b512a962c">Rejected</a>,
<a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6ad4852d715c07070ca1b117cb7e263840">Accepted</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The result of a modal dialog execution. <a href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ab31907fa4f641192b2720ba735226d58">WDialog</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &windowTitle=<a class="el" href="classWt_1_1WString.html">WString</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a WDialog with a given window title. <a href="#ab31907fa4f641192b2720ba735226d58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97fa6bfc8c31a3bf98284ad66b2df738"></a><!-- doxytag: member="Wt::WDialog::~WDialog" ref="a97fa6bfc8c31a3bf98284ad66b2df738" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a97fa6bfc8c31a3bf98284ad66b2df738">~WDialog</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructs a WDialog. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ae0923afc12895002f30b8ee12ab91aae">setWindowTitle</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &title)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the dialog window title. <a href="#ae0923afc12895002f30b8ee12ab91aae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#acf71bbc665dff57a7af201b4f32f59f8">windowTitle</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the dialog window title. <a href="#acf71bbc665dff57a7af201b4f32f59f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a626d5109624e7442f9a96310b6919a5a">setCaption</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &caption)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the dialog caption (<b>deprecated</b>). <a href="#a626d5109624e7442f9a96310b6919a5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#af56bc5d90c6da742faa454ddfed4ce00">caption</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the dialog caption (<b>deprecated</b>). <a href="#af56bc5d90c6da742faa454ddfed4ce00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ab8ae8763648de12a67ada4b8237154a9">setTitleBarEnabled</a> (bool enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the title bar. <a href="#ab8ae8763648de12a67ada4b8237154a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#aa23c6db155044c4f2c49269a874dd5cb">isTitleBarEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the title bar is enabled. <a href="#aa23c6db155044c4f2c49269a874dd5cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a77351279e0927eb204ffebbc95d0cd79">titleBar</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the dialog title bar container. <a href="#a77351279e0927eb204ffebbc95d0cd79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a10f2f5df7ee5762845bf7ba334f170ae">contents</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the dialog contents container. <a href="#a10f2f5df7ee5762845bf7ba334f170ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968">exec</a> (const <a class="el" href="classWt_1_1WAnimation.html">WAnimation</a> &animation=<a class="el" href="classWt_1_1WAnimation.html">WAnimation</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Executes the dialog in a recursive event loop. <a href="#aca20cf1a63cf08402f4c03c943e0c968"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08">done</a> (<a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> r)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops the dialog. <a href="#a8d0a8725d03e5d7d144ef015983a8d08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288">accept</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the dialog, with result is Accepted. <a href="#afab6f75ebb2d2970ebe0bbf1cf19f288"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062">reject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the dialog, with result is Rejected. <a href="#afcff2ea14c4ae79b2fc7bac1a86b0062"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a7db347dd52c9d487a5e007ebaa664285">rejectWhenEscapePressed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lets pressing the escape key reject the dialog. <a href="#a7db347dd52c9d487a5e007ebaa664285"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< <a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ae7f3991e5adf17ec4e9e93fd8a3a2f79">finished</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal emitted when the dialog is closed. <a href="#ae7f3991e5adf17ec4e9e93fd8a3a2f79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a469ba179a2d620e2f7f6e0142f891c27">result</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the result that was set for this dialog. <a href="#a469ba179a2d620e2f7f6e0142f891c27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#acc8c9734f33b405bf0a706fe2f6e4e05">setModal</a> (bool modal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the dialog is modal. <a href="#acc8c9734f33b405bf0a706fe2f6e4e05"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a3ded330bb27133ac59ec8d8f0e7a1bcf">isModal</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the dialog is modal. <a href="#a3ded330bb27133ac59ec8d8f0e7a1bcf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a0a3517bffbd049b988e80bb85ae18c46">setResizable</a> (bool resizable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a resize handle to the dialog. <a href="#a0a3517bffbd049b988e80bb85ae18c46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a672ec5a8934fd097dd534ea8729163a2">resizable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the dialog has a resize handle. <a href="#a672ec5a8934fd097dd534ea8729163a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#afe7c5f57ddb5fd1bc67334c931401e98">setClosable</a> (bool closable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a close button to the titlebar. <a href="#afe7c5f57ddb5fd1bc67334c931401e98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac10a3465edab4c7923889cd3767c0c1a"></a><!-- doxytag: member="Wt::WDialog::closable" ref="ac10a3465edab4c7923889cd3767c0c1a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ac10a3465edab4c7923889cd3767c0c1a">closable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the dialog can be closed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#a3a7d93ea045031cbfd3d8be3c1fe294c">setHidden</a> (bool hidden, const <a class="el" href="classWt_1_1WAnimation.html">WAnimation</a> &animation=<a class="el" href="classWt_1_1WAnimation.html">WAnimation</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hides or shows the widget. <a href="#a3a7d93ea045031cbfd3d8be3c1fe294c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ac4c7bf687dc714ede0b39fdc9af6c66f">positionAt</a> (const <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *widget, <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation=Vertical)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Positions a widget next to another widget. <a href="#ac4c7bf687dc714ede0b39fdc9af6c66f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDialog.html#ac55f7dd6e3b22487b83b4d62f9ff8558">setMaximumSize</a> (const <a class="el" href="classWt_1_1WLength.html">WLength</a> &width, const <a class="el" href="classWt_1_1WLength.html">WLength</a> &height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a maximum size. <a href="#ac55f7dd6e3b22487b83b4d62f9ff8558"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A WDialog shows a dialog. </p>
<p>By default, the dialog is <em>modal</em>. 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).</p>
<p>A modal dialog can be instantiated synchronously or asynchronously. A non-modal dialog can only be instantiated asynchronously.</p>
<p>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 <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a>, <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> or <a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done()</a> (or connecting a signal to one of these methods). This will hide the dialog and emit the <a class="el" href="classWt_1_1WDialog.html#ae7f3991e5adf17ec4e9e93fd8a3a2f79" title="Signal emitted when the dialog is closed.">finished()</a> 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 <a class="el" href="classWt_1_1WWidget.html#a52dcef5a385ddfa0a8c3e6c20000f181" title="Shows the widget.">show()</a> or setHidden(true) to show the dialog.</p>
<p>The synchronous use of a dialog involves a call to <a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968" title="Executes the dialog in a recursive event loop.">exec()</a> 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 <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a>, and in some cases a Cancel button to <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a>. 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 <a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968" title="Executes the dialog in a recursive event loop.">exec()</a> 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 <a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968" title="Executes the dialog in a recursive event loop.">exec()</a>, 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).</p>
<p>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.</p>
<p>Contents for the dialog is defined by adding it to the <a class="el" href="classWt_1_1WDialog.html#a10f2f5df7ee5762845bf7ba334f170ae" title="Returns the dialog contents container.">contents()</a> widget.</p>
<p>Usage example, using the <a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968" title="Executes the dialog in a recursive event loop.">exec()</a> method (not recommended): </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WDialog.html" title="A WDialog shows a dialog.">Wt::WDialog</a> dialog(<span class="stringliteral">"Personalia"</span>);
<span class="keyword">new</span> <a class="code" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">Wt::WText</a>(<span class="stringliteral">"Enter your name: "</span>, dialog.contents());
<a class="code" href="classWt_1_1WLineEdit.html" title="A widget that provides a single line edit.">Wt::WLineEdit</a> edit(dialog.contents());
<span class="keyword">new</span> <a class="code" href="classWt_1_1WBreak.html" title="A widget that provides a line break between inline widgets.">Wt::WBreak</a>(dialog.contents());
<a class="code" href="classWt_1_1WPushButton.html" title="A widget that represents a push button.">Wt::WPushButton</a> ok(<span class="stringliteral">"Ok"</span>, dialog.contents());
<span class="comment">// these events will accept() the Dialog</span>
edit.<a class="code" href="classWt_1_1WInteractWidget.html#a38f06d1ad95e7599b055f49931236c10" title="Event signal emitted when enter was pressed.">enterPressed</a>().connect(&dialog, &<a class="code" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">Wt::WDialog::accept</a>);
ok.clicked().connect(&dialog, &<a class="code" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">Wt::WDialog::accept</a>);
<span class="keywordflow">if</span> (dialog.exec() == <a class="code" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6ad4852d715c07070ca1b117cb7e263840" title="Dialog closed with accept()">Wt::WDialog::Accepted</a>)
setStatus(<span class="stringliteral">"Welcome, "</span> + edit.text());
</pre></div><p>Usage example, using the asynchronous method (recommended): </p>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> MyClass::showDialog()
{
dialog_ = <span class="keyword">new</span> <a class="code" href="classWt_1_1WDialog.html#ab31907fa4f641192b2720ba735226d58" title="Constructs a WDialog with a given window title.">WDialog</a>(<span class="stringliteral">"Personalia"</span>);
<span class="keyword">new</span> <a class="code" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">Wt::WText</a>(<span class="stringliteral">"Enter your name: "</span>, dialog_->contents());
<a class="code" href="classWt_1_1WLineEdit.html" title="A widget that provides a single line edit.">Wt::WLineEdit</a> *edit = <span class="keyword">new</span> <a class="code" href="classWt_1_1WLineEdit.html" title="A widget that provides a single line edit.">Wt::WLineEdit</a>(dialog_->contents());
<span class="keyword">new</span> <a class="code" href="classWt_1_1WBreak.html" title="A widget that provides a line break between inline widgets.">Wt::WBreak</a>(dialog_->contents());
<a class="code" href="classWt_1_1WPushButton.html" title="A widget that represents a push button.">Wt::WPushButton</a> *ok = <span class="keyword">new</span> <a class="code" href="classWt_1_1WPushButton.html" title="A widget that represents a push button.">Wt::WPushButton</a>(<span class="stringliteral">"Ok"</span>, dialog_->contents());
<span class="comment">// these events will accept() the Dialog</span>
edit-><a class="code" href="classWt_1_1WInteractWidget.html#a38f06d1ad95e7599b055f49931236c10" title="Event signal emitted when enter was pressed.">enterPressed</a>().connect(dialog_, &<a class="code" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">Wt::WDialog::accept</a>);
ok->clicked().connect(dialog_, &<a class="code" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">Wt::WDialog::accept</a>);
dialog_->finished().connect(<span class="keyword">this</span>, &MyClass::dialogDone);
dialog_->show();
}
<span class="keywordtype">void</span> MyClass::dialogDone(<a class="code" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6" title="The result of a modal dialog execution.">DialogCode</a> code)
{
<span class="keywordflow">if</span> (code == <a class="code" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6ad4852d715c07070ca1b117cb7e263840" title="Dialog closed with accept()">Wt::WDialog::Accepted</a>)
setStatus(<span class="stringliteral">"Welcome, "</span> + edit_->text());
<span class="keyword">delete</span> dialog_;
}
</pre></div><p>This dialog looks like this (using the standard look):</p>
<table border="0" align="center">
<tr>
<td><div class="image">
<img src="WDialog-default-1.png" alt="WDialog-default-1.png"/>
<div class="caption">
A simple custom dialog (default)</div></div>
</td><td><div class="image">
<img src="WDialog-polished-1.png" alt="WDialog-polished-1.png"/>
<div class="caption">
A simple custom dialog (polished)</div></div>
</td></tr>
</table>
<h3>CSS</h3>
<p>A dialog has the <code>Wt-dialog</code> and <code>Wt-outset</code> style classes. The look can be overridden using the following style class selectors:</p>
<div class="fragment"><pre class="fragment">
.Wt-dialog .titlebar : The title bar
.Wt-dialog .body : The body (requires vertical padding 4px).
</pre></div><dl class="note"><dt><b>Note:</b></dt><dd>For the dialog (or rather, the silkscreen covering the user interface below) to render properly in IE, the "html body" margin is set to 0 (if it wasn't already). </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a6f4bab24bf9e39be422bb6d9637268e6"></a><!-- doxytag: member="Wt::WDialog::DialogCode" ref="a6f4bab24bf9e39be422bb6d9637268e6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">Wt::WDialog::DialogCode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The result of a modal dialog execution. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a6f4bab24bf9e39be422bb6d9637268e6a8279eafdc9665e6c91d98d2b512a962c"></a><!-- doxytag: member="Rejected" ref="a6f4bab24bf9e39be422bb6d9637268e6a8279eafdc9665e6c91d98d2b512a962c" args="" -->Rejected</em> </td><td>
<p>Dialog closed with <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a6f4bab24bf9e39be422bb6d9637268e6ad4852d715c07070ca1b117cb7e263840"></a><!-- doxytag: member="Accepted" ref="a6f4bab24bf9e39be422bb6d9637268e6ad4852d715c07070ca1b117cb7e263840" args="" -->Accepted</em> </td><td>
<p>Dialog closed with <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a> </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab31907fa4f641192b2720ba735226d58"></a><!-- doxytag: member="Wt::WDialog::WDialog" ref="ab31907fa4f641192b2720ba735226d58" args="(const WString &windowTitle=WString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WDialog::WDialog </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>windowTitle</em> = <code><a class="el" href="classWt_1_1WString.html">WString</a>()</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a WDialog with a given window title. </p>
<p>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. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afab6f75ebb2d2970ebe0bbf1cf19f288"></a><!-- doxytag: member="Wt::WDialog::accept" ref="afab6f75ebb2d2970ebe0bbf1cf19f288" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::accept </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the dialog, with result is Accepted. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done(DialogCode r)</a>, <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af56bc5d90c6da742faa454ddfed4ce00"></a><!-- doxytag: member="Wt::WDialog::caption" ref="af56bc5d90c6da742faa454ddfed4ce00" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WDialog::caption </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the dialog caption (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000026">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WDialog.html#acf71bbc665dff57a7af201b4f32f59f8" title="Returns the dialog window title.">windowTitle()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a10f2f5df7ee5762845bf7ba334f170ae"></a><!-- doxytag: member="Wt::WDialog::contents" ref="a10f2f5df7ee5762845bf7ba334f170ae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a>* Wt::WDialog::contents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the dialog contents container. </p>
<p>Content to the dialog window may be added to this container widget. </p>
</div>
</div>
<a class="anchor" id="a8d0a8725d03e5d7d144ef015983a8d08"></a><!-- doxytag: member="Wt::WDialog::done" ref="a8d0a8725d03e5d7d144ef015983a8d08" args="(DialogCode r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> </td>
<td class="paramname"><em>r</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stops the dialog. </p>
<p>Sets the dialog result, and emits the <a class="el" href="classWt_1_1WDialog.html#ae7f3991e5adf17ec4e9e93fd8a3a2f79" title="Signal emitted when the dialog is closed.">finished()</a> signal.</p>
<p>If a recursive event loop was started using the <a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968" title="Executes the dialog in a recursive event loop.">exec()</a> method, it is ended.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#ae7f3991e5adf17ec4e9e93fd8a3a2f79" title="Signal emitted when the dialog is closed.">finished()</a>, <a class="el" href="classWt_1_1WDialog.html#a469ba179a2d620e2f7f6e0142f891c27" title="Returns the result that was set for this dialog.">result()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aca20cf1a63cf08402f4c03c943e0c968"></a><!-- doxytag: member="Wt::WDialog::exec" ref="aca20cf1a63cf08402f4c03c943e0c968" args="(const WAnimation &animation=WAnimation())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">WDialog::DialogCode</a> Wt::WDialog::exec </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WAnimation.html">WAnimation</a> & </td>
<td class="paramname"><em>animation</em> = <code><a class="el" href="classWt_1_1WAnimation.html">WAnimation</a>()</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Executes the dialog in a recursive event loop. </p>
<p>Executes the dialog synchronously. This blocks the current thread of execution until one of <a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done(DialogCode)</a>, <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a> or <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> is called.</p>
<p><em>Warning: using <a class="el" href="classWt_1_1WDialog.html#aca20cf1a63cf08402f4c03c943e0c968" title="Executes the dialog in a recursive event loop.">exec()</a> 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.</em></p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done(DialogCode r)</a>, <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a>, <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae7f3991e5adf17ec4e9e93fd8a3a2f79"></a><!-- doxytag: member="Wt::WDialog::finished" ref="ae7f3991e5adf17ec4e9e93fd8a3a2f79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a><<a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a>>& Wt::WDialog::finished </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal emitted when the dialog is closed. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done(DialogCode r)</a>, <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a>, <a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3ded330bb27133ac59ec8d8f0e7a1bcf"></a><!-- doxytag: member="Wt::WDialog::isModal" ref="a3ded330bb27133ac59ec8d8f0e7a1bcf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WDialog::isModal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the dialog is modal. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#acc8c9734f33b405bf0a706fe2f6e4e05" title="Sets whether the dialog is modal.">setModal()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa23c6db155044c4f2c49269a874dd5cb"></a><!-- doxytag: member="Wt::WDialog::isTitleBarEnabled" ref="aa23c6db155044c4f2c49269a874dd5cb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WDialog::isTitleBarEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the title bar is enabled. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#ab8ae8763648de12a67ada4b8237154a9" title="Enables or disables the title bar.">setTitleBarEnabled()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac4c7bf687dc714ede0b39fdc9af6c66f"></a><!-- doxytag: member="Wt::WDialog::positionAt" ref="ac4c7bf687dc714ede0b39fdc9af6c66f" args="(const WWidget *widget, Orientation orientation=Vertical)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::positionAt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"><em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td>
<td class="paramname"><em>orientation</em> = <code>Vertical</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Positions a widget next to another widget. </p>
<p>Positions this absolutely positioned widget next to another <code>widget</code>. Both widgets must be visible.</p>
<p>When <code>orientation</code> = <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912af916b7ec24727db2d972f0770170c7f5" title="Vertical.">Wt::Vertical</a>, 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).</p>
<p>Conversely, when <code>orientation</code> = <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912ac2ebf22b096a22b18eef23e736aa2e28" title="Horizontal.">Wt::Horizontal</a>, 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).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This only works if JavaScript is available. </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WWidget.html#aef120ad789aec5ee406c2e312efeb4b5">Wt::WWidget</a>.</p>
</div>
</div>
<a class="anchor" id="afcff2ea14c4ae79b2fc7bac1a86b0062"></a><!-- doxytag: member="Wt::WDialog::reject" ref="afcff2ea14c4ae79b2fc7bac1a86b0062" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::reject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the dialog, with result is Rejected. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done(DialogCode r)</a>, <a class="el" href="classWt_1_1WDialog.html#afab6f75ebb2d2970ebe0bbf1cf19f288" title="Closes the dialog, with result is Accepted.">accept()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7db347dd52c9d487a5e007ebaa664285"></a><!-- doxytag: member="Wt::WDialog::rejectWhenEscapePressed" ref="a7db347dd52c9d487a5e007ebaa664285" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::rejectWhenEscapePressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lets pressing the escape key reject the dialog. </p>
<p>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.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#afcff2ea14c4ae79b2fc7bac1a86b0062" title="Closes the dialog, with result is Rejected.">reject()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a672ec5a8934fd097dd534ea8729163a2"></a><!-- doxytag: member="Wt::WDialog::resizable" ref="a672ec5a8934fd097dd534ea8729163a2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WDialog::resizable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the dialog has a resize handle. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#a0a3517bffbd049b988e80bb85ae18c46" title="Adds a resize handle to the dialog.">setResizable()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a469ba179a2d620e2f7f6e0142f891c27"></a><!-- doxytag: member="Wt::WDialog::result" ref="a469ba179a2d620e2f7f6e0142f891c27" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WDialog.html#a6f4bab24bf9e39be422bb6d9637268e6">DialogCode</a> Wt::WDialog::result </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the result that was set for this dialog. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#a8d0a8725d03e5d7d144ef015983a8d08" title="Stops the dialog.">done(DialogCode r)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a626d5109624e7442f9a96310b6919a5a"></a><!-- doxytag: member="Wt::WDialog::setCaption" ref="a626d5109624e7442f9a96310b6919a5a" args="(const WString &caption)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setCaption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>caption</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the dialog caption (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000025">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WDialog.html#ae0923afc12895002f30b8ee12ab91aae" title="Sets the dialog window title.">setWindowTitle()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="afe7c5f57ddb5fd1bc67334c931401e98"></a><!-- doxytag: member="Wt::WDialog::setClosable" ref="afe7c5f57ddb5fd1bc67334c931401e98" args="(bool closable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setClosable </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>closable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a close button to the titlebar. </p>
<p>The close button is shown in the title bar. Clicking the close button will reject the dialog. </p>
</div>
</div>
<a class="anchor" id="a3a7d93ea045031cbfd3d8be3c1fe294c"></a><!-- doxytag: member="Wt::WDialog::setHidden" ref="a3a7d93ea045031cbfd3d8be3c1fe294c" args="(bool hidden, const WAnimation &animation=WAnimation())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setHidden </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hidden</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WAnimation.html">WAnimation</a> & </td>
<td class="paramname"><em>animation</em> = <code><a class="el" href="classWt_1_1WAnimation.html">WAnimation</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hides or shows the widget. </p>
<p>Hides or show the widget (including all its descendant widgets). When setting <code>hidden</code> = <code>false</code>, 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 <a class="el" href="classWt_1_1WCompositeWidget.html#a1ae4501ce5807c22b71532d9fd564337" title="Returns whether the widget is visible.">isVisible()</a>. </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WCompositeWidget.html#a2c905ba0dd649609a6a29b89b3438e1b">Wt::WCompositeWidget</a>.</p>
</div>
</div>
<a class="anchor" id="ac55f7dd6e3b22487b83b4d62f9ff8558"></a><!-- doxytag: member="Wt::WDialog::setMaximumSize" ref="ac55f7dd6e3b22487b83b4d62f9ff8558" args="(const WLength &width, const WLength &height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setMaximumSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WLength.html">WLength</a> & </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WLength.html">WLength</a> & </td>
<td class="paramname"><em>height</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a maximum size. </p>
<p>Specifies a maximum size for this widget, setting CSS <code>max-width</code> and <code>max-height</code> properties.</p>
<p>The default the maximum width and height are <a class="el" href="classWt_1_1WLength.html#a0cf39ca4225776879d56ade60320c31a" title="An 'auto' length.">WLength::Auto</a>, indicating no maximum size. A <a class="el" href="classWt_1_1WLength.html#a908caf5d6be7e244e24598e6d22cd4c0a304d9ef07db638690997830a7b348db1" title="Percentage (meaning context-sensitive)">WLength::Percentage</a> size should not be used, as this is (in virtually all cases) undefined behaviour.</p>
<p>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.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WCompositeWidget.html#a976e94e38c7a9cc0f212e13a9792912e" title="Resizes the widget.">resize()</a>, <a class="el" href="classWt_1_1WCompositeWidget.html#acf95c795e47eee85425c98509aa8e57a" title="Sets a minimum size.">setMinimumSize()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WCompositeWidget.html#a7ba5622622b118e72b9a407d10df7ece">Wt::WCompositeWidget</a>.</p>
</div>
</div>
<a class="anchor" id="acc8c9734f33b405bf0a706fe2f6e4e05"></a><!-- doxytag: member="Wt::WDialog::setModal" ref="acc8c9734f33b405bf0a706fe2f6e4e05" args="(bool modal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setModal </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>modal</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the dialog is modal. </p>
<p>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.</p>
<p>By default a dialog is modal. </p>
</div>
</div>
<a class="anchor" id="a0a3517bffbd049b988e80bb85ae18c46"></a><!-- doxytag: member="Wt::WDialog::setResizable" ref="a0a3517bffbd049b988e80bb85ae18c46" args="(bool resizable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setResizable </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>resizable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a resize handle to the dialog. </p>
<p>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).</p>
<p>This also sets the minimum width and height to <a class="el" href="classWt_1_1WLength.html#a0cf39ca4225776879d56ade60320c31a" title="An 'auto' length.">WLength::Auto</a> 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.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WCompositeWidget.html#acf95c795e47eee85425c98509aa8e57a" title="Sets a minimum size.">setMinimumSize()</a>, <a class="el" href="classWt_1_1WDialog.html#ac55f7dd6e3b22487b83b4d62f9ff8558" title="Sets a maximum size.">setMaximumSize()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab8ae8763648de12a67ada4b8237154a9"></a><!-- doxytag: member="Wt::WDialog::setTitleBarEnabled" ref="ab8ae8763648de12a67ada4b8237154a9" args="(bool enabled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setTitleBarEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables or disables the title bar. </p>
<p>The titlebar is enabled by default. </p>
</div>
</div>
<a class="anchor" id="ae0923afc12895002f30b8ee12ab91aae"></a><!-- doxytag: member="Wt::WDialog::setWindowTitle" ref="ae0923afc12895002f30b8ee12ab91aae" args="(const WString &title)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WDialog::setWindowTitle </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>title</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the dialog window title. </p>
<p>The window title is displayed in the title bar.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#ab8ae8763648de12a67ada4b8237154a9" title="Enables or disables the title bar.">setTitleBarEnabled()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a77351279e0927eb204ffebbc95d0cd79"></a><!-- doxytag: member="Wt::WDialog::titleBar" ref="a77351279e0927eb204ffebbc95d0cd79" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a>* Wt::WDialog::titleBar </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the dialog title bar container. </p>
<p>The title bar contains a single text that contains the caption. You may customize the title bar by for example adding other content. </p>
</div>
</div>
<a class="anchor" id="acf71bbc665dff57a7af201b4f32f59f8"></a><!-- doxytag: member="Wt::WDialog::windowTitle" ref="acf71bbc665dff57a7af201b4f32f59f8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WDialog::windowTitle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the dialog window title. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WDialog.html#ae0923afc12895002f30b8ee12ab91aae" title="Sets the dialog window title.">setWindowTitle()</a> </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
