Correctly document the library the classes belong to.

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

diff --git a/interface/wx/vector.h b/interface/wx/vector.h
index ddaff2edcaa985fb022a01e44ff5b136b0f0572d..02e1a2728bc6916eb83b33b42d306fa28780194f 100644 (file)
--- a/interface/wx/vector.h
+++ b/interface/wx/vector.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxVector<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -20,7 +20,7 @@
     @nolibrary
     @category{containers}
 
-    @see @ref overview_container, wxList<T>, wxArray<T>
+    @see @ref overview_container, wxList<T>, wxArray<T>, wxVectorSort<T>
 */
 template<typename T>
 class wxVector<T>
@@ -34,38 +34,25 @@ public:
     typedef const value_type* const_iterator;
     typedef value_type& reference;
 
-    /**
-        Reverse iterator interface
-    */
-    class reverse_iterator
-    {
-    public:
-        reverse_iterator();
-        explicit reverse_iterator(iterator it);
-        reverse_iterator(const reverse_iterator& it);
-        reference operator*() const;
-        pointer operator->() const;
-        iterator base() const;
-        reverse_iterator& operator++();
-        reverse_iterator operator++(int);
-        reverse_iterator& operator--();
-        reverse_iterator operator--(int);
-        reverse_iterator operator+(difference_type n) const;
-        reverse_iterator& operator+=(difference_type n);
-        reverse_iterator operator-(difference_type n) const;
-        reverse_iterator& operator-=(difference_type n);
-        reference operator[](difference_type n) const;
-        bool operator ==(const reverse_iterator& it) const;
-        bool operator !=(const reverse_iterator& it) const;
-    };
-
     /**
         Constructor.
     */
     wxVector();
 
     /**
-        Copy onstructor.
+        Constructor initializing the vector with the given number of
+        default-constructed objects.
+     */
+    wxVector(size_type size);
+
+    /**
+        Constructor initializing the vector with the given number of
+        copies of the given object.
+     */
+    wxVector(size_type size, const value_type& value);
+
+    /**
+        Copy constructor.
     */
     wxVector(const wxVector<T>& c);
 
@@ -108,7 +95,7 @@ public:
         Return reverse iterator to end of the vector.
     */
     reverse_iterator rbegin();
-    
+
     /**
         Return reverse iterator to beginning of the vector.
     */
@@ -206,9 +193,49 @@ public:
     */
     void reserve(size_type n);
 
+    /**
+        Makes the vector of size @a n.
+
+        If @a n is less than the current size(), the elements at the end of the
+        vector are erased. If it is greater, then the vector is completed with
+        either the copies of the given object @a v or @c value_type() objects
+        until it becomes of size @a n.
+     */
+    //@{
+    void resize(size_type n);
+    void resize(size_type n, const value_type& v);
+    //@}
+
     /**
         Returns the size of the vector.
     */
     size_type size() const;
+
+    /**
+        Efficiently exchanges contents of this vector with another one.
+
+        After the execution of this function the contents of this vector is
+        equal to the original contents of @a v and the contents of @a v becomes
+        the original contents of this vector without copying the data.
+
+        @since 2.9.1
+     */
+    void swap(wxVector& v);
 };
 
+
+/**
+   Sort the contents of a @c wxVector<T>.  In a STL build this function will
+   be defined as a thin wrapper around std::sort.  To be sortable the
+   contained type must support the less-than operator.
+
+   @code
+   wxVector<SomeClass> v;
+   ... // items are added to the vector v...
+   wxVectorSort(v);
+   @endcode
+
+   @see wxVector<T>
+*/
+template<typename T>
+void wxVectorSort(wxVector<T>& v);