docs/reference/html/structsigc_1_1hide__functor.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++: sigc::hide_functor&lt; I_location, T_functor &gt; Struct Template Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40   <div id="navrow2" class="tabs2">
  41     <ul class="tablist">
  42       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  43       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  44       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  45       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  46     </ul>
  47   </div>
  48 <div id="nav-path" class="navpath">
  49   <ul>
  50 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a></li>  </ul>
  51 </div>
  52 </div><!-- top -->
  53 <div class="header">
  54   <div class="summary">
  55 <a href="#pub-types">Public Types</a> &#124;
  56 <a href="#pub-methods">Public Member Functions</a> &#124;
  57 <a href="structsigc_1_1hide__functor-members.html">List of all members</a>  </div>
  58   <div class="headertitle">
  59 <div class="title">sigc::hide_functor&lt; I_location, T_functor &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a> &raquo; <a class="el" href="group__hide.html">hide(), hide_return()</a></div></div>  </div>
  60 </div><!--header-->
  61 <div class="contents">
  62
  63 <p>Adaptor that adds a dummy parameter to the wrapped functor.
  64  <a href="structsigc_1_1hide__functor.html#details">More...</a></p>
  65
  66 <p><code>#include &lt;sigc++/adaptors/hide.h&gt;</code></p>
  67 <div class="dynheader">
  68 Inheritance diagram for sigc::hide_functor&lt; I_location, T_functor &gt;:</div>
  69 <div class="dyncontent">
  70 <div class="center"><img src="structsigc_1_1hide__functor__inherit__graph.png" border="0" usemap="#sigc_1_1hide__functor_3_01I__location_00_01T__functor_01_4_inherit__map" alt="Inheritance graph"/></div>
  71 <map name="sigc_1_1hide__functor_3_01I__location_00_01T__functor_01_4_inherit__map" id="sigc_1_1hide__functor_3_01I__location_00_01T__functor_01_4_inherit__map">
  72 <area shape="rect" id="node2" href="structsigc_1_1adapts.html" title="Base type for adaptors. " alt="" coords="5,155,193,181"/><area shape="rect" id="node3" href="structsigc_1_1adaptor__base.html" title="A hint to the compiler. " alt="" coords="28,80,171,107"/><area shape="rect" id="node4" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="30,5,169,32"/></map>
  73 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  74 <table class="memberdecls">
  75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  76 Public Types</h2></td></tr>
  77 <tr class="memitem:a5cc3f649061828c26336388a90766776"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor.html#a5cc3f649061828c26336388a90766776">adaptor_type</a> = typename <a class="el" href="structsigc_1_1adapts.html">adapts</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a></td></tr>
  78 <tr class="separator:a5cc3f649061828c26336388a90766776"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:aead1d0a75d4a91d67e52b37aa206809a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor.html#aead1d0a75d4a91d67e52b37aa206809a">result_type</a> = typename adaptor_type::result_type</td></tr>
  80 <tr class="separator:aead1d0a75d4a91d67e52b37aa206809a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="inherit_header pub_types_structsigc_1_1adapts"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structsigc_1_1adapts')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structsigc_1_1adapts.html">sigc::adapts&lt; T_functor &gt;</a></td></tr>
  82 <tr class="memitem:a944f414e6d1a98cf42aa48e82b52a079 inherit pub_types_structsigc_1_1adapts"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a> = typename <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a></td></tr>
  83 <tr class="separator:a944f414e6d1a98cf42aa48e82b52a079 inherit pub_types_structsigc_1_1adapts"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:a4514810fc2ec4e274748d8970a7052e2 inherit pub_types_structsigc_1_1adapts"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a> = typename <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a></td></tr>
  85 <tr class="separator:a4514810fc2ec4e274748d8970a7052e2 inherit pub_types_structsigc_1_1adapts"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 </table><table class="memberdecls">
  87 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  88 Public Member Functions</h2></td></tr>
  89 <tr class="memitem:a970d9f81378b54af16cac7363385db52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor.html#a970d9f81378b54af16cac7363385db52">hide_functor</a> (const T_functor&amp; _A_func)</td></tr>
  90 <tr class="memdesc:a970d9f81378b54af16cac7363385db52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">hide_functor</a> object that adds a dummy parameter to the passed functor.  <a href="#a970d9f81378b54af16cac7363385db52">More...</a><br /></td></tr>
  91 <tr class="separator:a970d9f81378b54af16cac7363385db52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:ab197447d666c8f08a9b3ef6ef1e7ec0c"><td class="memTemplParams" colspan="2">template&lt;class... T_arg&gt; </td></tr>
  93 <tr class="memitem:ab197447d666c8f08a9b3ef6ef1e7ec0c"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1hide__functor.html#ab197447d666c8f08a9b3ef6ef1e7ec0c">operator()</a> (T_arg&amp;&amp;..._A_a)</td></tr>
  94 <tr class="memdesc:ab197447d666c8f08a9b3ef6ef1e7ec0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the wrapped functor, ignoring the argument at index <em>I_location</em> (0-indexed).  <a href="#ab197447d666c8f08a9b3ef6ef1e7ec0c">More...</a><br /></td></tr>
  95 <tr class="separator:ab197447d666c8f08a9b3ef6ef1e7ec0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="inherit_header pub_methods_structsigc_1_1adapts"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structsigc_1_1adapts')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structsigc_1_1adapts.html">sigc::adapts&lt; T_functor &gt;</a></td></tr>
  97 <tr class="memitem:a947b69ccbdcabd4ef4163dcab96096f8 inherit pub_methods_structsigc_1_1adapts"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a947b69ccbdcabd4ef4163dcab96096f8">adapts</a> (const T_functor&amp; _A_functor)</td></tr>
  98 <tr class="memdesc:a947b69ccbdcabd4ef4163dcab96096f8 inherit pub_methods_structsigc_1_1adapts"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an adaptor that wraps the passed functor.  <a href="#a947b69ccbdcabd4ef4163dcab96096f8">More...</a><br /></td></tr>
  99 <tr class="separator:a947b69ccbdcabd4ef4163dcab96096f8 inherit pub_methods_structsigc_1_1adapts"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 </table><table class="memberdecls">
 101 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
 102 Additional Inherited Members</h2></td></tr>
 103 <tr class="inherit_header pub_attribs_structsigc_1_1adapts"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structsigc_1_1adapts')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structsigc_1_1adapts.html">sigc::adapts&lt; T_functor &gt;</a></td></tr>
 104 <tr class="memitem:a2f4b37eb160708baf17de57f2abce7a7 inherit pub_attribs_structsigc_1_1adapts"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a2f4b37eb160708baf17de57f2abce7a7">functor_</a></td></tr>
 105 <tr class="memdesc:a2f4b37eb160708baf17de57f2abce7a7 inherit pub_attribs_structsigc_1_1adapts"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adaptor that is invoked from operator()().  <a href="#a2f4b37eb160708baf17de57f2abce7a7">More...</a><br /></td></tr>
 106 <tr class="separator:a2f4b37eb160708baf17de57f2abce7a7 inherit pub_attribs_structsigc_1_1adapts"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 </table>
 108 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 109 <div class="textblock"><h3>template&lt;int I_location, class T_functor&gt;<br />
 110 struct sigc::hide_functor&lt; I_location, T_functor &gt;</h3>
 111
 112 <p>Adaptor that adds a dummy parameter to the wrapped functor. </p>
 113 <p>Use the convenience function <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> to create an instance of <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">sigc::hide_functor</a>.</p>
 114 <p>The following template arguments are used:</p><ul>
 115 <li><em>I_location</em> Zero-based position of the dummy parameter (<code>-1</code> for the last parameter).</li>
 116 <li><em>T_type</em> Type of the dummy parameter.</li>
 117 <li><em>T_functor</em> Type of the functor to wrap. </li>
 118 </ul>
 119 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 120 <a class="anchor" id="a5cc3f649061828c26336388a90766776"></a>
 121 <div class="memitem">
 122 <div class="memproto">
 123 <div class="memtemplate">
 124 template &lt;int I_location, class T_functor &gt; </div>
 125       <table class="memname">
 126         <tr>
 127           <td class="memname">using <a class="el" href="structsigc_1_1hide__functor.html">sigc::hide_functor</a>&lt; I_location, T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a> =  typename <a class="el" href="structsigc_1_1adapts.html">adapts</a>&lt;T_functor&gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a></td>
 128         </tr>
 129       </table>
 130 </div><div class="memdoc">
 131
 132 </div>
 133 </div>
 134 <a class="anchor" id="aead1d0a75d4a91d67e52b37aa206809a"></a>
 135 <div class="memitem">
 136 <div class="memproto">
 137 <div class="memtemplate">
 138 template &lt;int I_location, class T_functor &gt; </div>
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">using <a class="el" href="structsigc_1_1hide__functor.html">sigc::hide_functor</a>&lt; I_location, T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a> =  typename adaptor_type::result_type</td>
 142         </tr>
 143       </table>
 144 </div><div class="memdoc">
 145
 146 </div>
 147 </div>
 148 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 149 <a class="anchor" id="a970d9f81378b54af16cac7363385db52"></a>
 150 <div class="memitem">
 151 <div class="memproto">
 152 <div class="memtemplate">
 153 template &lt;int I_location, class T_functor &gt; </div>
 154 <table class="mlabels">
 155   <tr>
 156   <td class="mlabels-left">
 157       <table class="memname">
 158         <tr>
 159           <td class="memname"><a class="el" href="structsigc_1_1hide__functor.html">sigc::hide_functor</a>&lt; I_location, T_functor &gt;::<a class="el" href="structsigc_1_1hide__functor.html">hide_functor</a> </td>
 160           <td>(</td>
 161           <td class="paramtype">const T_functor &amp;&#160;</td>
 162           <td class="paramname"><em>_A_func</em></td><td>)</td>
 163           <td></td>
 164         </tr>
 165       </table>
 166   </td>
 167   <td class="mlabels-right">
 168 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 169   </tr>
 170 </table>
 171 </div><div class="memdoc">
 172
 173 <p>Constructs a <a class="el" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. ">hide_functor</a> object that adds a dummy parameter to the passed functor. </p>
 174 <dl class="params"><dt>Parameters</dt><dd>
 175   <table class="params">
 176     <tr><td class="paramname">_A_func</td><td>Functor to invoke from <a class="el" href="structsigc_1_1hide__functor.html#ab197447d666c8f08a9b3ef6ef1e7ec0c" title="Invokes the wrapped functor, ignoring the argument at index I_location (0-indexed). ">operator()()</a>. </td></tr>
 177   </table>
 178   </dd>
 179 </dl>
 180
 181 </div>
 182 </div>
 183 <h2 class="groupheader">Member Function Documentation</h2>
 184 <a class="anchor" id="ab197447d666c8f08a9b3ef6ef1e7ec0c"></a>
 185 <div class="memitem">
 186 <div class="memproto">
 187 <div class="memtemplate">
 188 template &lt;int I_location, class T_functor &gt; </div>
 189 <div class="memtemplate">
 190 template &lt;class... T_arg&gt; </div>
 191 <table class="mlabels">
 192   <tr>
 193   <td class="mlabels-left">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">decltype(auto) <a class="el" href="structsigc_1_1hide__functor.html">sigc::hide_functor</a>&lt; I_location, T_functor &gt;::operator() </td>
 197           <td>(</td>
 198           <td class="paramtype">T_arg &amp;&amp;...&#160;</td>
 199           <td class="paramname"><em>_A_a</em></td><td>)</td>
 200           <td></td>
 201         </tr>
 202       </table>
 203   </td>
 204   <td class="mlabels-right">
 205 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 206   </tr>
 207 </table>
 208 </div><div class="memdoc">
 209
 210 <p>Invokes the wrapped functor, ignoring the argument at index <em>I_location</em> (0-indexed). </p>
 211 <dl class="params"><dt>Parameters</dt><dd>
 212   <table class="params">
 213     <tr><td class="paramname">_A_a</td><td>Arguments to be passed on to the functor, apart from the ignored argument. </td></tr>
 214   </table>
 215   </dd>
 216 </dl>
 217 <dl class="section return"><dt>Returns</dt><dd>The return value of the functor invocation. </dd></dl>
 218
 219 </div>
 220 </div>
 221 </div><!-- contents -->
 222 <!-- start footer part -->
 223 <hr class="footer"/><address class="footer"><small>
 224 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 225 <img class="footer" src="doxygen.png" alt="doxygen"/>
 226 </a> 1.8.9.1
 227 </small></address>
 228 </body>
 229 </html>