docs/reference/html/classsigc_1_1pointer__functor3.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::pointer_functor3&lt; T_arg1, T_arg2, T_arg3, T_return &gt; Class 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.9.1</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="classsigc_1_1pointer__functor3.html">pointer_functor3</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="#pro-attribs">Protected Attributes</a> &#124;
  58 <a href="classsigc_1_1pointer__functor3-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <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>
  61 </div><!--header-->
  62 <div class="contents">
  63
  64 <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).
  65  <a href="classsigc_1_1pointer__functor3.html#details">More...</a></p>
  66
  67 <p><code>#include &lt;sigc++/functors/ptr_fun.h&gt;</code></p>
  68 <div class="dynheader">
  69 Inheritance diagram for sigc::pointer_functor3&lt; T_arg1, T_arg2, T_arg3, T_return &gt;:</div>
  70 <div class="dyncontent">
  71 <div class="center"><img src="classsigc_1_1pointer__functor3__inherit__graph.png" border="0" usemap="#sigc_1_1pointer__functor3_3_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__return_01_4_inherit__map" alt="Inheritance graph"/></div>
  72 <map name="sigc_1_1pointer__functor3_3_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__return_01_4_inherit__map" id="sigc_1_1pointer__functor3_3_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__return_01_4_inherit__map">
  73 <area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="29,5,168,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: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>
  79 <tr class="separator:a2a0ed29803c02cc62fcc6497f83f88bf"><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: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>
  84 <tr class="memdesc:a1a4909d1444e4456a89eb5852933d1cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="#a1a4909d1444e4456a89eb5852933d1cc">More...</a><br /></td></tr>
  85 <tr class="separator:a1a4909d1444e4456a89eb5852933d1cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <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>
  87 <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="#aae48103ba1c48e192a04c9a1b81ae9dc">More...</a><br /></td></tr>
  88 <tr class="separator:aae48103ba1c48e192a04c9a1b81ae9dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a3229fd4b8f451f4de3feedfa9a74625e"><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#a3229fd4b8f451f4de3feedfa9a74625e">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>
  90 <tr class="memdesc:a3229fd4b8f451f4de3feedfa9a74625e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped function.  <a href="#a3229fd4b8f451f4de3feedfa9a74625e">More...</a><br /></td></tr>
  91 <tr class="separator:a3229fd4b8f451f4de3feedfa9a74625e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 </table><table class="memberdecls">
  93 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  94 Protected Attributes</h2></td></tr>
  95 <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>
  96 <tr class="separator:a1ac1e43f2515d64c0da4656cdfac1f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 </table>
  98 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  99 <div class="textblock"><h3>template&lt;class T_arg1, class T_arg2, class T_arg3, class T_return&gt;<br />
 100 class sigc::pointer_functor3&lt; T_arg1, T_arg2, T_arg3, T_return &gt;</h3>
 101
 102 <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>
 103 <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>
 104 <p>The following template arguments are used:</p><ul>
 105 <li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor3.html#a3229fd4b8f451f4de3feedfa9a74625e" title="Execute the wrapped function. ">operator()()</a>.</li>
 106 <li><em>T_arg2</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor3.html#a3229fd4b8f451f4de3feedfa9a74625e" title="Execute the wrapped function. ">operator()()</a>.</li>
 107 <li><em>T_arg3</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor3.html#a3229fd4b8f451f4de3feedfa9a74625e" title="Execute the wrapped function. ">operator()()</a>.</li>
 108 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1pointer__functor3.html#a3229fd4b8f451f4de3feedfa9a74625e" title="Execute the wrapped function. ">operator()()</a>. </li>
 109 </ul>
 110 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 111 <a class="anchor" id="a2a0ed29803c02cc62fcc6497f83f88bf"></a>
 112 <div class="memitem">
 113 <div class="memproto">
 114 <div class="memtemplate">
 115 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 116       <table class="memname">
 117         <tr>
 118           <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>
 119         </tr>
 120       </table>
 121 </div><div class="memdoc">
 122
 123 </div>
 124 </div>
 125 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 126 <a class="anchor" id="a1a4909d1444e4456a89eb5852933d1cc"></a>
 127 <div class="memitem">
 128 <div class="memproto">
 129 <div class="memtemplate">
 130 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 131 <table class="mlabels">
 132   <tr>
 133   <td class="mlabels-left">
 134       <table class="memname">
 135         <tr>
 136           <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>
 137           <td>(</td>
 138           <td class="paramname"></td><td>)</td>
 139           <td></td>
 140         </tr>
 141       </table>
 142   </td>
 143   <td class="mlabels-right">
 144 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 145   </tr>
 146 </table>
 147 </div><div class="memdoc">
 148
 149 <p>Constructs an invalid functor. </p>
 150
 151 </div>
 152 </div>
 153 <a class="anchor" id="aae48103ba1c48e192a04c9a1b81ae9dc"></a>
 154 <div class="memitem">
 155 <div class="memproto">
 156 <div class="memtemplate">
 157 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , 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__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>
 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__functor3.html" title="pointer_functor3 wraps existing non-member functions with 3 argument(s). ">pointer_functor3</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__functor3.html#a3229fd4b8f451f4de3feedfa9a74625e" 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 class="anchor" id="a3229fd4b8f451f4de3feedfa9a74625e"></a>
 189 <div class="memitem">
 190 <div class="memproto">
 191 <div class="memtemplate">
 192 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 193 <table class="mlabels">
 194   <tr>
 195   <td class="mlabels-left">
 196       <table class="memname">
 197         <tr>
 198           <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>
 199           <td>(</td>
 200           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
 201           <td class="paramname"><em>_A_a1</em>, </td>
 202         </tr>
 203         <tr>
 204           <td class="paramkey"></td>
 205           <td></td>
 206           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg2 &gt;&#160;</td>
 207           <td class="paramname"><em>_A_a2</em>, </td>
 208         </tr>
 209         <tr>
 210           <td class="paramkey"></td>
 211           <td></td>
 212           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg3 &gt;&#160;</td>
 213           <td class="paramname"><em>_A_a3</em>&#160;</td>
 214         </tr>
 215         <tr>
 216           <td></td>
 217           <td>)</td>
 218           <td></td><td> const</td>
 219         </tr>
 220       </table>
 221   </td>
 222   <td class="mlabels-right">
 223 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 224   </tr>
 225 </table>
 226 </div><div class="memdoc">
 227
 228 <p>Execute the wrapped function. </p>
 229 <dl class="params"><dt>Parameters</dt><dd>
 230   <table class="params">
 231     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the function. </td></tr>
 232     <tr><td class="paramname">_A_a2</td><td>Argument to be passed on to the function. </td></tr>
 233     <tr><td class="paramname">_A_a3</td><td>Argument to be passed on to the function. </td></tr>
 234   </table>
 235   </dd>
 236 </dl>
 237 <dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
 238
 239 </div>
 240 </div>
 241 <h2 class="groupheader">Member Data Documentation</h2>
 242 <a class="anchor" id="a1ac1e43f2515d64c0da4656cdfac1f44"></a>
 243 <div class="memitem">
 244 <div class="memproto">
 245 <div class="memtemplate">
 246 template &lt;class T_arg1 , class T_arg2 , class T_arg3 , class T_return &gt; </div>
 247 <table class="mlabels">
 248   <tr>
 249   <td class="mlabels-left">
 250       <table class="memname">
 251         <tr>
 252           <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>
 253         </tr>
 254       </table>
 255   </td>
 256   <td class="mlabels-right">
 257 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 258   </tr>
 259 </table>
 260 </div><div class="memdoc">
 261
 262 </div>
 263 </div>
 264 </div><!-- contents -->
 265 <!-- start footer part -->
 266 <hr class="footer"/><address class="footer"><small>
 267 Generated on Wed Mar 16 2016 13:54:33 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 268 <img class="footer" src="doxygen.png" alt="doxygen"/>
 269 </a> 1.8.9.1
 270 </small></address>
 271 </body>
 272 </html>