X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2f930c8501cd4e0f7b17bb59761cfbdd02d3b9f2..677b38f28e645e362aedc11758bdda935f71ebfa:/docs/latex/wx/arrstrng.tex diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex index 0d12b11b81..68cc818143 100644 --- a/docs/latex/wx/arrstrng.tex +++ b/docs/latex/wx/arrstrng.tex @@ -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}}{} @@ -173,7 +181,7 @@ 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,7 +203,7 @@ 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 same result as {\it GetCount() == 0} but is probably easier to read. @@ -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.