X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..0a95f6d03619063ecd06b7dc41e57997424fbffe:/docs/latex/wx/arrstrng.tex diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index 71f698a11c..611c3e8ad6 100644 --- a/docs/latex/wx/arrstrng.tex +++ b/docs/latex/wx/arrstrng.tex @@ -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}