X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e21d9ad05231bdd45829fc0f436af32c9e3fe88..fe482327a58c0b477cbe83111b17ad493e2a7eca:/docs/latex/wx/listctrl.tex

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index ece9d30ad6..3305ac71c3 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -1,9 +1,13 @@
 \section{\class{wxListCtrl}}\label{wxlistctrl}
 
-A list control presents lists in a number of formats: list view, report view, icon view
-and small icon view. Elements are numbered from zero.
+A list control presents lists in a number of formats: list view, report view,
+icon view and small icon view. In any case, elements are numbered from zero.
 
-To intercept events from a list control, use the event table macros described in \helpref{wxListEvent}{wxlistevent}.
+Using many of wxListCtrl is shown in the 
+\helpref{corresponding sample}{samplelistctrl}.
+
+To intercept events from a list control, use the event table macros described
+in \helpref{wxListEvent}{wxlistevent}.
 
 \wxheading{Derived from}
 
@@ -254,6 +258,9 @@ Returns the specified image list. {\it which} may be one of:
 Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
 information.
 
+You must call {\it info.SetId()} to se ID of item you're interested in
+before calling this method.
+
 \pythonnote{The wxPython version of this method takes an integer parameter
 for the item ID, and returns the wxListItem object.
 }
@@ -461,7 +468,7 @@ Insert an image/string item.
 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
+\indented{2cm}{\begin{twocollist}\itemsep=0pt
 \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.}
@@ -517,6 +524,8 @@ wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is u
 
 \func{bool}{SetItem}{\param{wxListItem\& }{info}}
 
+\func{long}{SetItem}{\param{long }{index}, \param{int }{col}, \param{const }{wxString\& label}, \param{int }{imageId = -1}}
+
 Sets information about the item.
 
 wxListItem is a class with the following members:
@@ -578,7 +587,6 @@ string or image at a given location.}
 \end{twocollist}}
 }
 
-
 \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata}
 
 \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}
@@ -632,21 +640,31 @@ Sets the whole window style.
 
 \membersection{wxListCtrl::SortItems}\label{wxlistctrlsortitems}
 
-\func{bool}{SortItems}{\param{wxListCtrlCompare }{fn}, \param{long }{data}}
+\func{bool}{SortItems}{\param{wxListCtrlCompare }{fnSortCallBack}, \param{long }{data}}
 
-Sorts the items in the list control.
+Call this function to sorts the items in the list control. Sorting is done
+using the specified {\it fnSortCallBack} function. This function must have the
+following prototype:
 
-fn is a function which takes 3 long arguments: item1, item2, data.
+\begin{verbatim}
+int wxCALLBACK wxListCompareFunction(long item1, long item2, long sortData)
+\end{verbatim}
 
-item1 is the long data associated with a first item (NOT the index).
+It is called each time when the two items must be compared and should return 0
+if the items are equal, negative value if the first item is less than the
+second one and positive value if the first one is greater than the second one
+(the same convention as used by {\tt qsort(3)}).
 
-item2 is the long data associated with a second item (NOT the index).
+\wxheading{Parameters}
 
-data is the same value as passed to SortItems.
+\docparam{item1}{client data associated with the first item ({\bf NOT} the index).}
+\docparam{item2}{client data associated with the second item ({\bf NOT} the index).}
+\docparam{data}{the value passed to SortItems() itself.}
 
-The return value is a negative number if the first item should precede the second
-item, a positive number of the second item should precede the first,
-or zero if the two items are equivalent.
+Notice that the control may only be sorted on client data associated with the
+items, so you {\bf must} use \helpref{SetItemData}{wxlistctrlsetitemdata} if
+you want to be able to sort the items in the control.
 
-data is arbitrary data to be passed to the sort function.
+Please see the \helpref{listctrl sample}{samplelistctrl} for an example of
+using this function.
 
