X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..35d367d8dd6742bb24ed519622629b89a3e55aaf:/docs/latex/wx/listctrl.tex diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index ea672c9b25..fbe8e5b396 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} @@ -26,15 +30,17 @@ the list wraps, unlike a wxListBox.} \twocolitem{\windowstyle{wxLC\_REPORT}}{single or multicolumn report view, with optional header.} \twocolitem{\windowstyle{wxLC\_ICON}}{Large icon view, with optional labels.} \twocolitem{\windowstyle{wxLC\_SMALL\_ICON}}{Small icon view, with optional labels.} -\twocolitem{\windowstyle{wxLC\_ALIGN\_TOP}}{Icons align to the top (default).} -\twocolitem{\windowstyle{wxLC\_ALIGN\_LEFT}}{Icons align to the left.} -\twocolitem{\windowstyle{wxLC\_AUTOARRANGE}}{Icons arrange themselves.} -\twocolitem{\windowstyle{wxLC\_USER\_TEXT}}{The application provides label text on demand, except for column headers.} +\twocolitem{\windowstyle{wxLC\_ALIGN\_TOP}}{Icons align to the top. Win32 default, Win32 only. } +\twocolitem{\windowstyle{wxLC\_ALIGN\_LEFT}}{Icons align to the left. } +\twocolitem{\windowstyle{wxLC\_AUTOARRANGE}}{Icons arrange themselves. Win32 only. } +\twocolitem{\windowstyle{wxLC\_USER\_TEXT}}{The application provides label text on demand, except for column headers. Win32 only. } \twocolitem{\windowstyle{wxLC\_EDIT\_LABELS}}{Labels are editable: the application will be notified when editing starts.} -\twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode.} +\twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode. Win32 only. } \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}. @@ -48,17 +54,19 @@ functions that take a \helpref{wxListEvent}{wxlistevent} argument. \begin{twocollist}\itemsep=0pt \twocolitem{{\bf EVT\_LIST\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.} \twocolitem{{\bf EVT\_LIST\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.} -\twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label.} -\twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label.} +\twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} +\twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} \twocolitem{{\bf EVT\_LIST\_DELETE\_ITEM(id, func)}}{Delete an item.} \twocolitem{{\bf EVT\_LIST\_DELETE\_ALL\_ITEMS(id, func)}}{Delete all items.} \twocolitem{{\bf EVT\_LIST\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.} \twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).} \twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.} \twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.} +\twocolitem{{\bf EVT\_LIST\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).} \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} @@ -111,7 +119,7 @@ Destructor, destroying the list control. \func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}} -Arranges the items in icon or small icon view. {\it flag} is one of: +Arranges the items in icon or small icon view. This only has effect on Win32. {\it flag} is one of: \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt @@ -121,6 +129,19 @@ Arranges the items in icon or small icon view. {\it flag} is one of: \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 @@ -129,29 +150,48 @@ Arranges the items in icon or small icon view. {\it flag} is one of: Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details. +\membersection{wxListCtrl::ClearAll}\label{wxlistctrlclearall} + +\func{void}{ClearAll}{} + +Deletes all items and all columns. + \membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem} \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} -\func{bool}{DeleteAllItems}{\void} +\func{bool}{DeleteAllItems}{} 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}} Deletes a column. -\membersection{wxListCtrl::Edit}\label{wxlistctrledit} +\membersection{wxListCtrl::EditLabel}\label{wxlistctrledit} -\func{wxTextCtrl\&}{Edit}{\param{long }{item}} +\func{void}{EditLabel}{\param{long }{item}} -Starts editing a label. +Starts editing the label of the given item. This function generates a +EVT\_LIST\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no +text control will appear for in-place editing. + +If the user changed the label (i.e. s/he does not press ESC or leave +the text control without changes, a EVT\_LIST\_END\_LABEL\_EDIT event +will be sent which can be vetoed as well. \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible} @@ -176,6 +216,15 @@ the beginning if 'start' is -1. Find an item nearest this position in the specified direction, starting from 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)}}{} +\end{twocollist}} +} + \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn} \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}} @@ -224,6 +273,13 @@ 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, an optional integer for the column number, and +returns the wxListItem object. } + \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata} \constfunc{long}{GetItemData}{\param{long }{item}} @@ -236,6 +292,9 @@ Gets the application-defined data associated with this item. Returns the position of the item, in icon or small icon view. +\pythonnote{The wxPython version of this method accepts only the item +ID and returns the wxPoint.} + \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect} \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}} @@ -244,6 +303,9 @@ Returns the rectangle representing the item's size and position, in client coord {\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 code and returns the wxRect.} + \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}} @@ -276,10 +338,29 @@ 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. +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: @@ -292,6 +373,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} @@ -344,6 +428,10 @@ giving details in {\it flags}. {\it flags} will be a combination of the followin wxLIST\_HITTEST\_ONITEMSTATEICON.} \end{twocollist} +\pythonnote{A tuple of values is returned in the wxPython version of +this method. The first value is the item id and the second is the +flags value mentioned above.} + \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} \func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}} @@ -355,6 +443,16 @@ For list view mode (only), inserts a column. For more details, see \helpref{wxLi For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. +\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, +width=-1)}}{Creates a column using a header string only.} +\twocolitem{{\bf InsertColumnInfo(col, item)}}{Creates a column using a +wxListInfo.} +\end{twocollist}} +} + \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem} \func{long}{InsertItem}{\param{wxListItem\& }{info}} @@ -384,6 +482,16 @@ Insert an image/string item. \docparam{imageIndex}{index into the image list associated with this control and view style} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\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.} +\twocolitem{{\bf InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.} +\end{twocollist}} +} + \membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist} \func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}} @@ -416,6 +524,8 @@ information. Sets the column width. {\it width} can be a width in pixels or wxLIST\_AUTOSIZE (-1) or wxLIST\_AUTOSIZE\_USEHEADER (-2). +wxLIST\_AUTOSIZE will resize the column to the length of its longest item. wxLIST\_AUTOSIZE\_USEHEADER +will resize the column to the length of the header (Win32) or 80 pixels (other platforms). In small or normal icon view, {\it col} must be -1, and the column width is set for all columns. @@ -426,10 +536,20 @@ In small or normal icon view, {\it col} must be -1, and the column width is set 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: @@ -463,19 +583,34 @@ 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.} -\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event.} +\twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is. Win32 only. } +\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event. Win32 only. } \twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.} \twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.} -\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state.} +\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state. Win32 only. } \end{twocollist} \func{long}{SetItem}{\param{long }{index}, \param{int }{col}, \param{const wxString\& }{label}, \param{int }{imageId = -1}} 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 +string or image at a given location.} +\end{twocollist}} +} + \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata} \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}} @@ -529,21 +664,38 @@ 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 sort the items in the list control. Sorting is done +using the specified {\it fnSortCallBack} function. This function must have the +following prototype: + +\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.}