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">
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"/>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
18 <table cellspacing="0" cellpadding="0">
20 <tr style="height: 56px;">
21 <td id="projectalign" style="padding-left: 0.5em;">
22 <div id="projectname">libsigc++
23  <span id="projectnumber">2.10.8</span>
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&dn=gpl-2.0.txt GPL-v2 */
37 initMenu('',false,false,'search.php','Search');
39 /* @license-end */</script>
40 <div id="main-nav"></div>
44 <a href="#nested-classes">Classes</a> |
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>
49 <div class="contents">
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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor.html">sigc::hide_functor< I_location, T_functor ></a></td></tr>
57 <tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr>
59 <tr class="memitem:"><td class="memItemLeft" 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>
60 <tr class="memdesc:"><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>
61 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
62 <tr class="memitem:"><td class="memItemLeft" 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>
63 <tr class="memdesc:"><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>
64 <tr class="separator:"><td class="memSeparator" colspan="2"> </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<int I_location, class T_functor > </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>< I_location, T_functor > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d">sigc::hide</a> (const T_functor & _A_func)</td></tr>
70 <tr class="memdesc:gaf2cefea3a99acd44f68121424103172d"><td class="mdescLeft"> </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"> </td></tr>
72 <tr class="memitem:gacbbacd3553268d85b95e3a85aefb67e5"><td class="memTemplParams" colspan="2">template<class T_functor > </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><-1, T_functor > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gacbbacd3553268d85b95e3a85aefb67e5">sigc::hide</a> (const T_functor & _A_func)</td></tr>
74 <tr class="memdesc:gacbbacd3553268d85b95e3a85aefb67e5"><td class="mdescLeft"> </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"> </td></tr>
76 <tr class="memitem:gae4e6f5491471c12440f1c5d480726b98"><td class="memTemplParams" colspan="2">template<class T_functor > </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>< void, T_functor > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__hide.html#gae4e6f5491471c12440f1c5d480726b98">sigc::hide_return</a> (const T_functor & _A_functor)</td></tr>
78 <tr class="memdesc:gae4e6f5491471c12440f1c5d480726b98"><td class="mdescLeft"> </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"> </td></tr>
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><-1>() 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>(&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><-1>(&foo)(1,2,3); <span class="comment">// same as sigc::hide(&foo)(1,2,3) (calls foo(1,2))</span></div>
90 <div class="line">sigc::hide<0>(&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<1>(&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<2>(&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< I_location, T_functor > hide(const T_functor &_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<void,int></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>(&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 &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>(&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">◆ </a></span>hide() <span class="overload">[1/2]</span></h2>
110 <div class="memitem">
111 <div class="memproto">
112 <div class="memtemplate">
113 template <int I_location, class T_functor > </div>
114 <table class="mlabels">
116 <td class="mlabels-left">
117 <table class="memname">
119 <td class="memname"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a><I_location, T_functor> sigc::hide </td>
121 <td class="paramtype">const T_functor & </td>
122 <td class="paramname"><em>_A_func</em></td><td>)</td>
127 <td class="mlabels-right">
128 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
131 </div><div class="memdoc">
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>
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>
145 <a id="gacbbacd3553268d85b95e3a85aefb67e5"></a>
146 <h2 class="memtitle"><span class="permalink"><a href="#gacbbacd3553268d85b95e3a85aefb67e5">◆ </a></span>hide() <span class="overload">[2/2]</span></h2>
148 <div class="memitem">
149 <div class="memproto">
150 <div class="memtemplate">
151 template <class T_functor > </div>
152 <table class="mlabels">
154 <td class="mlabels-left">
155 <table class="memname">
157 <td class="memname"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a><-1, T_functor> sigc::hide </td>
159 <td class="paramtype">const T_functor & </td>
160 <td class="paramname"><em>_A_func</em></td><td>)</td>
165 <td class="mlabels-right">
166 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
169 </div><div class="memdoc">
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>
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>
183 <a id="gae4e6f5491471c12440f1c5d480726b98"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#gae4e6f5491471c12440f1c5d480726b98">◆ </a></span>hide_return()</h2>
186 <div class="memitem">
187 <div class="memproto">
188 <div class="memtemplate">
189 template <class T_functor > </div>
190 <table class="mlabels">
192 <td class="mlabels-left">
193 <table class="memname">
195 <td class="memname"><a class="el" href="structsigc_1_1retype__return__functor.html">retype_return_functor</a><void, T_functor> sigc::hide_return </td>
197 <td class="paramtype">const T_functor & </td>
198 <td class="paramname"><em>_A_functor</em></td><td>)</td>
203 <td class="mlabels-right">
204 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
207 </div><div class="memdoc">
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>
216 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_functor</em> dropping its return value. </dd></dl>
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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1