\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}
\twocolitem{\windowstyle{wxLC\_SINGLE\_SEL}}{Single selection.}
\twocolitem{\windowstyle{wxLC\_SORT\_ASCENDING}}{Sort in ascending order (must still supply a comparison callback in SortItems.}
\twocolitem{\windowstyle{wxLC\_SORT\_DESCENDING}}{Sort in descending order (must still supply a comparison callback in SortItems.}
+\twocolitem{\windowstyle{wxLC\_HRULES}}{Draws light horizontal rules between rows in report mode.}
+\twocolitem{\windowstyle{wxLC\_VRULES}}{Draws light vertical rules between columns in report mode.}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles}.
\func{bool}{DeleteItem}{\param{long }{item}}
-Deletes the specified item. This function sends the
+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}
Deletes all the items in the list control.
-{\bf NB:} This function does {\it not} send the
+{\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})
+from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}).
\membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn}
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.
-}
+for the item ID, an optional integer for the column number, and
+returns the wxListItem object. }
\membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}
{\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL.
\pythonnote{The wxPython version of this method accepts only the item
-ID and returns the wxRect.}
+ID and code and returns the wxRect.}
\membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
\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.
+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.
-Returns the item or -1 if unsuccessful.
+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:
\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}
\end{twocollist}
\pythonnote{A tuple of values is returned in the wxPython version of
-thsi method. The first value is the item id and the second is the
+this method. The first value is the item id and the second is the
flags value mentioned above.}
\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
\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.}
\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:
\end{twocollist}}
}
-
\membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata}
\func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}
\membersection{wxListCtrl::SortItems}\label{wxlistctrlsortitems}
-\func{bool}{SortItems}{\param{wxListCtrlCompare }{fn}, \param{long }{data}}
+\func{bool}{SortItems}{\param{wxListCtrlCompare }{fnSortCallBack}, \param{long }{data}}
+
+Call this function to sort the items in the list control. Sorting is done
+using the specified {\it fnSortCallBack} function. This function must have the
+following prototype:
-Sorts the items in the list control.
+\begin{verbatim}
+int wxCALLBACK wxListCompareFunction(long item1, long item2, long sortData)
+\end{verbatim}
+
+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)}).
+
+\wxheading{Parameters}
-fn is a function which takes 3 long arguments: item1, item2, data.
+\docparam{item1}{client data associated with the first item ({\bf NOT} the index).}
-item1 is the long data associated with a first item (NOT the index).
+\docparam{item2}{client data associated with the second item ({\bf NOT} the index).}
-item2 is the long data associated with a second item (NOT the index).
+\docparam{data}{the value passed to SortItems() itself.}
-data is the same value as passed to SortItems.
+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.
-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.
+Please see the \helpref{listctrl sample}{samplelistctrl} for an example of
+using this function.
-data is arbitrary data to be passed to the sort function.
+\pythonnote{wxPython uses the sortData parameter to pass the Python
+function to call, so it is not available for programmer use. Call
+SortItems with a reference to a callable object that expects two
+parameters.}
projects / wxWidgets.git / blobdiff