]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/tracker.h
Doc and comment cleanup, fixes, tweaks
[wxWidgets.git] / interface / wx / tracker.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: tracker.h
3 // Purpose: interface of wxTrackable
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 @class wxTrackable
11
12 Add-on base class for a trackable object. This class maintains an internal
13 linked list of classes of type wxTrackerNode and calls OnObjectDestroy() on
14 them if this object is destroyed. The most common usage is by using the
15 wxWeakRef<T> class template which automates this. This class has no public
16 API. Its only use is by deriving another class from it to make it trackable.
17
18 @code
19 class MyClass: public Foo, public wxTrackable
20 {
21 // whatever
22 }
23
24 typedef wxWeakRef<MyClass> MyClassRef;
25 @endcode
26
27 @library{wxbase}
28 @category{smartpointers}
29 */
30 class wxTrackable
31 {
32 public:
33
34 };
35