docs/latex/wx/dataviewctrl.tex

   1
   2 \section{\class{wxDataViewCtrl}}\label{wxdataviewctrl}
   3
   4 wxDataViewCtrl is a control to display data either
   5 in a tree like fashion or in a tabular form or both.
   6
   7 A \helpref{wxDataViewItem}{wxdataviewitem} is used
   8 to represent a (visible) item in the control.
   9
  10 Unlike \helpref{wxListCtrl}{wxlistctrl} wxDataViewCtrl doesn't
  11 get its data from the user through virtual functions or by
  12 setting it directly. Instead you need to write your own
  13 \helpref{wxDataViewModel}{wxdataviewmodel} and associate
  14 it with this control. Then you need to add a number of
  15 \helpref{wxDataViewColumn}{wxdataviewcolumn} to this control to
  16 define what each column shall display. Each wxDataViewColumn
  17 in turn owns 1 instance of a
  18 \helpref{wxDataViewRenderer}{wxdataviewrenderer} to render its
  19 cells. A number of standard renderers for rendering text, dates,
  20 images, toggle, a progress bar etc. are provided. Additionally,
  21 the user can write custom renderes deriving from
  22 \helpref{wxDataViewCustomRenderer}{wxdataviewcustomrenderer}
  23 for displaying anything.
  24
  25 All data transfer from the control to the model and the user
  26 code is done through \helpref{wxVariant}{wxvariant} which can
  27 be extended to support more data formats as necessary.
  28 Accordingly, all type information uses the strings returned
  29 from \helpref{wxVariant::GetType}{wxvariantgettype}.
  30
  31 \wxheading{Window styles}
  32
  33 \twocolwidtha{5cm}
  34 \begin{twocollist}\itemsep=0pt
  35 \twocolitem{\windowstyle{wxDV\_SINGLE}}{Single selection mode. This is the default.}
  36 \twocolitem{\windowstyle{wxDV\_MULTIPLE}}{Multiple selection mode.}
  37 \end{twocollist}
  38
  39
  40 \wxheading{Event handling}
  41
  42 To process input from a dataview control, use the following event handler
  43 macros to direct input to member functions that take a
  44 \helpref{wxDataViewEvent}{wxdataviewevent} argument.
  45
  46 \twocolwidtha{7cm}
  47 \begin{twocollist}\itemsep=0pt
  48
  49 \twocolitem{{\bf EVT\_DATAVIEW\_SELECTION\_CHANGED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_SELECTION\_CHANGED event.}
  50 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_ACTIVATED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_ACTIVATED event.}
  51 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_EDITING\_STARTED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_EDITING\_STARTED event.}
  52 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_EDITING\_DONE(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_EDITING\_DONE event.}
  53 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_COLLAPSING(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_COLLAPSING event.}
  54 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_COLLAPSED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_COLLAPSED event.}
  55 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_EXPANDING(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_EXPANDING event.}
  56 \twocolitem{{\bf EVT\_DATAVIEW\_ITEM\_EXPANDED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_ITEM\_EXPANDED event.}
  57 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_CLICK(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_CLICKED event.}
  58 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_RIGHT\_CLICK(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_RIGHT\_CLICKED event.}
  59 \twocolitem{{\bf EVT\_DATAVIEW\_COLUMN\_HEADER\_SORTED(id, func)}}{Processes a wxEVT\_COMMAND\_DATAVIEW\_COLUMN\_HEADER\_SORTED event.}
  60
  61 \end{twocollist}
  62
  63
  64 \wxheading{Derived from}
  65
  66 \helpref{wxControl}{wxcontrol}\\
  67 \helpref{wxWindow}{wxwindow}\\
  68 \helpref{wxEvtHandler}{wxevthandler}\\
  69 \helpref{wxObject}{wxobject}
  70
  71 \wxheading{Include files}
  72
  73 <wx/dataview.h>
  74
  75 \wxheading{Library}
  76
  77 \helpref{wxAdv}{librarieslist}
  78
  79
  80 \latexignore{\rtfignore{\wxheading{Members}}}
  81
  82 \membersection{wxDataViewCtrl::wxDataViewCtrl}\label{wxdataviewctrlwxdataviewctrl}
  83
  84 \func{}{wxDataViewCtrl}{\void}
  85
  86 \func{}{wxDataViewCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}}
  87
  88 Constructor. Calls \helpref{Create}{wxdataviewctrlcreate}.
  89
  90 \membersection{wxDataViewCtrl::\destruct{wxDataViewCtrl}}\label{wxdataviewctrldtor}
  91
  92 \func{}{\destruct{wxDataViewCtrl}}{\void}
  93
  94 Destructor.
  95
  96 \membersection{wxDataViewCtrl::AppendColumn}\label{wxdataviewctrlappendcolumn}
  97
  98 \func{virtual bool}{AppendColumn}{\param{wxDataViewColumn* }{col}}
  99
 100 Add a \helpref{wxDataViewColumn}{wxdataviewcolumn} to the control. Returns
 101 {\it true} on success.
 102
 103 Note that there is a number of short cut methods which implicitly create
 104 a \helpref{wxDataViewColumn}{wxdataviewcolumn} and a
 105 \helpref{wxDataViewRenderer}{wxdataviewrenderer} for it (see below).
 106
 107 \membersection{wxDataViewCtrl::AppendBitmapColumn}\label{wxdataviewctrlappendbitmapcolumn}
 108
 109 \func{wxDataViewColumn*}{AppendBitmapColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
 110
 111 \func{wxDataViewColumn*}{AppendBitmapColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
 112
 113 Appends a column for rendering a bitmap. Returns the wxDataViewColumn
 114 created in the function or NULL on failure.
 115
 116 \membersection{wxDataViewCtrl::AppendDateColumn}\label{wxdataviewctrlappenddatecolumn}
 117
 118 \func{wxDataViewColumn*}{AppendDateColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}, \param{int }{width = -1}}
 119
 120 \func{wxDataViewColumn*}{AppendDateColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}, \param{int }{width = -1}}
 121
 122 Appends a column for rendering a date. Returns the wxDataViewColumn
 123 created in the function or NULL on failure.
 124
 125 \membersection{wxDataViewCtrl::AppendProgressColumn}\label{wxdataviewctrlappendprogresscolumn}
 126
 127 \func{wxDataViewColumn*}{AppendProgressColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 80}}
 128
 129 \func{wxDataViewColumn*}{AppendProgressColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 80}}
 130
 131 Appends a column for rendering a progress indicator. Returns the wxDataViewColumn
 132 created in the function or NULL on failure.
 133
 134 \membersection{wxDataViewCtrl::AppendIconTextColumn}\label{wxdataviewctrlappendicontextcolumn}
 135
 136 \func{wxDataViewColumn*}{AppendIconTextColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
 137
 138 \func{wxDataViewColumn*}{AppendIconTextColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
 139
 140 Appends a column for rendering text with an icon. Returns the wxDataViewColumn
 141 created in the function or NULL on failure. This uses the
 142 \helpref{wxDataViewIconTextRenderer}{wxdataviewicontextrenderer}.
 143
 144 \membersection{wxDataViewCtrl::AppendTextColumn}\label{wxdataviewctrlappendtextcolumn}
 145
 146 \func{wxDataViewColumn*}{AppendTextColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
 147
 148 \func{wxDataViewColumn*}{AppendTextColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = -1}}
 149
 150 Appends a column for rendering text. Returns the wxDataViewColumn
 151 created in the function or NULL on failure.
 152
 153 \membersection{wxDataViewCtrl::AppendToggleColumn}\label{wxdataviewctrlappendtogglecolumn}
 154
 155 \func{wxDataViewColumn*}{AppendToggleColumn}{\param{const wxString\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 30}}
 156
 157 \func{wxDataViewColumn*}{AppendToggleColumn}{\param{const wxBitmap\& }{label}, \param{unsigned int }{model\_column}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{int }{width = 30}}
 158
 159 Appends a column for rendering a toggle. Returns the wxDataViewColumn
 160 created in the function or NULL on failure.
 161
 162 \membersection{wxDataViewCtrl::AssociateModel}\label{wxdataviewctrlassociatemodel}
 163
 164 \func{virtual bool}{AssociateModel}{\param{wxDataViewModel* }{model}}
 165
 166 Associates a \helpref{wxDataViewModel}{wxdataviewmodel} with the
 167 control.
 168
 169 \membersection{wxDataViewCtrl::Create}\label{wxdataviewctrlcreate}
 170
 171 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}}
 172
 173 Create the control. Useful for two step creation.
 174
 175 \membersection{wxDataViewCtrl::ClearColumns}\label{wxdataviewctrlclearcolumns}
 176
 177 \func{virtual bool}{ClearColumns}{\void}
 178
 179 Removes all columns.
 180
 181 \membersection{wxDataViewCtrl::ClearSelection}\label{wxdataviewctrlclearselection}
 182
 183 \func{void}{ClearSelection}{\void}
 184
 185 Unselects all rows.
 186
 187 \membersection{wxDataViewCtrl::Collapse}\label{wxdataviewctrlcollapse}
 188
 189 \func{void}{Collapse}{\param{const wxDataViewItem \& }{item}}
 190
 191 Collapses the item.
 192
 193 \membersection{wxDataViewCtrl::DeleteColumn}\label{wxdataviewctrldeletecolumn}
 194
 195 \func{virtual bool}{DeleteColumn}{\param{const wxDataViewColumn* }{column}}
 196
 197 Deletes given column.
 198
 199 \membersection{wxDataViewCtrl::Expand}\label{wxdataviewctrlexpand}
 200
 201 \func{void}{Expand}{\param{const wxDataViewItem \& }{item}}
 202
 203 Expands the item.
 204
 205 \membersection{wxDataViewCtrl::GetColumn}\label{wxdataviewctrlgetcolumn}
 206
 207 \constfunc{virtual wxDataViewColumn*}{GetColumn}{\param{unsigned int }{pos}}
 208
 209 Returns pointer to the column. {\it pos} refers to the
 210 position in the control which may change after reordering
 211 columns by the user.
 212
 213 \membersection{wxDataViewCtrl::GetColumnCount}\label{wxdataviewctrlgetcolumncount}
 214
 215 \constfunc{virtual unsigned int}{GetColumnCount}{\void}
 216
 217 Returns the number of columns.
 218
 219 \membersection{wxDataViewCtrl::GetColumnPosition}\label{wxdataviewctrlgetcolumnposition}
 220
 221 \constfunc{virtual int}{GetColumnPosition}{\param{const wxDataViewColumn* }{column}}
 222
 223 Returns the position of the column or -1 if not found in the control.
 224
 225 \membersection{wxDataViewCtrl::EnsureVisible}\label{wxdataviewctrlensurevisible}
 226
 227 \func{void}{EnsureVisible}{\param{const wxDataViewItem \& }{item}, \param{const wxDataViewColumn* }{column = NULL}}
 228
 229 Call this to ensure that the given item is visible.
 230
 231 \membersection{wxDataViewCtrl::GetExpanderColumn}\label{wxdataviewctrlgetexpandercolumn}
 232
 233 \constfunc{wxDataViewColumn *}{GetExpanderColumn}{\void}
 234
 235 Returns column containing the expanders.
 236
 237 \membersection{wxDataViewCtrl::GetIndent}\label{wxdataviewctrlgetindent}
 238
 239 \constfunc{int}{GetIndent}{\void}
 240
 241 Returns indentation.
 242
 243 \membersection{wxDataViewCtrl::GetItemRect}\label{wxdataviewctrlgetitemrect}
 244
 245 \constfunc{wxRect}{GetItemRect}{\param{const wxDataViewItem\& }{item}, \param{const wxDataViewColumn *}{col = NULL}}
 246
 247 Returns item rect.
 248
 249 \membersection{wxDataViewCtrl::GetModel}\label{wxdataviewctrlgetmodel}
 250
 251 \constfunc{virtual wxDataViewModel*}{GetModel}{\void}
 252
 253 Returns pointer to the data model associated with the
 254 control (if any).
 255
 256 \membersection{wxDataViewCtrl::GetSelection}\label{wxdataviewctrlgetselection}
 257
 258 \constfunc{wxDataViewItem}{GetSelection}{\void}
 259
 260 Returns first selected item or an invalid item if none is selected.
 261
 262 \membersection{wxDataViewCtrl::GetSelections}\label{wxdataviewctrlgetselections}
 263
 264 \constfunc{int}{GetSelections}{\param{wxDataViewItemArray \& }{sel}}
 265
 266 Fills {\it sel} with currently selected items and returns
 267 their number.
 268
 269 \membersection{wxDataViewCtrl::GetSortingColumn}\label{wxdataviewctrlgetsortingcolumn}
 270
 271 \constfunc{virtual wxDataViewColumn*}{GetSortingColumn}{\void}
 272
 273 Returns the wxDataViewColumn currently responsible for sorting
 274 or NULL if none has been selected.
 275
 276 \membersection{wxDataViewCtrl::HitTest}\label{wxdataviewctrlhittest}
 277
 278 \constfunc{void}{HitTest}{\param{const wxPoint\& }{point}, \param{wxDataViewItem\& }{item}, \param{wxDataViewColumn *\&}{col}}
 279
 280 Hittest.
 281
 282 \membersection{wxDataViewCtrl::IsSelected}\label{wxdataviewctrlisselected}
 283
 284 \constfunc{bool}{IsSelected}{\param{const wxDataViewItem \& }{item}}
 285
 286 Return true if the item is selected.
 287
 288 \membersection{wxDataViewCtrl::Select}\label{wxdataviewctrlselect}
 289
 290 \func{void}{Select}{\param{const wxDataViewItem \& }{item}}
 291
 292 Select the given item.
 293
 294 \membersection{wxDataViewCtrl::SelectAll}\label{wxdataviewctrlselectall}
 295
 296 \func{void}{SelectAll}{\void}
 297
 298 Select all items.
 299
 300 \membersection{wxDataViewCtrl::SetExpanderColumn}\label{wxdataviewctrlsetexpandercolumn}
 301
 302 \func{void}{SetExpanderColumn}{\param{wxDataViewColumn *}{col}}
 303
 304 Set which column shall contain the tree-like expanders.
 305
 306 \membersection{wxDataViewCtrl::SetIndent}\label{wxdataviewctrlsetindent}
 307
 308 \func{void}{SetIndent}{\param{int }{indent}}
 309
 310 Sets the indendation.
 311
 312 \membersection{wxDataViewCtrl::SetSelections}\label{wxdataviewctrlsetselections}
 313
 314 \func{void}{SetSelections}{\param{const wxDataViewItemArray \& }{sel}}
 315
 316 Sets the selection to the array of wxDataViewItems.
 317
 318 \membersection{wxDataViewCtrl::Unselect}\label{wxdataviewctrlunselect}
 319
 320 \func{void}{Unselect}{\param{const wxDataViewItem \& }{item}}
 321
 322 Unselect the given item.
 323
 324 \membersection{wxDataViewCtrl::UnselectAll}\label{wxdataviewctrlunselectall}
 325
 326 \func{void}{UnselectAll}{\void}
 327
 328 Unselect all item. This method only has effect if multiple
 329 selections are allowed.
 330