From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Tue, 25 Jan 2000 16:57:19 +0000 (+0000)
Subject: documented GetNextItem() behaviour precisely
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/8e21d9ad05231bdd45829fc0f436af32c9e3fe88

documented GetNextItem() behaviour precisely


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5656 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index ed9e3f49e0..ece9d30ad6 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -316,10 +316,28 @@ Gets the item text for this item.
 
 \constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}}
 
-Searches for an item with the given goemetry or state, starting from {\it item}. {\it item} can be -1
-to find the first item that matches the specified flags.
-
-Returns the item or -1 if unsuccessful.
+Searches for an item with the given goemetry or state, starting from 
+{\it item} but excluding the {\it item} itself. If {\it item} is -1,
+the first item that matches the specified flags will be returned.
+
+Returns the first item with given state following {\it item} or -1 if
+no such item found.
+
+This function may be used to find all selected items in the control like this:
+\begin{verbatim}
+    long item = -1;
+    for ( ;; )
+    {
+        item = listctrl->GetNextItem(item,
+                                     wxLIST_NEXT_ALL,
+                                     wxLIST_STATE_SELECTED);
+        if ( item == -1 )
+            break;
+
+        // this item is selected - do whatever is needed with it
+        wxLogMessage("Item %ld is selected."), item);
+    }
+\end{verbatim}
 
 {\it geometry} can be one of:
 
@@ -332,6 +350,9 @@ Returns the item or -1 if unsuccessful.
 \twocolitem{wxLIST\_NEXT\_RIGHT}{Searches for an item to the right of the specified item.}
 \end{twocollist}
 
+{\bf NB:} this parameters is only supported by wxMSW currently and ignored on
+other platforms.
+
 {\it state} can be a bitlist of the following:
 
 \twocolwidtha{5cm}