From: Stefan Neis Date: Sat, 4 May 2002 15:26:24 +0000 (+0000) Subject: Updated documentation according to recent array changes. X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/8a2a6bbf9c9cf5a5aa913f805e893e61d0dae53b?ds=sidebyside Updated documentation according to recent array changes. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15375 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index f68d672050..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,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} @@ -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}