libsigcplusplus/docs/reference/html/classsigc_1_1pointer__funct...

266 lines
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libsigc++: sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libsigc++
&#160;<span id="projectnumber">2.10.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1pointer__functor2.html">pointer_functor2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsigc_1_1pointer__functor2-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a> &raquo; <a class="el" href="group__ptr__fun.html">ptr_fun()</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s). ">pointer_functor2</a> wraps existing non-member functions with 2 argument(s).
<a href="classsigc_1_1pointer__functor2.html#details">More...</a></p>
<p><code>#include &lt;sigc++/functors/ptr_fun.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classsigc_1_1pointer__functor2__inherit__graph.png" border="0" usemap="#sigc_1_1pointer__functor2_3_01T__arg1_00_01T__arg2_00_01T__return_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="sigc_1_1pointer__functor2_3_01T__arg1_00_01T__arg2_00_01T__return_01_4_inherit__map" id="sigc_1_1pointer__functor2_3_01T__arg1_00_01T__arg2_00_01T__return_01_4_inherit__map">
<area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="41,5,181,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a297b784eb0cea07b364c854e5dd5f864"><td class="memItemLeft" align="right" valign="top">typedef T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a297b784eb0cea07b364c854e5dd5f864">result_type</a></td></tr>
<tr class="separator:a297b784eb0cea07b364c854e5dd5f864"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2977aa1d72f5f0fd6c778b60ad791b9c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a2977aa1d72f5f0fd6c778b60ad791b9c">pointer_functor2</a> ()</td></tr>
<tr class="memdesc:a2977aa1d72f5f0fd6c778b60ad791b9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid functor. <a href="#a2977aa1d72f5f0fd6c778b60ad791b9c">More...</a><br /></td></tr>
<tr class="separator:a2977aa1d72f5f0fd6c778b60ad791b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a428226381ff7bda06044c8fa53d4e27e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a428226381ff7bda06044c8fa53d4e27e">pointer_functor2</a> (function_type _A_func)</td></tr>
<tr class="memdesc:a428226381ff7bda06044c8fa53d4e27e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s). ">pointer_functor2</a> object that wraps an existing function. <a href="#a428226381ff7bda06044c8fa53d4e27e">More...</a><br /></td></tr>
<tr class="separator:a428226381ff7bda06044c8fa53d4e27e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afedc108e4407385fb70e9d1b2ee8282e"><td class="memItemLeft" align="right" valign="top">T_return&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#afedc108e4407385fb70e9d1b2ee8282e">operator()</a> (<a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt; _A_a1, <a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg2 &gt; _A_a2) const </td></tr>
<tr class="memdesc:afedc108e4407385fb70e9d1b2ee8282e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the wrapped function. <a href="#afedc108e4407385fb70e9d1b2ee8282e">More...</a><br /></td></tr>
<tr class="separator:afedc108e4407385fb70e9d1b2ee8282e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a340680ba8ae5ea67eb0afe33d118c82b"><td class="memItemLeft" align="right" valign="top">function_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor2.html#a340680ba8ae5ea67eb0afe33d118c82b">func_ptr_</a></td></tr>
<tr class="separator:a340680ba8ae5ea67eb0afe33d118c82b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T_arg1, class T_arg2, class T_return&gt;<br />
class sigc::pointer_functor2&lt; T_arg1, T_arg2, T_return &gt;</h3>
<p><a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s). ">pointer_functor2</a> wraps existing non-member functions with 2 argument(s). </p>
<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__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s). ">pointer_functor2</a>.</p>
<p>The following template arguments are used:</p><ul>
<li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor2.html#afedc108e4407385fb70e9d1b2ee8282e" title="Execute the wrapped function. ">operator()()</a>.</li>
<li><em>T_arg2</em> Argument type used in the definition of <a class="el" href="classsigc_1_1pointer__functor2.html#afedc108e4407385fb70e9d1b2ee8282e" title="Execute the wrapped function. ">operator()()</a>.</li>
<li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1pointer__functor2.html#afedc108e4407385fb70e9d1b2ee8282e" title="Execute the wrapped function. ">operator()()</a>. </li>
</ul>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a297b784eb0cea07b364c854e5dd5f864"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef T_return <a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor2.html#a297b784eb0cea07b364c854e5dd5f864">result_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2977aa1d72f5f0fd6c778b60ad791b9c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor2.html">pointer_functor2</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an invalid functor. </p>
</div>
</div>
<a class="anchor" id="a428226381ff7bda06044c8fa53d4e27e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::<a class="el" href="classsigc_1_1pointer__functor2.html">pointer_functor2</a> </td>
<td>(</td>
<td class="paramtype">function_type&#160;</td>
<td class="paramname"><em>_A_func</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="classsigc_1_1pointer__functor2.html" title="pointer_functor2 wraps existing non-member functions with 2 argument(s). ">pointer_functor2</a> object that wraps an existing function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_A_func</td><td>Pointer to function that will be invoked from <a class="el" href="classsigc_1_1pointer__functor2.html#afedc108e4407385fb70e9d1b2ee8282e" title="Execute the wrapped function. ">operator()()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afedc108e4407385fb70e9d1b2ee8282e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T_return <a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg1 &gt;&#160;</td>
<td class="paramname"><em>_A_a1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacesigc.html#aa0d56c61023af35c47b79db80b32fd2e">type_trait_take_t</a>&lt; T_arg2 &gt;&#160;</td>
<td class="paramname"><em>_A_a2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute the wrapped function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the function. </td></tr>
<tr><td class="paramname">_A_a2</td><td>Argument to be passed on to the function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The return value of the function invocation. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a340680ba8ae5ea67eb0afe33d118c82b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_arg1 , class T_arg2 , class T_return &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">function_type <a class="el" href="classsigc_1_1pointer__functor2.html">sigc::pointer_functor2</a>&lt; T_arg1, T_arg2, T_return &gt;::func_ptr_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 25 2020 10:13:29 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>