<!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::WLoadingIndicator 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_1WLoadingIndicator.html">WLoadingIndicator</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::WLoadingIndicator Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WLoadingIndicator" -->
<p>An abstract interface for a loading indicator.
<a href="classWt_1_1WLoadingIndicator.html#details">More...</a></p>
<p><code>#include <Wt/WLoadingIndicator></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WLoadingIndicator:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WLoadingIndicator__inherit__graph.png" border="0" usemap="#Wt_1_1WLoadingIndicator_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WLoadingIndicator_inherit__map" id="Wt_1_1WLoadingIndicator_inherit__map">
<area shape="rect" href="classWt_1_1WDefaultLoadingIndicator.html" title="A default loading indicator." alt="" coords="5,80,197,107"/><area shape="rect" href="classWt_1_1WOverlayLoadingIndicator.html" title="A more obvious loading indicator that grays the window." alt="" coords="221,80,416,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WLoadingIndicator-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLoadingIndicator.html#a760be320d6a5ca3d8035606d0803ed36">~WLoadingIndicator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a760be320d6a5ca3d8035606d0803ed36"></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_1WLoadingIndicator.html#a0ccda9318560b1c16086899504842ad4">widget</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the widget that visually represents the indicator. <a href="#a0ccda9318560b1c16086899504842ad4"></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_1WLoadingIndicator.html#a33f6df2d9f56e8431874b2a0efc70ab0">setMessage</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the message that you want to be displayed. <a href="#a33f6df2d9f56e8431874b2a0efc70ab0"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An abstract interface for a loading indicator. </p>
<p>The loading indicator displays a message while a response from the server is pending.</p>
<p>By providing a custom implementation of this interface, you may use a custom loading indicator using <a class="el" href="classWt_1_1WApplication.html#a080d01aa8e92ae57ef9c9491d33a7fca" title="Sets the loading indicator.">WApplication::setLoadingIndicator()</a>,instead of the default implementation (<a class="el" href="classWt_1_1WDefaultLoadingIndicator.html" title="A default loading indicator.">WDefaultLoadingIndicator</a>).</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.">WApplication::setLoadingIndicator()</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a760be320d6a5ca3d8035606d0803ed36"></a><!-- doxytag: member="Wt::WLoadingIndicator::~WLoadingIndicator" ref="a760be320d6a5ca3d8035606d0803ed36" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WLoadingIndicator::~WLoadingIndicator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>The destructor must delete the <a class="el" href="classWt_1_1WLoadingIndicator.html#a0ccda9318560b1c16086899504842ad4" title="Returns the widget that visually represents the indicator.">widget()</a>. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a33f6df2d9f56e8431874b2a0efc70ab0"></a><!-- doxytag: member="Wt::WLoadingIndicator::setMessage" ref="a33f6df2d9f56e8431874b2a0efc70ab0" args="(const WString &text)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Wt::WLoadingIndicator::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> [pure 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>Implemented in <a class="el" href="classWt_1_1WOverlayLoadingIndicator.html#a14abae6e7193229ad71d7804c6e7467b">Wt::WOverlayLoadingIndicator</a>, and <a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#a0b4731e54dc060bf0451b9429a973678">Wt::WDefaultLoadingIndicator</a>.</p>
</div>
</div>
<a class="anchor" id="a0ccda9318560b1c16086899504842ad4"></a><!-- doxytag: member="Wt::WLoadingIndicator::widget" ref="a0ccda9318560b1c16086899504842ad4" args="()=0" -->
<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::WLoadingIndicator::widget </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure 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 show() and hide() 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>Implemented in <a class="el" href="classWt_1_1WOverlayLoadingIndicator.html#aa2e776a3e592a0426aec553446819e83">Wt::WOverlayLoadingIndicator</a>, and <a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#a0c0ad40f2d0638cc6d51dbc5e97fac4a">Wt::WDefaultLoadingIndicator</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>
