docs/reference/html/structsigc_1_1adapts.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::adapts&lt; T_functor &gt; Struct 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="structsigc_1_1adapts.html">adapts</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="structsigc_1_1adapts-members.html">List of all members</a>  </div>
  59   <div class="headertitle">
  60 <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>
  61 </div><!--header-->
  62 <div class="contents">
  63
  64 <p>Base type for adaptors.
  65  <a href="structsigc_1_1adapts.html#details">More...</a></p>
  66
  67 <p><code>#include &lt;sigc++/adaptors/adaptor_trait.h&gt;</code></p>
  68 <div class="dynheader">
  69 Inheritance diagram for sigc::adapts&lt; T_functor &gt;:</div>
  70 <div class="dyncontent">
  71 <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>
  72 <map name="sigc_1_1adapts_3_01T__functor_01_4_inherit__map" id="sigc_1_1adapts_3_01T__functor_01_4_inherit__map">
  73 <area shape="rect" id="node4" href="structsigc_1_1bind__functor.html" title="Adaptor that binds arguments to the wrapped functor. " alt="" coords="650,5,785,47"/><area shape="rect" id="node5" href="structsigc_1_1bind__functor_3-1_00_01T__functor_00_01T__type_8_8_8_4.html" title="Adaptor that binds argument(s) to the wrapped functor. " alt="" coords="624,71,811,112"/><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="627,136,807,177"/><area shape="rect" id="node7" href="structsigc_1_1exception__catch__functor.html" title="sigc::exception_catch\l_functor\&lt; T_functor \&gt;" alt="" coords="636,201,799,243"/><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="638,266,797,322"/><area shape="rect" id="node9" href="structsigc_1_1hide__functor.html" title="Adaptor that adds a dummy parameter to the wrapped functor. " alt="" coords="650,345,785,387"/><area shape="rect" id="node10" href="structsigc_1_1retype__functor.html" title="Adaptor that performs C&#45;style casts on the parameters passed on to the functor. " alt="" coords="643,411,791,452"/><area shape="rect" id="node11" 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="636,476,799,517"/><area shape="rect" id="node12" 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="619,541,816,583"/><area shape="rect" id="node13" href="classsigc_1_1track__obj__functor.html" title="track_obj_functor wraps a functor and stores a reference to a trackable object. " alt="" coords="635,607,800,648"/><area shape="rect" id="node2" href="structsigc_1_1adaptor__base.html" title="A hint to the compiler. " alt="" coords="192,317,335,343"/><area shape="rect" id="node3" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="5,317,144,343"/></map>
  74 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  75 <table class="memberdecls">
  76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  77 Public Types</h2></td></tr>
  78 <tr class="memitem:a944f414e6d1a98cf42aa48e82b52a079"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a> = typename <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a></td></tr>
  79 <tr class="separator:a944f414e6d1a98cf42aa48e82b52a079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a4514810fc2ec4e274748d8970a7052e2"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a> = typename <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a></td></tr>
  81 <tr class="separator:a4514810fc2ec4e274748d8970a7052e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 </table><table class="memberdecls">
  83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  84 Public Member Functions</h2></td></tr>
  85 <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>
  86 <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>
  87 <tr class="separator:a947b69ccbdcabd4ef4163dcab96096f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 </table><table class="memberdecls">
  89 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  90 Public Attributes</h2></td></tr>
  91 <tr class="memitem:a2f4b37eb160708baf17de57f2abce7a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html#a2f4b37eb160708baf17de57f2abce7a7">functor_</a></td></tr>
  92 <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>
  93 <tr class="separator:a2f4b37eb160708baf17de57f2abce7a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 </table>
  95 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  96 <div class="textblock"><h3>template&lt;class T_functor&gt;<br />
  97 struct sigc::adapts&lt; T_functor &gt;</h3>
  98
  99 <p>Base type for adaptors. </p>
 100 <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 adaptor_type alias 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>
 101 <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>
 102 <div class="line">{</div>
 103 <div class="line"><span class="keyword">template</span> &lt;<span class="keyword">class</span> T_functor&gt;</div>
 104 <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>
 105 <div class="line">{</div>
 106 <div class="line">  <span class="keyword">using</span> <a class="code" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a> = <span class="keyword">typename</span> <a class="code" href="structsigc_1_1functor__trait.html#a8fdb1c2faa79642fea821ab1052dfd40">sigc::functor_trait&lt;T_functor&gt;::result_type</a>;</div>
 107 <div class="line">  <span class="comment">//</span></div>
 108 <div class="line">  <a class="code" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a></div>
 109 <div class="line">  operator()() <span class="keyword">const</span>;</div>
 110 <div class="line">  <span class="comment">//</span></div>
 111 <div class="line">  <span class="keyword">template</span> &lt;<span class="keyword">class</span> T_arg1&gt;</div>
 112 <div class="line">  decltype(<span class="keyword">auto</span>)</div>
 113 <div class="line">  operator()(T_arg1 _A_arg1) const;</div>
 114 <div class="line">  <span class="comment">//</span></div>
 115 <div class="line">  template &lt;class T_arg1, class T_arg2&gt;</div>
 116 <div class="line">  decltype(auto)</div>
 117 <div class="line">  operator()(T_arg1 _A_arg1, T_arg2 _A_arg2) const;</div>
 118 <div class="line">  <span class="comment">//</span></div>
 119 <div class="line">  <span class="comment">// Constructs a my_adaptor object that wraps the passed functor.</span></div>
 120 <div class="line">  <span class="comment">// Initializes adapts&lt;T_functor&gt;::functor_, which is invoked from operator()().</span></div>
 121 <div class="line">  explicit my_adaptor(const T_functor&amp; _A_functor)</div>
 122 <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>
 123 <div class="line">};</div>
 124 <div class="line">} <span class="comment">// end namespace my_ns</span></div>
 125 <div class="line"><span class="comment">//</span></div>
 126 <div class="line"><span class="comment">// Specialization of sigc::visitor for my_adaptor.</span></div>
 127 <div class="line"><span class="keyword">namespace </span><a class="code" href="namespacesigc.html">sigc</a></div>
 128 <div class="line">{</div>
 129 <div class="line"><span class="keyword">template</span> &lt;<span class="keyword">class</span> T_functor&gt;</div>
 130 <div class="line"><span class="keyword">struct </span>visitor&lt;my_ns::my_adaptor&lt;T_functor&gt; &gt;</div>
 131 <div class="line">{</div>
 132 <div class="line">  <span class="keyword">template</span> &lt;<span class="keyword">class</span> T_action&gt;</div>
 133 <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>
 134 <div class="line">                            <span class="keyword">const</span> my_ns::my_adaptor&lt;T_functor&gt;&amp; _A_target)</div>
 135 <div class="line">  {</div>
 136 <div class="line">    <a class="code" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404">sigc::visit_each</a>(_A_action, _A_target.functor_);</div>
 137 <div class="line">  }</div>
 138 <div class="line">};</div>
 139 <div class="line">} <span class="comment">// end namespace sigc</span></div>
 140 </div><!-- fragment --></dd></dl>
 141 <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>
 142 <p>Your specialization of sigc::visitor&lt;&gt; must be in namespace sigc. </p>
 143 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 144 <a class="anchor" id="a944f414e6d1a98cf42aa48e82b52a079"></a>
 145 <div class="memitem">
 146 <div class="memproto">
 147 <div class="memtemplate">
 148 template &lt;class T_functor&gt; </div>
 149       <table class="memname">
 150         <tr>
 151           <td class="memname">using <a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a> =  typename <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt;T_functor&gt;::<a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a></td>
 152         </tr>
 153       </table>
 154 </div><div class="memdoc">
 155
 156 </div>
 157 </div>
 158 <a class="anchor" id="a4514810fc2ec4e274748d8970a7052e2"></a>
 159 <div class="memitem">
 160 <div class="memproto">
 161 <div class="memtemplate">
 162 template &lt;class T_functor&gt; </div>
 163       <table class="memname">
 164         <tr>
 165           <td class="memname">using <a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::<a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a> =  typename <a class="el" href="structsigc_1_1adaptor__trait.html">adaptor_trait</a>&lt;T_functor&gt;::<a class="el" href="structsigc_1_1adapts.html#a4514810fc2ec4e274748d8970a7052e2">result_type</a></td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 </div>
 171 </div>
 172 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 173 <a class="anchor" id="a947b69ccbdcabd4ef4163dcab96096f8"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176 <div class="memtemplate">
 177 template &lt;class T_functor&gt; </div>
 178 <table class="mlabels">
 179   <tr>
 180   <td class="mlabels-left">
 181       <table class="memname">
 182         <tr>
 183           <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>
 184           <td>(</td>
 185           <td class="paramtype">const T_functor &amp;&#160;</td>
 186           <td class="paramname"><em>_A_functor</em></td><td>)</td>
 187           <td></td>
 188         </tr>
 189       </table>
 190   </td>
 191   <td class="mlabels-right">
 192 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 193   </tr>
 194 </table>
 195 </div><div class="memdoc">
 196
 197 <p>Constructs an adaptor that wraps the passed functor. </p>
 198 <dl class="params"><dt>Parameters</dt><dd>
 199   <table class="params">
 200     <tr><td class="paramname">_A_functor</td><td>Functor to invoke from operator()(). </td></tr>
 201   </table>
 202   </dd>
 203 </dl>
 204
 205 </div>
 206 </div>
 207 <h2 class="groupheader">Member Data Documentation</h2>
 208 <a class="anchor" id="a2f4b37eb160708baf17de57f2abce7a7"></a>
 209 <div class="memitem">
 210 <div class="memproto">
 211 <div class="memtemplate">
 212 template &lt;class T_functor&gt; </div>
 213 <table class="mlabels">
 214   <tr>
 215   <td class="mlabels-left">
 216       <table class="memname">
 217         <tr>
 218           <td class="memname"><a class="el" href="structsigc_1_1adapts.html#a944f414e6d1a98cf42aa48e82b52a079">adaptor_type</a> <a class="el" href="structsigc_1_1adapts.html">sigc::adapts</a>&lt; T_functor &gt;::functor_</td>
 219         </tr>
 220       </table>
 221   </td>
 222   <td class="mlabels-right">
 223 <span class="mlabels"><span class="mlabel">mutable</span></span>  </td>
 224   </tr>
 225 </table>
 226 </div><div class="memdoc">
 227
 228 <p>Adaptor that is invoked from operator()(). </p>
 229
 230 </div>
 231 </div>
 232 </div><!-- contents -->
 233 <!-- start footer part -->
 234 <hr class="footer"/><address class="footer"><small>
 235 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 236 <img class="footer" src="doxygen.png" alt="doxygen"/>
 237 </a> 1.8.9.1
 238 </small></address>
 239 </body>
 240 </html>