include/wx/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dataview.h
   3 // Purpose:     wxDataViewCtrl base classes
   4 // Author:      Robert Roebling
   5 // Modified by: Bo Yang
   6 // Created:     08.01.06
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DATAVIEW_H_BASE_
  13 #define _WX_DATAVIEW_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_DATAVIEWCTRL
  18
  19 #include "wx/textctrl.h"
  20 #include "wx/headercol.h"
  21 #include "wx/variant.h"
  22 #include "wx/dynarray.h"
  23 #include "wx/icon.h"
  24 #include "wx/itemid.h"
  25 #include "wx/weakref.h"
  26 #include "wx/vector.h"
  27 #include "wx/dataobj.h"
  28 #include "wx/withimages.h"
  29
  30 class WXDLLIMPEXP_FWD_CORE wxImageList;
  31
  32 #if !(defined(__WXGTK20__) || defined(__WXOSX__)) || defined(__WXUNIVERSAL__)
  33 // #if !(defined(__WXOSX__)) || defined(__WXUNIVERSAL__)
  34     #define wxHAS_GENERIC_DATAVIEWCTRL
  35 #endif
  36
  37 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
  38     // this symbol doesn't follow the convention for wxUSE_XXX symbols which
  39     // are normally always defined as either 0 or 1, so its use is deprecated
  40     // and it only exists for backwards compatibility, don't use it any more
  41     // and use wxHAS_GENERIC_DATAVIEWCTRL instead
  42     #define wxUSE_GENERICDATAVIEWCTRL
  43 #endif
  44
  45 // ----------------------------------------------------------------------------
  46 // wxDataViewCtrl globals
  47 // ----------------------------------------------------------------------------
  48
  49 class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
  50 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
  51 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
  52 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
  53 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
  54
  55 extern WXDLLIMPEXP_DATA_ADV(const char) wxDataViewCtrlNameStr[];
  56
  57 // ----------------------------------------------------------------------------
  58 // wxDataViewCtrl flags
  59 // ----------------------------------------------------------------------------
  60
  61 // size of a wxDataViewRenderer without contents:
  62 #define wxDVC_DEFAULT_RENDERER_SIZE     20
  63
  64 // the default width of new (text) columns:
  65 #define wxDVC_DEFAULT_WIDTH             80
  66
  67 // the default width of new toggle columns:
  68 #define wxDVC_TOGGLE_DEFAULT_WIDTH      30
  69
  70 // the default minimal width of the columns:
  71 #define wxDVC_DEFAULT_MINWIDTH          30
  72
  73 // The default alignment of wxDataViewRenderers is to take
  74 // the alignment from the column it owns.
  75 #define wxDVR_DEFAULT_ALIGNMENT         -1
  76
  77
  78 // ---------------------------------------------------------
  79 // wxDataViewItem
  80 // ---------------------------------------------------------
  81
  82 // Make it a class and not a typedef to allow forward declaring it.
  83 class wxDataViewItem : public wxItemId<void*>
  84 {
  85 public:
  86     wxDataViewItem() : wxItemId<void*>() { }
  87     wxEXPLICIT wxDataViewItem(void* pItem) : wxItemId<void*>(pItem) { }
  88 };
  89
  90 WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
  91
  92 // ---------------------------------------------------------
  93 // wxDataViewModelNotifier
  94 // ---------------------------------------------------------
  95
  96 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
  97 {
  98 public:
  99     wxDataViewModelNotifier() { m_owner = NULL; }
 100     virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
 101
 102     virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
 103     virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
 104     virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
 105     virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 106     virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 107     virtual bool ItemsChanged( const wxDataViewItemArray &items );
 108     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
 109     virtual bool Cleared() = 0;
 110
 111     // some platforms, such as GTK+, may need a two step procedure for ::Reset()
 112     virtual bool BeforeReset() { return true; }
 113     virtual bool AfterReset() { return Cleared(); }
 114
 115     virtual void Resort() = 0;
 116
 117     void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
 118     wxDataViewModel *GetOwner() const       { return m_owner; }
 119
 120 private:
 121     wxDataViewModel *m_owner;
 122 };
 123
 124
 125
 126 // ----------------------------------------------------------------------------
 127 // wxDataViewItemAttr: a structure containing the visual attributes of an item
 128 // ----------------------------------------------------------------------------
 129
 130 // TODO: this should be renamed to wxItemAttr or something general like this
 131
 132 class WXDLLIMPEXP_ADV wxDataViewItemAttr
 133 {
 134 public:
 135     // ctors
 136     wxDataViewItemAttr()
 137     {
 138         m_bold = false;
 139         m_italic = false;
 140     }
 141
 142     // setters
 143     void SetColour(const wxColour& colour) { m_colour = colour; }
 144     void SetBold( bool set ) { m_bold = set; }
 145     void SetItalic( bool set ) { m_italic = set; }
 146
 147     // accessors
 148     bool HasColour() const { return m_colour.IsOk(); }
 149     const wxColour& GetColour() const { return m_colour; }
 150
 151     bool HasFont() const { return m_bold || m_italic; }
 152     bool GetBold() const { return m_bold; }
 153     bool GetItalic() const { return m_italic; }
 154
 155     bool IsDefault() const { return !(HasColour() || HasFont()); }
 156
 157     // Return the font based on the given one with this attribute applied to it.
 158     wxFont GetEffectiveFont(const wxFont& font) const;
 159
 160 private:
 161     wxColour m_colour;
 162     bool     m_bold;
 163     bool     m_italic;
 164 };
 165
 166
 167 // ---------------------------------------------------------
 168 // wxDataViewModel
 169 // ---------------------------------------------------------
 170
 171 WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier, wxDataViewModelNotifiers,
 172                           class WXDLLIMPEXP_ADV);
 173
 174 class WXDLLIMPEXP_ADV wxDataViewModel: public wxRefCounter
 175 {
 176 public:
 177     wxDataViewModel();
 178
 179     virtual unsigned int GetColumnCount() const = 0;
 180
 181     // return type as reported by wxVariant
 182     virtual wxString GetColumnType( unsigned int col ) const = 0;
 183
 184     // get value into a wxVariant
 185     virtual void GetValue( wxVariant &variant,
 186                            const wxDataViewItem &item, unsigned int col ) const = 0;
 187
 188     // return true if the given item has a value to display in the given
 189     // column: this is always true except for container items which by default
 190     // only show their label in the first column (but see HasContainerColumns())
 191     bool HasValue(const wxDataViewItem& item, unsigned col) const
 192     {
 193         return col == 0 || !IsContainer(item) || HasContainerColumns(item);
 194     }
 195
 196     // usually ValueChanged() should be called after changing the value in the
 197     // model to update the control, ChangeValue() does it on its own while
 198     // SetValue() does not -- so while you will override SetValue(), you should
 199     // be usually calling ChangeValue()
 200     virtual bool SetValue(const wxVariant &variant,
 201                           const wxDataViewItem &item,
 202                           unsigned int col) = 0;
 203
 204     bool ChangeValue(const wxVariant& variant,
 205                      const wxDataViewItem& item,
 206                      unsigned int col)
 207     {
 208         return SetValue(variant, item, col) && ValueChanged(item, col);
 209     }
 210
 211     // Get text attribute, return false of default attributes should be used
 212     virtual bool GetAttr(const wxDataViewItem &WXUNUSED(item),
 213                          unsigned int WXUNUSED(col),
 214                          wxDataViewItemAttr &WXUNUSED(attr)) const
 215     {
 216         return false;
 217     }
 218
 219     // Override this if you want to disable specific items
 220     virtual bool IsEnabled(const wxDataViewItem &WXUNUSED(item),
 221                            unsigned int WXUNUSED(col)) const
 222     {
 223         return true;
 224     }
 225
 226     // define hierachy
 227     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
 228     virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
 229     // Is the container just a header or an item with all columns
 230     virtual bool HasContainerColumns(const wxDataViewItem& WXUNUSED(item)) const
 231         { return false; }
 232     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
 233
 234     // delegated notifiers
 235     bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
 236     bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 237     bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
 238     bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 239     bool ItemChanged( const wxDataViewItem &item );
 240     bool ItemsChanged( const wxDataViewItemArray &items );
 241     bool ValueChanged( const wxDataViewItem &item, unsigned int col );
 242     bool Cleared();
 243
 244     // some platforms, such as GTK+, may need a two step procedure for ::Reset()
 245     bool BeforeReset();
 246     bool AfterReset();
 247
 248
 249     // delegated action
 250     virtual void Resort();
 251
 252     void AddNotifier( wxDataViewModelNotifier *notifier );
 253     void RemoveNotifier( wxDataViewModelNotifier *notifier );
 254
 255     // default compare function
 256     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 257                          unsigned int column, bool ascending ) const;
 258     virtual bool HasDefaultCompare() const { return false; }
 259
 260     // internal
 261     virtual bool IsListModel() const { return false; }
 262     virtual bool IsVirtualListModel() const { return false; }
 263
 264 protected:
 265     // the user should not delete this class directly: he should use DecRef() instead!
 266     virtual ~wxDataViewModel() { }
 267
 268     wxDataViewModelNotifiers  m_notifiers;
 269 };
 270
 271 // ----------------------------------------------------------------------------
 272 // wxDataViewListModel: a model of a list, i.e. flat data structure without any
 273 //      branches/containers, used as base class by wxDataViewIndexListModel and
 274 //      wxDataViewVirtualListModel
 275 // ----------------------------------------------------------------------------
 276
 277 class WXDLLIMPEXP_ADV wxDataViewListModel : public wxDataViewModel
 278 {
 279 public:
 280     // derived classes should override these methods instead of
 281     // {Get,Set}Value() and GetAttr() inherited from the base class
 282
 283     virtual void GetValueByRow(wxVariant &variant,
 284                                unsigned row, unsigned col) const = 0;
 285
 286     virtual bool SetValueByRow(const wxVariant &variant,
 287                                unsigned row, unsigned col) = 0;
 288
 289     virtual bool
 290     GetAttrByRow(unsigned WXUNUSED(row), unsigned WXUNUSED(col),
 291                  wxDataViewItemAttr &WXUNUSED(attr)) const
 292     {
 293         return false;
 294     }
 295
 296     virtual bool IsEnabledByRow(unsigned int WXUNUSED(row),
 297                                 unsigned int WXUNUSED(col)) const
 298     {
 299         return true;
 300     }
 301
 302
 303     // helper methods provided by list models only
 304     virtual unsigned GetRow( const wxDataViewItem &item ) const = 0;
 305
 306     // returns the number of rows
 307     virtual unsigned int GetCount() const = 0;
 308
 309     // implement some base class pure virtual directly
 310     virtual wxDataViewItem
 311     GetParent( const wxDataViewItem & WXUNUSED(item) ) const
 312     {
 313         // items never have valid parent in this model
 314         return wxDataViewItem();
 315     }
 316
 317     virtual bool IsContainer( const wxDataViewItem &item ) const
 318     {
 319         // only the invisible (and invalid) root item has children
 320         return !item.IsOk();
 321     }
 322
 323     // and implement some others by forwarding them to our own ones
 324     virtual void GetValue( wxVariant &variant,
 325                            const wxDataViewItem &item, unsigned int col ) const
 326     {
 327         GetValueByRow(variant, GetRow(item), col);
 328     }
 329
 330     virtual bool SetValue( const wxVariant &variant,
 331                            const wxDataViewItem &item, unsigned int col )
 332     {
 333         return SetValueByRow( variant, GetRow(item), col );
 334     }
 335
 336     virtual bool GetAttr(const wxDataViewItem &item, unsigned int col,
 337                          wxDataViewItemAttr &attr) const
 338     {
 339         return GetAttrByRow( GetRow(item), col, attr );
 340     }
 341
 342     virtual bool IsEnabled(const wxDataViewItem &item, unsigned int col) const
 343     {
 344         return IsEnabledByRow( GetRow(item), col );
 345     }
 346
 347
 348     virtual bool IsListModel() const { return true; }
 349 };
 350
 351 // ---------------------------------------------------------
 352 // wxDataViewIndexListModel
 353 // ---------------------------------------------------------
 354
 355 class WXDLLIMPEXP_ADV wxDataViewIndexListModel: public wxDataViewListModel
 356 {
 357 public:
 358     wxDataViewIndexListModel( unsigned int initial_size = 0 );
 359
 360     void RowPrepended();
 361     void RowInserted( unsigned int before );
 362     void RowAppended();
 363     void RowDeleted( unsigned int row );
 364     void RowsDeleted( const wxArrayInt &rows );
 365     void RowChanged( unsigned int row );
 366     void RowValueChanged( unsigned int row, unsigned int col );
 367     void Reset( unsigned int new_size );
 368
 369     // convert to/from row/wxDataViewItem
 370
 371     virtual unsigned GetRow( const wxDataViewItem &item ) const;
 372     wxDataViewItem GetItem( unsigned int row ) const;
 373
 374     // compare based on index
 375
 376     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 377                          unsigned int column, bool ascending ) const;
 378     virtual bool HasDefaultCompare() const;
 379
 380     // implement base methods
 381     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
 382
 383     unsigned int GetCount() const { return m_hash.GetCount(); }
 384
 385 private:
 386     wxDataViewItemArray m_hash;
 387     unsigned int m_nextFreeID;
 388     bool m_ordered;
 389 };
 390
 391 // ---------------------------------------------------------
 392 // wxDataViewVirtualListModel
 393 // ---------------------------------------------------------
 394
 395 #ifdef __WXMAC__
 396 // better than nothing
 397 typedef wxDataViewIndexListModel wxDataViewVirtualListModel;
 398 #else
 399
 400 class WXDLLIMPEXP_ADV wxDataViewVirtualListModel: public wxDataViewListModel
 401 {
 402 public:
 403     wxDataViewVirtualListModel( unsigned int initial_size = 0 );
 404
 405     void RowPrepended();
 406     void RowInserted( unsigned int before );
 407     void RowAppended();
 408     void RowDeleted( unsigned int row );
 409     void RowsDeleted( const wxArrayInt &rows );
 410     void RowChanged( unsigned int row );
 411     void RowValueChanged( unsigned int row, unsigned int col );
 412     void Reset( unsigned int new_size );
 413
 414     // convert to/from row/wxDataViewItem
 415
 416     virtual unsigned GetRow( const wxDataViewItem &item ) const;
 417     wxDataViewItem GetItem( unsigned int row ) const;
 418
 419     // compare based on index
 420
 421     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 422                          unsigned int column, bool ascending ) const;
 423     virtual bool HasDefaultCompare() const;
 424
 425     // implement base methods
 426     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
 427
 428     unsigned int GetCount() const { return m_size; }
 429
 430     // internal
 431     virtual bool IsVirtualListModel() const { return true; }
 432
 433 private:
 434     unsigned int m_size;
 435     bool m_ordered;
 436 };
 437 #endif
 438
 439 // ----------------------------------------------------------------------------
 440 // wxDataViewRenderer and related classes
 441 // ----------------------------------------------------------------------------
 442
 443 #include "wx/dvrenderers.h"
 444
 445 // ---------------------------------------------------------
 446 // wxDataViewColumnBase
 447 // ---------------------------------------------------------
 448
 449 // for compatibility only, do not use
 450 enum wxDataViewColumnFlags
 451 {
 452     wxDATAVIEW_COL_RESIZABLE     = wxCOL_RESIZABLE,
 453     wxDATAVIEW_COL_SORTABLE      = wxCOL_SORTABLE,
 454     wxDATAVIEW_COL_REORDERABLE   = wxCOL_REORDERABLE,
 455     wxDATAVIEW_COL_HIDDEN        = wxCOL_HIDDEN
 456 };
 457
 458 class WXDLLIMPEXP_ADV wxDataViewColumnBase : public wxSettableHeaderColumn
 459 {
 460 public:
 461     // ctor for the text columns: takes ownership of renderer
 462     wxDataViewColumnBase(wxDataViewRenderer *renderer,
 463                          unsigned int model_column)
 464     {
 465         Init(renderer, model_column);
 466     }
 467
 468     // ctor for the bitmap columns
 469     wxDataViewColumnBase(const wxBitmap& bitmap,
 470                          wxDataViewRenderer *renderer,
 471                          unsigned int model_column)
 472         : m_bitmap(bitmap)
 473     {
 474         Init(renderer, model_column);
 475     }
 476
 477     virtual ~wxDataViewColumnBase();
 478
 479     // setters:
 480     virtual void SetOwner( wxDataViewCtrl *owner )
 481         { m_owner = owner; }
 482
 483     // getters:
 484     unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column); }
 485     wxDataViewCtrl *GetOwner() const        { return m_owner; }
 486     wxDataViewRenderer* GetRenderer() const { return m_renderer; }
 487
 488     // implement some of base class pure virtuals (the rest is port-dependent
 489     // and done differently in generic and native versions)
 490     virtual void SetBitmap( const wxBitmap& bitmap ) { m_bitmap = bitmap; }
 491     virtual wxBitmap GetBitmap() const { return m_bitmap; }
 492
 493 protected:
 494     wxDataViewRenderer      *m_renderer;
 495     int                      m_model_column;
 496     wxBitmap                 m_bitmap;
 497     wxDataViewCtrl          *m_owner;
 498
 499 private:
 500     // common part of all ctors
 501     void Init(wxDataViewRenderer *renderer, unsigned int model_column);
 502 };
 503
 504 // ---------------------------------------------------------
 505 // wxDataViewCtrlBase
 506 // ---------------------------------------------------------
 507
 508 #define wxDV_SINGLE                  0x0000     // for convenience
 509 #define wxDV_MULTIPLE                0x0001     // can select multiple items
 510
 511 #define wxDV_NO_HEADER               0x0002     // column titles not visible
 512 #define wxDV_HORIZ_RULES             0x0004     // light horizontal rules between rows
 513 #define wxDV_VERT_RULES              0x0008     // light vertical rules between columns
 514
 515 #define wxDV_ROW_LINES               0x0010     // alternating colour in rows
 516 #define wxDV_VARIABLE_LINE_HEIGHT    0x0020     // variable line height
 517
 518 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 519 {
 520 public:
 521     wxDataViewCtrlBase();
 522     virtual ~wxDataViewCtrlBase();
 523
 524     // model
 525     // -----
 526
 527     virtual bool AssociateModel( wxDataViewModel *model );
 528     wxDataViewModel* GetModel();
 529     const wxDataViewModel* GetModel() const;
 530
 531
 532     // column management
 533     // -----------------
 534
 535     wxDataViewColumn *PrependTextColumn( const wxString &label, unsigned int model_column,
 536                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 537                     wxAlignment align = wxALIGN_NOT,
 538                     int flags = wxDATAVIEW_COL_RESIZABLE );
 539     wxDataViewColumn *PrependIconTextColumn( const wxString &label, unsigned int model_column,
 540                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 541                     wxAlignment align = wxALIGN_NOT,
 542                     int flags = wxDATAVIEW_COL_RESIZABLE );
 543     wxDataViewColumn *PrependToggleColumn( const wxString &label, unsigned int model_column,
 544                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 545                     wxAlignment align = wxALIGN_CENTER,
 546                     int flags = wxDATAVIEW_COL_RESIZABLE );
 547     wxDataViewColumn *PrependProgressColumn( const wxString &label, unsigned int model_column,
 548                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 549                     wxAlignment align = wxALIGN_CENTER,
 550                     int flags = wxDATAVIEW_COL_RESIZABLE );
 551     wxDataViewColumn *PrependDateColumn( const wxString &label, unsigned int model_column,
 552                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 553                     wxAlignment align = wxALIGN_NOT,
 554                     int flags = wxDATAVIEW_COL_RESIZABLE );
 555     wxDataViewColumn *PrependBitmapColumn( const wxString &label, unsigned int model_column,
 556                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 557                     wxAlignment align = wxALIGN_CENTER,
 558                     int flags = wxDATAVIEW_COL_RESIZABLE );
 559     wxDataViewColumn *PrependTextColumn( const wxBitmap &label, unsigned int model_column,
 560                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 561                     wxAlignment align = wxALIGN_NOT,
 562                     int flags = wxDATAVIEW_COL_RESIZABLE );
 563     wxDataViewColumn *PrependIconTextColumn( const wxBitmap &label, unsigned int model_column,
 564                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 565                     wxAlignment align = wxALIGN_NOT,
 566                     int flags = wxDATAVIEW_COL_RESIZABLE );
 567     wxDataViewColumn *PrependToggleColumn( const wxBitmap &label, unsigned int model_column,
 568                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 569                     wxAlignment align = wxALIGN_CENTER,
 570                     int flags = wxDATAVIEW_COL_RESIZABLE );
 571     wxDataViewColumn *PrependProgressColumn( const wxBitmap &label, unsigned int model_column,
 572                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 573                     wxAlignment align = wxALIGN_CENTER,
 574                     int flags = wxDATAVIEW_COL_RESIZABLE );
 575     wxDataViewColumn *PrependDateColumn( const wxBitmap &label, unsigned int model_column,
 576                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 577                     wxAlignment align = wxALIGN_NOT,
 578                     int flags = wxDATAVIEW_COL_RESIZABLE );
 579     wxDataViewColumn *PrependBitmapColumn( const wxBitmap &label, unsigned int model_column,
 580                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 581                     wxAlignment align = wxALIGN_CENTER,
 582                     int flags = wxDATAVIEW_COL_RESIZABLE );
 583
 584     wxDataViewColumn *AppendTextColumn( const wxString &label, unsigned int model_column,
 585                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 586                     wxAlignment align = wxALIGN_NOT,
 587                     int flags = wxDATAVIEW_COL_RESIZABLE );
 588     wxDataViewColumn *AppendIconTextColumn( const wxString &label, unsigned int model_column,
 589                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 590                     wxAlignment align = wxALIGN_NOT,
 591                     int flags = wxDATAVIEW_COL_RESIZABLE );
 592     wxDataViewColumn *AppendToggleColumn( const wxString &label, unsigned int model_column,
 593                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 594                     wxAlignment align = wxALIGN_CENTER,
 595                     int flags = wxDATAVIEW_COL_RESIZABLE );
 596     wxDataViewColumn *AppendProgressColumn( const wxString &label, unsigned int model_column,
 597                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 598                     wxAlignment align = wxALIGN_CENTER,
 599                     int flags = wxDATAVIEW_COL_RESIZABLE );
 600     wxDataViewColumn *AppendDateColumn( const wxString &label, unsigned int model_column,
 601                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 602                     wxAlignment align = wxALIGN_NOT,
 603                     int flags = wxDATAVIEW_COL_RESIZABLE );
 604     wxDataViewColumn *AppendBitmapColumn( const wxString &label, unsigned int model_column,
 605                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 606                     wxAlignment align = wxALIGN_CENTER,
 607                     int flags = wxDATAVIEW_COL_RESIZABLE );
 608     wxDataViewColumn *AppendTextColumn( const wxBitmap &label, unsigned int model_column,
 609                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 610                     wxAlignment align = wxALIGN_NOT,
 611                     int flags = wxDATAVIEW_COL_RESIZABLE );
 612     wxDataViewColumn *AppendIconTextColumn( const wxBitmap &label, unsigned int model_column,
 613                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 614                     wxAlignment align = wxALIGN_NOT,
 615                     int flags = wxDATAVIEW_COL_RESIZABLE );
 616     wxDataViewColumn *AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
 617                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 618                     wxAlignment align = wxALIGN_CENTER,
 619                     int flags = wxDATAVIEW_COL_RESIZABLE );
 620     wxDataViewColumn *AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
 621                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 622                     wxAlignment align = wxALIGN_CENTER,
 623                     int flags = wxDATAVIEW_COL_RESIZABLE );
 624     wxDataViewColumn *AppendDateColumn( const wxBitmap &label, unsigned int model_column,
 625                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 626                     wxAlignment align = wxALIGN_NOT,
 627                     int flags = wxDATAVIEW_COL_RESIZABLE );
 628     wxDataViewColumn *AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
 629                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 630                     wxAlignment align = wxALIGN_CENTER,
 631                     int flags = wxDATAVIEW_COL_RESIZABLE );
 632
 633     virtual bool PrependColumn( wxDataViewColumn *col );
 634     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 635     virtual bool AppendColumn( wxDataViewColumn *col );
 636
 637     virtual unsigned int GetColumnCount() const = 0;
 638     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const = 0;
 639     virtual int GetColumnPosition( const wxDataViewColumn *column ) const = 0;
 640
 641     virtual bool DeleteColumn( wxDataViewColumn *column ) = 0;
 642     virtual bool ClearColumns() = 0;
 643
 644     void SetExpanderColumn( wxDataViewColumn *col )
 645         { m_expander_column = col ; DoSetExpanderColumn(); }
 646     wxDataViewColumn *GetExpanderColumn() const
 647         { return m_expander_column; }
 648
 649     virtual wxDataViewColumn *GetSortingColumn() const = 0;
 650
 651
 652     // items management
 653     // ----------------
 654
 655     void SetIndent( int indent )
 656         { m_indent = indent ; DoSetIndent(); }
 657     int GetIndent() const
 658         { return m_indent; }
 659
 660     // Current item is the one used by the keyboard navigation, it is the same
 661     // as the (unique) selected item in single selection mode so these
 662     // functions are mostly useful for controls with wxDV_MULTIPLE style.
 663     wxDataViewItem GetCurrentItem() const;
 664     void SetCurrentItem(const wxDataViewItem& item);
 665
 666     // Selection: both GetSelection() and GetSelections() can be used for the
 667     // controls both with and without wxDV_MULTIPLE style. For single selection
 668     // controls GetSelections() is not very useful however. And for multi
 669     // selection controls GetSelection() returns an invalid item if more than
 670     // one item is selected. Use GetSelectedItemsCount() or HasSelection() to
 671     // check if any items are selected at all.
 672     virtual int GetSelectedItemsCount() const = 0;
 673     bool HasSelection() const { return GetSelectedItemsCount() != 0; }
 674     wxDataViewItem GetSelection() const;
 675     virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
 676     virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
 677     virtual void Select( const wxDataViewItem & item ) = 0;
 678     virtual void Unselect( const wxDataViewItem & item ) = 0;
 679     virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
 680
 681     virtual void SelectAll() = 0;
 682     virtual void UnselectAll() = 0;
 683
 684     virtual void Expand( const wxDataViewItem & item ) = 0;
 685     virtual void ExpandAncestors( const wxDataViewItem & item );
 686     virtual void Collapse( const wxDataViewItem & item ) = 0;
 687     virtual bool IsExpanded( const wxDataViewItem & item ) const = 0;
 688
 689     virtual void EnsureVisible( const wxDataViewItem & item,
 690                                 const wxDataViewColumn *column = NULL ) = 0;
 691     virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
 692     virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
 693
 694     virtual bool SetRowHeight( int WXUNUSED(rowHeight) ) { return false; }
 695
 696     virtual void StartEditor( const wxDataViewItem & WXUNUSED(item),
 697                               unsigned int WXUNUSED(column) )
 698         { }
 699
 700 #if wxUSE_DRAG_AND_DROP
 701     virtual bool EnableDragSource(const wxDataFormat& WXUNUSED(format))
 702         { return false; }
 703     virtual bool EnableDropTarget(const wxDataFormat& WXUNUSED(format))
 704         { return false; }
 705 #endif // wxUSE_DRAG_AND_DROP
 706
 707     // define control visual attributes
 708     // --------------------------------
 709
 710     virtual wxVisualAttributes GetDefaultAttributes() const
 711     {
 712         return GetClassDefaultAttributes(GetWindowVariant());
 713     }
 714
 715     static wxVisualAttributes
 716     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
 717     {
 718         return wxControl::GetCompositeControlsDefaultAttributes(variant);
 719     }
 720
 721 protected:
 722     virtual void DoSetExpanderColumn() = 0 ;
 723     virtual void DoSetIndent() = 0;
 724
 725 private:
 726     // Implementation of the public Set/GetCurrentItem() methods which are only
 727     // called in multi selection case (for single selection controls their
 728     // implementation is trivial and is done in the base class itself).
 729     virtual wxDataViewItem DoGetCurrentItem() const = 0;
 730     virtual void DoSetCurrentItem(const wxDataViewItem& item) = 0;
 731
 732     wxDataViewModel        *m_model;
 733     wxDataViewColumn       *m_expander_column;
 734     int m_indent ;
 735
 736 protected:
 737     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 738 };
 739
 740 // ----------------------------------------------------------------------------
 741 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
 742 // ----------------------------------------------------------------------------
 743
 744 class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
 745 {
 746 public:
 747     wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 748         : wxNotifyEvent(commandType, winid),
 749         m_item(0),
 750         m_col(-1),
 751         m_model(NULL),
 752         m_value(wxNullVariant),
 753         m_column(NULL),
 754         m_pos(-1,-1),
 755         m_cacheFrom(0),
 756         m_cacheTo(0),
 757         m_editCancelled(false)
 758 #if wxUSE_DRAG_AND_DROP
 759         , m_dataObject(NULL),
 760         m_dataBuffer(NULL),
 761         m_dataSize(0)
 762 #endif
 763         { }
 764
 765     wxDataViewEvent(const wxDataViewEvent& event)
 766         : wxNotifyEvent(event),
 767         m_item(event.m_item),
 768         m_col(event.m_col),
 769         m_model(event.m_model),
 770         m_value(event.m_value),
 771         m_column(event.m_column),
 772         m_pos(event.m_pos),
 773         m_cacheFrom(event.m_cacheFrom),
 774         m_cacheTo(event.m_cacheTo),
 775         m_editCancelled(event.m_editCancelled)
 776 #if wxUSE_DRAG_AND_DROP
 777         , m_dataObject(event.m_dataObject),
 778         m_dataFormat(event.m_dataFormat),
 779         m_dataBuffer(event.m_dataBuffer),
 780         m_dataSize(event.m_dataSize)
 781 #endif
 782         { }
 783
 784     wxDataViewItem GetItem() const { return m_item; }
 785     void SetItem( const wxDataViewItem &item ) { m_item = item; }
 786
 787     int GetColumn() const { return m_col; }
 788     void SetColumn( int col ) { m_col = col; }
 789
 790     wxDataViewModel* GetModel() const { return m_model; }
 791     void SetModel( wxDataViewModel *model ) { m_model = model; }
 792
 793     const wxVariant &GetValue() const { return m_value; }
 794     void SetValue( const wxVariant &value ) { m_value = value; }
 795
 796     // for wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE only
 797     bool IsEditCancelled() const { return m_editCancelled; }
 798     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 799
 800     // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
 801     void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
 802     wxDataViewColumn *GetDataViewColumn() const { return m_column; }
 803
 804     // for wxEVT_DATAVIEW_CONTEXT_MENU only
 805     wxPoint GetPosition() const { return m_pos; }
 806     void SetPosition( int x, int y ) { m_pos.x = x; m_pos.y = y; }
 807
 808     // For wxEVT_COMMAND_DATAVIEW_CACHE_HINT
 809     int GetCacheFrom() const { return m_cacheFrom; }
 810     int GetCacheTo() const { return m_cacheTo; }
 811     void SetCache(int from, int to) { m_cacheFrom = from; m_cacheTo = to; }
 812
 813
 814 #if wxUSE_DRAG_AND_DROP
 815     // For drag operations
 816     void SetDataObject( wxDataObject *obj ) { m_dataObject = obj; }
 817     wxDataObject *GetDataObject() const { return m_dataObject; }
 818
 819     // For drop operations
 820     void SetDataFormat( const wxDataFormat &format ) { m_dataFormat = format; }
 821     wxDataFormat GetDataFormat() const { return m_dataFormat; }
 822     void SetDataSize( size_t size ) { m_dataSize = size; }
 823     size_t GetDataSize() const { return m_dataSize; }
 824     void SetDataBuffer( void* buf ) { m_dataBuffer = buf;}
 825     void *GetDataBuffer() const { return m_dataBuffer; }
 826 #endif // wxUSE_DRAG_AND_DROP
 827
 828     virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
 829
 830 protected:
 831     wxDataViewItem      m_item;
 832     int                 m_col;
 833     wxDataViewModel    *m_model;
 834     wxVariant           m_value;
 835     wxDataViewColumn   *m_column;
 836     wxPoint             m_pos;
 837     int                 m_cacheFrom;
 838     int                 m_cacheTo;
 839     bool                m_editCancelled;
 840
 841 #if wxUSE_DRAG_AND_DROP
 842     wxDataObject       *m_dataObject;
 843
 844     wxDataFormat        m_dataFormat;
 845     void*               m_dataBuffer;
 846     size_t              m_dataSize;
 847 #endif // wxUSE_DRAG_AND_DROP
 848
 849 private:
 850     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
 851 };
 852
 853 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED, wxDataViewEvent );
 854
 855 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, wxDataViewEvent );
 856 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED, wxDataViewEvent );
 857 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED, wxDataViewEvent );
 858 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING, wxDataViewEvent );
 859 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, wxDataViewEvent );
 860 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_START_EDITING, wxDataViewEvent );
 861 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED, wxDataViewEvent );
 862 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE, wxDataViewEvent );
 863 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED, wxDataViewEvent );
 864
 865 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU, wxDataViewEvent );
 866
 867 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, wxDataViewEvent );
 868 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, wxDataViewEvent );
 869 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, wxDataViewEvent );
 870 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED, wxDataViewEvent );
 871
 872 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_CACHE_HINT, wxDataViewEvent );
 873
 874 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG, wxDataViewEvent );
 875 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE, wxDataViewEvent );
 876 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_DROP, wxDataViewEvent );
 877
 878 typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
 879
 880 #define wxDataViewEventHandler(func) \
 881     wxEVENT_HANDLER_CAST(wxDataViewEventFunction, func)
 882
 883 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
 884     wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
 885
 886 #define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
 887
 888 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
 889 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
 890 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
 891 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
 892 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
 893 #define EVT_DATAVIEW_ITEM_START_EDITING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_START_EDITING, id, fn)
 894 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
 895 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
 896 #define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
 897
 898 #define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
 899
 900 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
 901 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
 902 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
 903 #define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
 904 #define EVT_DATAVIEW_CACHE_HINT(id, fn) wx__DECLARE_DATAVIEWEVT(CACHE_HINT, id, fn)
 905
 906 #define EVT_DATAVIEW_ITEM_BEGIN_DRAG(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_BEGIN_DRAG, id, fn)
 907 #define EVT_DATAVIEW_ITEM_DROP_POSSIBLE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP_POSSIBLE, id, fn)
 908 #define EVT_DATAVIEW_ITEM_DROP(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DROP, id, fn)
 909
 910 #ifdef wxHAS_GENERIC_DATAVIEWCTRL
 911     #include "wx/generic/dataview.h"
 912 #elif defined(__WXGTK20__)
 913     #include "wx/gtk/dataview.h"
 914 #elif defined(__WXMAC__)
 915     #include "wx/osx/dataview.h"
 916 #else
 917     #error "unknown native wxDataViewCtrl implementation"
 918 #endif
 919
 920 //-----------------------------------------------------------------------------
 921 // wxDataViewListStore
 922 //-----------------------------------------------------------------------------
 923
 924 class WXDLLIMPEXP_ADV wxDataViewListStoreLine
 925 {
 926 public:
 927     wxDataViewListStoreLine( wxClientData *data = NULL )
 928     {
 929         m_data = data;
 930     }
 931     virtual ~wxDataViewListStoreLine()
 932     {
 933         delete m_data;
 934     }
 935
 936     void SetData( wxClientData *data )
 937         { if (m_data) delete m_data; m_data = data; }
 938     wxClientData *GetData() const
 939         { return m_data; }
 940
 941     wxVector<wxVariant>  m_values;
 942
 943 private:
 944     wxClientData    *m_data;
 945 };
 946
 947
 948 class WXDLLIMPEXP_ADV wxDataViewListStore: public wxDataViewIndexListModel
 949 {
 950 public:
 951     wxDataViewListStore();
 952     ~wxDataViewListStore();
 953
 954     void PrependColumn( const wxString &varianttype );
 955     void InsertColumn( unsigned int pos, const wxString &varianttype );
 956     void AppendColumn( const wxString &varianttype );
 957
 958     void AppendItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
 959     void PrependItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
 960     void InsertItem(  unsigned int row, const wxVector<wxVariant> &values, wxClientData *data = NULL );
 961     void DeleteItem( unsigned int pos );
 962     void DeleteAllItems();
 963
 964     // override base virtuals
 965
 966     virtual unsigned int GetColumnCount() const;
 967
 968     virtual wxString GetColumnType( unsigned int col ) const;
 969
 970     virtual void GetValueByRow( wxVariant &value,
 971                            unsigned int row, unsigned int col ) const;
 972
 973     virtual bool SetValueByRow( const wxVariant &value,
 974                            unsigned int row, unsigned int col );
 975
 976
 977 public:
 978     wxVector<wxDataViewListStoreLine*> m_data;
 979     wxArrayString                      m_cols;
 980 };
 981
 982 //-----------------------------------------------------------------------------
 983
 984 class WXDLLIMPEXP_ADV wxDataViewListCtrl: public wxDataViewCtrl
 985 {
 986 public:
 987     wxDataViewListCtrl();
 988     wxDataViewListCtrl( wxWindow *parent, wxWindowID id,
 989            const wxPoint& pos = wxDefaultPosition,
 990            const wxSize& size = wxDefaultSize, long style = wxDV_ROW_LINES,
 991            const wxValidator& validator = wxDefaultValidator );
 992     ~wxDataViewListCtrl();
 993
 994     bool Create( wxWindow *parent, wxWindowID id,
 995            const wxPoint& pos = wxDefaultPosition,
 996            const wxSize& size = wxDefaultSize, long style = wxDV_ROW_LINES,
 997            const wxValidator& validator = wxDefaultValidator );
 998
 999     wxDataViewListStore *GetStore()
1000         { return (wxDataViewListStore*) GetModel(); }
1001     const wxDataViewListStore *GetStore() const
1002         { return (const wxDataViewListStore*) GetModel(); }
1003
1004     int ItemToRow(const wxDataViewItem &item) const
1005         { return item.IsOk() ? (int)GetStore()->GetRow(item) : wxNOT_FOUND; }
1006     wxDataViewItem RowToItem(int row) const
1007         { return row == wxNOT_FOUND ? wxDataViewItem() : GetStore()->GetItem(row); }
1008
1009     int GetSelectedRow() const
1010         { return ItemToRow(GetSelection()); }
1011     void SelectRow(unsigned row)
1012         { Select(RowToItem(row)); }
1013     void UnselectRow(unsigned row)
1014         { Unselect(RowToItem(row)); }
1015     bool IsRowSelected(unsigned row) const
1016         { return IsSelected(RowToItem(row)); }
1017
1018     bool AppendColumn( wxDataViewColumn *column, const wxString &varianttype );
1019     bool PrependColumn( wxDataViewColumn *column, const wxString &varianttype );
1020     bool InsertColumn( unsigned int pos, wxDataViewColumn *column, const wxString &varianttype );
1021
1022     // overridden from base class
1023     virtual bool PrependColumn( wxDataViewColumn *col );
1024     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
1025     virtual bool AppendColumn( wxDataViewColumn *col );
1026
1027     wxDataViewColumn *AppendTextColumn( const wxString &label,
1028           wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1029           int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
1030     wxDataViewColumn *AppendToggleColumn( const wxString &label,
1031           wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
1032           int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
1033     wxDataViewColumn *AppendProgressColumn( const wxString &label,
1034           wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1035           int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
1036     wxDataViewColumn *AppendIconTextColumn( const wxString &label,
1037           wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
1038           int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
1039
1040     void AppendItem( const wxVector<wxVariant> &values, wxClientData *data = NULL )
1041         { GetStore()->AppendItem( values, data ); }
1042     void PrependItem( const wxVector<wxVariant> &values, wxClientData *data = NULL )
1043         { GetStore()->PrependItem( values, data ); }
1044     void InsertItem(  unsigned int row, const wxVector<wxVariant> &values, wxClientData *data = NULL )
1045         { GetStore()->InsertItem( row, values, data ); }
1046     void DeleteItem( unsigned row )
1047         { GetStore()->DeleteItem( row ); }
1048     void DeleteAllItems()
1049         { GetStore()->DeleteAllItems(); }
1050
1051     void SetValue( const wxVariant &value, unsigned int row, unsigned int col )
1052         { GetStore()->SetValueByRow( value, row, col );
1053           GetStore()->RowValueChanged( row, col); }
1054     void GetValue( wxVariant &value, unsigned int row, unsigned int col )
1055         { GetStore()->GetValueByRow( value, row, col ); }
1056
1057     void SetTextValue( const wxString &value, unsigned int row, unsigned int col )
1058         { GetStore()->SetValueByRow( value, row, col );
1059           GetStore()->RowValueChanged( row, col); }
1060     wxString GetTextValue( unsigned int row, unsigned int col ) const
1061         { wxVariant value; GetStore()->GetValueByRow( value, row, col ); return value.GetString(); }
1062
1063     void SetToggleValue( bool value, unsigned int row, unsigned int col )
1064         { GetStore()->SetValueByRow( value, row, col );
1065           GetStore()->RowValueChanged( row, col); }
1066     bool GetToggleValue( unsigned int row, unsigned int col ) const
1067         { wxVariant value; GetStore()->GetValueByRow( value, row, col ); return value.GetBool(); }
1068
1069     void OnSize( wxSizeEvent &event );
1070
1071 private:
1072     DECLARE_EVENT_TABLE()
1073     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewListCtrl)
1074 };
1075
1076 //-----------------------------------------------------------------------------
1077 // wxDataViewTreeStore
1078 //-----------------------------------------------------------------------------
1079
1080 class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
1081 {
1082 public:
1083     wxDataViewTreeStoreNode( wxDataViewTreeStoreNode *parent,
1084         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
1085     virtual ~wxDataViewTreeStoreNode();
1086
1087     void SetText( const wxString &text )
1088         { m_text = text; }
1089     wxString GetText() const
1090         { return m_text; }
1091     void SetIcon( const wxIcon &icon )
1092         { m_icon = icon; }
1093     const wxIcon &GetIcon() const
1094         { return m_icon; }
1095     void SetData( wxClientData *data )
1096         { if (m_data) delete m_data; m_data = data; }
1097     wxClientData *GetData() const
1098         { return m_data; }
1099
1100     wxDataViewItem GetItem() const
1101         { return wxDataViewItem( (void*) this ); }
1102
1103     virtual bool IsContainer()
1104         { return false; }
1105
1106     wxDataViewTreeStoreNode *GetParent()
1107         { return m_parent; }
1108
1109 private:
1110     wxDataViewTreeStoreNode  *m_parent;
1111     wxString                  m_text;
1112     wxIcon                    m_icon;
1113     wxClientData             *m_data;
1114 };
1115
1116 WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode, wxDataViewTreeStoreNodeList,
1117                           class WXDLLIMPEXP_ADV);
1118
1119 class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode: public wxDataViewTreeStoreNode
1120 {
1121 public:
1122     wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode *parent,
1123         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1124         wxClientData *data = NULL );
1125     virtual ~wxDataViewTreeStoreContainerNode();
1126
1127     const wxDataViewTreeStoreNodeList &GetChildren() const
1128         { return m_children; }
1129     wxDataViewTreeStoreNodeList &GetChildren()
1130         { return m_children; }
1131
1132     void SetExpandedIcon( const wxIcon &icon )
1133         { m_iconExpanded = icon; }
1134     const wxIcon &GetExpandedIcon() const
1135         { return m_iconExpanded; }
1136
1137     void SetExpanded( bool expanded = true )
1138         { m_isExpanded = expanded; }
1139     bool IsExpanded() const
1140         { return m_isExpanded; }
1141
1142     virtual bool IsContainer()
1143         { return true; }
1144
1145 private:
1146     wxDataViewTreeStoreNodeList  m_children;
1147     wxIcon                       m_iconExpanded;
1148     bool                         m_isExpanded;
1149 };
1150
1151 //-----------------------------------------------------------------------------
1152
1153 class WXDLLIMPEXP_ADV wxDataViewTreeStore: public wxDataViewModel
1154 {
1155 public:
1156     wxDataViewTreeStore();
1157     ~wxDataViewTreeStore();
1158
1159     wxDataViewItem AppendItem( const wxDataViewItem& parent,
1160         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
1161     wxDataViewItem PrependItem( const wxDataViewItem& parent,
1162         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
1163     wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
1164         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
1165
1166     wxDataViewItem PrependContainer( const wxDataViewItem& parent,
1167         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1168         wxClientData *data = NULL );
1169     wxDataViewItem AppendContainer( const wxDataViewItem& parent,
1170         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1171         wxClientData *data = NULL );
1172     wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
1173         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
1174         wxClientData *data = NULL );
1175
1176     wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
1177     int GetChildCount( const wxDataViewItem& parent ) const;
1178
1179     void SetItemText( const wxDataViewItem& item, const wxString &text );
1180     wxString GetItemText( const wxDataViewItem& item ) const;
1181     void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
1182     const wxIcon &GetItemIcon( const wxDataViewItem& item ) const;
1183     void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon );
1184     const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const;
1185     void SetItemData( const wxDataViewItem& item, wxClientData *data );
1186     wxClientData *GetItemData( const wxDataViewItem& item ) const;
1187
1188     void DeleteItem( const wxDataViewItem& item );
1189     void DeleteChildren( const wxDataViewItem& item );
1190     void DeleteAllItems();
1191
1192     // implement base methods
1193
1194     virtual void GetValue( wxVariant &variant,
1195                            const wxDataViewItem &item, unsigned int col ) const;
1196     virtual bool SetValue( const wxVariant &variant,
1197                            const wxDataViewItem &item, unsigned int col );
1198     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
1199     virtual bool IsContainer( const wxDataViewItem &item ) const;
1200     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
1201
1202     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
1203                          unsigned int column, bool ascending ) const;
1204
1205     virtual bool HasDefaultCompare() const
1206         { return true; }
1207     virtual unsigned int GetColumnCount() const
1208         { return 1; };
1209     virtual wxString GetColumnType( unsigned int WXUNUSED(col) ) const
1210         { return wxT("wxDataViewIconText"); }
1211
1212     wxDataViewTreeStoreNode *FindNode( const wxDataViewItem &item ) const;
1213     wxDataViewTreeStoreContainerNode *FindContainerNode( const wxDataViewItem &item ) const;
1214     wxDataViewTreeStoreNode *GetRoot() const { return m_root; }
1215
1216 public:
1217     wxDataViewTreeStoreNode *m_root;
1218 };
1219
1220 //-----------------------------------------------------------------------------
1221
1222 class WXDLLIMPEXP_ADV wxDataViewTreeCtrl: public wxDataViewCtrl,
1223                                           public wxWithImages
1224 {
1225 public:
1226     wxDataViewTreeCtrl() { }
1227     wxDataViewTreeCtrl(wxWindow *parent,
1228                        wxWindowID id,
1229                        const wxPoint& pos = wxDefaultPosition,
1230                        const wxSize& size = wxDefaultSize,
1231                        long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
1232                        const wxValidator& validator = wxDefaultValidator)
1233     {
1234         Create(parent, id, pos, size, style, validator);
1235     }
1236
1237     bool Create(wxWindow *parent,
1238                 wxWindowID id,
1239                 const wxPoint& pos = wxDefaultPosition,
1240                 const wxSize& size = wxDefaultSize,
1241                 long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
1242                 const wxValidator& validator = wxDefaultValidator);
1243
1244     wxDataViewTreeStore *GetStore()
1245         { return (wxDataViewTreeStore*) GetModel(); }
1246     const wxDataViewTreeStore *GetStore() const
1247         { return (const wxDataViewTreeStore*) GetModel(); }
1248
1249     bool IsContainer( const wxDataViewItem& item ) const
1250         { return GetStore()->IsContainer(item); }
1251
1252     wxDataViewItem AppendItem( const wxDataViewItem& parent,
1253         const wxString &text, int icon = NO_IMAGE, wxClientData *data = NULL );
1254     wxDataViewItem PrependItem( const wxDataViewItem& parent,
1255         const wxString &text, int icon = NO_IMAGE, wxClientData *data = NULL );
1256     wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
1257         const wxString &text, int icon = NO_IMAGE, wxClientData *data = NULL );
1258
1259     wxDataViewItem PrependContainer( const wxDataViewItem& parent,
1260         const wxString &text, int icon = NO_IMAGE, int expanded = NO_IMAGE,
1261         wxClientData *data = NULL );
1262     wxDataViewItem AppendContainer( const wxDataViewItem& parent,
1263         const wxString &text, int icon = NO_IMAGE, int expanded = NO_IMAGE,
1264         wxClientData *data = NULL );
1265     wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
1266         const wxString &text, int icon = NO_IMAGE, int expanded = NO_IMAGE,
1267         wxClientData *data = NULL );
1268
1269     wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const
1270         { return GetStore()->GetNthChild(parent, pos); }
1271     int GetChildCount( const wxDataViewItem& parent ) const
1272         { return GetStore()->GetChildCount(parent); }
1273
1274     void SetItemText( const wxDataViewItem& item, const wxString &text );
1275     wxString GetItemText( const wxDataViewItem& item ) const
1276         { return GetStore()->GetItemText(item); }
1277     void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
1278     const wxIcon &GetItemIcon( const wxDataViewItem& item ) const
1279         { return GetStore()->GetItemIcon(item); }
1280     void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon );
1281     const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const
1282         { return GetStore()->GetItemExpandedIcon(item); }
1283     void SetItemData( const wxDataViewItem& item, wxClientData *data )
1284         { GetStore()->SetItemData(item,data); }
1285     wxClientData *GetItemData( const wxDataViewItem& item ) const
1286         { return GetStore()->GetItemData(item); }
1287
1288     void DeleteItem( const wxDataViewItem& item );
1289     void DeleteChildren( const wxDataViewItem& item );
1290     void DeleteAllItems();
1291
1292     void OnExpanded( wxDataViewEvent &event );
1293     void OnCollapsed( wxDataViewEvent &event );
1294     void OnSize( wxSizeEvent &event );
1295
1296 private:
1297     DECLARE_EVENT_TABLE()
1298     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl)
1299 };
1300
1301 #endif // wxUSE_DATAVIEWCTRL
1302
1303 #endif
1304     // _WX_DATAVIEW_H_BASE_