Add wxRichMessageDialog class.

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

diff --git a/interface/wx/arrstr.h b/interface/wx/arrstr.h
index 8c68b94aa7dd60ccaaa826817cce88c868f90ec9..3708c54635b95b0c8df7f005db0f8e21f261ba90 100644 (file)
--- a/interface/wx/arrstr.h
+++ b/interface/wx/arrstr.h
@@ -3,16 +3,9 @@
 // Purpose:     interface of wxArrayString
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-/**
-    @todo
-    the following functions are not documented; do they need to be?
-    WXDLLIMPEXP_BASE int wxCMPFUNC_CONV wxStringSortAscending(wxString*, wxString*);
-    WXDLLIMPEXP_BASE int wxCMPFUNC_CONV wxStringSortDescending(wxString*, wxString*);
-*/
-
 /**
     @class wxArrayString
 
@@ -48,16 +41,24 @@
     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 <tt>std::vector<wxString></tt> 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}
 
-    @see wxArray, wxString, @ref overview_string
+    @see wxArray<T>, wxString, @ref overview_string
 */
 class wxArrayString : public wxArray
 {
 public:
+    /**
+        The function type used with wxArrayString::Sort function.
+    */
+    typedef int (*CompareFunction)(const wxString& first, const wxString& second);
+
     /**
         Default constructor.
     */
@@ -96,13 +97,10 @@ public:
     size_t Add(const wxString& str, size_t copies = 1);
 
     /**
-        Preallocates enough memory to store @a nCount items. This function may be
-        used to improve array class performance before adding a known number of items
-        consecutively.
-
-        @todo FIX THIS LINK
+        Preallocates enough memory to store @a nCount items.
 
-        @see @ref wxArray::memorymanagement "Dynamic array memory management"
+        This function may be used to improve array class performance before
+        adding a known number of items consecutively.
     */
     void Alloc(size_t nCount);
 
@@ -147,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
@@ -186,13 +183,10 @@ public:
     void RemoveAt(size_t nIndex, size_t count = 1);
 
     /**
-        Releases the extra memory allocated by the array. This function is useful to
-        minimize the array memory consumption.
+        Releases the extra memory allocated by the array.
+        This function is useful to minimize the array memory consumption.
 
-        @todo FIX THIS LINK
-
-        @see Alloc(), @ref wxArray::memorymanagement "Dynamic array memory
-        management"
+        @see Alloc()
     */
     void Shrink();
 
@@ -204,7 +198,7 @@ public:
 
     /**
         Sorts the array using the specified @a compareFunction for item comparison.
-        @a CompareFunction is defined as a function taking two @e const wxString
+        @a CompareFunction is defined as a function taking two <em>const wxString&</em>
         parameters and returning an @e int value less than, equal to or greater
         than 0 if the first string is less than, equal to or greater than the
         second one.
@@ -285,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()
@@ -308,22 +304,26 @@ public:
         the @a bCase and @a bFromEnd parameters.
     */
     int Index(const wxString& sz, bool bCase = true,
-              bool bFromEnd = false);
+              bool bFromEnd = false) const;
 
     /**
-        @warning this function should not be used with sorted arrays because it
+        @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);
 
     //@{
     /**
-        @warning this function should not be used with sorted array because it could
+        @warning This function should not be used with sorted array because it could
                  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);
@@ -335,7 +335,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_string */
+/** @addtogroup group_funcmacro_string */
 //@{
 
 /**