<!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::WOverlayLoadingIndicator 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_1WOverlayLoadingIndicator.html">WOverlayLoadingIndicator</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WOverlayLoadingIndicator Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WOverlayLoadingIndicator" --><!-- doxytag: inherits="Wt::WContainerWidget,Wt::WLoadingIndicator" -->
<p>A more obvious loading indicator that grays the window.
<a href="classWt_1_1WOverlayLoadingIndicator.html#details">More...</a></p>
<p><code>#include <Wt/WOverlayLoadingIndicator></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WOverlayLoadingIndicator:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WOverlayLoadingIndicator__inherit__graph.png" border="0" usemap="#Wt_1_1WOverlayLoadingIndicator_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WOverlayLoadingIndicator_inherit__map" id="Wt_1_1WOverlayLoadingIndicator_inherit__map">
<area shape="rect" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets." alt="" coords="5,304,160,331"/><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="11,229,155,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="19,155,147,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="33,80,132,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="35,5,131,32"/><area shape="rect" href="classWt_1_1WLoadingIndicator.html" title="An abstract interface for a loading indicator." alt="" coords="184,304,336,331"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WOverlayLoadingIndicator-members.html">List of all members.</a></p>
<table class="memberdecls">
<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_1WOverlayLoadingIndicator.html#a1070617b610083d12d150d5a7c3f37a3">WOverlayLoadingIndicator</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &styleClass=<a class="el" href="classWt_1_1WString.html">WString</a>(), const <a class="el" href="classWt_1_1WString.html">WString</a> &backgroundStyleClass=<a class="el" href="classWt_1_1WString.html">WString</a>(), const <a class="el" href="classWt_1_1WString.html">WString</a> &textStyleClass=<a class="el" href="classWt_1_1WString.html">WString</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the loading indicator. <a href="#a1070617b610083d12d150d5a7c3f37a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WOverlayLoadingIndicator.html#aa2e776a3e592a0426aec553446819e83">widget</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the widget that visually represents the indicator. <a href="#aa2e776a3e592a0426aec553446819e83"></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_1WOverlayLoadingIndicator.html#a14abae6e7193229ad71d7804c6e7467b">setMessage</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the message that you want to be displayed. <a href="#a14abae6e7193229ad71d7804c6e7467b"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A more obvious loading indicator that grays the window. </p>
<p>This loading indicator uses a gray semi-transparent overlay to darken the window contents, and centers a loading icon (with some text).</p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">Wt::WApplication</a> *app = <a class="code" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">Wt::WApplication::instance</a>();
app-><a class="code" href="classWt_1_1WApplication.html#a080d01aa8e92ae57ef9c9491d33a7fca" title="Sets the loading indicator.">setLoadingIndicator</a>(<span class="keyword">new</span> <a class="code" href="classWt_1_1WOverlayLoadingIndicator.html" title="A more obvious loading indicator that grays the window.">Wt::WOverlayLoadingIndicator</a>());
</pre></div><div class="image">
<img src="WOverlayLoadingIndicator.png" alt="WOverlayLoadingIndicator.png"/>
<div class="caption">
The overlay loading indicator</div></div>
<dl class="note"><dt><b>Note:</b></dt><dd>For this loading indicator to render properly in IE, you need to reset the "body" margin to 0. Using the inline stylesheet, this could be done using: <div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">WApplication::instance</a>()->styleSheet().addRule(<span class="stringliteral">"body"</span>, <span class="stringliteral">"margin: 0px"</span>);
</pre></div></dd></dl>
<h3>CSS</h3>
<p>This widget does not provide styling, and can be styled using inline or external CSS as appropriate.</p>
<h3>i18n</h3>
<p>The strings used in this class can be translated by overriding the default values for the following localization keys:</p>
<ul>
<li>Wt.WOverlayLoadingIndicator.Loading: Loading...</li>
</ul>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a080d01aa8e92ae57ef9c9491d33a7fca" title="Sets the loading indicator.">WApplication::setLoadingIndicator()</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1070617b610083d12d150d5a7c3f37a3"></a><!-- doxytag: member="Wt::WOverlayLoadingIndicator::WOverlayLoadingIndicator" ref="a1070617b610083d12d150d5a7c3f37a3" args="(const WString &styleClass=WString(), const WString &backgroundStyleClass=WString(), const WString &textStyleClass=WString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WOverlayLoadingIndicator::WOverlayLoadingIndicator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>styleClass</em> = <code><a class="el" href="classWt_1_1WString.html">WString</a>()</code>, </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>backgroundStyleClass</em> = <code><a class="el" href="classWt_1_1WString.html">WString</a>()</code>, </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>textStyleClass</em> = <code><a class="el" href="classWt_1_1WString.html">WString</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct the loading indicator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">styleClass</td><td>the style class for the central box </td></tr>
<tr><td class="paramname">backgroundStyleClass</td><td>the style class for the "background" part of the indicator </td></tr>
<tr><td class="paramname">textStyleClass</td><td>the style class for the text that is displayed</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>if styleClass is not set, the central box gets the CSS style elements <div class="fragment"><pre class="fragment"> background: <a class="code" href="group__style.html#gga9686ea88ce4db2c0a12ea84452f60133aa8fbe7a33681fc09e0231d6dfbd90d66" title="Color white.">white</a>;
border: 3px solid #333333;
z-index: 10001; visibility: visible;
position: absolute; left: 50%; top: 50%;
<a class="code" href="classWt_1_1WWebWidget.html#a1ffcfb141e9e41185b14eaafea63d8f0" title="Returns a CSS margin set.">margin</a>-left: -50px; <a class="code" href="classWt_1_1WWebWidget.html#a1ffcfb141e9e41185b14eaafea63d8f0" title="Returns a CSS margin set.">margin</a>-top: -40px;
<a class="code" href="classWt_1_1WWebWidget.html#a66ea6d827d488a855abc7a36d8d414ca" title="Returns the width.">width</a>: 100px; <a class="code" href="classWt_1_1WWebWidget.html#a890a25fe2e8567525f44c0d2ecf0547b" title="Returns the height.">height</a>: 80px;
font-family: arial,sans-serif;
text-align: center
</pre></div> </dd>
<dd>
if backgroundStyleClass is not set, the background gets the CSS style elements <div class="fragment"><pre class="fragment"> background: #DDDDDD;
<a class="code" href="classWt_1_1WWebWidget.html#a890a25fe2e8567525f44c0d2ecf0547b" title="Returns the height.">height</a>: 100%; <a class="code" href="classWt_1_1WWebWidget.html#a66ea6d827d488a855abc7a36d8d414ca" title="Returns the width.">width</a>: 100%;
top: 0px; left: 0px;
z-index: 10000;
-moz-background-clip: -moz-initial;
-moz-background-origin: -moz-initial;
-moz-background-<span class="keyword">inline</span>-policy: -moz-initial;
opacity: 0.5; filter: alpha(opacity=50); -moz-opacity:0.5;
position: absolute;
</pre></div> </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a14abae6e7193229ad71d7804c6e7467b"></a><!-- doxytag: member="Wt::WOverlayLoadingIndicator::setMessage" ref="a14abae6e7193229ad71d7804c6e7467b" args="(const WString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WOverlayLoadingIndicator::setMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the message that you want to be displayed. </p>
<p>If the indicator is capable of displaying a text message, then you should reimplement this method to allow this message to be modified. </p>
<p>Implements <a class="el" href="classWt_1_1WLoadingIndicator.html#a33f6df2d9f56e8431874b2a0efc70ab0">Wt::WLoadingIndicator</a>.</p>
</div>
</div>
<a class="anchor" id="aa2e776a3e592a0426aec553446819e83"></a><!-- doxytag: member="Wt::WOverlayLoadingIndicator::widget" ref="aa2e776a3e592a0426aec553446819e83" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1WWidget.html">WWidget</a>* Wt::WOverlayLoadingIndicator::widget </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the widget that visually represents the indicator. </p>
<p>You should reimplement this method to return a widget that will be shown to indicate that a response is pending. The widget should be positioned using CSS.</p>
<p>The widget will be shown and hidden using <a class="el" href="classWt_1_1WWidget.html#a52dcef5a385ddfa0a8c3e6c20000f181" title="Shows the widget.">WWidget::show()</a> and <a class="el" href="classWt_1_1WWidget.html#a0825c3ccbd4999afc1a88fafa6aa6fc7" title="Hides the widget.">WWidget::hide()</a>. If you want to customize this behaviour, you should reimplement the <a class="el" href="classWt_1_1WWidget.html#a66bdda41220267a8c7ff9865996e2675" title="Hides or shows the widget.">WWidget::setHidden()</a> method. Note that <a class="el" href="classWt_1_1WWidget.html#a52dcef5a385ddfa0a8c3e6c20000f181" title="Shows the widget.">show()</a> and <a class="el" href="classWt_1_1WWidget.html#a0825c3ccbd4999afc1a88fafa6aa6fc7" title="Hides the widget.">hide()</a> are stateless slots, and thus you need to make sure that your implementation comforms to that contract, so that it may be optimized to JavaScript (the server-side implementation will only be called during stateless slot prelearning).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The widget will not be added to the <a class="el" href="classWt_1_1WApplication.html#a17e118a04d962459484a12989a80bc05" title="Returns the root container.">WApplication::root()</a> container. </dd></dl>
<p>Implements <a class="el" href="classWt_1_1WLoadingIndicator.html#a0ccda9318560b1c16086899504842ad4">Wt::WLoadingIndicator</a>.</p>
</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>
