]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/arrstrng.tex
Removed some inappropriate use of verbatim
[wxWidgets.git] / docs / latex / wx / arrstrng.tex
index 71f698a11c6569796867fe1b8fbcb37a8d3bb3c7..1b706a26afd28649e8fa1ec10fae882e29166449 100644 (file)
@@ -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
@@ -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
@@ -177,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
@@ -228,9 +228,9 @@ 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}}
+\func{void}{Remove}{\param{size\_t }{nIndex}, \param{size\_t }{count = $1$}}
 
-Removes the item at given position.
+Removes {\it count} items starting at position {\it nIndex} from the array.
 
 \membersection{wxArrayString::Shrink}\label{wxarraystringshrink}