fixed links to global variables; fixed categories; use @see instead of @seealso

[wxWidgets.git] / interface / tracker.h

/////////////////////////////////////////////////////////////////////////////
// Name:        tracker.h
// Purpose:     documentation for wxTrackable class
// 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.

    @code
    class MyClass: public Foo, public wxTrackable
    {
       // whatever
    }

    typedef wxWeakRefMyClass MyClassRef;
    @endcode

    @library{wxbase}
    @category{FIXME}
*/
class wxTrackable
{
public:

};