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.
-See \helpref{wxHashTable}{wxhashtable}\rtfsp for a faster method of storage
+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
\wxheading{Example}
-{\small%
\begin{verbatim}
// this part might be in a header or source (.cpp) file
class MyListElement
...
- // the only requirment for the rest is to be AFTER the full declaration of
+ // the only requirement for the rest is to be AFTER the full declaration of
// MyListElement (for WX_DECLARE_LIST forward declaration is enough), but
// usually it will be found in the source file and not in the header
...process the current element...
}
\end{verbatim}
-}
For compatibility with previous versions wxList and wxStringList classes are
still defined, but their usage is deprecated and they will disappear in the
\func{void}{Clear}{\void}
Clears the list (but does not delete the client data stored with each node
-unless you called DeleteContents(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 TRUE, instructs the list to call {\it delete} on the client contents of
-a node whenever the node is destroyed. The default is 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 *}{node}}
-Deletes the given node from the list, returning TRUE if successful.
+Deletes the given node from the list, returning {\tt TRUE} if successful.
\membersection{wxList::DeleteObject}\label{wxlistdeleteobject}
\func{bool}{DeleteObject}{\param{wxObject *}{object}}
Finds the given client {\it object} and deletes the appropriate node from the list, returning
-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}
\func{int}{IndexOf}{\param{wxObject*}{ obj }}
-Returns the index of {\it obj} within the list or NOT\_FOUND if {\it obj}
+Returns the index of {\it obj} within the list or wxNOT\_FOUND if {\it obj}
is not found in the list.
\membersection{wxList::Insert}\label{wxlistinsert}
Inserts the object before the given {\it node}.
+\membersection{wxList::IsEmpty}\label{wxlistisempty}
+
+\constfunc{bool}{IsEmpty}{\void}
+
+Returns {\tt TRUE} if the list is empty, {\tt FALSE} otherwise.
+
\membersection{wxList::Item}\label{wxlistitem}
\constfunc{wxNode *}{Item}{\param{size\_t }{index}}