X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8a2a6bbf9c9cf5a5aa913f805e893e61d0dae53b..11ef729d54ee338a1d569b5a238c2feb84d488ff:/docs/latex/wx/arrstrng.tex diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index 611c3e8ad6..68cc818143 100644 --- 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} - + \wxheading{See also} @@ -60,13 +60,21 @@ functions. \func{}{wxArrayString}{\void} -\func{}{wxArrayString}{\param{const wxArrayString\&}{ array}} +Default constructor. -Default and copy constructors. +\func{}{wxArrayString}{\param{const wxArrayString\&}{ array}} -Note that when an array is assigned to a sorted array, its contents is +Copy constructor. Note that when an array is assigned to a sorted array, its contents is automatically sorted during construction. +\func{}{wxArrayString}{\param{size\_t}{ sz}, \param{const wxChar**}{ arr}} + +Constructor from a C string array. Pass a size {\it sz} and array {\it arr}. + +\func{}{wxArrayString}{\param{size\_t}{ sz}, \param{const wxString*}{ arr}} + +Constructor from a wxString array. Pass a size {\it sz} and array {\it arr}. + \membersection{wxArrayString::\destruct{wxArrayString}}\label{wxarraystringdtor} \func{}{\destruct{wxArrayString}}{} @@ -84,14 +92,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} @@ -163,17 +171,17 @@ 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 wxSortedArrayString, but it ignores the {\it bCase} and {\it bFromEnd} parameters in the latter case. -Returns index of the first item matched or wxNOT\_FOUND if there is no match. +Returns index of the first item matched or {\tt wxNOT\_FOUND} if there is no match. \membersection{wxArrayString::Insert}\label{wxarraystringinsert} @@ -195,9 +203,9 @@ could break the order of items and, for example, subsequent calls to \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty} -\func{}{IsEmpty}{} +\func{bool}{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} @@ -213,7 +221,7 @@ version. \membersection{wxArrayString::Last}\label{wxarraystringlast} -\func{}{Last}{} +\func{wxString&}{Last}{} 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 @@ -228,7 +236,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}, \param{size\_t }{count = $1$}} +\membersection{wxArrayString::RemoveAt}\label{wxarraystringremoveat} + +\func{void}{RemoveAt}{\param{size\_t }{nIndex}, \param{size\_t }{count = $1$}} Removes {\it count} items starting at position {\it nIndex} from the array. @@ -243,10 +253,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