<!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::WApplication 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_1WApplication.html">WApplication</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WApplication Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WApplication" --><!-- doxytag: inherits="Wt::WObject" -->
<p>Represents an application instance for a single session.
<a href="classWt_1_1WApplication.html#details">More...</a></p>
<p><code>#include <Wt/WApplication></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WApplication:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WApplication__inherit__graph.png" border="0" usemap="#Wt_1_1WApplication_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WApplication_inherit__map" id="Wt_1_1WApplication_inherit__map">
<area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="19,5,115,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WApplication-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication_1_1UpdateLock.html">UpdateLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A RAII lock for manipulating and updating the application and its widgets outside of the event loop. <a href="classWt_1_1WApplication_1_1UpdateLock.html#details">More...</a><br/></td></tr>
<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_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">AjaxMethod</a> { <a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12aa9dc5b270e2b5c180556fb688cd8f06c2">XMLHttpRequest</a>,
<a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12aa66ad42375422870da68e3666a1712d39">DynamicScriptTag</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration that indicates the method for dynamic (AJAX-alike) updates ((<b>deprecated</b>). <a href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef Wt::ApplicationCreator </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a28b5dd3d1272f46fbacbfb21a0846d07">ApplicationCreator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Typedef for a function that creates <a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">WApplication</a> objects. <a href="#a28b5dd3d1272f46fbacbfb21a0846d07"></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_1WApplication.html#ae29a843f4d50159b17abfa9503c389db">WApplication</a> (const <a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a> &environment)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new application instance. <a href="#ae29a843f4d50159b17abfa9503c389db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ad0d9408ddc0fda917235d8416da3777f">~WApplication</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad0d9408ddc0fda917235d8416da3777f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a19f3b913f4bc2f69761d9a3738bf142b">environment</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the environment information. <a href="#a19f3b913f4bc2f69761d9a3738bf142b"></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_1WApplication.html#a17e118a04d962459484a12989a80bc05">root</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the root container. <a href="#a17e118a04d962459484a12989a80bc05"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a0363c673fdb4e3f2be6068c5c1139b69">findWidget</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds a widget by name. <a href="#a0363c673fdb4e3f2be6068c5c1139b69"></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_1WApplication.html#a71a3f7da5abb9a76df94fab69ba61670">setTitle</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 window title. <a href="#a71a3f7da5abb9a76df94fab69ba61670"></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_1WApplication.html#a86aefff2a3438fecdfde3e0e7dd6e5da">title</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the window title. <a href="#a86aefff2a3438fecdfde3e0e7dd6e5da"></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_1WApplication.html#af6e54918b88587438327464c98eecf5c">closeMessage</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the close message. <a href="#af6e54918b88587438327464c98eecf5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WLocalizedStrings.html">WLocalizedStrings</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0">localizedStrings</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the resource object that provides localized strings. <a href="#abcbace5a9e38947bf036ae86fb3438c0"></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_1WApplication.html#a1039775b5a73ff2efc34a482ebd112a8">setLocalizedStrings</a> (<a class="el" href="classWt_1_1WLocalizedStrings.html">WLocalizedStrings</a> *stringResolver)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the resource object that provides localized strings. <a href="#a1039775b5a73ff2efc34a482ebd112a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WMessageResourceBundle.html">WMessageResourceBundle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a4f304244f6bc75be6cd5f41798ea5e2e">messageResourceBundle</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the message resource bundle. <a href="#a4f304244f6bc75be6cd5f41798ea5e2e"></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_1WApplication.html#a5c9cc1350019d69f154a2b44cdaf2596">setLocale</a> (const std::string &locale)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the locale. <a href="#a5c9cc1350019d69f154a2b44cdaf2596"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a6e782f1f38a6f56e2024aab1a917a80b">locale</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current locale. <a href="#a6e782f1f38a6f56e2024aab1a917a80b"></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_1WApplication.html#a02b9d8aa1b6c2d0dc9edc1b9c63f86dc">refresh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Refreshes the application. <a href="#a02b9d8aa1b6c2d0dc9edc1b9c63f86dc"></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_1WApplication.html#aba49e1b9e696ac7244f5e2b63ca07de5">bindWidget</a> (<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *widget, const std::string &domId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a top-level widget for a WidgetSet deployment. <a href="#aba49e1b9e696ac7244f5e2b63ca07de5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a52684c8637c81c626b607ed802f7d19e">docRoot</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server document root. <a href="#a52684c8637c81c626b607ed802f7d19e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ab55c625a3197fec416544be8ad1529af">sessionId</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the unique identifier for the current session. <a href="#ab55c625a3197fec416544be8ad1529af"></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_1WApplication.html#a4b0bc73bab1132f17c13f5e731068446">changeSessionId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the session id. <a href="#a4b0bc73bab1132f17c13f5e731068446"></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_1WApplication.html#a48ceb7972ef7ec0e557adf441f660f2f">processEvents</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Processes UI events. <a href="#a48ceb7972ef7ec0e557adf441f660f2f"></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_1WApplication.html#af2b590f865a4a6a6b144c45682b4bc1a">setAjaxMethod</a> (<a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">AjaxMethod</a> method)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the Ajax communication method (<b>deprecated</b>). <a href="#af2b590f865a4a6a6b144c45682b4bc1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">AjaxMethod</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a10cd5e55a610b7f6587c881a2c35188c">ajaxMethod</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the Ajax communication method (<b>deprecated</b>). <a href="#a10cd5e55a610b7f6587c881a2c35188c"></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_1WApplication.html#a42fc7f65116073d4032573f1e42c1173">initialize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the application, post-construction. <a href="#a42fc7f65116073d4032573f1e42c1173"></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_1WApplication.html#a10317a8a50dc95db9b27ad54409ab39f">finalize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the application, pre-destruction. <a href="#a10317a8a50dc95db9b27ad54409ab39f"></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_1WApplication.html#a63d991e268c9af8898329217a1242563">setTwoPhaseRenderingThreshold</a> (int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the threshold for two-phase rendering. <a href="#a63d991e268c9af8898329217a1242563"></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_1WApplication.html#a5d10106d4131611aa98e20e6a82b3c40">setCookie</a> (const std::string &name, const std::string &value, int maxAge, const std::string &domain="", const std::string &path="", bool secure=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a new cookie. <a href="#a5d10106d4131611aa98e20e6a82b3c40"></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_1WApplication.html#a250fcc8a0959f2fe159ea10d22b552f9">removeCookie</a> (const std::string &name, const std::string &domain="", const std::string &path="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a cookie. <a href="#a250fcc8a0959f2fe159ea10d22b552f9"></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_1WApplication.html#a976f8a7f160fefc9d3f24a2b482f5c9a">addMetaLink</a> (const std::string &href, const std::string &rel, const std::string &media, const std::string &hreflang, const std::string &type, const std::string &sizes, bool disabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an HTML meta link. <a href="#a976f8a7f160fefc9d3f24a2b482f5c9a"></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_1WApplication.html#a1febcb091c5f02602fac121741ee063e">removeMetaLink</a> (const std::string &href)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the HTML meta link. <a href="#a1febcb091c5f02602fac121741ee063e"></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_1WApplication.html#abb9103bc749dac6942649ea693dc9a3d">addMetaHeader</a> (const std::string &name, const <a class="el" href="classWt_1_1WString.html">WString</a> &content, const std::string &lang="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an HTML meta header. <a href="#abb9103bc749dac6942649ea693dc9a3d"></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_1WApplication.html#a149412d829d104621c445bc10604be53">addMetaHeader</a> (<a class="el" href="namespaceWt.html#a9d76d7ac3eb4b1005a35fdc1500c0dcb">MetaHeaderType</a> type, const std::string &name, const <a class="el" href="classWt_1_1WString.html">WString</a> &content, const std::string &lang="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an HTML meta header. <a href="#a149412d829d104621c445bc10604be53"></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_1WApplication.html#a14fd608fd7d4079355f65b315e66a63f">removeMetaHeader</a> (<a class="el" href="namespaceWt.html#a9d76d7ac3eb4b1005a35fdc1500c0dcb">MetaHeaderType</a> type, const std::string &name="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes one or all meta headers. <a href="#a14fd608fd7d4079355f65b315e66a63f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WLogEntry.html">WLogEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a75067771ba8fcc56e174f2e741ce278f">log</a> (const std::string &type) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an entry to the application log. <a href="#a75067771ba8fcc56e174f2e741ce278f"></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_1WApplication.html#a080d01aa8e92ae57ef9c9491d33a7fca">setLoadingIndicator</a> (<a class="el" href="classWt_1_1WLoadingIndicator.html">WLoadingIndicator</a> *indicator)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the loading indicator. <a href="#a080d01aa8e92ae57ef9c9491d33a7fca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WLoadingIndicator.html">WLoadingIndicator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a435c81aaee5f9d0993b329d2541ee21a">loadingIndicator</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the loading indicator. <a href="#a435c81aaee5f9d0993b329d2541ee21a"></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_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7">quit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Quits the application. <a href="#a5231d54ed34982f4366058eb6440c8f7"></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_1WApplication.html#aca61c7262e83de25c276021b26b53074">isQuited</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the application has quit. (<b>deprecated</b>) <a href="#aca61c7262e83de25c276021b26b53074"></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_1WApplication.html#ab78b78e56a1f53cfdbe1a59c3112ce31">hasQuit</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the application has quit. <a href="#ab78b78e56a1f53cfdbe1a59c3112ce31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">::int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#aa6a98202fb6d4aa1214ab3dbe7784416">maximumRequestSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current maximum size of a request to the application. <a href="#aa6a98202fb6d4aa1214ab3dbe7784416"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< ::int64_t > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a5ebdb82053d80b17d5ac7affd8dc7fa2">requestTooLarge</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal which indicates that too a large request was received. <a href="#a5ebdb82053d80b17d5ac7affd8dc7fa2"></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_1WApplication.html#a506978cfb884af4bc6ffd5a5bc8476d6">setConfirmCloseMessage</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the message for the user to confirm closing of the application window/tab. <a href="#a506978cfb884af4bc6ffd5a5bc8476d6"></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_1WApplication.html#af6a25f56ab9d309d799012faf8823f48">deferRendering</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Defers rendering of the current event response. <a href="#af6a25f56ab9d309d799012faf8823f48"></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_1WApplication.html#a62dfa943a37a250ec781e9019ccd7434">resumeRendering</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resumes rendering of a deferred event response. <a href="#a62dfa943a37a250ec781e9019ccd7434"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename F > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">boost::function< void()> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#aae1c2ee7c4dd469eb83299524ac0e7ee">bind</a> (const F &f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Protects a function against deletion of the target object. <a href="#aae1c2ee7c4dd469eb83299524ac0e7ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a62899f99ccfc2b28c9ff492942c8814d">encodeUntrustedUrl</a> (const std::string &url) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encodes an untrusted URL to prevent referer leaks. <a href="#a62899f99ccfc2b28c9ff492942c8814d"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Style sheets and CSS</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WCssStyleSheet.html">WCssStyleSheet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a6a9a20d65ce9e7c2f62b27387c94e10d">styleSheet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the inline style sheet. <a href="#a6a9a20d65ce9e7c2f62b27387c94e10d"></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_1WApplication.html#af377d541443b4bcea5fcc40be7c70173">useStyleSheet</a> (const std::string &url)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an external style sheet. <a href="#af377d541443b4bcea5fcc40be7c70173"></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_1WApplication.html#a4a72348400d52ca0cf09b57a24577838">useStyleSheet</a> (const std::string &url, const std::string &condition, const std::string &media="all")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an external style sheet, constrained with conditions. <a href="#a4a72348400d52ca0cf09b57a24577838"></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_1WApplication.html#aa316b2b30a6191085f265974b66e55bb">setCssTheme</a> (const std::string &theme)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the theme. <a href="#aa316b2b30a6191085f265974b66e55bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a0e09381079f67501e38652087232969d">cssTheme</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the theme. <a href="#a0e09381079f67501e38652087232969d"></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_1WApplication.html#a44c5f0398b5539269be3961b26e95b08">setLayoutDirection</a> (<a class="el" href="namespaceWt.html#a23d3bcd7b697ff12d031b2d232f8704a">LayoutDirection</a> direction)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the layout direction. <a href="#a44c5f0398b5539269be3961b26e95b08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceWt.html#a23d3bcd7b697ff12d031b2d232f8704a">LayoutDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a5a9dd0bee018560417a7b7b43b7e42fc">layoutDirection</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the layout direction. <a href="#a5a9dd0bee018560417a7b7b43b7e42fc"></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_1WApplication.html#aa8fe83406981a556da61a843bb691674">setBodyClass</a> (const std::string &styleClass)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a style class to the entire page <body>. <a href="#aa8fe83406981a556da61a843bb691674"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a4e87d8f55211eb7f2fcea01ad956ea63">bodyClass</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the style class set for the entire page <body>. <a href="#a4e87d8f55211eb7f2fcea01ad956ea63"></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_1WApplication.html#a28867ea48711f9290de496c2ed42fdbf">setHtmlClass</a> (const std::string &styleClass)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a style class to the entire page <html>. <a href="#a28867ea48711f9290de496c2ed42fdbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a1324d7dd9b83e075d78a65ca8cde8c9b">htmlClass</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the style class set for the entire page <html>. <a href="#a1324d7dd9b83e075d78a65ca8cde8c9b"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">URLs and internal paths</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a5326831e30387099b5af76fe7a5cf213">url</a> (const std::string &internalPath=std::string()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#a5326831e30387099b5af76fe7a5cf213"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a1f31a52f8c8e4f250b5515c02bf9ee55">makeAbsoluteUrl</a> (const std::string &url) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes an absolute URL. <a href="#a1f31a52f8c8e4f250b5515c02bf9ee55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#afa5e8ff70f2f48dcd7f51e0e537cfc5b">resolveRelativeUrl</a> (const std::string &url) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">"Resolves" a relative URL taking into account internal paths. <a href="#afa5e8ff70f2f48dcd7f51e0e537cfc5b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1">bookmarkUrl</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a bookmarkable URL for the current internal path. <a href="#a37b4cf44f393688785ed3b34f53fead1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ac99ee110fd00d89de51e6e90ad166626">bookmarkUrl</a> (const std::string &internalPath) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a bookmarkable URL for a given internal path. <a href="#ac99ee110fd00d89de51e6e90ad166626"></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_1WApplication.html#a2c1a10aadc0d7ed877b5715b42ca4911">setInternalPath</a> (const std::string &path, bool emitChange=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the internal path. <a href="#a2c1a10aadc0d7ed877b5715b42ca4911"></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_1WApplication.html#ae641c0e2d82d21b0a4722129eea9ee76">setInternalPathDefaultValid</a> (bool valid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#ae641c0e2d82d21b0a4722129eea9ee76"></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_1WApplication.html#a9acc55756151112b00e2b34aee9ec0e9">internalPathDefaultValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#a9acc55756151112b00e2b34aee9ec0e9"></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_1WApplication.html#abd51dc659a0c68f51ed99eca1341ccb6">setInternalPathValid</a> (bool valid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#abd51dc659a0c68f51ed99eca1341ccb6"></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_1WApplication.html#a54a2dfa4924cf0294cff477a1863bf25">internalPathValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#a54a2dfa4924cf0294cff477a1863bf25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#aab6320ecdd0e8e4026e9ef1aca710ca5">internalPath</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current internal path. <a href="#aab6320ecdd0e8e4026e9ef1aca710ca5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a95e6b5e4dc9084d45e166264b10b3c46">internalPathNextPart</a> (const std::string &path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a part of the current internal path. <a href="#a95e6b5e4dc9084d45e166264b10b3c46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a55392ab234153cc66b667c39b57bc33b">internalSubPath</a> (const std::string &path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#a55392ab234153cc66b667c39b57bc33b"></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_1WApplication.html#aed54bd83339bc80b3cffba9067ab1e39">internalPathMatches</a> (const std::string &path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the internal path matches a given path. <a href="#aed54bd83339bc80b3cffba9067ab1e39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a674fd6a2522d66d07908e8f3d82424a9">internalPathChanged</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal which indicates that the user changes the internal path. <a href="#a674fd6a2522d66d07908e8f3d82424a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a490247b9593a6d989ba9cceb0eebe56b">internalPathInvalid</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a URL for the current session. <a href="#a490247b9593a6d989ba9cceb0eebe56b"></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_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18">redirect</a> (const std::string &url)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Redirects the application to another location. <a href="#a4dcbf69c8b09c301577b5b6aa8a4da18"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulation outside the main event loop</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ad9631ca64e68d30d40cb49c90e55223d">enableUpdates</a> (bool enabled=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables server-initiated updates. <a href="#ad9631ca64e68d30d40cb49c90e55223d"></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_1WApplication.html#a5a8e6970e9123fb1c23aa43711093135">updatesEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether server-initiated updates are enabled. <a href="#a5a8e6970e9123fb1c23aa43711093135"></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_1WApplication.html#a51f50e0641a6d702a7c6ab7f8dd5946a">triggerUpdate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Propagates server-initiated updates. <a href="#a51f50e0641a6d702a7c6ab7f8dd5946a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WApplication_1_1UpdateLock.html">UpdateLock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ac7582c37defc49b5e8d6ccbda3b68d45">getUpdateLock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grabs and returns the lock for manipulating widgets outside the event loop (<b>deprecated</b>). <a href="#ac7582c37defc49b5e8d6ccbda3b68d45"></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_1WApplication.html#a015a4c7613755699c393fb5dd0769038">attachThread</a> (bool attach=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach an auxiliary thread to this application. <a href="#a015a4c7613755699c393fb5dd0769038"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Invoking JavaScript or including scripts</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a2a92457b9212cef4057cb54e56183967">doJavaScript</a> (const std::string &javascript, bool afterLoaded=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Executes some JavaScript code. <a href="#a2a92457b9212cef4057cb54e56183967"></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_1WApplication.html#a412bcf9c269b097e7c372515e27b88ba">addAutoJavaScript</a> (const std::string &javascript)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds JavaScript statements that should be run continuously. <a href="#a412bcf9c269b097e7c372515e27b88ba"></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_1WApplication.html#a3456e2bd2eec561abb90ae19ae42be02">declareJavaScriptFunction</a> (const std::string &name, const std::string &function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Declares an application-wide JavaScript function. <a href="#a3456e2bd2eec561abb90ae19ae42be02"></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_1WApplication.html#ae88546224ed32cade783da188b145138">require</a> (const std::string &url, const std::string &symbol=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads a JavaScript library. <a href="#ae88546224ed32cade783da188b145138"></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_1WApplication.html#aa2add60804ff75b3798fc270050654c5">requireJQuery</a> (const std::string &url)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads a custom JQuery library. <a href="#aa2add60804ff75b3798fc270050654c5"></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_1WApplication.html#a790de918eb5f6b7e45bd30e4b886a583">customJQuery</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Executes some JavaScript code. <a href="#a790de918eb5f6b7e45bd30e4b886a583"></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_1WApplication.html#a800b4f49366fad5ed0db6c00ee3500b1">setJavaScriptClass</a> (const std::string &className)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the application JavaScript class. <a href="#a800b4f49366fad5ed0db6c00ee3500b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a6e0963307eb9367a3a4a3f4e35ae3abe">javaScriptClass</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the application JavaScript class. <a href="#a6e0963307eb9367a3a4a3f4e35ae3abe"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Global keyboard and mouse events</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>< <a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a0a9652fc0d0cbebca7966f98454b078a">globalKeyWentDown</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when a keyboard key is pushed down. <a href="#a0a9652fc0d0cbebca7966f98454b078a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>< <a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a7d8f807eee7191ae6b7f6f7fe2ab2fae">globalKeyPressed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when a "character" was entered. <a href="#a7d8f807eee7191ae6b7f6f7fe2ab2fae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>< <a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#aa2a569eabc35162f4b2a72c36a24cd80">globalKeyWentUp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when a keyboard key is released. <a href="#aa2a569eabc35162f4b2a72c36a24cd80"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a60c1defb57949f6f78c6c1373a18e74e">globalEnterPressed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when enter was pressed. <a href="#a60c1defb57949f6f78c6c1373a18e74e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ab4d42f698c48bf84fcc807cb597a0509">globalEscapePressed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when escape was pressed. <a href="#ab4d42f698c48bf84fcc807cb597a0509"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WApplication.html">WApplication</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6">instance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current application instance. <a href="#a38d922da0a0d83395519f3eaab85d0f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ac0fa2857a600cc34b3443a04d9ed5c5c">resourcesUrl</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the URL at which the resources are deployed. <a href="#ac0fa2857a600cc34b3443a04d9ed5c5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a88b082dadadd3fb7dbe10887e7d89c91">appRoot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the appRoot special property. <a href="#a88b082dadadd3fb7dbe10887e7d89c91"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#ac0f5599ed35eb159fa6912aa0ff3c75c">readConfigurationProperty</a> (const std::string &name, std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a configuration property. <a href="#ac0f5599ed35eb159fa6912aa0ff3c75c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a4a6f167bea94aefa8ba24f914c2fbee5">notify</a> (const <a class="el" href="classWt_1_1WEvent.html">WEvent</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notifies an event to the application. <a href="#a4a6f167bea94aefa8ba24f914c2fbee5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a17e25e84fab304664baab5b0c748b802">isExposed</a> (<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *w) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a widget is exposed in the interface. <a href="#a17e25e84fab304664baab5b0c748b802"></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_1WApplication.html#a78016406c4746c56b2c2ffce7c5e181f">enableAjax</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Progresses to an Ajax-enabled user interface. <a href="#a78016406c4746c56b2c2ffce7c5e181f"></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_1WApplication.html#a9a4048e01b69a536e35f47eb2a59a69b">unload</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles a browser unload event. <a href="#a9a4048e01b69a536e35f47eb2a59a69b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef boost::function<br class="typebreak"/>
< <a class="el" href="classWt_1_1WApplication.html">WApplication</a> *(const <br class="typebreak"/>
<a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WApplication.html#a3d36c49bb199ec88ad2d490124d62750">ApplicationCreator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Typedef for a function that creates <a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">WApplication</a> objects. <a href="#a3d36c49bb199ec88ad2d490124d62750"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents an application instance for a single session. </p>
<p>Each user session of your application has a corresponding WApplication instance. You need to create a new instance and return it as the result of the callback function passed to <a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun()</a>. The instance is the main entry point to session information, and holds a reference to the <a class="el" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">root()</a> of the widget tree.</p>
<p>The recipe for a Wt web application, which allocates new <a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">WApplication</a> instances for every user visiting the application is thus:</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html#ae29a843f4d50159b17abfa9503c389db" title="Creates a new application instance.">WApplication</a> *createApplication(<span class="keyword">const</span> WEnvironment WEnvironment& env)
{
<span class="comment">//</span>
<span class="comment">// Optionally, check the environment and redirect to an error page.</span>
<span class="comment">//</span>
<span class="keywordtype">bool</span> valid = ...;
<a class="code" href="classWt_1_1WApplication.html#ae29a843f4d50159b17abfa9503c389db" title="Creates a new application instance.">WApplication</a> *app;
<span class="keywordflow">if</span> (!valid) {
app = <span class="keyword">new</span> <a class="code" href="classWt_1_1WApplication.html#ae29a843f4d50159b17abfa9503c389db" title="Creates a new application instance.">WApplication</a>(env);
app->redirect(<span class="stringliteral">"error.html"</span>);
app->quit();
} <span class="keywordflow">else</span> {
<span class="comment">// usually you will specialize your application class</span>
app = <span class="keyword">new</span> <a class="code" href="classWt_1_1WApplication.html#ae29a843f4d50159b17abfa9503c389db" title="Creates a new application instance.">WApplication</a>(env);
<span class="comment">//</span>
<span class="comment">// Add widgets to app->root() and return the application object.</span>
<span class="comment">//</span>
}
<span class="keywordflow">return</span> app;
}
</pre></div><p>Throughout the session, the instance is available through <a class="el" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">WApplication::instance()</a> (or through #wApp). The application may be quited either using the method <a class="el" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">quit()</a>, or because of a timeout after the user has closed the window, but not because the user does not interact: keep-alive messages in the background will keep the session around as long as the user has the page opened. In either case, the application object is deleted, allowing for cleanup of the entire widget tree, and any other resources.</p>
<p>The WApplication object provides access to session-wide settings, including:</p>
<ul>
<li>circumstancial information through <a class="el" href="classWt_1_1WApplication.html#a19f3b913f4bc2f69761d9a3738bf142b" title="Returns the environment information.">environment()</a>, which gives details about the user, start-up arguments, and user agent capabilities.</li>
<li>the application title with <a class="el" href="classWt_1_1WApplication.html#a71a3f7da5abb9a76df94fab69ba61670" title="Sets the window title.">setTitle()</a>.</li>
<li>inline and external style sheets using <a class="el" href="classWt_1_1WApplication.html#a6a9a20d65ce9e7c2f62b27387c94e10d" title="Returns a reference to the inline style sheet.">styleSheet()</a> and <a class="el" href="classWt_1_1WApplication.html#af377d541443b4bcea5fcc40be7c70173" title="Adds an external style sheet.">useStyleSheet()</a>.</li>
<li>inline and external JavaScript using <a class="el" href="classWt_1_1WApplication.html#a2a92457b9212cef4057cb54e56183967" title="Executes some JavaScript code.">doJavaScript()</a> and <a class="el" href="classWt_1_1WApplication.html#ae88546224ed32cade783da188b145138" title="Loads a JavaScript library.">require()</a>.</li>
<li>the top-level widget in <a class="el" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">root()</a>, representing the entire browser window, or multiple top-level widgets using <a class="el" href="classWt_1_1WApplication.html#aba49e1b9e696ac7244f5e2b63ca07de5" title="Binds a top-level widget for a WidgetSet deployment.">bindWidget()</a> when deployed in WidgetSet mode to manage a number of widgets within a 3rd party page.</li>
<li>definition of cookies using <a class="el" href="classWt_1_1WApplication.html#a5d10106d4131611aa98e20e6a82b3c40" title="Sets a new cookie.">setCookie()</a> to persist information across sessions, which may be read using <a class="el" href="classWt_1_1WEnvironment.html#af39745ca2c6c6fc00c0f78bc7d064e3a" title="Returns a cookie value.">WEnvironment::getCookie()</a> in a future session.</li>
<li>management of the internal path (that enables browser history and bookmarks) using <a class="el" href="classWt_1_1WApplication.html#a2c1a10aadc0d7ed877b5715b42ca4911" title="Changes the internal path.">setInternalPath()</a> and related methods.</li>
<li>support for server-initiated updates with <a class="el" href="classWt_1_1WApplication.html#ad9631ca64e68d30d40cb49c90e55223d" title="Enables server-initiated updates.">enableUpdates()</a></li>
<li>localization information and message resources bundles using <a class="el" href="classWt_1_1WApplication.html#a5c9cc1350019d69f154a2b44cdaf2596" title="Changes the locale.">setLocale()</a> and <a class="el" href="classWt_1_1WApplication.html#a4f304244f6bc75be6cd5f41798ea5e2e" title="Returns the message resource bundle.">messageResourceBundle()</a>. </li>
</ul>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a28b5dd3d1272f46fbacbfb21a0846d07"></a><!-- doxytag: member="Wt::WApplication::ApplicationCreator" ref="a28b5dd3d1272f46fbacbfb21a0846d07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Wt::ApplicationCreator <a class="el" href="classWt_1_1WApplication.html#a3d36c49bb199ec88ad2d490124d62750">Wt::WApplication::ApplicationCreator</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Typedef for a function that creates <a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">WApplication</a> objects. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun()</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a102e3adfb4eb058288861c06dfd6a12a"></a><!-- doxytag: member="Wt::WApplication::AjaxMethod" ref="a102e3adfb4eb058288861c06dfd6a12a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">Wt::WApplication::AjaxMethod</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration that indicates the method for dynamic (AJAX-alike) updates ((<b>deprecated</b>). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#af2b590f865a4a6a6b144c45682b4bc1a" title="Sets the Ajax communication method (deprecated).">setAjaxMethod()</a> </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a102e3adfb4eb058288861c06dfd6a12aa9dc5b270e2b5c180556fb688cd8f06c2"></a><!-- doxytag: member="XMLHttpRequest" ref="a102e3adfb4eb058288861c06dfd6a12aa9dc5b270e2b5c180556fb688cd8f06c2" args="" -->XMLHttpRequest</em> </td><td>
<p>Using the XMLHttpRequest object (real AJAX) </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a102e3adfb4eb058288861c06dfd6a12aa66ad42375422870da68e3666a1712d39"></a><!-- doxytag: member="DynamicScriptTag" ref="a102e3adfb4eb058288861c06dfd6a12aa66ad42375422870da68e3666a1712d39" args="" -->DynamicScriptTag</em> </td><td>
<p>Using dynamic script tags (for cross-domain AJAX) </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae29a843f4d50159b17abfa9503c389db"></a><!-- doxytag: member="Wt::WApplication::WApplication" ref="ae29a843f4d50159b17abfa9503c389db" args="(const WEnvironment &environment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WApplication::WApplication </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a> & </td>
<td class="paramname"><em>environment</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new application instance. </p>
<p>The <code>environment</code> provides information on the initial request, user agent, and deployment-related information. </p>
</div>
</div>
<a class="anchor" id="ad0d9408ddc0fda917235d8416da3777f"></a><!-- doxytag: member="Wt::WApplication::~WApplication" ref="ad0d9408ddc0fda917235d8416da3777f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WApplication::~WApplication </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>The destructor deletes the <a class="el" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">root()</a> container, and as a consequence the entire widget tree. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a412bcf9c269b097e7c372515e27b88ba"></a><!-- doxytag: member="Wt::WApplication::addAutoJavaScript" ref="a412bcf9c269b097e7c372515e27b88ba" args="(const std::string &javascript)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::addAutoJavaScript </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>javascript</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds JavaScript statements that should be run continuously. </p>
<p>This is an internal method.</p>
<p>It is used by for example layout managers to adjust the layout whenever the DOM tree is manipulated.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a2a92457b9212cef4057cb54e56183967" title="Executes some JavaScript code.">doJavaScript()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abb9103bc749dac6942649ea693dc9a3d"></a><!-- doxytag: member="Wt::WApplication::addMetaHeader" ref="abb9103bc749dac6942649ea693dc9a3d" args="(const std::string &name, const WString &content, const std::string &lang="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::addMetaHeader </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>lang</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an HTML meta header. </p>
<p>A meta header can only be added in the following situations:</p>
<ul>
<li>when a plain HTML session is used (including when the user agent is a bot), you can add meta headers at any time.</li>
</ul>
<ul>
<li>or, when <a class="el" href="overview.html#progressive_bootstrap">progressive bootstrap</a> is used, you can set meta headers for any type of session, from within the application constructor (which corresponds to the initial request).</li>
</ul>
<ul>
<li>but never for a <a class="el" href="namespaceWt.html#af4b6ed5fd28b4f5fa141b153c1107349a932eaa79ae0d1f31e3cb240cf5ff0826" title="Specifies an application that manages one or more widgets.">Wt::WidgetSet</a> mode application since then the application is hosted within a foreign HTML page.</li>
</ul>
<p>When a header was previously set for the same <code>name</code>, its contents is replaced.</p>
<p>These situations coincide with <a class="el" href="classWt_1_1WEnvironment.html#af39702064f91a549514f28de713b7cd2" title="Returns whether the browser has enabled support for AJAX.">WEnvironment::ajax()</a> returning <code>false</code> (see <a class="el" href="classWt_1_1WApplication.html#a19f3b913f4bc2f69761d9a3738bf142b" title="Returns the environment information.">environment()</a>). </p>
</div>
</div>
<a class="anchor" id="a149412d829d104621c445bc10604be53"></a><!-- doxytag: member="Wt::WApplication::addMetaHeader" ref="a149412d829d104621c445bc10604be53" args="(MetaHeaderType type, const std::string &name, const WString &content, const std::string &lang="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::addMetaHeader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a9d76d7ac3eb4b1005a35fdc1500c0dcb">MetaHeaderType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>lang</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an HTML meta header. </p>
<p>This overloaded method allows to define both "name" meta headers, relating to document properties as well as "http-equiv" meta headers, which define HTTP headers.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a14fd608fd7d4079355f65b315e66a63f" title="Removes one or all meta headers.">removeMetaHeader()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a976f8a7f160fefc9d3f24a2b482f5c9a"></a><!-- doxytag: member="Wt::WApplication::addMetaLink" ref="a976f8a7f160fefc9d3f24a2b482f5c9a" args="(const std::string &href, const std::string &rel, const std::string &media, const std::string &hreflang, const std::string &type, const std::string &sizes, bool disabled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::addMetaLink </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>href</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>rel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>media</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>hreflang</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>sizes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>disabled</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an HTML meta link. </p>
<p>When a link was previously set for the same <code>href</code>, its contents are replaced. When an empty string is used for the arguments <code>media</code>, <code>hreflang</code>, <code>type</code> or <code>sizes</code>, they will be ignored.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a1febcb091c5f02602fac121741ee063e" title="Removes the HTML meta link.">removeMetaLink()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a10cd5e55a610b7f6587c881a2c35188c"></a><!-- doxytag: member="Wt::WApplication::ajaxMethod" ref="a10cd5e55a610b7f6587c881a2c35188c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">AjaxMethod</a> Wt::WApplication::ajaxMethod </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the Ajax communication method (<b>deprecated</b>). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#af2b590f865a4a6a6b144c45682b4bc1a" title="Sets the Ajax communication method (deprecated).">setAjaxMethod()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a88b082dadadd3fb7dbe10887e7d89c91"></a><!-- doxytag: member="Wt::WApplication::appRoot" ref="a88b082dadadd3fb7dbe10887e7d89c91" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::appRoot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the appRoot special property. </p>
<p>This returns the "appRoot" property, with a trailing slash added to the end if it was not yet present.</p>
<p>The property "appRoot" was introduced as a generalization of the working directory for the location of files that do not need to be served over http to the client, but are required by the program to run properly. Typically, these are message resource bundles (xml), CSV files, database files (e.g. SQLite files for <a class="el" href="namespaceWt_1_1Dbo.html" title="Namespace for the Database Objects (Wt::Dbo).">Wt::Dbo</a>), ...</p>
<p>Some connectors do not allow you to control what the current working directory (CWD) is set to (fcgi, isapi). Instead of referring to files assuming a sensible CWD, it is therefore better to refer to them relative to the application root.</p>
<p>The appRoot property is special in the sense that it can be set implicitly by the connector (see the connector documentation for more info). If it was not set by the connector, it can be set as a normal property in the configuration file (the default wt_config.xml describes how to set properties). If the property is not set at all, it is assumed that the appRoot is CWD and this function will return an empty string.</p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html#a4f304244f6bc75be6cd5f41798ea5e2e" title="Returns the message resource bundle.">messageResourceBundle</a>().use(<a class="code" href="classWt_1_1WApplication.html#a88b082dadadd3fb7dbe10887e7d89c91" title="Returns the appRoot special property.">appRoot</a>() + <span class="stringliteral">"text"</span>);
<a class="code" href="classWt_1_1WApplication.html#a4f304244f6bc75be6cd5f41798ea5e2e" title="Returns the message resource bundle.">messageResourceBundle</a>().use(<a class="code" href="classWt_1_1WApplication.html#a88b082dadadd3fb7dbe10887e7d89c91" title="Returns the appRoot special property.">appRoot</a>() + <span class="stringliteral">"charts"</span>);
<a class="code" href="classWt_1_1Dbo_1_1backend_1_1Sqlite3.html" title="An SQLite3 connection.">Wt::Dbo::backend::Sqlite3</a> sqlite3_(<a class="code" href="classWt_1_1WApplication.html#a88b082dadadd3fb7dbe10887e7d89c91" title="Returns the appRoot special property.">appRoot</a>() + <span class="stringliteral">"planner.db"</span>);
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a6b0f98b3c7fcac1dd21bdf929e3b8428" title="Returns the approot special property.">WServer::appRoot()</a>, <a class="el" href="classWt_1_1WApplication.html#a52684c8637c81c626b607ed802f7d19e" title="Returns the server document root.">docRoot()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a015a4c7613755699c393fb5dd0769038"></a><!-- doxytag: member="Wt::WApplication::attachThread" ref="a015a4c7613755699c393fb5dd0769038" args="(bool attach=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::attachThread </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>attach</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach an auxiliary thread to this application. </p>
<p>In a multi-threaded environment, <a class="el" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">WApplication::instance()</a> uses thread-local data to retrieve the application object that corresponds to the session currently being handled by the thread. This is set automatically by the library whenever an event is delivered to the application, or when you use the <a class="el" href="classWt_1_1WApplication_1_1UpdateLock.html" title="A RAII lock for manipulating and updating the application and its widgets outside of the event loop...">UpdateLock</a> to modify the application from an auxiliary thread outside the normal event loop.</p>
<p>When you want to manipulate the widget tree inside the main event loop, but from within an auxiliary thread, then you cannot use the <a class="el" href="classWt_1_1WApplication_1_1UpdateLock.html" title="A RAII lock for manipulating and updating the application and its widgets outside of the event loop...">UpdateLock</a> since this will create an immediate dead lock. Instead, you may attach the auxiliary thread to the application, by calling this method from the auxiliary thread, and in this way you can modify the application from within that thread without needing the update lock.</p>
<p>Calling <a class="el" href="classWt_1_1WApplication.html#a015a4c7613755699c393fb5dd0769038" title="Attach an auxiliary thread to this application.">attachThread()</a> with <code>attach</code> = <code>false</code>, detaches the current thread. </p>
</div>
</div>
<a class="anchor" id="aae1c2ee7c4dd469eb83299524ac0e7ee"></a><!-- doxytag: member="Wt::WApplication::bind" ref="aae1c2ee7c4dd469eb83299524ac0e7ee" args="(const F &f)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename F > </div>
<table class="memname">
<tr>
<td class="memname">boost::function< void()> Wt::WApplication::bind </td>
<td>(</td>
<td class="paramtype">const F & </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protects a function against deletion of the target object. </p>
<p>When posting an event using <a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88" title="Posts a function to a session.">WServer::post()</a>, it is convenient to bind an object method to be called. However, while <a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88" title="Posts a function to a session.">WServer::post()</a> guarantees that the application to which an event is posted is still alive, it may be that the targeted widget (or <a class="el" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system.">WObject</a> in general) has been deleted.</p>
<p>This function wraps such an object method with a protection layer which guarantees that the method is only called when the targeted object is alive, in the same way as how a signal automatically disconnects slots from objects that are being deleted.</p>
<p>You typically will bind the function immediately within the event loop where you register the "callback", and pass this bound function to (typically an external thread) which calls post() later on. What you cannot do is bind the function only later on, since at that time the target object may already have been destroyed.</p>
<p>As with the signal/slot connection tracking mechanism, this requires that the object is a <a class="el" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system.">WObject</a>. </p>
</div>
</div>
<a class="anchor" id="aba49e1b9e696ac7244f5e2b63ca07de5"></a><!-- doxytag: member="Wt::WApplication::bindWidget" ref="aba49e1b9e696ac7244f5e2b63ca07de5" args="(WWidget *widget, const std::string &domId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::bindWidget </td>
<td>(</td>
<td class="paramtype"><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">const std::string & </td>
<td class="paramname"><em>domId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a top-level widget for a WidgetSet deployment. </p>
<p>This method binds a <code>widget</code> to an existing element with DOM id <code>domId</code> on the page. The element type should correspond with the widget type (e.g. it should be a <div> for a <a class="el" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets.">WContainerWidget</a>, or a <table> for a <a class="el" href="classWt_1_1WTable.html" title="A container widget which provides layout of children in a table grid.">WTable</a>).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">root()</a> </dd>
<dd>
<a class="el" href="namespaceWt.html#af4b6ed5fd28b4f5fa141b153c1107349a932eaa79ae0d1f31e3cb240cf5ff0826" title="Specifies an application that manages one or more widgets.">Wt::WidgetSet</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4e87d8f55211eb7f2fcea01ad956ea63"></a><!-- doxytag: member="Wt::WApplication::bodyClass" ref="a4e87d8f55211eb7f2fcea01ad956ea63" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::bodyClass </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the style class set for the entire page <body>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#aa8fe83406981a556da61a843bb691674" title="Sets a style class to the entire page <body>.">setBodyClass()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a37b4cf44f393688785ed3b34f53fead1"></a><!-- doxytag: member="Wt::WApplication::bookmarkUrl" ref="a37b4cf44f393688785ed3b34f53fead1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::bookmarkUrl </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a bookmarkable URL for the current internal path. </p>
<p>Is equivalent to <code>bookmarkUrl(<a class="el" href="classWt_1_1WApplication.html#aab6320ecdd0e8e4026e9ef1aca710ca5" title="Returns the current internal path.">internalPath()</a>)</code>, see <a class="el" href="classWt_1_1WApplication.html#ac99ee110fd00d89de51e6e90ad166626" title="Returns a bookmarkable URL for a given internal path.">bookmarkUrl(const std::string&) const</a>.</p>
<p>To obtain a URL that is refers to the current session of the application, use <a class="el" href="classWt_1_1WApplication.html#a5326831e30387099b5af76fe7a5cf213" title="Returns a URL for the current session.">url()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5326831e30387099b5af76fe7a5cf213" title="Returns a URL for the current session.">url()</a>, <a class="el" href="classWt_1_1WApplication.html#ac99ee110fd00d89de51e6e90ad166626" title="Returns a bookmarkable URL for a given internal path.">bookmarkUrl(const std::string&) const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac99ee110fd00d89de51e6e90ad166626"></a><!-- doxytag: member="Wt::WApplication::bookmarkUrl" ref="ac99ee110fd00d89de51e6e90ad166626" args="(const std::string &internalPath) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::bookmarkUrl </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>internalPath</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a bookmarkable URL for a given internal path. </p>
<p>Returns the (relative) URL for this application that includes the internal path <code>internalPath</code>, usable across sessions.</p>
<p>The returned URL concatenates the internal path to the application base URL, and when no JavaScript is available and URL rewriting is used for session-tracking, a session Id is appended to reuse an existing session if available.</p>
<p>See also <a class="el" href="overview.html#config_session">10.1 Session management (wt_config.xml)</a> for configuring the session-tracking method.</p>
<p>For the built-in httpd, when the application is deployed at a folder (ending with '/'), only an exact matching path is routed to the application (this can be changed since <a class="el" href="namespaceWt.html" title="The namespace for Wt.">Wt</a> 3.1.9, see <a class="el" href="overview.html#wthttpd">9.2 Built-in httpd</a> ), making clean URLs impossible. Returned URLs then include a <code>"?_="</code> encoding for the internal path.</p>
<p>You can use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> as the destination for a <a class="el" href="classWt_1_1WAnchor.html" title="A widget that represents an HTML anchor (to link to other documents).">WAnchor</a>, and listen to a click event is attached to a slot that switches to the internal path <code>internalPath</code> (see <a class="el" href="classWt_1_1WAnchor.html#ae3ea26646f135bf133871564f5d6798d" title="Sets a link to an internal path (deprecated).">WAnchor::setRefInternalPath()</a>). In this way, an anchor can be used to switch between internal paths within an application regardless of the situation (browser with or without Ajax support, or a web spider bot), but still generates suitable URLs across sessions, which can be used for bookmarking, opening in a new window/tab, or indexing.</p>
<p>To obtain a URL that refers to the current session of the application, use <a class="el" href="classWt_1_1WApplication.html#a5326831e30387099b5af76fe7a5cf213" title="Returns a URL for the current session.">url()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5326831e30387099b5af76fe7a5cf213" title="Returns a URL for the current session.">url()</a>, <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a></dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the <code>internalPath</code> should be UTF8 encoded (we may fix the API to use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> in the future). </dd></dl>
</div>
</div>
<a class="anchor" id="a4b0bc73bab1132f17c13f5e731068446"></a><!-- doxytag: member="Wt::WApplication::changeSessionId" ref="a4b0bc73bab1132f17c13f5e731068446" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::changeSessionId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the session id. </p>
<p>To mitigate session ID fixation attacks, you should use this method to change the session ID to a new random value after a user has authenticated himself.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#ab55c625a3197fec416544be8ad1529af" title="Returns the unique identifier for the current session.">sessionId()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af6e54918b88587438327464c98eecf5c"></a><!-- doxytag: member="Wt::WApplication::closeMessage" ref="af6e54918b88587438327464c98eecf5c" 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::WApplication::closeMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the close message. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a506978cfb884af4bc6ffd5a5bc8476d6" title="Sets the message for the user to confirm closing of the application window/tab.">setConfirmCloseMessage()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0e09381079f67501e38652087232969d"></a><!-- doxytag: member="Wt::WApplication::cssTheme" ref="a0e09381079f67501e38652087232969d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::cssTheme </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the theme. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#aa316b2b30a6191085f265974b66e55bb" title="Sets the theme.">setCssTheme()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a790de918eb5f6b7e45bd30e4b886a583"></a><!-- doxytag: member="Wt::WApplication::customJQuery" ref="a790de918eb5f6b7e45bd30e4b886a583" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::customJQuery </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Executes some JavaScript code. </p>
<p>This method may be used to call some custom <code>javaScript</code> code as part of an event response.</p>
<p>This function does not wait until the JavaScript is run, but returns immediately. The JavaScript will be run after the normal event handling, unless <code>afterLoaded</code> is set to <code>false</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a412bcf9c269b097e7c372515e27b88ba" title="Adds JavaScript statements that should be run continuously.">addAutoJavaScript()</a>, <a class="el" href="classWt_1_1WApplication.html#a3456e2bd2eec561abb90ae19ae42be02" title="Declares an application-wide JavaScript function.">declareJavaScriptFunction()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3456e2bd2eec561abb90ae19ae42be02"></a><!-- doxytag: member="Wt::WApplication::declareJavaScriptFunction" ref="a3456e2bd2eec561abb90ae19ae42be02" args="(const std::string &name, const std::string &function)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::declareJavaScriptFunction </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>function</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Declares an application-wide JavaScript function. </p>
<p>The function is stored in <a class="el" href="classWt_1_1WApplication.html#a6e0963307eb9367a3a4a3f4e35ae3abe" title="Returns the name of the application JavaScript class.">WApplication::javaScriptClass()</a>.</p>
<p>The next code snippet declares and invokes function foo: </p>
<div class="fragment"><pre class="fragment"> app->declareJavaScriptFunction(<span class="stringliteral">"foo"</span>,
<span class="stringliteral">"function(id) { ... }"</span>);
...
std::string <a class="code" href="classWt_1_1WObject.html#a5c5cc1d7aada99baf97d0dc203e42154" title="Returns the (unique) identifier for this object.">id</a>(<span class="stringliteral">"myId"</span>);
app->doJavaScript(app->javaScriptClass() + <span class="stringliteral">".foo('"</span> + <span class="keywordtype">id</span> + <span class="stringliteral">"');"</span>);
</pre></div>
</div>
</div>
<a class="anchor" id="af6a25f56ab9d309d799012faf8823f48"></a><!-- doxytag: member="Wt::WApplication::deferRendering" ref="af6a25f56ab9d309d799012faf8823f48" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::deferRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Defers rendering of the current event response. </p>
<p>This method defers the rendering of the current event response until <a class="el" href="classWt_1_1WApplication.html#a62dfa943a37a250ec781e9019ccd7434" title="Resumes rendering of a deferred event response.">resumeRendering()</a> is called. This may be used if you do not want to actively block the current thread while waiting for an event which is needed to complete the current event response. Note that this effectively freezes the user interface, and thus you should only do this if you know that the event you are waiting for will arrive shortly, or there is really nothing more useful for the user to do than wait for the action to complete.</p>
<p>A typical use case is in conjunction with the <a class="el" href="classWt_1_1Http_1_1Client.html" title="An HTTP client.">Http::Client</a>, to defer the rendering while waiting for the <a class="el" href="classWt_1_1Http_1_1Client.html" title="An HTTP client.">Http::Client</a> to complete.</p>
<p>The function may be called multiple times and the number of deferral requests is counted. The current response is deferred until as many calls to <a class="el" href="classWt_1_1WApplication.html#a62dfa943a37a250ec781e9019ccd7434" title="Resumes rendering of a deferred event response.">resumeRendering()</a> have been performed.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a62dfa943a37a250ec781e9019ccd7434" title="Resumes rendering of a deferred event response.">resumeRendering()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a52684c8637c81c626b607ed802f7d19e"></a><!-- doxytag: member="Wt::WApplication::docRoot" ref="a52684c8637c81c626b607ed802f7d19e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::docRoot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the server document root. </p>
<p>This returns the filesystem path that corresponds to the document root of the webserver.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This does not work reliably for complex webserver configurations (e.g. using FastCGI with Apache and rewrite rules). See also the <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=26052">discussion here</a>.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a88b082dadadd3fb7dbe10887e7d89c91" title="Returns the appRoot special property.">appRoot()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2a92457b9212cef4057cb54e56183967"></a><!-- doxytag: member="Wt::WApplication::doJavaScript" ref="a2a92457b9212cef4057cb54e56183967" args="(const std::string &javascript, bool afterLoaded=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::doJavaScript </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>javascript</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>afterLoaded</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Executes some JavaScript code. </p>
<p>This method may be used to call some custom <code>javaScript</code> code as part of an event response.</p>
<p>This function does not wait until the JavaScript is run, but returns immediately. The JavaScript will be run after the normal event handling, unless <code>afterLoaded</code> is set to <code>false</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a412bcf9c269b097e7c372515e27b88ba" title="Adds JavaScript statements that should be run continuously.">addAutoJavaScript()</a>, <a class="el" href="classWt_1_1WApplication.html#a3456e2bd2eec561abb90ae19ae42be02" title="Declares an application-wide JavaScript function.">declareJavaScriptFunction()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a78016406c4746c56b2c2ffce7c5e181f"></a><!-- doxytag: member="Wt::WApplication::enableAjax" ref="a78016406c4746c56b2c2ffce7c5e181f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::enableAjax </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Progresses to an Ajax-enabled user interface. </p>
<p>This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will propagate the <a class="el" href="classWt_1_1WWidget.html#a919a4eaf68ff52f06f6a726d55dfb768" title="Progresses to an Ajax-enabled widget.">WWidget::enableAjax()</a> method through the widget hierarchy.</p>
<p>You may want to reimplement this method if you want to make changes to the user-interface when AJAX is enabled. You should always call the base implementation.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WWidget.html#a919a4eaf68ff52f06f6a726d55dfb768" title="Progresses to an Ajax-enabled widget.">WWidget::enableAjax()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad9631ca64e68d30d40cb49c90e55223d"></a><!-- doxytag: member="Wt::WApplication::enableUpdates" ref="ad9631ca64e68d30d40cb49c90e55223d" args="(bool enabled=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::enableUpdates </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enabled</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables server-initiated updates. </p>
<p>By default, updates to the user interface are possible only at startup, during any event (in a slot), or at regular time points using <a class="el" href="classWt_1_1WTimer.html" title="A utility class which provides timer signals and single-shot timers.">WTimer</a>. This is the normal Wt event loop.</p>
<p>In some cases, one may want to modify the user interface from a second thread, outside the event loop. While this may be worked around by the <a class="el" href="classWt_1_1WTimer.html" title="A utility class which provides timer signals and single-shot timers.">WTimer</a>, in some cases, there are bandwidth and processing overheads associated which may be unnecessary, and which create a trade-off with time resolution of the updates.</p>
<p>When <code>enabled</code> is <code>true</code>, this enables "server push" (what is called 'comet' in AJAX terminology). Widgets may then be modified, created or deleted outside of the event loop (e.g. in response to execution of another thread), and these changes are propagated by calling <a class="el" href="classWt_1_1WApplication.html#a51f50e0641a6d702a7c6ab7f8dd5946a" title="Propagates server-initiated updates.">triggerUpdate()</a>.</p>
<p>There are two ways for safely manipulating a session's UI, with respect to thread-safety and application life-time (the library can decide to terminate an application if it lost connectivity with the browser).</p>
<h3><a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88" title="Posts a function to a session.">WServer::post()</a></h3>
<p>The easiest and less error-prone solution is to post an event, represented by a function/method call, to a session using <a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88" title="Posts a function to a session.">WServer::post()</a>.</p>
<p>The method is non-blocking: it returns immediately, avoiding dead-lock scenarios. The function is called from within a thread of the server's thread pool, and not if the session has been or is being terminated. The function is called in the context of the targeted application session, and with exclusive access to the session.</p>
<h3><a class="el" href="classWt_1_1WApplication_1_1UpdateLock.html" title="A RAII lock for manipulating and updating the application and its widgets outside of the event loop...">WApplication::UpdateLock</a></h3>
<p>A more direct approach is to grab the application's update lock and manipulate the application's state directly from another thread.</p>
<p>At any time, the application may be deleted (e.g. because of a time out or because the user closes the application window). You should thus make sure you do no longer reference an application after it has been deleted. When Wt decides to delete an application, it first runs <a class="el" href="classWt_1_1WApplication.html#a10317a8a50dc95db9b27ad54409ab39f" title="Finalizes the application, pre-destruction.">WApplication::finalize()</a> and then invokes the destructor. While doing this, any other thread trying to grab the update lock will unblock, but the lock will return <code>false</code>. You should therefore always check whether the lock is valid.</p>
<p>An example of how to modify the widget tree outside the event loop and propagate changes is: </p>
<div class="fragment"><pre class="fragment"> <span class="comment">// You need to have a reference to the application whose state</span>
<span class="comment">// you are about to manipulate.</span>
<span class="comment">// You should prevent the application from being deleted somehow,</span>
<span class="comment">// before you could grab the application lock.</span>
<a class="code" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">Wt::WApplication</a> *app = ...;
{
<span class="comment">// Grab the application lock. It is a scoped lock.</span>
<a class="code" href="classWt_1_1WApplication_1_1UpdateLock.html" title="A RAII lock for manipulating and updating the application and its widgets outside of the event loop...">Wt::WApplication::UpdateLock</a> lock(app);
<span class="keywordflow">if</span> (lock) {
<span class="comment">// We now have exclusive access to the application: we can safely modify the widget tree for example.</span>
app-><a class="code" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">root</a>()->addWidget(<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">"Something happened!"</span>));
<span class="comment">// Push the changes to the browser</span>
app-><a class="code" href="classWt_1_1WApplication.html#a51f50e0641a6d702a7c6ab7f8dd5946a" title="Propagates server-initiated updates.">triggerUpdate</a>();
}
}
</pre></div><dl class="note"><dt><b>Note:</b></dt><dd>This works only if JavaScript is available on the client.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a51f50e0641a6d702a7c6ab7f8dd5946a" title="Propagates server-initiated updates.">triggerUpdate()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a62899f99ccfc2b28c9ff492942c8814d"></a><!-- doxytag: member="Wt::WApplication::encodeUntrustedUrl" ref="a62899f99ccfc2b28c9ff492942c8814d" args="(const std::string &url) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::encodeUntrustedUrl </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes an untrusted URL to prevent referer leaks. </p>
<p>This encodes an URL so that in case the session ID is present in the current URL, this session ID does not leak to the refenced URL.</p>
<p><a class="el" href="namespaceWt.html" title="The namespace for Wt.">Wt</a> will safely handle URLs in the API (in <a class="el" href="classWt_1_1WImage.html" title="A widget that displays an image.">WImage</a> and <a class="el" href="classWt_1_1WAnchor.html" title="A widget that represents an HTML anchor (to link to other documents).">WAnchor</a>) but you may want to use this function to encode URLs which you use in <a class="el" href="classWt_1_1WTemplate.html" title="A widget that renders an XHTML template.">WTemplate</a> texts. </p>
</div>
</div>
<a class="anchor" id="a19f3b913f4bc2f69761d9a3738bf142b"></a><!-- doxytag: member="Wt::WApplication::environment" ref="a19f3b913f4bc2f69761d9a3738bf142b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a> & Wt::WApplication::environment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the environment information. </p>
<p>This method returns the environment object that was used when constructing the application. The environment provides information on the initial request, user agent, and deployment-related information.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5326831e30387099b5af76fe7a5cf213" title="Returns a URL for the current session.">url()</a>, <a class="el" href="classWt_1_1WApplication.html#ab55c625a3197fec416544be8ad1529af" title="Returns the unique identifier for the current session.">sessionId()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a10317a8a50dc95db9b27ad54409ab39f"></a><!-- doxytag: member="Wt::WApplication::finalize" ref="a10317a8a50dc95db9b27ad54409ab39f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::finalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finalizes the application, pre-destruction. </p>
<p>This method is invoked by the Wt library before destruction of a new application. You may reimplement this method to do additional finalization that is not possible from the destructor (e.g. which uses virtual methods). </p>
</div>
</div>
<a class="anchor" id="a0363c673fdb4e3f2be6068c5c1139b69"></a><!-- doxytag: member="Wt::WApplication::findWidget" ref="a0363c673fdb4e3f2be6068c5c1139b69" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * Wt::WApplication::findWidget </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a widget by name. </p>
<p>This finds a widget in the application's widget hierarchy. It does not only consider widgets in the <a class="el" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">root()</a>, but also widgets that are placed outside this root, such as in dialogs, or other "roots" such as all the bound widgets in a widgetset application.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a64ce31cadb378c4eba81224f43bf493d" title="Sets an object name.">WWidget::setObjectName()</a>, <a class="el" href="classWt_1_1WWidget.html#a96e9c88d9ed79acccf3edf2bb00c0126" title="Finds a descendent widget by name.">WWidget::find()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac7582c37defc49b5e8d6ccbda3b68d45"></a><!-- doxytag: member="Wt::WApplication::getUpdateLock" ref="ac7582c37defc49b5e8d6ccbda3b68d45" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WApplication_1_1UpdateLock.html">WApplication::UpdateLock</a> Wt::WApplication::getUpdateLock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grabs and returns the lock for manipulating widgets outside the event loop (<b>deprecated</b>). </p>
<p>You need to keep this lock in scope while manipulating widgets outside of the event loop. In normal cases, inside the Wt event loop, you do not need to care about it.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#ad9631ca64e68d30d40cb49c90e55223d" title="Enables server-initiated updates.">enableUpdates()</a>, <a class="el" href="classWt_1_1WApplication.html#a51f50e0641a6d702a7c6ab7f8dd5946a" title="Propagates server-initiated updates.">triggerUpdate()</a></dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Use the RAII-style UpdateLock(WApplication *) constructor instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a60c1defb57949f6f78c6c1373a18e74e"></a><!-- doxytag: member="Wt::WApplication::globalEnterPressed" ref="a60c1defb57949f6f78c6c1373a18e74e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & Wt::WApplication::globalEnterPressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when enter was pressed. </p>
<p>The application receives key events when no widget currently has focus. Otherwise, key events are handled by the widget in focus, and its ancestors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>See <a class="el" href="classWt_1_1WInteractWidget.html#a38f06d1ad95e7599b055f49931236c10" title="Event signal emitted when enter was pressed.">WInteractWidget::enterPressed()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab4d42f698c48bf84fcc807cb597a0509"></a><!-- doxytag: member="Wt::WApplication::globalEscapePressed" ref="ab4d42f698c48bf84fcc807cb597a0509" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & Wt::WApplication::globalEscapePressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when escape was pressed. </p>
<p>The application receives key events when no widget currently has focus. Otherwise, key events are handled by the widget in focus, and its ancestors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>See <a class="el" href="classWt_1_1WInteractWidget.html#ab581bba7f0ce02380e9339198bac2f78" title="Event signal emitted when escape was pressed.">WInteractWidget::escapePressed()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7d8f807eee7191ae6b7f6f7fe2ab2fae"></a><!-- doxytag: member="Wt::WApplication::globalKeyPressed" ref="a7d8f807eee7191ae6b7f6f7fe2ab2fae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>< <a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> > & Wt::WApplication::globalKeyPressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when a "character" was entered. </p>
<p>The application receives key events when no widget currently has focus. Otherwise, key events are handled by the widget in focus, and its ancestors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>See <a class="el" href="classWt_1_1WInteractWidget.html#a6d4c957a92eb6ffec59a638dd384c6c9" title="Event signal emitted when a "character" was entered.">WInteractWidget::keyPressed()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0a9652fc0d0cbebca7966f98454b078a"></a><!-- doxytag: member="Wt::WApplication::globalKeyWentDown" ref="a0a9652fc0d0cbebca7966f98454b078a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>< <a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> > & Wt::WApplication::globalKeyWentDown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when a keyboard key is pushed down. </p>
<p>The application receives key events when no widget currently has focus. Otherwise, key events are handled by the widget in focus, and its ancestors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>See <a class="el" href="classWt_1_1WInteractWidget.html#a8669f2d35aad5091837b97bd00f25223" title="Event signal emitted when a keyboard key is pushed down.">WInteractWidget::keyWentDown()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa2a569eabc35162f4b2a72c36a24cd80"></a><!-- doxytag: member="Wt::WApplication::globalKeyWentUp" ref="aa2a569eabc35162f4b2a72c36a24cd80" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a>< <a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> > & Wt::WApplication::globalKeyWentUp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when a keyboard key is released. </p>
<p>The application receives key events when no widget currently has focus. Otherwise, key events are handled by the widget in focus, and its ancestors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>See <a class="el" href="classWt_1_1WInteractWidget.html#a7602bfbe38090d4acca674afc02f15c8" title="Event signal emitted when a keyboard key is released.">WInteractWidget::keyWentUp()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab78b78e56a1f53cfdbe1a59c3112ce31"></a><!-- doxytag: member="Wt::WApplication::hasQuit" ref="ab78b78e56a1f53cfdbe1a59c3112ce31" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::hasQuit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the application has quit. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">quit()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1324d7dd9b83e075d78a65ca8cde8c9b"></a><!-- doxytag: member="Wt::WApplication::htmlClass" ref="a1324d7dd9b83e075d78a65ca8cde8c9b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::htmlClass </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the style class set for the entire page <html>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a28867ea48711f9290de496c2ed42fdbf" title="Sets a style class to the entire page <html>.">setHtmlClass()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a42fc7f65116073d4032573f1e42c1173"></a><!-- doxytag: member="Wt::WApplication::initialize" ref="a42fc7f65116073d4032573f1e42c1173" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::initialize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes the application, post-construction. </p>
<p>This method is invoked by the Wt library after construction of a new application. You may reimplement this method to do additional initialization that is not possible from the constructor (e.g. which uses virtual methods). </p>
</div>
</div>
<a class="anchor" id="a38d922da0a0d83395519f3eaab85d0f6"></a><!-- doxytag: member="Wt::WApplication::instance" ref="a38d922da0a0d83395519f3eaab85d0f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WApplication.html">WApplication</a> * Wt::WApplication::instance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current application instance. </p>
<p>This is the same as the global define #wApp. In a multi-threaded server, this method uses thread-specific storage to fetch the current session. </p>
</div>
</div>
<a class="anchor" id="aab6320ecdd0e8e4026e9ef1aca710ca5"></a><!-- doxytag: member="Wt::WApplication::internalPath" ref="aab6320ecdd0e8e4026e9ef1aca710ca5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::internalPath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current internal path. </p>
<p>When the application is just created, this is equal to <a class="el" href="classWt_1_1WEnvironment.html#acb2ba1f1f88e9cd6b7a57a2e51518ec6" title="Returns the initial internal path.">WEnvironment::internalPath()</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a2c1a10aadc0d7ed877b5715b42ca4911" title="Changes the internal path.">setInternalPath()</a>, <a class="el" href="classWt_1_1WApplication.html#a95e6b5e4dc9084d45e166264b10b3c46" title="Returns a part of the current internal path.">internalPathNextPart()</a>, <a class="el" href="classWt_1_1WApplication.html#aed54bd83339bc80b3cffba9067ab1e39" title="Checks if the internal path matches a given path.">internalPathMatches()</a></dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the <code>returned</code> path is UTF8 (we may fix the API to use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> in the future). </dd></dl>
</div>
</div>
<a class="anchor" id="a674fd6a2522d66d07908e8f3d82424a9"></a><!-- doxytag: member="Wt::WApplication::internalPathChanged" ref="a674fd6a2522d66d07908e8f3d82424a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a>< std::string > & Wt::WApplication::internalPathChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal which indicates that the user changes the internal path. </p>
<p>This signal indicates a change to the internal path, which is usually triggered by the user using the browser back/forward buttons.</p>
<p>The argument contains the new internal path.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a2c1a10aadc0d7ed877b5715b42ca4911" title="Changes the internal path.">setInternalPath()</a></dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the <code>internal</code> path is UTF8 encoded (we may fix the API to use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> in the future). </dd></dl>
</div>
</div>
<a class="anchor" id="a9acc55756151112b00e2b34aee9ec0e9"></a><!-- doxytag: member="Wt::WApplication::internalPathDefaultValid" ref="a9acc55756151112b00e2b34aee9ec0e9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::internalPathDefaultValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a490247b9593a6d989ba9cceb0eebe56b"></a><!-- doxytag: member="Wt::WApplication::internalPathInvalid" ref="a490247b9593a6d989ba9cceb0eebe56b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a><std::string>& Wt::WApplication::internalPathInvalid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aed54bd83339bc80b3cffba9067ab1e39"></a><!-- doxytag: member="Wt::WApplication::internalPathMatches" ref="aed54bd83339bc80b3cffba9067ab1e39" args="(const std::string &path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::internalPathMatches </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if the internal path matches a given path. </p>
<p>Returns whether the current <a class="el" href="classWt_1_1WApplication.html#aab6320ecdd0e8e4026e9ef1aca710ca5" title="Returns the current internal path.">internalPath()</a> starts with <code>path</code> (or is equal to <code>path</code>). You will typically use this method within a slot conneted to the <a class="el" href="classWt_1_1WApplication.html#a674fd6a2522d66d07908e8f3d82424a9" title="Signal which indicates that the user changes the internal path.">internalPathChanged()</a> signal, to check that an internal path change affects the widget. It may also be useful before changing <code>path</code> using <a class="el" href="classWt_1_1WApplication.html#a2c1a10aadc0d7ed877b5715b42ca4911" title="Changes the internal path.">setInternalPath()</a> if you do not intend to remove sub paths when the current internal path already matches <code>path</code>.</p>
<p>The <code>path</code> must start with a '/'.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a2c1a10aadc0d7ed877b5715b42ca4911" title="Changes the internal path.">setInternalPath()</a>, <a class="el" href="classWt_1_1WApplication.html#aab6320ecdd0e8e4026e9ef1aca710ca5" title="Returns the current internal path.">internalPath()</a></dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the <code>internal</code> path is UTF8 encoded (we may fix the API to use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> in the future). </dd></dl>
</div>
</div>
<a class="anchor" id="a95e6b5e4dc9084d45e166264b10b3c46"></a><!-- doxytag: member="Wt::WApplication::internalPathNextPart" ref="a95e6b5e4dc9084d45e166264b10b3c46" args="(const std::string &path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::internalPathNextPart </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a part of the current internal path. </p>
<p>This is a convenience method which returns the next <code>folder</code> in the internal path, after the given <code>path</code>.</p>
<p>For example, when the current internal path is <code>"/project/z3cbc/details"</code>, this method returns <code>"details"</code> when called with <code>"/project/z3cbc/"</code> as <code>path</code> argument.</p>
<p>The <code>path</code> must start with a '/', and <a class="el" href="classWt_1_1WApplication.html#aed54bd83339bc80b3cffba9067ab1e39" title="Checks if the internal path matches a given path.">internalPathMatches()</a> should evaluate to <code>true</code> for the given <code>path</code>. If not, an empty string is returned and an error message is logged.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#aab6320ecdd0e8e4026e9ef1aca710ca5" title="Returns the current internal path.">internalPath()</a>, <a class="el" href="classWt_1_1WApplication.html#a674fd6a2522d66d07908e8f3d82424a9" title="Signal which indicates that the user changes the internal path.">internalPathChanged()</a></dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the <code>internal</code> path is UTF8 encoded (we may fix the API to use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> in the future). </dd></dl>
</div>
</div>
<a class="anchor" id="a54a2dfa4924cf0294cff477a1863bf25"></a><!-- doxytag: member="Wt::WApplication::internalPathValid" ref="a54a2dfa4924cf0294cff477a1863bf25" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::internalPathValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a55392ab234153cc66b667c39b57bc33b"></a><!-- doxytag: member="Wt::WApplication::internalSubPath" ref="a55392ab234153cc66b667c39b57bc33b" args="(const std::string &path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::internalSubPath </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a17e25e84fab304664baab5b0c748b802"></a><!-- doxytag: member="Wt::WApplication::isExposed" ref="a17e25e84fab304664baab5b0c748b802" args="(WWidget *w) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::isExposed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"><em>w</em></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether a widget is exposed in the interface. </p>
<p>The default implementation simply returns <code>true</code>, unless a modal dialog is active, in which case it returns <code>true</code> only for widgets that are inside the dialog.</p>
<p>You may want to reimplement this method if you wish to disallow events from certain widgets even when they are inserted in the widget hierachy. </p>
</div>
</div>
<a class="anchor" id="aca61c7262e83de25c276021b26b53074"></a><!-- doxytag: member="Wt::WApplication::isQuited" ref="aca61c7262e83de25c276021b26b53074" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::isQuited </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the application has quit. (<b>deprecated</b>) </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">quit()</a></dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd><a class="el" href="classWt_1_1WApplication.html#ab78b78e56a1f53cfdbe1a59c3112ce31" title="Returns whether the application has quit.">hasQuit()</a> is proper English </dd></dl>
</div>
</div>
<a class="anchor" id="a6e0963307eb9367a3a4a3f4e35ae3abe"></a><!-- doxytag: member="Wt::WApplication::javaScriptClass" ref="a6e0963307eb9367a3a4a3f4e35ae3abe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::javaScriptClass </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the application JavaScript class. </p>
<p>This JavaScript class encapsulates all JavaScript methods specific to this application instance. The method is foreseen to allow multiple applications to run simultaneously on the same page in Wt::WidgtSet mode, without interfering. </p>
</div>
</div>
<a class="anchor" id="a5a9dd0bee018560417a7b7b43b7e42fc"></a><!-- doxytag: member="Wt::WApplication::layoutDirection" ref="a5a9dd0bee018560417a7b7b43b7e42fc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceWt.html#a23d3bcd7b697ff12d031b2d232f8704a">LayoutDirection</a> Wt::WApplication::layoutDirection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the layout direction. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a44c5f0398b5539269be3961b26e95b08" title="Sets the layout direction.">setLayoutDirection()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a435c81aaee5f9d0993b329d2541ee21a"></a><!-- doxytag: member="Wt::WApplication::loadingIndicator" ref="a435c81aaee5f9d0993b329d2541ee21a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WLoadingIndicator.html">WLoadingIndicator</a>* Wt::WApplication::loadingIndicator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the loading indicator. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a080d01aa8e92ae57ef9c9491d33a7fca" title="Sets the loading indicator.">setLoadingIndicator()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6e782f1f38a6f56e2024aab1a917a80b"></a><!-- doxytag: member="Wt::WApplication::locale" ref="a6e782f1f38a6f56e2024aab1a917a80b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::locale </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current locale. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5c9cc1350019d69f154a2b44cdaf2596" title="Changes the locale.">setLocale(const std::string&)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abcbace5a9e38947bf036ae86fb3438c0"></a><!-- doxytag: member="Wt::WApplication::localizedStrings" ref="abcbace5a9e38947bf036ae86fb3438c0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WLocalizedStrings.html">WLocalizedStrings</a> * Wt::WApplication::localizedStrings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the resource object that provides localized strings. </p>
<p>The default value is a <a class="el" href="classWt_1_1WMessageResourceBundle.html" title="Support for localized strings using XML files.">WMessageResourceBundle</a> instance, which uses XML files to resolve localized strings, but you can set a custom class using <a class="el" href="classWt_1_1WApplication.html#a1039775b5a73ff2efc34a482ebd112a8" title="Sets the resource object that provides localized strings.">setLocalizedStrings()</a>.</p>
<p><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a> is used to create localized strings, whose localized translation is looked up through this object, using a key.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a>, <a class="el" href="classWt_1_1WApplication.html#a4f304244f6bc75be6cd5f41798ea5e2e" title="Returns the message resource bundle.">messageResourceBundle()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a75067771ba8fcc56e174f2e741ce278f"></a><!-- doxytag: member="Wt::WApplication::log" ref="a75067771ba8fcc56e174f2e741ce278f" args="(const std::string &type) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WLogEntry.html">WLogEntry</a> Wt::WApplication::log </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an entry to the application log. </p>
<p>Starts a new log entry of the given <code>type</code> in the Wt application log file. This method returns a stream-like object to which the message may be streamed.</p>
<p>A typical usage would be: </p>
<div class="fragment"><pre class="fragment"> wApp->log(<span class="stringliteral">"notice"</span>) << <span class="stringliteral">"User "</span> << userName << <span class="stringliteral">" logged in successfully."</span>;
</pre></div><p>This would create a log entry that looks like: </p>
<div class="fragment"><pre class="fragment">
[2008-Jul-13 14:01:17.817348] 16879 [/app.wt Z2gCmSxIGjLHD73L] [notice] "User bart logged in successfully." </pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="overview.html#config_general">10.2 General application settings (wt_config.xml)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1f31a52f8c8e4f250b5515c02bf9ee55"></a><!-- doxytag: member="Wt::WApplication::makeAbsoluteUrl" ref="a1f31a52f8c8e4f250b5515c02bf9ee55" args="(const std::string &url) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::makeAbsoluteUrl </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes an absolute URL. </p>
<p>Returns an absolute URL for a given (relative url) by including the schema, hostname, and deployment path.</p>
<p>If <code>url</code> is "", then the absolute base URL is returned. This is the absolute URL at which the application is deployed, up to the last '/'.</p>
<p>This is not used in the library, except when a public URL is needed, e.g. for inclusion in an email.</p>
<p>You may want to reimplement this method when the application is hosted behind a reverse proxy or in general the public URL of the application cannot be guessed correctly by the application. </p>
</div>
</div>
<a class="anchor" id="aa6a98202fb6d4aa1214ab3dbe7784416"></a><!-- doxytag: member="Wt::WApplication::maximumRequestSize" ref="aa6a98202fb6d4aa1214ab3dbe7784416" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t Wt::WApplication::maximumRequestSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current maximum size of a request to the application. </p>
<p>The returned value is the maximum request size in bytes.</p>
<p>The maximum request size is configured in the configuration file, see <a class="el" href="overview.html#config_general">10.2 General application settings (wt_config.xml)</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5ebdb82053d80b17d5ac7affd8dc7fa2" title="Signal which indicates that too a large request was received.">requestTooLarge()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4f304244f6bc75be6cd5f41798ea5e2e"></a><!-- doxytag: member="Wt::WApplication::messageResourceBundle" ref="a4f304244f6bc75be6cd5f41798ea5e2e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WMessageResourceBundle.html">WMessageResourceBundle</a> & Wt::WApplication::messageResourceBundle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the message resource bundle. </p>
<p>The message resource bundle defines the list of external XML files that are used to lookup localized strings.</p>
<p>The default <a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">localizedStrings()</a> is a <a class="el" href="classWt_1_1WMessageResourceBundle.html" title="Support for localized strings using XML files.">WMessageResourceBundle</a> object, and this method returns <a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">localizedStrings()</a> upcasted to this type.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr(const char *key)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4a6f167bea94aefa8ba24f914c2fbee5"></a><!-- doxytag: member="Wt::WApplication::notify" ref="a4a6f167bea94aefa8ba24f914c2fbee5" args="(const WEvent &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::notify </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WEvent.html">WEvent</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Notifies an event to the application. </p>
<p>This method is called by the event loop for propagating an event to the application. It provides a single point of entry for events to the application, besides the application constructor.</p>
<p>You may want to reimplement this method for two reasons:</p>
<ul>
<li>for having a single point for exception handling: while you may want to catch recoverable exceptions in a more appropriate place, general (usually fatal) exceptions may be caught here. You will in probably also want to catch the same exceptions in the application constructor in the same way.</li>
<li>you want to manage resource usage during requests. For example, at the end of request handling, you want to return a database session back to the pool. Since notify() is also used for rendering right after the application is created, this will also clean up resources after application construction.</li>
</ul>
<p>In either case, you will need to call the base class implementation of notify(), as otherwise no events will be delivered to your application.</p>
<p>The following shows a generic template for reimplementhing this method for both managing request resources and generic exception handling.</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html#a4a6f167bea94aefa8ba24f914c2fbee5" title="Notifies an event to the application.">MyApplication::notify</a>(<span class="keyword">const</span> WEvent& event)
{
<span class="comment">// Grab resources for during request handling</span>
<span class="keywordflow">try</span> {
<a class="code" href="classWt_1_1WApplication.html#a4a6f167bea94aefa8ba24f914c2fbee5" title="Notifies an event to the application.">WApplication::notify</a>(event);
} <span class="keywordflow">catch</span> (MyException& exception) {
<span class="comment">// handle this exception in a central place</span>
}
<span class="comment">// Free resources used during request handling</span>
}
</pre></div><p>Note that any uncaught exception throw during event handling terminates the session. </p>
</div>
</div>
<a class="anchor" id="a48ceb7972ef7ec0e557adf441f660f2f"></a><!-- doxytag: member="Wt::WApplication::processEvents" ref="a48ceb7972ef7ec0e557adf441f660f2f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::processEvents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Processes UI events. </p>
<p>You may call this method during a long operation to:</p>
<ul>
<li>propagate widget changes to the client.</li>
<li>process UI events.</li>
</ul>
<p>This method starts a recursive event loop, blocking the current thread, and resumes when all pending user interface events have been processed.</p>
<p>Because a thread is blocked, this may affect your application scalability. </p>
</div>
</div>
<a class="anchor" id="a5231d54ed34982f4366058eb6440c8f7"></a><!-- doxytag: member="Wt::WApplication::quit" ref="a5231d54ed34982f4366058eb6440c8f7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::quit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Quits the application. </p>
<p>The method returns immediately, but has as effect that the application will be terminated after the current event is completed.</p>
<p>The current widget tree (including any modifications still pending and applied during the current event handling) will still be rendered, after which the application is terminated.</p>
<p>You might want to make sure no more events can be received from the user, by not having anything clickable, for example by displaying only text. Even better is to <a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a> the user to another, static, page in conjunction with quit().</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac0f5599ed35eb159fa6912aa0ff3c75c"></a><!-- doxytag: member="Wt::WApplication::readConfigurationProperty" ref="ac0f5599ed35eb159fa6912aa0ff3c75c" args="(const std::string &name, std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::readConfigurationProperty </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads a configuration property. </p>
<p>Tries to read a configured value for the property <code>name</code>. The method returns whether a value is defined for the property, and sets it to <code>value</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a11cf397651bd2b470c65aa43b2a60271" title="Reads a configuration property.">WServer::readConfigurationProperty()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4dcbf69c8b09c301577b5b6aa8a4da18"></a><!-- doxytag: member="Wt::WApplication::redirect" ref="a4dcbf69c8b09c301577b5b6aa8a4da18" args="(const std::string &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::redirect </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Redirects the application to another location. </p>
<p>The client will be redirected to a new location identified by <code>url</code>. Use this in conjunction with <a class="el" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">quit()</a> if you want to the application to be terminated as well.</p>
<p>Calling redirect() does not imply quit() since it may be useful to switch between a non-secure and secure (SSL) transport connection. </p>
</div>
</div>
<a class="anchor" id="a02b9d8aa1b6c2d0dc9edc1b9c63f86dc"></a><!-- doxytag: member="Wt::WApplication::refresh" ref="a02b9d8aa1b6c2d0dc9edc1b9c63f86dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Refreshes the application. </p>
<p>This lets the application to refresh its data, including strings from message-resource bundles. This done by propagating <a class="el" href="classWt_1_1WWidget.html#a15e1efb1c2e1030a3ad9565ef7fb0e15" title="Refresh the widget.">WWidget::refresh()</a> through the widget hierarchy.</p>
<p>This method is also called when the user hits the refresh (or reload) button, if this can be caught within the current session.</p>
<p>The reload button may only be caught when Wt is configured so that reload should not spawn a new session. When URL rewriting is used for session tracking, this will cause an ugly session ID to be added to the URL. See <a class="el" href="overview.html#config_session">10.1 Session management (wt_config.xml)</a> for configuring the reload behavior ("<reload-is-new-session>").</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WWidget.html#a15e1efb1c2e1030a3ad9565ef7fb0e15" title="Refresh the widget.">WWidget::refresh()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a250fcc8a0959f2fe159ea10d22b552f9"></a><!-- doxytag: member="Wt::WApplication::removeCookie" ref="a250fcc8a0959f2fe159ea10d22b552f9" args="(const std::string &name, const std::string &domain="", const std::string &path="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::removeCookie </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>domain</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a cookie. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5d10106d4131611aa98e20e6a82b3c40" title="Sets a new cookie.">setCookie()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a14fd608fd7d4079355f65b315e66a63f"></a><!-- doxytag: member="Wt::WApplication::removeMetaHeader" ref="a14fd608fd7d4079355f65b315e66a63f" args="(MetaHeaderType type, const std::string &name="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::removeMetaHeader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a9d76d7ac3eb4b1005a35fdc1500c0dcb">MetaHeaderType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes one or all meta headers. </p>
<p>Removes the meta header with given type and name (if it is present). If name is empty, all meta headers of the given type are removed.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#abb9103bc749dac6942649ea693dc9a3d" title="Adds an HTML meta header.">addMetaHeader()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1febcb091c5f02602fac121741ee063e"></a><!-- doxytag: member="Wt::WApplication::removeMetaLink" ref="a1febcb091c5f02602fac121741ee063e" args="(const std::string &href)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::removeMetaLink </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>href</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the HTML meta link. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a976f8a7f160fefc9d3f24a2b482f5c9a" title="Adds an HTML meta link.">addMetaLink()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5ebdb82053d80b17d5ac7affd8dc7fa2"></a><!-- doxytag: member="Wt::WApplication::requestTooLarge" ref="a5ebdb82053d80b17d5ac7affd8dc7fa2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a>< ::int64_t >& Wt::WApplication::requestTooLarge </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal which indicates that too a large request was received. </p>
<p>The integer parameter is the request size that was received in bytes. </p>
</div>
</div>
<a class="anchor" id="ae88546224ed32cade783da188b145138"></a><!-- doxytag: member="Wt::WApplication::require" ref="ae88546224ed32cade783da188b145138" args="(const std::string &url, const std::string &symbol=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::require </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>symbol</em> = <code>std::string()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a JavaScript library. </p>
<p>Loads a JavaScript library located at the URL <code>url</code>. Wt keeps track of libraries (with the same URL) that already have been loaded, and will load a library only once. In addition, you may provide a <code>symbol</code> which if already defined will also indicate that the library was already loaded (possibly outside of Wt when in WidgetSet mode).</p>
<p>This method returns <code>true</code> only when the library is loaded for the first time.</p>
<p>JavaScript libraries may be loaded at any point in time. Any JavaScript code is deferred until the library is loaded, except for JavaScript that was defined to load before, passing <code>false</code> as second parameter to <a class="el" href="classWt_1_1WApplication.html#a2a92457b9212cef4057cb54e56183967" title="Executes some JavaScript code.">doJavaScript()</a>.</p>
<p>Although Wt includes an off-the-shelf JQuery version (which can also be used by your own JavaScript code), you can override the one used by Wt and load another JQuery version instead, but this needs to be done using <a class="el" href="classWt_1_1WApplication.html#aa2add60804ff75b3798fc270050654c5" title="Loads a custom JQuery library.">requireJQuery()</a>. </p>
</div>
</div>
<a class="anchor" id="aa2add60804ff75b3798fc270050654c5"></a><!-- doxytag: member="Wt::WApplication::requireJQuery" ref="aa2add60804ff75b3798fc270050654c5" args="(const std::string &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::requireJQuery </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a custom JQuery library. </p>
<p>Wt ships with a rather old version of JQuery (1.4.1) which is sufficient for its needs and is many times smaller than more recent JQuery releases (about 50% smaller).</p>
<p>Using this function, you can replace Wt's JQuery version with another version of JQuery.</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html#aa2add60804ff75b3798fc270050654c5" title="Loads a custom JQuery library.">requireJQuery</a>(<span class="stringliteral">"jquery/jquery-1.7.2.min.js"</span>);
</pre></div>
</div>
</div>
<a class="anchor" id="afa5e8ff70f2f48dcd7f51e0e537cfc5b"></a><!-- doxytag: member="Wt::WApplication::resolveRelativeUrl" ref="afa5e8ff70f2f48dcd7f51e0e537cfc5b" args="(const std::string &url) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::resolveRelativeUrl </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>"Resolves" a relative URL taking into account internal paths. </p>
<p>Using HTML5 History API or in a plain HTML session (without ugly internal paths), the internal path is present as a full part of the URL. This has a consequence that relative URLs, if not dealt with, would be resolved against the last 'folder' name of the internal path, rather than against the application deployment path (which is what you probably want).</p>
<p>When using a widgetset mode deployment, or when configuring a baseURL property in the configuration, this method will make an absolute URL so that the property is fetched from the right server.</p>
<p>Otherwise, this method will fixup a relative URL so that it resolves correctly against the base path of an application. This does not necessarily mean that the URL is resolved into an absolute URL. In fact, Wt will simply prepend a sequence of "../" path elements to correct for the internal path. When passed an absolute URL (i.e. starting with '/'), the url is returned unchanged.</p>
<p>For URLs passed to the Wt API (and of which the library knows it is represents a URL) this method is called internally by the library. But it may be useful for URLs which are set e.g. inside a <a class="el" href="classWt_1_1WTemplate.html" title="A widget that renders an XHTML template.">WTemplate</a>. </p>
</div>
</div>
<a class="anchor" id="ac0fa2857a600cc34b3443a04d9ed5c5c"></a><!-- doxytag: member="Wt::WApplication::resourcesUrl" ref="ac0fa2857a600cc34b3443a04d9ed5c5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::resourcesUrl </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the URL at which the resources are deployed. </p>
<p>This returns the value of the 'resources' property set in the configuration file. </p>
</div>
</div>
<a class="anchor" id="a62dfa943a37a250ec781e9019ccd7434"></a><!-- doxytag: member="Wt::WApplication::resumeRendering" ref="a62dfa943a37a250ec781e9019ccd7434" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::resumeRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resumes rendering of a deferred event response. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#af6a25f56ab9d309d799012faf8823f48" title="Defers rendering of the current event response.">deferRendering()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a17e118a04d962459484a12989a80bc05"></a><!-- doxytag: member="Wt::WApplication::root" ref="a17e118a04d962459484a12989a80bc05" 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::WApplication::root </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the root container. </p>
<p>This is the top-level widget container of the application, and corresponds to entire browser window. The user interface of your application is represented by the content of this container.</p>
<p>The root() widget is only defined when the application manages the entire window. When deployed as a <a class="el" href="namespaceWt.html#af4b6ed5fd28b4f5fa141b153c1107349a932eaa79ae0d1f31e3cb240cf5ff0826">WidgetSet</a> application, there is no root() container, and <code>0</code> is returned. Instead, use <a class="el" href="classWt_1_1WApplication.html#aba49e1b9e696ac7244f5e2b63ca07de5" title="Binds a top-level widget for a WidgetSet deployment.">bindWidget()</a> to bind one or more root widgets to existing HTML <div> (or other) elements on the page. </p>
</div>
</div>
<a class="anchor" id="ab55c625a3197fec416544be8ad1529af"></a><!-- doxytag: member="Wt::WApplication::sessionId" ref="ab55c625a3197fec416544be8ad1529af" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::sessionId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the unique identifier for the current session. </p>
<p>The session id is a string that uniquely identifies the current session. Note that the actual contents has no particular meaning and client applications should in no way try to interpret its value. </p>
</div>
</div>
<a class="anchor" id="af2b590f865a4a6a6b144c45682b4bc1a"></a><!-- doxytag: member="Wt::WApplication::setAjaxMethod" ref="af2b590f865a4a6a6b144c45682b4bc1a" args="(AjaxMethod method)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setAjaxMethod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WApplication.html#a102e3adfb4eb058288861c06dfd6a12a">AjaxMethod</a> </td>
<td class="paramname"><em>method</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Ajax communication method (<b>deprecated</b>). </p>
<p>This method has no effect.</p>
<p>Since Wt 3.1.8, a communication method that works is detected at run time. For widget set mode, cross-domain Ajax is chosen if available.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>this setting is no longer needed. </dd></dl>
</div>
</div>
<a class="anchor" id="aa8fe83406981a556da61a843bb691674"></a><!-- doxytag: member="Wt::WApplication::setBodyClass" ref="aa8fe83406981a556da61a843bb691674" args="(const std::string &styleClass)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setBodyClass </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>styleClass</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a style class to the entire page <body>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a28867ea48711f9290de496c2ed42fdbf" title="Sets a style class to the entire page <html>.">setHtmlClass()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a506978cfb884af4bc6ffd5a5bc8476d6"></a><!-- doxytag: member="Wt::WApplication::setConfirmCloseMessage" ref="a506978cfb884af4bc6ffd5a5bc8476d6" args="(const WString &message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setConfirmCloseMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the message for the user to confirm closing of the application window/tab. </p>
<p>If the message is empty, then the user may navigate away from the page without confirmation.</p>
<p>Otherwise the user will be prompted with a browser-specific dialog asking him to confirm leaving the page. This <code>message</code> is added to the page.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a9a4048e01b69a536e35f47eb2a59a69b" title="Handles a browser unload event.">unload()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5d10106d4131611aa98e20e6a82b3c40"></a><!-- doxytag: member="Wt::WApplication::setCookie" ref="a5d10106d4131611aa98e20e6a82b3c40" args="(const std::string &name, const std::string &value, int maxAge, const std::string &domain="", const std::string &path="", bool secure=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setCookie </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxAge</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>domain</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>secure</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a new cookie. </p>
<p>Use cookies to transfer information across different sessions (e.g. a user name). In a subsequent session you will be able to read this cookie using <a class="el" href="classWt_1_1WEnvironment.html#af39745ca2c6c6fc00c0f78bc7d064e3a" title="Returns a cookie value.">WEnvironment::getCookie()</a>. You cannot use a cookie to store information in the current session.</p>
<p>The name must be a valid cookie name (of type 'token': no special characters or separators, see RFC2616 page 16). The value may be anything. Specify the maximum age (in seconds) after which the client must discard the cookie. To delete a cookie, use a value of '0'.</p>
<p>By default the cookie only applies to the application deployment path (<a class="el" href="classWt_1_1WEnvironment.html#aa6c6f66f82b2c6f08317366882d9b827" title="Returns the deployment path.">WEnvironment::deploymentPath()</a>) in the current domain. To set a proper value for domain, see also RFC2109.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Wt provides session tracking automatically, and may be configured to use a cookie for this. You only need to use cookies yourself if you want to remember some information (like a logged in identity) <em>across sessions</em>.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#abf06c6d85be1b482c037f80e63890f3a" title="Returns whether the browser has enabled support for cookies.">WEnvironment::supportsCookies()</a>, <a class="el" href="classWt_1_1WEnvironment.html#af39745ca2c6c6fc00c0f78bc7d064e3a" title="Returns a cookie value.">WEnvironment::getCookie()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa316b2b30a6191085f265974b66e55bb"></a><!-- doxytag: member="Wt::WApplication::setCssTheme" ref="aa316b2b30a6191085f265974b66e55bb" args="(const std::string &theme)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setCssTheme </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>theme</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the theme. </p>
<p>The theme provides the look and feel of several built-in widgets, using CSS style rules. Rules for each theme are defined in the <code>resources/themes/</code><em>theme</em><code>/</code> folder.</p>
<p>The default theme is "default". When setting "", the external style sheets related to the theme are not loaded. </p>
</div>
</div>
<a class="anchor" id="a28867ea48711f9290de496c2ed42fdbf"></a><!-- doxytag: member="Wt::WApplication::setHtmlClass" ref="a28867ea48711f9290de496c2ed42fdbf" args="(const std::string &styleClass)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setHtmlClass </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>styleClass</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a style class to the entire page <html>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#aa8fe83406981a556da61a843bb691674" title="Sets a style class to the entire page <body>.">setBodyClass()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2c1a10aadc0d7ed877b5715b42ca4911"></a><!-- doxytag: member="Wt::WApplication::setInternalPath" ref="a2c1a10aadc0d7ed877b5715b42ca4911" args="(const std::string &path, bool emitChange=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setInternalPath </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>emitChange</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the internal path. </p>
<p>A Wt application may manage multiple virtual paths. The virtual path is appended to the application URL. Depending on the situation, the path is directly appended to the application URL or it is appended using a name anchor (#).</p>
<p>For example, for an application deployed at: </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt</span>
</pre></div><p> for which an <code>internalPath</code> <code>"/project/z3cbc/details/"</code> is set, the two forms for the application URL are: </p>
<ul>
<li>
in an AJAX session (HTML5): <div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt/project/z3cbc/details/</span>
</pre></div> </li>
<li>
in an AJAX session (HTML4): <div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt#/project/z3cbc/details/</span>
</pre></div> </li>
<li>
</li>
<li>
in a plain HTML session: <div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt/project/z3cbc/details/</span>
</pre></div> </li>
</ul>
<p>Note, since Wt 3.1.9, the actual form of the URL no longer affects relative URL resolution, since now Wt includes an HTML <code>meta base</code> tag which points to the deployment path, regardless of the current internal path. This does break deployments behind a reverse proxy which changes paths.</p>
<p>For the built-in httpd, when the application is deployed at a folder (ending with '/'), only an exact matching path is routed to the application (this can be changed since <a class="el" href="namespaceWt.html" title="The namespace for Wt.">Wt</a> 3.1.9, see <a class="el" href="overview.html#wthttpd">9.2 Built-in httpd</a> ), making clean URLs impossible. Returned URLs then include a <code>"?_="</code> encoding for the internal path:</p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/?_=/project/z3cbc/details/</span>
</pre></div><p>When the internal path is changed, an entry is added to the browser history. When the user navigates back and forward through this history (using the browser back/forward buttons), an <a class="el" href="classWt_1_1WApplication.html#a674fd6a2522d66d07908e8f3d82424a9" title="Signal which indicates that the user changes the internal path.">internalPathChanged()</a> event is emitted. You should listen to this signal to switch the application to the corresponding state. When <code>emitChange</code> is <code>true</code>, this signal is also emitted by setting the path.</p>
<p>A url that includes the internal path may be obtained using <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a>.</p>
<p>The <code>internalPath</code> must start with a '/'. In this way, you can still use normal anchors in your HTML. Internal path changes initiated in the browser to paths that do not start with a '/' are ignored.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a>, <a class="el" href="classWt_1_1WApplication.html#aab6320ecdd0e8e4026e9ef1aca710ca5" title="Returns the current internal path.">internalPath()</a>, <a class="el" href="classWt_1_1WApplication.html#a674fd6a2522d66d07908e8f3d82424a9" title="Signal which indicates that the user changes the internal path.">internalPathChanged()</a></dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the <code>path</code> should be UTF8 encoded (we may fix the API to use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> in the future). </dd></dl>
</div>
</div>
<a class="anchor" id="ae641c0e2d82d21b0a4722129eea9ee76"></a><!-- doxytag: member="Wt::WApplication::setInternalPathDefaultValid" ref="ae641c0e2d82d21b0a4722129eea9ee76" args="(bool valid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setInternalPathDefaultValid </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>valid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abd51dc659a0c68f51ed99eca1341ccb6"></a><!-- doxytag: member="Wt::WApplication::setInternalPathValid" ref="abd51dc659a0c68f51ed99eca1341ccb6" args="(bool valid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setInternalPathValid </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>valid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a800b4f49366fad5ed0db6c00ee3500b1"></a><!-- doxytag: member="Wt::WApplication::setJavaScriptClass" ref="a800b4f49366fad5ed0db6c00ee3500b1" args="(const std::string &className)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setJavaScriptClass </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>className</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the name of the application JavaScript class. </p>
<p>This should be called right after construction of the application, and changing the JavaScript class is only supported for WidgetSet mode applications. The <code>className</code> should be a valid JavaScript identifier, and should also be unique in a single page. </p>
</div>
</div>
<a class="anchor" id="a44c5f0398b5539269be3961b26e95b08"></a><!-- doxytag: member="Wt::WApplication::setLayoutDirection" ref="a44c5f0398b5539269be3961b26e95b08" args="(LayoutDirection direction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setLayoutDirection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a23d3bcd7b697ff12d031b2d232f8704a">LayoutDirection</a> </td>
<td class="paramname"><em>direction</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the layout direction. </p>
<p>The default direction is LeftToRight.</p>
<p>This sets the language text direction, which by itself sets the default text alignment and reverse the column orders of <table> elements.</p>
<p>In addition, Wt will take this setting into account in <a class="el" href="classWt_1_1WTextEdit.html" title="A rich-text XHTML editor.">WTextEdit</a>, <a class="el" href="classWt_1_1WTableView.html" title="An MVC View widget for tabular data.">WTableView</a> and <a class="el" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">WTreeView</a> (so that columns are reverted), and swap the behaviour of <a class="el" href="classWt_1_1WWidget.html#a2915d313e6934173c087bf8212024289" title="Specifies a CSS float side.">WWidget::setFloatSide()</a> and <a class="el" href="classWt_1_1WWidget.html#a0b60b3e6d868689071fe3f828d550ae2" title="Sets CSS offsets for a non-statically positioned widget.">WWidget::setOffsets()</a> for RightToLeft languages. Note that CSS settings themselves are not affected by this setting, and thus for example <code>"float: right"</code> will move a box to the right, irrespective of the layout direction.</p>
<p>The library sets <code>"Wt-ltr"</code> or <code>"Wt-rtl"</code> as style classes for the document body. You may use this if to override certain style rules for a Right-to-Left document.</p>
<p>For example: </p>
<div class="fragment"><pre class="fragment"> body .sidebar { <span class="keywordtype">float</span>: right; }
body.Wt-rtl .sidebar { <span class="keywordtype">float</span>: left; }
</pre></div><dl class="note"><dt><b>Note:</b></dt><dd>The layout direction can be set only at application startup and does not have the effect of rerendering the entire UI. </dd></dl>
</div>
</div>
<a class="anchor" id="a080d01aa8e92ae57ef9c9491d33a7fca"></a><!-- doxytag: member="Wt::WApplication::setLoadingIndicator" ref="a080d01aa8e92ae57ef9c9491d33a7fca" args="(WLoadingIndicator *indicator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setLoadingIndicator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WLoadingIndicator.html">WLoadingIndicator</a> * </td>
<td class="paramname"><em>indicator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the loading indicator. </p>
<p>The loading indicator is shown to indicate that a response from the server is pending or JavaScript is being evaluated.</p>
<p>The default loading indicator is a <a class="el" href="classWt_1_1WDefaultLoadingIndicator.html" title="A default loading indicator.">WDefaultLoadingIndicator</a>.</p>
<p>When setting a new loading indicator, the previous one is deleted. </p>
</div>
</div>
<a class="anchor" id="a5c9cc1350019d69f154a2b44cdaf2596"></a><!-- doxytag: member="Wt::WApplication::setLocale" ref="a5c9cc1350019d69f154a2b44cdaf2596" args="(const std::string &locale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setLocale </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>locale</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the locale. </p>
<p>The locale is used by the localized strings resource to resolve localized strings.</p>
<p>By passing an empty <code>locale</code>, the default locale is chosen.</p>
<p>When the locale is changed, <a class="el" href="classWt_1_1WApplication.html#a02b9d8aa1b6c2d0dc9edc1b9c63f86dc" title="Refreshes the application.">refresh()</a> is called, which will resolve the strings of the current user-interface in the new locale.</p>
<p>At construction, the locale is copied from the environment (<a class="el" href="classWt_1_1WEnvironment.html#a42b10cde31c3df634dc753b5dbd1e800" title="Returns the preferred language indicated in the request header.">WEnvironment::locale()</a>), and this is the locale that was configured by the user in his browser preferences, and passed using an HTTP request header.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">localizedStrings()</a>, <a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1039775b5a73ff2efc34a482ebd112a8"></a><!-- doxytag: member="Wt::WApplication::setLocalizedStrings" ref="a1039775b5a73ff2efc34a482ebd112a8" args="(WLocalizedStrings *stringResolver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setLocalizedStrings </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WLocalizedStrings.html">WLocalizedStrings</a> * </td>
<td class="paramname"><em>stringResolver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the resource object that provides localized strings. </p>
<p>The <code>translator</code> resolves localized strings within the current application locale.</p>
<p>The previous resource is deleted, and ownership of the new resource passes to the application.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">localizedStrings()</a>, <a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr(const char *key)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a71a3f7da5abb9a76df94fab69ba61670"></a><!-- doxytag: member="Wt::WApplication::setTitle" ref="a71a3f7da5abb9a76df94fab69ba61670" args="(const WString &title)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setTitle </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 window title. </p>
<p>Sets the browser window title to <code>title</code>.</p>
<p>The default title is "".</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a86aefff2a3438fecdfde3e0e7dd6e5da" title="Returns the window title.">title()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a63d991e268c9af8898329217a1242563"></a><!-- doxytag: member="Wt::WApplication::setTwoPhaseRenderingThreshold" ref="a63d991e268c9af8898329217a1242563" args="(int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::setTwoPhaseRenderingThreshold </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the threshold for two-phase rendering. </p>
<p>This changes the threshold for the <code>size</code> of a JavaScript response (in bytes) to render invisible changes in one go. If the bandwidth for rendering the invisible changes exceed the threshold, they will be fetched in a second communication, after the visible changes have been rendered.</p>
<p>The value is a trade-off: setting it smaller will always use two-phase rendering, increasing the total render time but reducing the latency for the visible changes. Setting it too large will increase the latency to render the visible changes, since first also all invisible changes need to be computed and received in the browser.</p>
<p>The initial value is read from the configuration file, see <a class="el" href="overview.html#config_general">10.2 General application settings (wt_config.xml)</a>. </p>
</div>
</div>
<a class="anchor" id="a6a9a20d65ce9e7c2f62b27387c94e10d"></a><!-- doxytag: member="Wt::WApplication::styleSheet" ref="a6a9a20d65ce9e7c2f62b27387c94e10d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WCssStyleSheet.html">WCssStyleSheet</a>& Wt::WApplication::styleSheet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a reference to the inline style sheet. </p>
<p>Widgets may allow configuration of their look and feel through style classes. These may be defined in this inline stylesheet, or in external style sheets.</p>
<p>It is usually preferable to use external stylesheets (and consider more accessible). Still, the internal stylesheet has as benefit that style rules may be dynamically updated, and it is easier to manage logistically.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#af377d541443b4bcea5fcc40be7c70173" title="Adds an external style sheet.">useStyleSheet()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WWidget.html#a4be23ecf48d5968efb5d926e38e01708" title="Sets (one or more) CSS style classes.">WWidget::setStyleClass()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a86aefff2a3438fecdfde3e0e7dd6e5da"></a><!-- doxytag: member="Wt::WApplication::title" ref="a86aefff2a3438fecdfde3e0e7dd6e5da" 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::WApplication::title </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the window title. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a71a3f7da5abb9a76df94fab69ba61670" title="Sets the window title.">setTitle(const WString&)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a51f50e0641a6d702a7c6ab7f8dd5946a"></a><!-- doxytag: member="Wt::WApplication::triggerUpdate" ref="a51f50e0641a6d702a7c6ab7f8dd5946a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::triggerUpdate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Propagates server-initiated updates. </p>
<p>When the lock to the application is released, changes will propagate to the user interface. This call only has an effect after updates have been enabled from within the normal event loop using <a class="el" href="classWt_1_1WApplication.html#ad9631ca64e68d30d40cb49c90e55223d" title="Enables server-initiated updates.">enableUpdates()</a>.</p>
<p>This is typically used only outside of the main event loop, e.g. from another thread or from within a method posted to an application using <a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88" title="Posts a function to a session.">WServer::post()</a>, since changes always propagate within the event loop at the end of the event.</p>
<p>The update is not immediate, and thus changes that happen after this call will equally be pushed to the client.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#ad9631ca64e68d30d40cb49c90e55223d" title="Enables server-initiated updates.">enableUpdates()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9a4048e01b69a536e35f47eb2a59a69b"></a><!-- doxytag: member="Wt::WApplication::unload" ref="a9a4048e01b69a536e35f47eb2a59a69b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::unload </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles a browser unload event. </p>
<p>The browser unloads the application when the user navigates away or when he closes the window or tab.</p>
<p>When <code>reload-is-new-session</code> is set to <code>true</code>, then the default implementation of this method terminates this session by calling <a class="el" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">quit()</a>, otherwise the session is scheduled to expire within seconds (since it may be a refresh).</p>
<p>You may want to reimplement this if you want to keep the application running until it times out (as was the behaviour before Wt 3.1.6). </p>
</div>
</div>
<a class="anchor" id="a5a8e6970e9123fb1c23aa43711093135"></a><!-- doxytag: member="Wt::WApplication::updatesEnabled" ref="a5a8e6970e9123fb1c23aa43711093135" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WApplication::updatesEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether server-initiated updates are enabled. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#ad9631ca64e68d30d40cb49c90e55223d" title="Enables server-initiated updates.">enableUpdates()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5326831e30387099b5af76fe7a5cf213"></a><!-- doxytag: member="Wt::WApplication::url" ref="a5326831e30387099b5af76fe7a5cf213" args="(const std::string &internalPath=std::string()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WApplication::url </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>internalPath</em> = <code>std::string()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a URL for the current session. </p>
<p>Returns the (relative) URL for this application session (including the session ID if necessary). The URL includes the full application path, and is expanded by the browser into a full URL.</p>
<p>For example, for an application deployed at </p>
<div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt </span>
</pre></div><p> this method might return <code>"/stuff/app.wt?wtd=AbCdEf"</code>. Additional query parameters can be appended in the form of <code>"&param1=value&param2=value"</code>.</p>
<p>To obtain a URL that is suitable for bookmarking the current application state, to be used across sessions, use <a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4dcbf69c8b09c301577b5b6aa8a4da18" title="Redirects the application to another location.">redirect()</a>, <a class="el" href="classWt_1_1WEnvironment.html#ad798f03cb67b859cc42ed2e1ced82fcd" title="Returns the server host name that is used by the client.">WEnvironment::hostName()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a5dd3ea667a61c3bbc2c6e1e3a879dc2f" title="Returns the URL scheme used for the current request ("http" or "https").">WEnvironment::urlScheme()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a37b4cf44f393688785ed3b34f53fead1" title="Returns a bookmarkable URL for the current internal path.">bookmarkUrl()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af377d541443b4bcea5fcc40be7c70173"></a><!-- doxytag: member="Wt::WApplication::useStyleSheet" ref="af377d541443b4bcea5fcc40be7c70173" args="(const std::string &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::useStyleSheet </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an external style sheet. </p>
<p>Widgets may allow configuration of their look and feel through style classes. These may be defined in an inline stylesheet, or in external style sheets.</p>
<p>The <code>url</code> indicates a relative or absolute URL to the stylesheet.</p>
<p>External stylesheets are inserted after the internal style sheet, and can therefore override default styles set by widgets in the internal style sheet.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a6a9a20d65ce9e7c2f62b27387c94e10d" title="Returns a reference to the inline style sheet.">styleSheet()</a>, useStyleSheet(const std::string&, const std::string&) </dd>
<dd>
<a class="el" href="classWt_1_1WWidget.html#a4be23ecf48d5968efb5d926e38e01708" title="Sets (one or more) CSS style classes.">WWidget::setStyleClass()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4a72348400d52ca0cf09b57a24577838"></a><!-- doxytag: member="Wt::WApplication::useStyleSheet" ref="a4a72348400d52ca0cf09b57a24577838" args="(const std::string &url, const std::string &condition, const std::string &media="all")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WApplication::useStyleSheet </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>condition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>media</em> = <code>"all"</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an external style sheet, constrained with conditions. </p>
<p>If not empty, <code>condition</code> is a string that is used to apply the stylesheet to specific versions of IE. Only a limited subset of the IE conditional comments syntax is supported (since these are in fact interpreted server-side instead of client-side). Examples are:</p>
<ul>
<li>"IE gte 6": only for IE version 6 or later.</li>
<li>"!IE gte 6": only for IE versions prior to IE6.</li>
<li>"IE lte 7": only for IE versions prior to IE7.</li>
</ul>
<p>The <code>media</code> indicates the CSS media to which this stylesheet applies. This may be a comma separated list of media. The default value is "all" indicating all media.</p>
<p>The <code>url</code> indicates a relative or absolute URL to the stylesheet.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#af377d541443b4bcea5fcc40be7c70173" title="Adds an external style sheet.">useStyleSheet()</a> </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a3d36c49bb199ec88ad2d490124d62750"></a><!-- doxytag: member="Wt::WApplication::ApplicationCreator" ref="a3d36c49bb199ec88ad2d490124d62750" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::function<<a class="el" href="classWt_1_1WApplication.html">WApplication</a>* (const <a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a>&)> <a class="el" href="classWt_1_1WApplication.html#a3d36c49bb199ec88ad2d490124d62750">ApplicationCreator</a><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Typedef for a function that creates <a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">WApplication</a> objects. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun()</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>
