1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libsigc++ 2.0: sigc::trackable Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/libsigc_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a class="qindex" href="modules.html">Groups</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
</center>
<hr width="100%"/>
<!-- Generated by Doxygen 1.3.9.1 -->
<h1>sigc::trackable Struct Reference<br>
<small>
[<a class="el" href="group__signal.html">Signals</a>]</small>
</h1>Base class for objects with auto-disconnection.
<a href="#_details">More...</a>
<p>
Inheritance diagram for sigc::trackable:<p><center><img src="structsigc_1_1trackable__inherit__graph.png" border="0" usemap="#sigc_1_1trackable__inherit__map" alt="Inheritance graph"></center>
<map name="sigc_1_1trackable__inherit__map">
<area href="structsigc_1_1internal_1_1slot__rep.html" shape="rect" coords="8,83,160,107" alt="">
<area href="structsigc_1_1signal__base.html" shape="rect" coords="184,83,306,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="structsigc_1_1trackable-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespacesigc_1_1internal.html#a1">internal::func_destroy_notify</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#w0">func_destroy_notify</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a0">trackable</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a1">trackable</a> (const <a class="el" href="structsigc_1_1trackable.html">trackable</a>& src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsigc_1_1trackable.html">trackable</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a2">operator=</a> (const <a class="el" href="structsigc_1_1trackable.html">trackable</a>& src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a3">~trackable</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a4">add_destroy_notify_callback</a> (void* data, <a class="el" href="structsigc_1_1trackable.html#w0">func_destroy_notify</a> func) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a callback that is executed (notified) when the trackable object is detroyed. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a5">remove_destroy_notify_callback</a> (void* data) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a callback previously installed with <a class="el" href="structsigc_1_1trackable.html#a4">add_destroy_notify_callback()</a>. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html#a6">notify_callbacks</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute and remove all previously installed callbacks. <a href="#a6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for objects with auto-disconnection.
<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>
<a class="el" href="structsigc_1_1trackable.html#a4">add_destroy_notify_callback()</a> and <a class="el" href="structsigc_1_1trackable.html#a5">remove_destroy_notify_callback()</a> can be used to manually install and remove callbacks when notification of the object dying is needed.<p>
<a class="el" href="structsigc_1_1trackable.html#a6">notify_callbacks()</a> invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.<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 Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="sigc::trackable::func_destroy_notify"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef <a class="el" href="namespacesigc_1_1internal.html#a1">internal::func_destroy_notify</a> <a class="el" href="structsigc_1_1trackable.html#w0">sigc::trackable::func_destroy_notify</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="sigc::trackable::trackable"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">sigc::trackable::trackable </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="sigc::trackable::trackable"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">sigc::trackable::trackable </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="structsigc_1_1trackable.html">trackable</a>& </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="sigc::trackable::~trackable"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">sigc::trackable::~<a class="el" href="structsigc_1_1trackable.html">trackable</a> </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4" doxytag="sigc::trackable::add_destroy_notify_callback"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void sigc::trackable::add_destroy_notify_callback </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">void* </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="structsigc_1_1trackable.html#w0">func_destroy_notify</a> </td>
<td class="mdname" nowrap> <em>func</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a callback that is executed (notified) when the trackable object is detroyed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Passed into func upon notification. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>Callback executed upon destruction of the object. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="sigc::trackable::notify_callbacks"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void sigc::trackable::notify_callbacks </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Execute and remove all previously installed callbacks.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="sigc::trackable::operator="></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="structsigc_1_1trackable.html">trackable</a>& sigc::trackable::operator= </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="structsigc_1_1trackable.html">trackable</a>& </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="sigc::trackable::remove_destroy_notify_callback"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void sigc::trackable::remove_destroy_notify_callback </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">void* </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Remove a callback previously installed with <a class="el" href="structsigc_1_1trackable.html#a4">add_destroy_notify_callback()</a>.
<p>
The callback is not executed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Parameter passed into previous call to <a class="el" href="structsigc_1_1trackable.html#a4">add_destroy_notify_callback()</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="trackable_8h.html">trackable.h</a></ul>
<hr><address><small>
Generated for libsigc++ 2.0 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3.9.1 © 1997-2001</small></address>
</body>
</html>
|