wxURI/wxURL links in changes list.

[wxWidgets.git] / docs / latex / wx / strlist.tex

diff --git a/docs/latex/wx/strlist.tex b/docs/latex/wx/strlist.tex
index 0c45fe457e0eff152f24a90883d64aab71ad1963..6c02aba9211131728069afa71b01520643f60754 100644 (file)
--- 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,13 +14,17 @@ member.
 \helpref{wxList}{wxlist}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/list.h>
+
 \wxheading{See also}
 
 \helpref{wxString}{wxstring}, \helpref{wxList}{wxlist}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxStringList::wxStringList}
+\membersection{wxStringList::wxStringList}\label{wxstringlistctor}
 
 \func{}{wxStringList}{\void}
 
@@ -27,38 +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::Delete}
+\membersection{wxStringList::Clear}\label{wxstringlistclear}
+
+\func{void}{Clear}{\void}
+
+Clears all strings from the list.
+
+\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}