This class is used in the same way as other dynamic \helpref{arrays}{wxarray},
except that no {\it WX\_DEFINE\_ARRAY} declaration is needed for it. When a
string is added or inserted in the array, a copy of the string is created, so
-the original string may be safely deleted (e.g. if it was a {\it char *}
+the original string may be safely deleted (e.g. if it was a {\it wxChar *}
pointer the memory it was using can be freed immediately after this). In
general, there is no need to worry about string memory deallocation when using
this class - it will always free the memory it uses itself.
\wxheading{Include files}
-<wx/string.h>
+<wx/arrstr.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
\wxheading{See also}
\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 char**}{ arr}}
+
+\func{}{wxArrayString}{\param{size\_t}{ sz}, \param{const wchar\_t**}{ 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}}{}
\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}
See also: \helpref{Empty}{wxarraystringempty}
-\membersection{wxArrayString::Count}\label{wxarraystringcount}
-
-\constfunc{size\_t}{Count}{\void}
-
-Returns the number of items in the array. This function is deprecated and is
-for backwards compatibility only, please use
-\helpref{GetCount}{wxarraystringgetcount} instead.
-
\membersection{wxArrayString::Empty}\label{wxarraystringempty}
\func{void}{Empty}{\void}
\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 wxString\& }{ 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}
\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}
\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
\membersection{wxArrayString::Remove}\label{wxarraystringremove}
-\func{void}{Remove}{\param{const char *}{ sz}}
+\func{void}{Remove}{\param{const wxString\&}{ 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}
-\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.
\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
projects / wxWidgets.git / blobdiff