docs/reference/html/classsigc_1_1pointer__functor0.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_functor0&lt; 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__functor0.html">pointer_functor0</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__functor0-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <div class="title">sigc::pointer_functor0&lt; 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__functor0.html" title="pointer_functor0 wraps existing non-member functions with 0 argument(s). ">pointer_functor0</a> wraps existing non-member functions with 0 argument(s).
  65  <a href="classsigc_1_1pointer__functor0.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_functor0&lt; T_return &gt;:</div>
  70 <div class="dyncontent">
  71 <div class="center"><img src="classsigc_1_1pointer__functor0__inherit__graph.png" border="0" usemap="#sigc_1_1pointer__functor0_3_01T__return_01_4_inherit__map" alt="Inheritance graph"/></div>
  72 <map name="sigc_1_1pointer__functor0_3_01T__return_01_4_inherit__map" id="sigc_1_1pointer__functor0_3_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="16,5,155,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:af44316e53e33b4184ca151b6b11c70e5"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor0.html#af44316e53e33b4184ca151b6b11c70e5">result_type</a></td></tr>
  79 <tr class="separator:af44316e53e33b4184ca151b6b11c70e5"><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:afdb67f682e7b9190f646eed879dcfbe4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor0.html#afdb67f682e7b9190f646eed879dcfbe4">pointer_functor0</a> ()</td></tr>
  84 <tr class="memdesc:afdb67f682e7b9190f646eed879dcfbe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="#afdb67f682e7b9190f646eed879dcfbe4">More...</a><br /></td></tr>
  85 <tr class="separator:afdb67f682e7b9190f646eed879dcfbe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a9ae3efd5c13c738db815f619499004d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor0.html#a9ae3efd5c13c738db815f619499004d7">pointer_functor0</a> (function_type _A_func)</td></tr>
  87 <tr class="memdesc:a9ae3efd5c13c738db815f619499004d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1pointer__functor0.html" title="pointer_functor0 wraps existing non-member functions with 0 argument(s). ">pointer_functor0</a> object that wraps an existing function.  <a href="#a9ae3efd5c13c738db815f619499004d7">More...</a><br /></td></tr>
  88 <tr class="separator:a9ae3efd5c13c738db815f619499004d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:afb058396d0f84a248197ddb7d4aed109"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor0.html#afb058396d0f84a248197ddb7d4aed109">operator()</a> () const </td></tr>
  90 <tr class="memdesc:afb058396d0f84a248197ddb7d4aed109"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped function.  <a href="#afb058396d0f84a248197ddb7d4aed109">More...</a><br /></td></tr>
  91 <tr class="separator:afb058396d0f84a248197ddb7d4aed109"><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:af998b64dac7b3c7eeb2e9a2856a4213e"><td class="memItemLeft" align="right" valign="top">function_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor0.html#af998b64dac7b3c7eeb2e9a2856a4213e">func_ptr_</a></td></tr>
  96 <tr class="separator:af998b64dac7b3c7eeb2e9a2856a4213e"><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_return&gt;<br />
 100 class sigc::pointer_functor0&lt; T_return &gt;</h3>
 101
 102 <p><a class="el" href="classsigc_1_1pointer__functor0.html" title="pointer_functor0 wraps existing non-member functions with 0 argument(s). ">pointer_functor0</a> wraps existing non-member functions with 0 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__functor0.html" title="pointer_functor0 wraps existing non-member functions with 0 argument(s). ">pointer_functor0</a>.</p>
 104 <p>The following template arguments are used:</p><ul>
 105 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1pointer__functor0.html#afb058396d0f84a248197ddb7d4aed109" title="Execute the wrapped function. ">operator()()</a>. </li>
 106 </ul>
 107 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 108 <a class="anchor" id="af44316e53e33b4184ca151b6b11c70e5"></a>
 109 <div class="memitem">
 110 <div class="memproto">
 111 <div class="memtemplate">
 112 template &lt;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__functor0.html">sigc::pointer_functor0</a>&lt; T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor0.html#af44316e53e33b4184ca151b6b11c70e5">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 class="anchor" id="afdb67f682e7b9190f646eed879dcfbe4"></a>
 124 <div class="memitem">
 125 <div class="memproto">
 126 <div class="memtemplate">
 127 template &lt;class T_return &gt; </div>
 128 <table class="mlabels">
 129   <tr>
 130   <td class="mlabels-left">
 131       <table class="memname">
 132         <tr>
 133           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor0.html">sigc::pointer_functor0</a>&lt; T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor0.html">pointer_functor0</a> </td>
 134           <td>(</td>
 135           <td class="paramname"></td><td>)</td>
 136           <td></td>
 137         </tr>
 138       </table>
 139   </td>
 140   <td class="mlabels-right">
 141 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 142   </tr>
 143 </table>
 144 </div><div class="memdoc">
 145
 146 <p>Constructs an invalid functor. </p>
 147
 148 </div>
 149 </div>
 150 <a class="anchor" id="a9ae3efd5c13c738db815f619499004d7"></a>
 151 <div class="memitem">
 152 <div class="memproto">
 153 <div class="memtemplate">
 154 template &lt;class T_return &gt; </div>
 155 <table class="mlabels">
 156   <tr>
 157   <td class="mlabels-left">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname"><a class="el" href="classsigc_1_1pointer__functor0.html">sigc::pointer_functor0</a>&lt; T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor0.html">pointer_functor0</a> </td>
 161           <td>(</td>
 162           <td class="paramtype">function_type&#160;</td>
 163           <td class="paramname"><em>_A_func</em></td><td>)</td>
 164           <td></td>
 165         </tr>
 166       </table>
 167   </td>
 168   <td class="mlabels-right">
 169 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 170   </tr>
 171 </table>
 172 </div><div class="memdoc">
 173
 174 <p>Constructs a <a class="el" href="classsigc_1_1pointer__functor0.html" title="pointer_functor0 wraps existing non-member functions with 0 argument(s). ">pointer_functor0</a> object that wraps an existing function. </p>
 175 <dl class="params"><dt>Parameters</dt><dd>
 176   <table class="params">
 177     <tr><td class="paramname">_A_func</td><td>Pointer to function that will be invoked from <a class="el" href="classsigc_1_1pointer__functor0.html#afb058396d0f84a248197ddb7d4aed109" title="Execute the wrapped function. ">operator()()</a>. </td></tr>
 178   </table>
 179   </dd>
 180 </dl>
 181
 182 </div>
 183 </div>
 184 <h2 class="groupheader">Member Function Documentation</h2>
 185 <a class="anchor" id="afb058396d0f84a248197ddb7d4aed109"></a>
 186 <div class="memitem">
 187 <div class="memproto">
 188 <div class="memtemplate">
 189 template &lt;class T_return &gt; </div>
 190 <table class="mlabels">
 191   <tr>
 192   <td class="mlabels-left">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname">T_return <a class="el" href="classsigc_1_1pointer__functor0.html">sigc::pointer_functor0</a>&lt; T_return &gt;::operator() </td>
 196           <td>(</td>
 197           <td class="paramname"></td><td>)</td>
 198           <td> const</td>
 199         </tr>
 200       </table>
 201   </td>
 202   <td class="mlabels-right">
 203 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 204   </tr>
 205 </table>
 206 </div><div class="memdoc">
 207
 208 <p>Execute the wrapped function. </p>
 209 <dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
 210
 211 </div>
 212 </div>
 213 <h2 class="groupheader">Member Data Documentation</h2>
 214 <a class="anchor" id="af998b64dac7b3c7eeb2e9a2856a4213e"></a>
 215 <div class="memitem">
 216 <div class="memproto">
 217 <div class="memtemplate">
 218 template &lt;class T_return &gt; </div>
 219 <table class="mlabels">
 220   <tr>
 221   <td class="mlabels-left">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname">function_type <a class="el" href="classsigc_1_1pointer__functor0.html">sigc::pointer_functor0</a>&lt; T_return &gt;::func_ptr_</td>
 225         </tr>
 226       </table>
 227   </td>
 228   <td class="mlabels-right">
 229 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 230   </tr>
 231 </table>
 232 </div><div class="memdoc">
 233
 234 </div>
 235 </div>
 236 </div><!-- contents -->
 237 <!-- start footer part -->
 238 <hr class="footer"/><address class="footer"><small>
 239 Generated on Wed Mar 16 2016 13:54:33 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 240 <img class="footer" src="doxygen.png" alt="doxygen"/>
 241 </a> 1.8.9.1
 242 </small></address>
 243 </body>
 244 </html>