docs/reference/html/classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.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_functor&lt; T_return(T_args...)&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.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="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html">pointer_functor&lt; T_return(T_args...)&gt;</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__functor_3_01T__return_07T__args_8_8_8_08_4-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <div class="title">sigc::pointer_functor&lt; T_return(T_args...)&gt; Class Template Reference</div>  </div>
  61 </div><!--header-->
  62 <div class="contents">
  63
  64 <p><code>#include &lt;sigc++/functors/ptr_fun.h&gt;</code></p>
  65 <div class="dynheader">
  66 Inheritance diagram for sigc::pointer_functor&lt; T_return(T_args...)&gt;:</div>
  67 <div class="dyncontent">
  68 <div class="center"><img src="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4__inherit__graph.png" border="0" usemap="#sigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4_inherit__map" alt="Inheritance graph"/></div>
  69 <map name="sigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4_inherit__map" id="sigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4_inherit__map">
  70 <area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="19,5,157,32"/></map>
  71 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  72 <table class="memberdecls">
  73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  74 Public Types</h2></td></tr>
  75 <tr class="memitem:a0a6c15f66e36a7d656d8b13949632ff5"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#a0a6c15f66e36a7d656d8b13949632ff5">result_type</a> = T_return</td></tr>
  76 <tr class="separator:a0a6c15f66e36a7d656d8b13949632ff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table><table class="memberdecls">
  78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79 Public Member Functions</h2></td></tr>
  80 <tr class="memitem:a9a9e668280c525690934039360708f88"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#a9a9e668280c525690934039360708f88">pointer_functor</a> ()</td></tr>
  81 <tr class="memdesc:a9a9e668280c525690934039360708f88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="#a9a9e668280c525690934039360708f88">More...</a><br /></td></tr>
  82 <tr class="separator:a9a9e668280c525690934039360708f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:acf5187ed4b100979bda904663398b478"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#acf5187ed4b100979bda904663398b478">pointer_functor</a> (function_type _A_func)</td></tr>
  84 <tr class="memdesc:acf5187ed4b100979bda904663398b478"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a pointer_functor2 object that wraps an existing function.  <a href="#acf5187ed4b100979bda904663398b478">More...</a><br /></td></tr>
  85 <tr class="separator:acf5187ed4b100979bda904663398b478"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:ad84eb8b252001dd854485486b1b953c1"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#ad84eb8b252001dd854485486b1b953c1">operator()</a> (<a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_args &gt;..._A_a) const </td></tr>
  87 <tr class="memdesc:ad84eb8b252001dd854485486b1b953c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped function.  <a href="#ad84eb8b252001dd854485486b1b953c1">More...</a><br /></td></tr>
  88 <tr class="separator:ad84eb8b252001dd854485486b1b953c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 </table><table class="memberdecls">
  90 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  91 Protected Attributes</h2></td></tr>
  92 <tr class="memitem:a986042bfa4905a2cb5bf9d17a2f5a110"><td class="memItemLeft" align="right" valign="top">function_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#a986042bfa4905a2cb5bf9d17a2f5a110">func_ptr_</a></td></tr>
  93 <tr class="separator:a986042bfa4905a2cb5bf9d17a2f5a110"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 </table>
  95 <h2 class="groupheader">Member Typedef Documentation</h2>
  96 <a class="anchor" id="a0a6c15f66e36a7d656d8b13949632ff5"></a>
  97 <div class="memitem">
  98 <div class="memproto">
  99 <div class="memtemplate">
 100 template &lt;class T_return , class... T_args&gt; </div>
 101       <table class="memname">
 102         <tr>
 103           <td class="memname">using <a class="el" href="classsigc_1_1pointer__functor.html">sigc::pointer_functor</a>&lt; T_return(T_args...)&gt;::<a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#a0a6c15f66e36a7d656d8b13949632ff5">result_type</a> =  T_return</td>
 104         </tr>
 105       </table>
 106 </div><div class="memdoc">
 107
 108 </div>
 109 </div>
 110 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 111 <a class="anchor" id="a9a9e668280c525690934039360708f88"></a>
 112 <div class="memitem">
 113 <div class="memproto">
 114 <div class="memtemplate">
 115 template &lt;class T_return , class... T_args&gt; </div>
 116 <table class="mlabels">
 117   <tr>
 118   <td class="mlabels-left">
 119       <table class="memname">
 120         <tr>
 121           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor.html">sigc::pointer_functor</a>&lt; T_return(T_args...)&gt;::<a class="el" href="classsigc_1_1pointer__functor.html">pointer_functor</a> </td>
 122           <td>(</td>
 123           <td class="paramname"></td><td>)</td>
 124           <td></td>
 125         </tr>
 126       </table>
 127   </td>
 128   <td class="mlabels-right">
 129 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 130   </tr>
 131 </table>
 132 </div><div class="memdoc">
 133
 134 <p>Constructs an invalid functor. </p>
 135
 136 </div>
 137 </div>
 138 <a class="anchor" id="acf5187ed4b100979bda904663398b478"></a>
 139 <div class="memitem">
 140 <div class="memproto">
 141 <div class="memtemplate">
 142 template &lt;class T_return , class... T_args&gt; </div>
 143 <table class="mlabels">
 144   <tr>
 145   <td class="mlabels-left">
 146       <table class="memname">
 147         <tr>
 148           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor.html">sigc::pointer_functor</a>&lt; T_return(T_args...)&gt;::<a class="el" href="classsigc_1_1pointer__functor.html">pointer_functor</a> </td>
 149           <td>(</td>
 150           <td class="paramtype">function_type&#160;</td>
 151           <td class="paramname"><em>_A_func</em></td><td>)</td>
 152           <td></td>
 153         </tr>
 154       </table>
 155   </td>
 156   <td class="mlabels-right">
 157 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 158   </tr>
 159 </table>
 160 </div><div class="memdoc">
 161
 162 <p>Constructs a pointer_functor2 object that wraps an existing function. </p>
 163 <dl class="params"><dt>Parameters</dt><dd>
 164   <table class="params">
 165     <tr><td class="paramname">_A_func</td><td>Pointer to function that will be invoked from <a class="el" href="classsigc_1_1pointer__functor_3_01T__return_07T__args_8_8_8_08_4.html#ad84eb8b252001dd854485486b1b953c1" title="Execute the wrapped function. ">operator()()</a>. </td></tr>
 166   </table>
 167   </dd>
 168 </dl>
 169
 170 </div>
 171 </div>
 172 <h2 class="groupheader">Member Function Documentation</h2>
 173 <a class="anchor" id="ad84eb8b252001dd854485486b1b953c1"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176 <div class="memtemplate">
 177 template &lt;class T_return , class... T_args&gt; </div>
 178 <table class="mlabels">
 179   <tr>
 180   <td class="mlabels-left">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">T_return <a class="el" href="classsigc_1_1pointer__functor.html">sigc::pointer_functor</a>&lt; T_return(T_args...)&gt;::operator() </td>
 184           <td>(</td>
 185           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_args &gt;...&#160;</td>
 186           <td class="paramname"><em>_A_a</em></td><td>)</td>
 187           <td> const</td>
 188         </tr>
 189       </table>
 190   </td>
 191   <td class="mlabels-right">
 192 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 193   </tr>
 194 </table>
 195 </div><div class="memdoc">
 196
 197 <p>Execute the wrapped function. </p>
 198 <dl class="params"><dt>Parameters</dt><dd>
 199   <table class="params">
 200     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the function. </td></tr>
 201     <tr><td class="paramname">_A_a2</td><td>Argument to be passed on to the function. </td></tr>
 202   </table>
 203   </dd>
 204 </dl>
 205 <dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
 206
 207 </div>
 208 </div>
 209 <h2 class="groupheader">Member Data Documentation</h2>
 210 <a class="anchor" id="a986042bfa4905a2cb5bf9d17a2f5a110"></a>
 211 <div class="memitem">
 212 <div class="memproto">
 213 <div class="memtemplate">
 214 template &lt;class T_return , class... T_args&gt; </div>
 215 <table class="mlabels">
 216   <tr>
 217   <td class="mlabels-left">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">function_type <a class="el" href="classsigc_1_1pointer__functor.html">sigc::pointer_functor</a>&lt; T_return(T_args...)&gt;::func_ptr_</td>
 221         </tr>
 222       </table>
 223   </td>
 224   <td class="mlabels-right">
 225 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 226   </tr>
 227 </table>
 228 </div><div class="memdoc">
 229
 230 </div>
 231 </div>
 232 </div><!-- contents -->
 233 <!-- start footer part -->
 234 <hr class="footer"/><address class="footer"><small>
 235 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 236 <img class="footer" src="doxygen.png" alt="doxygen"/>
 237 </a> 1.8.9.1
 238 </small></address>
 239 </body>
 240 </html>