diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 85ddafa64c..dba0aa01a0 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -93,6 +93,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls} \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection} \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view} +\twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode} \twocolitem{\helpref{wxTabCtrl}{wxtabctrl}}{Manages several tabs} \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control} \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 6e6487a91f..646ee733c3 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -174,6 +174,7 @@ \input listctrl.tex \input listevt.tex \input listitem.tex +\input listview.tex \input locale.tex \input log.tex \input longlong.tex diff --git a/docs/latex/wx/listview.tex b/docs/latex/wx/listview.tex new file mode 100644 index 0000000000..57ba0088ee --- /dev/null +++ b/docs/latex/wx/listview.tex @@ -0,0 +1,145 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: listview.tex +%% Purpose: wxListView documentation +%% Author: Vadim Zeitlin +%% Modified by: +%% Created: 07.11.02 +%% RCS-ID: $Id$ +%% Copyright: (c) 2002 Vadim Zeitlin +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{\class{wxListView}}\label{wxlistview} + +This class currently simply presents a simpler to use interface for the +\helpref{wxListCtrl}{wxlistctrl} -- it can be thought of as a {\it fa\c{c}ade} +for that complicated class. Using it is preferable to using +\helpref{wxListCtrl}{wxlistctrl} directly whenever possible because in the +future some ports might implement wxListView but not the full set of wxListCtrl +features. + +Other than different interface, this class is identical to wxListCtrl. In +particular, it uses the same events, same windows styles and so on. + +\wxheading{Derived from} + +\helpref{wxListCtrl}{wxlistctrl}\\ +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +%%%%%%%%%%%%% Methods in alphabetic order %%%%%%%%%%%%% +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxListView::ClearColumnImage}{wxlistviewclearcolumnimage} + +\func{void}{ClearColumnImage}{\param{int }{col}} + +Resets the column image -- after calling this function, no image will be shown. + +\wxheading{Parameters} + +\docparam{col}{the column to clear image for} + +\wxheading{See also} + +\helpref{SetColumnImage}{wxlistviewsetcolumnimage} + + +\membersection{wxListView::Focus}{wxlistviewfocus} + +\func{void}{Focus}{\param{long }{index}} + +Sets focus to the item with the given {\it index}. + + +\membersection{wxListView::GetFirstSelected}{wxlistviewgetfirstselected} + +\constfunc{long}{GetFirstSelected}{\void} + +Returns the first selected item in a (presumably) multiple selection control. +Tigether with \helpref{GetNextSelected}{wxlistviewgetnextselected} it can be +used to iterate over all selected items in the control. + +\wxheading{Return value} + +The fisrt selected item, if any, $-1$ otherwise. + + +\membersection{wxListView::GetFocusedItem}{wxlistviewgetfocuseditem} + +\constfunc{long}{GetFocusedItem}{\void} + +Returns the currently focused item or $-1$ if none. + +\wxheading{See also} + +\helpref{IsSelected}{wxlistviewisselected},\\ +\helpref{Focus}{wxlistviewfocus} + + +\membersection{wxListView::GetNextSelected}{wxlistviewgetnextselected} + +\constfunc{long}{GetNextSelected}{\param{long }{item}} + +Used together with \helpref{GetFirstSelected}{wxlistviewgetfirstselected} to +iterate oevr all selected items in the control. + +\wxheading{Return value} + +Returns the next selected item or $-1$ if there are no more of them. + + +\membersection{wxListView::IsSelected}{wxlistviewisselected} + +\func{bool}{IsSelected}{\param{long }{index}} + +Returns {\tt TRUE} if the item with the given {\it index} is selected, +{\tt FALSE} otherwise. + +\wxheading{See also} + +\helpref{GetFirstSelected}{wxlistviewgetfirstselected},\\ +\helpref{GetNextSelected}{wxlistviewgetnextselected} + + +\membersection{wxListView::Select}{wxlistviewselect} + +\func{void}{Select}{long n, \param{bool }{on = TRUE}} + +Selects or unselects the given item. + +\wxheading{Parameters} + +\docparam{n}{the item to select or unselect} + +\docparam{on}{if {\tt TRUE} (default), selects the item, otherwise unselects it} + +\wxheading{See also} + +\helpref{SetItemState}{wxlistctrlsetitemstate} + + +\membersection{wxListView::SetColumnImage}{wxlistviewsetcolumnimage} + +\func{void}{SetColumnImage}{\param{int }{col}, \param{int }{image}} + +Sets the column image for the specified column. To use the column images, the +control must have a valid image list with at least one image. + +\wxheading{Parameters} + +\docparam{col}{the column to set image for} + +\docparam{image}{the index of the column image in the controls image list} + +\wxheading{See also} + +\helpref{ClearColumnImage}{wxlistviewclearcolumnimage},\\ +\helpref{SetImageList}{wxlistctrlwsetimagelist} +