untracked/docs/reference/html/group__hide.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>libsigc++: hide(), hide_return()</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  14 </head>
  15 <body>
  16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17 <div id="titlearea">
  18 <table cellspacing="0" cellpadding="0">
  19  <tbody>
  20  <tr style="height: 56px;">
  21   <td id="projectalign" style="padding-left: 0.5em;">
  22    <div id="projectname">libsigc++
  23    &#160;<span id="projectnumber">2.10.8</span>
  24    </div>
  25   </td>
  26  </tr>
  27  </tbody>
  28 </table>
  29 </div>
  30 <!-- end header part -->
  31 <!-- Generated by Doxygen 1.9.1 -->
  32 <script type="text/javascript" src="menudata.js"></script>
  33 <script type="text/javascript" src="menu.js"></script>
  34 <script type="text/javascript">
  35 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36 $(function() {
  37   initMenu('',false,false,'search.php','Search');
  38 });
  39 /* @license-end */</script>
  40 <div id="main-nav"></div>
  41 </div><!-- top -->
  42 <div class="header">
  43   <div class="summary">
  44 <a href="#nested-classes">Classes</a> &#124;
  45 <a href="#func-members">Functions</a>  </div>
  46   <div class="headertitle">
  47 <div class="title">hide(), hide_return()<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div>  </div>
  48 </div><!--header-->
  49 <div class="contents">
  50
  51 <p><a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d" 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.
  52 <a href="#details">More...</a></p>
  53 <table class="memberdecls">
  54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  55 Classes</h2></td></tr>
  56 <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>
  57 <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>
  58 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 <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_3_010_00_01T__functor_01_4.html">sigc::hide_functor&lt; 0, T_functor &gt;</a></td></tr>
  60 <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_3_010_00_01T__functor_01_4.html#details">More...</a><br /></td></tr>
  61 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 <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_3-1_00_01T__functor_01_4.html">sigc::hide_functor&lt;-1, T_functor &gt;</a></td></tr>
  63 <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_3-1_00_01T__functor_01_4.html#details">More...</a><br /></td></tr>
  64 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table><table class="memberdecls">
  66 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  67 Functions</h2></td></tr>
  68 <tr class="memitem:gaf2cefea3a99acd44f68121424103172d"><td class="memTemplParams" colspan="2">template&lt;int I_location, class T_functor &gt; </td></tr>
  69 <tr class="memitem:gaf2cefea3a99acd44f68121424103172d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a>&lt; I_location, T_functor &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">sigc::hide</a> (const T_functor &amp; _A_func)</td></tr>
  70 <tr class="memdesc:gaf2cefea3a99acd44f68121424103172d"><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="group__hide.html#gaf2cefea3a99acd44f68121424103172d">More...</a><br /></td></tr>
  71 <tr class="separator:gaf2cefea3a99acd44f68121424103172d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:gacbbacd3553268d85b95e3a85aefb67e5"><td class="memTemplParams" colspan="2">template&lt;class T_functor &gt; </td></tr>
  73 <tr class="memitem:gacbbacd3553268d85b95e3a85aefb67e5"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a>&lt;-1, T_functor &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gacbbacd3553268d85b95e3a85aefb67e5">sigc::hide</a> (const T_functor &amp; _A_func)</td></tr>
  74 <tr class="memdesc:gacbbacd3553268d85b95e3a85aefb67e5"><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="group__hide.html#gacbbacd3553268d85b95e3a85aefb67e5">More...</a><br /></td></tr>
  75 <tr class="separator:gacbbacd3553268d85b95e3a85aefb67e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:gae4e6f5491471c12440f1c5d480726b98"><td class="memTemplParams" colspan="2">template&lt;class T_functor &gt; </td></tr>
  77 <tr class="memitem:gae4e6f5491471c12440f1c5d480726b98"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1retype__return__functor.html">retype_return_functor</a>&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>
  78 <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="group__hide.html#gae4e6f5491471c12440f1c5d480726b98">More...</a><br /></td></tr>
  79 <tr class="separator:gae4e6f5491471c12440f1c5d480726b98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 </table>
  81 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  82 <p><a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d" 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>
  83 <p>Thus you can discard one argument of a signal.</p>
  84 <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#gaf2cefea3a99acd44f68121424103172d" 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#gaf2cefea3a99acd44f68121424103172d" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor.">sigc::hide()</a>.)</p>
  85 <p>The type of the parameter can optionally be specified if not deduced.</p>
  86 <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>
  87 <div class="line"><span class="comment">// single argument hiding ...</span></div>
  88 <div class="line"><a class="code" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">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>
  89 <div class="line"><a class="code" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">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>
  90 <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>
  91 <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>
  92 <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>
  93 <div class="ttc" id="agroup__hide_html_gaf2cefea3a99acd44f68121424103172d"><div class="ttname"><a href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">sigc::hide</a></div><div class="ttdeci">hide_functor&lt; I_location, T_functor &gt; hide(const T_functor &amp;_A_func)</div><div class="ttdoc">Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor.</div><div class="ttdef"><b>Definition:</b> hide.h:1061</div></div>
  94 </div><!-- fragment --></dd></dl>
  95 <p>The functor <a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d" 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 <a class="el" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2" title="Add a slot to the list of slots.">sigc::signal::connect()</a>.</p>
  96 <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>
  97 <div class="line"><span class="keywordtype">void</span> foo();</div>
  98 <div class="line">some_signal.<a class="code" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2">connect</a>(<a class="code" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">sigc::hide</a>(&amp;foo));</div>
  99 <div class="ttc" id="aclasssigc_1_1signal7_html_adc55ac9b0f935fd87a67904022e03cb2"><div class="ttname"><a href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2">sigc::signal7::connect</a></div><div class="ttdeci">iterator connect(const slot_type &amp;slot_)</div><div class="ttdoc">Add a slot to the list of slots.</div><div class="ttdef"><b>Definition:</b> signal.h:3871</div></div>
 100 <div class="ttc" id="aclasssigc_1_1signal_html"><div class="ttname"><a href="classsigc_1_1signal.html">sigc::signal</a></div><div class="ttdoc">Convenience wrapper for the numbered sigc::signal# templates.</div><div class="ttdef"><b>Definition:</b> signal.h:4015</div></div>
 101 </div><!-- fragment --></dd></dl>
 102 <p><a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d" 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>
 103 <div class="line"><a class="code" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">sigc::hide</a>(<a class="code" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">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>
 104 </div><!-- fragment --></dd></dl>
 105 <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>
 106 <h2 class="groupheader">Function Documentation</h2>
 107 <a id="gaf2cefea3a99acd44f68121424103172d"></a>
 108 <h2 class="memtitle"><span class="permalink"><a href="#gaf2cefea3a99acd44f68121424103172d">&#9670;&#160;</a></span>hide() <span class="overload">[1/2]</span></h2>
 109
 110 <div class="memitem">
 111 <div class="memproto">
 112 <div class="memtemplate">
 113 template &lt;int I_location, class T_functor &gt; </div>
 114 <table class="mlabels">
 115   <tr>
 116   <td class="mlabels-left">
 117       <table class="memname">
 118         <tr>
 119           <td class="memname"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a>&lt;I_location, T_functor&gt; sigc::hide </td>
 120           <td>(</td>
 121           <td class="paramtype">const T_functor &amp;&#160;</td>
 122           <td class="paramname"><em>_A_func</em></td><td>)</td>
 123           <td></td>
 124         </tr>
 125       </table>
 126   </td>
 127   <td class="mlabels-right">
 128 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 129   </tr>
 130 </table>
 131 </div><div class="memdoc">
 132
 133 <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>
 134 <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>
 135 <dl class="params"><dt>Parameters</dt><dd>
 136   <table class="params">
 137     <tr><td class="paramname">_A_func</td><td>Functor that should be wrapped. </td></tr>
 138   </table>
 139   </dd>
 140 </dl>
 141 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_func</em>, ignoring the value of the dummy parameter. </dd></dl>
 142
 143 </div>
 144 </div>
 145 <a id="gacbbacd3553268d85b95e3a85aefb67e5"></a>
 146 <h2 class="memtitle"><span class="permalink"><a href="#gacbbacd3553268d85b95e3a85aefb67e5">&#9670;&#160;</a></span>hide() <span class="overload">[2/2]</span></h2>
 147
 148 <div class="memitem">
 149 <div class="memproto">
 150 <div class="memtemplate">
 151 template &lt;class T_functor &gt; </div>
 152 <table class="mlabels">
 153   <tr>
 154   <td class="mlabels-left">
 155       <table class="memname">
 156         <tr>
 157           <td class="memname"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a>&lt;-1, T_functor&gt; sigc::hide </td>
 158           <td>(</td>
 159           <td class="paramtype">const T_functor &amp;&#160;</td>
 160           <td class="paramname"><em>_A_func</em></td><td>)</td>
 161           <td></td>
 162         </tr>
 163       </table>
 164   </td>
 165   <td class="mlabels-right">
 166 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 167   </tr>
 168 </table>
 169 </div><div class="memdoc">
 170
 171 <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>
 172 <p>This overload adds a dummy parameter at the back of the functor's parameter list.</p>
 173 <dl class="params"><dt>Parameters</dt><dd>
 174   <table class="params">
 175     <tr><td class="paramname">_A_func</td><td>Functor that should be wrapped. </td></tr>
 176   </table>
 177   </dd>
 178 </dl>
 179 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_func</em>, ignoring the value of the last parameter. </dd></dl>
 180
 181 </div>
 182 </div>
 183 <a id="gae4e6f5491471c12440f1c5d480726b98"></a>
 184 <h2 class="memtitle"><span class="permalink"><a href="#gae4e6f5491471c12440f1c5d480726b98">&#9670;&#160;</a></span>hide_return()</h2>
 185
 186 <div class="memitem">
 187 <div class="memproto">
 188 <div class="memtemplate">
 189 template &lt;class T_functor &gt; </div>
 190 <table class="mlabels">
 191   <tr>
 192   <td class="mlabels-left">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname"><a class="el" href="structsigc_1_1retype__return__functor.html">retype_return_functor</a>&lt;void, T_functor&gt; sigc::hide_return </td>
 196           <td>(</td>
 197           <td class="paramtype">const T_functor &amp;&#160;</td>
 198           <td class="paramname"><em>_A_functor</em></td><td>)</td>
 199           <td></td>
 200         </tr>
 201       </table>
 202   </td>
 203   <td class="mlabels-right">
 204 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 205   </tr>
 206 </table>
 207 </div><div class="memdoc">
 208
 209 <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>
 210 <dl class="params"><dt>Parameters</dt><dd>
 211   <table class="params">
 212     <tr><td class="paramname">_A_functor</td><td>Functor that should be wrapped. </td></tr>
 213   </table>
 214   </dd>
 215 </dl>
 216 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_functor</em> dropping its return value. </dd></dl>
 217
 218 </div>
 219 </div>
 220 </div><!-- contents -->
 221 <!-- start footer part -->
 222 <hr class="footer"/><address class="footer"><small>
 223 Generated on Fri Feb 11 2022 15:40:57 for libsigc++ by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
 224 </small></address>
 225 </body>
 226 </html>