File: classWt_1_1WAbstractToggleButton.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 (302 lines) | stat: -rw-r--r-- 18,792 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
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<!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::WAbstractToggleButton 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_1WAbstractToggleButton.html">WAbstractToggleButton</a>
  </div>
</div>
<div class="contents">
<h1>Wt::WAbstractToggleButton Class Reference</h1><!-- doxytag: class="Wt::WAbstractToggleButton" --><!-- doxytag: inherits="Wt::WFormWidget" -->An abstract base class for radio buttons and check boxes.  
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WAbstractToggleButton:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WAbstractToggleButton__inherit__graph.png" border="0" usemap="#Wt_1_1WAbstractToggleButton__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1WAbstractToggleButton__inherit__map">
<area shape="rect" href="classWt_1_1WCheckBox.html" title="A user control that represents a check box." alt="" coords="5,453,123,480"><area shape="rect" href="classWt_1_1WRadioButton.html" title="A user control that represents a radio button." alt="" coords="147,453,275,480"><area shape="rect" href="classWt_1_1WFormWidget.html" title="An abstract widget that corresponds to an HTML form element." alt="" coords="73,304,201,331"><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user&#45;interface interaction." alt="" coords="67,229,208,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="76,155,199,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user&#45;interface component." alt="" coords="89,80,185,107"><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="89,5,185,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classWt_1_1WAbstractToggleButton-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="24f8ea0ae98c36503202140f24d23a72"></a><!-- doxytag: member="Wt::WAbstractToggleButton::~WAbstractToggleButton" ref="24f8ea0ae98c36503202140f24d23a72" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#24f8ea0ae98c36503202140f24d23a72">~WAbstractToggleButton</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#7a75e3b2585124eefdea57c9bf9a7696">setText</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 label text.  <a href="#7a75e3b2585124eefdea57c9bf9a7696"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#3ef9682b5fe66d802380ccd6c698725d">text</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the label text.  <a href="#3ef9682b5fe66d802380ccd6c698725d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#bd40ce7a6c4b4e924c9097015f4971ea">isChecked</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the button state.  <a href="#bd40ce7a6c4b4e924c9097015f4971ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#6838c9a37f3e9e3c466e9f48bde55e62">setChecked</a> (bool checked)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the button state.  <a href="#6838c9a37f3e9e3c466e9f48bde55e62"></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_1WAbstractToggleButton.html#2b4ab0746beb381276ff7fcf0bde93c8">setChecked</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks the button.  <a href="#2b4ab0746beb381276ff7fcf0bde93c8"></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_1WAbstractToggleButton.html#b772a43209d2b042f5ac74ae078f1045">setUnChecked</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unchecks the button.  <a href="#b772a43209d2b042f5ac74ae078f1045"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#e80ceb3226d548d66a58bb26d258ec79">checked</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Signal emitted when the button gets checked.  <a href="#e80ceb3226d548d66a58bb26d258ec79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#e203379ba84c01935f68cd293f2a3eeb">unChecked</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Signal emitted when the button gets unChecked.  <a href="#e203379ba84c01935f68cd293f2a3eeb"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8dafae860bd28e00e707d567d124ea4e"></a><!-- doxytag: member="Wt::WAbstractToggleButton::WAbstractToggleButton" ref="8dafae860bd28e00e707d567d124ea4e" args="(WContainerWidget *parent=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#8dafae860bd28e00e707d567d124ea4e">WAbstractToggleButton</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an unchecked toggle button without label. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractToggleButton.html#0d8e9ead61c0ab655f472a240bef86f5">WAbstractToggleButton</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;text, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an unchecked toggle button with given text label.  <a href="#0d8e9ead61c0ab655f472a240bef86f5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An abstract base class for radio buttons and check boxes. 
<p>
A toggle button provides a button with a boolean state (checked or unchecked), and a text label.<p>
To act on a change of the state, either connect a slot to the <a class="el" href="classWt_1_1WFormWidget.html#5216ba1594b5dc525cc47cad593c7ba8" title="Signal emitted when the value was changed.">changed()</a> signal, or connect a slot to the <a class="el" href="classWt_1_1WAbstractToggleButton.html#e80ceb3226d548d66a58bb26d258ec79" title="Signal emitted when the button gets checked.">checked()</a> or <a class="el" href="classWt_1_1WAbstractToggleButton.html#e203379ba84c01935f68cd293f2a3eeb" title="Signal emitted when the button gets unChecked.">unChecked()</a> signals.<p>
The current state (checked or unchecked) may be inspected using the <a class="el" href="classWt_1_1WAbstractToggleButton.html#bd40ce7a6c4b4e924c9097015f4971ea" title="Returns the button state.">isChecked()</a> method. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0d8e9ead61c0ab655f472a240bef86f5"></a><!-- doxytag: member="Wt::WAbstractToggleButton::WAbstractToggleButton" ref="0d8e9ead61c0ab655f472a240bef86f5" args="(const WString &amp;text, WContainerWidget *parent=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Wt::WAbstractToggleButton::WAbstractToggleButton           </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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates an unchecked toggle button with given text label. 
<p>
The text label is rendered to the right side of the button. 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7a75e3b2585124eefdea57c9bf9a7696"></a><!-- doxytag: member="Wt::WAbstractToggleButton::setText" ref="7a75e3b2585124eefdea57c9bf9a7696" args="(const WString &amp;text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::WAbstractToggleButton::setText           </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></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets the label text. 
<p>
The label is rendered to the right fo the button. 
</div>
</div><p>
<a class="anchor" name="3ef9682b5fe66d802380ccd6c698725d"></a><!-- doxytag: member="Wt::WAbstractToggleButton::text" ref="3ef9682b5fe66d802380ccd6c698725d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a> Wt::WAbstractToggleButton::text           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the label text. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractToggleButton.html#7a75e3b2585124eefdea57c9bf9a7696" title="Sets the label text.">setText()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="bd40ce7a6c4b4e924c9097015f4971ea"></a><!-- doxytag: member="Wt::WAbstractToggleButton::isChecked" ref="bd40ce7a6c4b4e924c9097015f4971ea" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Wt::WAbstractToggleButton::isChecked           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the button state. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractToggleButton.html#2b4ab0746beb381276ff7fcf0bde93c8" title="Checks the button.">setChecked()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="6838c9a37f3e9e3c466e9f48bde55e62"></a><!-- doxytag: member="Wt::WAbstractToggleButton::setChecked" ref="6838c9a37f3e9e3c466e9f48bde55e62" args="(bool checked)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::WAbstractToggleButton::setChecked           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>checked</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets the button state. 
<p>
This method does not emit one of the <a class="el" href="classWt_1_1WAbstractToggleButton.html#e80ceb3226d548d66a58bb26d258ec79" title="Signal emitted when the button gets checked.">checked()</a> or <a class="el" href="classWt_1_1WAbstractToggleButton.html#e203379ba84c01935f68cd293f2a3eeb" title="Signal emitted when the button gets unChecked.">unChecked()</a> signals.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractToggleButton.html#2b4ab0746beb381276ff7fcf0bde93c8" title="Checks the button.">setChecked()</a>, <a class="el" href="classWt_1_1WAbstractToggleButton.html#b772a43209d2b042f5ac74ae078f1045" title="Unchecks the button.">setUnChecked()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="2b4ab0746beb381276ff7fcf0bde93c8"></a><!-- doxytag: member="Wt::WAbstractToggleButton::setChecked" ref="2b4ab0746beb381276ff7fcf0bde93c8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::WAbstractToggleButton::setChecked           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Checks the button. 
<p>
Does not emit the <a class="el" href="classWt_1_1WAbstractToggleButton.html#e80ceb3226d548d66a58bb26d258ec79" title="Signal emitted when the button gets checked.">checked()</a> signal.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractToggleButton.html#6838c9a37f3e9e3c466e9f48bde55e62" title="Sets the button state.">setChecked(bool)</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="b772a43209d2b042f5ac74ae078f1045"></a><!-- doxytag: member="Wt::WAbstractToggleButton::setUnChecked" ref="b772a43209d2b042f5ac74ae078f1045" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::WAbstractToggleButton::setUnChecked           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Unchecks the button. 
<p>
Does not emit the <a class="el" href="classWt_1_1WAbstractToggleButton.html#e203379ba84c01935f68cd293f2a3eeb" title="Signal emitted when the button gets unChecked.">unChecked()</a> signal.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractToggleButton.html#6838c9a37f3e9e3c466e9f48bde55e62" title="Sets the button state.">setChecked(bool)</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="e80ceb3226d548d66a58bb26d258ec79"></a><!-- doxytag: member="Wt::WAbstractToggleButton::checked" ref="e80ceb3226d548d66a58bb26d258ec79" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp; Wt::WAbstractToggleButton::checked           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Signal emitted when the button gets checked. 
<p>
This signal is emitted when the user checks the button.<p>
You can use the <a class="el" href="classWt_1_1WFormWidget.html#5216ba1594b5dc525cc47cad593c7ba8" title="Signal emitted when the value was changed.">changed()</a> signal to react to any change of the button state. 
</div>
</div><p>
<a class="anchor" name="e203379ba84c01935f68cd293f2a3eeb"></a><!-- doxytag: member="Wt::WAbstractToggleButton::unChecked" ref="e203379ba84c01935f68cd293f2a3eeb" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp; Wt::WAbstractToggleButton::unChecked           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Signal emitted when the button gets unChecked. 
<p>
This signal is emitted when the user unchecks the button.<p>
You can use the <a class="el" href="classWt_1_1WFormWidget.html#5216ba1594b5dc525cc47cad593c7ba8" title="Signal emitted when the value was changed.">changed()</a> signal to react to any change of the button state. 
</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>