X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..253d8fd8fc70db993ccdd5b7aa932043fe09a768:/interface/vector.h diff --git a/interface/vector.h b/interface/vector.h index 3ca85c6c3e..a32f018b73 100644 --- a/interface/vector.h +++ b/interface/vector.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: vector.h -// Purpose: documentation for wxVector class +// Purpose: interface of wxVector // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,23 +9,21 @@ /** @class wxVectorT @wxheader{vector.h} - + wxVectorT is a template class which implements most of the std::vector class and can be used like it. If wxWidgets is compiled in STL mode, wxVector will just be a typedef to std::vector. Just like for std::vector, objects stored in wxVectorT need to be @e assignable but don't have to be @e default constructible. - + You can refer to the STL documentation for further information. - + @library{wxbase} @category{FIXME} - - @seealso - @ref overview_wxcontaineroverview "Container classes overview", wxListT, - wxArrayT + + @see @ref overview_wxcontaineroverview, wxListT(), wxArrayT() */ -class wxVector +class wxVector { public: //@{ @@ -33,7 +31,7 @@ public: Constructor. */ wxVectorT(); - wxVectorT(const wxVector& c); + wxVectorT(const wxVector& c); //@} /** @@ -46,7 +44,7 @@ public: Returns item at position @e idx. */ const value_type at(size_type idx); - value_type at(size_type idx); + const value_type at(size_type idx); //@} //@{ @@ -54,7 +52,7 @@ public: Return last item. */ const value_type back(); - value_type back(); + const value_type back(); //@} //@{ @@ -62,13 +60,13 @@ public: Return iterator to beginning of the vector. */ const_iterator begin(); - iterator begin(); + const iterator begin(); //@} /** */ - size_type capacity(); + size_type capacity() const; /** Clears the vector. @@ -78,24 +76,24 @@ public: /** Returns @true if the vector is empty. */ - bool empty(); + bool empty() const; //@{ /** Returns iterator to the end of the vector. */ const_iterator end(); - iterator end(); + const iterator end(); //@} //@{ /** - Erase items. When using values other than built-in integrals + Erase items. When using values other than built-in integrals or classes with reference counting this can be an inefficient operation. */ iterator erase(iterator it); - iterator erase(iterator first, iterator last); + iterator erase(iterator first, iterator last); //@} //@{ @@ -103,13 +101,12 @@ public: Returns first item. */ const value_type front(); - value_type front(); + const value_type front(); //@} /** ) - - Insert an item. When using values other than built-in integrals + Insert an item. When using values other than built-in integrals or classes with reference counting this can be an inefficient operation. */ @@ -125,7 +122,7 @@ public: Returns item at position @e idx. */ const value_type operator[](size_type idx); - value_type operator[](size_type idx); + const value_type operator[](size_type idx); //@} /** @@ -139,9 +136,10 @@ public: void push_back(const value_type& v); /** - Reserves more memory of @e n is greater then + Reserves more memory of @a n is greater then wxVector::size. Other this call has no effect. */ void reserve(size_type n); }; +