Documented new constructor and overloaded Create methods.

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

diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex
index 7a1a8ec9d1f5d37b4d37be39307ab15075ff292b..ba7fef8068fa8a948a08fd270ab801ed1c6dbadf 100644 (file)
--- a/docs/latex/wx/list.tex
+++ b/docs/latex/wx/list.tex
@@ -2,7 +2,8 @@
 
 wxList classes provide linked list functionality for wxWindows, and for an
 application if it wishes.  Depending on the form of constructor used, a list
 
 wxList classes provide linked list functionality for wxWindows, 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.
 
 See \helpref{wxHashMap}{wxhashmap}\rtfsp for a faster method of storage
 when random access is required.
 


@@ -138,12 +139,14 @@ members for getting to the next or previous node.
 
 \func{}{wxList}{\void}
 
 
 \func{}{wxList}{\void}
 

-\func{}{wxList}{\param{unsigned int}{ key\_type}}
-

 \func{}{wxList}{\param{int}{ n}, \param{T *}{objects[]}}
 
 \func{}{wxList}{\param{T *}{object}, ...}
 
 \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).
 
 Constructors. {\it key\_type} is one of wxKEY\_NONE, wxKEY\_INTEGER, or wxKEY\_STRING,
 and indicates what sort of keying is required (if any).
 


@@ -163,6 +166,8 @@ client data held in the nodes.
 
 \func{wxNode<T> *}{Append}{\param{T *}{object}}
 
 
 \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}}
 \func{wxNode<T> *}{Append}{\param{long}{ key}, \param{T *}{object}}
 
 \func{wxNode<T> *}{Append}{\param{const wxString\& }{key}, \param{T *}{object}}


@@ -179,27 +184,27 @@ 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
 \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}}
 
 
 \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}}
 
 
 \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
 
 \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::Find}\label{wxlistfind}
 
 
 \membersection{wxList::Find}\label{wxlistfind}
 


@@ -207,6 +212,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.
 
 
 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}}
 \func{wxNode<T> *}{Find}{\param{long}{ key}}
 
 \func{wxNode<T> *}{Find}{\param{const wxString\& }{key}}


@@ -259,7 +266,7 @@ Inserts the object before the given {\it node}.
 
 \constfunc{bool}{IsEmpty}{\void}
 
 
 \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}
 
 % Use different label name to avoid clashing with wxListItem label
 \membersection{wxList::Item}\label{wxlistitemfunc}