Return NULL from wxWindow::GetCapture() when the capture is being lost.

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

diff --git a/interface/wx/vector.h b/interface/wx/vector.h
index 65e39a4a1d4051002f4ebea226444a4c57769363..f8b32e26d2f795e0bc81e22b83fc4b37b2c9da70 100644 (file)
--- a/interface/wx/vector.h
+++ b/interface/wx/vector.h
@@ -2,12 +2,10 @@
 // Name:        vector.h
 // Purpose:     interface of wxVector<T>
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
-    @wxheader{vector.h}
 
     wxVector<T> is a template class which implements most of the @c std::vector
     class and can be used like it.
@@ -21,14 +19,16 @@
     @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>
 {
 public:
     typedef size_t size_type;
+    typedef size_t difference_type;
     typedef T value_type;
+    typedef value_type* pointer;
     typedef value_type* iterator;
     typedef const value_type* const_iterator;
     typedef value_type& reference;
@@ -39,7 +39,32 @@ public:
     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);
+
+    /**
+        Constructor initializing the vector with the elements in the given
+        range.
+
+        The @a InputIterator template parameter must be an input iterator type.
+        This constructor adds all elements from @a first until, not not
+        including, @a last to the vector.
+
+        @since 2.9.5
+     */
+    template <class InputIterator>
+    wxVector(InputIterator first, InputIterator last);
+
+    /**
+        Copy constructor.
     */
     wxVector(const wxVector<T>& c);
 
@@ -48,6 +73,27 @@ public:
     */
     ~wxVector();
 
+    /**
+        Resizes the vector to @a n and assigns @a v to all elements.
+
+        @see resize()
+
+        @since 2.9.5
+     */
+    void assign(size_type n, const value_type& v);
+
+    /**
+        Assigns the elements in the given range to the vector.
+
+        The @a InputIterator template parameter must be an input iterator type.
+        This method clears the vector and then adds all elements from @a first
+        until, not not including, @a last to it.
+
+        @since 2.9.5
+     */
+    template <class InputIterator>
+    void assign(InputIterator first, InputIterator last);
+
     /**
         Returns item at position @a idx.
     */
@@ -79,7 +125,18 @@ public:
     iterator begin();
 
     /**
-        Returns vector's current capacity, i.e. how much memory is allocated.
+        Return reverse iterator to end of the vector.
+    */
+    reverse_iterator rbegin();
+
+    /**
+        Return reverse iterator to beginning of the vector.
+    */
+    reverse_iterator rend();
+
+
+    /**
+        Returns vector's current capacity, i.e.\ how much memory is allocated.
 
         @see reserve()
     */
@@ -169,9 +226,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);