interface/tracker.h

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