docs/reference/html/group__track__obj.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++: track_obj()</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><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Classes</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">track_obj()<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p><a class="el" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1" title="Creates an adaptor of type sigc::track_obj_functor which wraps a functor. ">sigc::track_obj()</a> tracks trackable objects, referenced from a functor.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  54 Classes</h2></td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1track__obj__functor.html">sigc::track_obj_functor&lt; T_functor, T_obj &gt;</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classsigc_1_1track__obj__functor.html" title="track_obj_functor wraps a functor and stores a reference to a trackable object. ">track_obj_functor</a> wraps a functor and stores a reference to a trackable object.  <a href="classsigc_1_1track__obj__functor.html#details">More...</a><br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 </table><table class="memberdecls">
  59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  60 Functions</h2></td></tr>
  61 <tr class="memitem:ga2d8c46509a25df9c7ad37b8712d16ab1"><td class="memTemplParams" colspan="2">template&lt;typename T_functor , typename... T_obj&gt; </td></tr>
  62 <tr class="memitem:ga2d8c46509a25df9c7ad37b8712d16ab1"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1">sigc::track_obj</a> (const T_functor&amp; _A_func, const T_obj&amp;..._A_obj)</td></tr>
  63 <tr class="memdesc:ga2d8c46509a25df9c7ad37b8712d16ab1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="classsigc_1_1track__obj__functor.html" title="track_obj_functor wraps a functor and stores a reference to a trackable object. ">sigc::track_obj_functor</a> which wraps a functor.  <a href="#ga2d8c46509a25df9c7ad37b8712d16ab1">More...</a><br /></td></tr>
  64 <tr class="separator:ga2d8c46509a25df9c7ad37b8712d16ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table>
  66 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  67 <p><a class="el" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1" title="Creates an adaptor of type sigc::track_obj_functor which wraps a functor. ">sigc::track_obj()</a> tracks trackable objects, referenced from a functor. </p>
  68 <p>It can be useful when you assign a C++11 lambda expression or a std::function&lt;&gt; to a slot, or connect it to a signal, and the lambda expression or std::function&lt;&gt; contains references to <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection. ">sigc::trackable</a> derived objects.</p>
  69 <p>The functor returned by <a class="el" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1" title="Creates an adaptor of type sigc::track_obj_functor which wraps a functor. ">sigc::track_obj()</a> is formally an adaptor, but it does not alter the signature, return type or behaviour of the supplied functor. Up to 7 objects can be tracked. operator()() can have up to 7 arguments.</p>
  70 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keyword">struct </span>bar : <span class="keyword">public</span> <a class="code" href="structsigc_1_1trackable.html">sigc::trackable</a> {};</div>
  71 <div class="line"><a class="code" href="classsigc_1_1signal.html">sigc::signal&lt;void()&gt;</a> some_signal;</div>
  72 <div class="line"><span class="keywordtype">void</span> foo(bar&amp;);</div>
  73 <div class="line">{</div>
  74 <div class="line">  bar some_bar;</div>
  75 <div class="line">  some_signal.connect([&amp;some_bar](){ foo(some_bar); });</div>
  76 <div class="line">    <span class="comment">// NOT disconnected automatically when some_bar goes out of scope</span></div>
  77 <div class="line">  some_signal.connect(<a class="code" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1">sigc::track_obj</a>([&amp;some_bar](){ foo(some_bar); }, some_bar);</div>
  78 <div class="line">    <span class="comment">// disconnected automatically when some_bar goes out of scope</span></div>
  79 <div class="line">}</div>
  80 </div><!-- fragment --></dd></dl>
  81 <dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000006">Since libsigc++ 2.4:</a></b></dt><dd></dd></dl>
  82 <h2 class="groupheader">Function Documentation</h2>
  83 <a class="anchor" id="ga2d8c46509a25df9c7ad37b8712d16ab1"></a>
  84 <div class="memitem">
  85 <div class="memproto">
  86 <div class="memtemplate">
  87 template &lt;typename T_functor , typename... T_obj&gt; </div>
  88 <table class="mlabels">
  89   <tr>
  90   <td class="mlabels-left">
  91       <table class="memname">
  92         <tr>
  93           <td class="memname">decltype(auto) sigc::track_obj </td>
  94           <td>(</td>
  95           <td class="paramtype">const T_functor &amp;&#160;</td>
  96           <td class="paramname"><em>_A_func</em>, </td>
  97         </tr>
  98         <tr>
  99           <td class="paramkey"></td>
 100           <td></td>
 101           <td class="paramtype">const T_obj &amp;...&#160;</td>
 102           <td class="paramname"><em>_A_obj</em>&#160;</td>
 103         </tr>
 104         <tr>
 105           <td></td>
 106           <td>)</td>
 107           <td></td><td></td>
 108         </tr>
 109       </table>
 110   </td>
 111   <td class="mlabels-right">
 112 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 113   </tr>
 114 </table>
 115 </div><div class="memdoc">
 116
 117 <p>Creates an adaptor of type <a class="el" href="classsigc_1_1track__obj__functor.html" title="track_obj_functor wraps a functor and stores a reference to a trackable object. ">sigc::track_obj_functor</a> which wraps a functor. </p>
 118 <dl class="params"><dt>Parameters</dt><dd>
 119   <table class="params">
 120     <tr><td class="paramname">_A_func</td><td>Functor that shall be wrapped. </td></tr>
 121     <tr><td class="paramname">_A_obj</td><td>Trackable objects. </td></tr>
 122   </table>
 123   </dd>
 124 </dl>
 125 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes _A_func() on invocation.</dd></dl>
 126 <dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000008">Since libsigc++ 2.4:</a></b></dt><dd></dd></dl>
 127
 128 </div>
 129 </div>
 130 </div><!-- contents -->
 131 <!-- start footer part -->
 132 <hr class="footer"/><address class="footer"><small>
 133 Generated on Wed Mar 16 2016 20:53:27 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 134 <img class="footer" src="doxygen.png" alt="doxygen"/>
 135 </a> 1.8.9.1
 136 </small></address>
 137 </body>
 138 </html>