Add possibility to hide and show again wxRibbonBar pages.

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

diff --git a/interface/wx/list.h b/interface/wx/list.h
index a770d433d6c276836c0400bc091f856b0ef96859..7d2f566c631d56a4eb84dfef2542121f3d4e31e8 100644 (file)
--- a/interface/wx/list.h
+++ b/interface/wx/list.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxList<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxList<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

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


@@ -12,7 +12,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
     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.
     (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 +27,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 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
 
     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


@@ -89,7 +89,7 @@
         The type stored in the wxList nodes.
 
     @library{wxbase}
         The type stored in the wxList nodes.
 
     @library{wxbase}

-    @category{data}
+    @category{containers}

 
     @see wxArray<T>, wxVector<T>, wxNode<T>
 */
 
     @see wxArray<T>, wxVector<T>, wxNode<T>
 */


@@ -132,7 +132,7 @@ public:
     void DeleteContents(bool destroy);
 
     /**
     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.
         if @a iter is a valid iterator. Returns @true if successful.
 
         Deletes the actual object if DeleteContents( @true ) was called previously.


@@ -148,14 +148,14 @@ public:
     bool DeleteObject(T* object);
 
     /**
     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);
 
     /**
     */
     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;
 
     */
     wxList<T>::compatibility_iterator Find(T* object) const;
 


@@ -192,7 +192,7 @@ public:
                                            T* object);
 
     /**
                                            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);
     */
     wxList<T>::compatibility_iterator Insert(compatibility_iterator iter,
                                            T* object);


@@ -203,15 +203,17 @@ public:
     bool IsEmpty() const;
 
     /**
     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;
 
     /**
         @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.
 
     /**
         @deprecated This function is deprecated, use Item() instead.