X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/11ebea162a1d99032aa98ac649d61aaf08e428e8..f1e7793361bb0106611e5d1373b4e1e6ed30f14f:/docs/latex/wx/listctrl.tex

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index b4e57c7a4f..b155fcc185 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -103,6 +103,7 @@ functions that take a \helpref{wxListEvent}{wxlistevent} argument.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxListCtrl::wxListCtrl}\label{wxlistctrlconstr}
 
 \func{}{wxListCtrl}{\void}
@@ -136,12 +137,14 @@ 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}}
@@ -156,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}
 
+
 \membersection{wxListCtrl::AssignImageList}\label{wxlistctrlassignimagelist}
 
 \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}
@@ -169,12 +173,14 @@ wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is u
 
 \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
@@ -183,6 +189,7 @@ Deletes all items and all columns.
 
 Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
 
+
 \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
 
 \func{bool}{DeleteAllItems}{}
@@ -193,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}).
 
+
 \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}}
@@ -208,6 +217,7 @@ Deletes the specified item. This function sends the
 
 See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
 
+
 \membersection{wxListCtrl::EditLabel}\label{wxlistctrledit}
 
 \func{void}{EditLabel}{\param{long }{item}}
@@ -220,28 +230,30 @@ If the user changed the label (i.e. s/he does not press ESC or leave
 the text control without changes, a EVT\_LIST\_END\_LABEL\_EDIT event
 will be sent which can be vetoed as well.
 
+
 \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible}
 
 \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}}
 
-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
@@ -261,6 +273,7 @@ method:\par
 \end{twocollist}
 }}
 
+
 \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
 
 \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
@@ -271,18 +284,21 @@ 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}
@@ -292,6 +308,7 @@ 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}
@@ -301,6 +318,7 @@ if no label is being edited.
 
 {\bf NB:} It is currently only implemented for wxMSW.
 
+
 \membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist}
 
 \constfunc{wxImageList*}{GetImageList}{\param{int }{which}}
@@ -314,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}}
@@ -331,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.}
 
+
+\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}}
@@ -355,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 ).}
 
+
 \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
 
 \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
@@ -369,13 +405,17 @@ 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{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}
 
@@ -385,12 +425,25 @@ 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::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}}
@@ -444,18 +497,21 @@ other platforms.
 \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}
@@ -464,7 +520,8 @@ Gets the index of the topmost visible item when in
 list or report view.
 
 
-\membersection{wxRect}{wxListCtrl::GetViewRect}\label{wxlistctrlgetviewrect}
+
+\membersection{wxListCtrl::GetViewRect}\label{wxlistctrlgetviewrect}
 
 \constfunc{wxRect}{GetViewRect}{\void}
 
@@ -476,6 +533,7 @@ 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}}
@@ -505,6 +563,7 @@ 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}}
@@ -524,6 +583,7 @@ wxListInfo.}
 \end{twocollist}}
 }
 
+
 \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
 
 \func{long}{InsertItem}{\param{wxListItem\& }{info}}
@@ -574,6 +634,7 @@ method:\par
 \end{twocollist}
 }}
 
+
 \membersection{wxListCtrl::OnGetItemAttr}\label{wxlistctrlongetitemattr}
 
 \func{virtual wxListItemAttr *}{OnGetItemAttr}{\param{long }{item}}
@@ -590,6 +651,7 @@ The base class version always returns {\tt NULL}.
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
 \helpref{OnGetItemText}{wxlistctrlongetitemtext}
 
+
 \membersection{wxListCtrl::OnGetItemImage}\label{wxlistctrlongetitemimage}
 
 \func{virtual int}{OnGetItemImage}{\param{long }{item}}
@@ -607,6 +669,7 @@ The base class version always returns $-1$.
 \helpref{OnGetItemText}{wxlistctrlongetitemtext},\\
 \helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
 
+
 \membersection{wxListCtrl::OnGetItemText}\label{wxlistctrlongetitemtext}
 
 \func{virtual wxString}{OnGetItemText}{\param{long }{item}, \param{long }{column}}
@@ -621,6 +684,7 @@ the given {\it column} for the specified {\tt item}.
 \helpref{OnGetItemImage}{wxlistctrlongetitemimage},\\
 \helpref{OnGetItemAttr}{wxlistctrlongetitemattr}
 
+
 \membersection{wxListCtrl::RefreshItem}\label{wxlistctrlrefreshitem}
 
 \func{void}{RefreshItem}{\param{long }{item}}
@@ -634,6 +698,7 @@ even when the underlying data does change.
 \helpref{RefreshItems}{wxlistctrlrefreshitems}
 
 
+
 \membersection{wxListCtrl::RefreshItems}\label{wxlistctrlrefreshitems}
 
 \func{void}{RefreshItems}{\param{long }{itemFrom}, \param{long }{itemTo}}
@@ -645,6 +710,7 @@ 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}}
@@ -656,6 +722,7 @@ the number of pixels to scroll vertically.
 
 {\bf NB:} This method is currently only implemented in the Windows version.
 
+
 \membersection{wxListCtrl::SetBackgroundColour}\label{wxlistctrlsetbackgroundcolour}
 
 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{col}}
@@ -663,6 +730,7 @@ the number of pixels to scroll vertically.
 Sets the background colour (GetBackgroundColour already implicit in
 wxWindow class).
 
+
 \membersection{wxListCtrl::SetColumn}\label{wxlistctrlsetcolumn}
 
 \func{bool}{SetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
@@ -670,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}}
@@ -682,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.
 
+
 \membersection{wxListCtrl::SetImageList}\label{wxlistctrlsetimagelist}
 
 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}
@@ -697,6 +767,7 @@ delete it yourself.
 \helpref{wxListCtrl::AssignImageList}{wxlistctrlassignimagelist}
 
 
+
 \membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
 
 \func{bool}{SetItem}{\param{wxListItem\& }{info}}
@@ -764,6 +835,17 @@ 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}}
@@ -774,12 +856,14 @@ 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}}
@@ -787,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}}
@@ -801,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.
 
+
 \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}}
 
 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}