Imported Upstream version 2.99.2
[platform/upstream/libsigc++.git] / docs / reference / html / classsigc_1_1bound__mem__functor.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::bound_mem_functor&lt; T_func, T_arg &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.99.2</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_1bound__mem__functor.html">bound_mem_functor</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="#pub-attribs">Public Attributes</a> &#124;
58 <a href="classsigc_1_1bound__mem__functor-members.html">List of all members</a>  </div>
59   <div class="headertitle">
60 <div class="title">sigc::bound_mem_functor&lt; T_func, T_arg &gt; Class Template Reference</div>  </div>
61 </div><!--header-->
62 <div class="contents">
63
64 <p><code>#include &lt;sigc++/functors/mem_fun.h&gt;</code></p>
65 <div class="dynheader">
66 Inheritance diagram for sigc::bound_mem_functor&lt; T_func, T_arg &gt;:</div>
67 <div class="dyncontent">
68 <div class="center"><img src="classsigc_1_1bound__mem__functor__inherit__graph.png" border="0" usemap="#sigc_1_1bound__mem__functor_3_01T__func_00_01T__arg_01_4_inherit__map" alt="Inheritance graph"/></div>
69 <map name="sigc_1_1bound__mem__functor_3_01T__func_00_01T__arg_01_4_inherit__map" id="sigc_1_1bound__mem__functor_3_01T__func_00_01T__arg_01_4_inherit__map">
70 <area shape="rect" id="node2" href="classsigc_1_1mem__functor.html" title="sigc::mem_functor\&lt;\l T_func, T_arg...\&gt;" alt="" coords="23,80,175,121"/><area shape="rect" id="node3" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="30,5,169,32"/></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:a872b1c05e93574f6b4fea719dd84562b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#a872b1c05e93574f6b4fea719dd84562b">function_type</a> = typename <a class="el" href="classsigc_1_1mem__functor.html#a15a8ea02f1ffc3875b06fe24afe0c716">base_type::function_type</a></td></tr>
76 <tr class="separator:a872b1c05e93574f6b4fea719dd84562b"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 <tr class="memitem:abb9c367edb9d7e8d475ebf1690d079d6"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#abb9c367edb9d7e8d475ebf1690d079d6">obj_type_with_modifier</a> = typename std::conditional_t&lt; internal::member_method_is_const&lt; T_func &gt;::value, const <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a>, <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a> &gt;</td></tr>
78 <tr class="separator:abb9c367edb9d7e8d475ebf1690d079d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:a6cff1d1d709688fed710b40ce96c6eca"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a> = typename <a class="el" href="classsigc_1_1mem__functor.html#a66ce968499f60275c30feea623a5fa5b">base_type::object_type</a></td></tr>
80 <tr class="separator:a6cff1d1d709688fed710b40ce96c6eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 <tr class="memitem:a6e3829edf337389a0427ffff403838a8"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#a6e3829edf337389a0427ffff403838a8">result_type</a> = typename <a class="el" href="classsigc_1_1mem__functor.html#ab35ca512321bab23d281672bae70f2e4">base_type::result_type</a></td></tr>
82 <tr class="separator:a6e3829edf337389a0427ffff403838a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a5f9c4408bf79f18f6531df98c2dbfac1"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#a5f9c4408bf79f18f6531df98c2dbfac1">T_limit_reference</a> = typename std::conditional_t&lt; internal::member_method_is_const&lt; T_func &gt;::value, <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>&lt; const <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a> &gt;, <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>&lt; <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a> &gt;&gt;</td></tr>
84 <tr class="separator:a5f9c4408bf79f18f6531df98c2dbfac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 </table><table class="memberdecls">
86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
87 Public Member Functions</h2></td></tr>
88 <tr class="memitem:abf0f84db2b1fd9268432e853667937d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#abf0f84db2b1fd9268432e853667937d9">bound_mem_functor</a> (<a class="el" href="classsigc_1_1bound__mem__functor.html#abb9c367edb9d7e8d475ebf1690d079d6">obj_type_with_modifier</a>&amp; _A_obj, <a class="el" href="classsigc_1_1bound__mem__functor.html#a872b1c05e93574f6b4fea719dd84562b">function_type</a> _A_func)</td></tr>
89 <tr class="memdesc:abf0f84db2b1fd9268432e853667937d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1bound__mem__functor.html">bound_mem_functor</a> object that wraps the passed method.  <a href="#abf0f84db2b1fd9268432e853667937d9">More...</a><br /></td></tr>
90 <tr class="separator:abf0f84db2b1fd9268432e853667937d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:aa4a72f4d8769468ae4684ff78b80c8a3"><td class="memItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#aa4a72f4d8769468ae4684ff78b80c8a3">operator()</a> (<a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg &gt;..._A_a) const </td></tr>
92 <tr class="memdesc:aa4a72f4d8769468ae4684ff78b80c8a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped method operating on the stored instance.  <a href="#aa4a72f4d8769468ae4684ff78b80c8a3">More...</a><br /></td></tr>
93 <tr class="separator:aa4a72f4d8769468ae4684ff78b80c8a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 </table><table class="memberdecls">
95 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
96 Public Attributes</h2></td></tr>
97 <tr class="memitem:a634f14739f5639cbba81c0fec28303b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1bound__mem__functor.html#a5f9c4408bf79f18f6531df98c2dbfac1">T_limit_reference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor.html#a634f14739f5639cbba81c0fec28303b3">obj_</a></td></tr>
98 <tr class="separator:a634f14739f5639cbba81c0fec28303b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 </table>
100 <h2 class="groupheader">Member Typedef Documentation</h2>
101 <a class="anchor" id="a872b1c05e93574f6b4fea719dd84562b"></a>
102 <div class="memitem">
103 <div class="memproto">
104 <div class="memtemplate">
105 template &lt;class T_func , class... T_arg&gt; </div>
106       <table class="memname">
107         <tr>
108           <td class="memname">using <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::<a class="el" href="classsigc_1_1bound__mem__functor.html#a872b1c05e93574f6b4fea719dd84562b">function_type</a> =  typename <a class="el" href="classsigc_1_1mem__functor.html#a15a8ea02f1ffc3875b06fe24afe0c716">base_type::function_type</a></td>
109         </tr>
110       </table>
111 </div><div class="memdoc">
112
113 </div>
114 </div>
115 <a class="anchor" id="abb9c367edb9d7e8d475ebf1690d079d6"></a>
116 <div class="memitem">
117 <div class="memproto">
118 <div class="memtemplate">
119 template &lt;class T_func , class... T_arg&gt; </div>
120       <table class="memname">
121         <tr>
122           <td class="memname">using <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::<a class="el" href="classsigc_1_1bound__mem__functor.html#abb9c367edb9d7e8d475ebf1690d079d6">obj_type_with_modifier</a> =  typename std::conditional_t&lt; internal::member_method_is_const&lt;T_func&gt;::value, const <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a>, <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a>&gt;</td>
123         </tr>
124       </table>
125 </div><div class="memdoc">
126
127 </div>
128 </div>
129 <a class="anchor" id="a6cff1d1d709688fed710b40ce96c6eca"></a>
130 <div class="memitem">
131 <div class="memproto">
132 <div class="memtemplate">
133 template &lt;class T_func , class... T_arg&gt; </div>
134       <table class="memname">
135         <tr>
136           <td class="memname">using <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::<a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a> =  typename <a class="el" href="classsigc_1_1mem__functor.html#a66ce968499f60275c30feea623a5fa5b">base_type::object_type</a></td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140
141 </div>
142 </div>
143 <a class="anchor" id="a6e3829edf337389a0427ffff403838a8"></a>
144 <div class="memitem">
145 <div class="memproto">
146 <div class="memtemplate">
147 template &lt;class T_func , class... T_arg&gt; </div>
148       <table class="memname">
149         <tr>
150           <td class="memname">using <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::<a class="el" href="classsigc_1_1bound__mem__functor.html#a6e3829edf337389a0427ffff403838a8">result_type</a> =  typename <a class="el" href="classsigc_1_1mem__functor.html#ab35ca512321bab23d281672bae70f2e4">base_type::result_type</a></td>
151         </tr>
152       </table>
153 </div><div class="memdoc">
154
155 </div>
156 </div>
157 <a class="anchor" id="a5f9c4408bf79f18f6531df98c2dbfac1"></a>
158 <div class="memitem">
159 <div class="memproto">
160 <div class="memtemplate">
161 template &lt;class T_func , class... T_arg&gt; </div>
162       <table class="memname">
163         <tr>
164           <td class="memname">using <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::<a class="el" href="classsigc_1_1bound__mem__functor.html#a5f9c4408bf79f18f6531df98c2dbfac1">T_limit_reference</a> =  typename std::conditional_t&lt; internal::member_method_is_const&lt;T_func&gt;::value, <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>&lt;const <a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a>&gt;, <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>&lt;<a class="el" href="classsigc_1_1bound__mem__functor.html#a6cff1d1d709688fed710b40ce96c6eca">object_type</a>&gt;&gt;</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168
169 </div>
170 </div>
171 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
172 <a class="anchor" id="abf0f84db2b1fd9268432e853667937d9"></a>
173 <div class="memitem">
174 <div class="memproto">
175 <div class="memtemplate">
176 template &lt;class T_func , class... T_arg&gt; </div>
177 <table class="mlabels">
178   <tr>
179   <td class="mlabels-left">
180       <table class="memname">
181         <tr>
182           <td class="memname"><a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::<a class="el" href="classsigc_1_1bound__mem__functor.html">bound_mem_functor</a> </td>
183           <td>(</td>
184           <td class="paramtype"><a class="el" href="classsigc_1_1bound__mem__functor.html#abb9c367edb9d7e8d475ebf1690d079d6">obj_type_with_modifier</a>&amp;&#160;</td>
185           <td class="paramname"><em>_A_obj</em>, </td>
186         </tr>
187         <tr>
188           <td class="paramkey"></td>
189           <td></td>
190           <td class="paramtype"><a class="el" href="classsigc_1_1bound__mem__functor.html#a872b1c05e93574f6b4fea719dd84562b">function_type</a>&#160;</td>
191           <td class="paramname"><em>_A_func</em>&#160;</td>
192         </tr>
193         <tr>
194           <td></td>
195           <td>)</td>
196           <td></td><td></td>
197         </tr>
198       </table>
199   </td>
200   <td class="mlabels-right">
201 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
202   </tr>
203 </table>
204 </div><div class="memdoc">
205
206 <p>Constructs a <a class="el" href="classsigc_1_1bound__mem__functor.html">bound_mem_functor</a> object that wraps the passed method. </p>
207 <dl class="params"><dt>Parameters</dt><dd>
208   <table class="params">
209     <tr><td class="paramname">_A_obj</td><td>Reference to instance the method will operate on. </td></tr>
210     <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1bound__mem__functor.html#aa4a72f4d8769468ae4684ff78b80c8a3" title="Execute the wrapped method operating on the stored instance. ">operator()()</a>. </td></tr>
211   </table>
212   </dd>
213 </dl>
214
215 </div>
216 </div>
217 <h2 class="groupheader">Member Function Documentation</h2>
218 <a class="anchor" id="aa4a72f4d8769468ae4684ff78b80c8a3"></a>
219 <div class="memitem">
220 <div class="memproto">
221 <div class="memtemplate">
222 template &lt;class T_func , class... T_arg&gt; </div>
223 <table class="mlabels">
224   <tr>
225   <td class="mlabels-left">
226       <table class="memname">
227         <tr>
228           <td class="memname">decltype(auto) <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::operator() </td>
229           <td>(</td>
230           <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg &gt;...&#160;</td>
231           <td class="paramname"><em>_A_a</em></td><td>)</td>
232           <td> const</td>
233         </tr>
234       </table>
235   </td>
236   <td class="mlabels-right">
237 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
238   </tr>
239 </table>
240 </div><div class="memdoc">
241
242 <p>Execute the wrapped method operating on the stored instance. </p>
243 <dl class="params"><dt>Parameters</dt><dd>
244   <table class="params">
245     <tr><td class="paramname">_A_a...</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 <h2 class="groupheader">Member Data Documentation</h2>
254 <a class="anchor" id="a634f14739f5639cbba81c0fec28303b3"></a>
255 <div class="memitem">
256 <div class="memproto">
257 <div class="memtemplate">
258 template &lt;class T_func , class... T_arg&gt; </div>
259       <table class="memname">
260         <tr>
261           <td class="memname"><a class="el" href="classsigc_1_1bound__mem__functor.html#a5f9c4408bf79f18f6531df98c2dbfac1">T_limit_reference</a> <a class="el" href="classsigc_1_1bound__mem__functor.html">sigc::bound_mem_functor</a>&lt; T_func, T_arg &gt;::obj_</td>
262         </tr>
263       </table>
264 </div><div class="memdoc">
265
266 </div>
267 </div>
268 </div><!-- contents -->
269 <!-- start footer part -->
270 <hr class="footer"/><address class="footer"><small>
271 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
272 <img class="footer" src="doxygen.png" alt="doxygen"/>
273 </a> 1.8.9.1
274 </small></address>
275 </body>
276 </html>