docs/reference/html/classsigc_1_1const__mem__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 <title>libsigc++: sigc::const_mem_functor0&lt; T_return, T_obj &gt; Class Template Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javascript" src="jquery.js"></script>
   9 <script type="text/javascript" src="dynsections.js"></script>
  10 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11 </head>
  12 <body>
  13 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14 <div id="titlearea">
  15 <table cellspacing="0" cellpadding="0">
  16  <tbody>
  17  <tr style="height: 56px;">
  18   <td style="padding-left: 0.5em;">
  19    <div id="projectname">libsigc++
  20    &#160;<span id="projectnumber">2.3.1</span>
  21    </div>
  22   </td>
  23  </tr>
  24  </tbody>
  25 </table>
  26 </div>
  27 <!-- end header part -->
  28 <!-- Generated by Doxygen 1.8.2 -->
  29   <div id="navrow1" class="tabs">
  30     <ul class="tablist">
  31       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  33       <li><a href="modules.html"><span>Modules</span></a></li>
  34       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  35       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36     </ul>
  37   </div>
  38   <div id="navrow2" class="tabs2">
  39     <ul class="tablist">
  40       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  43       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44     </ul>
  45   </div>
  46 <div id="nav-path" class="navpath">
  47   <ul>
  48 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1const__mem__functor0.html">const_mem_functor0</a></li> </ul>
  49 </div>
  50 </div><!-- top -->
  51 <div class="header">
  52   <div class="summary">
  53 <a href="#pub-types">Public Types</a> &#124;
  54 <a href="#pub-methods">Public Member Functions</a> &#124;
  55 <a href="#pro-attribs">Protected Attributes</a> &#124;
  56 <a href="classsigc_1_1const__mem__functor0-members.html">List of all members</a> </div>
  57   <div class="headertitle">
  58 <div class="title">sigc::const_mem_functor0&lt; T_return, T_obj &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__mem__fun.html">mem_fun()</a></div></div> </div>
  59 </div><!--header-->
  60 <div class="contents">
  61
  62 <p><a class="el" href="classsigc_1_1const__mem__functor0.html" title="const_mem_functor0 wraps const methods with 0 argument(s).">const_mem_functor0</a> wraps const methods with 0 argument(s).  <a href="classsigc_1_1const__mem__functor0.html#details">More...</a></p>
  63
  64 <p><code>#include &lt;sigc++/functors/mem_fun.h&gt;</code></p>
  65 <div class="dynheader">
  66 Inheritance diagram for sigc::const_mem_functor0&lt; T_return, T_obj &gt;:</div>
  67 <div class="dyncontent">
  68 <div class="center"><img src="classsigc_1_1const__mem__functor0__inherit__graph.png" border="0" usemap="#sigc_1_1const__mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map" alt="Inheritance graph"/></div>
  69 <map name="sigc_1_1const__mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map" id="sigc_1_1const__mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map">
  70 <area shape="rect" id="node5" href="classsigc_1_1bound__const__mem__functor0.html" title="bound_const_mem_functor0 encapsulates a const method with 0 arguments and an object instance..." alt="" coords="11,179,189,243"/><area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="31,5,169,35"/></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:aeefd8087157f292002b331756b187baa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeefd8087157f292002b331756b187baa"></a>
  76 typedef T_return(T_obj::*&#160;</td><td class="memItemRight" valign="bottom"><b>function_type</b> )() const </td></tr>
  77 <tr class="separator:aeefd8087157f292002b331756b187baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:a553cd4d85524b5deea445b67773527bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a553cd4d85524b5deea445b67773527bf"></a>
  79 typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><b>result_type</b></td></tr>
  80 <tr class="separator:a553cd4d85524b5deea445b67773527bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 </table><table class="memberdecls">
  82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83 Public Member Functions</h2></td></tr>
  84 <tr class="memitem:a49bba4c8045b8b6933b8f5a854ac98d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49bba4c8045b8b6933b8f5a854ac98d6"></a>
  85 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor0.html#a49bba4c8045b8b6933b8f5a854ac98d6">const_mem_functor0</a> ()</td></tr>
  86 <tr class="memdesc:a49bba4c8045b8b6933b8f5a854ac98d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor. <br/></td></tr>
  87 <tr class="separator:a49bba4c8045b8b6933b8f5a854ac98d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a27895e58972642453f7b853f25a66f42"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor0.html#a27895e58972642453f7b853f25a66f42">const_mem_functor0</a> (function_type _A_func)</td></tr>
  89 <tr class="memdesc:a27895e58972642453f7b853f25a66f42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1const__mem__functor0.html" title="const_mem_functor0 wraps const methods with 0 argument(s).">const_mem_functor0</a> object that wraps the passed method. <a href="#a27895e58972642453f7b853f25a66f42"></a><br/></td></tr>
  90 <tr class="separator:a27895e58972642453f7b853f25a66f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:a261a8a2fc4fca25717ee0d50a0a718c2"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor0.html#a261a8a2fc4fca25717ee0d50a0a718c2">operator()</a> (const T_obj* _A_obj) const </td></tr>
  92 <tr class="memdesc:a261a8a2fc4fca25717ee0d50a0a718c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance. <a href="#a261a8a2fc4fca25717ee0d50a0a718c2"></a><br/></td></tr>
  93 <tr class="separator:a261a8a2fc4fca25717ee0d50a0a718c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:ab282ef8746fa5de89ddbb91907d0e131"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor0.html#ab282ef8746fa5de89ddbb91907d0e131">operator()</a> (const T_obj&amp; _A_obj) const </td></tr>
  95 <tr class="memdesc:ab282ef8746fa5de89ddbb91907d0e131"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance. <a href="#ab282ef8746fa5de89ddbb91907d0e131"></a><br/></td></tr>
  96 <tr class="separator:ab282ef8746fa5de89ddbb91907d0e131"><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:a215359b20450c2afe93496826ac45c1d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a215359b20450c2afe93496826ac45c1d"></a>
 101 function_type&#160;</td><td class="memItemRight" valign="bottom"><b>func_ptr_</b></td></tr>
 102 <tr class="separator:a215359b20450c2afe93496826ac45c1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 </table>
 104 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 105 <div class="textblock"><h3>template&lt;class T_return, class T_obj&gt;<br/>
 106 class sigc::const_mem_functor0&lt; T_return, T_obj &gt;</h3>
 107
 108 <p><a class="el" href="classsigc_1_1const__mem__functor0.html" title="const_mem_functor0 wraps const methods with 0 argument(s).">const_mem_functor0</a> wraps const methods with 0 argument(s). </p>
 109 <p>Use the convenience function <a class="el" href="group__mem__fun.html#ga52244864d2f65f072678b682bfc9913f" 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_1const__mem__functor0.html" title="const_mem_functor0 wraps const methods with 0 argument(s).">const_mem_functor0</a>.</p>
 110 <p>The following template arguments are used:</p>
 111 <ul>
 112 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1const__mem__functor0.html#a261a8a2fc4fca25717ee0d50a0a718c2" title="Execute the wrapped method operating on the passed instance.">operator()()</a>.</li>
 113 <li><em>T_obj</em> The object type. </li>
 114 </ul>
 115 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 116 <a class="anchor" id="a27895e58972642453f7b853f25a66f42"></a>
 117 <div class="memitem">
 118 <div class="memproto">
 119 <div class="memtemplate">
 120 template &lt;class T_return , class T_obj &gt; </div>
 121 <table class="mlabels">
 122   <tr>
 123   <td class="mlabels-left">
 124       <table class="memname">
 125         <tr>
 126           <td class="memname"><a class="el" href="classsigc_1_1const__mem__functor0.html">sigc::const_mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1const__mem__functor0.html">const_mem_functor0</a> </td>
 127           <td>(</td>
 128           <td class="paramtype">function_type&#160;</td>
 129           <td class="paramname"><em>_A_func</em></td><td>)</td>
 130           <td></td>
 131         </tr>
 132       </table>
 133   </td>
 134   <td class="mlabels-right">
 135 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
 136   </tr>
 137 </table>
 138 </div><div class="memdoc">
 139
 140 <p>Constructs a <a class="el" href="classsigc_1_1const__mem__functor0.html" title="const_mem_functor0 wraps const methods with 0 argument(s).">const_mem_functor0</a> object that wraps the passed method. </p>
 141 <dl class="params"><dt>Parameters</dt><dd>
 142   <table class="params">
 143     <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1const__mem__functor0.html#a261a8a2fc4fca25717ee0d50a0a718c2" title="Execute the wrapped method operating on the passed instance.">operator()()</a>. </td></tr>
 144   </table>
 145   </dd>
 146 </dl>
 147
 148 </div>
 149 </div>
 150 <h2 class="groupheader">Member Function Documentation</h2>
 151 <a class="anchor" id="a261a8a2fc4fca25717ee0d50a0a718c2"></a>
 152 <div class="memitem">
 153 <div class="memproto">
 154 <div class="memtemplate">
 155 template &lt;class T_return , class T_obj &gt; </div>
 156 <table class="mlabels">
 157   <tr>
 158   <td class="mlabels-left">
 159       <table class="memname">
 160         <tr>
 161           <td class="memname">T_return <a class="el" href="classsigc_1_1const__mem__functor0.html">sigc::const_mem_functor0</a>&lt; T_return, T_obj &gt;::operator() </td>
 162           <td>(</td>
 163           <td class="paramtype">const T_obj *&#160;</td>
 164           <td class="paramname"><em>_A_obj</em></td><td>)</td>
 165           <td> const</td>
 166         </tr>
 167       </table>
 168   </td>
 169   <td class="mlabels-right">
 170 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
 171   </tr>
 172 </table>
 173 </div><div class="memdoc">
 174
 175 <p>Execute the wrapped method operating on the passed instance. </p>
 176 <dl class="params"><dt>Parameters</dt><dd>
 177   <table class="params">
 178     <tr><td class="paramname">_A_obj</td><td>Pointer to instance the method should operate on. </td></tr>
 179   </table>
 180   </dd>
 181 </dl>
 182 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 183
 184 </div>
 185 </div>
 186 <a class="anchor" id="ab282ef8746fa5de89ddbb91907d0e131"></a>
 187 <div class="memitem">
 188 <div class="memproto">
 189 <div class="memtemplate">
 190 template &lt;class T_return , class T_obj &gt; </div>
 191 <table class="mlabels">
 192   <tr>
 193   <td class="mlabels-left">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">T_return <a class="el" href="classsigc_1_1const__mem__functor0.html">sigc::const_mem_functor0</a>&lt; T_return, T_obj &gt;::operator() </td>
 197           <td>(</td>
 198           <td class="paramtype">const T_obj &amp;&#160;</td>
 199           <td class="paramname"><em>_A_obj</em></td><td>)</td>
 200           <td> const</td>
 201         </tr>
 202       </table>
 203   </td>
 204   <td class="mlabels-right">
 205 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
 206   </tr>
 207 </table>
 208 </div><div class="memdoc">
 209
 210 <p>Execute the wrapped method operating on the passed instance. </p>
 211 <dl class="params"><dt>Parameters</dt><dd>
 212   <table class="params">
 213     <tr><td class="paramname">_A_obj</td><td>Reference to instance the method should operate on. </td></tr>
 214   </table>
 215   </dd>
 216 </dl>
 217 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 218
 219 </div>
 220 </div>
 221 </div><!-- contents -->
 222 <!-- start footer part -->
 223 <hr class="footer"/><address class="footer"><small>
 224 Generated on Thu Oct 18 2012 09:28:25 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 225 <img class="footer" src="doxygen.png" alt="doxygen"/>
 226 </a> 1.8.2
 227 </small></address>
 228 </body>
 229 </html>