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