]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/arrstrng.tex
Misc fixes
[wxWidgets.git] / docs / latex / wx / arrstrng.tex
index 62f1f245e6c65125495bcd0071432a2a6826635c..dc15f1dd0f0c0c15c79e82d931f28abe2613dc82 100644 (file)
@@ -92,9 +92,10 @@ This is the operator version of \helpref{Item}{wxarraystringitem} method.
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 
-\func{void}{Add}{\param{const wxString\& }{str}}
+\func{size\_t}{Add}{\param{const wxString\& }{str}}
 
 
-Appends a new item to the array.
+Appends a new item to the array and return the index of th new item in the
+array.
 
 {\bf Warning:} For sorted arrays, the index of the inserted item will not be,
 in general, equal to \helpref{GetCount()}{wxarraystringgetcount} - 1 because
 
 {\bf Warning:} For sorted arrays, the index of the inserted item will not be,
 in general, equal to \helpref{GetCount()}{wxarraystringgetcount} - 1 because
@@ -174,9 +175,9 @@ Insert("foo", 0);
 If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as 
 \helpref{Add}{wxarraystringadd}.
 
 If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as 
 \helpref{Add}{wxarraystringadd}.
 
-{\bf Warning:} this function should not be used with sorted array because it
+{\bf Warning:} this function should not be used with sorted arrays because it
 could break the order of items and, for example, subsequent calls to 
 could break the order of items and, for example, subsequent calls to 
-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!
 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 
 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 
@@ -234,12 +235,12 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man
 
 \func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
 
 
 \func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
 
-Sorts the array in alphabetical order or in reverse alphabetical order if
+Sorts the array in alphabetical order or in reverse alphabetical order if 
 {\it reverseOrder} is TRUE.
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 
 {\it reverseOrder} is TRUE.
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 
-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!
 
 See also: \helpref{Sort}{wxarraystringsortcallback}
 
 
 See also: \helpref{Sort}{wxarraystringsortcallback}
 
@@ -249,7 +250,7 @@ See also: \helpref{Sort}{wxarraystringsortcallback}
 
 Sorts the array using the specified {\it compareFunction} for item comparison.
 {\it CompareFunction} is defined as a function taking two {\it const
 
 Sorts the array using the specified {\it compareFunction} for item comparison.
 {\it CompareFunction} is defined as a function taking two {\it const
-wxString\&} parameters and returning {\it int} value less than, equal to or
+wxString\&} parameters and returning an {\it 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.
 
 greater than 0 if the first string is less than, equal to or greater than the
 second one.
 
@@ -277,7 +278,7 @@ array.Sort(CompareStringLen);
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 
 
 {\bf Warning:} this function should not be used with sorted array because it
 could break the order of items and, for example, subsequent calls to 
-\helpref{Index()}{wxarraystringindex} would not work then!
+\helpref{Index()}{wxarraystringindex} would then not work!
 
 See also: \helpref{Sort}{wxarraystringsort}
 
 
 See also: \helpref{Sort}{wxarraystringsort}