docs/reference/html/classsigc_1_1mem__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::mem_functor0&lt; T_return, T_obj &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_1mem__functor0.html">mem_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_1mem__functor0-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <div class="title">sigc::mem_functor0&lt; T_return, T_obj &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a> &raquo; <a class="el" href="group__mem__fun.html">mem_fun()</a></div></div>  </div>
  61 </div><!--header-->
  62 <div class="contents">
  63
  64 <p><a class="el" href="classsigc_1_1mem__functor0.html" title="mem_functor0 wraps methods with 0 argument(s). ">mem_functor0</a> wraps methods with 0 argument(s).
  65  <a href="classsigc_1_1mem__functor0.html#details">More...</a></p>
  66
  67 <p><code>#include &lt;sigc++/functors/mem_fun.h&gt;</code></p>
  68 <div class="dynheader">
  69 Inheritance diagram for sigc::mem_functor0&lt; T_return, T_obj &gt;:</div>
  70 <div class="dyncontent">
  71 <div class="center"><img src="classsigc_1_1mem__functor0__inherit__graph.png" border="0" usemap="#sigc_1_1mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map" alt="Inheritance graph"/></div>
  72 <map name="sigc_1_1mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map" id="sigc_1_1mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map">
  73 <area shape="rect" id="node3" href="classsigc_1_1bound__mem__functor0.html" title="bound_mem_functor0 encapsulates a method with 0 arguments and an object instance. ..." alt="" coords="5,169,201,211"/><area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="34,5,173,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:a2b54ee0f1d0b0ca4f25707c85a5d4bab"><td class="memItemLeft" align="right" valign="top">typedef T_return(T_obj::*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#a2b54ee0f1d0b0ca4f25707c85a5d4bab">function_type</a>) ()</td></tr>
  79 <tr class="separator:a2b54ee0f1d0b0ca4f25707c85a5d4bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:aa679f73c7b786540686c110628a71dde"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#aa679f73c7b786540686c110628a71dde">result_type</a></td></tr>
  81 <tr class="separator:aa679f73c7b786540686c110628a71dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 </table><table class="memberdecls">
  83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  84 Public Member Functions</h2></td></tr>
  85 <tr class="memitem:ad598cd301fc54f3aa4da2b9e3c16bc81"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#ad598cd301fc54f3aa4da2b9e3c16bc81">mem_functor0</a> ()</td></tr>
  86 <tr class="memdesc:ad598cd301fc54f3aa4da2b9e3c16bc81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="#ad598cd301fc54f3aa4da2b9e3c16bc81">More...</a><br /></td></tr>
  87 <tr class="separator:ad598cd301fc54f3aa4da2b9e3c16bc81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a5655f48c6f36716dc15daf584f20d51c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#a5655f48c6f36716dc15daf584f20d51c">mem_functor0</a> (<a class="el" href="classsigc_1_1mem__functor0.html#a2b54ee0f1d0b0ca4f25707c85a5d4bab">function_type</a> _A_func)</td></tr>
  89 <tr class="memdesc:a5655f48c6f36716dc15daf584f20d51c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1mem__functor0.html" title="mem_functor0 wraps methods with 0 argument(s). ">mem_functor0</a> object that wraps the passed method.  <a href="#a5655f48c6f36716dc15daf584f20d51c">More...</a><br /></td></tr>
  90 <tr class="separator:a5655f48c6f36716dc15daf584f20d51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:a3d083ed9bc066718a9d6970be5a07b6e"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#a3d083ed9bc066718a9d6970be5a07b6e">operator()</a> (T_obj* _A_obj) const </td></tr>
  92 <tr class="memdesc:a3d083ed9bc066718a9d6970be5a07b6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="#a3d083ed9bc066718a9d6970be5a07b6e">More...</a><br /></td></tr>
  93 <tr class="separator:a3d083ed9bc066718a9d6970be5a07b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a5b9327e3a0f2f7df91394614f704ddc6"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#a5b9327e3a0f2f7df91394614f704ddc6">operator()</a> (T_obj&amp; _A_obj) const </td></tr>
  95 <tr class="memdesc:a5b9327e3a0f2f7df91394614f704ddc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="#a5b9327e3a0f2f7df91394614f704ddc6">More...</a><br /></td></tr>
  96 <tr class="separator:a5b9327e3a0f2f7df91394614f704ddc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 </table><table class="memberdecls">
  98 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  99 Protected Attributes</h2></td></tr>
 100 <tr class="memitem:a1f7b51d412900f55e155ecdd848fa283"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1mem__functor0.html#a2b54ee0f1d0b0ca4f25707c85a5d4bab">function_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor0.html#a1f7b51d412900f55e155ecdd848fa283">func_ptr_</a></td></tr>
 101 <tr class="separator:a1f7b51d412900f55e155ecdd848fa283"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 </table>
 103 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 104 <div class="textblock"><h3>template&lt;class T_return, class T_obj&gt;<br />
 105 class sigc::mem_functor0&lt; T_return, T_obj &gt;</h3>
 106
 107 <p><a class="el" href="classsigc_1_1mem__functor0.html" title="mem_functor0 wraps methods with 0 argument(s). ">mem_functor0</a> wraps methods with 0 argument(s). </p>
 108 <p>Use the convenience function <a class="el" href="group__mem__fun.html#gadf6b6d22c503b439019f0a2e77352419" title="Creates a functor of type sigc::mem_functor0 which wraps a method. ">mem_fun()</a> to create an instance of <a class="el" href="classsigc_1_1mem__functor0.html" title="mem_functor0 wraps methods with 0 argument(s). ">mem_functor0</a>.</p>
 109 <p>The following template arguments are used:</p><ul>
 110 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1mem__functor0.html#a3d083ed9bc066718a9d6970be5a07b6e" title="Execute the wrapped method operating on the passed instance. ">operator()()</a>.</li>
 111 <li><em>T_obj</em> The object type. </li>
 112 </ul>
 113 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 114 <a class="anchor" id="a2b54ee0f1d0b0ca4f25707c85a5d4bab"></a>
 115 <div class="memitem">
 116 <div class="memproto">
 117 <div class="memtemplate">
 118 template &lt;class T_return , class T_obj &gt; </div>
 119       <table class="memname">
 120         <tr>
 121           <td class="memname">typedef T_return(T_obj::* <a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::function_type) ()</td>
 122         </tr>
 123       </table>
 124 </div><div class="memdoc">
 125
 126 </div>
 127 </div>
 128 <a class="anchor" id="aa679f73c7b786540686c110628a71dde"></a>
 129 <div class="memitem">
 130 <div class="memproto">
 131 <div class="memtemplate">
 132 template &lt;class T_return , class T_obj &gt; </div>
 133       <table class="memname">
 134         <tr>
 135           <td class="memname">typedef T_return <a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1mem__functor0.html#aa679f73c7b786540686c110628a71dde">result_type</a></td>
 136         </tr>
 137       </table>
 138 </div><div class="memdoc">
 139
 140 </div>
 141 </div>
 142 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 143 <a class="anchor" id="ad598cd301fc54f3aa4da2b9e3c16bc81"></a>
 144 <div class="memitem">
 145 <div class="memproto">
 146 <div class="memtemplate">
 147 template &lt;class T_return , class T_obj &gt; </div>
 148 <table class="mlabels">
 149   <tr>
 150   <td class="mlabels-left">
 151       <table class="memname">
 152         <tr>
 153           <td class="memname"><a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1mem__functor0.html">mem_functor0</a> </td>
 154           <td>(</td>
 155           <td class="paramname"></td><td>)</td>
 156           <td></td>
 157         </tr>
 158       </table>
 159   </td>
 160   <td class="mlabels-right">
 161 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 162   </tr>
 163 </table>
 164 </div><div class="memdoc">
 165
 166 <p>Constructs an invalid functor. </p>
 167
 168 </div>
 169 </div>
 170 <a class="anchor" id="a5655f48c6f36716dc15daf584f20d51c"></a>
 171 <div class="memitem">
 172 <div class="memproto">
 173 <div class="memtemplate">
 174 template &lt;class T_return , class T_obj &gt; </div>
 175 <table class="mlabels">
 176   <tr>
 177   <td class="mlabels-left">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname"><a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1mem__functor0.html">mem_functor0</a> </td>
 181           <td>(</td>
 182           <td class="paramtype"><a class="el" href="classsigc_1_1mem__functor0.html#a2b54ee0f1d0b0ca4f25707c85a5d4bab">function_type</a>&#160;</td>
 183           <td class="paramname"><em>_A_func</em></td><td>)</td>
 184           <td></td>
 185         </tr>
 186       </table>
 187   </td>
 188   <td class="mlabels-right">
 189 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 190   </tr>
 191 </table>
 192 </div><div class="memdoc">
 193
 194 <p>Constructs a <a class="el" href="classsigc_1_1mem__functor0.html" title="mem_functor0 wraps methods with 0 argument(s). ">mem_functor0</a> object that wraps the passed method. </p>
 195 <dl class="params"><dt>Parameters</dt><dd>
 196   <table class="params">
 197     <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1mem__functor0.html#a3d083ed9bc066718a9d6970be5a07b6e" title="Execute the wrapped method operating on the passed instance. ">operator()()</a>. </td></tr>
 198   </table>
 199   </dd>
 200 </dl>
 201
 202 </div>
 203 </div>
 204 <h2 class="groupheader">Member Function Documentation</h2>
 205 <a class="anchor" id="a3d083ed9bc066718a9d6970be5a07b6e"></a>
 206 <div class="memitem">
 207 <div class="memproto">
 208 <div class="memtemplate">
 209 template &lt;class T_return , class T_obj &gt; </div>
 210 <table class="mlabels">
 211   <tr>
 212   <td class="mlabels-left">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">T_return <a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::operator() </td>
 216           <td>(</td>
 217           <td class="paramtype">T_obj *&#160;</td>
 218           <td class="paramname"><em>_A_obj</em></td><td>)</td>
 219           <td> const</td>
 220         </tr>
 221       </table>
 222   </td>
 223   <td class="mlabels-right">
 224 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 225   </tr>
 226 </table>
 227 </div><div class="memdoc">
 228
 229 <p>Execute the wrapped method operating on the passed instance. </p>
 230 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000086">Deprecated:</a></b></dt><dd>Please use the constructor that takes the object by reference instead.</dd></dl>
 231 <dl class="params"><dt>Parameters</dt><dd>
 232   <table class="params">
 233     <tr><td class="paramname">_A_obj</td><td>Pointer to instance the method should operate on. </td></tr>
 234   </table>
 235   </dd>
 236 </dl>
 237 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 238
 239 </div>
 240 </div>
 241 <a class="anchor" id="a5b9327e3a0f2f7df91394614f704ddc6"></a>
 242 <div class="memitem">
 243 <div class="memproto">
 244 <div class="memtemplate">
 245 template &lt;class T_return , class T_obj &gt; </div>
 246 <table class="mlabels">
 247   <tr>
 248   <td class="mlabels-left">
 249       <table class="memname">
 250         <tr>
 251           <td class="memname">T_return <a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::operator() </td>
 252           <td>(</td>
 253           <td class="paramtype">T_obj &amp;&#160;</td>
 254           <td class="paramname"><em>_A_obj</em></td><td>)</td>
 255           <td> const</td>
 256         </tr>
 257       </table>
 258   </td>
 259   <td class="mlabels-right">
 260 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 261   </tr>
 262 </table>
 263 </div><div class="memdoc">
 264
 265 <p>Execute the wrapped method operating on the passed instance. </p>
 266 <dl class="params"><dt>Parameters</dt><dd>
 267   <table class="params">
 268     <tr><td class="paramname">_A_obj</td><td>Reference to instance the method should operate on. </td></tr>
 269   </table>
 270   </dd>
 271 </dl>
 272 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 273
 274 </div>
 275 </div>
 276 <h2 class="groupheader">Member Data Documentation</h2>
 277 <a class="anchor" id="a1f7b51d412900f55e155ecdd848fa283"></a>
 278 <div class="memitem">
 279 <div class="memproto">
 280 <div class="memtemplate">
 281 template &lt;class T_return , class T_obj &gt; </div>
 282 <table class="mlabels">
 283   <tr>
 284   <td class="mlabels-left">
 285       <table class="memname">
 286         <tr>
 287           <td class="memname"><a class="el" href="classsigc_1_1mem__functor0.html#a2b54ee0f1d0b0ca4f25707c85a5d4bab">function_type</a> <a class="el" href="classsigc_1_1mem__functor0.html">sigc::mem_functor0</a>&lt; T_return, T_obj &gt;::func_ptr_</td>
 288         </tr>
 289       </table>
 290   </td>
 291   <td class="mlabels-right">
 292 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 293   </tr>
 294 </table>
 295 </div><div class="memdoc">
 296
 297 </div>
 298 </div>
 299 </div><!-- contents -->
 300 <!-- start footer part -->
 301 <hr class="footer"/><address class="footer"><small>
 302 Generated on Wed Mar 16 2016 13:54:33 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 303 <img class="footer" src="doxygen.png" alt="doxygen"/>
 304 </a> 1.8.9.1
 305 </small></address>
 306 </body>
 307 </html>