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">
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::bound_mem_functor1< T_return, T_obj, T_arg1 > 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" />
13 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <table cellspacing="0" cellpadding="0">
17 <tr style="height: 56px;">
18 <td style="padding-left: 0.5em;">
19 <div id="projectname">libsigc++
20  <span id="projectnumber">2.3.1</span>
27 <!-- end header part -->
28 <!-- Generated by Doxygen 1.8.2 -->
29 <div id="navrow1" class="tabs">
31 <li><a href="index.html"><span>Main Page</span></a></li>
32 <li><a href="pages.html"><span>Related 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>
38 <div id="navrow2" class="tabs2">
40 <li><a href="annotated.html"><span>Class List</span></a></li>
41 <li><a href="classes.html"><span>Class Index</span></a></li>
42 <li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
43 <li><a href="functions.html"><span>Class Members</span></a></li>
46 <div id="nav-path" class="navpath">
48 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a></li> </ul>
53 <a href="#pub-types">Public Types</a> |
54 <a href="#pub-methods">Public Member Functions</a> |
55 <a href="#pub-attribs">Public Attributes</a> |
56 <a href="classsigc_1_1bound__mem__functor1-members.html">List of all members</a> </div>
57 <div class="headertitle">
58 <div class="title">sigc::bound_mem_functor1< T_return, T_obj, T_arg1 > Class Template Reference<div class="ingroups"><a class="el" href="group__mem__fun.html">mem_fun()</a></div></div> </div>
60 <div class="contents">
62 <p><a class="el" href="classsigc_1_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a> encapsulates a method with 1 arguments and an object instance. <a href="classsigc_1_1bound__mem__functor1.html#details">More...</a></p>
64 <p><code>#include <sigc++/functors/mem_fun.h></code></p>
65 <div class="dynheader">
66 Inheritance diagram for sigc::bound_mem_functor1< T_return, T_obj, T_arg1 >:</div>
67 <div class="dyncontent">
68 <div class="center"><img src="classsigc_1_1bound__mem__functor1__inherit__graph.png" border="0" usemap="#sigc_1_1bound__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map" alt="Inheritance graph"/></div>
69 <map name="sigc_1_1bound__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map" id="sigc_1_1bound__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4_inherit__map">
70 <area shape="rect" id="node2" href="classsigc_1_1mem__functor1.html" title="mem_functor1 wraps methods with 1 argument(s)." alt="" coords="29,83,179,147"/><area shape="rect" id="node4" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="35,5,173,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:a8e460c2a0eb87dcaf263c984b4dc5888"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e460c2a0eb87dcaf263c984b4dc5888"></a>
76 typedef base_type_::function_type </td><td class="memItemRight" valign="bottom"><b>function_type</b></td></tr>
77 <tr class="separator:a8e460c2a0eb87dcaf263c984b4dc5888"><td class="memSeparator" colspan="2"> </td></tr>
78 <tr class="inherit_header pub_types_classsigc_1_1mem__functor1"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classsigc_1_1mem__functor1')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classsigc_1_1mem__functor1.html">sigc::mem_functor1< T_return, T_obj, T_arg1 ></a></td></tr>
79 <tr class="memitem:a3e557dead320f2bff90655a004fe177f inherit pub_types_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e557dead320f2bff90655a004fe177f"></a>
80 typedef T_return(T_obj::* </td><td class="memItemRight" valign="bottom"><b>function_type</b> )(T_arg1)</td></tr>
81 <tr class="separator:a3e557dead320f2bff90655a004fe177f inherit pub_types_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </td></tr>
82 <tr class="memitem:a7c7ab28530e2f678eae87772253df709 inherit pub_types_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c7ab28530e2f678eae87772253df709"></a>
83 typedef T_return </td><td class="memItemRight" valign="bottom"><b>result_type</b></td></tr>
84 <tr class="separator:a7c7ab28530e2f678eae87772253df709 inherit pub_types_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </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:ad13235c20a9171bd24a4f8ae36577448"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#ad13235c20a9171bd24a4f8ae36577448">bound_mem_functor1</a> (T_obj* _A_obj, function_type _A_func)</td></tr>
89 <tr class="memdesc:ad13235c20a9171bd24a4f8ae36577448"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a> object that wraps the passed method. <a href="#ad13235c20a9171bd24a4f8ae36577448"></a><br/></td></tr>
90 <tr class="separator:ad13235c20a9171bd24a4f8ae36577448"><td class="memSeparator" colspan="2"> </td></tr>
91 <tr class="memitem:a777afe4673c9adc0798a38fc96bca7f6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#a777afe4673c9adc0798a38fc96bca7f6">bound_mem_functor1</a> (T_obj& _A_obj, function_type _A_func)</td></tr>
92 <tr class="memdesc:a777afe4673c9adc0798a38fc96bca7f6"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a> object that wraps the passed method. <a href="#a777afe4673c9adc0798a38fc96bca7f6"></a><br/></td></tr>
93 <tr class="separator:a777afe4673c9adc0798a38fc96bca7f6"><td class="memSeparator" colspan="2"> </td></tr>
94 <tr class="memitem:a5c589e3b5ce49a8845554ce9e95032a3"><td class="memItemLeft" align="right" valign="top">T_return </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#a5c589e3b5ce49a8845554ce9e95032a3">operator()</a> (typename type_trait< T_arg1 >::take _A_a1) const </td></tr>
95 <tr class="memdesc:a5c589e3b5ce49a8845554ce9e95032a3"><td class="mdescLeft"> </td><td class="mdescRight">Execute the wrapped method operating on the stored instance. <a href="#a5c589e3b5ce49a8845554ce9e95032a3"></a><br/></td></tr>
96 <tr class="separator:a5c589e3b5ce49a8845554ce9e95032a3"><td class="memSeparator" colspan="2"> </td></tr>
97 <tr class="inherit_header pub_methods_classsigc_1_1mem__functor1"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsigc_1_1mem__functor1')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsigc_1_1mem__functor1.html">sigc::mem_functor1< T_return, T_obj, T_arg1 ></a></td></tr>
98 <tr class="memitem:ab97c2206275025d8d1e7665c12322eba inherit pub_methods_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab97c2206275025d8d1e7665c12322eba"></a>
99  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor1.html#ab97c2206275025d8d1e7665c12322eba">mem_functor1</a> ()</td></tr>
100 <tr class="memdesc:ab97c2206275025d8d1e7665c12322eba inherit pub_methods_classsigc_1_1mem__functor1"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an invalid functor. <br/></td></tr>
101 <tr class="separator:ab97c2206275025d8d1e7665c12322eba inherit pub_methods_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </td></tr>
102 <tr class="memitem:a63230b348e410f7d2f245df1f2af019a inherit pub_methods_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor1.html#a63230b348e410f7d2f245df1f2af019a">mem_functor1</a> (function_type _A_func)</td></tr>
103 <tr class="memdesc:a63230b348e410f7d2f245df1f2af019a inherit pub_methods_classsigc_1_1mem__functor1"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1mem__functor1.html" title="mem_functor1 wraps methods with 1 argument(s).">mem_functor1</a> object that wraps the passed method. <a href="#a63230b348e410f7d2f245df1f2af019a"></a><br/></td></tr>
104 <tr class="separator:a63230b348e410f7d2f245df1f2af019a inherit pub_methods_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </td></tr>
105 <tr class="memitem:a72c4e7ffd730381bbb842f3b72816d02 inherit pub_methods_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top">T_return </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor1.html#a72c4e7ffd730381bbb842f3b72816d02">operator()</a> (T_obj* _A_obj, typename type_trait< T_arg1 >::take _A_a1) const </td></tr>
106 <tr class="memdesc:a72c4e7ffd730381bbb842f3b72816d02 inherit pub_methods_classsigc_1_1mem__functor1"><td class="mdescLeft"> </td><td class="mdescRight">Execute the wrapped method operating on the passed instance. <a href="#a72c4e7ffd730381bbb842f3b72816d02"></a><br/></td></tr>
107 <tr class="separator:a72c4e7ffd730381bbb842f3b72816d02 inherit pub_methods_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </td></tr>
108 <tr class="memitem:a3555bf838d0d60d24271d0354d925b40 inherit pub_methods_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top">T_return </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1mem__functor1.html#a3555bf838d0d60d24271d0354d925b40">operator()</a> (T_obj& _A_obj, typename type_trait< T_arg1 >::take _A_a1) const </td></tr>
109 <tr class="memdesc:a3555bf838d0d60d24271d0354d925b40 inherit pub_methods_classsigc_1_1mem__functor1"><td class="mdescLeft"> </td><td class="mdescRight">Execute the wrapped method operating on the passed instance. <a href="#a3555bf838d0d60d24271d0354d925b40"></a><br/></td></tr>
110 <tr class="separator:a3555bf838d0d60d24271d0354d925b40 inherit pub_methods_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </td></tr>
111 </table><table class="memberdecls">
112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
113 Public Attributes</h2></td></tr>
114 <tr class="memitem:a95ae2c4525d8218569b68bbb3effbadf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95ae2c4525d8218569b68bbb3effbadf"></a>
115 <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>< T_obj > </td><td class="memItemRight" valign="bottom"><b>obj_</b></td></tr>
116 <tr class="separator:a95ae2c4525d8218569b68bbb3effbadf"><td class="memSeparator" colspan="2"> </td></tr>
117 </table><table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
119 Additional Inherited Members</h2></td></tr>
120 <tr class="inherit_header pro_attribs_classsigc_1_1mem__functor1"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsigc_1_1mem__functor1')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsigc_1_1mem__functor1.html">sigc::mem_functor1< T_return, T_obj, T_arg1 ></a></td></tr>
121 <tr class="memitem:af5981be86ea36d59e86234ef5cd2b5a4 inherit pro_attribs_classsigc_1_1mem__functor1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5981be86ea36d59e86234ef5cd2b5a4"></a>
122 function_type </td><td class="memItemRight" valign="bottom"><b>func_ptr_</b></td></tr>
123 <tr class="separator:af5981be86ea36d59e86234ef5cd2b5a4 inherit pro_attribs_classsigc_1_1mem__functor1"><td class="memSeparator" colspan="2"> </td></tr>
125 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
126 <div class="textblock"><h3>template<class T_return, class T_obj, class T_arg1><br/>
127 class sigc::bound_mem_functor1< T_return, T_obj, T_arg1 ></h3>
129 <p><a class="el" href="classsigc_1_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a> encapsulates a method with 1 arguments and an object instance. </p>
130 <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_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a>.</p>
131 <p>The following template arguments are used:</p>
133 <li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1bound__mem__functor1.html#a5c589e3b5ce49a8845554ce9e95032a3" title="Execute the wrapped method operating on the stored instance.">operator()()</a>.</li>
134 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1bound__mem__functor1.html#a5c589e3b5ce49a8845554ce9e95032a3" title="Execute the wrapped method operating on the stored instance.">operator()()</a>.</li>
135 <li><em>T_obj</em> The object type. </li>
137 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
138 <a class="anchor" id="ad13235c20a9171bd24a4f8ae36577448"></a>
139 <div class="memitem">
140 <div class="memproto">
141 <div class="memtemplate">
142 template <class T_return , class T_obj , class T_arg1 > </div>
143 <table class="mlabels">
145 <td class="mlabels-left">
146 <table class="memname">
148 <td class="memname"><a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>< T_return, T_obj, T_arg1 >::<a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> </td>
150 <td class="paramtype">T_obj * </td>
151 <td class="paramname"><em>_A_obj</em>, </td>
154 <td class="paramkey"></td>
156 <td class="paramtype">function_type </td>
157 <td class="paramname"><em>_A_func</em> </td>
166 <td class="mlabels-right">
167 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
170 </div><div class="memdoc">
172 <p>Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a> object that wraps the passed method. </p>
173 <dl class="params"><dt>Parameters</dt><dd>
174 <table class="params">
175 <tr><td class="paramname">_A_obj</td><td>Pointer to instance the method will operate on. </td></tr>
176 <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1bound__mem__functor1.html#a5c589e3b5ce49a8845554ce9e95032a3" title="Execute the wrapped method operating on the stored instance.">operator()()</a>. </td></tr>
183 <a class="anchor" id="a777afe4673c9adc0798a38fc96bca7f6"></a>
184 <div class="memitem">
185 <div class="memproto">
186 <div class="memtemplate">
187 template <class T_return , class T_obj , class T_arg1 > </div>
188 <table class="mlabels">
190 <td class="mlabels-left">
191 <table class="memname">
193 <td class="memname"><a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>< T_return, T_obj, T_arg1 >::<a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> </td>
195 <td class="paramtype">T_obj & </td>
196 <td class="paramname"><em>_A_obj</em>, </td>
199 <td class="paramkey"></td>
201 <td class="paramtype">function_type </td>
202 <td class="paramname"><em>_A_func</em> </td>
211 <td class="mlabels-right">
212 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
215 </div><div class="memdoc">
217 <p>Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html" title="bound_mem_functor1 encapsulates a method with 1 arguments and an object instance.">bound_mem_functor1</a> object that wraps the passed method. </p>
218 <dl class="params"><dt>Parameters</dt><dd>
219 <table class="params">
220 <tr><td class="paramname">_A_obj</td><td>Reference to instance the method will operate on. </td></tr>
221 <tr><td class="paramname">_A_func</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1bound__mem__functor1.html#a5c589e3b5ce49a8845554ce9e95032a3" title="Execute the wrapped method operating on the stored instance.">operator()()</a>. </td></tr>
228 <h2 class="groupheader">Member Function Documentation</h2>
229 <a class="anchor" id="a5c589e3b5ce49a8845554ce9e95032a3"></a>
230 <div class="memitem">
231 <div class="memproto">
232 <div class="memtemplate">
233 template <class T_return , class T_obj , class T_arg1 > </div>
234 <table class="mlabels">
236 <td class="mlabels-left">
237 <table class="memname">
239 <td class="memname">T_return <a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>< T_return, T_obj, T_arg1 >::operator() </td>
241 <td class="paramtype">typename type_trait< T_arg1 >::take </td>
242 <td class="paramname"><em>_A_a1</em></td><td>)</td>
247 <td class="mlabels-right">
248 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
251 </div><div class="memdoc">
253 <p>Execute the wrapped method operating on the stored instance. </p>
254 <dl class="params"><dt>Parameters</dt><dd>
255 <table class="params">
256 <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the method. </td></tr>
260 <dl class="section return"><dt>Returns</dt><dd>The return value of the method invocation. </dd></dl>
264 </div><!-- contents -->
265 <!-- start footer part -->
266 <hr class="footer"/><address class="footer"><small>
267 Generated on Thu Oct 18 2012 09:28:25 for libsigc++ by  <a href="http://www.doxygen.org/index.html">
268 <img class="footer" src="doxygen.png" alt="doxygen"/>