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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<!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::WOverlayLoadingIndicator 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_1WOverlayLoadingIndicator.html">WOverlayLoadingIndicator</a>
</div>
</div>
<div class="contents">
<h1>Wt::WOverlayLoadingIndicator Class Reference</h1><!-- doxytag: class="Wt::WOverlayLoadingIndicator" --><!-- doxytag: inherits="Wt::WContainerWidget,Wt::WLoadingIndicator" -->A more obvious loading indicator that grays the window.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WOverlayLoadingIndicator></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WOverlayLoadingIndicator:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WOverlayLoadingIndicator__inherit__graph.png" border="0" usemap="#Wt_1_1WOverlayLoadingIndicator__inherit__map" alt="Inheritance graph"></center>
<map name="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,157,331"><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="11,229,152,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="20,155,143,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="33,80,129,107"><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="33,5,129,32"><area shape="rect" href="classWt_1_1WLoadingIndicator.html" title="An abstract interface for a loading indicator." alt="" coords="181,304,333,331"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1WOverlayLoadingIndicator-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WOverlayLoadingIndicator.html#1070617b610083d12d150d5a7c3f37a3">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="#1070617b610083d12d150d5a7c3f37a3"></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_1WOverlayLoadingIndicator.html#a2e776a3e592a0426aec553446819e83">widget</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the widget that visually represents the indicator. <a href="#a2e776a3e592a0426aec553446819e83"></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_1WOverlayLoadingIndicator.html#14abae6e7193229ad71d7804c6e7467b">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="#14abae6e7193229ad71d7804c6e7467b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A more obvious loading indicator that grays the window.
<p>
This loading indicator uses a gray semi-transparent overlay to darken the window contents, and centers a loading icon (with some text).<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#38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">Wt::WApplication::instance</a>();
app-><a class="code" href="classWt_1_1WApplication.html#080d01aa8e92ae57ef9c9491d33a7fca" 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><p>
<div align="center">
<img src="WOverlayLoadingIndicator.png" alt="WOverlayLoadingIndicator.png">
<p><strong>The overlay loading indicator</strong></p></div>
<p>
<dl class="note" compact><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:</dd></dl>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WApplication.html#38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">WApplication::instance</a>()->styleSheet().addRule(<span class="stringliteral">"body"</span>, <span class="stringliteral">"margin: 0px"</span>);
</pre></div><p>
<h3>CSS</h3>
<p>
This widget does not provide styling, and can be styled using inline or external CSS as appropriate.<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="1070617b610083d12d150d5a7c3f37a3"></a><!-- doxytag: member="Wt::WOverlayLoadingIndicator::WOverlayLoadingIndicator" ref="1070617b610083d12d150d5a7c3f37a3" 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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct the loading indicator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>styleClass</em> </td><td>the style class for the central box </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backgroundStyleClass</em> </td><td>the style class for the "background" part of the indicator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textStyleClass</em> </td><td>the style class for the text that is displayed</td></tr>
</table>
</dl>
<dl class="note" compact><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#gg9686ea88ce4db2c0a12ea84452f60133a8fbe7a33681fc09e0231d6dfbd90d66" 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#2c0381fd3e59c8d84da23fe6af564725" title="Returns a CSS margin set.">margin</a>-left: -50px; <a class="code" href="classWt_1_1WWebWidget.html#2c0381fd3e59c8d84da23fe6af564725" title="Returns a CSS margin set.">margin</a>-top: -40px;
<a class="code" href="classWt_1_1WWebWidget.html#4187ef41415521e545106c970c2679f2" title="Returns the width.">width</a>: 100px; <a class="code" href="classWt_1_1WWebWidget.html#7321103dca90574bbc3ac6ea9a91ccff" title="Returns the height.">height</a>: 80px;
font-family: arial,sans-serif;
text-align: center
</pre></div> <p>
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#7321103dca90574bbc3ac6ea9a91ccff" title="Returns the height.">height</a>: 100%; <a class="code" href="classWt_1_1WWebWidget.html#4187ef41415521e545106c970c2679f2" 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><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2e776a3e592a0426aec553446819e83"></a><!-- doxytag: member="Wt::WOverlayLoadingIndicator::widget" ref="a2e776a3e592a0426aec553446819e83" 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> [inline, 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 <a class="el" href="classWt_1_1WWidget.html#52dcef5a385ddfa0a8c3e6c20000f181" title="Shows the widget.">show()</a> and <a class="el" href="classWt_1_1WWidget.html#0825c3ccbd4999afc1a88fafa6aa6fc7" 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" 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>Implements <a class="el" href="classWt_1_1WLoadingIndicator.html#0ccda9318560b1c16086899504842ad4">Wt::WLoadingIndicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="14abae6e7193229ad71d7804c6e7467b"></a><!-- doxytag: member="Wt::WOverlayLoadingIndicator::setMessage" ref="14abae6e7193229ad71d7804c6e7467b" 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>
If the indicator is capable of displaying a text message, then you should reimplement this method to allow this message to be modified.
<p>Implements <a class="el" href="classWt_1_1WLoadingIndicator.html#33f6df2d9f56e8431874b2a0efc70ab0">Wt::WLoadingIndicator</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>
|
