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: Functors</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>Functors</h1>Functors are copyable types that define operator()().
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">group </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mem__fun.html">mem_fun()</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="group__mem__fun.html#ga56">mem_fun()</a> is used to convert a pointer to a method to a functor. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">group </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ptr__fun.html">ptr_fun()</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="group__ptr__fun.html#ga8">ptr_fun()</a> is used to convert a pointer to a function to a functor. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">group </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slot.html">Slots</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Slots are type-safe representations of callback methods and functions. <br></td></tr>
<p>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1functor__base.html">sigc::functor_base</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A hint to the compiler. <a href="structsigc_1_1functor__base.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functors.html#ga2">SIGC_FUNCTORS_HAVE_RESULT_TYPE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If you want to mix functors from a different library with libsigc++ and these functors define <code>result_type</code> simply use this macro inside namespace sigc like so: <div class="fragment"><pre class="fragment"> <span class="keyword">namespace </span>sigc { <a class="code" href="group__functors.html#ga2">SIGC_FUNCTORS_HAVE_RESULT_TYPE</a> }
</pre></div>. <a href="#ga2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__functors.html#ga3">SIGC_FUNCTOR_TRAIT</a>(T_functor, T_return)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If you want to mix functors from a different library with libsigc++ and these functors don't define <code>result_type</code> use this macro inside namespace sigc to expose the return type of the functors like so: <div class="fragment"><pre class="fragment"> <span class="keyword">namespace </span>sigc {
<a class="code" href="group__functors.html#ga3">SIGC_FUNCTOR_TRAIT</a>(first_functor_type, return_type_of_first_functor_type)
SIGC_FUNCTOR_TRAIT(second_functor_type, return_type_of_second_functor_type)
...
}
</pre></div>. <a href="#ga3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T_action, class T_functor> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__functors.html#ga0">sigc::visit_each</a> (const T_action& _A_action, const T_functor& _A_functor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function performs a functor on each of the targets of a functor. <a href="#ga0"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T_type, class T_action, class T_functor> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__functors.html#ga1">sigc::visit_each_type</a> (const T_action& _A_action, const T_functor& _A_functor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function performs a functor on each of the targets of a functor limited to a restricted type. <a href="#ga1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Functors are copyable types that define operator()().
<p>
Types that define operator()() overloads with different return types are referred to as multi-type functors. Multi-type functors are only partly supported in libsigc++.<p>
Closures are functors that store all information needed to invoke a callback from operator()().<p>
Adaptors are functors that alter the signature of a functor's operator()().<p>
libsigc++ defines numerous functors, closures and adaptors. Since libsigc++ is a callback libaray, most functors are also closures. The documentation doesn't distinguish between functors and closures.<p>
The basic functor types libsigc++ provides are created with <a class="el" href="group__ptr__fun.html#ga8">ptr_fun()</a> and <a class="el" href="group__mem__fun.html#ga56">mem_fun()</a> and can be converted into slots implicitly. The set of adaptors that ships with libsigc++ is documented in the equally named module. <hr><h2>Define Documentation</h2>
<a class="anchor" name="ga3" doxytag="functor_trait.h::SIGC_FUNCTOR_TRAIT"></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" nowrap valign="top">#define SIGC_FUNCTOR_TRAIT </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">T_functor, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>T_return </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">template</span> <> \
<span class="keyword">struct </span>functor_trait<T_functor,false> \
{ \
<span class="keyword">typedef</span> T_return result_type; \
<span class="keyword">typedef</span> T_functor functor_type; \
};
</pre></div>If you want to mix functors from a different library with libsigc++ and these functors don't define <code>result_type</code> use this macro inside namespace sigc to expose the return type of the functors like so: <div class="fragment"><pre class="fragment"> <span class="keyword">namespace </span>sigc {
<a class="code" href="group__functors.html#ga3">SIGC_FUNCTOR_TRAIT</a>(first_functor_type, return_type_of_first_functor_type)
SIGC_FUNCTOR_TRAIT(second_functor_type, return_type_of_second_functor_type)
...
}
</pre></div>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="ga2" doxytag="functor_trait.h::SIGC_FUNCTORS_HAVE_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" nowrap valign="top">#define SIGC_FUNCTORS_HAVE_RESULT_TYPE </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">template</span> <<span class="keyword">class</span> T_functor> \
<span class="keyword">struct </span>functor_trait<T_functor,false> \
{ \
<span class="keyword">typedef</span> <span class="keyword">typename</span> T_functor::result_type result_type; \
<span class="keyword">typedef</span> T_functor functor_type; \
};
</pre></div>If you want to mix functors from a different library with libsigc++ and these functors define <code>result_type</code> simply use this macro inside namespace sigc like so: <div class="fragment"><pre class="fragment"> <span class="keyword">namespace </span>sigc { <a class="code" href="group__functors.html#ga2">SIGC_FUNCTORS_HAVE_RESULT_TYPE</a> }
</pre></div>.
<p>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ga0" doxytag="sigc::visit_each"></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_action, class T_functor> </td>
</tr>
<tr>
<td class="md" nowrap valign="top">void visit_each </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const T_action& </td>
<td class="mdname" nowrap> <em>_A_action</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const T_functor& </td>
<td class="mdname" nowrap> <em>_A_functor</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function performs a functor on each of the targets of a functor.
<p>
All unknown types just call <em>_A_action</em> on them. Add overloads that specialize the <em>T_functor</em> argument for your own functor types, so that subobjects get visited. This is needed to enable auto-disconnection support for your functor types.<p>
<dl compact><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keyword">struct </span>some_functor
{
<span class="keywordtype">void</span> operator()() {}
some_possibly_sigc_trackable_derived_type some_data_member;
some_other_functor_type some_other_functor;
}
<span class="keyword">namespace </span>sigc
{
<span class="keyword">template</span> <<span class="keyword">class</span> T_action>
<span class="keywordtype">void</span> <a class="code" href="group__adaptors.html#ga0">visit_each</a>(<span class="keyword">const</span> T_action& _A_action,
<span class="keyword">const</span> some_functor& _A_target)
{
<a class="code" href="group__adaptors.html#ga0">visit_each</a>(_A_action, _A_target.some_data_member);
<a class="code" href="group__adaptors.html#ga0">visit_each</a>(_A_action, _A_target.some_other_functor);
}
}
</pre></div></dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga1" doxytag="sigc::visit_each_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_type, class T_action, class T_functor> </td>
</tr>
<tr>
<td class="md" nowrap valign="top">void visit_each_type </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const T_action& </td>
<td class="mdname" nowrap> <em>_A_action</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const T_functor& </td>
<td class="mdname" nowrap> <em>_A_functor</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function performs a functor on each of the targets of a functor limited to a restricted type.
<p>
</td>
</tr>
</table>
<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>
|
