untracked/docs/reference/html/classsigc_1_1pointer__functor2.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++: sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt; Class Template Reference</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 id="nav-path" class="navpath">
  42   <ul>
  43 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1pointer__functor2.html">pointer_functor2</a></li>  </ul>
  44 </div>
  45 </div><!-- top -->
  46 <div class="header">
  47   <div class="summary">
  48 <a href="#pub-types">Public Types</a> &#124;
  49 <a href="#pub-methods">Public Member Functions</a> &#124;
  50 <a href="#pro-attribs">Protected Attributes</a> &#124;
  51 <a href="classsigc_1_1pointer__functor2-members.html">List of all members</a>  </div>
  52   <div class="headertitle">
  53 <div class="title">sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a> &raquo; <a class="el" href="group__ptr__fun.html">ptr_fun()</a></div></div>  </div>
  54 </div><!--header-->
  55 <div class="contents">
  56
  57 <p><a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s).">pointer_functor2</a> wraps existing non-member functions with 2 argument(s).
  58  <a href="classsigc_1_1pointer__functor2.html#details">More...</a></p>
  59
  60 <p><code>#include &lt;sigc++/functors/ptr_fun.h&gt;</code></p>
  61 <div class="dynheader">
  62 Inheritance diagram for sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt;:</div>
  63 <div class="dyncontent">
  64 <div class="center"><img src="classsigc_1_1pointer__functor2__inherit__graph.png" border="0" usemap="#asigc_1_1pointer__functor2_3_01T__arg1_00_01T__arg2_00_01T__return_01_4_inherit__map" alt="Inheritance graph"/></div>
  65 <map name="asigc_1_1pointer__functor2_3_01T__arg1_00_01T__arg2_00_01T__return_01_4_inherit__map" id="asigc_1_1pointer__functor2_3_01T__arg1_00_01T__arg2_00_01T__return_01_4_inherit__map">
  66 <area shape="rect" title="pointer_functor2 wraps existing non&#45;member functions with 2 argument(s)." alt="" coords="5,80,216,121"/>
  67 <area shape="rect" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="41,5,181,32"/>
  68 </map>
  69 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  70 <table class="memberdecls">
  71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  72 Public Types</h2></td></tr>
  73 <tr class="memitem:a297b784eb0cea07b364c854e5dd5f864"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a297b784eb0cea07b364c854e5dd5f864">result_type</a></td></tr>
  74 <tr class="separator:a297b784eb0cea07b364c854e5dd5f864"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 </table><table class="memberdecls">
  76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  77 Public Member Functions</h2></td></tr>
  78 <tr class="memitem:a2977aa1d72f5f0fd6c778b60ad791b9c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a2977aa1d72f5f0fd6c778b60ad791b9c">pointer_functor2</a> ()</td></tr>
  79 <tr class="memdesc:a2977aa1d72f5f0fd6c778b60ad791b9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="classsigc_1_1pointer__functor2.html#a2977aa1d72f5f0fd6c778b60ad791b9c">More...</a><br /></td></tr>
  80 <tr class="separator:a2977aa1d72f5f0fd6c778b60ad791b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:a428226381ff7bda06044c8fa53d4e27e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a428226381ff7bda06044c8fa53d4e27e">pointer_functor2</a> (function_type _A_func)</td></tr>
  82 <tr class="memdesc:a428226381ff7bda06044c8fa53d4e27e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s).">pointer_functor2</a> object that wraps an existing function.  <a href="classsigc_1_1pointer__functor2.html#a428226381ff7bda06044c8fa53d4e27e">More...</a><br /></td></tr>
  83 <tr class="separator:a428226381ff7bda06044c8fa53d4e27e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:af3d1d778be1730e170c42c52511d6926"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#af3d1d778be1730e170c42c52511d6926">operator()</a> (<a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt; _A_a1, <a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg2 &gt; _A_a2) const</td></tr>
  85 <tr class="memdesc:af3d1d778be1730e170c42c52511d6926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped function.  <a href="classsigc_1_1pointer__functor2.html#af3d1d778be1730e170c42c52511d6926">More...</a><br /></td></tr>
  86 <tr class="separator:af3d1d778be1730e170c42c52511d6926"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table><table class="memberdecls">
  88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  89 Protected Attributes</h2></td></tr>
  90 <tr class="memitem:a340680ba8ae5ea67eb0afe33d118c82b"><td class="memItemLeft" align="right" valign="top">function_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a340680ba8ae5ea67eb0afe33d118c82b">func_ptr_</a></td></tr>
  91 <tr class="separator:a340680ba8ae5ea67eb0afe33d118c82b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 </table>
  93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94 <div class="textblock"><h3>template&lt;class T_arg1, class T_arg2, class T_return&gt;<br />
  95 class sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt;</h3>
  96
  97 <p><a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s).">pointer_functor2</a> wraps existing non-member functions with 2 argument(s). </p>
  98 <p>Use the convenience function <a class="el" href="group__ptr__fun.html#ga9c80de72f656fb05e81fda622dddc863" title="Creates a functor of type sigc::pointer_functor0 which wraps an existing non-member function.">ptr_fun()</a> to create an instance of <a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s).">pointer_functor2</a>.</p>
  99 <p>The following template arguments are used:</p><ul>
 100 <li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor2.html#af3d1d778be1730e170c42c52511d6926" title="Execute the wrapped function.">operator()()</a>.</li>
 101 <li><em>T_arg2</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor2.html#af3d1d778be1730e170c42c52511d6926" title="Execute the wrapped function.">operator()()</a>.</li>
 102 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1pointer__functor2.html#af3d1d778be1730e170c42c52511d6926" title="Execute the wrapped function.">operator()()</a>. </li>
 103 </ul>
 104 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 105 <a id="a297b784eb0cea07b364c854e5dd5f864"></a>
 106 <h2 class="memtitle"><span class="permalink"><a href="#a297b784eb0cea07b364c854e5dd5f864">&#9670;&#160;</a></span>result_type</h2>
 107
 108 <div class="memitem">
 109 <div class="memproto">
 110 <div class="memtemplate">
 111 template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
 112       <table class="memname">
 113         <tr>
 114           <td class="memname">typedef T_return <a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor2.html#a297b784eb0cea07b364c854e5dd5f864">result_type</a></td>
 115         </tr>
 116       </table>
 117 </div><div class="memdoc">
 118
 119 </div>
 120 </div>
 121 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 122 <a id="a2977aa1d72f5f0fd6c778b60ad791b9c"></a>
 123 <h2 class="memtitle"><span class="permalink"><a href="#a2977aa1d72f5f0fd6c778b60ad791b9c">&#9670;&#160;</a></span>pointer_functor2() <span class="overload">[1/2]</span></h2>
 124
 125 <div class="memitem">
 126 <div class="memproto">
 127 <div class="memtemplate">
 128 template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
 129 <table class="mlabels">
 130   <tr>
 131   <td class="mlabels-left">
 132       <table class="memname">
 133         <tr>
 134           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor2.html">pointer_functor2</a> </td>
 135           <td>(</td>
 136           <td class="paramname"></td><td>)</td>
 137           <td></td>
 138         </tr>
 139       </table>
 140   </td>
 141   <td class="mlabels-right">
 142 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 143   </tr>
 144 </table>
 145 </div><div class="memdoc">
 146
 147 <p>Constructs an invalid functor. </p>
 148
 149 </div>
 150 </div>
 151 <a id="a428226381ff7bda06044c8fa53d4e27e"></a>
 152 <h2 class="memtitle"><span class="permalink"><a href="#a428226381ff7bda06044c8fa53d4e27e">&#9670;&#160;</a></span>pointer_functor2() <span class="overload">[2/2]</span></h2>
 153
 154 <div class="memitem">
 155 <div class="memproto">
 156 <div class="memtemplate">
 157 template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
 158 <table class="mlabels">
 159   <tr>
 160   <td class="mlabels-left">
 161       <table class="memname">
 162         <tr>
 163           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor2.html">pointer_functor2</a> </td>
 164           <td>(</td>
 165           <td class="paramtype">function_type&#160;</td>
 166           <td class="paramname"><em>_A_func</em></td><td>)</td>
 167           <td></td>
 168         </tr>
 169       </table>
 170   </td>
 171   <td class="mlabels-right">
 172 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 173   </tr>
 174 </table>
 175 </div><div class="memdoc">
 176
 177 <p>Constructs a <a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s).">pointer_functor2</a> object that wraps an existing function. </p>
 178 <dl class="params"><dt>Parameters</dt><dd>
 179   <table class="params">
 180     <tr><td class="paramname">_A_func</td><td>Pointer to function that will be invoked from <a class="el" href="classsigc_1_1pointer__functor2.html#af3d1d778be1730e170c42c52511d6926" title="Execute the wrapped function.">operator()()</a>. </td></tr>
 181   </table>
 182   </dd>
 183 </dl>
 184
 185 </div>
 186 </div>
 187 <h2 class="groupheader">Member Function Documentation</h2>
 188 <a id="af3d1d778be1730e170c42c52511d6926"></a>
 189 <h2 class="memtitle"><span class="permalink"><a href="#af3d1d778be1730e170c42c52511d6926">&#9670;&#160;</a></span>operator()()</h2>
 190
 191 <div class="memitem">
 192 <div class="memproto">
 193 <div class="memtemplate">
 194 template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
 195 <table class="mlabels">
 196   <tr>
 197   <td class="mlabels-left">
 198       <table class="memname">
 199         <tr>
 200           <td class="memname">T_return <a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::operator() </td>
 201           <td>(</td>
 202           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
 203           <td class="paramname"><em>_A_a1</em>, </td>
 204         </tr>
 205         <tr>
 206           <td class="paramkey"></td>
 207           <td></td>
 208           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg2 &gt;&#160;</td>
 209           <td class="paramname"><em>_A_a2</em>&#160;</td>
 210         </tr>
 211         <tr>
 212           <td></td>
 213           <td>)</td>
 214           <td></td><td> const</td>
 215         </tr>
 216       </table>
 217   </td>
 218   <td class="mlabels-right">
 219 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 220   </tr>
 221 </table>
 222 </div><div class="memdoc">
 223
 224 <p>Execute the wrapped function. </p>
 225 <dl class="params"><dt>Parameters</dt><dd>
 226   <table class="params">
 227     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the function. </td></tr>
 228     <tr><td class="paramname">_A_a2</td><td>Argument to be passed on to the function. </td></tr>
 229   </table>
 230   </dd>
 231 </dl>
 232 <dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
 233
 234 </div>
 235 </div>
 236 <h2 class="groupheader">Member Data Documentation</h2>
 237 <a id="a340680ba8ae5ea67eb0afe33d118c82b"></a>
 238 <h2 class="memtitle"><span class="permalink"><a href="#a340680ba8ae5ea67eb0afe33d118c82b">&#9670;&#160;</a></span>func_ptr_</h2>
 239
 240 <div class="memitem">
 241 <div class="memproto">
 242 <div class="memtemplate">
 243 template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
 244 <table class="mlabels">
 245   <tr>
 246   <td class="mlabels-left">
 247       <table class="memname">
 248         <tr>
 249           <td class="memname">function_type <a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::func_ptr_</td>
 250         </tr>
 251       </table>
 252   </td>
 253   <td class="mlabels-right">
 254 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 255   </tr>
 256 </table>
 257 </div><div class="memdoc">
 258
 259 </div>
 260 </div>
 261 </div><!-- contents -->
 262 <!-- start footer part -->
 263 <hr class="footer"/><address class="footer"><small>
 264 Generated on Fri Feb 11 2022 15:40:58 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
 265 </small></address>
 266 </body>
 267 </html>