docs/reference/html/group__hide.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.9.1"/>
   7 <title>libsigc++: hide(), hide_return()</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libsigc++
  22    &#160;<span id="projectnumber">2.99.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="modules.html"><span>Modules</span></a></li>
  36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  37       <li><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Classes</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">hide(), hide_return()<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p><a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide()</a> alters an arbitrary functor in that it adds a parameter whose value is ignored on invocation of the returned functor.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  54 Classes</h2></td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor.html">sigc::hide_functor&lt; I_location, T_functor &gt;</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adaptor that adds a dummy parameter to the wrapped functor.  <a href="structsigc_1_1hide__functor.html#details">More...</a><br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 </table><table class="memberdecls">
  59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  60 Functions</h2></td></tr>
  61 <tr class="memitem:gaba7e613a3b4fc1a6c6188194c5c54849"><td class="memTemplParams" colspan="2">template&lt;int I_location, class T_functor &gt; </td></tr>
  62 <tr class="memitem:gaba7e613a3b4fc1a6c6188194c5c54849"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849">sigc::hide</a> (const T_functor&amp; _A_func)</td></tr>
  63 <tr class="memdesc:gaba7e613a3b4fc1a6c6188194c5c54849"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">sigc::hide_functor</a> which adds a dummy parameter to the passed functor.  <a href="#gaba7e613a3b4fc1a6c6188194c5c54849">More...</a><br /></td></tr>
  64 <tr class="separator:gaba7e613a3b4fc1a6c6188194c5c54849"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:ga397f9ea6927c30e36d1f20163356649b"><td class="memTemplParams" colspan="2">template&lt;class T_functor &gt; </td></tr>
  66 <tr class="memitem:ga397f9ea6927c30e36d1f20163356649b"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#ga397f9ea6927c30e36d1f20163356649b">sigc::hide</a> (const T_functor&amp; _A_func)</td></tr>
  67 <tr class="memdesc:ga397f9ea6927c30e36d1f20163356649b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">sigc::hide_functor</a> which adds a dummy parameter to the passed functor.  <a href="#ga397f9ea6927c30e36d1f20163356649b">More...</a><br /></td></tr>
  68 <tr class="separator:ga397f9ea6927c30e36d1f20163356649b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:gae4e6f5491471c12440f1c5d480726b98"><td class="memTemplParams" colspan="2">template&lt;class T_functor &gt; </td></tr>
  70 <tr class="memitem:gae4e6f5491471c12440f1c5d480726b98"><td class="memTemplItemLeft" align="right" valign="top">retype_return_functor&lt; void, T_functor &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gae4e6f5491471c12440f1c5d480726b98">sigc::hide_return</a> (const T_functor&amp; _A_functor)</td></tr>
  71 <tr class="memdesc:gae4e6f5491471c12440f1c5d480726b98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1retype__return__functor.html" title="Adaptor that performs a C-style cast on the return value of a functor. ">sigc::retype_return_functor</a> which drops the return value of the passed functor.  <a href="#gae4e6f5491471c12440f1c5d480726b98">More...</a><br /></td></tr>
  72 <tr class="separator:gae4e6f5491471c12440f1c5d480726b98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 </table>
  74 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  75 <p><a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide()</a> alters an arbitrary functor in that it adds a parameter whose value is ignored on invocation of the returned functor. </p>
  76 <p>Thus you can discard one argument of a signal.</p>
  77 <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#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide</a>&lt;-1&gt;() gives the same result as <a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide()</a>.)</p>
  78 <p>The type of the parameter can optionally be specified if not deduced.</p>
  79 <dl class="section user"><dt>Examples:</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">void</span> foo(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>);</div>
  80 <div class="line"><span class="comment">// single argument hiding ...</span></div>
  81 <div class="line"><a class="code" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849">sigc::hide</a>(&amp;foo)(1,2,3);     <span class="comment">// adds a dummy parameter at the back and calls foo(1,2)</span></div>
  82 <div class="line"><a class="code" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849">sigc::hide</a>&lt;-1&gt;(&amp;foo)(1,2,3); <span class="comment">// same as sigc::hide(&amp;foo)(1,2,3) (calls foo(1,2))</span></div>
  83 <div class="line">sigc::hide&lt;0&gt;(&amp;foo)(1,2,3);  <span class="comment">// adds a dummy parameter at the beginning and calls foo(2,3)</span></div>
  84 <div class="line">sigc::hide&lt;1&gt;(&amp;foo)(1,2,3);  <span class="comment">// adds a dummy parameter in the middle and calls foo(1,3)</span></div>
  85 <div class="line">sigc::hide&lt;2&gt;(&amp;foo)(1,2,3);  <span class="comment">// adds a dummy parameter at the back and calls foo(1,2)</span></div>
  86 </div><!-- fragment --></dd></dl>
  87 <p>The functor <a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide()</a> returns can be directly passed into sigc::signal::connect().</p>
  88 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><a class="code" href="classsigc_1_1signal.html">sigc::signal&lt;void(int)&gt;</a> some_signal;</div>
  89 <div class="line"><span class="keywordtype">void</span> foo();</div>
  90 <div class="line">some_signal.connect(<a class="code" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849">sigc::hide</a>(&amp;foo));</div>
  91 </div><!-- fragment --></dd></dl>
  92 <p><a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide()</a> can be nested in order to discard multiple arguments. </p><dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="comment">// multiple argument hiding ...</span></div>
  93 <div class="line"><a class="code" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849">sigc::hide</a>(<a class="code" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849">sigc::hide</a>(&amp;foo))(1,2,3,4); <span class="comment">// adds two dummy parameters at the back and calls foo(1,2)</span></div>
  94 </div><!-- fragment --></dd></dl>
  95 <p><a class="el" href="group__hide.html#gae4e6f5491471c12440f1c5d480726b98" title="Creates an adaptor of type sigc::retype_return_functor which drops the return value of the passed fun...">sigc::hide_return()</a> alters an arbitrary functor by dropping its return value, thus converting it to a void functor. </p>
  96 <h2 class="groupheader">Function Documentation</h2>
  97 <a class="anchor" id="gaba7e613a3b4fc1a6c6188194c5c54849"></a>
  98 <div class="memitem">
  99 <div class="memproto">
 100 <div class="memtemplate">
 101 template &lt;int I_location, class T_functor &gt; </div>
 102 <table class="mlabels">
 103   <tr>
 104   <td class="mlabels-left">
 105       <table class="memname">
 106         <tr>
 107           <td class="memname">decltype(auto) sigc::hide </td>
 108           <td>(</td>
 109           <td class="paramtype">const T_functor &amp;&#160;</td>
 110           <td class="paramname"><em>_A_func</em></td><td>)</td>
 111           <td></td>
 112         </tr>
 113       </table>
 114   </td>
 115   <td class="mlabels-right">
 116 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 117   </tr>
 118 </table>
 119 </div><div class="memdoc">
 120
 121 <p>Creates an adaptor of type <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">sigc::hide_functor</a> which adds a dummy parameter to the passed functor. </p>
 122 <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>
 123 <dl class="params"><dt>Parameters</dt><dd>
 124   <table class="params">
 125     <tr><td class="paramname">_A_func</td><td>Functor that should be wrapped. </td></tr>
 126   </table>
 127   </dd>
 128 </dl>
 129 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_func</em>, ignoring the value of the dummy parameter. </dd></dl>
 130
 131 </div>
 132 </div>
 133 <a class="anchor" id="ga397f9ea6927c30e36d1f20163356649b"></a>
 134 <div class="memitem">
 135 <div class="memproto">
 136 <div class="memtemplate">
 137 template &lt;class T_functor &gt; </div>
 138 <table class="mlabels">
 139   <tr>
 140   <td class="mlabels-left">
 141       <table class="memname">
 142         <tr>
 143           <td class="memname">decltype(auto) sigc::hide </td>
 144           <td>(</td>
 145           <td class="paramtype">const T_functor &amp;&#160;</td>
 146           <td class="paramname"><em>_A_func</em></td><td>)</td>
 147           <td></td>
 148         </tr>
 149       </table>
 150   </td>
 151   <td class="mlabels-right">
 152 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 153   </tr>
 154 </table>
 155 </div><div class="memdoc">
 156
 157 <p>Creates an adaptor of type <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">sigc::hide_functor</a> which adds a dummy parameter to the passed functor. </p>
 158 <p>This overload adds a dummy parameter at the back of the functor's parameter list.</p>
 159 <dl class="params"><dt>Parameters</dt><dd>
 160   <table class="params">
 161     <tr><td class="paramname">_A_func</td><td>Functor that should be wrapped. </td></tr>
 162   </table>
 163   </dd>
 164 </dl>
 165 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_func</em>, ignoring the value of the last parameter. </dd></dl>
 166
 167 </div>
 168 </div>
 169 <a class="anchor" id="gae4e6f5491471c12440f1c5d480726b98"></a>
 170 <div class="memitem">
 171 <div class="memproto">
 172 <div class="memtemplate">
 173 template &lt;class T_functor &gt; </div>
 174 <table class="mlabels">
 175   <tr>
 176   <td class="mlabels-left">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname">retype_return_functor&lt;void, T_functor&gt; sigc::hide_return </td>
 180           <td>(</td>
 181           <td class="paramtype">const T_functor &amp;&#160;</td>
 182           <td class="paramname"><em>_A_functor</em></td><td>)</td>
 183           <td></td>
 184         </tr>
 185       </table>
 186   </td>
 187   <td class="mlabels-right">
 188 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 189   </tr>
 190 </table>
 191 </div><div class="memdoc">
 192
 193 <p>Creates an adaptor of type <a class="el" href="structsigc_1_1retype__return__functor.html" title="Adaptor that performs a C-style cast on the return value of a functor. ">sigc::retype_return_functor</a> which drops the return value of the passed functor. </p>
 194 <dl class="params"><dt>Parameters</dt><dd>
 195   <table class="params">
 196     <tr><td class="paramname">_A_functor</td><td>Functor that should be wrapped. </td></tr>
 197   </table>
 198   </dd>
 199 </dl>
 200 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_functor</em> dropping its return value. </dd></dl>
 201
 202 </div>
 203 </div>
 204 </div><!-- contents -->
 205 <!-- start footer part -->
 206 <hr class="footer"/><address class="footer"><small>
 207 Generated on Wed Mar 16 2016 20:53:27 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 208 <img class="footer" src="doxygen.png" alt="doxygen"/>
 209 </a> 1.8.9.1
 210 </small></address>
 211 </body>
 212 </html>