X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f045c7f52dfcfebcd0ea6a7b689ccb8a25021d1f..15fa4de377053c3c38f62593b2df941c217ea34b:/interface/wx/arrstr.h diff --git a/interface/wx/arrstr.h b/interface/wx/arrstr.h index a81aa37e19..3708c54635 100644 --- a/interface/wx/arrstr.h +++ b/interface/wx/arrstr.h @@ -3,7 +3,7 @@ // Purpose: interface of wxArrayString // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -41,7 +41,10 @@ a specialization of wxArray class for the wxString member data: it is not implemented like this, but it does have all of the wxArray functions. - @todo what about stl? how does it integrate? + It also has the full set of std::vector compatible + methods, including nested @c iterator and @c const_iterator classes which + should be used in the new code for forward compatibility with the future + wxWidgets versions. @library{wxbase} @category{containers} @@ -142,8 +145,7 @@ public: If @a nIndex is equal to GetCount() this function behaves as Add(). */ - void Insert(const wxString& str, size_t nIndex, - size_t copies = 1); + void Insert(wxString lItem, size_t nIndex, size_t copies = 1); /** Returns @true if the array is empty, @false otherwise. This function returns the @@ -277,10 +279,12 @@ class wxSortedArrayString : public wxArrayString public: /** - Copy constructor. Note that when an array is assigned to a sorted array, - its contents is automatically sorted during construction. + Conversion constructor. + + Constructs a sorted array with the same contents as the (possibly + unsorted) "array" argument. */ - wxArrayString(const wxArrayString& array); + wxSortedArrayString(const wxArrayString& array); /** @copydoc wxArrayString::Add() @@ -306,6 +310,8 @@ public: @warning This function should not be used with sorted arrays because it could break the order of items and, for example, subsequent calls to Index() would then not work! + + @warning In STL mode, Insert is private and simply invokes wxFAIL_MSG. */ void Insert(const wxString& str, size_t nIndex, size_t copies = 1); @@ -316,6 +322,8 @@ public: break the order of items and, for example, subsequent calls to Index() would then not work! Also, sorting a wxSortedArrayString doesn't make sense because its elements are always already sorted. + + @warning In STL mode, Sort is private and simply invokes wxFAIL_MSG. */ void Sort(bool reverseOrder = false); void Sort(CompareFunction compareFunction); @@ -327,7 +335,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_string */ +/** @addtogroup group_funcmacro_string */ //@{ /**