untracked/docs/reference/html/classsigc_1_1volatile__mem__functor0.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>libsigc++: sigc::volatile_mem_functor0&lt; T_return, T_obj &gt; Class Template Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  14 </head>
  15 <body>
  16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17 <div id="titlearea">
  18 <table cellspacing="0" cellpadding="0">
  19  <tbody>
  20  <tr style="height: 56px;">
  21   <td id="projectalign" style="padding-left: 0.5em;">
  22    <div id="projectname">libsigc++
  23    &#160;<span id="projectnumber">2.10.8</span>
  24    </div>
  25   </td>
  26  </tr>
  27  </tbody>
  28 </table>
  29 </div>
  30 <!-- end header part -->
  31 <!-- Generated by Doxygen 1.9.1 -->
  32 <script type="text/javascript" src="menudata.js"></script>
  33 <script type="text/javascript" src="menu.js"></script>
  34 <script type="text/javascript">
  35 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36 $(function() {
  37   initMenu('',false,false,'search.php','Search');
  38 });
  39 /* @license-end */</script>
  40 <div id="main-nav"></div>
  41 <div id="nav-path" class="navpath">
  42   <ul>
  43 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1volatile__mem__functor0.html">volatile_mem_functor0</a></li>  </ul>
  44 </div>
  45 </div><!-- top -->
  46 <div class="header">
  47   <div class="summary">
  48 <a href="#pub-types">Public Types</a> &#124;
  49 <a href="#pub-methods">Public Member Functions</a> &#124;
  50 <a href="#pro-attribs">Protected Attributes</a> &#124;
  51 <a href="classsigc_1_1volatile__mem__functor0-members.html">List of all members</a>  </div>
  52   <div class="headertitle">
  53 <div class="title">sigc::volatile_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>
  54 </div><!--header-->
  55 <div class="contents">
  56
  57 <p><a class="el" href="classsigc_1_1volatile__mem__functor0.html" title="volatile_mem_functor0 wraps volatile methods with 0 argument(s).">volatile_mem_functor0</a> wraps volatile methods with 0 argument(s).
  58  <a href="classsigc_1_1volatile__mem__functor0.html#details">More...</a></p>
  59
  60 <p><code>#include &lt;sigc++/functors/mem_fun.h&gt;</code></p>
  61 <div class="dynheader">
  62 Inheritance diagram for sigc::volatile_mem_functor0&lt; T_return, T_obj &gt;:</div>
  63 <div class="dyncontent">
  64 <div class="center"><img src="classsigc_1_1volatile__mem__functor0__inherit__graph.png" border="0" usemap="#asigc_1_1volatile__mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map" alt="Inheritance graph"/></div>
  65 <map name="asigc_1_1volatile__mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map" id="asigc_1_1volatile__mem__functor0_3_01T__return_00_01T__obj_01_4_inherit__map">
  66 <area shape="rect" title="volatile_mem_functor0 wraps volatile methods with 0 argument(s)." alt="" coords="26,80,182,136"/>
  67 <area shape="rect" href="classsigc_1_1bound__volatile__mem__functor0.html" title="bound_volatile_mem_functor0 encapsulates a volatile method with 0 arguments and an object instance." alt="" coords="5,184,203,240"/>
  68 <area shape="rect" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="34,5,174,32"/>
  69 </map>
  70 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  71 <table class="memberdecls">
  72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  73 Public Types</h2></td></tr>
  74 <tr class="memitem:a2f0448d35b580f2b4884292f29b19b2f"><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_1volatile__mem__functor0.html#a2f0448d35b580f2b4884292f29b19b2f">function_type</a>) () volatile</td></tr>
  75 <tr class="separator:a2f0448d35b580f2b4884292f29b19b2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:a41fbd67d6bbde0818b880f08f6295396"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#a41fbd67d6bbde0818b880f08f6295396">result_type</a></td></tr>
  77 <tr class="separator:a41fbd67d6bbde0818b880f08f6295396"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 </table><table class="memberdecls">
  79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80 Public Member Functions</h2></td></tr>
  81 <tr class="memitem:ae29bbe3e668b370d2788631465daa63c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#ae29bbe3e668b370d2788631465daa63c">volatile_mem_functor0</a> ()</td></tr>
  82 <tr class="memdesc:ae29bbe3e668b370d2788631465daa63c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="classsigc_1_1volatile__mem__functor0.html#ae29bbe3e668b370d2788631465daa63c">More...</a><br /></td></tr>
  83 <tr class="separator:ae29bbe3e668b370d2788631465daa63c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:aa4e5e279480d50940eb4b73b9c61b938"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#aa4e5e279480d50940eb4b73b9c61b938">volatile_mem_functor0</a> (<a class="el" href="classsigc_1_1volatile__mem__functor0.html#a2f0448d35b580f2b4884292f29b19b2f">function_type</a> _A_func)</td></tr>
  85 <tr class="memdesc:aa4e5e279480d50940eb4b73b9c61b938"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1volatile__mem__functor0.html" title="volatile_mem_functor0 wraps volatile methods with 0 argument(s).">volatile_mem_functor0</a> object that wraps the passed method.  <a href="classsigc_1_1volatile__mem__functor0.html#aa4e5e279480d50940eb4b73b9c61b938">More...</a><br /></td></tr>
  86 <tr class="separator:aa4e5e279480d50940eb4b73b9c61b938"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 <tr class="memitem:aa5df40ec8fb385594c673a07f3ff8044"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#aa5df40ec8fb385594c673a07f3ff8044">operator()</a> (T_obj &amp; _A_obj) const</td></tr>
  88 <tr class="memdesc:aa5df40ec8fb385594c673a07f3ff8044"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="classsigc_1_1volatile__mem__functor0.html#aa5df40ec8fb385594c673a07f3ff8044">More...</a><br /></td></tr>
  89 <tr class="separator:aa5df40ec8fb385594c673a07f3ff8044"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:af627ef410fac7ec5d2ee842d8f89fe51"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#af627ef410fac7ec5d2ee842d8f89fe51">operator()</a> (T_obj * _A_obj) const</td></tr>
  91 <tr class="memdesc:af627ef410fac7ec5d2ee842d8f89fe51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="classsigc_1_1volatile__mem__functor0.html#af627ef410fac7ec5d2ee842d8f89fe51">More...</a><br /></td></tr>
  92 <tr class="separator:af627ef410fac7ec5d2ee842d8f89fe51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 </table><table class="memberdecls">
  94 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  95 Protected Attributes</h2></td></tr>
  96 <tr class="memitem:a874e91ca403b95bb085ed596257de3ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#a2f0448d35b580f2b4884292f29b19b2f">function_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#a874e91ca403b95bb085ed596257de3ec">func_ptr_</a></td></tr>
  97 <tr class="separator:a874e91ca403b95bb085ed596257de3ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 </table>
  99 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 100 <div class="textblock"><h3>template&lt;class T_return, class T_obj&gt;<br />
 101 class sigc::volatile_mem_functor0&lt; T_return, T_obj &gt;</h3>
 102
 103 <p><a class="el" href="classsigc_1_1volatile__mem__functor0.html" title="volatile_mem_functor0 wraps volatile methods with 0 argument(s).">volatile_mem_functor0</a> wraps volatile methods with 0 argument(s). </p>
 104 <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_1volatile__mem__functor0.html" title="volatile_mem_functor0 wraps volatile methods with 0 argument(s).">volatile_mem_functor0</a>.</p>
 105 <p>The following template arguments are used:</p><ul>
 106 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1volatile__mem__functor0.html#af627ef410fac7ec5d2ee842d8f89fe51" title="Execute the wrapped method operating on the passed instance.">operator()()</a>.</li>
 107 <li><em>T_obj</em> The object type. </li>
 108 </ul>
 109 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 110 <a id="a2f0448d35b580f2b4884292f29b19b2f"></a>
 111 <h2 class="memtitle"><span class="permalink"><a href="#a2f0448d35b580f2b4884292f29b19b2f">&#9670;&#160;</a></span>function_type</h2>
 112
 113 <div class="memitem">
 114 <div class="memproto">
 115 <div class="memtemplate">
 116 template &lt;class T_return , class T_obj &gt; </div>
 117       <table class="memname">
 118         <tr>
 119           <td class="memname">typedef T_return(T_obj::* <a class="el" href="classsigc_1_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::function_type) () volatile</td>
 120         </tr>
 121       </table>
 122 </div><div class="memdoc">
 123
 124 </div>
 125 </div>
 126 <a id="a41fbd67d6bbde0818b880f08f6295396"></a>
 127 <h2 class="memtitle"><span class="permalink"><a href="#a41fbd67d6bbde0818b880f08f6295396">&#9670;&#160;</a></span>result_type</h2>
 128
 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_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1volatile__mem__functor0.html#a41fbd67d6bbde0818b880f08f6295396">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 id="ae29bbe3e668b370d2788631465daa63c"></a>
 144 <h2 class="memtitle"><span class="permalink"><a href="#ae29bbe3e668b370d2788631465daa63c">&#9670;&#160;</a></span>volatile_mem_functor0() <span class="overload">[1/2]</span></h2>
 145
 146 <div class="memitem">
 147 <div class="memproto">
 148 <div class="memtemplate">
 149 template &lt;class T_return , class T_obj &gt; </div>
 150 <table class="mlabels">
 151   <tr>
 152   <td class="mlabels-left">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname"><a class="el" href="classsigc_1_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1volatile__mem__functor0.html">volatile_mem_functor0</a> </td>
 156           <td>(</td>
 157           <td class="paramname"></td><td>)</td>
 158           <td></td>
 159         </tr>
 160       </table>
 161   </td>
 162   <td class="mlabels-right">
 163 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 164   </tr>
 165 </table>
 166 </div><div class="memdoc">
 167
 168 <p>Constructs an invalid functor. </p>
 169
 170 </div>
 171 </div>
 172 <a id="aa4e5e279480d50940eb4b73b9c61b938"></a>
 173 <h2 class="memtitle"><span class="permalink"><a href="#aa4e5e279480d50940eb4b73b9c61b938">&#9670;&#160;</a></span>volatile_mem_functor0() <span class="overload">[2/2]</span></h2>
 174
 175 <div class="memitem">
 176 <div class="memproto">
 177 <div class="memtemplate">
 178 template &lt;class T_return , class T_obj &gt; </div>
 179 <table class="mlabels">
 180   <tr>
 181   <td class="mlabels-left">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname"><a class="el" href="classsigc_1_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::<a class="el" href="classsigc_1_1volatile__mem__functor0.html">volatile_mem_functor0</a> </td>
 185           <td>(</td>
 186           <td class="paramtype"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#a2f0448d35b580f2b4884292f29b19b2f">function_type</a>&#160;</td>
 187           <td class="paramname"><em>_A_func</em></td><td>)</td>
 188           <td></td>
 189         </tr>
 190       </table>
 191   </td>
 192   <td class="mlabels-right">
 193 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 194   </tr>
 195 </table>
 196 </div><div class="memdoc">
 197
 198 <p>Constructs a <a class="el" href="classsigc_1_1volatile__mem__functor0.html" title="volatile_mem_functor0 wraps volatile methods with 0 argument(s).">volatile_mem_functor0</a> object that wraps the passed method. </p>
 199 <dl class="params"><dt>Parameters</dt><dd>
 200   <table class="params">
 201     <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1volatile__mem__functor0.html#af627ef410fac7ec5d2ee842d8f89fe51" title="Execute the wrapped method operating on the passed instance.">operator()()</a>. </td></tr>
 202   </table>
 203   </dd>
 204 </dl>
 205
 206 </div>
 207 </div>
 208 <h2 class="groupheader">Member Function Documentation</h2>
 209 <a id="aa5df40ec8fb385594c673a07f3ff8044"></a>
 210 <h2 class="memtitle"><span class="permalink"><a href="#aa5df40ec8fb385594c673a07f3ff8044">&#9670;&#160;</a></span>operator()() <span class="overload">[1/2]</span></h2>
 211
 212 <div class="memitem">
 213 <div class="memproto">
 214 <div class="memtemplate">
 215 template &lt;class T_return , class T_obj &gt; </div>
 216 <table class="mlabels">
 217   <tr>
 218   <td class="mlabels-left">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname">T_return <a class="el" href="classsigc_1_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::operator() </td>
 222           <td>(</td>
 223           <td class="paramtype">T_obj &amp;&#160;</td>
 224           <td class="paramname"><em>_A_obj</em></td><td>)</td>
 225           <td> const</td>
 226         </tr>
 227       </table>
 228   </td>
 229   <td class="mlabels-right">
 230 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 231   </tr>
 232 </table>
 233 </div><div class="memdoc">
 234
 235 <p>Execute the wrapped method operating on the passed instance. </p>
 236 <dl class="params"><dt>Parameters</dt><dd>
 237   <table class="params">
 238     <tr><td class="paramname">_A_obj</td><td>Reference to instance the method should operate on. </td></tr>
 239   </table>
 240   </dd>
 241 </dl>
 242 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 243
 244 </div>
 245 </div>
 246 <a id="af627ef410fac7ec5d2ee842d8f89fe51"></a>
 247 <h2 class="memtitle"><span class="permalink"><a href="#af627ef410fac7ec5d2ee842d8f89fe51">&#9670;&#160;</a></span>operator()() <span class="overload">[2/2]</span></h2>
 248
 249 <div class="memitem">
 250 <div class="memproto">
 251 <div class="memtemplate">
 252 template &lt;class T_return , class T_obj &gt; </div>
 253 <table class="mlabels">
 254   <tr>
 255   <td class="mlabels-left">
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">T_return <a class="el" href="classsigc_1_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::operator() </td>
 259           <td>(</td>
 260           <td class="paramtype">T_obj *&#160;</td>
 261           <td class="paramname"><em>_A_obj</em></td><td>)</td>
 262           <td> const</td>
 263         </tr>
 264       </table>
 265   </td>
 266   <td class="mlabels-right">
 267 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 268   </tr>
 269 </table>
 270 </div><div class="memdoc">
 271
 272 <p>Execute the wrapped method operating on the passed instance. </p>
 273 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000146">Deprecated:</a></b></dt><dd>Please use the constructor that takes the object by reference instead.</dd></dl>
 274 <dl class="params"><dt>Parameters</dt><dd>
 275   <table class="params">
 276     <tr><td class="paramname">_A_obj</td><td>Pointer to instance the method should operate on. </td></tr>
 277   </table>
 278   </dd>
 279 </dl>
 280 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
 281
 282 </div>
 283 </div>
 284 <h2 class="groupheader">Member Data Documentation</h2>
 285 <a id="a874e91ca403b95bb085ed596257de3ec"></a>
 286 <h2 class="memtitle"><span class="permalink"><a href="#a874e91ca403b95bb085ed596257de3ec">&#9670;&#160;</a></span>func_ptr_</h2>
 287
 288 <div class="memitem">
 289 <div class="memproto">
 290 <div class="memtemplate">
 291 template &lt;class T_return , class T_obj &gt; </div>
 292 <table class="mlabels">
 293   <tr>
 294   <td class="mlabels-left">
 295       <table class="memname">
 296         <tr>
 297           <td class="memname"><a class="el" href="classsigc_1_1volatile__mem__functor0.html#a2f0448d35b580f2b4884292f29b19b2f">function_type</a> <a class="el" href="classsigc_1_1volatile__mem__functor0.html">sigc::volatile_mem_functor0</a>&lt; T_return, T_obj &gt;::func_ptr_</td>
 298         </tr>
 299       </table>
 300   </td>
 301   <td class="mlabels-right">
 302 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 303   </tr>
 304 </table>
 305 </div><div class="memdoc">
 306
 307 </div>
 308 </div>
 309 </div><!-- contents -->
 310 <!-- start footer part -->
 311 <hr class="footer"/><address class="footer"><small>
 312 Generated on Fri Feb 11 2022 15:40:59 for libsigc++ by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
 313 </small></address>
 314 </body>
 315 </html>