Sophie

Sophie

distrib > Mandriva > 2011.0 > x86_64 > by-pkgid > f30eb1b4d08ac51d6fa9ede1cab27d6b > files > 619

libsigc++2.0-doc-2.2.9-2.x86_64.rpm

<!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"/>
<title>libsigc++: sigc::trackable Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.2 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</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 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="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacesigc.html">sigc</a> </li>
      <li><a class="el" href="structsigc_1_1trackable.html">trackable</a> </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
  <div class="headertitle">
<h1>sigc::trackable Struct Reference<br/>
<small>
[<a class="el" href="group__signal.html">Signals</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="sigc::trackable" -->
<p>Base class for objects with auto-disconnection. <a href="#_details">More...</a></p>

<p><code>#include &lt;sigc++/trackable.h&gt;</code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for sigc::trackable:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="structsigc_1_1trackable__inherit__graph.png" border="0" usemap="#sigc_1_1trackable_inherit__map" alt="Inheritance graph"/></div>
<map name="sigc_1_1trackable_inherit__map" id="sigc_1_1trackable_inherit__map">
<area shape="rect" id="node3" href="structsigc_1_1signal__base.html" title="Base class for the sigc::signal# templates." alt="" coords="168,413,299,442"/><area shape="rect" id="node5" href="classsigc_1_1signal0.html" title="Signal declaration." alt="" coords="525,13,811,42"/><area shape="rect" id="node9" href="classsigc_1_1signal1.html" title="Signal declaration." alt="" coords="500,66,836,95"/><area shape="rect" id="node13" href="classsigc_1_1signal2.html" title="Signal declaration." alt="" coords="475,119,861,149"/><area shape="rect" id="node17" href="classsigc_1_1signal3.html" title="Signal declaration." alt="" coords="449,173,887,202"/><area shape="rect" id="node21" href="classsigc_1_1signal4.html" title="Signal declaration." alt="" coords="424,226,912,255"/><area shape="rect" id="node25" href="classsigc_1_1signal5.html" title="Signal declaration." alt="" coords="399,279,937,309"/><area shape="rect" id="node29" href="classsigc_1_1signal6.html" title="Signal declaration." alt="" coords="373,333,963,362"/><area shape="rect" id="node33" href="classsigc_1_1signal7.html" title="Signal declaration." alt="" coords="347,386,989,415"/><area shape="rect" id="node37" href="classsigc_1_1signal0.html" title="sigc::signal0\&lt; T_return, nil \&gt;" alt="" coords="565,439,771,469"/><area shape="rect" id="node41" href="classsigc_1_1signal1.html" title="sigc::signal1\&lt; T_return, T_arg1, nil \&gt;" alt="" coords="540,493,796,522"/><area shape="rect" id="node45" href="classsigc_1_1signal2.html" title="sigc::signal2\&lt; T_return, T_arg1, T_arg2, nil \&gt;" alt="" coords="515,546,821,575"/><area shape="rect" id="node49" href="classsigc_1_1signal3.html" title="sigc::signal3\&lt; T_return, T_arg1, T_arg2, T_arg3, nil \&gt;" alt="" coords="489,599,847,629"/><area shape="rect" id="node53" href="classsigc_1_1signal4.html" title="sigc::signal4\&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, nil \&gt;" alt="" coords="464,653,872,682"/><area shape="rect" id="node57" href="classsigc_1_1signal5.html" title="sigc::signal5\&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, nil \&gt;" alt="" coords="439,706,897,735"/><area shape="rect" id="node61" href="classsigc_1_1signal6.html" title="sigc::signal6\&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, nil \&gt;" alt="" coords="413,759,923,789"/><area shape="rect" id="node65" href="classsigc_1_1signal7.html" title="sigc::signal7\&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7, nil \&gt;" alt="" coords="387,813,949,842"/><area shape="rect" id="node7" href="classsigc_1_1signal_3_01T__return_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4_1_1accumulated.html" title="Convenience wrapper for the numbered sigc::signal0 template." alt="" coords="1191,13,1609,42"/><area shape="rect" id="node11" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4_1_1accumulated.html" title="Convenience wrapper for the numbered sigc::signal1 template." alt="" coords="1176,66,1624,95"/><area shape="rect" id="node15" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4_1_1accumulated.html" title="Convenience wrapper for the numbered sigc::signal2 template." alt="" coords="1161,119,1639,149"/><area shape="rect" id="node19" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01nil_00_01nil_00_01852c349c390cefa04662a850d84c0a94.html" title="Convenience wrapper for the numbered sigc::signal3 template." alt="" coords="1147,173,1653,202"/><area shape="rect" id="node23" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01nil_0d729ce48b1328d982e0ee754652fed04.html" title="Convenience wrapper for the numbered sigc::signal4 template." alt="" coords="1132,226,1668,255"/><area shape="rect" id="node27" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arcf6cb51783c363bfae7c4a91d9685109.html" title="Convenience wrapper for the numbered sigc::signal5 template." alt="" coords="1117,279,1683,309"/><area shape="rect" id="node31" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__are33def4d0c1a12dcbfd220489302db67.html" title="Convenience wrapper for the numbered sigc::signal6 template." alt="" coords="1103,333,1697,362"/><area shape="rect" id="node35" href="classsigc_1_1signal_1_1accumulated.html" title="Convenience wrapper for the numbered sigc::signal# templates." alt="" coords="1037,386,1763,415"/><area shape="rect" id="node39" href="classsigc_1_1signal_3_01T__return_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal0 template." alt="" coords="1236,439,1564,469"/><area shape="rect" id="node43" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal1 template." alt="" coords="1221,493,1579,522"/><area shape="rect" id="node47" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal2 template." alt="" coords="1207,546,1593,575"/><area shape="rect" id="node51" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal3 template." alt="" coords="1192,599,1608,629"/><area shape="rect" id="node55" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal4 template." alt="" coords="1177,653,1623,682"/><area shape="rect" id="node59" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal5 template." alt="" coords="1163,706,1637,735"/><area shape="rect" id="node63" href="classsigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__arg6_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::signal6 template." alt="" coords="1149,759,1651,789"/><area shape="rect" id="node67" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates." alt="" coords="1135,813,1665,842"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>

<p><a href="structsigc_1_1trackable-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3338954d7565534bd945290b798e13ed"></a><!-- doxytag: member="sigc::trackable::func_destroy_notify" ref="a3338954d7565534bd945290b798e13ed" args="" -->
typedef <br class="typebreak"/>
internal::func_destroy_notify&#160;</td><td class="memItemRight" valign="bottom"><b>func_destroy_notify</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7efefbcab4645648a366da3439242198"></a><!-- doxytag: member="sigc::trackable::trackable" ref="a7efefbcab4645648a366da3439242198" args="(const trackable &amp;src)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>trackable</b> (const <a class="el" href="structsigc_1_1trackable.html">trackable</a>&amp; src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7494fbad23a65932ff1457d00d4edaf5"></a><!-- doxytag: member="sigc::trackable::operator=" ref="a7494fbad23a65932ff1457d00d4edaf5" args="(const trackable &amp;src)" -->
<a class="el" href="structsigc_1_1trackable.html">trackable</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="structsigc_1_1trackable.html">trackable</a>&amp; src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#ab14931670837728e49bb5ca88fb16db5">add_destroy_notify_callback</a> (void* data, func_destroy_notify func) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a callback that is executed (notified) when the trackable object is detroyed. <a href="#ab14931670837728e49bb5ca88fb16db5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a8b9dffa8a50ff13ba33e6c7f10468e2b">remove_destroy_notify_callback</a> (void* data) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a callback previously installed with <a class="el" href="structsigc_1_1trackable.html#ab14931670837728e49bb5ca88fb16db5" title="Add a callback that is executed (notified) when the trackable object is detroyed.">add_destroy_notify_callback()</a>. <a href="#a8b9dffa8a50ff13ba33e6c7f10468e2b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2e23cfe7adc1ca844a3350bbac557cb"></a><!-- doxytag: member="sigc::trackable::notify_callbacks" ref="af2e23cfe7adc1ca844a3350bbac557cb" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#af2e23cfe7adc1ca844a3350bbac557cb">notify_callbacks</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute and remove all previously installed callbacks. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base class for objects with auto-disconnection. </p>
<p>trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.</p>
<p><a class="el" href="structsigc_1_1trackable.html#ab14931670837728e49bb5ca88fb16db5" title="Add a callback that is executed (notified) when the trackable object is detroyed.">add_destroy_notify_callback()</a> and <a class="el" href="structsigc_1_1trackable.html#a8b9dffa8a50ff13ba33e6c7f10468e2b" title="Remove a callback previously installed with add_destroy_notify_callback().">remove_destroy_notify_callback()</a> can be used to manually install and remove callbacks when notification of the object dying is needed.</p>
<p><a class="el" href="structsigc_1_1trackable.html#af2e23cfe7adc1ca844a3350bbac557cb" title="Execute and remove all previously installed callbacks.">notify_callbacks()</a> invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.</p>
<p>Note that there is no virtual destructor. Don't use <code>trackable*</code> as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab14931670837728e49bb5ca88fb16db5"></a><!-- doxytag: member="sigc::trackable::add_destroy_notify_callback" ref="ab14931670837728e49bb5ca88fb16db5" args="(void *data, func_destroy_notify func) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sigc::trackable::add_destroy_notify_callback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">func_destroy_notify&#160;</td>
          <td class="paramname"> <em>func</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add a callback that is executed (notified) when the trackable object is detroyed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Passed into func upon notification. </td></tr>
    <tr><td class="paramname">func</td><td>Callback executed upon destruction of the object. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8b9dffa8a50ff13ba33e6c7f10468e2b"></a><!-- doxytag: member="sigc::trackable::remove_destroy_notify_callback" ref="a8b9dffa8a50ff13ba33e6c7f10468e2b" args="(void *data) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sigc::trackable::remove_destroy_notify_callback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"> <em>data</em>&#160;)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Remove a callback previously installed with <a class="el" href="structsigc_1_1trackable.html#ab14931670837728e49bb5ca88fb16db5" title="Add a callback that is executed (notified) when the trackable object is detroyed.">add_destroy_notify_callback()</a>. </p>
<p>The callback is not executed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Parameter passed into previous call to <a class="el" href="structsigc_1_1trackable.html#ab14931670837728e49bb5ca88fb16db5" title="Add a callback that is executed (notified) when the trackable object is detroyed.">add_destroy_notify_callback()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Mar 8 2011 11:44:40 for libsigc++ by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>