openkylin
/
libsigcplusplus
mirror of https://gitee.com/openkylin/libsigcplusplus.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libsigcplusplus/docs/reference/html/structsigc_1_1adapts.html

221 lines
20 KiB
HTML
Raw Blame History

<!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::adapts&lt; T_functor &gt; Struct 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="structsigc_1_1adapts.html">adapts</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="#pub-attribs">Public Attributes</a> &#124;
<a href="structsigc_1_1adapts-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sigc::adapts&lt; T_functor &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Base type for adaptors.
<a href="structsigc_1_1adapts.html#details">More...</a></p>
<p><code>#include &lt;sigc++/adaptors/adaptor_trait.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sigc::adapts&lt; T_functor &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structsigc_1_1adapts__inherit__graph.png" border="0" usemap="#sigc_1_1adapts_3_01T__functor_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="sigc_1_1adapts_3_01T__functor_01_4_inherit__map" id="sigc_1_1adapts_3_01T__functor_01_4_inherit__map">
<area shape="rect" id="node4" href="structsigc_1_1bind__functor_3_010_00_01T__functor_00_01T__bound_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Adaptor that binds an argument to the wrapped functor. " alt="" coords="635,5,816,61"/>
<area shape="rect" id="node5" href="structsigc_1_1bind__functor_3-1_00_01T__functor_00_01T__type1_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Adaptor that binds 1 argument(s) to the wrapped functor. " alt="" coords="636,85,815,141"/>
<area shape="rect" id="node6" href="structsigc_1_1bind__return__functor.html" title="Adaptor that fixes the return value of the wrapped functor. " alt="" coords="634,166,817,207"/>
<area shape="rect" id="node7" href="structsigc_1_1exception__catch__functor.html" title="sigc::exception_catch\l_functor\&lt; T_functor \&gt;" alt="" coords="642,231,809,273"/>
<area shape="rect" id="node8" href="structsigc_1_1exception__catch__functor_3_01T__functor_00_01T__catcher_00_01void_01_4.html" title="sigc::exception_catch\l_functor\&lt; T_functor,\l T_catcher, void \&gt;" alt="" coords="644,297,807,353"/>
<area shape="rect" id="node9" href="structsigc_1_1hide__functor_3_010_00_01T__functor_01_4.html" title="Adaptor that adds a dummy parameter to the wrapped functor. " alt="" coords="657,378,794,419"/>
<area shape="rect" id="node10" href="structsigc_1_1hide__functor_3-1_00_01T__functor_01_4.html" title="Adaptor that adds a dummy parameter to the wrapped functor. " alt="" coords="657,443,794,485"/>
<area shape="rect" id="node11" href="structsigc_1_1retype__functor.html" title="Adaptor that performs C&#45;style casts on the parameters passed on to the functor. " alt="" coords="650,509,801,550"/>
<area shape="rect" id="node12" href="structsigc_1_1retype__return__functor.html" title="Adaptor that performs a C&#45;style cast on the return value of a functor. " alt="" coords="642,574,809,615"/>
<area shape="rect" id="node13" href="structsigc_1_1retype__return__functor_3_01void_00_01T__functor_01_4.html" title="Adaptor that performs a C&#45;style cast on the return value of a functor. " alt="" coords="624,639,827,681"/>
<area shape="rect" id="node14" href="classsigc_1_1track__obj__functor1.html" title="track_obj_functor1 wraps a functor and stores a reference to a trackable object. " alt="" coords="637,705,814,746"/>
<area shape="rect" id="node2" href="structsigc_1_1adaptor__base.html" title="A hint to the compiler. " alt="" coords="193,385,337,412"/>
<area shape="rect" id="node3" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="5,385,145,412"/>
<area shape="rect" id="node15" href="classsigc_1_1track__obj__functor2.html" title="track_obj_functor2 wraps a functor and stores 2 references to trackable objects. " alt="" coords="875,541,1052,582"/>
<area shape="rect" id="node16" href="classsigc_1_1track__obj__functor3.html" title="track_obj_functor3 wraps a functor and stores 3 references to trackable objects. " alt="" coords="875,606,1052,647"/>
<area shape="rect" id="node17" href="classsigc_1_1track__obj__functor4.html" title="track_obj_functor4 wraps a functor and stores 4 references to trackable objects. " alt="" coords="875,671,1052,713"/>
<area shape="rect" id="node18" href="classsigc_1_1track__obj__functor5.html" title="track_obj_functor5 wraps a functor and stores 5 references to trackable objects. " alt="" coords="875,737,1052,778"/>
<area shape="rect" id="node19" href="classsigc_1_1track__obj__functor6.html" title="track_obj_functor6 wraps a functor and stores 6 references to trackable objects. " alt="" coords="875,802,1052,843"/>
<area shape="rect" id="node20" href="classsigc_1_1track__obj__functor7.html" title="track_obj_functor7 wraps a functor and stores 7 references to trackable objects. " alt="" coords="875,867,1052,909"/>
</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:a5c3f3b614455552f4cd5d88b1f330248"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a5c3f3b614455552f4cd5d88b1f330248">adaptor_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a5c3f3b614455552f4cd5d88b1f330248">adaptor_type</a></td></tr>
<tr class="separator:a5c3f3b614455552f4cd5d88b1f330248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a914e75556dae1fdcf0162c4c99aca79d"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a914e75556dae1fdcf0162c4c99aca79d">result_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a914e75556dae1fdcf0162c4c99aca79d">result_type</a></td></tr>
<tr class="separator:a914e75556dae1fdcf0162c4c99aca79d"><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:a947b69ccbdcabd4ef4163dcab96096f8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a947b69ccbdcabd4ef4163dcab96096f8">adapts</a> (const T_functor&amp; _A_functor)</td></tr>
<tr class="memdesc:a947b69ccbdcabd4ef4163dcab96096f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an adaptor that wraps the passed functor. <a href="#a947b69ccbdcabd4ef4163dcab96096f8">More...</a><br /></td></tr>
<tr class="separator:a947b69ccbdcabd4ef4163dcab96096f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2f4b37eb160708baf17de57f2abce7a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1adapts.html#a5c3f3b614455552f4cd5d88b1f330248">adaptor_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a2f4b37eb160708baf17de57f2abce7a7">functor_</a></td></tr>
<tr class="memdesc:a2f4b37eb160708baf17de57f2abce7a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adaptor that is invoked from operator()(). <a href="#a2f4b37eb160708baf17de57f2abce7a7">More...</a><br /></td></tr>
<tr class="separator:a2f4b37eb160708baf17de57f2abce7a7"><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_functor&gt;<br />
struct sigc::adapts&lt; T_functor &gt;</h3>
<p>Base type for adaptors. </p>
<p><a class="el" href="structsigc_1_1adapts.html" title="Base type for adaptors. ">sigc::adapts</a> wraps adaptors, functors, function pointers and class methods. It contains a single member functor which is always a <a class="el" href="structsigc_1_1adaptor__base.html" title="A hint to the compiler. ">sigc::adaptor_base</a>. The typedef adaptor_type defines the exact type that is used to store the adaptor, functor, function pointer or class method passed into the constructor. It differs from <em>T_functor</em> unless <em>T_functor</em> inherits from <a class="el" href="structsigc_1_1adaptor__base.html" title="A hint to the compiler. ">sigc::adaptor_base</a>.</p>
<dl class="section user"><dt>Example of a simple adaptor:</dt><dd><div class="fragment"><div class="line"><span class="keyword">namespace </span>my_ns</div><div class="line">{</div><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">class</span> T_functor&gt;</div><div class="line"><span class="keyword">struct </span>my_adaptor : <span class="keyword">public</span> <a class="code" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt;T_functor&gt;</div><div class="line">{</div><div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">class</span> T_arg1=<span class="keywordtype">void</span>, <span class="keyword">class</span> T_arg2=<span class="keywordtype">void</span>&gt;</div><div class="line"> <span class="keyword">struct </span>deduce_result_type</div><div class="line"> { <span class="keyword">typedef</span> <a class="code" href="namespacesigc.html#ab7791439fb79592300826fe076a8e3d1">sigc::deduce_result_t&lt;T_functor, T_arg1, T_arg2&gt;</a> type; };</div><div class="line"> <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="structsigc_1_1functor__trait.html#af1324bf0d3cec3d1f2e39e932b228d6d">sigc::functor_trait&lt;T_functor&gt;::result_type</a> <a class="code" href="structsigc_1_1adapts.html#a914e75556dae1fdcf0162c4c99aca79d">result_type</a>;</div><div class="line"> <span class="comment">//</span></div><div class="line"> result_type</div><div class="line"> operator()() <span class="keyword">const</span>;</div><div class="line"> <span class="comment">//</span></div><div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">class</span> T_arg1&gt;</div><div class="line"> <span class="keyword">typename</span> <a class="code" href="structsigc_1_1deduce__result__type.html#a529a6b7809ea3ad1a2d4392b9ffcec42">deduce_result_type&lt;T_arg1&gt;::type</a></div><div class="line"> operator()(T_arg1 _A_arg1) <span class="keyword">const</span>;</div><div class="line"> <span class="comment">//</span></div><div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">class</span> T_arg1, <span class="keyword">class</span> T_arg2&gt;</div><div class="line"> <span class="keyword">typename</span> <a class="code" href="structsigc_1_1deduce__result__type.html#a529a6b7809ea3ad1a2d4392b9ffcec42">deduce_result_type&lt;T_arg1, T_arg2&gt;::type</a></div><div class="line"> operator()(T_arg1 _A_arg1, T_arg2 _A_arg2) <span class="keyword">const</span>;</div><div class="line"> <span class="comment">//</span></div><div class="line"> <span class="comment">// Constructs a my_adaptor object that wraps the passed functor.</span></div><div class="line"> <span class="comment">// Initializes adapts&lt;T_functor&gt;::functor_, which is invoked from operator()().</span></div><div class="line"> <span class="keyword">explicit</span> my_adaptor(<span class="keyword">const</span> T_functor&amp; _A_functor)</div><div class="line"> : <a class="code" href="namespacesigc.html">sigc</a>::<a class="code" href="structsigc_1_1adapts.html#a947b69ccbdcabd4ef4163dcab96096f8">adapts</a>&lt;T_functor&gt;(_A_functor) {}</div><div class="line">};</div><div class="line">} <span class="comment">// end namespace my_ns</span></div><div class="line"><span class="comment">//</span></div><div class="line"><span class="comment">// Specialization of sigc::visitor for my_adaptor.</span></div><div class="line"><span class="keyword">namespace </span><a class="code" href="namespacesigc.html">sigc</a></div><div class="line">{</div><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">class</span> T_functor&gt;</div><div class="line"><span class="keyword">struct </span>visitor&lt;my_ns::my_adaptor&lt;T_functor&gt; &gt;</div><div class="line">{</div><div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">class</span> T_action&gt;</div><div class="line"> <span class="keyword">static</span> <span class="keywordtype">void</span> do_visit_each(<span class="keyword">const</span> T_action&amp; _A_action,</div><div class="line"> <span class="keyword">const</span> my_ns::my_adaptor&lt;T_functor&gt;&amp; _A_target)</div><div class="line"> {</div><div class="line"> <a class="code" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404">sigc::visit_each</a>(_A_action, _A_target.functor_);</div><div class="line"> }</div><div class="line">};</div><div class="line">} <span class="comment">// end namespace sigc</span></div></div><!-- fragment --></dd></dl>
<p>If you implement your own adaptor, you must also provide your specialization of sigc::visitor&lt;&gt;::do_visit_each&lt;&gt;() that will forward the call to the functor(s) your adapter is wrapping. Otherwise, pointers stored within the functor won't be invalidated when a <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection. ">sigc::trackable</a> object is destroyed and you can end up executing callbacks on destroyed objects.</p>
<p>Your specialization of sigc::visitor&lt;&gt; must be in namespace sigc. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a5c3f3b614455552f4cd5d88b1f330248"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_functor&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt;T_functor&gt;::<a class="el" href="structsigc_1_1adapts.html#a5c3f3b614455552f4cd5d88b1f330248">adaptor_type</a> <a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a5c3f3b614455552f4cd5d88b1f330248">adaptor_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a914e75556dae1fdcf0162c4c99aca79d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_functor&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt;T_functor&gt;::<a class="el" href="structsigc_1_1adapts.html#a914e75556dae1fdcf0162c4c99aca79d">result_type</a> <a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a914e75556dae1fdcf0162c4c99aca79d">result_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a947b69ccbdcabd4ef4163dcab96096f8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_functor&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html">adapts</a> </td>
<td>(</td>
<td class="paramtype">const T_functor &amp;&#160;</td>
<td class="paramname"><em>_A_functor</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 an adaptor that wraps the passed functor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_A_functor</td><td>Functor to invoke from operator()(). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a2f4b37eb160708baf17de57f2abce7a7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T_functor&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsigc_1_1adapts.html#a5c3f3b614455552f4cd5d88b1f330248">adaptor_type</a> <a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::functor_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adaptor that is invoked from operator()(). </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 25 2020 10:13:28 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>
Reference in New Issue View Git Blame Copy Permalink