1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::WLoadingIndicator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1WLoadingIndicator.html">WLoadingIndicator</a>
</div>
</div>
<div class="contents">
<h1>Wt::WLoadingIndicator Class Reference</h1><!-- doxytag: class="Wt::WLoadingIndicator" -->An abstract interface for a loading indicator.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WLoadingIndicator></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WLoadingIndicator:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WLoadingIndicator__inherit__graph.png" border="0" usemap="#Wt_1_1WLoadingIndicator__inherit__map" alt="Inheritance graph"></center>
<map name="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,419,107"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1WLoadingIndicator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLoadingIndicator.html#760be320d6a5ca3d8035606d0803ed36">~WLoadingIndicator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#760be320d6a5ca3d8035606d0803ed36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#0ccda9318560b1c16086899504842ad4">widget</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the widget that visually represents the indicator. <a href="#0ccda9318560b1c16086899504842ad4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WLoadingIndicator.html#33f6df2d9f56e8431874b2a0efc70ab0">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="#33f6df2d9f56e8431874b2a0efc70ab0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An abstract interface for a loading indicator.
<p>
The loading indicator displays a message while a response from the server is pending.<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#080d01aa8e92ae57ef9c9491d33a7fca" 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" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#080d01aa8e92ae57ef9c9491d33a7fca" title="Sets the loading indicator.">WApplication::setLoadingIndicator()</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="760be320d6a5ca3d8035606d0803ed36"></a><!-- doxytag: member="Wt::WLoadingIndicator::~WLoadingIndicator" ref="760be320d6a5ca3d8035606d0803ed36" 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>
The destructor must delete the <a class="el" href="classWt_1_1WLoadingIndicator.html#0ccda9318560b1c16086899504842ad4" title="Returns the widget that visually represents the indicator.">widget()</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0ccda9318560b1c16086899504842ad4"></a><!-- doxytag: member="Wt::WLoadingIndicator::widget" ref="0ccda9318560b1c16086899504842ad4" 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>
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>
The widget will be shown and hidden using <a class="el" href="classWt_1_1WWidget.html#52dcef5a385ddfa0a8c3e6c20000f181" title="Shows the widget.">WWidget::show()</a> and <a class="el" href="classWt_1_1WWidget.html#0825c3ccbd4999afc1a88fafa6aa6fc7" 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#11bd299d9afd0d83f17ac454c85c43a2" title="Sets whether the widget is hidden.">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" compact><dt><b>Note:</b></dt><dd>The widget will not be added to the <a class="el" href="classWt_1_1WApplication.html#17e118a04d962459484a12989a80bc05" title="Returns the root container.">WApplication::root()</a> container. </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#0c0ad40f2d0638cc6d51dbc5e97fac4a">Wt::WDefaultLoadingIndicator</a>, and <a class="el" href="classWt_1_1WOverlayLoadingIndicator.html#a2e776a3e592a0426aec553446819e83">Wt::WOverlayLoadingIndicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="33f6df2d9f56e8431874b2a0efc70ab0"></a><!-- doxytag: member="Wt::WLoadingIndicator::setMessage" ref="33f6df2d9f56e8431874b2a0efc70ab0" 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>
If the indicator is capable of displaying a text message, then you should reimplement this method to allow this message to be modified.
<p>Implemented in <a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#0b4731e54dc060bf0451b9429a973678">Wt::WDefaultLoadingIndicator</a>, and <a class="el" href="classWt_1_1WOverlayLoadingIndicator.html#14abae6e7193229ad71d7804c6e7467b">Wt::WOverlayLoadingIndicator</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:07 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|
