docs/reference/html/structsigc_1_1adaptor__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::adaptor_functor&lt; 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_1adaptor__functor.html">adaptor_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="#pub-attribs">Public Attributes</a> &#124;
  58 <a href="structsigc_1_1adaptor__functor-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <div class="title">sigc::adaptor_functor&lt; T_functor &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div>  </div>
  61 </div><!--header-->
  62 <div class="contents">
  63
  64 <p>Converts an arbitrary functor into an adaptor type.
  65  <a href="structsigc_1_1adaptor__functor.html#details">More...</a></p>
  66
  67 <p><code>#include &lt;sigc++/adaptors/adaptor_trait.h&gt;</code></p>
  68 <div class="dynheader">
  69 Inheritance diagram for sigc::adaptor_functor&lt; T_functor &gt;:</div>
  70 <div class="dyncontent">
  71 <div class="center"><img src="structsigc_1_1adaptor__functor__inherit__graph.png" border="0" usemap="#sigc_1_1adaptor__functor_3_01T__functor_01_4_inherit__map" alt="Inheritance graph"/></div>
  72 <map name="sigc_1_1adaptor__functor_3_01T__functor_01_4_inherit__map" id="sigc_1_1adaptor__functor_3_01T__functor_01_4_inherit__map">
  73 <area shape="rect" id="node2" href="structsigc_1_1adaptor__base.html" title="A hint to the compiler. " alt="" coords="13,80,155,107"/><area shape="rect" id="node3" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="15,5,153,32"/></map>
  74 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  75 <table class="memberdecls">
  76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  77 Public Types</h2></td></tr>
  78 <tr class="memitem:a724506f950434eb50de9407b7bcbebeb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#a724506f950434eb50de9407b7bcbebeb">result_type</a> = typename <a class="el" href="structsigc_1_1functor__trait.html">functor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adaptor__functor.html#a724506f950434eb50de9407b7bcbebeb">result_type</a></td></tr>
  79 <tr class="separator:a724506f950434eb50de9407b7bcbebeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 </table><table class="memberdecls">
  81 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  82 Public Member Functions</h2></td></tr>
  83 <tr class="memitem:a39ef4610f8e0f03425b6f4a44b59e5fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#a39ef4610f8e0f03425b6f4a44b59e5fb">adaptor_functor</a> ()</td></tr>
  84 <tr class="memdesc:a39ef4610f8e0f03425b6f4a44b59e5fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="#a39ef4610f8e0f03425b6f4a44b59e5fb">More...</a><br /></td></tr>
  85 <tr class="separator:a39ef4610f8e0f03425b6f4a44b59e5fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:ac5907212f7ee2eadf10b31757a0c5930"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#ac5907212f7ee2eadf10b31757a0c5930">adaptor_functor</a> (const T_functor&amp; _A_functor)</td></tr>
  87 <tr class="memdesc:ac5907212f7ee2eadf10b31757a0c5930"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type. ">adaptor_functor</a> object that wraps the passed functor.  <a href="#ac5907212f7ee2eadf10b31757a0c5930">More...</a><br /></td></tr>
  88 <tr class="separator:ac5907212f7ee2eadf10b31757a0c5930"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:af765e401002eb15f18aca5cfaa678b01"><td class="memTemplParams" colspan="2">template&lt;class T_type &gt; </td></tr>
  90 <tr class="memitem:af765e401002eb15f18aca5cfaa678b01"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#af765e401002eb15f18aca5cfaa678b01">adaptor_functor</a> (const T_type&amp; _A_type)</td></tr>
  91 <tr class="memdesc:af765e401002eb15f18aca5cfaa678b01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type. ">adaptor_functor</a> object that wraps the passed (member) function pointer.  <a href="#af765e401002eb15f18aca5cfaa678b01">More...</a><br /></td></tr>
  92 <tr class="separator:af765e401002eb15f18aca5cfaa678b01"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 <tr class="memitem:a5aef2dd64d7c7a2762ea578ae19b438f"><td class="memItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#a5aef2dd64d7c7a2762ea578ae19b438f">operator()</a> () const </td></tr>
  94 <tr class="memdesc:a5aef2dd64d7c7a2762ea578ae19b438f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the wrapped functor passing on the arguments.  <a href="#a5aef2dd64d7c7a2762ea578ae19b438f">More...</a><br /></td></tr>
  95 <tr class="separator:a5aef2dd64d7c7a2762ea578ae19b438f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:a32ab266e2276ea7a5d4defc79ee670b9"><td class="memTemplParams" colspan="2">template&lt;class... T_arg&gt; </td></tr>
  97 <tr class="memitem:a32ab266e2276ea7a5d4defc79ee670b9"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#a32ab266e2276ea7a5d4defc79ee670b9">operator()</a> (T_arg&amp;&amp;..._A_arg) const </td></tr>
  98 <tr class="memdesc:a32ab266e2276ea7a5d4defc79ee670b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the wrapped functor passing on the arguments.  <a href="#a32ab266e2276ea7a5d4defc79ee670b9">More...</a><br /></td></tr>
  99 <tr class="separator:a32ab266e2276ea7a5d4defc79ee670b9"><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="pub-attribs"></a>
 102 Public Attributes</h2></td></tr>
 103 <tr class="memitem:a4faff6b7a82f4f6d92e3d3b0aa8fdca8"><td class="memItemLeft" align="right" valign="top">T_functor&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html#a4faff6b7a82f4f6d92e3d3b0aa8fdca8">functor_</a></td></tr>
 104 <tr class="memdesc:a4faff6b7a82f4f6d92e3d3b0aa8fdca8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor that is invoked from <a class="el" href="structsigc_1_1adaptor__functor.html#a5aef2dd64d7c7a2762ea578ae19b438f" title="Invokes the wrapped functor passing on the arguments. ">operator()()</a>.  <a href="#a4faff6b7a82f4f6d92e3d3b0aa8fdca8">More...</a><br /></td></tr>
 105 <tr class="separator:a4faff6b7a82f4f6d92e3d3b0aa8fdca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 </table>
 107 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 108 <div class="textblock"><h3>template&lt;class T_functor&gt;<br />
 109 struct sigc::adaptor_functor&lt; T_functor &gt;</h3>
 110
 111 <p>Converts an arbitrary functor into an adaptor type. </p>
 112 <p>All adaptor types in libsigc++ have a <code>template operator()</code> member of every argument count they support. These functions in turn invoke a stored adaptor's <code>template operator()</code>, processing the arguments and return value in a characteristic manner. Explicit function template instantiation is used to pass type hints thus saving copy costs.</p>
 113 <p><a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type. ">adaptor_functor</a> is a glue between adaptors and arbitrary functors that just passes on the arguments. You won't use this type directly.</p>
 114 <p>The template argument <em>T_functor</em> determines the type of stored functor. </p>
 115 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 116 <a class="anchor" id="a724506f950434eb50de9407b7bcbebeb"></a>
 117 <div class="memitem">
 118 <div class="memproto">
 119 <div class="memtemplate">
 120 template &lt;class T_functor &gt; </div>
 121       <table class="memname">
 122         <tr>
 123           <td class="memname">using <a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adaptor__functor.html#a724506f950434eb50de9407b7bcbebeb">result_type</a> =  typename <a class="el" href="structsigc_1_1functor__trait.html">functor_trait</a>&lt;T_functor&gt;::<a class="el" href="structsigc_1_1adaptor__functor.html#a724506f950434eb50de9407b7bcbebeb">result_type</a></td>
 124         </tr>
 125       </table>
 126 </div><div class="memdoc">
 127
 128 </div>
 129 </div>
 130 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 131 <a class="anchor" id="a39ef4610f8e0f03425b6f4a44b59e5fb"></a>
 132 <div class="memitem">
 133 <div class="memproto">
 134 <div class="memtemplate">
 135 template &lt;class T_functor &gt; </div>
 136 <table class="mlabels">
 137   <tr>
 138   <td class="mlabels-left">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname"><a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adaptor__functor.html">adaptor_functor</a> </td>
 142           <td>(</td>
 143           <td class="paramname"></td><td>)</td>
 144           <td></td>
 145         </tr>
 146       </table>
 147   </td>
 148   <td class="mlabels-right">
 149 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 150   </tr>
 151 </table>
 152 </div><div class="memdoc">
 153
 154 <p>Constructs an invalid functor. </p>
 155
 156 </div>
 157 </div>
 158 <a class="anchor" id="ac5907212f7ee2eadf10b31757a0c5930"></a>
 159 <div class="memitem">
 160 <div class="memproto">
 161 <div class="memtemplate">
 162 template &lt;class T_functor &gt; </div>
 163 <table class="mlabels">
 164   <tr>
 165   <td class="mlabels-left">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname"><a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adaptor__functor.html">adaptor_functor</a> </td>
 169           <td>(</td>
 170           <td class="paramtype">const T_functor &amp;&#160;</td>
 171           <td class="paramname"><em>_A_functor</em></td><td>)</td>
 172           <td></td>
 173         </tr>
 174       </table>
 175   </td>
 176   <td class="mlabels-right">
 177 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 178   </tr>
 179 </table>
 180 </div><div class="memdoc">
 181
 182 <p>Constructs an <a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type. ">adaptor_functor</a> object that wraps the passed functor. </p>
 183 <dl class="params"><dt>Parameters</dt><dd>
 184   <table class="params">
 185     <tr><td class="paramname">_A_functor</td><td>Functor to invoke from <a class="el" href="structsigc_1_1adaptor__functor.html#a5aef2dd64d7c7a2762ea578ae19b438f" title="Invokes the wrapped functor passing on the arguments. ">operator()()</a>. </td></tr>
 186   </table>
 187   </dd>
 188 </dl>
 189
 190 </div>
 191 </div>
 192 <a class="anchor" id="af765e401002eb15f18aca5cfaa678b01"></a>
 193 <div class="memitem">
 194 <div class="memproto">
 195 <div class="memtemplate">
 196 template &lt;class T_functor &gt; </div>
 197 <div class="memtemplate">
 198 template &lt;class T_type &gt; </div>
 199 <table class="mlabels">
 200   <tr>
 201   <td class="mlabels-left">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname"><a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adaptor__functor.html">adaptor_functor</a> </td>
 205           <td>(</td>
 206           <td class="paramtype">const T_type &amp;&#160;</td>
 207           <td class="paramname"><em>_A_type</em></td><td>)</td>
 208           <td></td>
 209         </tr>
 210       </table>
 211   </td>
 212   <td class="mlabels-right">
 213 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 214   </tr>
 215 </table>
 216 </div><div class="memdoc">
 217
 218 <p>Constructs an <a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type. ">adaptor_functor</a> object that wraps the passed (member) function pointer. </p>
 219 <dl class="params"><dt>Parameters</dt><dd>
 220   <table class="params">
 221     <tr><td class="paramname">_A_type</td><td>Pointer to function or class method to invoke from <a class="el" href="structsigc_1_1adaptor__functor.html#a5aef2dd64d7c7a2762ea578ae19b438f" title="Invokes the wrapped functor passing on the arguments. ">operator()()</a>. </td></tr>
 222   </table>
 223   </dd>
 224 </dl>
 225
 226 </div>
 227 </div>
 228 <h2 class="groupheader">Member Function Documentation</h2>
 229 <a class="anchor" id="a5aef2dd64d7c7a2762ea578ae19b438f"></a>
 230 <div class="memitem">
 231 <div class="memproto">
 232 <div class="memtemplate">
 233 template &lt;class T_functor &gt; </div>
 234 <table class="mlabels">
 235   <tr>
 236   <td class="mlabels-left">
 237       <table class="memname">
 238         <tr>
 239           <td class="memname">decltype(auto) <a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::operator() </td>
 240           <td>(</td>
 241           <td class="paramname"></td><td>)</td>
 242           <td> const</td>
 243         </tr>
 244       </table>
 245   </td>
 246   <td class="mlabels-right">
 247 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 248   </tr>
 249 </table>
 250 </div><div class="memdoc">
 251
 252 <p>Invokes the wrapped functor passing on the arguments. </p>
 253 <dl class="section return"><dt>Returns</dt><dd>The return value of the functor invocation. </dd></dl>
 254
 255 </div>
 256 </div>
 257 <a class="anchor" id="a32ab266e2276ea7a5d4defc79ee670b9"></a>
 258 <div class="memitem">
 259 <div class="memproto">
 260 <div class="memtemplate">
 261 template &lt;class T_functor &gt; </div>
 262 <div class="memtemplate">
 263 template &lt;class... T_arg&gt; </div>
 264 <table class="mlabels">
 265   <tr>
 266   <td class="mlabels-left">
 267       <table class="memname">
 268         <tr>
 269           <td class="memname">decltype(auto) <a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::operator() </td>
 270           <td>(</td>
 271           <td class="paramtype">T_arg &amp;&amp;...&#160;</td>
 272           <td class="paramname"><em>_A_arg</em></td><td>)</td>
 273           <td> const</td>
 274         </tr>
 275       </table>
 276   </td>
 277   <td class="mlabels-right">
 278 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 279   </tr>
 280 </table>
 281 </div><div class="memdoc">
 282
 283 <p>Invokes the wrapped functor passing on the arguments. </p>
 284 <dl class="params"><dt>Parameters</dt><dd>
 285   <table class="params">
 286     <tr><td class="paramname">_A_arg...</td><td>Arguments to be passed on to the functor. </td></tr>
 287   </table>
 288   </dd>
 289 </dl>
 290 <dl class="section return"><dt>Returns</dt><dd>The return value of the functor invocation. </dd></dl>
 291
 292 </div>
 293 </div>
 294 <h2 class="groupheader">Member Data Documentation</h2>
 295 <a class="anchor" id="a4faff6b7a82f4f6d92e3d3b0aa8fdca8"></a>
 296 <div class="memitem">
 297 <div class="memproto">
 298 <div class="memtemplate">
 299 template &lt;class T_functor &gt; </div>
 300 <table class="mlabels">
 301   <tr>
 302   <td class="mlabels-left">
 303       <table class="memname">
 304         <tr>
 305           <td class="memname">T_functor <a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor</a>&lt; T_functor &gt;::functor_</td>
 306         </tr>
 307       </table>
 308   </td>
 309   <td class="mlabels-right">
 310 <span class="mlabels"><span class="mlabel">mutable</span></span>  </td>
 311   </tr>
 312 </table>
 313 </div><div class="memdoc">
 314
 315 <p>Functor that is invoked from <a class="el" href="structsigc_1_1adaptor__functor.html#a5aef2dd64d7c7a2762ea578ae19b438f" title="Invokes the wrapped functor passing on the arguments. ">operator()()</a>. </p>
 316
 317 </div>
 318 </div>
 319 </div><!-- contents -->
 320 <!-- start footer part -->
 321 <hr class="footer"/><address class="footer"><small>
 322 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 323 <img class="footer" src="doxygen.png" alt="doxygen"/>
 324 </a> 1.8.9.1
 325 </small></address>
 326 </body>
 327 </html>