X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/884360bc11fe926bf91b23215bae719b562df91b..f1e7793361bb0106611e5d1373b4e1e6ed30f14f:/docs/latex/wx/listctrl.tex diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index 50ff163bcd..b155fcc185 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -1,9 +1,31 @@ \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. - -To intercept events from a list control, use the event table macros described in \helpref{wxListEvent}{wxlistevent}. +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. +For all these modes, the items are stored in the control and must be added to +it using \helpref{InsertItem}{wxlistctrlinsertitem} method. + +A special case of report view quite different from the other modes of the list +control is a virtual control in which the items data (including text, images +and attributes) is managed by the main program and is requested by the control +itself only when needed which allows to have controls with millions of items +without consuming much memory. To use virtual list control you must use +\helpref{SetItemCount}{wxlistctrlsetitemcount} first and overload at least +\helpref{OnGetItemText}{wxlistctrlongetitemtext} (and optionally +\helpref{OnGetItemImage}{wxlistctrlongetitemimage} and +\helpref{OnGetItemAttr}{wxlistctrlongetitemattr}) to return the information +about the items when the control requests it. Virtual list control can be used +as a normal one except that no operations which can take time proportional to +the number of items in the control happen -- this is required to allow having a +practically infinite number of items. For example, in a multiple selection +virtual list control, the selections won't be sent when many items are selected +at once because this could mean iterating over all the items. + +Using many of wxListCtrl features 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} @@ -12,36 +34,76 @@ To intercept events from a list control, use the event table macros described in \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} -\twocolwidtha{5cm} +\twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxLC\_LIST}}{multicolumn list view, with optional small icons. Columns are computed automatically, i.e. you don't set columns as in wxLC\_REPORT. In other words, the list wraps, unlike a wxListBox.} \twocolitem{\windowstyle{wxLC\_REPORT}}{single or multicolumn report view, with optional header.} +\twocolitem{\windowstyle{wxLC\_VIRTUAL}}{virtual control, may only be used with wxLC\_REPORT} \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\_VIRTUAL}}{The application provides items text on demand.} \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\_SINGLE\_SEL}}{Single selection.} +\twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode. } +\twocolitem{\windowstyle{wxLC\_SINGLE\_SEL}}{Single selection (default is multiple).} \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}. +\wxheading{Event handling} + +To process input from a list control, use these event handler macros to direct input to member +functions that take a \helpref{wxListEvent}{wxlistevent} argument. + +\twocolwidtha{7cm} +\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. 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\_ITEM\_FOCUSED(id, func)}}{The currently focused item has changed.} +\twocolitem{{\bf EVT\_LIST\_ITEM\_MIDDLE\_CLICK(id, func)}}{The middle mouse button has been clicked on an item.} +\twocolitem{{\bf EVT\_LIST\_ITEM\_RIGHT\_CLICK(id, func)}}{The right mouse button has been clicked on an item.} +\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\_COL\_RIGHT\_CLICK(id, func)}}{A column ({\bf m\_col}) has been right-clicked.} +\twocolitem{{\bf EVT\_LIST\_COL\_BEGIN\_DRAG(id, func)}}{The user started resizing a column - can be vetoed.} +\twocolitem{{\bf EVT\_LIST\_COL\_DRAGGING(id, func)}}{The divider between columns is being dragged.} +\twocolitem{{\bf EVT\_LIST\_COL\_END\_DRAG(id, func)}}{A column has been resized by the user.} +\twocolitem{{\bf EVT\_LIST\_CACHE\_HINT(id, func)}}{Prepare cache for a virtual list control} +\end{twocollist}% + \wxheading{See also} \helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxTreeCtrl}{wxtreectrl},\rtfsp -\helpref{wxImageList}{wximagelist}, \helpref{wxListEvent}{wxlistevent} +\helpref{wxImageList}{wximagelist}, \helpref{wxListEvent}{wxlistevent}, +\helpref{wxListItem}{wxlistitem} \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlconstr} \func{}{wxListCtrl}{\void} @@ -75,17 +137,19 @@ appropriately.} \helpref{wxListCtrl::Create}{wxlistctrlcreate}, \helpref{wxValidator}{wxvalidator} + \membersection{wxListCtrl::\destruct{wxListCtrl}} \func{void}{\destruct{wxListCtrl}}{\void} Destructor, destroying the list control. + \membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange} \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 @@ -95,6 +159,28 @@ 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::ClearAll}\label{wxlistctrlclearall} + +\func{void}{ClearAll}{} + +Deletes all items and all columns. + + \membersection{wxListCtrl::Create}\label{wxlistctrlcreate} \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp @@ -103,29 +189,47 @@ 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::DeleteItem}\label{wxlistctrldeleteitem} - -\func{bool}{DeleteItem}{\param{long }{item}} - -Deletes the specified item. \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} -\func{wxTextCtrl\&}{Edit}{\param{long }{item}} +\membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem} + +\func{bool}{DeleteItem}{\param{long }{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::EditLabel}\label{wxlistctrledit} + +\func{void}{EditLabel}{\param{long }{item}} + +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. -Starts editing a label. \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible} @@ -133,22 +237,42 @@ Starts editing a label. Ensures this item is visible. + \membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem} -\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = FALSE}} +\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = false}} -Find an item whose label matches this string, starting from the item after {\it start} or +Find an item whose label matches this string, starting from {\it start} or the beginning if {\it start} is -1. \func{long}{FindItem}{\param{long }{start}, \param{long }{data}} -Find an item whose data matches this data, starting from the item after {\it start} or +Find an item whose data matches this data, starting from {\it start} or the beginning if 'start' is -1. \func{long}{FindItem}{\param{long }{start}, \param{const wxPoint\& }{pt}, \param{int }{direction}} -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. +Find an item nearest this position in the specified direction, starting from +{\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}} +} + +\perlnote{In wxPerl there are three methods instead of a single overloaded +method:\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} @@ -157,12 +281,24 @@ the item after {\it start} or the beginning if {\it start} is -1. Gets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more information. +\perlnote{In wxPerl this method takes only the {\bf col} parameter and + returns a Wx::ListItem ( or undef ).} + + +\membersection{wxListCtrl::GetColumnCount}\label{wxlistctrlgetcolumncount} + +\constfunc{int}{GetColumnCount}{\void} + +Returns the number of columns. + + \membersection{wxListCtrl::GetColumnWidth}\label{wxlistctrlgetcolumnwidth} \constfunc{int}{GetColumnWidth}{\param{int }{col}} Gets the column width (report view only). + \membersection{wxListCtrl::GetCountPerPage}\label{wxlistctrlgetcountperpage} \constfunc{int}{GetCountPerPage}{\void} @@ -172,11 +308,16 @@ visible area of the list control (list or report view) or the total number of items in the list control (icon or small icon view). + \membersection{wxListCtrl::GetEditControl}\label{wxlistctrlgeteditcontrol} -\constfunc{wxTextCtrl\&}{GetEditControl}{\void} +\constfunc{wxTextCtrl *}{GetEditControl}{\void} + +Returns the edit control being currently used to edit a label. Returns {\tt NULL} +if no label is being edited. + +{\bf NB:} It is currently only implemented for wxMSW. -Gets the edit control for editing labels. \membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist} @@ -191,6 +332,7 @@ Returns the specified image list. {\it which} may be one of: \twocolitem{\windowstyle{wxIMAGE\_LIST\_STATE}}{The user-defined state image list (unimplemented).} \end{twocollist} + \membersection{wxListCtrl::GetItem}\label{wxlistctrlgetitem} \constfunc{bool}{GetItem}{\param{wxListItem\& }{info}} @@ -198,18 +340,57 @@ 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 the 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.} + +\perlnote{In wxPerl this method takes as parameter the {\bf ID} of the item +and ( optionally ) the column, and returns a Wx::ListItem object.} + + +\membersection{wxListCtrl::GetItemBackgroundColour}\label{wxlistctrlgetitembackgroundcolour} + +\constfunc{wxColour}{GetItemBackgroundColour}{\param{long }{item}} + +Returns the colour for this item. If the item has no specific colour, returns +an invalid colour (and not the default background control of the control +itself). + +\wxheading{See also} + +\helpref{GetItemTextColour}{wxlistctrlgetitemtextcolour} + + +\membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount} + +\constfunc{int}{GetItemCount}{\void} + +Returns the number of items in the list control. + + \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata} \constfunc{long}{GetItemData}{\param{long }{item}} Gets the application-defined data associated with this item. + \membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition} \constfunc{bool}{GetItemPosition}{\param{long }{item}, \param{wxPoint\& }{pos}} 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.} + +\perlnote{In wxPerl this method takes only the {\bf item} parameter and +returns a Wx::Point ( or undef ).} + + \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect} \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}} @@ -218,6 +399,24 @@ 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.} + +\perlnote{In wxPerl this method takes only the {\bf item} parameter and +returns a Wx::Rect ( or undef ).} + + + +\membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing} + +\constfunc{wxSize}{GetItemSpacing}{\void} + +Retrieves the spacing between icons in pixels: horizontal spacing is returned +as \texttt{x} component of the \helpref{wxSize}{wxsize} object and the vertical +spacing as its \texttt{y} component. + + + \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}} @@ -226,34 +425,52 @@ Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem The {\bf stateMask} indicates which state flags are of interest. -\membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount} -\constfunc{int}{GetItemCount}{\void} +\membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext} -Returns the number of items in the list control. +\constfunc{wxString}{GetItemText}{\param{long }{item}} -\membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing} +Gets the item text for this item. -\constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}} -Retrieves the spacing between icons in pixels. -If {\it small} is TRUE, gets the spacing for the small icon -view, otherwise the large icon view. +\membersection{wxListCtrl::GetItemTextColour}\label{wxlistctrlgetitemtextcolour} -\membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext} +\constfunc{wxColour}{GetItemTextColour}{\param{long }{item}} -\constfunc{wxString}{GetItemText}{\param{long }{item}} +Returns the colour for this item. If the item has no specific colour, returns +an invalid colour (and not the default foreground control of the control itself +as this wouldn't allow distinguishing between items having the same colour as +the current control foreground and items with default colour which, hence, have +always the same colour as the control). -Gets the item text for this item. \membersection{wxListCtrl::GetNextItem}\label{wxlistctrlgetnextitem} \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 geometry 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; -Returns the item or -1 if unsuccessful. + // this item is selected - do whatever is needed with it + wxLogMessage("Item %ld is selected."), item); + } +\end{verbatim} {\it geometry} can be one of: @@ -266,6 +483,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} @@ -277,18 +497,21 @@ Returns the item or -1 if unsuccessful. \twocolitem{wxLIST\_STATE\_CUT}{The item is selected as part of a cut and paste operation.} \end{twocollist} + \membersection{wxListCtrl::GetSelectedItemCount}\label{wxlistctrlgetselecteditemcount} \constfunc{int}{GetSelectedItemCount}{\void} Returns the number of selected items in the list control. + \membersection{wxListCtrl::GetTextColour}\label{wxlistctrlgettextcolour} \constfunc{wxColour}{GetTextColour}{\void} Gets the text colour of the list control. + \membersection{wxListCtrl::GetTopItem}\label{wxlistctrlgettopitem} \constfunc{long}{GetTopItem}{\void} @@ -296,6 +519,21 @@ Gets the text colour of the list control. Gets the index of the topmost visible item when in list or report view. + + +\membersection{wxListCtrl::GetViewRect}\label{wxlistctrlgetviewrect} + +\constfunc{wxRect}{GetViewRect}{\void} + +Returns the rectangle taken by all items in the control. In other words, if the +controls client size were equal to the size of this rectangle, no scrollbars +would be needed and no free space would be left. + +Note that this function only works in the icon and small icon views, not in +list or report views (this is a limitation of the native Win32 control). + + + \membersection{wxListCtrl::HitTest}\label{wxlistctrlhittest} \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}} @@ -318,16 +556,33 @@ 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.} + +\perlnote{In wxPerl this method only takes the {\bf point} parameter + and returns a 2-element list {\tt ( item, flags )}.} + + \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} \func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}} -For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. - \func{long}{InsertColumn}{\param{long }{col}, \param{const wxString\& }{heading}, \param{int }{format = wxLIST\_FORMAT\_LEFT},\rtfsp \param{int }{width = -1}} -For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. +For report 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} @@ -358,16 +613,115 @@ 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}} +} + +\perlnote{In wxPerl there are four methods instead of a single overloaded +method:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf InsertItem( item )}}{Inserts a Wx::ListItem} +\twocolitem{{\bf InsertStringItem( index, label )}}{Inserts a string item} +\twocolitem{{\bf InsertImageItem( index, imageIndex )}}{Inserts an image item} +\twocolitem{{\bf InsertImageStringItem( index, label, imageIndex )}}{Inserts + an item with a string and an image} +\end{twocollist} +}} + + +\membersection{wxListCtrl::OnGetItemAttr}\label{wxlistctrlongetitemattr} + +\func{virtual wxListItemAttr *}{OnGetItemAttr}{\param{long }{item}} + +This function may be overloaded in the derived class for a control with +{\tt wxLC\_VIRTUAL} style. It should return the attribute for the +for the specified {\tt item} or {\tt NULL} to use the default appearance +parameters. + +The base class version always returns {\tt NULL}. + +\wxheading{See also} + +\helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\ +\helpref{OnGetItemText}{wxlistctrlongetitemtext} + + +\membersection{wxListCtrl::OnGetItemImage}\label{wxlistctrlongetitemimage} + +\func{virtual int}{OnGetItemImage}{\param{long }{item}} + +This function must be overloaded in the derived class for a control with +{\tt wxLC\_VIRTUAL} style having an \helpref{image list}{wxlistctrlsetimagelist} +(if the control doesn't have an image list, it is not necessary to overload + it). It should return the index of the items image in the controls image list +or $-1$ for no image. + +The base class version always returns $-1$. + +\wxheading{See also} + +\helpref{OnGetItemText}{wxlistctrlongetitemtext},\\ +\helpref{OnGetItemAttr}{wxlistctrlongetitemattr} + + +\membersection{wxListCtrl::OnGetItemText}\label{wxlistctrlongetitemtext} + +\func{virtual wxString}{OnGetItemText}{\param{long }{item}, \param{long }{column}} + +This function {\bf must} be overloaded in the derived class for a control with +{\tt wxLC\_VIRTUAL} style. It should return the string containing the text of +the given {\it column} for the specified {\tt item}. + +\wxheading{See also} + +\helpref{SetItemCount}{wxlistctrlsetitemcount},\\ +\helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\ +\helpref{OnGetItemAttr}{wxlistctrlongetitemattr} + + +\membersection{wxListCtrl::RefreshItem}\label{wxlistctrlrefreshitem} + +\func{void}{RefreshItem}{\param{long }{item}} + +Redraws the given {\it item}. This is only useful for the virtual list controls +as without calling this function the displayed value of the item doesn't change +even when the underlying data does change. + +\wxheading{See also} + +\helpref{RefreshItems}{wxlistctrlrefreshitems} + + + +\membersection{wxListCtrl::RefreshItems}\label{wxlistctrlrefreshitems} + +\func{void}{RefreshItems}{\param{long }{itemFrom}, \param{long }{itemTo}} + +Redraws the items between {\it itemFrom} and {\it itemTo}. The starting item +must be less than or equal to the ending one. + +Just as \helpref{RefreshItem}{wxlistctrlrefreshitem} this is only useful for +virtual list controls. + + + \membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist} \func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}} -Scrolls the list control. If in icon, small icon or report view mode, -dx specifies the number of pixels to scroll. If in list view mode, dx -specifies the number of columns to scroll. +Scrolls the list control. If in icon, small icon or report view mode, +{\it dx} specifies the number of pixels to scroll. If in list view mode, +{\it dx} specifies the number of columns to scroll. {\it dy} always specifies +the number of pixels to scroll vertically. + +{\bf NB:} This method is currently only implemented in the Windows version. -If in icon, small icon or list view mode, dy specifies the number of pixels -to scroll. If in report view mode, dy specifies the number of lines to scroll. \membersection{wxListCtrl::SetBackgroundColour}\label{wxlistctrlsetbackgroundcolour} @@ -376,6 +730,7 @@ to scroll. If in report view mode, dy specifies the number of lines to scroll. Sets the background colour (GetBackgroundColour already implicit in wxWindow class). + \membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn} \func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}} @@ -383,6 +738,7 @@ wxWindow class). Sets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more information. + \membersection{wxListCtrl::SetColumnWidth}\label{wxlistctrlsetcolumnwidth} \func{bool}{SetColumnWidth}{\param{int }{col}, \param{int }{width}} @@ -390,9 +746,12 @@ 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. + \membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist} \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}} @@ -400,10 +759,21 @@ 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: @@ -437,25 +807,63 @@ 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::SetItemBackgroundColour}\label{wxlistctrlsetitembackgroundcolour} + +\func{void}{SetItemBackgroundColour}{\param{long }{item}, \param{const wxColour\& }{col}} + +Sets the background colour for this item. This function only works in report view. + +The colour can be retrieved using +\helpref{GetItemBackgroundColour}{wxlistctrlgetitembackgroundcolour}. + + + +\membersection{wxListCtrl::SetItemCount}\label{wxlistctrlsetitemcount} + +\func{void}{SetItemCount}{\param{long }{count}} + +This method can only be used with virtual list controls. It is used to indicate +to the control the number of items it contains. After calling it, the main +program should be ready to handle calls to various item callbacks (such as +\helpref{OnGetItemText}{wxlistctrlongetitemtext}) for all items in the range +from $0$ to {\it count}. + + \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata} \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}} Associates application-defined data with this item. + \membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage} \func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}} @@ -463,12 +871,14 @@ Associates application-defined data with this item. Sets the unselected and selected images associated with the item. The images are indices into the image list associated with the list control. + \membersection{wxListCtrl::SetItemPosition}\label{wxlistctrlsetitemposition} \func{bool}{SetItemPosition}{\param{long }{item}, \param{const wxPoint\& }{pos}} Sets the position of the item, in icon or small icon view. + \membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate} \func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}} @@ -477,47 +887,82 @@ Sets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem The {\bf stateMask} indicates which state flags are valid. + \membersection{wxListCtrl::SetItemText}\label{wxlistctrlsetitemtext} \func{void}{SetItemText}{\param{long }{item}, \param{const wxString\& }{text}} Sets the item text for this item. + +\membersection{wxListCtrl::SetItemTextColour}\label{wxlistctrlsetitemtextcolour} + +\func{void}{SetItemTextColour}{\param{long }{item}, \param{const wxColour\& }{col}} + +Sets the colour for this item. This function only works in report view. + +The colour can be retrieved using +\helpref{GetItemTextColour}{wxlistctrlgetitemtextcolour}. + + \membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle} -\func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = TRUE}} +\func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = true}} Adds or removes a single window style. + \membersection{wxListCtrl::SetTextColour}\label{wxlistctrlsettextcolour} \func{void}{SetTextColour}{\param{const wxColour\& }{col}} Sets the text colour of the list control. + \membersection{wxListCtrl::SetWindowStyleFlag}\label{wxlistctrlsetwindowstyleflag} \func{void}{SetWindowStyleFlag}{\param{long }{style}} -Sets the whole window style. +Sets the whole window style, deleting all items. \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: + +\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} -Sorts the items in the list control. +\docparam{item1}{client data associated with the first item ({\bf NOT} the index).} -fn is a function which takes 3 long arguments: item1, item2, data. +\docparam{item2}{client data associated with the second item ({\bf NOT} the index).} -item1 is the long data associated with a first item (NOT the index). +\docparam{data}{the value passed to SortItems() itself.} -item2 is the long data associated with a second item (NOT the index). +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 the same value as passed to SortItems. +Please see the \helpref{listctrl sample}{samplelistctrl} for an example of +using this function. -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. +\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.} -data is arbitrary data to be passed to the sort function. +\perlnote{In wxPerl the comparison function must take just two parameters; + however, you may use a closure to achieve an effect similar to the + SortItems third parameter.}