X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..71aba8333cc915afff9e740c944f7fa7247abacb:/docs/latex/wx/listctrl.tex diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index 9bf5f1d1f5..03cd4fd808 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -52,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\_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\_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.} @@ -369,13 +369,15 @@ 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} @@ -463,6 +465,19 @@ Gets the text colour of the list control. 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}} @@ -496,12 +511,10 @@ flags value mentioned above.} \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 @@ -610,6 +623,30 @@ 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}} + +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}}