X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..22cf5eef6415705b5b677be1ad071ea8d9a73c47:/docs/latex/wx/strlist.tex?ds=sidebyside diff --git a/docs/latex/wx/strlist.tex b/docs/latex/wx/strlist.tex index 0c45fe457e..8956e27041 100644 --- a/docs/latex/wx/strlist.tex +++ b/docs/latex/wx/strlist.tex @@ -1,7 +1,11 @@ \section{\class{wxStringList}}\label{wxstringlist} -A string list is a list which is assumed to contain strings, with a -specific member functions. Memory is allocated when strings are added to +{\bf NB:} This class is obsolete, please don't use it any longer. You can use +either \helpref{wxArrayString}{wxarraystring} or a \helpref{type safe}{wxlist} +list class instead. + +A string list is a list which is assumed to contain strings. +Memory is allocated when strings are added to the list, and deallocated by the destructor or by the {\bf Delete}\rtfsp member. @@ -10,6 +14,10 @@ member. \helpref{wxList}{wxlist}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxString}{wxstring}, \helpref{wxList}{wxlist} @@ -39,6 +47,12 @@ Deletes string list, deallocating strings. Adds string to list, allocating memory. +\membersection{wxStringList::Clear} + +\func{void}{Clear}{\void} + +Clears all strings from the list. + \membersection{wxStringList::Delete} \func{void}{Delete}{\param{const wxString\& }{s}} @@ -47,16 +61,16 @@ Searches for string and deletes from list, deallocating memory. \membersection{wxStringList::ListToArray} -\func{char*}{ListToArray}{\param{bool}{ new\_copies = FALSE}} +\func{char*}{ListToArray}{\param{bool}{ new\_copies = false}} Converts the list to an array of strings, only allocating new memory if -\rtfsp{\bf new\_copies} is TRUE. +\rtfsp{\bf new\_copies} is true. \membersection{wxStringList::Member} \func{bool}{Member}{\param{const wxString\& }{s}} -Returns TRUE if {\bf s} is a member of the list (tested using {\bf strcmp}). +Returns true if {\bf s} is a member of the list (tested using {\bf strcmp}). \membersection{wxStringList::Sort}