File: classWt_1_1WDefaultLoadingIndicator.html

package info (click to toggle)
witty 3.1.2-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 45,512 kB
  • ctags: 35,832
  • sloc: cpp: 69,469; ansic: 66,945; xml: 4,383; sh: 594; perl: 108; makefile: 106
file content (120 lines) | stat: -rw-r--r-- 8,910 bytes parent folder | download
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
<!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::WDefaultLoadingIndicator 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1WDefaultLoadingIndicator.html">WDefaultLoadingIndicator</a>
  </div>
</div>
<div class="contents">
<h1>Wt::WDefaultLoadingIndicator Class Reference</h1><!-- doxytag: class="Wt::WDefaultLoadingIndicator" --><!-- doxytag: inherits="Wt::WText,Wt::WLoadingIndicator" -->A default loading indicator.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;Wt/WDefaultLoadingIndicator&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WDefaultLoadingIndicator:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WDefaultLoadingIndicator__inherit__graph.png" border="0" usemap="#Wt_1_1WDefaultLoadingIndicator__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1WDefaultLoadingIndicator__inherit__map">
<area shape="rect" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text." alt="" coords="35,304,117,331"><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user&#45;interface interaction." alt="" coords="5,229,147,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="15,155,137,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user&#45;interface component." alt="" coords="28,80,124,107"><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="28,5,124,32"><area shape="rect" href="classWt_1_1WLoadingIndicator.html" title="An abstract interface for a loading indicator." alt="" coords="141,304,293,331"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classWt_1_1WDefaultLoadingIndicator-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"><a class="anchor" name="667089dada9be1ac765e0daa676f5e45"></a><!-- doxytag: member="Wt::WDefaultLoadingIndicator::WDefaultLoadingIndicator" ref="667089dada9be1ac765e0daa676f5e45" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#667089dada9be1ac765e0daa676f5e45">WDefaultLoadingIndicator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#0c0ad40f2d0638cc6d51dbc5e97fac4a">widget</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the widget that visually represents the indicator.  <a href="#0c0ad40f2d0638cc6d51dbc5e97fac4a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WDefaultLoadingIndicator.html#0b4731e54dc060bf0451b9429a973678">setMessage</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;text)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the message that you want to be displayed.  <a href="#0b4731e54dc060bf0451b9429a973678"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A default loading indicator. 
<p>
The default loading indicator displays the text message <span style="background-color: red; color: white; font-family:
 Arial,Helvetica,sans-serif; font-size: small;">Loading...</span> in the right top corner of the window.<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>Member Function Documentation</h2>
<a class="anchor" name="0c0ad40f2d0638cc6d51dbc5e97fac4a"></a><!-- doxytag: member="Wt::WDefaultLoadingIndicator::widget" ref="0c0ad40f2d0638cc6d51dbc5e97fac4a" 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::WDefaultLoadingIndicator::widget           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="0b4731e54dc060bf0451b9429a973678"></a><!-- doxytag: member="Wt::WDefaultLoadingIndicator::setMessage" ref="0b4731e54dc060bf0451b9429a973678" args="(const WString &amp;text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::WDefaultLoadingIndicator::setMessage           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>text</em>          </td>
          <td>&nbsp;)&nbsp;</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:06 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by&nbsp;<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>