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
|
<!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::GlobalEventSet 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_1GlobalEventSet.html">GlobalEventSet</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::GlobalEventSet Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::GlobalEventSet" --><!-- doxytag: inherits="CEGUI::EventSet,Singleton< GlobalEventSet >" -->
<p>The <a class="el" href="classCEGUI_1_1GlobalEventSet.html" title="The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class...">GlobalEventSet</a> singleton allows you to subscribe to an event for all instances of a class. The <a class="el" href="classCEGUI_1_1GlobalEventSet.html" title="The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class...">GlobalEventSet</a> effectively supports "late binding" to events; which means you can subscribe to some event that does not actually exist (yet).
<a href="classCEGUI_1_1GlobalEventSet.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::GlobalEventSet:</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_1GlobalEventSet__inherit__graph.gif" border="0" usemap="#CEGUI_1_1GlobalEventSet_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1GlobalEventSet_inherit__map" id="CEGUI_1_1GlobalEventSet_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="5,5,131,35"/><area shape="rect" id="node4" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< GlobalEventSet \>" alt="" coords="155,5,397,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::GlobalEventSet:</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_1GlobalEventSet__coll__graph.gif" border="0" usemap="#CEGUI_1_1GlobalEventSet_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1GlobalEventSet_coll__map" id="CEGUI_1_1GlobalEventSet_coll__map">
<area shape="rect" id="node4" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< GlobalEventSet \>" alt="" coords="5,181,248,211"/><area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="64,5,189,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1GlobalEventSet-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GlobalEventSet.html#a5c4a30c64ef129cc57391912e277f1f4">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="#a5c4a30c64ef129cc57391912e277f1f4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1GlobalEventSet.html">GlobalEventSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GlobalEventSet.html#a5e55e00b73ca2e7094fbfecd9220b72c">getSingleton</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return singleton <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> object. <a href="#a5e55e00b73ca2e7094fbfecd9220b72c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1GlobalEventSet.html">GlobalEventSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1GlobalEventSet.html#a23367aa700729270c8436846a17e7cac">getSingletonPtr</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return pointer to singleton <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> object. <a href="#a23367aa700729270c8436846a17e7cac"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classCEGUI_1_1GlobalEventSet.html" title="The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class...">GlobalEventSet</a> singleton allows you to subscribe to an event for all instances of a class. The <a class="el" href="classCEGUI_1_1GlobalEventSet.html" title="The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class...">GlobalEventSet</a> effectively supports "late binding" to events; which means you can subscribe to some event that does not actually exist (yet). </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5c4a30c64ef129cc57391912e277f1f4"></a><!-- doxytag: member="CEGUI::GlobalEventSet::fireEvent" ref="a5c4a30c64ef129cc57391912e277f1f4" 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::GlobalEventSet::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 namespace prefix to use when firing the global event.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1EventSet.html#a449ba093d6b539bbb591dd7983faee8e">CEGUI::EventSet</a>.</p>
</div>
</div>
<a class="anchor" id="a5e55e00b73ca2e7094fbfecd9220b72c"></a><!-- doxytag: member="CEGUI::GlobalEventSet::getSingleton" ref="a5e55e00b73ca2e7094fbfecd9220b72c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1GlobalEventSet.html">GlobalEventSet</a>& CEGUI::GlobalEventSet::getSingleton </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return singleton <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Singleton.html">Singleton</a> <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> object </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Singleton.html">CEGUI::Singleton< GlobalEventSet ></a>.</p>
</div>
</div>
<a class="anchor" id="a23367aa700729270c8436846a17e7cac"></a><!-- doxytag: member="CEGUI::GlobalEventSet::getSingletonPtr" ref="a23367aa700729270c8436846a17e7cac" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1GlobalEventSet.html">GlobalEventSet</a>* CEGUI::GlobalEventSet::getSingletonPtr </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return pointer to singleton <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to singleton <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> object </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Singleton.html">CEGUI::Singleton< GlobalEventSet ></a>.</p>
</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>
|
