X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/86e7822245592f36cd04022c15690b226494cb65..f6081a0462089eaa1da4d38b260af032b349a041:/docs/latex/wx/listctrl.tex

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index ba963b06b5..ece9d30ad6 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -140,7 +140,10 @@ Deletes all items and all columns.
 
 \func{bool}{DeleteItem}{\param{long }{item}}
 
-Deletes the specified item.
+Deletes the specified item. This function sends the 
+{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted.
+
+See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
 
 \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
 
@@ -148,6 +151,11 @@ Deletes the specified item.
 
 Deletes all the items in the list control.
 
+{\bf NB:} This function does {\it not} send the 
+{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
+from the control would be too slow then (unlike 
+        \helpref{DeleteItem}{wxlistctrldeleteitem})
+
 \membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
 
 \func{bool}{DeleteColumn}{\param{int }{col}}
@@ -192,9 +200,9 @@ the item after {\it start} or the beginning if {\it start} is -1.
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{FindItem(start, str, partial=FALSE)}}{}
-\twocolitem{\bf{FindItemData(start, data)}}{}
-\twocolitem{\bf{FindItemAtPos(start, point, direction)}}{}
+\twocolitem{{\bf FindItem(start, str, partial=FALSE)}}{}
+\twocolitem{{\bf FindItemData(start, data)}}{}
+\twocolitem{{\bf FindItemAtPos(start, point, direction)}}{}
 \end{twocollist}}
 }
 
@@ -308,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:
 
@@ -324,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}
@@ -394,9 +423,9 @@ For list view mode (only), inserts a column. For more details, see \helpref{wxLi
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{InsertColumn(col, heading, format=wxLIST_FORMAT_LEFT,
+\twocolitem{{\bf InsertColumn(col, heading, format=wxLIST\_FORMAT\_LEFT,
 width=-1)}}{Creates a column using a header string only.}
-\twocolitem{\bf{InsertColumnInfo(col, item)}}{Creates a column using a
+\twocolitem{{\bf InsertColumnInfo(col, item)}}{Creates a column using a
 wxListInfo.}
 \end{twocollist}}
 }
@@ -433,10 +462,10 @@ Insert an image/string item.
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{InsertItem(item)}}{Inserts an item using a wxListItem.}
-\twocolitem{\bf{InsertStringItem(index, label)}}{Inserts a string item.}
-\twocolitem{\bf{InsertImageItem(index, imageIndex)}}{Inserts an image item.}
-\twocolitem{\bf{InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
+\twocolitem{{\bf InsertItem(item)}}{Inserts an item using a wxListItem.}
+\twocolitem{{\bf InsertStringItem(index, label)}}{Inserts a string item.}
+\twocolitem{{\bf InsertImageItem(index, imageIndex)}}{Inserts an image item.}
+\twocolitem{{\bf InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
 \end{twocollist}}
 }
 
@@ -521,6 +550,12 @@ The {\bf m\_mask} member contains a bitlist specifying which of the other fields
 
 The {\bf m\_stateMask} and {\bf m\_state} members take flags from the following:
 
+The wxListItem object can also contain item-specific colour and font
+information: for this you need to call one of SetTextColour(),
+SetBackgroundColour() or SetFont() functions on it passing it the colour/font
+to use. If the colour/font is not specified, the default list control
+colour/font is used.
+
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is. Win32 only. }
@@ -537,8 +572,8 @@ Sets a string field at a particular column.
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
-\twocolitem{\bf{SetItem(item)}}{Sets information about the given wxListItem.}
-\twocolitem{\bf{SetStringItem(index, col, label, imageId)}}{Sets a
+\twocolitem{{\bf SetItem(item)}}{Sets information about the given wxListItem.}
+\twocolitem{{\bf SetStringItem(index, col, label, imageId)}}{Sets a
 string or image at a given location.}
 \end{twocollist}}
 }