Changed version to 2.5.1

[wxWidgets.git] / docs / latex / wx / arrstrng.tex

diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex
index f68d672050fdc3b9d64722f91db33e41c60cdf6b..e79a8fcdd208d965df5b88ab5e11e0d3ec71a7f4 100644 (file)
--- a/docs/latex/wx/arrstrng.tex
+++ b/docs/latex/wx/arrstrng.tex
@@ -26,14 +26,14 @@ array elements may be modified in place like this
     array.Last().MakeUpper();
 \end{verbatim}
 
-There is also a varian of wxArrayString called wxSortedArrayString which has
+There is also a variant of wxArrayString called wxSortedArrayString which has
 exactly the same methods as wxArrayString, but which always keeps the string
 in it in (alphabetical) order. wxSortedArrayString uses binary search in its 
-\helpref{Index}{wxarraystringindex} function (insteadf of linear search for
+\helpref{Index}{wxarraystringindex} function (instead of linear search for
 wxArrayString::Index) which makes it much more efficient if you add strings to
 the array rarely (because, of course, you have to pay for Index() efficiency
 by having Add() be slower) but search for them often. Several methods should
-not be used with sorted array (basicly, all which break the order of items)
+not be used with sorted array (basically, all which break the order of items)
 which is mentioned in their description.
 
 Final word: none of the methods of wxArrayString is virtual including its
@@ -48,7 +48,7 @@ functions.
 
 \wxheading{Include files}
 
-<wx/string.h>
+<wx/arrstr.h>
 
 \wxheading{See also}
 
@@ -84,14 +84,14 @@ Assignment operator.
 
 \constfunc{bool}{operator $==$}{\param{const wxArrayString\&}{ array}}
 
-Compares 2 arrays respecting the case. Returns TRUE only if the arrays have
+Compares 2 arrays respecting the case. Returns true only if the arrays have
 the same number of elements and the same strings in the same order.
 
 \membersection{wxArrayString::operator!=}\label{wxarraystringoperatornotequal}
 
 \constfunc{bool}{operator $!=$}{\param{const wxArrayString\&}{ array}}
 
-Compares 2 arrays respecting the case. Returns TRUE if the arrays have
+Compares 2 arrays respecting the case. Returns true if the arrays have
 different number of elements or if the elements don't match pairwise.
 
 \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex}
@@ -106,10 +106,10 @@ This is the operator version of \helpref{Item}{wxarraystringitem} method.
 
 \membersection{wxArrayString::Add}\label{wxarraystringadd}
 
-\func{size\_t}{Add}{\param{const wxString\& }{str}}
+\func{size\_t}{Add}{\param{const wxString\& }{str}, \param{size\_t}{ copies = $1$}}
 
-Appends a new item to the array and return the index of th new item in the
-array.
+Appends the given number of {\it copies} of the new item {\it str} to the
+array and returns the index of the first 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
@@ -163,10 +163,10 @@ Returns the number of items in the array.
 
 \membersection{wxArrayString::Index}\label{wxarraystringindex}
 
-\func{int}{Index}{\param{const char *}{ sz}, \param{bool}{ bCase = TRUE}, \param{bool}{ bFromEnd = FALSE}}
+\func{int}{Index}{\param{const char *}{ sz}, \param{bool}{ bCase = true}, \param{bool}{ bFromEnd = false}}
 
 Search the element in the array, starting from the beginning if
-{\it bFromEnd} is FALSE or from end otherwise. If {\it bCase}, comparison is
+{\it bFromEnd} is false or from end otherwise. If {\it bCase}, comparison is
 case sensitive (default), otherwise the case is ignored.
 
 This function uses linear search for wxArrayString and binary search for
@@ -177,9 +177,9 @@ Returns index of the first item matched or wxNOT\_FOUND if there is no match.
 
 \membersection{wxArrayString::Insert}\label{wxarraystringinsert}
 
-\func{void}{Insert}{\param{const wxString\& }{str}, \param{size\_t}{ nIndex}}
+\func{void}{Insert}{\param{const wxString\& }{str}, \param{size\_t}{ nIndex}, \param{size\_t }{copies = $1$}}
 
-Insert a new element in the array before the position {\it nIndex}. Thus, for
+Insert the given number of {\it copies} of the new element in the array before the position {\it nIndex}. Thus, for
 example, to insert the string in the beginning of the array you would write
 
 \begin{verbatim}
@@ -197,7 +197,7 @@ could break the order of items and, for example, subsequent calls to
 
 \func{}{IsEmpty}{}
 
-Returns TRUE if the array is empty, FALSE otherwise. This function returns the
+Returns true if the array is empty, false otherwise. This function returns the
 same result as {\it GetCount() == 0} but is probably easier to read.
 
 \membersection{wxArrayString::Item}\label{wxarraystringitem}
@@ -228,9 +228,11 @@ an attempt to remove an element which does not exist in debug build.
 
 See also: \helpref{Index}{wxarraystringindex}
 
-\func{void}{Remove}{\param{size\_t }{nIndex}}
+\membersection{wxArrayString::RemoveAt}\label{wxarraystringremoveat}
 
-Removes the item at given position.
+\func{void}{RemoveAt}{\param{size\_t }{nIndex}, \param{size\_t }{count = $1$}}
+
+Removes {\it count} items starting at position {\it nIndex} from the array.
 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}
 
@@ -243,10 +245,10 @@ See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory man
 
 \membersection{wxArrayString::Sort}\label{wxarraystringsort}
 
-\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 
-{\it reverseOrder} is TRUE.
+{\it reverseOrder} is true. The sort is case-sensitive.
 
 {\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