Added logic, API and docs for wxDataViewModel::HasDefaultCompare indicating a compare...

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

diff --git a/docs/latex/wx/dataviewctrl.tex b/docs/latex/wx/dataviewctrl.tex
index 2c0688b0cdf0ddf34f00dcbf3ed4267f74b81405..f9f99941c503dea1ecf8ce9bb5b70e49d6474bc3 100644 (file)
--- a/docs/latex/wx/dataviewctrl.tex
+++ b/docs/latex/wx/dataviewctrl.tex
@@ -1,15 +1,13 @@
 
 \section{\class{wxDataViewCtrl}}\label{wxdataviewctrl}
 
 
 \section{\class{wxDataViewCtrl}}\label{wxdataviewctrl}
 

-This class and its documentation are work in progress and
-certainly subject to change.
-
-wxDataViewCtrl is planned to be a control to display data either
-in a tree like fashion or in a tabular form or both. Currently,
-only the tabular form is implemented. wxDataViewCtrl doesn't
-get its data from the user through virtual functions or events,
-instead you need to write your own 
-\helpref{wxDataViewListModel}{wxdataviewlistmodel} and associate
+wxDataViewCtrl is a control to display data either
+in a tree like fashion or in a tabular form or both. 
+
+Unlike \helpref{wxListCtrl}{wxlistctrl} wxDataViewCtrl doesn't 
+get its data from the user through virtual functions or by
+setting it directly. Instead you need to write your own 
+\helpref{wxDataViewModel}{wxdataviewmodel} and associate

 it with this control. Then you need to add a number of
 \helpref{wxDataViewColumn}{wxdataviewcolumn} to this control to
 define what each column shall display. Each wxDataViewColumn
 it with this control. Then you need to add a number of
 \helpref{wxDataViewColumn}{wxdataviewcolumn} to this control to
 define what each column shall display. Each wxDataViewColumn


@@ -27,11 +25,6 @@ be extended to support more data formats as necessary.
 Accordingly, all type information uses the strings returned
 from \helpref{wxVariant::GetType}{wxvariantgettype}.
 
 Accordingly, all type information uses the strings returned
 from \helpref{wxVariant::GetType}{wxvariantgettype}.
 

-So far, this control has only be implemented for GTK+ and
-there are only barely working stubs for a generic implementation.
-It is planned to implement the control natively under OS X
-and use generic code under Windows (and elsewhere).
-

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}


@@ -50,23 +43,32 @@ macros to direct input to member functions that take a
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 

-\twocolitem{{\bf EVT\_DATAVIEW\_ROW\_SELECTED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ROW\_SELECTED event.}
-\twocolitem{{\bf EVT\_DATAVIEW\_ROW\_ACTIVATED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ROW\_ACTIVATED event.}
+\twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_SELECTED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_SELECTED event.}
+\twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_ACTIVATED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_ACTIVATED event.}

 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_CLICK(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_CLICKED event.}
 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_RIGHT\_CLICK(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_RIGHT\_CLICKED event.}
 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_CLICK(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_CLICKED event.}
 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_RIGHT\_CLICK(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_RIGHT\_CLICKED event.}

+\twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_SORTED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_SORTED event.}

 
 \end{twocollist}
 
 
 
 \end{twocollist}
 
 

-

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-\helpref{wxControl}{wxcontrol}
+\helpref{wxControl}{wxcontrol}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
+
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 \membersection{wxDataViewCtrl::wxDataViewCtrl}\label{wxdataviewctrlwxdataviewctrl}
 
 
 \membersection{wxDataViewCtrl::wxDataViewCtrl}\label{wxdataviewctrlwxdataviewctrl}
 


@@ -86,59 +88,64 @@ Destructor.
 
 \func{virtual bool}{AppendColumn}{\param{wxDataViewColumn* }{col}}
 
 
 \func{virtual bool}{AppendColumn}{\param{wxDataViewColumn* }{col}}
 

-Add a \helpref{wxDataViewColumn}{wxdataviewcolumn} to the control. Note
-that there is a number of short cut methods which implicitly create
+Add a \helpref{wxDataViewColumn}{wxdataviewcolumn} to the control. Returns
+{\it true} on success.
+
+Note that there is a number of short cut methods which implicitly create

 a \helpref{wxDataViewColumn}{wxdataviewcolumn} and a 
 \helpref{wxDataViewRenderer}{wxdataviewrenderer} for it (see below).
 
 a \helpref{wxDataViewColumn}{wxdataviewcolumn} and a 
 \helpref{wxDataViewRenderer}{wxdataviewrenderer} for it (see below).
 

-

 \membersection{wxDataViewCtrl::AppendBitmapColumn}\label{wxdataviewctrlappendbitmapcolumn}
 
 \membersection{wxDataViewCtrl::AppendBitmapColumn}\label{wxdataviewctrlappendbitmapcolumn}
 

-\func{bool}{AppendBitmapColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
+\func{wxDataViewColumn*}{AppendBitmapColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}

 
 

-\func{bool}{AppendBitmapColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
+\func{wxDataViewColumn*}{AppendBitmapColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}

 
 

-Appends a column for rendering a bitmap.
+Appends a column for rendering a bitmap. Returns the wxDataViewColumn
+created in the function or NULL on failure.

 
 \membersection{wxDataViewCtrl::AppendDateColumn}\label{wxdataviewctrlappenddatecolumn}
 
 
 \membersection{wxDataViewCtrl::AppendDateColumn}\label{wxdataviewctrlappenddatecolumn}
 

-\func{bool}{AppendDateColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}, \param{int }{width = -1}}
+\func{wxDataViewColumn*}{AppendDateColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}, \param{int }{width = -1}}

 
 

-\func{bool}{AppendDateColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}, \param{int }{width = -1}}
+\func{wxDataViewColumn*}{AppendDateColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}, \param{int }{width = -1}}

 
 

-Appends a column for rendering a date.
+Appends a column for rendering a date. Returns the wxDataViewColumn
+created in the function or NULL on failure.

 
 \membersection{wxDataViewCtrl::AppendProgressColumn}\label{wxdataviewctrlappendprogresscolumn}
 
 
 \membersection{wxDataViewCtrl::AppendProgressColumn}\label{wxdataviewctrlappendprogresscolumn}
 

-\func{bool}{AppendProgressColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 80}}
+\func{wxDataViewColumn*}{AppendProgressColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 80}}

 
 

-\func{bool}{AppendProgressColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 80}}
+\func{wxDataViewColumn*}{AppendProgressColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 80}}

 
 

-Appends a column for rendering a progress indicator.
+Appends a column for rendering a progress indicator. Returns the wxDataViewColumn
+created in the function or NULL on failure.

 
 \membersection{wxDataViewCtrl::AppendTextColumn}\label{wxdataviewctrlappendtextcolumn}
 
 
 \membersection{wxDataViewCtrl::AppendTextColumn}\label{wxdataviewctrlappendtextcolumn}
 

-\func{bool}{AppendTextColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
+\func{wxDataViewColumn*}{AppendTextColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}

 
 

-\func{bool}{AppendTextColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
+\func{wxDataViewColumn*}{AppendTextColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}

 
 

-Appends a column for rendering text.
+Appends a column for rendering text. Returns the wxDataViewColumn
+created in the function or NULL on failure.

 
 \membersection{wxDataViewCtrl::AppendToggleColumn}\label{wxdataviewctrlappendtogglecolumn}
 
 
 \membersection{wxDataViewCtrl::AppendToggleColumn}\label{wxdataviewctrlappendtogglecolumn}
 

-\func{bool}{AppendToggleColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 30}}
+\func{wxDataViewColumn*}{AppendToggleColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 30}}

 
 

-\func{bool}{AppendToggleColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 30}}
+\func{wxDataViewColumn*}{AppendToggleColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 30}}

 
 

-Appends a column for rendering a toggle.
+Appends a column for rendering a toggle. Returns the wxDataViewColumn
+created in the function or NULL on failure.

 
 \membersection{wxDataViewCtrl::AssociateModel}\label{wxdataviewctrlassociatemodel}
 
 
 \membersection{wxDataViewCtrl::AssociateModel}\label{wxdataviewctrlassociatemodel}
 

-\func{virtual bool}{AssociateModel}{\param{wxDataViewListModel* }{model}}
+\func{virtual bool}{AssociateModel}{\param{wxDataViewModel* }{model}}

 
 

-Associates a \helpref{wxDataViewListModel}{wxdataviewlistmodel} with the
-control. In the future this should be changed to supporting any data
-model including a to-be-written wxDataViewTreeModel.
+Associates a \helpref{wxDataViewModel}{wxdataviewmodel} with the
+control. 

 
 \membersection{wxDataViewCtrl::Create}\label{wxdataviewctrlcreate}
 
 
 \membersection{wxDataViewCtrl::Create}\label{wxdataviewctrlcreate}
 


@@ -172,59 +179,106 @@ Returns pointer to the column.
 
 \membersection{wxDataViewCtrl::GetModel}\label{wxdataviewctrlgetmodel}
 
 
 \membersection{wxDataViewCtrl::GetModel}\label{wxdataviewctrlgetmodel}
 

-\func{virtual wxDataViewListModel*}{GetModel}{\void}
+\func{virtual wxDataViewModel*}{GetModel}{\void}

 
 Returns pointer to the data model associated with the
 control (if any).
 
 
 Returns pointer to the data model associated with the
 control (if any).
 

-\membersection{wxDataViewCtrl::GetNumberOfColumns}\label{wxdataviewctrlgetnumberofcolumns}
+\membersection{wxDataViewCtrl::GetColumnCount}\label{wxdataviewctrlgetcolumncount}

 
 

-\func{virtual unsigned int}{GetNumberOfColumns}{\void}
+\func{virtual unsigned int}{GetColumnCount}{\void}

 
 Returns the number of columns.
 
 
 Returns the number of columns.
 

+\membersection{wxDataViewCtrl::EnsureVisible}\label{wxdataviewctrlensurevisible}
+
+\func{void}{EnsureVisible}{\param{const wxDataViewItem \& }{item}, \param{wxDataViewColumn* }{column = NULL}}
+
+Call this to ensure that the given item is visible.
+
+\membersection{wxDataViewCtrl::GetExpanderColumn}\label{wxdataviewctrlgetexpandercolumn}
+
+\constfunc{unsigned int}{GetExpanderColumn}{\void}
+
+Returns column containing the expanders.
+
+\membersection{wxDataViewCtrl::GetIndent}\label{wxdataviewctrlgetindent}
+
+\constfunc{int}{GetIndent}{\void}
+
+Returns indentation.
+
+\membersection{wxDataViewCtrl::GetItemRect}\label{wxdataviewctrlgetitemrect}
+
+\constfunc{wxRect}{GetItemRect}{\param{const wxDataViewItem\& }{item}, \param{unsigned int }{column}}
+
+Returns item rect.
+

 \membersection{wxDataViewCtrl::GetSelection}\label{wxdataviewctrlgetselection}
 
 \membersection{wxDataViewCtrl::GetSelection}\label{wxdataviewctrlgetselection}
 

-\constfunc{virtual int}{GetSelection}{\void}
+\func{wxDataViewItem}{GetSelection}{\void}

 
 

-Returns the index of the currently selected row. It will 
-return -1 if no row is selected and the index of the first
-selected row if more than one row are selected.
+Returns first selected item or an invalid item if none is selected.

 
 \membersection{wxDataViewCtrl::GetSelections}\label{wxdataviewctrlgetselections}
 
 
 \membersection{wxDataViewCtrl::GetSelections}\label{wxdataviewctrlgetselections}
 

-\constfunc{virtual int}{GetSelections}{\param{wxArrayInt\& }{aSelections}}
+\constfunc{int}{GetSelections}{\param{wxDataViewItemArray \& }{sel}}

 
 

-Returns the number of selected rows and fills an array of int
-with the indeces of the selected rows.
+Fills {\it sel} with currently selected items and returns
+their number.
+
+\membersection{wxDataViewCtrl::HitTest}\label{wxdataviewctrlhittest}
+
+\constfunc{void}{HitTest}{\param{const wxPoint\& }{point}, \param{wxDataViewItem\& }{item}, \param{unsigned int\& }{column}}
+
+Hittest.

 
 \membersection{wxDataViewCtrl::IsSelected}\label{wxdataviewctrlisselected}
 
 
 \membersection{wxDataViewCtrl::IsSelected}\label{wxdataviewctrlisselected}
 

-\constfunc{virtual bool}{IsSelected}{\param{unsigned int }{row}}
+\constfunc{bool}{IsSelected}{\param{const wxDataViewItem \& }{item}}
+
+Return true if the item is selected.

 
 

-Returns {\it true} if the row is selected, {\it false} otherwise.
+\membersection{wxDataViewCtrl::Select}\label{wxdataviewctrlselect}

 
 

-\membersection{wxDataViewCtrl::SetSelection}\label{wxdataviewctrlsetselection}
+\func{void}{Select}{\param{const wxDataViewItem \& }{item}}

 
 

-\func{virtual void}{SetSelection}{\param{int }{row}}
+Select the given item.

 
 

-Sets the selection. Use -1 to unselect all rows.
+\membersection{wxDataViewCtrl::SelectAll}\label{wxdataviewctrlselectall}

 
 

-\membersection{wxDataViewCtrl::SetSelectionRange}\label{wxdataviewctrlsetselectionrange}
+\func{void}{SelectAll}{\void}

 
 

-\func{virtual void}{SetSelectionRange}{\param{unsigned int }{from}, \param{unsigned int }{to}}
+Select all items.

 
 

-Set a range of selection.
+\membersection{wxDataViewCtrl::SetExpanderColumn}\label{wxdataviewctrlsetexpandercolumn}
+
+\func{void}{SetExpanderColumn}{\param{unsigned int }{col}}
+
+Set which column shall contain the tree-like expanders.
+
+\membersection{wxDataViewCtrl::SetIndent}\label{wxdataviewctrlsetindent}
+
+\func{void}{SetIndent}{\param{int }{indent}}
+
+Sets the indendation.

 
 \membersection{wxDataViewCtrl::SetSelections}\label{wxdataviewctrlsetselections}
 
 
 \membersection{wxDataViewCtrl::SetSelections}\label{wxdataviewctrlsetselections}
 

-\func{virtual void}{SetSelections}{\param{const wxArrayInt\& }{aSelections}}
+\func{void}{SetSelections}{\param{const wxDataViewItemArray \& }{sel}}

 
 

-Set the selection to the array of int.
+Sets the selection to the array of wxDataViewItems.

 
 \membersection{wxDataViewCtrl::Unselect}\label{wxdataviewctrlunselect}
 
 
 \membersection{wxDataViewCtrl::Unselect}\label{wxdataviewctrlunselect}
 

-\func{virtual void}{Unselect}{\param{unsigned int }{row}}
+\func{void}{Unselect}{\param{const wxDataViewItem \& }{item}}
+
+Unselect the given item.
+
+\membersection{wxDataViewCtrl::UnselectAll}\label{wxdataviewctrlunselectall}
+
+\func{void}{UnselectAll}{\void}

 
 

-Unselect a particular row.
+Unselect all item. This method only has effect if multiple
+selections are allowed.