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
|
<!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>Crazy Eddies GUI System: CEGUI::Checkbox Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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="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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1Checkbox.html">Checkbox</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::Checkbox Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Checkbox" --><!-- doxytag: inherits="CEGUI::ButtonBase" -->
<p>Base class providing logic for Check-box widgets.
<a href="classCEGUI_1_1Checkbox.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::Checkbox:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1Checkbox__inherit__graph.gif" border="0" usemap="#CEGUI_1_1Checkbox_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1Checkbox_inherit__map" id="CEGUI_1_1Checkbox_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ButtonBase.html" title="Base class for all the 'button' type widgets (push button, radio button, check-box, etc)" alt="" coords="5,83,147,112"/><area shape="rect" id="node4" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="16,5,136,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::Checkbox:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1Checkbox__coll__graph.gif" border="0" usemap="#CEGUI_1_1Checkbox_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Checkbox_coll__map" id="CEGUI_1_1Checkbox_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ButtonBase.html" title="Base class for all the 'button' type widgets (push button, radio button, check-box, etc)" alt="" coords="5,5,147,35"/><area shape="rect" id="node4" href="classCEGUI_1_1CheckboxProperties_1_1Selected.html" title="Property to access the selected state of the check box." alt="" coords="171,5,421,35"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="445,5,552,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1Checkbox-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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a7e731337be4da37d127f72bf9bea0070">isSelected</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return true if the check-box is selected (has the checkmark) <a href="#a7e731337be4da37d127f72bf9bea0070"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a262f107235e944cbba65685025a3d156">setSelected</a> (bool select)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set whether the check-box is selected or not <a href="#a262f107235e944cbba65685025a3d156"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c8a8dc3a227bf007a9d1eec20121ca6"></a><!-- doxytag: member="CEGUI::Checkbox::Checkbox" ref="a0c8a8dc3a227bf007a9d1eec20121ca6" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a0c8a8dc3a227bf007a9d1eec20121ca6">Checkbox</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1Checkbox.html" title="Base class providing logic for Check-box widgets.">Checkbox</a> class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e0ce5674990eb6a09af7177b8bef125"></a><!-- doxytag: member="CEGUI::Checkbox::~Checkbox" ref="a2e0ce5674990eb6a09af7177b8bef125" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a2e0ce5674990eb6a09af7177b8bef125">~Checkbox</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1Checkbox.html" title="Base class providing logic for Check-box widgets.">Checkbox</a> class. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb4f3d468adcb4fed0a9e3ea9b8078ca"></a><!-- doxytag: member="CEGUI::Checkbox::EventNamespace" ref="afb4f3d468adcb4fed0a9e3ea9b8078ca" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#afb4f3d468adcb4fed0a9e3ea9b8078ca">EventNamespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f28af5894ae712eb523f0e3a1e6f355"></a><!-- doxytag: member="CEGUI::Checkbox::WidgetTypeName" ref="a5f28af5894ae712eb523f0e3a1e6f355" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a5f28af5894ae712eb523f0e3a1e6f355">WidgetTypeName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> factory name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a2a67b042be6940661cf8216ab585601f">EventCheckStateChanged</a></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a757911db0b0738312df63a3bd7a39a8b"></a><!-- doxytag: member="CEGUI::Checkbox::onSelectStateChange" ref="a757911db0b0738312df63a3bd7a39a8b" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a757911db0b0738312df63a3bd7a39a8b">onSelectStateChange</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">event triggered internally when state of check-box changes <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#aea1c6e5de0f0f42486f4c4d17648c1ce">onMouseButtonUp</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when a mouse button has been released within this window's area. <a href="#aea1c6e5de0f0f42486f4c4d17648c1ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#afeab7a19cbe68387e6660d755c724f31">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &class_name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. <a href="#afeab7a19cbe68387e6660d755c724f31"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42b4841e9b03a1ba21654ddb3443f4f5"></a><!-- doxytag: member="CEGUI::Checkbox::d_selected" ref="a42b4841e9b03a1ba21654ddb3443f4f5" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Checkbox.html#a42b4841e9b03a1ba21654ddb3443f4f5">d_selected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if check-box is selected (has checkmark) <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class providing logic for Check-box widgets. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7e731337be4da37d127f72bf9bea0070"></a><!-- doxytag: member="CEGUI::Checkbox::isSelected" ref="a7e731337be4da37d127f72bf9bea0070" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::Checkbox::isSelected </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return true if the check-box is selected (has the checkmark) </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the widget is selected and has the check-mark, false if the widget is not selected and does not have the check-mark. </dd></dl>
</div>
</div>
<a class="anchor" id="aea1c6e5de0f0f42486f4c4d17648c1ce"></a><!-- doxytag: member="CEGUI::Checkbox::onMouseButtonUp" ref="aea1c6e5de0f0f42486f4c4d17648c1ce" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::Checkbox::onMouseButtonUp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handler called when a mouse button has been released within this window's area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ButtonBase.html#ad28199915fe08115944fe740610231b0">CEGUI::ButtonBase</a>.</p>
</div>
</div>
<a class="anchor" id="a262f107235e944cbba65685025a3d156"></a><!-- doxytag: member="CEGUI::Checkbox::setSelected" ref="a262f107235e944cbba65685025a3d156" args="(bool select)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Checkbox::setSelected </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>select</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set whether the check-box is selected or not </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">select</td><td>true to select the widget and give it the check-mark. false to de-select the widget and remove the check-mark.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="afeab7a19cbe68387e6660d755c724f31"></a><!-- doxytag: member="CEGUI::Checkbox::testClassName_impl" ref="afeab7a19cbe68387e6660d755c724f31" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::Checkbox::testClassName_impl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>class_name</em></td><td>)</td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this window was inherited from <em>class_name</em>. false if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ButtonBase.html#a9495497dbb5e8416a088b4e907f841de">CEGUI::ButtonBase</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1ButtonBase.html#a9495497dbb5e8416a088b4e907f841de">CEGUI::ButtonBase::testClassName_impl()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2a67b042be6940661cf8216ab585601f"></a><!-- doxytag: member="CEGUI::Checkbox::EventCheckStateChanged" ref="a2a67b042be6940661cf8216ab585601f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Checkbox.html#a2a67b042be6940661cf8216ab585601f">CEGUI::Checkbox::EventCheckStateChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when then checked state of the <a class="el" href="classCEGUI_1_1Checkbox.html" title="Base class providing logic for Check-box widgets.">Checkbox</a> changes. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1Checkbox.html" title="Base class providing logic for Check-box widgets.">Checkbox</a> whose state has changed. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
