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
|
<!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::Slot1< T_return, T_arg1 > 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::Slot1< T_return, T_arg1 > Class Template Reference<br>
<small>
[<a class="el" href="group__compat.html">Compatibility module</a>]</small>
</h1>Converts an arbitrary functor to a unified type which is opaque.
<a href="#_details">More...</a>
<p>
Inheritance diagram for SigC::Slot1< T_return, T_arg1 >:<p><center><img src="classSigC_1_1Slot1__inherit__graph.png" border="0" usemap="#SigC_1_1Slot1_3_01T__return_00_01T__arg1_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="SigC_1_1Slot1_3_01T__return_00_01T__arg1_01_4__inherit__map">
<area href="classsigc_1_1slot.html" shape="rect" coords="61,233,258,257" alt="">
<area href="classsigc_1_1slot7.html" shape="rect" coords="8,158,312,182" alt="">
<area href="classsigc_1_1slot__base.html" shape="rect" coords="105,83,214,107" alt="">
<area href="structsigc_1_1functor__base.html" shape="rect" coords="94,9,225,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classSigC_1_1Slot1-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_1slot.html">sigc::slot</a>< T_return,<br>
T_arg1 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Slot1.html#w0">parent_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_1Slot1.html#a0">Slot1</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty slot. <a href="#a0"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T_functor> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classSigC_1_1Slot1.html#a1">Slot1</a> (const T_functor& _A_func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a slot from an arbitrary functor. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Slot1.html#a2">Slot1</a> (const <a class="el" href="classsigc_1_1slot.html">parent_type</a>& src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a slot, copying an existing one. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSigC_1_1Slot1.html">Slot1</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classSigC_1_1Slot1.html#a3">operator=</a> (const <a class="el" href="classsigc_1_1slot.html">parent_type</a>& src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overrides this slot making a copy from another slot. <a href="#a3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template <class T_return, class T_arg1><br>
class SigC::Slot1< T_return, T_arg1 ></h3>
Converts an arbitrary functor to a unified type which is opaque.
<p>
<a class="el" href="classSigC_1_1Slot1.html">Slot1</a> itself is a functor or to be more precise a closure. It contains a single, arbitrary functor (or closure) that is executed in <a class="el" href="classsigc_1_1slot7.html#a0">operator()()</a>.<p>
The template arguments determine the function signature of <a class="el" href="classsigc_1_1slot7.html#a0">operator()()</a>:<ul>
<li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1slot7.html#a0">operator()()</a>.</li><li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1slot7.html#a0">operator()()</a>.</li></ul>
<p>
To use simply assign the slot to the desired functor. If the functor is not compatible with the parameter list defined with the template arguments compiler errors are triggered. When called the slot will invoke the functor with minimal copies. <a class="el" href="classsigc_1_1slot__base.html#a10">block()</a> and <a class="el" href="classsigc_1_1slot__base.html#a11">unblock()</a> can be used to block the functor's invocation from <a class="el" href="classsigc_1_1slot7.html#a0">operator()()</a> temporarily.<p>
<dl compact><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <<a class="code" href="slot_8h.html">sigc++/slot.h</a>></span>
<span class="keywordtype">void</span> foo(<span class="keywordtype">int</span>) {}
<a class="code" href="classSigC_1_1Slot1.html">SigC::Slot1<void, long></a> s = <a class="code" href="group__compat.html#ga17">SigC::slot</a>(&foo);
s(19);
</pre></div></dd></dl>
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000103">Deprecated:</a></b></dt><dd>Use the unnumbered template <a class="el" href="classsigc_1_1slot.html">sigc::slot</a> instead.</dd></dl>
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="SigC::Slot1::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> </td>
</tr>
<tr>
<td class="md" nowrap valign="top">typedef ::<a class="el" href="classsigc_1_1slot.html">sigc::slot</a><T_return, T_arg1> <a class="el" href="classSigC_1_1Slot1.html">SigC::Slot1</a><T_return, T_arg1>::<a class="el" href="classsigc_1_1slot.html">parent_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_1slot.html#w0">sigc::slot<T_return, T_arg1></a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="SigC::Slot1::Slot1"></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> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Slot1.html">SigC::Slot1</a><T_return, T_arg1>::<a class="el" href="classSigC_1_1Slot1.html">Slot1</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>
Constructs an empty slot.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="SigC::Slot1::Slot1"></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> </td>
</tr>
<tr>
<td class="md" colspan="4">
template <class T_functor> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Slot1.html">SigC::Slot1</a><T_return, T_arg1>::<a class="el" href="classSigC_1_1Slot1.html">Slot1</a> </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const T_functor& </td>
<td class="mdname1" valign="top" nowrap> <em>_A_func</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>
Constructs a slot from an arbitrary functor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_A_func</em> </td><td>The desired functor the new slot should be assigned to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="SigC::Slot1::Slot1"></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> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Slot1.html">SigC::Slot1</a><T_return, T_arg1>::<a class="el" href="classSigC_1_1Slot1.html">Slot1</a> </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="classsigc_1_1slot.html">parent_type</a>& </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>
Constructs a slot, copying an existing one.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The existing slot to copy. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a3" doxytag="SigC::Slot1::operator="></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> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSigC_1_1Slot1.html">Slot1</a>& <a class="el" href="classSigC_1_1Slot1.html">SigC::Slot1</a><T_return, T_arg1>::operator= </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="classsigc_1_1slot.html">parent_type</a>& </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>
Overrides this slot making a copy from another slot.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The slot from which to make a copy. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>this</code>. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="slot_8h.html">slot.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>
|