X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/83e51c483e9c3621d150fb5bdb3f28493af833ef..eaa785079ca4234e6bb97983e24e54d7af21c257:/docs/latex/wx/list.tex?ds=sidebyside diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex index 93f4663fa5..50482dd315 100644 --- a/docs/latex/wx/list.tex +++ b/docs/latex/wx/list.tex @@ -27,12 +27,10 @@ information on how to use the class. Below we documented the legacy API that originated from the old wxList class and which can still be used alternatively for the the same class. -Note that if you compile wxWidgets in STL mode (wxUSE_STL defined as 1) +Note that if you compile wxWidgets in STL mode (wxUSE\_STL defined as 1) then wxList will actually derive from std::list and just add a legacy compatibility layer for the old wxList class. -each list type (i.e. list of ints, of wxStrings or of MyObjects). - \wxheading{Example} \begin{verbatim} @@ -55,7 +53,6 @@ each list type (i.e. list of ints, of wxStrings or of MyObjects). WX_DEFINE_LIST(MyList); - MyList list; MyListElement element; list.Append(&element); // ok @@ -93,6 +90,10 @@ it is not only unsafe but is also much less efficient than +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxArray}{wxarray} @@ -103,7 +104,7 @@ it is not only unsafe but is also much less efficient than \func{}{wxList}{\void} -\func{}{wxList}{\param{size_t}{ count}, \param{T *}{elements[]}} +\func{}{wxList}{\param{size\_t}{ count}, \param{T *}{elements[]}} Constructors. @@ -116,7 +117,7 @@ unless you called DeleteContents({\tt true} ). \membersection{wxList::Append}\label{wxlistappend} -\func{wxList::compatibility_iterator }{Append}{\param{T *}{object}} +\func{wxList::compatibility\_iterator }{Append}{\param{T *}{object}} Appends the pointer to \rtfsp{\it object} to the list. @@ -137,7 +138,7 @@ The default is {\tt false}. \membersection{wxList::DeleteNode}\label{wxlistdeletenode} -\func{bool}{DeleteNode}{\param{const compatibility_iterator &}{iter}} +\func{bool}{DeleteNode}{\param{const compatibility\_iterator &}{iter}} Deletes the given element refered to by {\tt iter} from the list, returning {\tt true} if successful. @@ -152,13 +153,13 @@ separately. \membersection{wxList::Erase}\label{wxlisterase} -\func{void}{Erase}{\param{const compatibility_iterator &}{iter}} +\func{void}{Erase}{\param{const compatibility\_iterator &}{iter}} Removes element refered to be {\tt iter}. \membersection{wxList::Find}\label{wxlistfind} -\constfunc{wxList::compatibility_iterator}{Find}{\param{T *}{ object}} +\constfunc{wxList::compatibility\_iterator}{Find}{\param{T *}{ object}} Returns the iterator refering to {\it object} or NULL if none found. @@ -170,13 +171,13 @@ Returns the number of elements in the list. \membersection{wxList::GetFirst}\label{wxlistgetfirst} -\constfunc{wxList::compatibility_iterator}{GetFirst}{\void} +\constfunc{wxList::compatibility\_iterator}{GetFirst}{\void} Returns the first iterator in the list (NULL if the list is empty). \membersection{wxList::GetLast}\label{wxlistgetlast} -\constfunc{wxList::compatibility_iterator}{GetLast}{\void} +\constfunc{wxList::compatibility\_iterator}{GetLast}{\void} Returns the last iterator in the list (NULL if the list is empty). @@ -189,18 +190,18 @@ Returns the index of {\it obj} within the list or {\tt wxNOT\_FOUND} if \membersection{wxList::Insert}\label{wxlistinsert} -\func{wxList::compatibility_iterator}{Insert}{\param{T *}{object}} +\func{wxList::compatibility\_iterator}{Insert}{\param{T *}{object}} Insert object at the front of list. -\func{wxList::compatibility_iterator}{Insert}{\param{size\_t }{position}, \param{T *}{object}} +\func{wxList::compatibility\_iterator}{Insert}{\param{size\_t }{position}, \param{T *}{object}} Insert object before {\it position}, i.e. the index of the new item in the list will be equal to {\it position}. {\it position} should be less than or equal to \helpref{GetCount}{wxlistgetcount}; if it is equal to it, this is the same as calling \helpref{Append}{wxlistappend}. -\func{wxList::compatibility_iterator}{Insert}{\param{compatibility_iterator}{iter}, \param{T *}{object}} +\func{wxList::compatibility\_iterator}{Insert}{\param{compatibility\_iterator}{iter}, \param{T *}{object}} Inserts the object before the object refered to be {\it iter}. @@ -213,20 +214,20 @@ 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} -\constfunc{wxList::compatibility_iterator}{Item}{\param{size\_t }{index}} +\constfunc{wxList::compatibility\_iterator}{Item}{\param{size\_t }{index}} Returns the iterator refering to the object at the given {\tt index} in the list. \membersection{wxList::Member}\label{wxlistmember} -\constfunc{wxList::compatibility_iterator}{Member}{\param{T *}{ object}} +\constfunc{wxList::compatibility\_iterator}{Member}{\param{T *}{ object}} {\bf NB:} This function is deprecated, use \helpref{Find}{wxlistfind} instead. \membersection{wxList::Nth}\label{wxlistnth} -\constfunc{wxList::compatibility_iterator}{Nth}{\param{int }{n}} +\constfunc{wxList::compatibility\_iterator}{Nth}{\param{int }{n}} {\bf NB:} This function is deprecated, use \helpref{Item}{wxlistitemfunc} instead.