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