No docs yet, just the bare interace so we can get XML for Phoenix.

[wxWidgets.git] / interface / wx / weakref.h

diff --git a/interface/wx/weakref.h b/interface/wx/weakref.h
index c06a27e11189e2dc29d9ddb73aefea3a06d46828..6e988f0e1276e4415f5d3112f83877e89a820b92 100644 (file)
--- a/interface/wx/weakref.h
+++ b/interface/wx/weakref.h
@@ -3,13 +3,11 @@
 // Purpose:     interface of wxWeakRefDynamic<T>, wxWeakRef<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxWeakRefDynamic<T>, wxWeakRef<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 
 /**

-    @class wxWeakRefDynamic<T>
-

     wxWeakRefDynamic<T> is a template class for weak references that is used in
     the same way as wxWeakRef<T>. The only difference is that wxWeakRefDynamic
     defaults to using @c dynamic_cast for establishing the object reference
     wxWeakRefDynamic<T> is a template class for weak references that is used in
     the same way as wxWeakRef<T>. The only difference is that wxWeakRefDynamic
     defaults to using @c dynamic_cast for establishing the object reference


@@ -28,8 +26,11 @@
 
     For API documentation, see: wxWeakRef<T>.
 
 
     For API documentation, see: wxWeakRef<T>.
 

+    @tparam T
+        The type to which the smart pointer points to.
+

     @nolibrary
     @nolibrary

-    @category{misc}
+    @category{smartpointers}

 */
 template<typename T>
 class wxWeakRefDynamic<T>
 */
 template<typename T>
 class wxWeakRefDynamic<T>


@@ -41,8 +42,6 @@ public:
 
 
 /**
 
 
 /**

-    @class wxWeakRef<T>
-

     wxWeakRef<T> is a template class for weak references to wxWidgets objects,
     such as wxEvtHandler, wxWindow and wxObject.
     A weak reference behaves much like an ordinary pointer, but when the object
     wxWeakRef<T> is a template class for weak references to wxWidgets objects,
     such as wxEvtHandler, wxWindow and wxObject.
     A weak reference behaves much like an ordinary pointer, but when the object


@@ -91,8 +90,11 @@ public:
     typedef wxWeakRef<wxWindow>      wxWindowRef;
     @endcode
 
     typedef wxWeakRef<wxWindow>      wxWindowRef;
     @endcode
 

+    @tparam T
+        The type to which the smart pointer points to.
+

     @nolibrary
     @nolibrary

-    @category{misc}
+    @category{smartpointers}

 
     @see wxSharedPtr<T>, wxScopedPtr<T>
 */
 
     @see wxSharedPtr<T>, wxScopedPtr<T>
 */


@@ -100,6 +102,9 @@ template<typename T>
 class wxWeakRef<T> : public wxTrackerNode
 {
 public:
 class wxWeakRef<T> : public wxTrackerNode
 {
 public:

+    /// Type of the element stored by this reference.
+    typedef T element_type;
+

     /**
         Constructor. The weak reference is initialized to @e pobj.
     */
     /**
         Constructor. The weak reference is initialized to @e pobj.
     */


@@ -113,7 +118,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxWeakRef();
+    virtual ~wxWeakRef();

 
     /**
         Called when the tracked object is destroyed. Be default sets
 
     /**
         Called when the tracked object is destroyed. Be default sets


@@ -151,11 +156,10 @@ public:
     T& operator*() const;
 
     /**
     T& operator*() const;
 
     /**

-        Smart pointer member access.
-        Returns a pointer to the tracked object.
+        Smart pointer member access. Returns a pointer to the tracked object.

         If the internal pointer is @NULL this method will cause an assert in debug mode.
     */
         If the internal pointer is @NULL this method will cause an assert in debug mode.
     */

-    T* operator-();
+    T* operator->();

 
     /**
         Releases the currently tracked object and starts tracking @e pobj.
 
     /**
         Releases the currently tracked object and starts tracking @e pobj.