docs/reference/html/classsigc_1_1const__mem__functor1.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::const_mem_functor1&lt; T_return, T_obj, T_arg1 &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_1const__mem__functor1.html">const_mem_functor1</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_1const__mem__functor1-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <div class="title">sigc::const_mem_functor1&lt; T_return, T_obj, T_arg1 &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_1const__mem__functor1.html" title="const_mem_functor1 wraps const methods with 1 argument(s). ">const_mem_functor1</a> wraps const methods with 1 argument(s).
  65  <a href="classsigc_1_1const__mem__functor1.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::const_mem_functor1&lt; T_return, T_obj, T_arg1 &gt;:</div>
  70 <div class="dyncontent">
  71 <div class="center"><img src="classsigc_1_1const__mem__functor1__inherit__graph.png" border="0" usemap="#sigc_1_1const__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map" alt="Inheritance graph"/></div>
  72 <map name="sigc_1_1const__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map" id="sigc_1_1const__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map">
  73 <area shape="rect" id="node3" href="classsigc_1_1bound__const__mem__functor1.html" title="bound_const_mem_functor1 encapsulates a const method with 1 arguments and an object instance..." alt="" coords="15,169,193,225"/><area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="35,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:a563ba65003a6373a2270f8460f4149e6"><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_1const__mem__functor1.html#a563ba65003a6373a2270f8460f4149e6">function_type</a>) (T_arg1) const </td></tr>
  79 <tr class="separator:a563ba65003a6373a2270f8460f4149e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a8ba6a6565b8a29812e266aa4e5261a2d"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor1.html#a8ba6a6565b8a29812e266aa4e5261a2d">result_type</a></td></tr>
  81 <tr class="separator:a8ba6a6565b8a29812e266aa4e5261a2d"><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:a2c171737e0c7dc6ae00f73f1580a976d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor1.html#a2c171737e0c7dc6ae00f73f1580a976d">const_mem_functor1</a> ()</td></tr>
  86 <tr class="memdesc:a2c171737e0c7dc6ae00f73f1580a976d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="#a2c171737e0c7dc6ae00f73f1580a976d">More...</a><br /></td></tr>
  87 <tr class="separator:a2c171737e0c7dc6ae00f73f1580a976d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:aba30421222bd496f9dec9b733fe70447"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor1.html#aba30421222bd496f9dec9b733fe70447">const_mem_functor1</a> (<a class="el" href="classsigc_1_1const__mem__functor1.html#a563ba65003a6373a2270f8460f4149e6">function_type</a> _A_func)</td></tr>
  89 <tr class="memdesc:aba30421222bd496f9dec9b733fe70447"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1const__mem__functor1.html" title="const_mem_functor1 wraps const methods with 1 argument(s). ">const_mem_functor1</a> object that wraps the passed method.  <a href="#aba30421222bd496f9dec9b733fe70447">More...</a><br /></td></tr>
  90 <tr class="separator:aba30421222bd496f9dec9b733fe70447"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:a2c6f54619e3ff9c15ddaba1e39771cc1"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor1.html#a2c6f54619e3ff9c15ddaba1e39771cc1">operator()</a> (const T_obj* _A_obj, <a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt; _A_a1) const </td></tr>
  92 <tr class="memdesc:a2c6f54619e3ff9c15ddaba1e39771cc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="#a2c6f54619e3ff9c15ddaba1e39771cc1">More...</a><br /></td></tr>
  93 <tr class="separator:a2c6f54619e3ff9c15ddaba1e39771cc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:ac8fce16f2a4d5f7f07abf4331267f8a0"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor1.html#ac8fce16f2a4d5f7f07abf4331267f8a0">operator()</a> (const T_obj&amp; _A_obj, <a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt; _A_a1) const </td></tr>
  95 <tr class="memdesc:ac8fce16f2a4d5f7f07abf4331267f8a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="#ac8fce16f2a4d5f7f07abf4331267f8a0">More...</a><br /></td></tr>
  96 <tr class="separator:ac8fce16f2a4d5f7f07abf4331267f8a0"><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:af791174008d5b58aa0f4fb42a531cc4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1const__mem__functor1.html#a563ba65003a6373a2270f8460f4149e6">function_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1const__mem__functor1.html#af791174008d5b58aa0f4fb42a531cc4a">func_ptr_</a></td></tr>
 101 <tr class="separator:af791174008d5b58aa0f4fb42a531cc4a"><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, class T_arg1&gt;<br />
 105 class sigc::const_mem_functor1&lt; T_return, T_obj, T_arg1 &gt;</h3>
 106
 107 <p><a class="el" href="classsigc_1_1const__mem__functor1.html" title="const_mem_functor1 wraps const methods with 1 argument(s). ">const_mem_functor1</a> wraps const methods with 1 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_1const__mem__functor1.html" title="const_mem_functor1 wraps const methods with 1 argument(s). ">const_mem_functor1</a>.</p>
 109 <p>The following template arguments are used:</p><ul>
 110 <li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1const__mem__functor1.html#a2c6f54619e3ff9c15ddaba1e39771cc1" title="Execute the wrapped method operating on the passed instance. ">operator()()</a>.</li>
 111 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1const__mem__functor1.html#a2c6f54619e3ff9c15ddaba1e39771cc1" title="Execute the wrapped method operating on the passed instance. ">operator()()</a>.</li>
 112 <li><em>T_obj</em> The object type. </li>
 113 </ul>
 114 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 115 <a class="anchor" id="a563ba65003a6373a2270f8460f4149e6"></a>
 116 <div class="memitem">
 117 <div class="memproto">
 118 <div class="memtemplate">
 119 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 120       <table class="memname">
 121         <tr>
 122           <td class="memname">typedef T_return(T_obj::* <a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::function_type) (T_arg1) const </td>
 123         </tr>
 124       </table>
 125 </div><div class="memdoc">
 126
 127 </div>
 128 </div>
 129 <a class="anchor" id="a8ba6a6565b8a29812e266aa4e5261a2d"></a>
 130 <div class="memitem">
 131 <div class="memproto">
 132 <div class="memtemplate">
 133 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 134       <table class="memname">
 135         <tr>
 136           <td class="memname">typedef T_return <a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::<a class="el" href="classsigc_1_1const__mem__functor1.html#a8ba6a6565b8a29812e266aa4e5261a2d">result_type</a></td>
 137         </tr>
 138       </table>
 139 </div><div class="memdoc">
 140
 141 </div>
 142 </div>
 143 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 144 <a class="anchor" id="a2c171737e0c7dc6ae00f73f1580a976d"></a>
 145 <div class="memitem">
 146 <div class="memproto">
 147 <div class="memtemplate">
 148 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname"><a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::<a class="el" href="classsigc_1_1const__mem__functor1.html">const_mem_functor1</a> </td>
 155           <td>(</td>
 156           <td class="paramname"></td><td>)</td>
 157           <td></td>
 158         </tr>
 159       </table>
 160   </td>
 161   <td class="mlabels-right">
 162 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 163   </tr>
 164 </table>
 165 </div><div class="memdoc">
 166
 167 <p>Constructs an invalid functor. </p>
 168
 169 </div>
 170 </div>
 171 <a class="anchor" id="aba30421222bd496f9dec9b733fe70447"></a>
 172 <div class="memitem">
 173 <div class="memproto">
 174 <div class="memtemplate">
 175 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 176 <table class="mlabels">
 177   <tr>
 178   <td class="mlabels-left">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname"><a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::<a class="el" href="classsigc_1_1const__mem__functor1.html">const_mem_functor1</a> </td>
 182           <td>(</td>
 183           <td class="paramtype"><a class="el" href="classsigc_1_1const__mem__functor1.html#a563ba65003a6373a2270f8460f4149e6">function_type</a>&#160;</td>
 184           <td class="paramname"><em>_A_func</em></td><td>)</td>
 185           <td></td>
 186         </tr>
 187       </table>
 188   </td>
 189   <td class="mlabels-right">
 190 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 191   </tr>
 192 </table>
 193 </div><div class="memdoc">
 194
 195 <p>Constructs a <a class="el" href="classsigc_1_1const__mem__functor1.html" title="const_mem_functor1 wraps const methods with 1 argument(s). ">const_mem_functor1</a> object that wraps the passed method. </p>
 196 <dl class="params"><dt>Parameters</dt><dd>
 197   <table class="params">
 198     <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1const__mem__functor1.html#a2c6f54619e3ff9c15ddaba1e39771cc1" title="Execute the wrapped method operating on the passed instance. ">operator()()</a>. </td></tr>
 199   </table>
 200   </dd>
 201 </dl>
 202
 203 </div>
 204 </div>
 205 <h2 class="groupheader">Member Function Documentation</h2>
 206 <a class="anchor" id="a2c6f54619e3ff9c15ddaba1e39771cc1"></a>
 207 <div class="memitem">
 208 <div class="memproto">
 209 <div class="memtemplate">
 210 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 211 <table class="mlabels">
 212   <tr>
 213   <td class="mlabels-left">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">T_return <a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::operator() </td>
 217           <td>(</td>
 218           <td class="paramtype">const T_obj *&#160;</td>
 219           <td class="paramname"><em>_A_obj</em>, </td>
 220         </tr>
 221         <tr>
 222           <td class="paramkey"></td>
 223           <td></td>
 224           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
 225           <td class="paramname"><em>_A_a1</em>&#160;</td>
 226         </tr>
 227         <tr>
 228           <td></td>
 229           <td>)</td>
 230           <td></td><td> const</td>
 231         </tr>
 232       </table>
 233   </td>
 234   <td class="mlabels-right">
 235 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 236   </tr>
 237 </table>
 238 </div><div class="memdoc">
 239
 240 <p>Execute the wrapped method operating on the passed instance. </p>
 241 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000095">Deprecated:</a></b></dt><dd>Please use the constructor that takes the object by reference instead.</dd></dl>
 242 <dl class="params"><dt>Parameters</dt><dd>
 243   <table class="params">
 244     <tr><td class="paramname">_A_obj</td><td>Pointer to instance the method should operate on. </td></tr>
 245     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the method. </td></tr>
 246   </table>
 247   </dd>
 248 </dl>
 249 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 250
 251 </div>
 252 </div>
 253 <a class="anchor" id="ac8fce16f2a4d5f7f07abf4331267f8a0"></a>
 254 <div class="memitem">
 255 <div class="memproto">
 256 <div class="memtemplate">
 257 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 258 <table class="mlabels">
 259   <tr>
 260   <td class="mlabels-left">
 261       <table class="memname">
 262         <tr>
 263           <td class="memname">T_return <a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::operator() </td>
 264           <td>(</td>
 265           <td class="paramtype">const T_obj &amp;&#160;</td>
 266           <td class="paramname"><em>_A_obj</em>, </td>
 267         </tr>
 268         <tr>
 269           <td class="paramkey"></td>
 270           <td></td>
 271           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
 272           <td class="paramname"><em>_A_a1</em>&#160;</td>
 273         </tr>
 274         <tr>
 275           <td></td>
 276           <td>)</td>
 277           <td></td><td> const</td>
 278         </tr>
 279       </table>
 280   </td>
 281   <td class="mlabels-right">
 282 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 283   </tr>
 284 </table>
 285 </div><div class="memdoc">
 286
 287 <p>Execute the wrapped method operating on the passed instance. </p>
 288 <dl class="params"><dt>Parameters</dt><dd>
 289   <table class="params">
 290     <tr><td class="paramname">_A_obj</td><td>Reference to instance the method should operate on. </td></tr>
 291     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the method. </td></tr>
 292   </table>
 293   </dd>
 294 </dl>
 295 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 296
 297 </div>
 298 </div>
 299 <h2 class="groupheader">Member Data Documentation</h2>
 300 <a class="anchor" id="af791174008d5b58aa0f4fb42a531cc4a"></a>
 301 <div class="memitem">
 302 <div class="memproto">
 303 <div class="memtemplate">
 304 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
 305 <table class="mlabels">
 306   <tr>
 307   <td class="mlabels-left">
 308       <table class="memname">
 309         <tr>
 310           <td class="memname"><a class="el" href="classsigc_1_1const__mem__functor1.html#a563ba65003a6373a2270f8460f4149e6">function_type</a> <a class="el" href="classsigc_1_1const__mem__functor1.html">sigc::const_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::func_ptr_</td>
 311         </tr>
 312       </table>
 313   </td>
 314   <td class="mlabels-right">
 315 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 316   </tr>
 317 </table>
 318 </div><div class="memdoc">
 319
 320 </div>
 321 </div>
 322 </div><!-- contents -->
 323 <!-- start footer part -->
 324 <hr class="footer"/><address class="footer"><small>
 325 Generated on Wed Mar 16 2016 13:54:33 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 326 <img class="footer" src="doxygen.png" alt="doxygen"/>
 327 </a> 1.8.9.1
 328 </small></address>
 329 </body>
 330 </html>