+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name: listctrl.tex
+%% Purpose: wxListCtrl docs
+%% Author:
+%% Modified by:
+%% Created:
+%% RCS-ID: $Id$
+%% Copyright: (c) wxWidgets
+%% License: wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section{\class{wxListCtrl}}\label{wxlistctrl}
A list control presents lists in a number of formats: list view, report view,
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
+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} or \helpref{OnGetItemColumnImage}{wxlistctrlongetitemcolumnimage} and
\helpref{OnGetItemAttr}{wxlistctrlongetitemattr}) to return the information
-about the items when the control requests it.
+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}.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxLC\_LIST}}{multicolumn list view, with optional small icons.
+\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\_REPORT}}{Single or multicolumn report view, with optional header.}
+\twocolitem{\windowstyle{wxLC\_VIRTUAL}}{The application provides items text on demand. 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. 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. Win32 only. }
-\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.}
\wxheading{See also}
-\helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxTreeCtrl}{wxtreectrl},\rtfsp
-\helpref{wxImageList}{wximagelist}, \helpref{wxListEvent}{wxlistevent},
+\helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListView}{wxlistview}, \helpref{wxListBox}{wxlistbox},\rtfsp
+\helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxImageList}{wximagelist}, \helpref{wxListEvent}{wxlistevent},
\helpref{wxListItem}{wxlistitem}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlconstr}
+
+\membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlctor}
\func{}{wxListCtrl}{\void}
\func{}{wxListCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
+\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxListCtrlNameStr}}
Constructor, creating and showing a list control.
\helpref{wxListCtrl::Create}{wxlistctrlcreate}, \helpref{wxValidator}{wxvalidator}
-\membersection{wxListCtrl::\destruct{wxListCtrl}}
+
+\membersection{wxListCtrl::\destruct{wxListCtrl}}\label{wxlistctrldtor}
\func{void}{\destruct{wxListCtrl}}{\void}
Destructor, destroying the list control.
+
\membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange}
\func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}}
\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
+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).
\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
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
+\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxListCtrlNameStr}}
+
+Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlctor} for further details.
-Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
\membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
\func{bool}{DeleteAllItems}{}
-Deletes all the items in the list control.
+Deletes all 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::DeleteItem}\label{wxlistctrldeleteitem}
\func{bool}{DeleteItem}{\param{long }{item}}
See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
+
\membersection{wxListCtrl::EditLabel}\label{wxlistctrledit}
\func{void}{EditLabel}{\param{long }{item}}
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}
\func{bool}{EnsureVisible}{\param{long }{item}}
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.
+{\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 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 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}}
\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}
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}
\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}}
\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::GetItemFont}\label{wxlistctrlgetitemfont}
+
+\constfunc{wxFont}{GetItemFont}{\param{long }{item}}
+
+Returns the item's font.
+
+
\membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition}
\constfunc{bool}{GetItemPosition}{\param{long }{item}, \param{wxPoint\& }{pos}}
\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}}
-Returns the rectangle representing the item's size and position, in client coordinates.
+Returns the rectangle representing the item's size and position, in physical
+coordinates.
{\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL.
\perlnote{In wxPerl this method takes only the {\bf item} parameter and
returns a Wx::Rect ( or undef ).}
+
+
+\membersection{wxListCtrl::GetSubItemRect}\label{wxlistctrlgetsubitemrect}
+
+\constfunc{bool}{GetSubItemRect}{\param{long }{item}, \param{long }{subItem}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
+
+Returns the rectangle representing the size and position, in physical
+coordinates, of the given subitem, i.e. the part of the row \arg{item} in the
+column \arg{subItem}.
+
+This method is only meaningfull when the wxListCtrl is in the report mode. If
+\arg{subItem} parameter is equal to the special value
+\texttt{wxLIST\_GETSUBITEMRECT\_WHOLEITEM} the return value is the same as
+for \helpref{GetItemRect}{wxlistctrlgetitemrect}.
+
+\arg{code} can be one of \texttt{wxLIST\_RECT\_BOUNDS},
+\texttt{wxLIST\_RECT\_ICON} or \texttt{wxLIST\_RECT\_LABEL}.
+
+\newsince{2.7.0}
+
+
\membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing}
-\constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}}
+\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.
+
-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::GetItemState}\label{wxlistctrlgetitemstate}
The {\bf stateMask} indicates which state flags are of interest.
+
\membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext}
\constfunc{wxString}{GetItemText}{\param{long }{item}}
Gets the item text for this item.
+
+\membersection{wxListCtrl::GetItemTextColour}\label{wxlistctrlgetitemtextcolour}
+
+\constfunc{wxColour}{GetItemTextColour}{\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).
+
+
\membersection{wxListCtrl::GetNextItem}\label{wxlistctrlgetnextitem}
\constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}}
break;
// this item is selected - do whatever is needed with it
- wxLogMessage("Item %ld is selected."), item);
+ wxLogMessage("Item %ld is selected.", item);
}
\end{verbatim}
\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
+{\bf NB:} this parameter is only supported by wxMSW currently and ignored on
other platforms.
{\it state} can be a bitlist of the following:
\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}
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}}
+\constfunc{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}, \param{long *}{ptrSubItem}}
Determines which item (if any) is at the specified point,
-giving details in {\it flags}. {\it flags} will be a combination of the following flags:
+giving details in {\it flags}. Returns index of the item or {\tt wxNOT\_FOUND}
+if no item is at the specified point.
+{\it flags} will be a combination of the following flags:
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
wxLIST\_HITTEST\_ONITEMSTATEICON.}
\end{twocollist}
+If \arg{ptrSubItem} is not \NULL and the wxListCtrl is in the report
+mode the subitem (or column) number will also be provided.
+This feature is only available in version 2.7.0 or higher and is currently only
+implemented under wxMSW and requires at least comctl32.dll of verion 4.70 on
+the host system or the value stored in \arg{ptrSubItem} will be always -1. To
+compile this feature into wxWidgets library you need to have access to
+commctrl.h of version 4.70 that is provided by Microsoft.
+
\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.}
+\twocolitem{{\bf InsertColumnItem(col, item)}}{Creates a column using a
+wxListItem.}
\end{twocollist}}
}
+
\membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
\func{long}{InsertItem}{\param{wxListItem\& }{info}}
\end{twocollist}
}}
+
\membersection{wxListCtrl::OnGetItemAttr}\label{wxlistctrlongetitemattr}
-\func{virtual wxListItemAttr *}{OnGetItemAttr}{\param{long }{item}}
+\constfunc{virtual wxListItemAttr *}{OnGetItemAttr}{\param{long }{item}}
-This function may be overloaded in the derived class for a control with
+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.
+wxListCtrl will not delete the pointer or keep a reference of it. You can
+return the same wxListItemAttr pointer for every OnGetItemAttr call.
+
The base class version always returns {\tt NULL}.
\wxheading{See also}
\helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
+\helpref{OnGetItemColumnImage}{wxlistctrlongetitemcolumnimage},\\
\helpref{OnGetItemText}{wxlistctrlongetitemtext}
+
\membersection{wxListCtrl::OnGetItemImage}\label{wxlistctrlongetitemimage}
-\func{virtual int}{OnGetItemImage}{\param{long }{item}}
+\constfunc{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}
+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.
+In a control with {\tt wxLC\_REPORT} style, OnGetItemImage only gets called for
+the first column of each line.
The base class version always returns $-1$.
\wxheading{See also}
\helpref{OnGetItemText}{wxlistctrlongetitemtext},\\
+\helpref{OnGetItemColumnImage}{wxlistctrlongetitemcolumnimage},\\
+\helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
+
+\membersection{wxListCtrl::OnGetItemColumnImage}\label{wxlistctrlongetitemcolumnimage}
+
+\constfunc{virtual int}{OnGetItemColumnImage}{\param{long }{item}, \param{long }{column}}
+
+Overload this function in the derived class for a control with
+{\tt wxLC\_VIRTUAL} and {\tt wxLC\_REPORT} styles in order to specify the image
+index for the given line and column.
+
+The base class version always calls OnGetItemImage for the first column, else
+it returns $-1$.
+
+\wxheading{See also}
+
+\helpref{OnGetItemText}{wxlistctrlongetitemtext},\\
+\helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
\helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
\membersection{wxListCtrl::OnGetItemText}\label{wxlistctrlongetitemtext}
-\func{virtual wxString}{OnGetItemText}{\param{long }{item}, \param{long }{column}}
+\constfunc{virtual wxString}{OnGetItemText}{\param{long }{item}, \param{long }{column}}
-This function {\bf must} be overloaded in the derived class for a control with
+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}.
\helpref{SetItemCount}{wxlistctrlsetitemcount},\\
\helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
+\helpref{OnGetItemColumnImage}{wxlistctrlongetitemcolumnimage},\\
\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.
+{\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}
Sets the background colour (GetBackgroundColour already implicit in
wxWindow class).
+
\membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn}
\func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
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}}
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}}
\helpref{wxListCtrl::AssignImageList}{wxlistctrlassignimagelist}
+
\membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
\func{bool}{SetItem}{\param{wxListItem\& }{info}}
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. Win32 only. }
\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state. Win32 only. }
\end{twocollist}
+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.
+
\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.
\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}}
\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::SetItemFont}\label{wxlistctrlsetitemfont}
+
+\func{void}{SetItemFont}{\param{long }{item}, \param{const wxFont\& }{font}}
+
+Sets the item's font.
+
+
\membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage}
+\func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}}
+
+Sets the image associated with the item. The image is an index into the
+image list associated with the list control. In report view, this only sets
+the image for the first column.
+
\func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}}
Sets the unselected and selected images associated with the item. The images are indices into the
-image list associated with the list control.
+image list associated with the list control. This form is deprecated: {\it selImage} is not
+used.
+
+
+\membersection{wxListCtrl::SetItemColumnImage}\label{wxlistctrlsetitemcolumnimage}
+
+\func{bool}{SetItemImage}{\param{long }{item}, \param{long }{column}\param{int }{image}}
+
+Sets the image associated with the item. In report view, you can specify the column.
+The image is an index 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.
+Sets the position of the item, in icon or small icon view. Windows only.
+
\membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate}
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}
parameters.}
\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.}
+however, you may use a closure to achieve an effect similar to the
+SortItems third parameter.}
projects / wxWidgets.git / blobdiff