removed extra (non existing) Prepend() parameter

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

diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex
index dc15f1dd0f0c0c15c79e82d931f28abe2613dc82..1b706a26afd28649e8fa1ec10fae882e29166449 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
@@ -80,6 +80,20 @@ reasons it is not virtual, so this class should not be derived from.
 
 Assignment operator.
 
+\membersection{wxArrayString::operator==}\label{wxarraystringoperatorequal}
+
+\constfunc{bool}{operator $==$}{\param{const wxArrayString\&}{ array}}
+
+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
+different number of elements or if the elements don't match pairwise.
+
 \membersection{wxArrayString::operator[]}\label{wxarraystringoperatorindex}
 
 \func{wxString\&}{operator[]}{\param{size\_t }{nIndex}}
@@ -92,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,16 +177,16 @@ 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}
 Insert("foo", 0);
 \end{verbatim}
 
-If {\it nIndex} is equal to {\it GetCount() + 1} this function behaves as 
+If {\it nIndex} is equal to {\it GetCount()} this function behaves as 
 \helpref{Add}{wxarraystringadd}.
 
 {\bf Warning:} this function should not be used with sorted arrays because it
@@ -205,22 +219,18 @@ 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.
 
-\membersection{wxArrayString::Remove (by value)}\label{wxarraystringremoveval}
+\membersection{wxArrayString::Remove}\label{wxarraystringremove}
 
 \func{void}{Remove}{\param{const char *}{ sz}}
 
 Removes the first item matching this value. An assert failure is provoked by
 an attempt to remove an element which does not exist in debug build.
 
-See also: \helpref{Index}{wxarraystringindex}, \helpref{Remove}{wxarraystringremove}
+See also: \helpref{Index}{wxarraystringindex}
 
-\membersection{wxArrayString::Remove (by index)}\label{wxarraystringremove}
+\func{void}{Remove}{\param{size\_t }{nIndex}, \param{size\_t }{count = $1$}}
 
-\func{void}{Remove}{\param{size\_t }{nIndex}}
-
-Removes the item at given position.
-
-See also: \helpref{Remove}{wxarraystringremoveval}
+Removes {\it count} items starting at position {\it nIndex} from the array.
 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}
 
@@ -231,7 +241,7 @@ minimize the array memory consumption.
 
 See also: \helpref{Alloc}{wxarraystringalloc}, \helpref{Dynamic array memory management}{wxarraymemorymanagement}
 
-\membersection{wxArrayString::Sort (alphabetically)}\label{wxarraystringsort}
+\membersection{wxArrayString::Sort}\label{wxarraystringsort}
 
 \func{void}{Sort}{\param{bool}{ reverseOrder = FALSE}}
 
@@ -242,10 +252,6 @@ Sorts the array in alphabetical order or in reverse alphabetical order if
 could break the order of items and, for example, subsequent calls to 
 \helpref{Index()}{wxarraystringindex} would then not work!
 
-See also: \helpref{Sort}{wxarraystringsortcallback}
-
-\membersection{wxArrayString::Sort (user defined)}\label{wxarraystringsortcallback}
-
 \func{void}{Sort}{\param{CompareFunction }{compareFunction}}
 
 Sorts the array using the specified {\it compareFunction} for item comparison.
@@ -280,5 +286,3 @@ array.Sort(CompareStringLen);
 could break the order of items and, for example, subsequent calls to 
 \helpref{Index()}{wxarraystringindex} would then not work!
 
-See also: \helpref{Sort}{wxarraystringsort}
-