interface/wx/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dataview.h
   3 // Purpose:     interface of wxDataViewIconText
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxDataViewIconText
  11
  12     wxDataViewIconText is used by wxDataViewIconTextRenderer for data transfer.
  13     This class can be converted to and from a wxVariant.
  14
  15     @library{wxadv}
  16     @category{dvc}
  17 */
  18 class wxDataViewIconText : public wxObject
  19 {
  20 public:
  21     //@{
  22     /**
  23         Constructor.
  24     */
  25     wxDataViewIconText(const wxString& text = wxEmptyString,
  26                        const wxIcon& icon = wxNullIcon);
  27     wxDataViewIconText(const wxDataViewIconText& other);
  28     //@}
  29
  30     /**
  31         Gets the icon.
  32     */
  33     const wxIcon& GetIcon() const;
  34
  35     /**
  36         Gets the text.
  37     */
  38     wxString GetText() const;
  39
  40     /**
  41         Set the icon.
  42     */
  43     void SetIcon(const wxIcon& icon);
  44
  45     /**
  46         Set the text.
  47     */
  48     void SetText(const wxString& text);
  49 };
  50
  51
  52
  53 /**
  54     @class wxDataViewEvent
  55
  56     This is the event class for the wxDataViewCtrl notifications.
  57
  58     @library{wxadv}
  59     @category{events,dvc}
  60 */
  61 class wxDataViewEvent : public wxNotifyEvent
  62 {
  63 public:
  64     //@{
  65     /**
  66         Constructor. Typically used by wxWidgets internals only.
  67     */
  68     wxDataViewEvent(wxEventType commandType = wxEVT_NULL,
  69                     int winid = 0);
  70     wxDataViewEvent(const wxDataViewEvent& event);
  71     //@}
  72
  73     /**
  74         Used to clone the event.
  75     */
  76     wxEvent* Clone() const;
  77
  78     /**
  79         Returns the position of the column in the control or -1
  80         if no column field was set by the event emitter.
  81     */
  82     int GetColumn() const;
  83
  84     /**
  85         Returns a pointer to the wxDataViewColumn from which
  86         the event was emitted or @NULL.
  87     */
  88     wxDataViewColumn* GetDataViewColumn() const;
  89
  90     /**
  91         Returns the wxDataViewModel associated with the event.
  92     */
  93     wxDataViewModel* GetModel() const;
  94
  95     /**
  96         Returns a the position of a context menu event in screen coordinates.
  97     */
  98     wxPoint GetPosition() const;
  99
 100     /**
 101         Returns a reference to a value.
 102     */
 103     const wxVariant& GetValue() const;
 104
 105     /**
 106         Sets the column index associated with this event.
 107     */
 108     void SetColumn(int col);
 109
 110     /**
 111         For wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only.
 112     */
 113     void SetDataViewColumn(wxDataViewColumn* col);
 114
 115     /**
 116         Sets the dataview model associated with this event.
 117     */
 118     void SetModel(wxDataViewModel* model);
 119
 120     /**
 121         Sets the value associated with this event.
 122     */
 123     void SetValue(const wxVariant& value);
 124 };
 125
 126
 127
 128 /**
 129     @class wxDataViewModel
 130
 131     wxDataViewModel is the base class for all data model to be displayed by a
 132     wxDataViewCtrl.
 133
 134     All other models derive from it and must implement its pure virtual functions
 135     in order to define a complete data model. In detail, you need to override
 136     wxDataViewModel::IsContainer, wxDataViewModel::GetParent, wxDataViewModel::GetChildren,
 137     wxDataViewModel::GetColumnCount, wxDataViewModel::GetColumnType and
 138     wxDataViewModel::GetValue in order to define the data model which acts as an
 139     interface between your actual data and the wxDataViewCtrl.
 140
 141     Since you will usually also allow the wxDataViewCtrl to change your data
 142     through its graphical interface, you will also have to override
 143     wxDataViewModel::SetValue which the wxDataViewCtrl will call when a change
 144     to some data has been commited.
 145
 146     wxDataViewModel (as indeed the entire wxDataViewCtrl code) is using wxVariant
 147     to store data and its type in a generic way. wxVariant can be extended to contain
 148     almost any data without changes to the original class.
 149
 150     The data that is presented through this data model is expected to change at
 151     run-time. You need to inform the data model when a change happened.
 152     Depending on what happened you need to call one of the following methods:
 153     - wxDataViewModel::ValueChanged,
 154     - wxDataViewModel::ItemAdded,
 155     - wxDataViewModel::ItemDeleted,
 156     - wxDataViewModel::ItemChanged,
 157     - wxDataViewModel::Cleared.
 158
 159     There are plural forms for notification of addition, change or removal of
 160     several item at once. See:
 161     - wxDataViewModel::ItemsAdded,
 162     - wxDataViewModel::ItemsDeleted,
 163     - wxDataViewModel::ItemsChanged.
 164
 165     Note that wxDataViewModel does not define the position or index of any item
 166     in the control because different controls might display the same data differently.
 167     wxDataViewModel does provide a wxDataViewModel::Compare method which the
 168     wxDataViewCtrl may use to sort the data either in conjunction with a column
 169     header or without (see wxDataViewModel::HasDefaultCompare).
 170
 171     This class maintains a list of wxDataViewModelNotifier which link this class
 172     to the specific implementations on the supported platforms so that e.g. calling
 173     wxDataViewModel::ValueChanged on this model will just call
 174     wxDataViewModelNotifier::ValueChanged for each notifier that has been added.
 175     You can also add your own notifier in order to get informed about any changes
 176     to the data in the list model.
 177
 178     Currently wxWidgets provides the following models apart from the base model:
 179     wxDataViewIndexListModel, wxDataViewVirtualListModel, wxDataViewTreeStore.
 180
 181     Note that wxDataViewModel is reference counted, derives from wxObjectRefData
 182     and cannot be deleted directly as it can be shared by several wxDataViewCtrls.
 183     This implies that you need to decrease the reference count after
 184     associating the model with a control like this:
 185
 186     @code
 187         wxDataViewCtrl *musicCtrl = new wxDataViewCtrl( this, ID_MUSIC_CTRL );
 188         wxDataViewModel *musicModel = new MyMusicModel;
 189         m_musicCtrl-AssociateModel( musicModel );
 190         musicModel-DecRef();  // avoid memory leak !!
 191         // add columns now
 192     @endcode
 193
 194
 195     @library{wxadv}
 196     @category{dvc}
 197 */
 198 class wxDataViewModel : public wxObjectRefData
 199 {
 200 public:
 201     /**
 202         Constructor.
 203     */
 204     wxDataViewModel();
 205
 206     /**
 207         Adds a wxDataViewModelNotifier to the model.
 208     */
 209     void AddNotifier(wxDataViewModelNotifier* notifier);
 210
 211     /**
 212         Called to inform the model that all data has been cleared.
 213         The control will reread the data from the model again.
 214     */
 215     virtual bool Cleared();
 216
 217     /**
 218         The compare function to be used by control. The default compare function
 219         sorts by container and other items separately and in ascending order.
 220         Override this for a different sorting behaviour.
 221
 222         @see HasDefaultCompare().
 223     */
 224     virtual int Compare(const wxDataViewItem& item1,
 225                         const wxDataViewItem& item2,
 226                         unsigned int column,
 227                         bool ascending);
 228
 229     /**
 230         Oberride this to indicate that the item has special font attributes.
 231         This only affects the wxDataViewTextRendererText renderer.
 232
 233         @see wxDataViewItemAttr.
 234     */
 235     virtual bool GetAttr(const wxDataViewItem& item, unsigned int col,
 236                          wxDataViewItemAttr& attr);
 237
 238     /**
 239         Override this so the control can query the child items of an item.
 240         Returns the number of items.
 241     */
 242     virtual unsigned int GetChildren(const wxDataViewItem& item,
 243                                      wxDataViewItemArray& children) const = 0;
 244
 245     /**
 246         Override this to indicate the number of columns in the model.
 247     */
 248     virtual unsigned int GetColumnCount() const = 0;
 249
 250     /**
 251         Override this to indicate what type of data is stored in the
 252         column specified by @a col.
 253
 254         This should return a string indicating the type of data as reported by wxVariant.
 255     */
 256     virtual wxString GetColumnType(unsigned int col) const = 0;
 257
 258     /**
 259         Override this to indicate which wxDataViewItem representing the parent
 260         of @a item or an invalid wxDataViewItem if the the root item is
 261         the parent item.
 262     */
 263     virtual wxDataViewItem GetParent(const wxDataViewItem& item) const = 0;
 264
 265     /**
 266         Override this to indicate the value of @a item.
 267         A wxVariant is used to store the data.
 268     */
 269     virtual void GetValue(wxVariant& variant, const wxDataViewItem& item,
 270                           unsigned int col) const = 0;
 271
 272     /**
 273         Override this method to indicate if a container item merely acts as a
 274         headline (or for categorisation) or if it also acts a normal item with
 275         entries for futher columns. By default returns @false.
 276     */
 277     virtual bool HasContainerColumns(const wxDataViewItem& item) const;
 278
 279     /**
 280         Override this to indicate that the model provides a default compare
 281         function that the control should use if no wxDataViewColumn has been
 282         chosen for sorting. Usually, the user clicks on a column header for
 283         sorting, the data will be sorted alphanumerically.
 284
 285         If any other order (e.g. by index or order of appearance) is required,
 286         then this should be used.
 287         See wxDataViewIndexListModel for a model which makes use of this.
 288     */
 289     virtual bool HasDefaultCompare() const;
 290
 291     /**
 292         Override this to indicate of @a item is a container, i.e. if
 293         it can have child items.
 294     */
 295     virtual bool IsContainer(const wxDataViewItem& item) const = 0;
 296
 297     /**
 298         Call this to inform the model that an item has been added to the data.
 299     */
 300     virtual bool ItemAdded(const wxDataViewItem& parent,
 301                            const wxDataViewItem& item);
 302
 303     /**
 304         Call this to inform the model that an item has changed.
 305
 306         This will eventually emit a wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
 307         event (in which the column fields will not be set) to the user.
 308     */
 309     virtual bool ItemChanged(const wxDataViewItem& item);
 310
 311     /**
 312         Call this to inform the model that an item has been deleted from the data.
 313     */
 314     virtual bool ItemDeleted(const wxDataViewItem& parent,
 315                              const wxDataViewItem& item);
 316
 317     /**
 318         Call this to inform the model that several items have been added to the data.
 319     */
 320     virtual bool ItemsAdded(const wxDataViewItem& parent,
 321                             const wxDataViewItemArray& items);
 322
 323     /**
 324         Call this to inform the model that several items have changed.
 325
 326         This will eventually emit wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
 327         events (in which the column fields will not be set) to the user.
 328     */
 329     virtual bool ItemsChanged(const wxDataViewItemArray& items);
 330
 331     /**
 332         Call this to inform the model that several items have been deleted.
 333     */
 334     virtual bool ItemsDeleted(const wxDataViewItem& parent,
 335                               const wxDataViewItemArray& items);
 336
 337     /**
 338         Remove the @a notifier from the list of notifiers.
 339     */
 340     void RemoveNotifier(wxDataViewModelNotifier* notifier);
 341
 342     /**
 343         Call this to initiate a resort after the sort function has been changed.
 344     */
 345     virtual void Resort();
 346
 347     /**
 348         This gets called in order to set a value in the data model.
 349         The most common scenario is that the wxDataViewCtrl calls this method
 350         after the user changed some data in the view.
 351
 352         Afterwards ValueChanged() has to be called!
 353     */
 354     virtual bool SetValue(const wxVariant& variant, const wxDataViewItem& item,
 355                           unsigned int col) = 0;
 356
 357     /**
 358         Call this to inform this model that a value in the model has been changed.
 359         This is also called from wxDataViewCtrl's internal editing code, e.g. when
 360         editing a text field in the control.
 361
 362         This will eventually emit a wxEVT_DATAVIEW_ITEM_VALUE_CHANGED
 363         event to the user.
 364     */
 365     virtual bool ValueChanged(const wxDataViewItem& item,
 366                               unsigned int col);
 367
 368 protected:
 369
 370     /**
 371         Destructor. This should not be called directly. Use DecRef() instead.
 372     */
 373     virtual ~wxDataViewModel();
 374 };
 375
 376
 377
 378 /**
 379     @class wxDataViewIndexListModel
 380
 381     wxDataViewIndexListModel is a specialized data model which lets you address
 382     an item by its position (row) rather than its wxDataViewItem (which you can
 383     obtain from this class).
 384     This model also provides its own wxDataViewIndexListModel::Compare
 385     method which sorts the model's data by the index.
 386
 387     This model is not a virtual model since the control stores each wxDataViewItem.
 388     Use wxDataViewVirtualListModel if you need to display millions of items or
 389     have other reason to use a virtual control.
 390
 391     @library{wxadv}
 392     @category{dvc}
 393 */
 394 class wxDataViewIndexListModel : public wxDataViewModel
 395 {
 396 public:
 397     /**
 398         Constructor.
 399     */
 400     wxDataViewIndexListModel(unsigned int initial_size = 0);
 401
 402     /**
 403         Destructor.
 404     */
 405     virtual ~wxDataViewIndexListModel();
 406
 407     /**
 408         Compare method that sorts the items by their index.
 409     */
 410     int Compare(const wxDataViewItem& item1,
 411                 const wxDataViewItem& item2,
 412                 unsigned int column, bool ascending);
 413
 414     /**
 415         Oberride this to indicate that the row has special font attributes.
 416         This only affects the wxDataViewTextRendererText() renderer.
 417
 418         @see wxDataViewItemAttr.
 419     */
 420     virtual bool GetAttr(unsigned int row, unsigned int col,
 421                          wxDataViewItemAttr& attr);
 422
 423     /**
 424         Returns the wxDataViewItem at the given @e row.
 425     */
 426     wxDataViewItem GetItem(unsigned int row) const;
 427
 428     /**
 429         Returns the position of given @e item.
 430     */
 431     unsigned int GetRow(const wxDataViewItem& item) const;
 432
 433     /**
 434         Override this to allow getting values from the model.
 435     */
 436     virtual void GetValue(wxVariant& variant, unsigned int row,
 437                           unsigned int col) const = 0;
 438
 439     /**
 440         Call this after if the data has to be read again from the model.
 441         This is useful after major changes when calling the methods below
 442         (possibly thousands of times) doesn't make sense.
 443     */
 444     void Reset(unsigned int new_size);
 445
 446     /**
 447         Call this after a row has been appended to the model.
 448     */
 449     void RowAppended();
 450
 451     /**
 452         Call this after a row has been changed.
 453     */
 454     void RowChanged(unsigned int row);
 455
 456     /**
 457         Call this after a row has been deleted.
 458     */
 459     void RowDeleted(unsigned int row);
 460
 461     /**
 462         Call this after a row has been inserted at the given position.
 463     */
 464     void RowInserted(unsigned int before);
 465
 466     /**
 467         Call this after a row has been prepended to the model.
 468     */
 469     void RowPrepended();
 470
 471     /**
 472         Call this after a value has been changed.
 473     */
 474     void RowValueChanged(unsigned int row, unsigned int col);
 475
 476     /**
 477         Call this after rows have been deleted.
 478         The array will internally get copied and sorted in descending order so
 479         that the rows with the highest position will be deleted first.
 480     */
 481     void RowsDeleted(const wxArrayInt& rows);
 482
 483     /**
 484         Called in order to set a value in the model.
 485     */
 486     virtual bool SetValue(const wxVariant& variant, unsigned int row,
 487                           unsigned int col) = 0;
 488 };
 489
 490
 491
 492 /**
 493     @class wxDataViewVirtualListModel
 494
 495     wxDataViewVirtualListModel is a specialized data model which lets you address
 496     an item by its position (row) rather than its wxDataViewItem and as such offers
 497     the exact same interface as wxDataViewIndexListModel.
 498     The important difference is that under platforms other than OS X, using this
 499     model will result in a truly virtual control able to handle millions of items
 500     as the control doesn't store any item (a feature not supported by the
 501     Carbon API under OS X).
 502
 503     @see wxDataViewIndexListModel for the API.
 504
 505     @library{wxadv}
 506     @category{dvc}
 507 */
 508 class wxDataViewVirtualListModel : public wxDataViewModel
 509 {
 510 public:
 511     /**
 512         Constructor.
 513     */
 514     wxDataViewVirtualListModel(unsigned int initial_size = 0);
 515 };
 516
 517
 518
 519 /**
 520     @class wxDataViewItemAttr
 521
 522     This class is used to indicate to a wxDataViewCtrl that a certain item
 523     (see wxDataViewItem) has extra font attributes for its renderer.
 524     For this, it is required to override wxDataViewModel::GetAttr.
 525
 526     Attributes are currently only supported by wxDataViewTextRendererText.
 527
 528     @library{wxadv}
 529     @category{dvc}
 530 */
 531 class wxDataViewItemAttr
 532 {
 533 public:
 534     /**
 535         Constructor.
 536     */
 537     wxDataViewItemAttr();
 538
 539     /**
 540         Call this to indicate that the item shall be displayed in bold text.
 541     */
 542     void SetBold(bool set);
 543
 544     /**
 545         Call this to indicate that the item shall be displayed with that colour.
 546     */
 547     void SetColour(const wxColour& colour);
 548
 549     /**
 550         Call this to indicate that the item shall be displayed in italic text.
 551     */
 552     void SetItalic(bool set);
 553 };
 554
 555
 556
 557 /**
 558     @class wxDataViewItem
 559
 560     wxDataViewItem is a small opaque class that represents an item in a wxDataViewCtrl
 561     in a persistent way, i.e. indepent of the position of the item in the control
 562     or changes to its contents.
 563
 564     It must hold a unique ID of type @e void* in its only field and can be converted
 565     to and from it.
 566
 567     If the ID is @NULL the wxDataViewItem is invalid and wxDataViewItem::IsOk will
 568     return @false which used in many places in the API of wxDataViewCtrl to
 569     indicate that e.g. no item was found. An ID of @NULL is also used to indicate
 570     the invisible root. Examples for this are wxDataViewModel::GetParent and
 571     wxDataViewModel::GetChildren.
 572
 573     @library{wxadv}
 574     @category{dvc}
 575 */
 576 class wxDataViewItem
 577 {
 578 public:
 579     //@{
 580     /**
 581         Constructor.
 582     */
 583     wxDataViewItem(void* id = NULL);
 584     wxDataViewItem(const wxDataViewItem& item);
 585     //@}
 586
 587     /**
 588         Returns the ID.
 589     */
 590     void* GetID() const;
 591
 592     /**
 593         Returns @true if the ID is not @NULL.
 594     */
 595     bool IsOk() const;
 596 };
 597
 598
 599
 600 /**
 601     @class wxDataViewCtrl
 602
 603     wxDataViewCtrl is a control to display data either in a tree like fashion or
 604     in a tabular form or both.
 605     If you only need to display a simple tree structure with an API more like the
 606     older wxTreeCtrl class, then the specialized wxDataViewTreeCtrl can be used.
 607
 608     A wxDataViewItem is used to represent a (visible) item in the control.
 609
 610     Unlike wxListCtrl wxDataViewCtrl doesn't get its data from the user through
 611     virtual functions or by setting it directly. Instead you need to write your own
 612     wxDataViewModel and associate it with this control.
 613     Then you need to add a number of wxDataViewColumn to this control to define
 614     what each column shall display. Each wxDataViewColumn in turn owns 1 instance
 615     of a wxDataViewRenderer to render its cells.
 616
 617     A number of standard renderers for rendering text, dates, images, toggle,
 618     a progress bar etc. are provided. Additionally, the user can write custom
 619     renderes deriving from wxDataViewCustomRenderer for displaying anything.
 620
 621     All data transfer from the control to the model and the user code is done
 622     through wxVariant which can be extended to support more data formats as necessary.
 623     Accordingly, all type information uses the strings returned from wxVariant::GetType.
 624
 625     @beginStyleTable
 626     @style{wxDV_SINGLE}
 627            Single selection mode. This is the default.
 628     @style{wxDV_MULTIPLE}
 629            Multiple selection mode.
 630     @style{wxDV_ROW_LINES}
 631            Use alternating colours for rows if supported by platform and theme.
 632     @style{wxDV_HORIZ_RULES}
 633            Display fine rules between row if supported.
 634     @style{wxDV_VERT_RULES}
 635            Display fine rules between columns is supported.
 636     @style{wxDV_VARIABLE_LINE_HEIGHT}
 637            Allow variable line heights.
 638             This can be inefficient when displaying large number of items.
 639     @endStyleTable
 640
 641     @beginEventTable{wxDataViewEvent}
 642     @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
 643            Process a wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
 644     @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
 645            Process a wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED event.
 646     @event{EVT_DATAVIEW_ITEM_EDITING_STARTED(id, func)}
 647            Process a wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED event.
 648     @event{EVT_DATAVIEW_ITEM_EDITING_DONE(id, func)}
 649            Process a wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event.
 650     @event{EVT_DATAVIEW_ITEM_COLLAPSING(id, func)}
 651            Process a wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING event.
 652     @event{EVT_DATAVIEW_ITEM_COLLAPSED(id, func)}
 653            Process a wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED event.
 654     @event{EVT_DATAVIEW_ITEM_EXPANDING(id, func)}
 655            Process a wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING event.
 656     @event{EVT_DATAVIEW_ITEM_EXPANDED(id, func)}
 657            Process a wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED event.
 658     @event{EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, func)}
 659            Process a wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED event.
 660     @event{EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, func)}
 661            Process a wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU event.
 662     @event{EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, func)}
 663            Process a wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICKED event.
 664     @event{EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK(id, func)}
 665            Process a wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED event.
 666     @event{EVT_DATAVIEW_COLUMN_SORTED(id, func)}
 667            Process a wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED event.
 668     @event{EVT_DATAVIEW_COLUMN_REORDERED(id, func)}
 669            Process a wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED event.
 670     @endEventTable
 671
 672     @library{wxadv}
 673     @category{ctrl,dvc}
 674     @appearance{dataviewctrl.png}
 675 */
 676 class wxDataViewCtrl : public wxControl
 677 {
 678 public:
 679     /**
 680         Default Constructor.
 681     */
 682     wxDataViewCtrl();
 683
 684     /**
 685         Constructor. Calls Create().
 686     */
 687     wxDataViewCtrl(wxWindow* parent, wxWindowID id,
 688                    const wxPoint& pos = wxDefaultPosition,
 689                    const wxSize& size = wxDefaultSize,
 690                    long style = 0,
 691                    const wxValidator& validator = wxDefaultValidator);
 692
 693     /**
 694         Destructor.
 695     */
 696     virtual ~wxDataViewCtrl();
 697
 698     /**
 699         Appends a wxDataViewColumn to the control. Returns @true on success.
 700
 701         Note that there is a number of short cut methods which implicitly create
 702         a wxDataViewColumn and a wxDataViewRenderer for it (see below).
 703     */
 704     virtual bool AppendColumn(wxDataViewColumn* col);
 705
 706     /**
 707         Prepends a wxDataViewColumn to the control. Returns @true on success.
 708
 709         Note that there is a number of short cut methods which implicitly create
 710         a wxDataViewColumn and a wxDataViewRenderer for it.
 711     */
 712     virtual bool PrependColumn(wxDataViewColumn* col);
 713
 714     /**
 715         Inserts a wxDataViewColumn to the control. Returns @true on success.
 716     */
 717     virtual bool InsertColumn(unsigned int pos, wxDataViewColumn* col);
 718
 719     //@{
 720     /**
 721         Appends a column for rendering a bitmap. Returns the wxDataViewColumn
 722         created in the function or @NULL on failure.
 723     */
 724     wxDataViewColumn* AppendBitmapColumn(const wxString& label,
 725                                          unsigned int model_column,
 726                                          wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 727                                          int width = -1,
 728                                          wxAlignment align = wxALIGN_CENTER,
 729                                          int flags = wxDATAVIEW_COL_RESIZABLE);
 730     wxDataViewColumn* AppendBitmapColumn(const wxBitmap& label,
 731                                          unsigned int model_column,
 732                                          wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 733                                          int width = -1,
 734                                          wxAlignment align = wxALIGN_CENTER,
 735                                          int flags = wxDATAVIEW_COL_RESIZABLE);
 736     //@}
 737
 738     //@{
 739     /**
 740         Appends a column for rendering a date. Returns the wxDataViewColumn
 741         created in the function or @NULL on failure.
 742
 743         @note The @a align parameter is applied to both the column header and
 744               the column renderer.
 745     */
 746     wxDataViewColumn* AppendDateColumn(const wxString& label,
 747                                        unsigned int model_column,
 748                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
 749                                        int width = -1,
 750                                        wxAlignment align = wxALIGN_CENTER,
 751                                        int flags = wxDATAVIEW_COL_RESIZABLE);
 752     wxDataViewColumn* AppendDateColumn(const wxBitmap& label,
 753                                        unsigned int model_column,
 754                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
 755                                        int width = -1,
 756                                        wxAlignment align = wxALIGN_CENTER,
 757                                        int flags = wxDATAVIEW_COL_RESIZABLE);
 758     //@}
 759
 760     //@{
 761     /**
 762         Appends a column for rendering text with an icon. Returns the wxDataViewColumn
 763         created in the function or @NULL on failure.
 764         This method uses the wxDataViewIconTextRenderer class.
 765
 766         @note The @a align parameter is applied to both the column header and
 767               the column renderer.
 768     */
 769     wxDataViewColumn* AppendIconTextColumn(const wxString& label,
 770                                            unsigned int model_column,
 771                                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 772                                            int width = -1,
 773                                            wxAlignment align = wxALIGN_LEFT,
 774                                            int flags = wxDATAVIEW_COL_RESIZABLE);
 775     wxDataViewColumn* AppendIconTextColumn(const wxBitmap& label,
 776                                            unsigned int model_column,
 777                                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 778                                            int width = -1,
 779                                            wxAlignment align = wxALIGN_LEFT,
 780                                            int flags = wxDATAVIEW_COL_RESIZABLE);
 781     //@}
 782
 783     //@{
 784     /**
 785         Appends a column for rendering a progress indicator. Returns the
 786         wxDataViewColumn created in the function or @NULL on failure.
 787
 788         @note The @a align parameter is applied to both the column header and
 789               the column renderer.
 790     */
 791     wxDataViewColumn* AppendProgressColumn(const wxString& label,
 792                                            unsigned int model_column,
 793                                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 794                                            int width = 80,
 795                                            wxAlignment align = wxALIGN_CENTER,
 796                                            int flags = wxDATAVIEW_COL_RESIZABLE);
 797     wxDataViewColumn* AppendProgressColumn(const wxBitmap& label,
 798                                            unsigned int model_column,
 799                                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 800                                            int width = 80,
 801                                            wxAlignment align = wxALIGN_CENTER,
 802                                            int flags = wxDATAVIEW_COL_RESIZABLE);
 803     //@}
 804
 805     //@{
 806     /**
 807         Appends a column for rendering text. Returns the wxDataViewColumn
 808         created in the function or @NULL on failure.
 809
 810         @note The @a align parameter is applied to both the column header and
 811               the column renderer.
 812     */
 813     wxDataViewColumn* AppendTextColumn(const wxString& label,
 814                                        unsigned int model_column,
 815                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 816                                        int width = -1,
 817                                        wxAlignment align = wxALIGN_LEFT,
 818                                        int flags = wxDATAVIEW_COL_RESIZABLE);
 819     wxDataViewColumn* AppendTextColumn(const wxBitmap& label,
 820                                        unsigned int model_column,
 821                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 822                                        int width = -1,
 823                                        wxAlignment align = wxALIGN_LEFT,
 824                                        int flags = wxDATAVIEW_COL_RESIZABLE);
 825     //@}
 826
 827     //@{
 828     /**
 829         Appends a column for rendering a toggle. Returns the wxDataViewColumn
 830         created in the function or @NULL on failure.
 831
 832         @note The @a align parameter is applied to both the column header and
 833               the column renderer.
 834     */
 835     wxDataViewColumn* AppendToggleColumn(const wxString& label,
 836                                          unsigned int model_column,
 837                                          wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 838                                          int width = 30,
 839                                          wxAlignment align = wxALIGN_CENTER,
 840                                          int flags = wxDATAVIEW_COL_RESIZABLE);
 841     wxDataViewColumn* AppendToggleColumn(const wxBitmap& label,
 842                                          unsigned int model_column,
 843                                          wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 844                                          int width = 30,
 845                                          wxAlignment align = wxALIGN_CENTER,
 846                                          int flags = wxDATAVIEW_COL_RESIZABLE);
 847     //@}
 848
 849     /**
 850         Associates a wxDataViewModel with the control.
 851         This increases the reference count of the model by 1.
 852     */
 853     virtual bool AssociateModel(wxDataViewModel* model);
 854
 855     /**
 856         Removes all columns.
 857     */
 858     virtual bool ClearColumns();
 859
 860     /**
 861         Collapses the item.
 862     */
 863     virtual void Collapse(const wxDataViewItem& item);
 864
 865     /**
 866         Create the control. Useful for two step creation.
 867     */
 868     bool Create(wxWindow* parent, wxWindowID id,
 869                 const wxPoint& pos = wxDefaultPosition,
 870                 const wxSize& size = wxDefaultSize,
 871                 long style = 0,
 872                 const wxValidator& validator = wxDefaultValidator);
 873
 874     /**
 875         Deletes given column.
 876     */
 877     virtual bool DeleteColumn(wxDataViewColumn* column);
 878
 879     /**
 880         Call this to ensure that the given item is visible.
 881     */
 882     virtual void EnsureVisible(const wxDataViewItem& item,
 883                                const wxDataViewColumn* column = NULL);
 884
 885     /**
 886         Expands the item.
 887     */
 888     virtual void Expand(const wxDataViewItem& item);
 889
 890     /**
 891         Returns pointer to the column. @a pos refers to the position in the
 892         control which may change after reordering columns by the user.
 893     */
 894     virtual wxDataViewColumn* GetColumn(unsigned int pos) const;
 895
 896     /**
 897         Returns the number of columns.
 898     */
 899     virtual unsigned int GetColumnCount() const;
 900
 901     /**
 902         Returns the position of the column or -1 if not found in the control.
 903     */
 904     virtual int GetColumnPosition(const wxDataViewColumn* column) const;
 905
 906     /**
 907         Returns column containing the expanders.
 908     */
 909     wxDataViewColumn* GetExpanderColumn() const;
 910
 911     /**
 912         Returns indentation.
 913     */
 914     int GetIndent() const;
 915
 916     /**
 917         Returns item rect.
 918     */
 919     virtual wxRect GetItemRect(const wxDataViewItem& item,
 920                                const wxDataViewColumn* col = NULL) const;
 921
 922     /**
 923         Returns pointer to the data model associated with the control (if any).
 924     */
 925     wxDataViewModel* GetModel();
 926
 927     /**
 928         Returns first selected item or an invalid item if none is selected.
 929     */
 930     virtual wxDataViewItem GetSelection() const;
 931
 932     /**
 933         Fills @a sel with currently selected items and returns their number.
 934     */
 935     virtual int GetSelections(wxDataViewItemArray& sel) const;
 936
 937     /**
 938         Returns the wxDataViewColumn currently responsible for sorting
 939         or @NULL if none has been selected.
 940     */
 941     virtual wxDataViewColumn* GetSortingColumn() const;
 942
 943     /**
 944         Hittest.
 945     */
 946     virtual void HitTest(const wxPoint& point, wxDataViewItem& item,
 947                          wxDataViewColumn*& col) const;
 948
 949     /**
 950         Return @true if the item is expanded.
 951
 952         Currently not supported by OS X.
 953     */
 954     virtual bool IsExpanded(const wxDataViewItem& item) const;
 955
 956     /**
 957         Return @true if the item is selected.
 958     */
 959     virtual bool IsSelected(const wxDataViewItem& item) const;
 960
 961     /**
 962         Select the given item.
 963     */
 964     virtual void Select(const wxDataViewItem& item);
 965
 966     /**
 967         Select all items.
 968     */
 969     virtual void SelectAll();
 970
 971     /**
 972         Set which column shall contain the tree-like expanders.
 973     */
 974     void SetExpanderColumn(wxDataViewColumn* col);
 975
 976     /**
 977         Sets the indendation.
 978     */
 979     void SetIndent(int indent);
 980
 981     /**
 982         Sets the selection to the array of wxDataViewItems.
 983     */
 984     virtual void SetSelections(const wxDataViewItemArray& sel);
 985
 986     /**
 987         Unselect the given item.
 988     */
 989     virtual void Unselect(const wxDataViewItem& item);
 990
 991     /**
 992         Unselect all item.
 993         This method only has effect if multiple selections are allowed.
 994     */
 995     virtual void UnselectAll();
 996 };
 997
 998
 999
1000 /**
1001     @class wxDataViewModelNotifier
1002
1003     A wxDataViewModelNotifier instance is owned by a wxDataViewModel and mirrors
1004     its notification interface.
1005     See the documentation of that class for further information.
1006
1007     @library{wxadv}
1008     @category{dvc}
1009 */
1010 class wxDataViewModelNotifier
1011 {
1012 public:
1013     /**
1014         Constructor.
1015     */
1016     wxDataViewModelNotifier();
1017
1018     /**
1019         Destructor.
1020     */
1021     virtual ~wxDataViewModelNotifier();
1022
1023     /**
1024         Called by owning model.
1025     */
1026     virtual bool Cleared() = 0;
1027
1028     /**
1029         Get owning wxDataViewModel.
1030     */
1031     wxDataViewModel* GetOwner() const;
1032
1033     /**
1034         Called by owning model.
1035     */
1036     virtual bool ItemAdded(const wxDataViewItem& parent,
1037                            const wxDataViewItem& item) = 0;
1038
1039     /**
1040         Called by owning model.
1041     */
1042     virtual bool ItemChanged(const wxDataViewItem& item) = 0;
1043
1044     /**
1045         Called by owning model.
1046     */
1047     virtual bool ItemDeleted(const wxDataViewItem& parent,
1048                              const wxDataViewItem& item) = 0;
1049
1050     /**
1051         Called by owning model.
1052     */
1053     virtual bool ItemsAdded(const wxDataViewItem& parent,
1054                             const wxDataViewItemArray& items);
1055
1056     /**
1057         Called by owning model.
1058     */
1059     virtual bool ItemsChanged(const wxDataViewItemArray& items);
1060
1061     /**
1062         Called by owning model.
1063     */
1064     virtual bool ItemsDeleted(const wxDataViewItem& parent,
1065                               const wxDataViewItemArray& items);
1066
1067     /**
1068         Called by owning model.
1069     */
1070     virtual void Resort() = 0;
1071
1072     /**
1073         Set owner of this notifier. Used internally.
1074     */
1075     void SetOwner(wxDataViewModel* owner);
1076
1077     /**
1078         Called by owning model.
1079     */
1080     virtual bool ValueChanged(const wxDataViewItem& item, unsigned int col) = 0;
1081 };
1082
1083
1084 /**
1085     The mode of a data-view cell; see wxDataViewRenderer for more info.
1086 */
1087 enum wxDataViewCellMode
1088 {
1089     wxDATAVIEW_CELL_INERT,
1090
1091     /**
1092         Indicates that the user can double click the cell and something will
1093         happen (e.g. a window for editing a date will pop up).
1094     */
1095     wxDATAVIEW_CELL_ACTIVATABLE,
1096
1097     /**
1098         Indicates that the user can edit the data in-place, i.e. an control
1099         will show up after a slow click on the cell. This behaviour is best
1100         known from changing the filename in most file managers etc.
1101     */
1102     wxDATAVIEW_CELL_EDITABLE
1103 };
1104
1105 /**
1106     The values of this enum controls how a wxDataViewRenderer should display
1107     its contents in a cell.
1108 */
1109 enum wxDataViewCellRenderState
1110 {
1111     wxDATAVIEW_CELL_SELECTED    = 1,
1112     wxDATAVIEW_CELL_PRELIT      = 2,
1113     wxDATAVIEW_CELL_INSENSITIVE = 4,
1114     wxDATAVIEW_CELL_FOCUSED     = 8
1115 };
1116
1117 /**
1118     @class wxDataViewRenderer
1119
1120     This class is used by wxDataViewCtrl to render the individual cells.
1121     One instance of a renderer class is owned by a wxDataViewColumn.
1122     There is a number of ready-to-use renderers provided:
1123     - wxDataViewTextRenderer,
1124     - wxDataViewTextRendererAttr,
1125     - wxDataViewIconTextRenderer,
1126     - wxDataViewToggleRenderer,
1127     - wxDataViewProgressRenderer,
1128     - wxDataViewBitmapRenderer,
1129     - wxDataViewDateRenderer,
1130     - wxDataViewSpinRenderer.
1131
1132     Additionally, the user can write own renderers by deriving from
1133     wxDataViewCustomRenderer.
1134
1135     The ::wxDataViewCellMode and ::wxDataViewCellRenderState flags accepted
1136     by the constructors respectively controls what actions the cell data allows
1137     and how the renderer should display its contents in a cell.
1138
1139     @library{wxadv}
1140     @category{dvc}
1141 */
1142 class wxDataViewRenderer : public wxObject
1143 {
1144 public:
1145     /**
1146         Constructor.
1147     */
1148     wxDataViewRenderer(const wxString& varianttype,
1149                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1150                        int align = wxDVR_DEFAULT_ALIGNMENT );
1151
1152     /**
1153         Returns the alignment. See SetAlignment()
1154     */
1155     virtual int GetAlignment() const;
1156
1157     /**
1158         Returns the cell mode.
1159     */
1160     virtual wxDataViewCellMode GetMode() const;
1161
1162     /**
1163         Returns pointer to the owning wxDataViewColumn.
1164     */
1165     wxDataViewColumn* GetOwner() const;
1166
1167     /**
1168         This methods retrieves the value from the renderer in order to
1169         transfer the value back to the data model.
1170
1171         Returns @false on failure.
1172     */
1173     virtual bool GetValue(wxVariant& value) const = 0;
1174
1175     /**
1176         Returns a string with the type of the wxVariant supported by this renderer.
1177     */
1178     wxString GetVariantType() const;
1179
1180     /**
1181         Sets the alignment of the renderer's content.
1182         The default value of @c wxDVR_DEFAULT_ALIGMENT indicates that the content
1183         should have the same alignment as the column header.
1184
1185         The method is not implemented under OS X and the renderer always aligns
1186         its contents as the column header on that platform. The other platforms
1187         support both vertical and horizontal alignment.
1188     */
1189     virtual void SetAlignment( int align );
1190     /**
1191         Sets the owning wxDataViewColumn.
1192         This is usually called from within wxDataViewColumn.
1193     */
1194     void SetOwner(wxDataViewColumn* owner);
1195
1196     /**
1197         Set the value of the renderer (and thus its cell) to @a value.
1198         The internal code will then render this cell with this data.
1199     */
1200     virtual bool SetValue(const wxVariant& value) = 0;
1201
1202     /**
1203         Before data is committed to the data model, it is passed to this
1204         method where it can be checked for validity. This can also be
1205         used for checking a valid range or limiting the user input in
1206         a certain aspect (e.g. max number of characters or only alphanumeric
1207         input, ASCII only etc.). Return @false if the value is not valid.
1208
1209         Please note that due to implementation limitations, this validation
1210         is done after the editing control already is destroyed and the
1211         editing process finished.
1212     */
1213     virtual bool Validate(wxVariant& value);
1214 };
1215
1216
1217
1218 /**
1219     @class wxDataViewTextRenderer
1220
1221     wxDataViewTextRenderer is used for rendering text.
1222     It supports in-place editing if desired.
1223
1224     @library{wxadv}
1225     @category{dvc}
1226 */
1227 class wxDataViewTextRenderer : public wxDataViewRenderer
1228 {
1229 public:
1230     /**
1231         The ctor.
1232     */
1233     wxDataViewTextRenderer(const wxString& varianttype = "string",
1234                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1235                            int align = wxDVR_DEFAULT_ALIGNMENT );
1236 };
1237
1238
1239
1240 /**
1241     @class wxDataViewIconTextRenderer
1242
1243     The wxDataViewIconTextRenderer class is used to display text with
1244     a small icon next to it as it is typically done in a file manager.
1245
1246     This classes uses the wxDataViewIconText helper class to store its data.
1247     wxDataViewIonText can be converted to and from a wxVariant using the left shift
1248     operator.
1249
1250     @library{wxadv}
1251     @category{dvc}
1252 */
1253 class wxDataViewIconTextRenderer : public wxDataViewRenderer
1254 {
1255 public:
1256     /**
1257         The ctor.
1258     */
1259     wxDataViewIconTextRenderer(const wxString& varianttype = "wxDataViewIconText",
1260                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1261                                int align = wxDVR_DEFAULT_ALIGNMENT );
1262 };
1263
1264
1265
1266 /**
1267     @class wxDataViewProgressRenderer
1268
1269     This class is used by wxDataViewCtrl to render progress bars.
1270
1271     @library{wxadv}
1272     @category{dvc}
1273 */
1274 class wxDataViewProgressRenderer : public wxDataViewRenderer
1275 {
1276 public:
1277     /**
1278         The ctor.
1279     */
1280     wxDataViewProgressRenderer(const wxString& label = wxEmptyString,
1281                                const wxString& varianttype = "long",
1282                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1283                                int align = wxDVR_DEFAULT_ALIGNMENT );
1284 };
1285
1286
1287
1288 /**
1289     @class wxDataViewSpinRenderer
1290
1291     This is a specialized renderer for rendering integer values.
1292     It supports modifying the values in-place by using a wxSpinCtrl.
1293     The renderer only support variants of type @e long.
1294
1295     @library{wxadv}
1296     @category{dvc}
1297 */
1298 class wxDataViewSpinRenderer : public wxDataViewCustomRenderer
1299 {
1300 public:
1301     /**
1302         Constructor.
1303         @a min and @a max indicate the minimum and maximum values for the wxSpinCtrl.
1304     */
1305     wxDataViewSpinRenderer(int min, int max,
1306                            wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
1307                            int align = wxDVR_DEFAULT_ALIGNMENT);
1308 };
1309
1310
1311
1312 /**
1313     @class wxDataViewToggleRenderer
1314
1315     This class is used by wxDataViewCtrl to render toggle controls.
1316
1317     @library{wxadv}
1318     @category{dvc}
1319 */
1320 class wxDataViewToggleRenderer : public wxDataViewRenderer
1321 {
1322 public:
1323     /**
1324         The ctor.
1325     */
1326     wxDataViewToggleRenderer(const wxString& varianttype = "bool",
1327                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1328                              int align = wxDVR_DEFAULT_ALIGNMENT);
1329 };
1330
1331
1332
1333 /**
1334     @class wxDataViewDateRenderer
1335
1336     This class is used by wxDataViewCtrl to render calendar controls.
1337
1338     @library{wxadv}
1339     @category{dvc}
1340 */
1341 class wxDataViewDateRenderer : public wxDataViewRenderer
1342 {
1343 public:
1344     /**
1345         The ctor.
1346     */
1347     wxDataViewDateRenderer(const wxString& varianttype = "datetime",
1348                            wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
1349                            int align = wxDVR_DEFAULT_ALIGNMENT);
1350 };
1351
1352
1353
1354 /**
1355     @class wxDataViewTextRendererAttr
1356
1357     The same as wxDataViewTextRenderer but with support for font attributes.
1358     Font attributes are currently only supported under GTK+ and MSW.
1359
1360     @see wxDataViewModel::GetAttr and wxDataViewItemAttr.
1361
1362     @library{wxadv}
1363     @category{dvc}
1364 */
1365 class wxDataViewTextRendererAttr : public wxDataViewTextRenderer
1366 {
1367 public:
1368     /**
1369         The ctor.
1370     */
1371     wxDataViewTextRendererAttr(const wxString& varianttype = "string",
1372                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1373                                int align = wxDVR_DEFAULT_ALIGNMENT);
1374 };
1375
1376
1377
1378 /**
1379     @class wxDataViewCustomRenderer
1380
1381     You need to derive a new class from wxDataViewCustomRenderer in
1382     order to write a new renderer.
1383
1384     You need to override at least wxDataViewRenderer::SetValue, wxDataViewRenderer::GetValue,
1385     wxDataViewCustomRenderer::GetSize and wxDataViewCustomRenderer::Render.
1386
1387     If you want your renderer to support in-place editing then you also need to override
1388     wxDataViewCustomRenderer::HasEditorCtrl, wxDataViewCustomRenderer::CreateEditorCtrl
1389     and wxDataViewCustomRenderer::GetValueFromEditorCtrl.
1390
1391     Note that a special event handler will be pushed onto that editor control
1392     which handles @e \<ENTER\> and focus out events in order to end the editing.
1393
1394     @library{wxadv}
1395     @category{dvc}
1396 */
1397 class wxDataViewCustomRenderer : public wxDataViewRenderer
1398 {
1399 public:
1400     /**
1401         Constructor.
1402     */
1403     wxDataViewCustomRenderer(const wxString& varianttype = "string",
1404                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1405                              int align = -1, bool no_init = false);
1406
1407     /**
1408         Destructor.
1409     */
1410     virtual ~wxDataViewCustomRenderer();
1411
1412     /**
1413         Override this to react to double clicks or ENTER.
1414         This method will only be called in wxDATAVIEW_CELL_ACTIVATABLE mode.
1415     */
1416     virtual bool Activate( wxRect cell,
1417                            wxDataViewModel* model,
1418                            const wxDataViewItem & item,
1419                            unsigned int col );
1420
1421     /**
1422         Override this to create the actual editor control once editing
1423         is about to start.
1424
1425         @a parent is the parent of the editor control, @a labelRect indicates the
1426         position and size of the editor control and @a value is its initial value:
1427         @code
1428         {
1429             long l = value;
1430             return new wxSpinCtrl( parent, wxID_ANY, wxEmptyString,
1431                         labelRect.GetTopLeft(), labelRect.GetSize(), 0, 0, 100, l );
1432         }
1433         @endcode
1434     */
1435     virtual wxControl* CreateEditorCtrl(wxWindow* parent,
1436                                         wxRect labelRect,
1437                                         const wxVariant& value);
1438
1439     /**
1440         Create DC on request. Internal.
1441     */
1442     virtual wxDC* GetDC();
1443
1444     /**
1445         Return size required to show content.
1446     */
1447     virtual wxSize GetSize() const = 0;
1448
1449     /**
1450         Overrride this so that the renderer can get the value from the editor
1451         control (pointed to by @a editor):
1452         @code
1453         {
1454             wxSpinCtrl *sc = (wxSpinCtrl*) editor;
1455             long l = sc->GetValue();
1456             value = l;
1457             return true;
1458         }
1459         @endcode
1460     */
1461     virtual bool GetValueFromEditorCtrl(wxControl* editor,
1462                                         wxVariant& value);
1463
1464     /**
1465         Override this and make it return @true in order to
1466         indicate that this renderer supports in-place editing.
1467     */
1468     virtual bool HasEditorCtrl();
1469
1470     /**
1471         Overrride this to react to a left click.
1472         This method will only be called in @c wxDATAVIEW_CELL_ACTIVATABLE mode.
1473     */
1474     virtual bool LeftClick( wxPoint cursor,
1475                             wxRect cell,
1476                             wxDataViewModel * model,
1477                             const wxDataViewItem & item,
1478                             unsigned int col );
1479
1480     /**
1481         Override this to render the cell.
1482         Before this is called, wxDataViewRenderer::SetValue was called
1483         so that this instance knows what to render.
1484     */
1485     virtual bool Render(wxRect cell, wxDC* dc, int state) = 0;
1486
1487     /**
1488         This method should be called from within Render() whenever you need to
1489         render simple text.
1490         This will ensure that the correct colour, font and vertical alignment will
1491         be chosen so the text will look the same as text drawn by native renderers.
1492     */
1493     void RenderText(const wxString& text, int xoffset, wxRect cell,
1494                     wxDC* dc, int state);
1495
1496     /**
1497         Overrride this to start a drag operation. Not yet supported.
1498     */
1499     virtual bool StartDrag(wxPoint cursor, wxRect cell,
1500                            wxDataViewModel* model,
1501                            const wxDataViewItem & item,
1502                            unsigned int col);
1503 };
1504
1505
1506
1507 /**
1508     @class wxDataViewBitmapRenderer
1509
1510     This class is used by wxDataViewCtrl to render bitmap controls.
1511
1512     @library{wxadv}
1513     @category{dvc}
1514 */
1515 class wxDataViewBitmapRenderer : public wxDataViewRenderer
1516 {
1517 public:
1518     /**
1519         The ctor.
1520     */
1521     wxDataViewBitmapRenderer(const wxString& varianttype = "wxBitmap",
1522                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1523                              int align = wxDVR_DEFAULT_ALIGNMENT);
1524 };
1525
1526
1527 /**
1528     The flags used by wxDataViewColumn.
1529 */
1530 enum wxDataViewColumnFlags
1531 {
1532     wxDATAVIEW_COL_RESIZABLE     = 1,
1533     wxDATAVIEW_COL_SORTABLE      = 2,
1534     wxDATAVIEW_COL_REORDERABLE   = 4,
1535     wxDATAVIEW_COL_HIDDEN        = 8
1536 };
1537
1538 /**
1539     @class wxDataViewColumn
1540
1541     This class represents a column in a wxDataViewCtrl.
1542     One wxDataViewColumn is bound to one column in the data model to which the
1543     wxDataViewCtrl has been associated.
1544
1545     An instance of wxDataViewRenderer is used by this class to render its data.
1546
1547     @library{wxadv}
1548     @category{dvc}
1549 */
1550 class wxDataViewColumn : public wxHeaderColumn
1551 {
1552 public:
1553     //@{
1554     /**
1555         Constructors.
1556     */
1557     wxDataViewColumn(const wxString& title,
1558                      wxDataViewRenderer* renderer,
1559                      unsigned int model_column,
1560                      int width = wxDVC_DEFAULT_WIDTH,
1561                      wxAlignment align = wxALIGN_CENTRE,
1562                      int flags = wxDATAVIEW_COL_RESIZABLE);
1563     wxDataViewColumn(const wxBitmap& bitmap,
1564                      wxDataViewRenderer* renderer,
1565                      unsigned int model_column,
1566                      int width = wxDVC_DEFAULT_WIDTH,
1567                      wxAlignment align = wxALIGN_CENTRE,
1568                      int flags = wxDATAVIEW_COL_RESIZABLE);
1569     //@}
1570
1571     /**
1572         Returns the index of the column of the model, which this
1573         wxDataViewColumn is displaying.
1574     */
1575     unsigned int GetModelColumn() const;
1576
1577     /**
1578         Returns the owning wxDataViewCtrl.
1579     */
1580     wxDataViewCtrl* GetOwner() const;
1581
1582     /**
1583         Returns the renderer of this wxDataViewColumn.
1584
1585         @see wxDataViewRenderer.
1586     */
1587     wxDataViewRenderer* GetRenderer() const;
1588 };
1589
1590
1591
1592 /**
1593     @class wxDataViewTreeCtrl
1594
1595     This class is a wxDataViewCtrl which internally uses a wxDataViewTreeStore
1596     and forwards most of its API to that class.
1597     Additionally, it uses a wxImageList to store a list of icons.
1598
1599     The main purpose of this class is to look like a wxTreeCtrl to make a transition
1600     from it to the wxDataViewCtrl class simpler.
1601
1602     @library{wxadv}
1603     @category{ctrl,dvc}
1604     @appearance{dataviewtreectrl.png}
1605 */
1606 class wxDataViewTreeCtrl : public wxDataViewCtrl
1607 {
1608 public:
1609     /**
1610         Default ctor.
1611     */
1612     wxDataViewTreeCtrl();
1613
1614     /**
1615         Constructor. Calls Create().
1616     */
1617     wxDataViewTreeCtrl(wxWindow* parent, wxWindowID id,
1618                        const wxPoint& pos = wxDefaultPosition,
1619                        const wxSize& size = wxDefaultSize,
1620                        long style = wxDV_NO_HEADER,
1621                        const wxValidator& validator = wxDefaultValidator);
1622
1623     /**
1624         Destructor. Deletes the image list if any.
1625     */
1626     virtual ~wxDataViewTreeCtrl();
1627
1628     /**
1629         @todo docme
1630     */
1631     wxDataViewItem AppendContainer(const wxDataViewItem& parent,
1632                                    const wxString& text,
1633                                    int icon = -1,
1634                                    int expanded = -1,
1635                                    wxClientData* data = NULL);
1636
1637     /**
1638         @todo docme
1639     */
1640     wxDataViewItem AppendItem(const wxDataViewItem& parent,
1641                               const wxString& text,
1642                               int icon = -1,
1643                               wxClientData* data = NULL);
1644
1645     /**
1646         Creates the control and a wxDataViewTreeStore as its internal model.
1647     */
1648     bool Create(wxWindow* parent, wxWindowID id,
1649                 const wxPoint& pos = wxDefaultPosition,
1650                 const wxSize& size = wxDefaultSize,
1651                 long style = wxDV_NO_HEADER,
1652                 const wxValidator& validator = wxDefaultValidator);
1653
1654     /**
1655         Calls the identical method from wxDataViewTreeStore.
1656     */
1657     void DeleteAllItems();
1658
1659     /**
1660         Calls the identical method from wxDataViewTreeStore.
1661     */
1662     void DeleteChildren(const wxDataViewItem& item);
1663
1664     /**
1665         Calls the identical method from wxDataViewTreeStore.
1666     */
1667     void DeleteItem(const wxDataViewItem& item);
1668
1669     /**
1670         Calls the identical method from wxDataViewTreeStore.
1671     */
1672     int GetChildCount(const wxDataViewItem& parent) const;
1673
1674     /**
1675         Returns the image list.
1676     */
1677     wxImageList* GetImageList();
1678
1679     /**
1680         Calls the identical method from wxDataViewTreeStore.
1681     */
1682     wxClientData* GetItemData(const wxDataViewItem& item) const;
1683
1684     /**
1685         Calls the identical method from wxDataViewTreeStore.
1686     */
1687     const wxIcon& GetItemExpandedIcon(const wxDataViewItem& item) const;
1688
1689     /**
1690         Calls the identical method from wxDataViewTreeStore.
1691     */
1692     const wxIcon& GetItemIcon(const wxDataViewItem& item) const;
1693
1694     /**
1695         Calls the identical method from wxDataViewTreeStore.
1696     */
1697     wxString GetItemText(const wxDataViewItem& item) const;
1698
1699     /**
1700         Calls the identical method from wxDataViewTreeStore.
1701     */
1702     wxDataViewItem GetNthChild(const wxDataViewItem& parent,
1703                                unsigned int pos) const;
1704
1705     //@{
1706     /**
1707         Returns the store.
1708     */
1709     wxDataViewTreeStore* GetStore() const;
1710     const wxDataViewTreeStore* GetStore() const;
1711     //@}
1712
1713     /**
1714         Calls the same method from wxDataViewTreeStore but uses
1715         an index position in the image list instead of a wxIcon.
1716     */
1717     wxDataViewItem InsertContainer(const wxDataViewItem& parent,
1718                                    const wxDataViewItem& previous,
1719                                    const wxString& text,
1720                                    int icon = -1,
1721                                    int expanded = -1,
1722                                    wxClientData* data = NULL);
1723
1724     /**
1725         Calls the same method from wxDataViewTreeStore but uses
1726         an index position in the image list instead of a wxIcon.
1727     */
1728     wxDataViewItem InsertItem(const wxDataViewItem& parent,
1729                               const wxDataViewItem& previous,
1730                               const wxString& text,
1731                               int icon = -1,
1732                               wxClientData* data = NULL);
1733
1734     /**
1735         Calls the same method from wxDataViewTreeStore but uses
1736         an index position in the image list instead of a wxIcon.
1737     */
1738     wxDataViewItem PrependContainer(const wxDataViewItem& parent,
1739                                     const wxString& text,
1740                                     int icon = -1,
1741                                     int expanded = -1,
1742                                     wxClientData* data = NULL);
1743
1744     /**
1745         Calls the same method from wxDataViewTreeStore but uses
1746         an index position in the image list instead of a wxIcon.
1747     */
1748     wxDataViewItem PrependItem(const wxDataViewItem& parent,
1749                                const wxString& text,
1750                                int icon = -1,
1751                                wxClientData* data = NULL);
1752
1753     /**
1754         Sets the image list.
1755     */
1756     void SetImageList(wxImageList* imagelist);
1757
1758     /**
1759         Calls the identical method from wxDataViewTreeStore.
1760     */
1761     void SetItemData(const wxDataViewItem& item, wxClientData* data);
1762
1763     /**
1764         Calls the identical method from wxDataViewTreeStore.
1765     */
1766     void SetItemExpandedIcon(const wxDataViewItem& item,
1767                              const wxIcon& icon);
1768
1769     /**
1770         Calls the identical method from wxDataViewTreeStore.
1771     */
1772     void SetItemIcon(const wxDataViewItem& item, const wxIcon& icon);
1773
1774     /**
1775         Calls the identical method from wxDataViewTreeStore.
1776     */
1777     void SetItemText(const wxDataViewItem& item,
1778                      const wxString& text);
1779 };
1780
1781
1782
1783 /**
1784     @class wxDataViewTreeStore
1785
1786     wxDataViewTreeStore is a specialised wxDataViewModel for displaying simple
1787     trees very much like wxTreeCtrl does and it offers a similar API.
1788
1789     This class actually stores the entire tree (therefore its name) and implements
1790     all virtual methods from the base class so it can be used directly without
1791     having to derive any class from it.
1792     This comes at the price of much reduced flexibility.
1793
1794     @library{wxadv}
1795     @category{dvc}
1796 */
1797 class wxDataViewTreeStore : public wxDataViewModel
1798 {
1799 public:
1800     /**
1801         Constructor. Creates the invisible root node internally.
1802     */
1803     wxDataViewTreeStore();
1804
1805     /**
1806         Destructor.
1807     */
1808     virtual ~wxDataViewTreeStore();
1809
1810     /**
1811         Append a container.
1812     */
1813     wxDataViewItem AppendContainer(const wxDataViewItem& parent,
1814                                    const wxString& text,
1815                                    const wxIcon& icon = wxNullIcon,
1816                                    const wxIcon& expanded = wxNullIcon,
1817                                    wxClientData* data = NULL);
1818
1819     /**
1820         Append an item.
1821     */
1822     wxDataViewItem AppendItem(const wxDataViewItem& parent,
1823                               const wxString& text,
1824                               const wxIcon& icon = wxNullIcon,
1825                               wxClientData* data = NULL);
1826
1827     /**
1828         Delete all item in the model.
1829     */
1830     void DeleteAllItems();
1831
1832     /**
1833         Delete all children of the item, but not the item itself.
1834     */
1835     void DeleteChildren(const wxDataViewItem& item);
1836
1837     /**
1838         Delete this item.
1839     */
1840     void DeleteItem(const wxDataViewItem& item);
1841
1842     /**
1843         Return the number of children of item.
1844     */
1845     int GetChildCount(const wxDataViewItem& parent) const;
1846
1847     /**
1848         Returns the client data asoociated with the item.
1849     */
1850     wxClientData* GetItemData(const wxDataViewItem& item) const;
1851
1852     /**
1853         Returns the icon to display in expanded containers.
1854     */
1855     const wxIcon& GetItemExpandedIcon(const wxDataViewItem& item) const;
1856
1857     /**
1858         Returns the icon of the item.
1859     */
1860     const wxIcon& GetItemIcon(const wxDataViewItem& item) const;
1861
1862     /**
1863         Returns the text of the item.
1864     */
1865     wxString GetItemText(const wxDataViewItem& item) const;
1866
1867     /**
1868         Returns the nth child item of item.
1869     */
1870     wxDataViewItem GetNthChild(const wxDataViewItem& parent,
1871                                unsigned int pos) const;
1872
1873     /**
1874         Inserts a container after @a previous.
1875     */
1876     wxDataViewItem InsertContainer(const wxDataViewItem& parent,
1877                                    const wxDataViewItem& previous,
1878                                    const wxString& text,
1879                                    const wxIcon& icon = wxNullIcon,
1880                                    const wxIcon& expanded = wxNullIcon,
1881                                    wxClientData* data = NULL);
1882
1883     /**
1884         Inserts an item after @a previous.
1885     */
1886     wxDataViewItem InsertItem(const wxDataViewItem& parent,
1887                               const wxDataViewItem& previous,
1888                               const wxString& text,
1889                               const wxIcon& icon = wxNullIcon,
1890                               wxClientData* data = NULL);
1891
1892     /**
1893         Inserts a container before the first child item or @a parent.
1894     */
1895     wxDataViewItem PrependContainer(const wxDataViewItem& parent,
1896                                     const wxString& text,
1897                                     const wxIcon& icon = wxNullIcon,
1898                                     const wxIcon& expanded = wxNullIcon,
1899                                     wxClientData* data = NULL);
1900
1901     /**
1902         Inserts an item before the first child item or @a parent.
1903     */
1904     wxDataViewItem PrependItem(const wxDataViewItem& parent,
1905                                const wxString& text,
1906                                const wxIcon& icon = wxNullIcon,
1907                                wxClientData* data = NULL);
1908
1909     /**
1910         Sets the client data associated with the item.
1911     */
1912     void SetItemData(const wxDataViewItem& item, wxClientData* data);
1913
1914     /**
1915         Sets the expanded icon for the item.
1916     */
1917     void SetItemExpandedIcon(const wxDataViewItem& item,
1918                              const wxIcon& icon);
1919
1920     /**
1921         Sets the icon for the item.
1922     */
1923     void SetItemIcon(const wxDataViewItem& item, const wxIcon& icon);
1924 };
1925