Fixed problem with Calltip tab not refreshing properly on Windows.

[wxWidgets.git] / docs / latex / wx / listctrl.tex

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index f3c0c9b79b9c7a29b3dcd5e36bc91d98ed3531c6..e27e2b56b885c19a824cf543618a60277501b76d 100644 (file)
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -14,7 +14,12 @@ without consuming much memory. To use virtual list control you must use
 \helpref{OnGetItemText}{wxlistctrlongetitemtext} (and optionally 
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage} and 
 \helpref{OnGetItemAttr}{wxlistctrlongetitemattr}) to return the information
 \helpref{OnGetItemText}{wxlistctrlongetitemtext} (and optionally 
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage} 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}.
 
 Using many of wxListCtrl features is shown in the
 \helpref{corresponding sample}{samplelistctrl}.


@@ -47,10 +52,10 @@ the list wraps, unlike a wxListBox.}
 \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\_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\_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\_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.}
 \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.}


@@ -77,7 +82,9 @@ functions that take a \helpref{wxListEvent}{wxlistevent} argument.
 \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\_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\_RIGHT\_CLICK(id, func)}}{An item has been right-clicked.}
+\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\_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.}


@@ -91,10 +98,12 @@ functions that take a \helpref{wxListEvent}{wxlistevent} argument.
 \wxheading{See also}
 
 \helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxTreeCtrl}{wxtreectrl},\rtfsp
 \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}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlconstr}
 
 \func{}{wxListCtrl}{\void}
 \membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlconstr}
 
 \func{}{wxListCtrl}{\void}


@@ -128,12 +137,14 @@ appropriately.}
 
 \helpref{wxListCtrl::Create}{wxlistctrlcreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxListCtrl::Create}{wxlistctrlcreate}, \helpref{wxValidator}{wxvalidator}
 

+

 \membersection{wxListCtrl::\destruct{wxListCtrl}}
 
 \func{void}{\destruct{wxListCtrl}}{\void}
 
 Destructor, destroying the list control.
 
 \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}}
 \membersection{wxListCtrl::Arrange}\label{wxlistctrlarrange}
 
 \func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}}


@@ -148,6 +159,7 @@ Arranges the items in icon or small icon view. This only has effect on Win32. {\
 \twocolitem{wxLIST\_ALIGN\_SNAP\_TO\_GRID}{Snap to grid.}
 \end{twocollist}
 
 \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}}
 \membersection{wxListCtrl::AssignImageList}\label{wxlistctrlassignimagelist}
 
 \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}


@@ -161,12 +173,14 @@ wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is u
 
 \helpref{wxListCtrl::SetImageList}{wxlistctrlsetimagelist}
 
 
 \helpref{wxListCtrl::SetImageList}{wxlistctrlsetimagelist}
 

+

 \membersection{wxListCtrl::ClearAll}\label{wxlistctrlclearall}
 
 \func{void}{ClearAll}{}
 
 Deletes all items and all columns.
 
 \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
 \membersection{wxListCtrl::Create}\label{wxlistctrlcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp


@@ -175,6 +189,7 @@ Deletes all items and all columns.
 
 Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
 
 
 Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
 

+

 \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
 
 \func{bool}{DeleteAllItems}{}
 \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
 
 \func{bool}{DeleteAllItems}{}


@@ -185,12 +200,14 @@ Deletes all the items in the list control.
 {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
 from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}).
 
 {\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::DeleteColumn}\label{wxlistctrldeletecolumn}
 
 \func{bool}{DeleteColumn}{\param{int }{col}}
 
 Deletes a column.
 

+

 \membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem}
 
 \func{bool}{DeleteItem}{\param{long }{item}}
 \membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem}
 
 \func{bool}{DeleteItem}{\param{long }{item}}


@@ -200,6 +217,7 @@ Deletes the specified item. This function sends the
 
 See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
 
 
 See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
 

+

 \membersection{wxListCtrl::EditLabel}\label{wxlistctrledit}
 
 \func{void}{EditLabel}{\param{long }{item}}
 \membersection{wxListCtrl::EditLabel}\label{wxlistctrledit}
 
 \func{void}{EditLabel}{\param{long }{item}}


@@ -212,33 +230,35 @@ 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.
 
 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::EnsureVisible}\label{wxlistctrlensurevisible}
 
 \func{bool}{EnsureVisible}{\param{long }{item}}
 
 Ensures this item is visible.
 

+

 \membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem}
 
 \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}}
 
 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}}
 
 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}
 
 \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}}
 \twocolitem{{\bf FindItemData(start, data)}}{}
 \twocolitem{{\bf FindItemAtPos(start, point, direction)}}{}
 \end{twocollist}}


@@ -247,12 +267,13 @@ implements the following methods:\par
 \perlnote{In wxPerl there are three methods instead of a single overloaded
 method:\par
 \indented{2cm}{\begin{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}
 }}
 
 \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}}
 \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
 
 \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}


@@ -263,12 +284,21 @@ information.
 \perlnote{In wxPerl this method takes only the {\bf col} parameter and
   returns a Wx::ListItem ( or undef ).}
 
 \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::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}
 \membersection{wxListCtrl::GetCountPerPage}\label{wxlistctrlgetcountperpage}
 
 \constfunc{int}{GetCountPerPage}{\void}


@@ -278,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).
 
 or the total number of items in the list control (icon
 or small icon view).
 

+

 \membersection{wxListCtrl::GetEditControl}\label{wxlistctrlgeteditcontrol}
 
 \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}
 
 
 \membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist}
 


@@ -297,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}
 
 \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}}
 \membersection{wxListCtrl::GetItem}\label{wxlistctrlgetitem}
 
 \constfunc{bool}{GetItem}{\param{wxListItem\& }{info}}


@@ -314,18 +350,34 @@ 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.}
 
 \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::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::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}}
 \membersection{wxListCtrl::GetItemPosition}\label{wxlistctrlgetitemposition}
 
 \constfunc{bool}{GetItemPosition}{\param{long }{item}, \param{wxPoint\& }{pos}}


@@ -338,6 +390,7 @@ ID and returns the wxPoint.}
 \perlnote{In wxPerl this method takes only the {\bf item} parameter and
 returns a Wx::Point ( or undef ).}
 
 \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}}
 \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
 
 \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}


@@ -350,15 +403,19 @@ Returns the rectangle representing the item's size and position, in client coord
 ID and code and returns the wxRect.}
 
 \perlnote{In wxPerl this method takes only the {\bf item} parameter and
 ID and code and returns the wxRect.}
 
 \perlnote{In wxPerl this method takes only the {\bf item} parameter and

-retutrns a Wx::Rect ( or undef ).}
+returns a Wx::Rect ( or undef ).}
+
+

 
 \membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing}
 
 
 \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}
 
 
 \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
 


@@ -368,17 +425,30 @@ Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem
 
 The {\bf stateMask} indicates which state flags are of interest.
 
 
 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::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}}
 
 \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
+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.
 
 {\it item} but excluding the {\it item} itself. If {\it item} is -1,
 the first item that matches the specified flags will be returned.
 


@@ -427,18 +497,21 @@ other platforms.
 \twocolitem{wxLIST\_STATE\_CUT}{The item is selected as part of a cut and paste operation.}
 \end{twocollist}
 
 \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::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::GetTextColour}\label{wxlistctrlgettextcolour}
 
 \constfunc{wxColour}{GetTextColour}{\void}
 
 Gets the text colour of the list control.
 

+

 \membersection{wxListCtrl::GetTopItem}\label{wxlistctrlgettopitem}
 
 \constfunc{long}{GetTopItem}{\void}
 \membersection{wxListCtrl::GetTopItem}\label{wxlistctrlgettopitem}
 
 \constfunc{long}{GetTopItem}{\void}


@@ -446,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.
 
 Gets the index of the topmost visible item when in
 list or report view.
 

+
+
+\membersection{wxRect}{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}}
 \membersection{wxListCtrl::HitTest}\label{wxlistctrlhittest}
 
 \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}


@@ -473,18 +561,17 @@ 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
 flags value mentioned above.}
 
 \perlnote{In wxPerl this method only takes the {\bf point} parameter

-  and returns a 2-element list ( item, flags ).}
+  and returns a 2-element list {\tt ( item, flags )}.}
+

 
 \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
 
 \func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}}
 
 
 \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}}
 
 \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
 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par


@@ -496,6 +583,7 @@ wxListInfo.}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+

 \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
 
 \func{long}{InsertItem}{\param{wxListItem\& }{info}}
 \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
 
 \func{long}{InsertItem}{\param{wxListItem\& }{info}}


@@ -546,9 +634,10 @@ method:\par
 \end{twocollist}
 }}
 
 \end{twocollist}
 }}
 

+

 \membersection{wxListCtrl::OnGetItemAttr}\label{wxlistctrlongetitemattr}
 
 \membersection{wxListCtrl::OnGetItemAttr}\label{wxlistctrlongetitemattr}
 

-\func{virtual wxString}{OnGetItemAttr}{\param{long }{item}}
+\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
 
 This function may be overloaded in the derived class for a control with 
 {\tt wxLC\_VIRTUAL} style. It should return the attribute for the


@@ -562,13 +651,16 @@ The base class version always returns {\tt NULL}.
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
 \helpref{OnGetItemText}{wxlistctrlongetitemtext}
 
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
 \helpref{OnGetItemText}{wxlistctrlongetitemtext}
 

+

 \membersection{wxListCtrl::OnGetItemImage}\label{wxlistctrlongetitemimage}
 
 \membersection{wxListCtrl::OnGetItemImage}\label{wxlistctrlongetitemimage}
 

-\func{virtual wxString}{OnGetItemImage}{\param{long }{item}}
+\func{virtual int}{OnGetItemImage}{\param{long }{item}}

 
 

-This function may be overloaded in the derived class for a control with 
-{\tt wxLC\_VIRTUAL} style. It should return the index of the items image in the
-controls image list or $-1$ for no image.
+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$.
 
 
 The base class version always returns $-1$.
 


@@ -577,6 +669,7 @@ The base class version always returns $-1$.
 \helpref{OnGetItemText}{wxlistctrlongetitemtext},\\
 \helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
 
 \helpref{OnGetItemText}{wxlistctrlongetitemtext},\\
 \helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
 

+

 \membersection{wxListCtrl::OnGetItemText}\label{wxlistctrlongetitemtext}
 
 \func{virtual wxString}{OnGetItemText}{\param{long }{item}, \param{long }{column}}
 \membersection{wxListCtrl::OnGetItemText}\label{wxlistctrlongetitemtext}
 
 \func{virtual wxString}{OnGetItemText}{\param{long }{item}, \param{long }{column}}


@@ -591,16 +684,44 @@ the given {\it column} for the specified {\tt item}.
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
 \helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
 
 \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}}
 
 \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}
 
 
 \membersection{wxListCtrl::SetBackgroundColour}\label{wxlistctrlsetbackgroundcolour}
 


@@ -609,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).
 
 Sets the background colour (GetBackgroundColour already implicit in
 wxWindow class).
 

+

 \membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn}
 
 \func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
 \membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn}
 
 \func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}


@@ -616,6 +738,7 @@ wxWindow class).
 Sets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
 information.
 
 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}}
 \membersection{wxListCtrl::SetColumnWidth}\label{wxlistctrlsetcolumnwidth}
 
 \func{bool}{SetColumnWidth}{\param{int }{col}, \param{int }{width}}


@@ -628,6 +751,7 @@ will resize the column to the length of the header (Win32) or 80 pixels (other p
 
 In small or normal icon view, {\it col} must be -1, and the column width is set for all columns.
 
 
 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}}
 \membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist}
 
 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}


@@ -643,6 +767,7 @@ delete it yourself.
 \helpref{wxListCtrl::AssignImageList}{wxlistctrlassignimagelist}
 
 
 \helpref{wxListCtrl::AssignImageList}{wxlistctrlassignimagelist}
 
 

+

 \membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
 
 \func{bool}{SetItem}{\param{wxListItem\& }{info}}
 \membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
 
 \func{bool}{SetItem}{\param{wxListItem\& }{info}}


@@ -710,6 +835,17 @@ string or image at a given location.}
 \end{twocollist}}
 }
 
 \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}}
 \membersection{wxListCtrl::SetItemCount}\label{wxlistctrlsetitemcount}
 
 \func{void}{SetItemCount}{\param{long }{count}}


@@ -717,15 +853,17 @@ string or image at a given location.}
 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
 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 vitems in the range
+\helpref{OnGetItemText}{wxlistctrlongetitemtext}) for all items in the range

 from $0$ to {\it count}.
 
 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::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}}
 \membersection{wxListCtrl::SetItemImage}\label{wxlistctrlsetitemimage}
 
 \func{bool}{SetItemImage}{\param{long }{item}, \param{int }{image}, \param{int }{selImage}}


@@ -733,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.
 
 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::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}}
 \membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate}
 
 \func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}}


@@ -747,29 +887,43 @@ Sets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem
 
 The {\bf stateMask} indicates which state flags are valid.
 
 
 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::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}
 
 \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.
 
 
 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::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}}
 
 \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}
 
 
 \membersection{wxListCtrl::SortItems}\label{wxlistctrlsortitems}