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">
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::pointer_functor1< T_arg1, T_return > 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"/>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
18 <table cellspacing="0" cellpadding="0">
20 <tr style="height: 56px;">
21 <td id="projectalign" style="padding-left: 0.5em;">
22 <div id="projectname">libsigc++
23  <span id="projectnumber">2.10.8</span>
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&dn=gpl-2.0.txt GPL-v2 */
37 initMenu('',false,false,'search.php','Search');
39 /* @license-end */</script>
40 <div id="main-nav"></div>
41 <div id="nav-path" class="navpath">
43 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1pointer__functor1.html">pointer_functor1</a></li> </ul>
48 <a href="#pub-types">Public Types</a> |
49 <a href="#pub-methods">Public Member Functions</a> |
50 <a href="#pro-attribs">Protected Attributes</a> |
51 <a href="classsigc_1_1pointer__functor1-members.html">List of all members</a> </div>
52 <div class="headertitle">
53 <div class="title">sigc::pointer_functor1< T_arg1, T_return > Class Template Reference<div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a> » <a class="el" href="group__ptr__fun.html">ptr_fun()</a></div></div> </div>
55 <div class="contents">
57 <p><a class="el" href="classsigc_1_1pointer__functor1.html" title="pointer_functor1 wraps existing non-member functions with 1 argument(s).">pointer_functor1</a> wraps existing non-member functions with 1 argument(s).
58 <a href="classsigc_1_1pointer__functor1.html#details">More...</a></p>
60 <p><code>#include <sigc++/functors/ptr_fun.h></code></p>
61 <div class="dynheader">
62 Inheritance diagram for sigc::pointer_functor1< T_arg1, T_return >:</div>
63 <div class="dyncontent">
64 <div class="center"><img src="classsigc_1_1pointer__functor1__inherit__graph.png" border="0" usemap="#asigc_1_1pointer__functor1_3_01T__arg1_00_01T__return_01_4_inherit__map" alt="Inheritance graph"/></div>
65 <map name="asigc_1_1pointer__functor1_3_01T__arg1_00_01T__return_01_4_inherit__map" id="asigc_1_1pointer__functor1_3_01T__arg1_00_01T__return_01_4_inherit__map">
66 <area shape="rect" title="pointer_functor1 wraps existing non-member functions with 1 argument(s)." alt="" coords="5,80,168,121"/>
67 <area shape="rect" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="17,5,157,32"/>
69 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
70 <table class="memberdecls">
71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
72 Public Types</h2></td></tr>
73 <tr class="memitem:a4080910d23a74b102a123838fa93e90b"><td class="memItemLeft" align="right" valign="top">typedef T_return </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor1.html#a4080910d23a74b102a123838fa93e90b">result_type</a></td></tr>
74 <tr class="separator:a4080910d23a74b102a123838fa93e90b"><td class="memSeparator" colspan="2"> </td></tr>
75 </table><table class="memberdecls">
76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
77 Public Member Functions</h2></td></tr>
78 <tr class="memitem:a6ce467c0641f8e3e0d91f3b843b07c3f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor1.html#a6ce467c0641f8e3e0d91f3b843b07c3f">pointer_functor1</a> ()</td></tr>
79 <tr class="memdesc:a6ce467c0641f8e3e0d91f3b843b07c3f"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an invalid functor. <a href="classsigc_1_1pointer__functor1.html#a6ce467c0641f8e3e0d91f3b843b07c3f">More...</a><br /></td></tr>
80 <tr class="separator:a6ce467c0641f8e3e0d91f3b843b07c3f"><td class="memSeparator" colspan="2"> </td></tr>
81 <tr class="memitem:a8ab0c5b707dc41a821c63769344db2cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor1.html#a8ab0c5b707dc41a821c63769344db2cb">pointer_functor1</a> (function_type _A_func)</td></tr>
82 <tr class="memdesc:a8ab0c5b707dc41a821c63769344db2cb"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1pointer__functor1.html" title="pointer_functor1 wraps existing non-member functions with 1 argument(s).">pointer_functor1</a> object that wraps an existing function. <a href="classsigc_1_1pointer__functor1.html#a8ab0c5b707dc41a821c63769344db2cb">More...</a><br /></td></tr>
83 <tr class="separator:a8ab0c5b707dc41a821c63769344db2cb"><td class="memSeparator" colspan="2"> </td></tr>
84 <tr class="memitem:a3c978e35c107326078f3e33afcdd1235"><td class="memItemLeft" align="right" valign="top">T_return </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor1.html#a3c978e35c107326078f3e33afcdd1235">operator()</a> (<a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>< T_arg1 > _A_a1) const</td></tr>
85 <tr class="memdesc:a3c978e35c107326078f3e33afcdd1235"><td class="mdescLeft"> </td><td class="mdescRight">Execute the wrapped function. <a href="classsigc_1_1pointer__functor1.html#a3c978e35c107326078f3e33afcdd1235">More...</a><br /></td></tr>
86 <tr class="separator:a3c978e35c107326078f3e33afcdd1235"><td class="memSeparator" colspan="2"> </td></tr>
87 </table><table class="memberdecls">
88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
89 Protected Attributes</h2></td></tr>
90 <tr class="memitem:a864ab55240be5287faf07c341ae9501e"><td class="memItemLeft" align="right" valign="top">function_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor1.html#a864ab55240be5287faf07c341ae9501e">func_ptr_</a></td></tr>
91 <tr class="separator:a864ab55240be5287faf07c341ae9501e"><td class="memSeparator" colspan="2"> </td></tr>
93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
94 <div class="textblock"><h3>template<class T_arg1, class T_return><br />
95 class sigc::pointer_functor1< T_arg1, T_return ></h3>
97 <p><a class="el" href="classsigc_1_1pointer__functor1.html" title="pointer_functor1 wraps existing non-member functions with 1 argument(s).">pointer_functor1</a> wraps existing non-member functions with 1 argument(s). </p>
98 <p>Use the convenience function <a class="el" href="group__ptr__fun.html#ga9c80de72f656fb05e81fda622dddc863" title="Creates a functor of type sigc::pointer_functor0 which wraps an existing non-member function.">ptr_fun()</a> to create an instance of <a class="el" href="classsigc_1_1pointer__functor1.html" title="pointer_functor1 wraps existing non-member functions with 1 argument(s).">pointer_functor1</a>.</p>
99 <p>The following template arguments are used:</p><ul>
100 <li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor1.html#a3c978e35c107326078f3e33afcdd1235" title="Execute the wrapped function.">operator()()</a>.</li>
101 <li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1pointer__functor1.html#a3c978e35c107326078f3e33afcdd1235" title="Execute the wrapped function.">operator()()</a>. </li>
103 </div><h2 class="groupheader">Member Typedef Documentation</h2>
104 <a id="a4080910d23a74b102a123838fa93e90b"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#a4080910d23a74b102a123838fa93e90b">◆ </a></span>result_type</h2>
107 <div class="memitem">
108 <div class="memproto">
109 <div class="memtemplate">
110 template <class T_arg1 , class T_return > </div>
111 <table class="memname">
113 <td class="memname">typedef T_return <a class="el" href="classsigc_1_1pointer__functor1.html">sigc::pointer_functor1</a>< T_arg1, T_return >::<a class="el" href="classsigc_1_1pointer__functor1.html#a4080910d23a74b102a123838fa93e90b">result_type</a></td>
116 </div><div class="memdoc">
120 <h2 class="groupheader">Constructor & Destructor Documentation</h2>
121 <a id="a6ce467c0641f8e3e0d91f3b843b07c3f"></a>
122 <h2 class="memtitle"><span class="permalink"><a href="#a6ce467c0641f8e3e0d91f3b843b07c3f">◆ </a></span>pointer_functor1() <span class="overload">[1/2]</span></h2>
124 <div class="memitem">
125 <div class="memproto">
126 <div class="memtemplate">
127 template <class T_arg1 , class T_return > </div>
128 <table class="mlabels">
130 <td class="mlabels-left">
131 <table class="memname">
133 <td class="memname"><a class="el" href="classsigc_1_1pointer__functor1.html">sigc::pointer_functor1</a>< T_arg1, T_return >::<a class="el" href="classsigc_1_1pointer__functor1.html">pointer_functor1</a> </td>
135 <td class="paramname"></td><td>)</td>
140 <td class="mlabels-right">
141 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
144 </div><div class="memdoc">
146 <p>Constructs an invalid functor. </p>
150 <a id="a8ab0c5b707dc41a821c63769344db2cb"></a>
151 <h2 class="memtitle"><span class="permalink"><a href="#a8ab0c5b707dc41a821c63769344db2cb">◆ </a></span>pointer_functor1() <span class="overload">[2/2]</span></h2>
153 <div class="memitem">
154 <div class="memproto">
155 <div class="memtemplate">
156 template <class T_arg1 , class T_return > </div>
157 <table class="mlabels">
159 <td class="mlabels-left">
160 <table class="memname">
162 <td class="memname"><a class="el" href="classsigc_1_1pointer__functor1.html">sigc::pointer_functor1</a>< T_arg1, T_return >::<a class="el" href="classsigc_1_1pointer__functor1.html">pointer_functor1</a> </td>
164 <td class="paramtype">function_type </td>
165 <td class="paramname"><em>_A_func</em></td><td>)</td>
170 <td class="mlabels-right">
171 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
174 </div><div class="memdoc">
176 <p>Constructs a <a class="el" href="classsigc_1_1pointer__functor1.html" title="pointer_functor1 wraps existing non-member functions with 1 argument(s).">pointer_functor1</a> object that wraps an existing function. </p>
177 <dl class="params"><dt>Parameters</dt><dd>
178 <table class="params">
179 <tr><td class="paramname">_A_func</td><td>Pointer to function that will be invoked from <a class="el" href="classsigc_1_1pointer__functor1.html#a3c978e35c107326078f3e33afcdd1235" title="Execute the wrapped function.">operator()()</a>. </td></tr>
186 <h2 class="groupheader">Member Function Documentation</h2>
187 <a id="a3c978e35c107326078f3e33afcdd1235"></a>
188 <h2 class="memtitle"><span class="permalink"><a href="#a3c978e35c107326078f3e33afcdd1235">◆ </a></span>operator()()</h2>
190 <div class="memitem">
191 <div class="memproto">
192 <div class="memtemplate">
193 template <class T_arg1 , class T_return > </div>
194 <table class="mlabels">
196 <td class="mlabels-left">
197 <table class="memname">
199 <td class="memname">T_return <a class="el" href="classsigc_1_1pointer__functor1.html">sigc::pointer_functor1</a>< T_arg1, T_return >::operator() </td>
201 <td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>< T_arg1 > </td>
202 <td class="paramname"><em>_A_a1</em></td><td>)</td>
207 <td class="mlabels-right">
208 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
211 </div><div class="memdoc">
213 <p>Execute the wrapped function. </p>
214 <dl class="params"><dt>Parameters</dt><dd>
215 <table class="params">
216 <tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the function. </td></tr>
220 <dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
224 <h2 class="groupheader">Member Data Documentation</h2>
225 <a id="a864ab55240be5287faf07c341ae9501e"></a>
226 <h2 class="memtitle"><span class="permalink"><a href="#a864ab55240be5287faf07c341ae9501e">◆ </a></span>func_ptr_</h2>
228 <div class="memitem">
229 <div class="memproto">
230 <div class="memtemplate">
231 template <class T_arg1 , class T_return > </div>
232 <table class="mlabels">
234 <td class="mlabels-left">
235 <table class="memname">
237 <td class="memname">function_type <a class="el" href="classsigc_1_1pointer__functor1.html">sigc::pointer_functor1</a>< T_arg1, T_return >::func_ptr_</td>
241 <td class="mlabels-right">
242 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
245 </div><div class="memdoc">
249 </div><!-- contents -->
250 <!-- start footer part -->
251 <hr class="footer"/><address class="footer"><small>
252 Generated on Fri Feb 11 2022 15:40:58 for libsigc++ by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1