On wxMac don't call Refresh from FullPaint as that is the biggest

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

diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex
index 7a1a8ec9d1f5d37b4d37be39307ab15075ff292b..1bce91d35e3abb45f0bf87c0b51a026a150f7f0f 100644 (file)
--- a/docs/latex/wx/list.tex
+++ b/docs/latex/wx/list.tex
@@ -1,18 +1,19 @@
 \section{\class{wxList}}\label{wxlist}
 
-wxList classes provide linked list functionality for wxWindows, and for an
+wxList classes provide linked list functionality for wxWidgets, and for an
 application if it wishes.  Depending on the form of constructor used, a list
-can be keyed on integer or string keys to provide a primitive look-up ability.
+can be keyed on integer or string keys to provide a primitive look-up ability,
+but please note that this feature is {\bf deprecated}.
 See \helpref{wxHashMap}{wxhashmap}\rtfsp for a faster method of storage
 when random access is required.
 
-While wxList class in the previous versions of wxWindows only could contain
+While wxList class in the previous versions of wxWidgets only could contain
 elements of type wxObject and had essentially untyped interface (thus allowing
 you to put apples in the list and read back oranges from it), the new wxList
 classes family may contain elements of any type and has much more strict type
 checking. Unfortunately, it also requires an additional line to be inserted in
 your program for each list class you use (which is the only solution short of
-using templates which is not done in wxWindows because of portability issues).
+using templates which is not done in wxWidgets because of portability issues).
 
 The general idea is to have the base class wxListBase working with {\it void *}
 data but make all of its dangerous (because untyped) functions protected, so
@@ -129,21 +130,23 @@ members for getting to the next or previous node.
 
 \wxheading{See also}
 
-\helpref{wxNode}{wxnode}, \helpref{wxStringList}{wxstringlist},
+\helpref{wxNode}{wxnode},
 \helpref{wxArray}{wxarray}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxList::wxList}
+\membersection{wxList::wxList}\label{wxlistctor}
 
 \func{}{wxList}{\void}
 
-\func{}{wxList}{\param{unsigned int}{ key\_type}}
-
 \func{}{wxList}{\param{int}{ n}, \param{T *}{objects[]}}
 
 \func{}{wxList}{\param{T *}{object}, ...}
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
+\func{}{wxList}{\param{unsigned int}{ key\_type}}
+
 Constructors. {\it key\_type} is one of wxKEY\_NONE, wxKEY\_INTEGER, or wxKEY\_STRING,
 and indicates what sort of keying is required (if any).
 
@@ -152,7 +155,7 @@ and indicates what sort of keying is required (if any).
 The variable-length argument list constructor must be supplied with a
 terminating NULL.
 
-\membersection{wxList::\destruct{wxList}}
+\membersection{wxList::\destruct{wxList}}\label{wxlistdtor}
 
 \func{}{\destruct{wxList}}{\void}
 
@@ -163,6 +166,8 @@ client data held in the nodes.
 
 \func{wxNode<T> *}{Append}{\param{T *}{object}}
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
 \func{wxNode<T> *}{Append}{\param{long}{ key}, \param{T *}{object}}
 
 \func{wxNode<T> *}{Append}{\param{const wxString\& }{key}, \param{T *}{object}}
@@ -179,27 +184,33 @@ The key string is copied and stored by the list implementation.
 \func{void}{Clear}{\void}
 
 Clears the list (but does not delete the client data stored with each node
-unless you called DeleteContents({\tt TRUE}), in which case it deletes data).
+unless you called DeleteContents({\tt true}), in which case it deletes data).
 
 \membersection{wxList::DeleteContents}\label{wxlistdeletecontents}
 
 \func{void}{DeleteContents}{\param{bool}{ destroy}}
 
-If {\it destroy} is {\tt TRUE}, instructs the list to call {\it delete} on the client contents of
-a node whenever the node is destroyed. The default is {\tt FALSE}.
+If {\it destroy} is {\tt true}, instructs the list to call {\it delete} on the client contents of
+a node whenever the node is destroyed. The default is {\tt false}.
 
 \membersection{wxList::DeleteNode}\label{wxlistdeletenode}
 
 \func{bool}{DeleteNode}{\param{wxNode<T> *}{node}}
 
-Deletes the given node from the list, returning {\tt TRUE} if successful.
+Deletes the given node from the list, returning {\tt true} if successful.
 
 \membersection{wxList::DeleteObject}\label{wxlistdeleteobject}
 
 \func{bool}{DeleteObject}{\param{T *}{object}}
 
 Finds the given client {\it object} and deletes the appropriate node from the list, returning
-{\tt TRUE} if successful. The application must delete the actual object separately.
+{\tt true} if successful. The application must delete the actual object separately.
+
+\membersection{wxList::Erase}\label{wxlisterase}
+
+\func{void}{Erase}{\param{wxNode<T> *}{node}}
+
+Removes element at given position.
 
 \membersection{wxList::Find}\label{wxlistfind}
 
@@ -207,6 +218,8 @@ Finds the given client {\it object} and deletes the appropriate node from the li
 
 Returns the node whose client date is {\it object} or NULL if none found.
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
 \func{wxNode<T> *}{Find}{\param{long}{ key}}
 
 \func{wxNode<T> *}{Find}{\param{const wxString\& }{key}}
@@ -235,7 +248,7 @@ Returns the last node in the list (NULL if the list is empty).
 
 \func{int}{IndexOf}{\param{T*}{ obj }}
 
-Returns the index of {\it obj} within the list or wxNOT\_FOUND if {\it obj} 
+Returns the index of {\it obj} within the list or {\tt wxNOT\_FOUND} if {\it obj} 
 is not found in the list.
 
 \membersection{wxList::Insert}\label{wxlistinsert}
@@ -259,7 +272,7 @@ Inserts the object before the given {\it node}.
 
 \constfunc{bool}{IsEmpty}{\void}
 
-Returns {\tt TRUE} if the list is empty, {\tt FALSE} otherwise.
+Returns {\tt true} if the list is empty, {\tt false} otherwise.
 
 % Use different label name to avoid clashing with wxListItem label
 \membersection{wxList::Item}\label{wxlistitemfunc}