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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
|
<!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::EventSet 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_1EventSet.html">EventSet</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="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::EventSet Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::EventSet" -->
<p>Class that collects together a set of <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> objects.
<a href="classCEGUI_1_1EventSet.html#details">More...</a></p>
<p>Inherited by <a class="el" href="classCEGUI_1_1GlobalEventSet.html">CEGUI::GlobalEventSet</a>, <a class="el" href="classCEGUI_1_1MouseCursor.html">CEGUI::MouseCursor</a>, <a class="el" href="classCEGUI_1_1RenderingSurface.html">CEGUI::RenderingSurface</a>, <a class="el" href="classCEGUI_1_1ResourceEventSet.html">CEGUI::ResourceEventSet</a>, <a class="el" href="classCEGUI_1_1System.html">CEGUI::System</a>, <a class="el" href="classCEGUI_1_1Window.html">CEGUI::Window</a>, and <a class="el" href="classCEGUI_1_1WindowManager.html">CEGUI::WindowManager</a>.</p>
<p><a href="classCEGUI_1_1EventSet-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="a092101fef9671af369dbdeaa8b36a41f"></a><!-- doxytag: member="CEGUI::EventSet::Iterator" ref="a092101fef9671af369dbdeaa8b36a41f" args="" -->
typedef <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><br class="typebreak"/>
< EventMap > </td><td class="memItemRight" valign="bottom"><b>Iterator</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"><a class="anchor" id="a4fc3ca00807d9ad4b78cf2c28bdd3a8d"></a><!-- doxytag: member="CEGUI::EventSet::EventSet" ref="a4fc3ca00807d9ad4b78cf2c28bdd3a8d" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a4fc3ca00807d9ad4b78cf2c28bdd3a8d">EventSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d6ffbe2ddb82f4a5b412b502826389e"></a><!-- doxytag: member="CEGUI::EventSet::~EventSet" ref="a0d6ffbe2ddb82f4a5b412b502826389e" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a0d6ffbe2ddb82f4a5b412b502826389e">~EventSet</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#ae88e5d66cd4eded638ac060787ff0710">addEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> with the given name. <a href="#ae88e5d66cd4eded638ac060787ff0710"></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_1EventSet.html#abdf7999c207be6aed0a4855373bb390a">removeEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> with the given name. All connections to the event are disconnected. <a href="#abdf7999c207be6aed0a4855373bb390a"></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_1EventSet.html#a6d1af9d888959b35cb19742c95c696cc">removeAllEvents</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> objects from the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. <a href="#a6d1af9d888959b35cb19742c95c696cc"></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_1EventSet.html#a93afe77c8cc949acf307859910623101">isEventPresent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> with the given name is present in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. <a href="#a93afe77c8cc949acf307859910623101"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#ab0a6d8321ef6232997ca984357a14124">subscribeEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1SubscriberSlot.html">Event::Subscriber</a> subscriber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes a handler to the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. If the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> is not yet present in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>, it is created and added. <a href="#ab0a6d8321ef6232997ca984357a14124"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a6746c0dc89fce0b2a087622b82d87b06">subscribeEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> group, <a class="el" href="classCEGUI_1_1SubscriberSlot.html">Event::Subscriber</a> subscriber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes a handler to the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. If the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> is not yet present in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>, it is created and added. <a href="#a6746c0dc89fce0b2a087622b82d87b06"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a098c5e838e61568a6d503102e9366352">subscribeScriptedEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#a098c5e838e61568a6d503102e9366352"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a226f138d44cd9bef24327b6c2d0e291e">subscribeScriptedEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> group, const <a class="el" href="classCEGUI_1_1String.html">String</a> &subscriber_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. <a href="#a226f138d44cd9bef24327b6c2d0e291e"></a><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_1EventSet.html#a449ba093d6b539bbb591dd7983faee8e">fireEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &args, const <a class="el" href="classCEGUI_1_1String.html">String</a> &eventNamespace="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fires the named event passing the given <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> object. <a href="#a449ba093d6b539bbb591dd7983faee8e"></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_1EventSet.html#a5a940a84565fb4160079c208cd8cd734">isMuted</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is muted or not. <a href="#a5a940a84565fb4160079c208cd8cd734"></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_1EventSet.html#a52411ed993eaf1880f963ad4ee065df1">setMutedState</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mute state for this <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. <a href="#a52411ed993eaf1880f963ad4ee065df1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d0ee5070da901ec5ea19f8569ef3421"></a><!-- doxytag: member="CEGUI::EventSet::getIterator" ref="a7d0ee5070da901ec5ea19f8569ef3421" args="(void) const " -->
<a class="el" href="classCEGUI_1_1ConstBaseIterator.html">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a7d0ee5070da901ec5ea19f8569ef3421">getIterator</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a EventSet::Iterator object to iterate over the events currently added to the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45abb62192caa5a8e4d23a9f13b2ba34"></a><!-- doxytag: member="CEGUI::EventSet::EventMap" ref="a45abb62192caa5a8e4d23a9f13b2ba34" args="" -->
typedef std::map< <a class="el" href="classCEGUI_1_1String.html">String</a>, <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1Event.html">Event</a> <br class="typebreak"/>
*, <a class="el" href="structCEGUI_1_1String_1_1FastLessCompare.html">String::FastLessCompare</a> > </td><td class="memItemRight" valign="bottom"><b>EventMap</b></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="el" href="classCEGUI_1_1Event.html">Event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a2024f6cd7334576cf68d9958e6baa63a">getEventObject</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, bool autoAdd=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object with the given name, optionally adding such an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object to the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> if it does not already exist. <a href="#a2024f6cd7334576cf68d9958e6baa63a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac0eaf193cc09471a42ab41c80a2abf1"></a><!-- doxytag: member="CEGUI::EventSet::fireEvent_impl" ref="aac0eaf193cc09471a42ab41c80a2abf1" args="(const String &name, EventArgs &args)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#aac0eaf193cc09471a42ab41c80a2abf1">fireEvent_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementation event firing member. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e1c2f3b3e69b8c4273964855531573d"></a><!-- doxytag: member="CEGUI::EventSet::EventSet" ref="a8e1c2f3b3e69b8c4273964855531573d" args="(EventSet &)" -->
 </td><td class="memItemRight" valign="bottom"><b>EventSet</b> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2935fe676764297f6da50788a39eef75"></a><!-- doxytag: member="CEGUI::EventSet::operator=" ref="a2935fe676764297f6da50788a39eef75" args="(EventSet &)" -->
<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> &)</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="afb2d2d15afbfa1cb0ee4e8554beab7a0"></a><!-- doxytag: member="CEGUI::EventSet::d_events" ref="afb2d2d15afbfa1cb0ee4e8554beab7a0" args="" -->
EventMap </td><td class="memItemRight" valign="bottom"><b>d_events</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05abf2ea8300b76caf62612566fe6c01"></a><!-- doxytag: member="CEGUI::EventSet::d_muted" ref="a05abf2ea8300b76caf62612566fe6c01" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1EventSet.html#a05abf2ea8300b76caf62612566fe6c01">d_muted</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if events for this <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> have been muted. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that collects together a set of <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> objects. </p>
<p>The <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is a means for code to attach a handler function to some named event, and later, for that event to be fired and the subscribed handler(s) called. </p>
<dl class="user"><dt><b></b></dt><dd>As of 0.5, the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> no longer needs to be filled with available events. Events are now added to the set as they are first used; that is, the first time a handler is subscribed to an event for a given <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>, an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object is created and added to the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. </dd></dl>
<dl class="user"><dt><b></b></dt><dd>Instead of throwing an exception when firing an event that does not actually exist in the set, we now do nothing (if the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> does not exist, then it has no handlers subscribed, and therefore doing nothing is the correct course action). </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae88e5d66cd4eded638ac060787ff0710"></a><!-- doxytag: member="CEGUI::EventSet::addEvent" ref="ae88e5d66cd4eded638ac060787ff0710" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::EventSet::addEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a new <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> with the given name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name to give the new <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. The name must be unique for the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1AlreadyExistsException.html" title="Exception class used when an attempt is made create a named object of a particular type when an objec...">AlreadyExistsException</a></td><td>Thrown if an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> already exists named <em>name</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a449ba093d6b539bbb591dd7983faee8e"></a><!-- doxytag: member="CEGUI::EventSet::fireEvent" ref="a449ba093d6b539bbb591dd7983faee8e" args="(const String &name, EventArgs &args, const String &eventNamespace="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::EventSet::fireEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> & </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>eventNamespace</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fires the named event passing the given <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> that is to be fired (triggered)</td></tr>
<tr><td class="paramname">args</td><td>The <a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> (or derived) object that is to be bassed to each subscriber of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. Once all subscribers have been called the 'handled' field of the event is updated appropriately.</td></tr>
<tr><td class="paramname">eventNamespace</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the global event namespace prefix for this event.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1GlobalEventSet.html#a5c4a30c64ef129cc57391912e277f1f4">CEGUI::GlobalEventSet</a>.</p>
</div>
</div>
<a class="anchor" id="a2024f6cd7334576cf68d9958e6baa63a"></a><!-- doxytag: member="CEGUI::EventSet::getEventObject" ref="a2024f6cd7334576cf68d9958e6baa63a" args="(const String &name, bool autoAdd=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Event.html">Event</a>* CEGUI::EventSet::getEventObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>autoAdd</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object with the given name, optionally adding such an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object to the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> if it does not already exist. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to return.</td></tr>
<tr><td class="paramname">autoAdd</td><td><ul>
<li>true if an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object named <em>name</em> should be added to the set if such an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> does not currently exist.</li>
<li>false if no object should automatically be added to the set. In this case, if the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> does not already exist 0 will be returned.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> object in this <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> with the specifed name. Or 0 if such an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> does not exist and <em>autoAdd</em> was false. </dd></dl>
</div>
</div>
<a class="anchor" id="a93afe77c8cc949acf307859910623101"></a><!-- doxytag: member="CEGUI::EventSet::isEventPresent" ref="a93afe77c8cc949acf307859910623101" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::EventSet::isEventPresent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks to see if an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> with the given name is present in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if an <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> named <em>name</em> was found, or false if the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> was not found </dd></dl>
</div>
</div>
<a class="anchor" id="a5a940a84565fb4160079c208cd8cd734"></a><!-- doxytag: member="CEGUI::EventSet::isMuted" ref="a5a940a84565fb4160079c208cd8cd734" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::EventSet::isMuted </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is muted or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is muted. All requests to fire events will be ignored.</li>
<li>false if the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is not muted. All requests to fire events are processed as normal. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a6d1af9d888959b35cb19742c95c696cc"></a><!-- doxytag: member="CEGUI::EventSet::removeAllEvents" ref="a6d1af9d888959b35cb19742c95c696cc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::EventSet::removeAllEvents </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> objects from the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="abdf7999c207be6aed0a4855373bb390a"></a><!-- doxytag: member="CEGUI::EventSet::removeEvent" ref="abdf7999c207be6aed0a4855373bb390a" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::EventSet::removeEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> with the given name. All connections to the event are disconnected. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to remove. If no such <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> exists, nothing happens.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a52411ed993eaf1880f963ad4ee065df1"></a><!-- doxytag: member="CEGUI::EventSet::setMutedState" ref="a52411ed993eaf1880f963ad4ee065df1" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::EventSet::setMutedState </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the mute state for this <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td><ul>
<li>true if the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is to be muted (no further event firing requests will be honoured until <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is unmuted).</li>
<li>false if the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a> is not to be muted and all events should fired as requested.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ab0a6d8321ef6232997ca984357a14124"></a><!-- doxytag: member="CEGUI::EventSet::subscribeEvent" ref="ab0a6d8321ef6232997ca984357a14124" args="(const String &name, Event::Subscriber subscriber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::EventSet::subscribeEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1SubscriberSlot.html">Event::Subscriber</a> </td>
<td class="paramname"><em>subscriber</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes a handler to the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. If the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> is not yet present in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>, it is created and added. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">subscriber</td><td>Function or object that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a6746c0dc89fce0b2a087622b82d87b06"></a><!-- doxytag: member="CEGUI::EventSet::subscribeEvent" ref="a6746c0dc89fce0b2a087622b82d87b06" args="(const String &name, Event::Group group, Event::Subscriber subscriber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::EventSet::subscribeEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1SubscriberSlot.html">Event::Subscriber</a> </td>
<td class="paramname"><em>subscriber</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes a handler to the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. If the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> is not yet present in the <a class="el" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects.">EventSet</a>, it is created and added. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">group</td><td>Group which is to be subscribed to. Subscription groups are called in ascending order.</td></tr>
<tr><td class="paramname">subscriber</td><td>Function or object that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a226f138d44cd9bef24327b6c2d0e291e"></a><!-- doxytag: member="CEGUI::EventSet::subscribeScriptedEvent" ref="a226f138d44cd9bef24327b6c2d0e291e" args="(const String &name, Event::Group group, const String &subscriber_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::EventSet::subscribeScriptedEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Event.html#ae8d893b984caa6aead199b2c0d60fd9f">Event::Group</a> </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_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the specified group of the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">group</td><td>Group which is to be subscribed to. Subscription groups are called in ascending order.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a098c5e838e61568a6d503102e9366352"></a><!-- doxytag: member="CEGUI::EventSet::subscribeScriptedEvent" ref="a098c5e838e61568a6d503102e9366352" args="(const String &name, const String &subscriber_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> CEGUI::EventSet::subscribeScriptedEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>subscriber_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes the named <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to a scripted funtion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> to subscribe to.</td></tr>
<tr><td class="paramname">subscriber_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the script funtion that is to be subscribed to the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Connection object that can be used to check the status of the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> connection and to disconnect (unsubscribe) from the <a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a>. </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>
|
