support for iPhone callbacks

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

diff --git a/interface/wx/arrstr.h b/interface/wx/arrstr.h
index 228126f769e42627e40491e17b25c3a48aefa89f..2a00a1b03a98a20cf311626589fbddfbb2304faa 100644 (file)
--- a/interface/wx/arrstr.h
+++ b/interface/wx/arrstr.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxArrayString
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // 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.
 
     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}
 
     @library{wxbase}
     @category{containers}


@@ -157,14 +160,20 @@ public:
 
         @see operator[] for the operator version.
     */
 
         @see operator[] for the operator version.
     */

-    wxString& Item(size_t nIndex) const;
+    //@{
+    wxString& Item(size_t nIndex);
+    const wxString& Item(size_t nIndex) const;
+    //@}

 
     /**
         Returns the last element of the array. Attempt to access the last element of
         an empty array will result in assert failure in debug build, however no checks
         are done in release mode.
     */
 
     /**
         Returns the last element of the array. Attempt to access the last element of
         an empty array will result in assert failure in debug build, however no checks
         are done in release mode.
     */

-    wxString& Last() const;
+    //@{
+    wxString& Last();
+    const wxString& Last() const;
+    //@}

 
     /**
         Removes the first item matching this value. An assert failure is provoked by
 
     /**
         Removes the first item matching this value. An assert failure is provoked by


@@ -276,10 +285,12 @@ class wxSortedArrayString : public wxArrayString
 public:
 
     /**
 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()
 
     /**
         @copydoc wxArrayString::Add()


@@ -305,6 +316,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 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);
     */
     void Insert(const wxString& str, size_t nIndex,
                 size_t copies = 1);


@@ -315,6 +328,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.
                  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);
     */
     void Sort(bool reverseOrder = false);
     void Sort(CompareFunction compareFunction);