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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libsigc++ 2.0: SigC::Signal5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/libsigc_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a class="qindex" href="modules.html">Groups</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
</center>
<hr width="100%"/>
<!-- Generated by Doxygen 1.3.9.1 -->
<h1>SigC::Signal5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator > Class Template Reference<br>
<small>
[<a class="el" href="group__compat.html">Compatibility module</a>]</small>
</h1>Signal declaration.
<a href="#_details">More...</a>
<p>
Inheritance diagram for SigC::Signal5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator >:<p><center><img src="classSigC_1_1Signal5__inherit__graph.png" border="0" usemap="#SigC_1_1Signal5_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__accumulator_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="SigC_1_1Signal5_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__accumulator_01_4__inherit__map">
<area href="classsigc_1_1signal5.html" shape="rect" coords="10,158,522,182" alt="">
<area href="structsigc_1_1signal__base.html" shape="rect" coords="205,84,327,108" alt="">
<area href="structsigc_1_1trackable.html" shape="rect" coords="213,9,319,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classSigC_1_1Signal5-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef ::<a class="el" href="classsigc_1_1signal5.html">sigc::signal5</a>< T_return,<br>
T_arg1, T_arg2, T_arg3, T_arg4,<br>
T_arg5, T_accumulator > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Signal5.html#w0">parent_type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classsigc_1_1signal5.html#w1">parent_type::result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Signal5.html#w1">result_type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classsigc_1_1signal5.html#w2">parent_type::slot_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Signal5.html#w2">slot_type</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Signal5.html#a0">Signal5</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Signal5.html#a1">Signal5</a> (const <a class="el" href="classSigC_1_1Signal5.html">Signal5</a>& src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSigC_1_1Signal5.html#w2">slot_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Signal5.html#a2">slot</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a functor that calls <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a> on this signal. <a href="#a2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil><br>
class SigC::Signal5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator ></h3>
Signal declaration.
<p>
<a class="el" href="classSigC_1_1Signal5.html">Signal5</a> can be used to <a class="el" href="classsigc_1_1signal5.html#a0">connect()</a> slots that are invoked during subsequent calls to <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a>. Any functor or slot can be passed into <a class="el" href="classsigc_1_1signal5.html#a0">connect()</a>. It is converted into a slot implicitely.<p>
If you want to connect one signal to another, use <a class="el" href="classSigC_1_1Signal5.html#a2">slot()</a> to retrieve a functor that emits the signal when invoked.<p>
Be careful if you directly pass one signal into the <a class="el" href="classsigc_1_1signal5.html#a0">connect()</a> method of another: a shallow copy of the signal is made and the signal's slots are not disconnected until both the signal and its clone are destroyed which is probably not what you want!<p>
An STL-style list interface for the signal's list of slots can be retrieved with <a class="el" href="classsigc_1_1signal5.html#a4">slots()</a>. This interface supports iteration, insertion and removal of slots.<p>
The following template arguments are used:<ul>
<li><em>T_return</em> The desired return type for the <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a> function (may be overridden by the accumulator).</li><li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a>.</li><li><em>T_arg2</em> Argument type used in the definition of <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a>.</li><li><em>T_arg3</em> Argument type used in the definition of <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a>.</li><li><em>T_arg4</em> Argument type used in the definition of <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a>.</li><li><em>T_arg5</em> Argument type used in the definition of <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a>.</li><li><em>T_accumulator</em> The accumulator type used for emission. The default <code>nil</code> means that no accumulator should be used. Signal emission returns the return value of the last slot invoked.</li></ul>
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000099">Deprecated:</a></b></dt><dd>Use the unnumbered template <a class="el" href="classsigc_1_1signal.html">sigc::signal</a> instead.</dd></dl>
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="SigC::Signal5::parent_type"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil> </td>
</tr>
<tr>
<td class="md" nowrap valign="top">typedef ::<a class="el" href="classsigc_1_1signal5.html">sigc::signal5</a><T_return, T_arg1,T_arg2,T_arg3,T_arg4,T_arg5, T_accumulator> <a class="el" href="classSigC_1_1Signal5.html">SigC::Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>::<a class="el" href="classsigc_1_1signal5.html">parent_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="w1" doxytag="SigC::Signal5::result_type"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil> </td>
</tr>
<tr>
<td class="md" nowrap valign="top">typedef <a class="el" href="classsigc_1_1signal5.html#w1">parent_type::result_type</a> <a class="el" href="classSigC_1_1Signal5.html">SigC::Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>::<a class="el" href="classSigC_1_1Signal5.html#w1">result_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classsigc_1_1signal5.html#w1">sigc::signal5<T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator></a>. </td>
</tr>
</table>
<a class="anchor" name="w2" doxytag="SigC::Signal5::slot_type"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil> </td>
</tr>
<tr>
<td class="md" nowrap valign="top">typedef <a class="el" href="classsigc_1_1signal5.html#w2">parent_type::slot_type</a> <a class="el" href="classSigC_1_1Signal5.html">SigC::Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>::<a class="el" href="classSigC_1_1Signal5.html#w2">slot_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classsigc_1_1signal5.html#w2">sigc::signal5<T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator></a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="SigC::Signal5::Signal5"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Signal5.html">SigC::Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>::<a class="el" href="classSigC_1_1Signal5.html">Signal5</a> </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="SigC::Signal5::Signal5"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Signal5.html">SigC::Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>::<a class="el" href="classSigC_1_1Signal5.html">Signal5</a> </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="classSigC_1_1Signal5.html">Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>& </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="SigC::Signal5::slot"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_accumulator = ::sigc::nil> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Signal5.html#w2">slot_type</a> <a class="el" href="classSigC_1_1Signal5.html">SigC::Signal5</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator>::slot </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates a functor that calls <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a> on this signal.
<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="group__mem__fun.html#ga56">sigc::mem_fun</a>(mysignal, &sigc::signal5::emit)
</pre></div>yields the same result. <dl compact><dt><b>Returns:</b></dt><dd>A functor that calls <a class="el" href="classsigc_1_1signal5.html#a1">emit()</a> on this signal. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="signal_8h.html">signal.h</a></ul>
<hr><address><small>
Generated for libsigc++ 2.0 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3.9.1 © 1997-2001</small></address>
</body>
</html>
|
