mirror of
https://github.com/AntonioND/tobkit.git
synced 2025-06-20 01:25:42 -04:00
196 lines
15 KiB
HTML
196 lines
15 KiB
HTML
<!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: hide(), hide_return()</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.5.1 -->
|
|
<h1>hide(), hide_return()<br>
|
|
<small>
|
|
[<a class="el" href="group__adaptors.html">Adaptors</a>]</small>
|
|
</h1>
|
|
<p>
|
|
Collaboration diagram for hide(), hide_return():<center><table><tr><td><img src="group__hide.png" border="0" alt="" usemap="#group____hide_map">
|
|
<map name="group____hide_map">
|
|
<area href="group__adaptors.html" shape="rect" coords="5,5,85,32" alt="">
|
|
</map></td></tr></table></center>
|
|
<a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide()</a> alters an arbitrary functor in that it adds a parameter whose value is ignored on invocation of the returned functor.
|
|
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<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_1hide__functor_3-1_00_01T__functor_01_4.html">sigc::hide_functor<-1, T_functor ></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3-1_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_010_00_01T__functor_01_4.html">sigc::hide_functor<0, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_010_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_011_00_01T__functor_01_4.html">sigc::hide_functor<1, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_011_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_012_00_01T__functor_01_4.html">sigc::hide_functor<2, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_012_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_013_00_01T__functor_01_4.html">sigc::hide_functor<3, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_013_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_014_00_01T__functor_01_4.html">sigc::hide_functor<4, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_014_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_015_00_01T__functor_01_4.html">sigc::hide_functor<5, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_015_00_01T__functor_01_4.html#_details">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor_3_016_00_01T__functor_01_4.html">sigc::hide_functor<6, T_functor></a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor. <a href="structsigc_1_1hide__functor_3_016_00_01T__functor_01_4.html#_details">More...</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, int I_location, 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__hide.html#ga07f0ffec52a12cd7dcf1601938b247c">sigc::visit_each</a> (const T_action& _A_action, const hide_functor<I_location, T_functor>& _A_target)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Performs a functor on each of the targets of a functor. <a href="#ga07f0ffec52a12cd7dcf1601938b247c"></a><br></td></tr>
|
|
<tr><td class="memTemplParams" nowrap colspan="2">template<int I_location, class T_functor> </td></tr>
|
|
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">hide_functor< I_location,<br>
|
|
T_functor > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a> (const T_functor& _A_func)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor. <a href="#g6e9653e79dbd111f458a2ccd690dadc6"></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">retype_return_functor< void,<br>
|
|
T_functor > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gd7e18e1edbbefe13216eb344bd522f0a">sigc::hide_return</a> (const T_functor& _A_functor)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1retype__return__functor.html">sigc::retype_return_functor</a> which drops the return value of the passed functor. <a href="#gd7e18e1edbbefe13216eb344bd522f0a"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
<a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide()</a> alters an arbitrary functor in that it adds a parameter whose value is ignored on invocation of the returned functor.
|
|
<p>
|
|
Thus you can discard one or more of the arguments of a signal.<p>
|
|
You may optionally specify the zero-based position of the parameter to ignore as a template argument. The default is to ignore the last parameter. (A value of <code>-1</code> adds a parameter at the end so <a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a><-1>() gives the same result as <a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide()</a>.)<p>
|
|
The type of the parameter can optionally be specified if not deduced.<p>
|
|
<dl class="user" compact><dt><b>Examples:</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> foo(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
|
|
<span class="comment">// single argument hiding ...</span>
|
|
<a class="code" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a>(&foo)(1,2,3); <span class="comment">// adds a dummy parameter at the back and calls foo(1,2)</span>
|
|
<a class="code" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a><-1>(&foo)(1,2,3); <span class="comment">// same as sigc::hide(&foo)(1,2,3) (calls foo(1,2))</span>
|
|
sigc::hide<0>(&foo)(1,2,3); <span class="comment">// adds a dummy parameter at the beginning and calls foo(2,3)</span>
|
|
sigc::hide<1>(&foo)(1,2,3); <span class="comment">// adds a dummy parameter in the middle and calls foo(1,3)</span>
|
|
sigc::hide<2>(&foo)(1,2,3); <span class="comment">// adds a dummy parameter at the back and calls foo(1,2)</span>
|
|
<span class="comment">// multiple argument hiding ...</span>
|
|
<a class="code" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a>(<a class="code" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a>(&foo))(1,2,3,4); <span class="comment">// adds two dummy parameters at the back and calls foo(1,2)</span>
|
|
</pre></div></dd></dl>
|
|
The functor <a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide()</a> returns can be passed into <a class="el" href="classsigc_1_1signal7.html#dc55ac9b0f935fd87a67904022e03cb2">sigc::signal::connect()</a> directly.<p>
|
|
<dl class="user" compact><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"> <a class="code" href="classsigc_1_1signal.html">sigc::signal<void,int></a> some_signal;
|
|
<span class="keywordtype">void</span> foo();
|
|
some_signal.<a class="code" href="classsigc_1_1signal7.html#dc55ac9b0f935fd87a67904022e03cb2">connect</a>(<a class="code" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide</a>(&foo));
|
|
</pre></div></dd></dl>
|
|
<a class="el" href="group__hide.html#gd7e18e1edbbefe13216eb344bd522f0a">sigc::hide_return()</a> alters an arbitrary functor by dropping its return value, thus converting it to a void functor.<p>
|
|
For a more powerful version of this functionality see the lambda library adaptor <a class="el" href="namespacesigc.html#d36281e6ca158599b36980a801f41aac">sigc::group()</a> which can bind, hide and reorder arguments arbitrarily. Although <a class="el" href="namespacesigc.html#d36281e6ca158599b36980a801f41aac">sigc::group()</a> is more flexible, <a class="el" href="group__hide.html#g6e9653e79dbd111f458a2ccd690dadc6">sigc::hide()</a> provides a means of hiding parameters when then total number of parameters called is variable. <hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="g6e9653e79dbd111f458a2ccd690dadc6"></a><!-- doxytag: member="sigc::hide" ref="g6e9653e79dbd111f458a2ccd690dadc6" args="(const T_functor &_A_func)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template <int I_location, class T_functor> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">hide_functor<-1, T_functor > sigc::hide </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T_functor & </td>
|
|
<td class="paramname"> <em>_A_func</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor.
|
|
<p>
|
|
The optional template argument <em>I_location</em> specifies the zero-based position of the dummy parameter in the returned functor (<code>-1</code> stands for the last parameter).<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>Functor that should be wrapped. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Adaptor that executes <em>_A_func</em> ignoring the value of the dummy parameter. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="gd7e18e1edbbefe13216eb344bd522f0a"></a><!-- doxytag: member="sigc::hide_return" ref="gd7e18e1edbbefe13216eb344bd522f0a" args="(const T_functor &_A_functor)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template <class T_functor> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">retype_return_functor<void, T_functor> sigc::hide_return </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T_functor & </td>
|
|
<td class="paramname"> <em>_A_functor</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Creates an adaptor of type <a class="el" href="structsigc_1_1retype__return__functor.html">sigc::retype_return_functor</a> which drops the return value of the passed 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_functor</em> </td><td>Functor that should be wrapped. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Adaptor that executes <em>_A_functor</em> dropping its return value. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ga07f0ffec52a12cd7dcf1601938b247c"></a><!-- doxytag: member="sigc::visit_each" ref="ga07f0ffec52a12cd7dcf1601938b247c" args="(const T_action &_A_action, const hide_functor< I_location, T_functor > &_A_target)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template <class T_action, int I_location, class T_functor> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sigc::visit_each </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T_action & </td>
|
|
<td class="paramname"> <em>_A_action</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const hide_functor< I_location, T_functor > & </td>
|
|
<td class="paramname"> <em>_A_target</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Performs a functor on each of the targets of a functor.
|
|
<p>
|
|
The function overload for sigc::hide_functor performs a functor on the functor stored in the sigc::hide_functor object.
|
|
</div>
|
|
</div><p>
|
|
<hr><address><small>
|
|
Generated for libsigc++ 2.0 by <a href="http://www.doxygen.org/index.html">
|
|
Doxygen</a> 1.5.1 © 1997-2001</small></address>
|
|
</body>
|
|
</html>
|