untracked/docs/reference/html/classsigc_1_1pointer__functor3.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_functor3&lt; T_arg1, T_arg2, T_arg3, 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__functor3.html">pointer_functor3</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__functor3-members.html">List of all members</a>  </div>
  52   <div class="headertitle">
  53 <div class="title">sigc::pointer_functor3&lt; T_arg1, T_arg2, T_arg3, 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__functor3.html" title="pointer_functor3 wraps existing non-member functions with 3 argument(s).">pointer_functor3</a> wraps existing non-member functions with 3 argument(s).
  58  <a href="classsigc_1_1pointer__functor3.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_functor3&lt; T_arg1, T_arg2, T_arg3, T_return &gt;:</div>
  63 <div class="dyncontent">
  64 <div class="center"><img src="classsigc_1_1pointer__functor3__inherit__graph.png" border="0" usemap="#asigc_1_1pointer__functor3_3_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__return_01_4_inherit__map" alt="Inheritance graph"/></div>
  65 <map name="asigc_1_1pointer__functor3_3_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__return_01_4_inherit__map" id="asigc_1_1pointer__functor3_3_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__return_01_4_inherit__map">
  66 <area shape="rect" title="pointer_functor3 wraps existing non&#45;member functions with 3 argument(s)." alt="" coords="5,80,195,136"/>
  67 <area shape="rect" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="30,5,170,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:a2a0ed29803c02cc62fcc6497f83f88bf"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor3.html#a2a0ed29803c02cc62fcc6497f83f88bf">result_type</a></td></tr>
  74 <tr class="separator:a2a0ed29803c02cc62fcc6497f83f88bf"><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:a1a4909d1444e4456a89eb5852933d1cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor3.html#a1a4909d1444e4456a89eb5852933d1cc">pointer_functor3</a> ()</td></tr>
  79 <tr class="memdesc:a1a4909d1444e4456a89eb5852933d1cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="classsigc_1_1pointer__functor3.html#a1a4909d1444e4456a89eb5852933d1cc">More...</a><br /></td></tr>
  80 <tr class="separator:a1a4909d1444e4456a89eb5852933d1cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:aae48103ba1c48e192a04c9a1b81ae9dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor3.html#aae48103ba1c48e192a04c9a1b81ae9dc">pointer_functor3</a> (function_type _A_func)</td></tr>
  82 <tr class="memdesc:aae48103ba1c48e192a04c9a1b81ae9dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1pointer__functor3.html" title="pointer_functor3 wraps existing non-member functions with 3 argument(s).">pointer_functor3</a> object that wraps an existing function.  <a href="classsigc_1_1pointer__functor3.html#aae48103ba1c48e192a04c9a1b81ae9dc">More...</a><br /></td></tr>
  83 <tr class="separator:aae48103ba1c48e192a04c9a1b81ae9dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:adf560c1e583b2216bba4de3027e3a05e"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor3.html#adf560c1e583b2216bba4de3027e3a05e">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, <a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg3 &gt; _A_a3) const</td></tr>
  85 <tr class="memdesc:adf560c1e583b2216bba4de3027e3a05e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped function.  <a href="classsigc_1_1pointer__functor3.html#adf560c1e583b2216bba4de3027e3a05e">More...</a><br /></td></tr>
  86 <tr class="separator:adf560c1e583b2216bba4de3027e3a05e"><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:a1ac1e43f2515d64c0da4656cdfac1f44"><td class="memItemLeft" align="right" valign="top">function_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor3.html#a1ac1e43f2515d64c0da4656cdfac1f44">func_ptr_</a></td></tr>
  91 <tr class="separator:a1ac1e43f2515d64c0da4656cdfac1f44"><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_arg3, class T_return&gt;<br />
  95 class sigc::pointer_functor3&lt; T_arg1, T_arg2, T_arg3, T_return &gt;</h3>
  96
  97 <p><a class="el" href="classsigc_1_1pointer__functor3.html" title="pointer_functor3 wraps existing non-member functions with 3 argument(s).">pointer_functor3</a> wraps existing non-member functions with 3 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__functor3.html" title="pointer_functor3 wraps existing non-member functions with 3 argument(s).">pointer_functor3</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__functor3.html#adf560c1e583b2216bba4de3027e3a05e" 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__functor3.html#adf560c1e583b2216bba4de3027e3a05e" title="Execute the wrapped function.">operator()()</a>.</li>
 102 <li><em>T_arg3</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor3.html#adf560c1e583b2216bba4de3027e3a05e" title="Execute the wrapped function.">operator()()</a>.</li>
 103 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1pointer__functor3.html#adf560c1e583b2216bba4de3027e3a05e" title="Execute the wrapped function.">operator()()</a>. </li>
 104 </ul>
 105 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 106 <a id="a2a0ed29803c02cc62fcc6497f83f88bf"></a>
 107 <h2 class="memtitle"><span class="permalink"><a href="#a2a0ed29803c02cc62fcc6497f83f88bf">&#9670;&#160;</a></span>result_type</h2>
 108
 109 <div class="memitem">
 110 <div class="memproto">
 111 <div class="memtemplate">
 112 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 113       <table class="memname">
 114         <tr>
 115           <td class="memname">typedef T_return <a class="el" href="classsigc_1_1pointer__functor3.html">sigc::pointer_functor3</a>&lt; T_arg1, T_arg2, T_arg3, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor3.html#a2a0ed29803c02cc62fcc6497f83f88bf">result_type</a></td>
 116         </tr>
 117       </table>
 118 </div><div class="memdoc">
 119
 120 </div>
 121 </div>
 122 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 123 <a id="a1a4909d1444e4456a89eb5852933d1cc"></a>
 124 <h2 class="memtitle"><span class="permalink"><a href="#a1a4909d1444e4456a89eb5852933d1cc">&#9670;&#160;</a></span>pointer_functor3() <span class="overload">[1/2]</span></h2>
 125
 126 <div class="memitem">
 127 <div class="memproto">
 128 <div class="memtemplate">
 129 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 130 <table class="mlabels">
 131   <tr>
 132   <td class="mlabels-left">
 133       <table class="memname">
 134         <tr>
 135           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor3.html">sigc::pointer_functor3</a>&lt; T_arg1, T_arg2, T_arg3, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor3.html">pointer_functor3</a> </td>
 136           <td>(</td>
 137           <td class="paramname"></td><td>)</td>
 138           <td></td>
 139         </tr>
 140       </table>
 141   </td>
 142   <td class="mlabels-right">
 143 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 144   </tr>
 145 </table>
 146 </div><div class="memdoc">
 147
 148 <p>Constructs an invalid functor. </p>
 149
 150 </div>
 151 </div>
 152 <a id="aae48103ba1c48e192a04c9a1b81ae9dc"></a>
 153 <h2 class="memtitle"><span class="permalink"><a href="#aae48103ba1c48e192a04c9a1b81ae9dc">&#9670;&#160;</a></span>pointer_functor3() <span class="overload">[2/2]</span></h2>
 154
 155 <div class="memitem">
 156 <div class="memproto">
 157 <div class="memtemplate">
 158 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 159 <table class="mlabels">
 160   <tr>
 161   <td class="mlabels-left">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor3.html">sigc::pointer_functor3</a>&lt; T_arg1, T_arg2, T_arg3, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor3.html">pointer_functor3</a> </td>
 165           <td>(</td>
 166           <td class="paramtype">function_type&#160;</td>
 167           <td class="paramname"><em>_A_func</em></td><td>)</td>
 168           <td></td>
 169         </tr>
 170       </table>
 171   </td>
 172   <td class="mlabels-right">
 173 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 174   </tr>
 175 </table>
 176 </div><div class="memdoc">
 177
 178 <p>Constructs a <a class="el" href="classsigc_1_1pointer__functor3.html" title="pointer_functor3 wraps existing non-member functions with 3 argument(s).">pointer_functor3</a> object that wraps an existing function. </p>
 179 <dl class="params"><dt>Parameters</dt><dd>
 180   <table class="params">
 181     <tr><td class="paramname">_A_func</td><td>Pointer to function that will be invoked from <a class="el" href="classsigc_1_1pointer__functor3.html#adf560c1e583b2216bba4de3027e3a05e" title="Execute the wrapped function.">operator()()</a>. </td></tr>
 182   </table>
 183   </dd>
 184 </dl>
 185
 186 </div>
 187 </div>
 188 <h2 class="groupheader">Member Function Documentation</h2>
 189 <a id="adf560c1e583b2216bba4de3027e3a05e"></a>
 190 <h2 class="memtitle"><span class="permalink"><a href="#adf560c1e583b2216bba4de3027e3a05e">&#9670;&#160;</a></span>operator()()</h2>
 191
 192 <div class="memitem">
 193 <div class="memproto">
 194 <div class="memtemplate">
 195 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 196 <table class="mlabels">
 197   <tr>
 198   <td class="mlabels-left">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname">T_return <a class="el" href="classsigc_1_1pointer__functor3.html">sigc::pointer_functor3</a>&lt; T_arg1, T_arg2, T_arg3, T_return &gt;::operator() </td>
 202           <td>(</td>
 203           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
 204           <td class="paramname"><em>_A_a1</em>, </td>
 205         </tr>
 206         <tr>
 207           <td class="paramkey"></td>
 208           <td></td>
 209           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg2 &gt;&#160;</td>
 210           <td class="paramname"><em>_A_a2</em>, </td>
 211         </tr>
 212         <tr>
 213           <td class="paramkey"></td>
 214           <td></td>
 215           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg3 &gt;&#160;</td>
 216           <td class="paramname"><em>_A_a3</em>&#160;</td>
 217         </tr>
 218         <tr>
 219           <td></td>
 220           <td>)</td>
 221           <td></td><td> const</td>
 222         </tr>
 223       </table>
 224   </td>
 225   <td class="mlabels-right">
 226 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 227   </tr>
 228 </table>
 229 </div><div class="memdoc">
 230
 231 <p>Execute the wrapped function. </p>
 232 <dl class="params"><dt>Parameters</dt><dd>
 233   <table class="params">
 234     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the function. </td></tr>
 235     <tr><td class="paramname">_A_a2</td><td>Argument to be passed on to the function. </td></tr>
 236     <tr><td class="paramname">_A_a3</td><td>Argument to be passed on to the function. </td></tr>
 237   </table>
 238   </dd>
 239 </dl>
 240 <dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
 241
 242 </div>
 243 </div>
 244 <h2 class="groupheader">Member Data Documentation</h2>
 245 <a id="a1ac1e43f2515d64c0da4656cdfac1f44"></a>
 246 <h2 class="memtitle"><span class="permalink"><a href="#a1ac1e43f2515d64c0da4656cdfac1f44">&#9670;&#160;</a></span>func_ptr_</h2>
 247
 248 <div class="memitem">
 249 <div class="memproto">
 250 <div class="memtemplate">
 251 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 252 <table class="mlabels">
 253   <tr>
 254   <td class="mlabels-left">
 255       <table class="memname">
 256         <tr>
 257           <td class="memname">function_type <a class="el" href="classsigc_1_1pointer__functor3.html">sigc::pointer_functor3</a>&lt; T_arg1, T_arg2, T_arg3, T_return &gt;::func_ptr_</td>
 258         </tr>
 259       </table>
 260   </td>
 261   <td class="mlabels-right">
 262 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 263   </tr>
 264 </table>
 265 </div><div class="memdoc">
 266
 267 </div>
 268 </div>
 269 </div><!-- contents -->
 270 <!-- start footer part -->
 271 <hr class="footer"/><address class="footer"><small>
 272 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
 273 </small></address>
 274 </body>
 275 </html>