]> git.tdb.fi Git - ext/sigc++-2.0.git/blob - untracked/docs/reference/html/classsigc_1_1volatile__mem__functor1.html
Import libsigc++ 2.10.8 sources
[ext/sigc++-2.0.git] / untracked / docs / reference / html / classsigc_1_1volatile__mem__functor1.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_functor1&lt; T_return, T_obj, T_arg1 &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__functor1.html">volatile_mem_functor1</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__functor1-members.html">List of all members</a>  </div>
52   <div class="headertitle">
53 <div class="title">sigc::volatile_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>
54 </div><!--header-->
55 <div class="contents">
56
57 <p><a class="el" href="classsigc_1_1volatile__mem__functor1.html" title="volatile_mem_functor1 wraps volatile methods with 1 argument(s).">volatile_mem_functor1</a> wraps volatile methods with 1 argument(s).  
58  <a href="classsigc_1_1volatile__mem__functor1.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_functor1&lt; T_return, T_obj, T_arg1 &gt;:</div>
63 <div class="dyncontent">
64 <div class="center"><img src="classsigc_1_1volatile__mem__functor1__inherit__graph.png" border="0" usemap="#asigc_1_1volatile__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map" alt="Inheritance graph"/></div>
65 <map name="asigc_1_1volatile__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map" id="asigc_1_1volatile__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map">
66 <area shape="rect" title="volatile_mem_functor1 wraps volatile methods with 1 argument(s)." alt="" coords="26,80,182,136"/>
67 <area shape="rect" href="classsigc_1_1bound__volatile__mem__functor1.html" title="bound_volatile_mem_functor1 encapsulates a volatile method with 1 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:a49228c222297c3f116b132370c3f054d"><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__functor1.html#a49228c222297c3f116b132370c3f054d">function_type</a>) (T_arg1) volatile</td></tr>
75 <tr class="separator:a49228c222297c3f116b132370c3f054d"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a3bcbf6ae6e950d35e4ac7b33fa066877"><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__functor1.html#a3bcbf6ae6e950d35e4ac7b33fa066877">result_type</a></td></tr>
77 <tr class="separator:a3bcbf6ae6e950d35e4ac7b33fa066877"><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:a30ec3be683a2c466b23da53c8025608b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a30ec3be683a2c466b23da53c8025608b">volatile_mem_functor1</a> ()</td></tr>
82 <tr class="memdesc:a30ec3be683a2c466b23da53c8025608b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor.  <a href="classsigc_1_1volatile__mem__functor1.html#a30ec3be683a2c466b23da53c8025608b">More...</a><br /></td></tr>
83 <tr class="separator:a30ec3be683a2c466b23da53c8025608b"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a86d592aee0ca1d853b64b52224054029"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a86d592aee0ca1d853b64b52224054029">volatile_mem_functor1</a> (<a class="el" href="classsigc_1_1volatile__mem__functor1.html#a49228c222297c3f116b132370c3f054d">function_type</a> _A_func)</td></tr>
85 <tr class="memdesc:a86d592aee0ca1d853b64b52224054029"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1volatile__mem__functor1.html" title="volatile_mem_functor1 wraps volatile methods with 1 argument(s).">volatile_mem_functor1</a> object that wraps the passed method.  <a href="classsigc_1_1volatile__mem__functor1.html#a86d592aee0ca1d853b64b52224054029">More...</a><br /></td></tr>
86 <tr class="separator:a86d592aee0ca1d853b64b52224054029"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a98cdb61b4c623e44d5b60650098bddfd"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a98cdb61b4c623e44d5b60650098bddfd">operator()</a> (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>
88 <tr class="memdesc:a98cdb61b4c623e44d5b60650098bddfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="classsigc_1_1volatile__mem__functor1.html#a98cdb61b4c623e44d5b60650098bddfd">More...</a><br /></td></tr>
89 <tr class="separator:a98cdb61b4c623e44d5b60650098bddfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a69185452103c51af81b78e95504eb95c"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a69185452103c51af81b78e95504eb95c">operator()</a> (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>
91 <tr class="memdesc:a69185452103c51af81b78e95504eb95c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the passed instance.  <a href="classsigc_1_1volatile__mem__functor1.html#a69185452103c51af81b78e95504eb95c">More...</a><br /></td></tr>
92 <tr class="separator:a69185452103c51af81b78e95504eb95c"><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:ad07b2821f95c27c013af4fdce527c1cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a49228c222297c3f116b132370c3f054d">function_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#ad07b2821f95c27c013af4fdce527c1cb">func_ptr_</a></td></tr>
97 <tr class="separator:ad07b2821f95c27c013af4fdce527c1cb"><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, class T_arg1&gt;<br />
101 class sigc::volatile_mem_functor1&lt; T_return, T_obj, T_arg1 &gt;</h3>
102
103 <p><a class="el" href="classsigc_1_1volatile__mem__functor1.html" title="volatile_mem_functor1 wraps volatile methods with 1 argument(s).">volatile_mem_functor1</a> wraps volatile methods with 1 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__functor1.html" title="volatile_mem_functor1 wraps volatile methods with 1 argument(s).">volatile_mem_functor1</a>.</p>
105 <p>The following template arguments are used:</p><ul>
106 <li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1volatile__mem__functor1.html#a69185452103c51af81b78e95504eb95c" title="Execute the wrapped method operating on the passed instance.">operator()()</a>.</li>
107 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1volatile__mem__functor1.html#a69185452103c51af81b78e95504eb95c" title="Execute the wrapped method operating on the passed instance.">operator()()</a>.</li>
108 <li><em>T_obj</em> The object type. </li>
109 </ul>
110 </div><h2 class="groupheader">Member Typedef Documentation</h2>
111 <a id="a49228c222297c3f116b132370c3f054d"></a>
112 <h2 class="memtitle"><span class="permalink"><a href="#a49228c222297c3f116b132370c3f054d">&#9670;&#160;</a></span>function_type</h2>
113
114 <div class="memitem">
115 <div class="memproto">
116 <div class="memtemplate">
117 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
118       <table class="memname">
119         <tr>
120           <td class="memname">typedef T_return(T_obj::* <a class="el" href="classsigc_1_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::function_type) (T_arg1) volatile</td>
121         </tr>
122       </table>
123 </div><div class="memdoc">
124
125 </div>
126 </div>
127 <a id="a3bcbf6ae6e950d35e4ac7b33fa066877"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#a3bcbf6ae6e950d35e4ac7b33fa066877">&#9670;&#160;</a></span>result_type</h2>
129
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_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::<a class="el" href="classsigc_1_1volatile__mem__functor1.html#a3bcbf6ae6e950d35e4ac7b33fa066877">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 id="a30ec3be683a2c466b23da53c8025608b"></a>
145 <h2 class="memtitle"><span class="permalink"><a href="#a30ec3be683a2c466b23da53c8025608b">&#9670;&#160;</a></span>volatile_mem_functor1() <span class="overload">[1/2]</span></h2>
146
147 <div class="memitem">
148 <div class="memproto">
149 <div class="memtemplate">
150 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
151 <table class="mlabels">
152   <tr>
153   <td class="mlabels-left">
154       <table class="memname">
155         <tr>
156           <td class="memname"><a class="el" href="classsigc_1_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::<a class="el" href="classsigc_1_1volatile__mem__functor1.html">volatile_mem_functor1</a> </td>
157           <td>(</td>
158           <td class="paramname"></td><td>)</td>
159           <td></td>
160         </tr>
161       </table>
162   </td>
163   <td class="mlabels-right">
164 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
165   </tr>
166 </table>
167 </div><div class="memdoc">
168
169 <p>Constructs an invalid functor. </p>
170
171 </div>
172 </div>
173 <a id="a86d592aee0ca1d853b64b52224054029"></a>
174 <h2 class="memtitle"><span class="permalink"><a href="#a86d592aee0ca1d853b64b52224054029">&#9670;&#160;</a></span>volatile_mem_functor1() <span class="overload">[2/2]</span></h2>
175
176 <div class="memitem">
177 <div class="memproto">
178 <div class="memtemplate">
179 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
180 <table class="mlabels">
181   <tr>
182   <td class="mlabels-left">
183       <table class="memname">
184         <tr>
185           <td class="memname"><a class="el" href="classsigc_1_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::<a class="el" href="classsigc_1_1volatile__mem__functor1.html">volatile_mem_functor1</a> </td>
186           <td>(</td>
187           <td class="paramtype"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a49228c222297c3f116b132370c3f054d">function_type</a>&#160;</td>
188           <td class="paramname"><em>_A_func</em></td><td>)</td>
189           <td></td>
190         </tr>
191       </table>
192   </td>
193   <td class="mlabels-right">
194 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
195   </tr>
196 </table>
197 </div><div class="memdoc">
198
199 <p>Constructs a <a class="el" href="classsigc_1_1volatile__mem__functor1.html" title="volatile_mem_functor1 wraps volatile methods with 1 argument(s).">volatile_mem_functor1</a> object that wraps the passed method. </p>
200 <dl class="params"><dt>Parameters</dt><dd>
201   <table class="params">
202     <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1volatile__mem__functor1.html#a69185452103c51af81b78e95504eb95c" title="Execute the wrapped method operating on the passed instance.">operator()()</a>. </td></tr>
203   </table>
204   </dd>
205 </dl>
206
207 </div>
208 </div>
209 <h2 class="groupheader">Member Function Documentation</h2>
210 <a id="a98cdb61b4c623e44d5b60650098bddfd"></a>
211 <h2 class="memtitle"><span class="permalink"><a href="#a98cdb61b4c623e44d5b60650098bddfd">&#9670;&#160;</a></span>operator()() <span class="overload">[1/2]</span></h2>
212
213 <div class="memitem">
214 <div class="memproto">
215 <div class="memtemplate">
216 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
217 <table class="mlabels">
218   <tr>
219   <td class="mlabels-left">
220       <table class="memname">
221         <tr>
222           <td class="memname">T_return <a class="el" href="classsigc_1_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::operator() </td>
223           <td>(</td>
224           <td class="paramtype">T_obj &amp;&#160;</td>
225           <td class="paramname"><em>_A_obj</em>, </td>
226         </tr>
227         <tr>
228           <td class="paramkey"></td>
229           <td></td>
230           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
231           <td class="paramname"><em>_A_a1</em>&#160;</td>
232         </tr>
233         <tr>
234           <td></td>
235           <td>)</td>
236           <td></td><td> const</td>
237         </tr>
238       </table>
239   </td>
240   <td class="mlabels-right">
241 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
242   </tr>
243 </table>
244 </div><div class="memdoc">
245
246 <p>Execute the wrapped method operating on the passed instance. </p>
247 <dl class="params"><dt>Parameters</dt><dd>
248   <table class="params">
249     <tr><td class="paramname">_A_obj</td><td>Reference to instance the method should operate on. </td></tr>
250     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the method. </td></tr>
251   </table>
252   </dd>
253 </dl>
254 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
255
256 </div>
257 </div>
258 <a id="a69185452103c51af81b78e95504eb95c"></a>
259 <h2 class="memtitle"><span class="permalink"><a href="#a69185452103c51af81b78e95504eb95c">&#9670;&#160;</a></span>operator()() <span class="overload">[2/2]</span></h2>
260
261 <div class="memitem">
262 <div class="memproto">
263 <div class="memtemplate">
264 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
265 <table class="mlabels">
266   <tr>
267   <td class="mlabels-left">
268       <table class="memname">
269         <tr>
270           <td class="memname">T_return <a class="el" href="classsigc_1_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::operator() </td>
271           <td>(</td>
272           <td class="paramtype">T_obj *&#160;</td>
273           <td class="paramname"><em>_A_obj</em>, </td>
274         </tr>
275         <tr>
276           <td class="paramkey"></td>
277           <td></td>
278           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
279           <td class="paramname"><em>_A_a1</em>&#160;</td>
280         </tr>
281         <tr>
282           <td></td>
283           <td>)</td>
284           <td></td><td> const</td>
285         </tr>
286       </table>
287   </td>
288   <td class="mlabels-right">
289 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
290   </tr>
291 </table>
292 </div><div class="memdoc">
293
294 <p>Execute the wrapped method operating on the passed instance. </p>
295 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000147">Deprecated:</a></b></dt><dd>Please use the constructor that takes the object by reference instead.</dd></dl>
296 <dl class="params"><dt>Parameters</dt><dd>
297   <table class="params">
298     <tr><td class="paramname">_A_obj</td><td>Pointer to instance the method should operate on. </td></tr>
299     <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the method. </td></tr>
300   </table>
301   </dd>
302 </dl>
303 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
304
305 </div>
306 </div>
307 <h2 class="groupheader">Member Data Documentation</h2>
308 <a id="ad07b2821f95c27c013af4fdce527c1cb"></a>
309 <h2 class="memtitle"><span class="permalink"><a href="#ad07b2821f95c27c013af4fdce527c1cb">&#9670;&#160;</a></span>func_ptr_</h2>
310
311 <div class="memitem">
312 <div class="memproto">
313 <div class="memtemplate">
314 template &lt;class T_return , class T_obj , class T_arg1 &gt; </div>
315 <table class="mlabels">
316   <tr>
317   <td class="mlabels-left">
318       <table class="memname">
319         <tr>
320           <td class="memname"><a class="el" href="classsigc_1_1volatile__mem__functor1.html#a49228c222297c3f116b132370c3f054d">function_type</a> <a class="el" href="classsigc_1_1volatile__mem__functor1.html">sigc::volatile_mem_functor1</a>&lt; T_return, T_obj, T_arg1 &gt;::func_ptr_</td>
321         </tr>
322       </table>
323   </td>
324   <td class="mlabels-right">
325 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
326   </tr>
327 </table>
328 </div><div class="memdoc">
329
330 </div>
331 </div>
332 </div><!-- contents -->
333 <!-- start footer part -->
334 <hr class="footer"/><address class="footer"><small>
335 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
336 </small></address>
337 </body>
338 </html>