Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/list.h b/interface/wx/list.h
index bee1b9c1d065de66e3f305b9b720325d9802a733..ac88a671c452bae1028cdfbd12a1327b18aac6e9 100644 (file)
--- a/interface/wx/list.h
+++ b/interface/wx/list.h
@@ -2,8 +2,7 @@
 // Name:        list.h
 // Purpose:     interface of wxList<T>
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -12,7 +11,7 @@
     This class has been rewritten to be type safe and to provide the full API of
     the STL std::list container and should be used like it.
     The exception is that wxList<T> actually stores pointers and therefore its
-    iterators return pointers and not references to the actual objets in the list
+    iterators return pointers and not references to the actual objects in the list
     (see example below) and @e value_type is defined as @e T*.
     wxList<T> destroys an object after removing it only if wxList<T>::DeleteContents
     has been called.
@@ -27,7 +26,7 @@
     for further information on how to use the class.
     Below we documented both the supported STL and the legacy API
     that originated from the old wxList class and which can still be used alternatively
-    for the the same class.
+    for the same class.
 
     Note that if you compile wxWidgets in STL mode (@c wxUSE_STL defined as 1)
     then wxList<T> will actually derive from @c std::list and just add a legacy
@@ -132,7 +131,7 @@ public:
     void DeleteContents(bool destroy);
 
     /**
-        Deletes the given element refered to by @a iter from the list
+        Deletes the given element referred to by @a iter from the list
         if @a iter is a valid iterator. Returns @true if successful.
 
         Deletes the actual object if DeleteContents( @true ) was called previously.
@@ -148,14 +147,14 @@ public:
     bool DeleteObject(T* object);
 
     /**
-        Removes element refered to be @a iter.
+        Removes element referred to be @a iter.
 
-        Deletes the actualy object if DeleteContents( @true ) was called previously.
+        Deletes the actual object if DeleteContents( @true ) was called previously.
     */
     void Erase(const compatibility_iterator& iter);
 
     /**
-        Returns the iterator refering to @a object or @NULL if none found.
+        Returns the iterator referring to @a object or @NULL if none found.
     */
     wxList<T>::compatibility_iterator Find(T* object) const;
 
@@ -192,7 +191,7 @@ public:
                                            T* object);
 
     /**
-        Inserts @a object before the object refered to be @a iter.
+        Inserts @a object before the object referred to be @a iter.
     */
     wxList<T>::compatibility_iterator Insert(compatibility_iterator iter,
                                            T* object);
@@ -203,15 +202,17 @@ public:
     bool IsEmpty() const;
 
     /**
-        Returns the iterator refering to the object at the given
+        Returns the iterator referring to the object at the given
         @a index in the list.
     */
     wxList<T>::compatibility_iterator Item(size_t index) const;
 
     /**
-        @deprecated This function is deprecated, use Find() instead.
+        Check if the object is present in the list.
+
+        @see Find()
     */
-    wxList<T>::compatibility_iterator Member(T* object) const;
+    bool Member(T* object) const;
 
     /**
         @deprecated This function is deprecated, use Item() instead.
@@ -389,6 +390,13 @@ public:
         Returns the size of the list.
     */
     size_type size() const;
+
+    /**
+        Returns a wxVector holding the list elements.
+
+        @since 2.9.5
+    */
+    wxVector<T> AsVector() const;
 };