X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..801d040762d0d875126935b79d660d4e2fe1b177:/docs/latex/wx/strlist.tex diff --git a/docs/latex/wx/strlist.tex b/docs/latex/wx/strlist.tex index 79b0a3880c..6c02aba921 100644 --- a/docs/latex/wx/strlist.tex +++ b/docs/latex/wx/strlist.tex @@ -1,5 +1,9 @@ \section{\class{wxStringList}}\label{wxstringlist} +{\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 @@ -20,7 +24,7 @@ member. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxStringList::wxStringList} +\membersection{wxStringList::wxStringList}\label{wxstringlistctor} \func{}{wxStringList}{\void} @@ -31,44 +35,44 @@ Constructor. Constructor, taking NULL-terminated string argument list. wxStringList allocates memory for the strings. -\membersection{wxStringList::\destruct{wxStringList}} +\membersection{wxStringList::\destruct{wxStringList}}\label{wxstringlistdtor} \func{}{\destruct{wxStringList}}{\void} Deletes string list, deallocating strings. -\membersection{wxStringList::Add} +\membersection{wxStringList::Add}\label{wxstringlistadd} \func{wxNode *}{Add}{\param{const wxString\& }{s}} Adds string to list, allocating memory. -\membersection{wxStringList::Clear} +\membersection{wxStringList::Clear}\label{wxstringlistclear} \func{void}{Clear}{\void} Clears all strings from the list. -\membersection{wxStringList::Delete} +\membersection{wxStringList::Delete}\label{wxstringlistdelete} \func{void}{Delete}{\param{const wxString\& }{s}} Searches for string and deletes from list, deallocating memory. -\membersection{wxStringList::ListToArray} +\membersection{wxStringList::ListToArray}\label{wxstringlistlisttoarray} -\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} +\membersection{wxStringList::Member}\label{wxstringlistmember} \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} +\membersection{wxStringList::Sort}\label{wxstringlistsort} \func{void}{Sort}{\void}