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
|
<!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::BoundSlot 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_1BoundSlot.html">BoundSlot</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">CEGUI::BoundSlot Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::BoundSlot" -->
<p>Class that tracks a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a>, its group, and the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to which it was subscribed. This is effectively what gets returned from the calls to the <a class="el" href="classCEGUI_1_1Event.html#abeac1e02b2d10a8359ea91cec3103b2e" title="Subscribes some function or object to the Event.">Event::subscribe</a> members, though <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> is always wrapped in a reference counted pointer. When a <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> is deleted, the connection is unsubscribed and the <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> is deleted.
<a href="classCEGUI_1_1BoundSlot.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"/> Collaboration diagram for CEGUI::BoundSlot:</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_1BoundSlot__coll__graph.gif" border="0" usemap="#CEGUI_1_1BoundSlot_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1BoundSlot_coll__map" id="CEGUI_1_1BoundSlot_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties." alt="" coords="5,101,112,131"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="5,5,112,35"/><area shape="rect" id="node6" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events." alt="" coords="136,101,293,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1BoundSlot-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac547b0b645af259b883b386c31370e23"></a><!-- doxytag: member="CEGUI::BoundSlot::Group" ref="ac547b0b645af259b883b386c31370e23" args="" -->
typedef unsigned int </td><td class="memItemRight" valign="bottom"><b>Group</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BoundSlot.html#a8c90bee0c55cb74bc9d87680b97f1c10">BoundSlot</a> (Group group, const <a class="el" href="classCEGUI_1_1SubscriberSlot.html">SubscriberSlot</a> &subscriber, <a class="el" href="classCEGUI_1_1Event.html">Event</a> &event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a8c90bee0c55cb74bc9d87680b97f1c10"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc081596e1a95629d4f7441e0eb7c2eb"></a><!-- doxytag: member="CEGUI::BoundSlot::BoundSlot" ref="acc081596e1a95629d4f7441e0eb7c2eb" args="(const BoundSlot &other)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BoundSlot.html#acc081596e1a95629d4f7441e0eb7c2eb">BoundSlot</a> (const <a class="el" href="classCEGUI_1_1BoundSlot.html">BoundSlot</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abaf7298135254806874ba9fd9aaa9bbd"></a><!-- doxytag: member="CEGUI::BoundSlot::~BoundSlot" ref="abaf7298135254806874ba9fd9aaa9bbd" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BoundSlot.html#abaf7298135254806874ba9fd9aaa9bbd">~BoundSlot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BoundSlot.html#ae405b07ed00baec7dbf56693295da68d">connected</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the slot which this object is tracking is still internally connected to the signal / event mechanism. <a href="#ae405b07ed00baec7dbf56693295da68d"></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_1BoundSlot.html#ab58b7313f3732dcbd6922338ad699ee4">disconnect</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnects the slot. Once disconnected, the slot will no longer be called when the associated signal / event fires. There is no way to re-connect a slot once it has been disconnected, a new subscription to the signal / event is required. <a href="#ab58b7313f3732dcbd6922338ad699ee4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BoundSlot.html#add9ba307f0ed8b1635b9f8f53846e47d">operator==</a> (const <a class="el" href="classCEGUI_1_1BoundSlot.html">BoundSlot</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#add9ba307f0ed8b1635b9f8f53846e47d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BoundSlot.html#af9c4b6feb781aa552fef7465dfa7ab0a">operator!=</a> (const <a class="el" href="classCEGUI_1_1BoundSlot.html">BoundSlot</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Non-equality operator. <a href="#af9c4b6feb781aa552fef7465dfa7ab0a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c7b3c89bf96f51e80a919b3a82a3915"></a><!-- doxytag: member="CEGUI::BoundSlot::Event" ref="a3c7b3c89bf96f51e80a919b3a82a3915" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Event</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that tracks a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a>, its group, and the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to which it was subscribed. This is effectively what gets returned from the calls to the <a class="el" href="classCEGUI_1_1Event.html#abeac1e02b2d10a8359ea91cec3103b2e" title="Subscribes some function or object to the Event.">Event::subscribe</a> members, though <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> is always wrapped in a reference counted pointer. When a <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> is deleted, the connection is unsubscribed and the <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> is deleted. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8c90bee0c55cb74bc9d87680b97f1c10"></a><!-- doxytag: member="CEGUI::BoundSlot::BoundSlot" ref="a8c90bee0c55cb74bc9d87680b97f1c10" args="(Group group, const SubscriberSlot &subscriber, Event &event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::BoundSlot::BoundSlot </td>
<td>(</td>
<td class="paramtype">Group </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1SubscriberSlot.html">SubscriberSlot</a> & </td>
<td class="paramname"><em>subscriber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html">Event</a> & </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">group</td><td>The subscriber group this slot is attached to.</td></tr>
<tr><td class="paramname">subscriber</td><td>The actual slot object that is controlling this connection binding.</td></tr>
<tr><td class="paramname">event</td><td>The <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object to which the subscribed slot is attached. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae405b07ed00baec7dbf56693295da68d"></a><!-- doxytag: member="CEGUI::BoundSlot::connected" ref="ae405b07ed00baec7dbf56693295da68d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::BoundSlot::connected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the slot which this object is tracking is still internally connected to the signal / event mechanism. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true to indicate that the slot is still connected.</li>
<li>false to indicate that the slot has been disconnected. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ab58b7313f3732dcbd6922338ad699ee4"></a><!-- doxytag: member="CEGUI::BoundSlot::disconnect" ref="ab58b7313f3732dcbd6922338ad699ee4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::BoundSlot::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnects the slot. Once disconnected, the slot will no longer be called when the associated signal / event fires. There is no way to re-connect a slot once it has been disconnected, a new subscription to the signal / event is required. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="af9c4b6feb781aa552fef7465dfa7ab0a"></a><!-- doxytag: member="CEGUI::BoundSlot::operator!=" ref="af9c4b6feb781aa552fef7465dfa7ab0a" args="(const BoundSlot &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::BoundSlot::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1BoundSlot.html">BoundSlot</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Non-equality operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> to compare against.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> objects represent different connections.</li>
<li>false if the <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> objects represent the same connection. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="add9ba307f0ed8b1635b9f8f53846e47d"></a><!-- doxytag: member="CEGUI::BoundSlot::operator==" ref="add9ba307f0ed8b1635b9f8f53846e47d" args="(const BoundSlot &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::BoundSlot::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1BoundSlot.html">BoundSlot</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Equality operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> to compare against.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> objects represent the same connection.</li>
<li>false if the <a class="el" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted.">BoundSlot</a> objects represent different connections. </li>
</ul>
</dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
