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
|
<!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::SubscriberSlot 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_1SubscriberSlot.html">SubscriberSlot</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::SubscriberSlot Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::SubscriberSlot" -->
<p><a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> class which is used when subscribing to events.
<a href="classCEGUI_1_1SubscriberSlot.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::SubscriberSlot:</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_1SubscriberSlot__coll__graph.gif" border="0" usemap="#CEGUI_1_1SubscriberSlot_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1SubscriberSlot_coll__map" id="CEGUI_1_1SubscriberSlot_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1SlotFunctorBase.html" title="Defines abstract interface which will be used when constructing various functor objects that bind slo..." alt="" coords="5,5,176,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1SubscriberSlot-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"><a class="anchor" id="ad1d9d187bf18dfdc354f145e43ec99ba"></a><!-- doxytag: member="CEGUI::SubscriberSlot::SubscriberSlot" ref="ad1d9d187bf18dfdc354f145e43ec99ba" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#ad1d9d187bf18dfdc354f145e43ec99ba">SubscriberSlot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Creates a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> with no bound slot. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94c03f62a5cd57b61705ba1ff48bbd1c"></a><!-- doxytag: member="CEGUI::SubscriberSlot::SubscriberSlot" ref="a94c03f62a5cd57b61705ba1ff48bbd1c" args="(FreeFunctionSlot::SlotFunction *func)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#a94c03f62a5cd57b61705ba1ff48bbd1c">SubscriberSlot</a> (<a class="el" href="classCEGUI_1_1FreeFunctionSlot.html#a5729d7dea7bfa7c1eac4dcea5212c89f">FreeFunctionSlot::SlotFunction</a> *func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> that is bound to a free function. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a875e81bf2b6ab2b5de16139753b79bc5"></a><!-- doxytag: member="CEGUI::SubscriberSlot::~SubscriberSlot" ref="a875e81bf2b6ab2b5de16139753b79bc5" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#a875e81bf2b6ab2b5de16139753b79bc5">~SubscriberSlot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. Note this is non-virtual, which should be telling you not to sub-class! <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56c5564397d313e5d6b3f0cfc3bacd86"></a><!-- doxytag: member="CEGUI::SubscriberSlot::operator()" ref="a56c5564397d313e5d6b3f0cfc3bacd86" args="(const EventArgs &args) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#a56c5564397d313e5d6b3f0cfc3bacd86">operator()</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &args) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invokes the slot functor that is bound to this Subscriber. Returns whatever the slot returns, unless there is not slot bound when false is always returned. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34636ac599809d59602b4b860727d13a"></a><!-- doxytag: member="CEGUI::SubscriberSlot::connected" ref="a34636ac599809d59602b4b860727d13a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#a34636ac599809d59602b4b860727d13a">connected</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> is internally connected (bound). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeed8d37fe488c8eac7856c91be7e86ff"></a><!-- doxytag: member="CEGUI::SubscriberSlot::cleanup" ref="aeed8d37fe488c8eac7856c91be7e86ff" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#aeed8d37fe488c8eac7856c91be7e86ff">cleanup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnects the slot internally and performs any required cleanup operations. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="aa6a5cf45ae750718f061df780adce1f3"></a><!-- doxytag: member="CEGUI::SubscriberSlot::SubscriberSlot" ref="aa6a5cf45ae750718f061df780adce1f3" args="(bool(T::*function)(const EventArgs &), T *obj)" -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#aa6a5cf45ae750718f061df780adce1f3">SubscriberSlot</a> (bool(T::*function)(const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &), T *obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> that is bound to a member function. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a3500c80fb033606f82f90ee19e1f753c"></a><!-- doxytag: member="CEGUI::SubscriberSlot::SubscriberSlot" ref="a3500c80fb033606f82f90ee19e1f753c" args="(const FunctorReferenceBinder< T > &binder)" -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#a3500c80fb033606f82f90ee19e1f753c">SubscriberSlot</a> (const <a class="el" href="structCEGUI_1_1FunctorReferenceBinder.html">FunctorReferenceBinder</a>< T > &binder)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> that is bound to a functor object reference. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ae01f316672b422c61c596ffaeef7b4b5"></a><!-- doxytag: member="CEGUI::SubscriberSlot::SubscriberSlot" ref="ae01f316672b422c61c596ffaeef7b4b5" args="(const T &functor)" -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#ae01f316672b422c61c596ffaeef7b4b5">SubscriberSlot</a> (const T &functor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> that is bound to a copy of a functor object. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7827e841e00ca0e8490e1ca85c839b9c"></a><!-- doxytag: member="CEGUI::SubscriberSlot::SubscriberSlot" ref="a7827e841e00ca0e8490e1ca85c839b9c" args="(T *functor)" -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SubscriberSlot.html#a7827e841e00ca0e8490e1ca85c839b9c">SubscriberSlot</a> (T *functor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> that is bound to a functor pointer. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> class which is used when subscribing to events. </p>
<p>For many uses, the construction of the <a class="el" href="classCEGUI_1_1SubscriberSlot.html" title="SubscriberSlot class which is used when subscribing to events.">SubscriberSlot</a> may be implicit, so you do not have to specify Subscriber in your subscription calls. Notable exceptions are for subscribing member functions and references to functor objects. </p>
</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>
|
