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.
-Using many of wxListCtrl is shown in the
+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
\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}.
\twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.}
\twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.}
\twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.}
+\twocolitem{{\bf EVT\_LIST\_ITEM\_RIGHT\_CLICK(id, func)}}{An item has been right-clicked.}
\end{twocollist}%
\wxheading{See also}
\twocolitem{wxLIST\_ALIGN\_SNAP\_TO\_GRID}{Snap to grid.}
\end{twocollist}
+\membersection{wxListCtrl::AssignImageList}\label{wxlistctrlassignimagelist}
+
+\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}
+
+Sets the image list associated with the control and
+takes ownership of it (i.e. the control will, unlike when using
+SetImageList, delete the list when destroyed). {\it which} is one of
+wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented).
+
+\wxheading{See also}
+
+\helpref{wxListCtrl::SetImageList}{wxlistctrlsetimagelist}
+
\membersection{wxListCtrl::Create}\label{wxlistctrlcreate}
\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\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
+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.
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 ( ;; )
\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}
Sets the image list associated with the control. {\it which} is one of
wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented).
+This method does not take ownership of the image list, you have to
+delete it yourself.
+
+\wxheading{See also}
+
+\helpref{wxListCtrl::AssignImageList}{wxlistctrlassignimagelist}
+
+
\membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
\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:
\func{bool}{SortItems}{\param{wxListCtrlCompare }{fnSortCallBack}, \param{long }{data}}
-Call this function to sorts the items in the list control. Sorting is done
+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:
\wxheading{Parameters}
\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.}
Notice that the control may only be sorted on client data associated with the
Please see the \helpref{listctrl sample}{samplelistctrl} for an example of
using this 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