/////////////////////////////////////////////////////////////////////////////
// Name: tracker.h
-// Purpose: documentation for wxTrackable class
+// Purpose: interface of wxTrackable
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxTrackable
@wxheader{tracker.h}
-
- Add-on base class for a trackable object. This class maintains
- an internal linked list of classes of type wxTrackerNode and
- calls OnObjectDestroy() on them if this object is destroyed.
- The most common usage is by using the wxWeakRefT
- class template which automates this. This class has no public
- API. Its only use is by deriving another class from it to
- make it trackable.
-
+
+ Add-on base class for a trackable object. This class maintains an internal
+ linked list of classes of type wxTrackerNode and calls OnObjectDestroy() on
+ them if this object is destroyed. The most common usage is by using the
+ wxWeakRef<T> class template which automates this. This class has no public
+ API. Its only use is by deriving another class from it to make it trackable.
+
@code
class MyClass: public Foo, public wxTrackable
{
- // whatever
+ // whatever
}
-
- typedef wxWeakRefMyClass MyClassRef;
+
+ typedef wxWeakRef<MyClass> MyClassRef;
@endcode
-
+
@library{wxbase}
- @category{FIXME}
+ @category{smartpointers}
*/
-class wxTrackable
+class wxTrackable
{
public:
-
+
};
+