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/control.h"
  20 #include "wx/textctrl.h"
  21 #include "wx/bitmap.h"
  22 #include "wx/variant.h"
  23 #include "wx/dynarray.h"
  24 #include "wx/icon.h"
  25 #include "wx/imaglist.h"
  26 #include "wx/weakref.h"
  27
  28 class WXDLLIMPEXP_FWD_CORE wxDataFormat;
  29
  30 #if defined(__WXGTK20__)
  31     // for testing
  32     // #define wxUSE_GENERICDATAVIEWCTRL 1
  33 #elif defined(__WXMAC__)
  34 #else
  35     #define wxUSE_GENERICDATAVIEWCTRL 1
  36 #endif
  37
  38 // ----------------------------------------------------------------------------
  39 // wxDataViewCtrl flags
  40 // ----------------------------------------------------------------------------
  41
  42 // ----------------------------------------------------------------------------
  43 // wxDataViewCtrl globals
  44 // ----------------------------------------------------------------------------
  45
  46 class WXDLLIMPEXP_FWD_ADV wxDataViewItem;
  47 class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
  48 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
  49 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
  50 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
  51 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
  52
  53 extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
  54
  55 // the default width of new (text) columns:
  56 #define wxDVC_DEFAULT_WIDTH             80
  57
  58 // the default width of new toggle columns:
  59 #define wxDVC_TOGGLE_DEFAULT_WIDTH      30
  60
  61 // the default minimal width of the columns:
  62 #define wxDVC_DEFAULT_MINWIDTH          30
  63
  64 // The default alignment of wxDataViewRenderers is to take
  65 // the alignment from the column it owns.
  66 #define wxDVR_DEFAULT_ALIGNMENT         -1
  67
  68
  69 // ---------------------------------------------------------
  70 // wxDataViewItem
  71 // ---------------------------------------------------------
  72
  73 class WXDLLIMPEXP_ADV wxDataViewItem
  74 {
  75 public:
  76     wxDataViewItem( void* id = NULL )
  77         { m_id = id; }
  78     wxDataViewItem( const wxDataViewItem &item )
  79         { m_id = item.m_id; }
  80     bool IsOk() const                  { return m_id != NULL; }
  81     void* GetID() const                { return m_id; }
  82     operator const void* () const      { return m_id; }
  83
  84 #ifdef __WXDEBUG__
  85     void Print( const wxString &text ) const;
  86 #endif
  87
  88 private:
  89     void* m_id;
  90 };
  91
  92 bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
  93
  94 WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
  95
  96 // ---------------------------------------------------------
  97 // wxDataViewModelNotifier
  98 // ---------------------------------------------------------
  99
 100 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
 101 {
 102 public:
 103     wxDataViewModelNotifier() { m_owner = NULL; }
 104     virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
 105
 106     virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
 107     virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
 108     virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
 109     virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 110     virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 111     virtual bool ItemsChanged( const wxDataViewItemArray &items );
 112     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
 113     virtual bool Cleared() = 0;
 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.Ok(); }
 149     const wxColour& GetColour() const { return m_colour; }
 150
 151     bool GetBold() const { return m_bold; }
 152     bool GetItalic() const { return m_italic; }
 153
 154 private:
 155     wxColour m_colour;
 156     bool     m_bold;
 157     bool     m_italic;
 158 };
 159
 160
 161 // ---------------------------------------------------------
 162 // wxDataViewModel
 163 // ---------------------------------------------------------
 164
 165 WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier, wxDataViewModelNotifiers,
 166                           class WXDLLIMPEXP_ADV);
 167
 168 class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
 169 {
 170 public:
 171     wxDataViewModel();
 172
 173     virtual unsigned int GetColumnCount() const = 0;
 174
 175     // return type as reported by wxVariant
 176     virtual wxString GetColumnType( unsigned int col ) const = 0;
 177
 178     // get value into a wxVariant
 179     virtual void GetValue( wxVariant &variant,
 180                            const wxDataViewItem &item, unsigned int col ) const = 0;
 181
 182     // set value, call ValueChanged() afterwards!
 183     virtual bool SetValue( const wxVariant &variant,
 184                            const wxDataViewItem &item, unsigned int col ) = 0;
 185
 186     // Get text attribute, return false of default attributes should be used
 187     virtual bool GetAttr( const wxDataViewItem &WXUNUSED(item), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
 188         { return false; }
 189
 190     // define hierachy
 191     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
 192     virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
 193     // Is the container just a header or an item with all columns
 194     virtual bool HasContainerColumns(const wxDataViewItem& WXUNUSED(item)) const
 195         { return false; }
 196     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
 197
 198     // define DnD capabilities
 199     virtual bool IsDraggable( const wxDataViewItem &WXUNUSED(item) )
 200         { return false; }
 201     virtual size_t GetDragDataSize( const wxDataViewItem &WXUNUSED(item), const wxDataFormat &WXUNUSED(format) )
 202         { return 0; }
 203     virtual bool GetDragData( const wxDataViewItem &WXUNUSED(item), const wxDataFormat &WXUNUSED(format),
 204                               void* WXUNUSED(data), size_t WXUNUSED(size) )
 205         { return FALSE; }
 206
 207     // delegated notifiers
 208     virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
 209     virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 210     virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
 211     virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
 212     virtual bool ItemChanged( const wxDataViewItem &item );
 213     virtual bool ItemsChanged( const wxDataViewItemArray &items );
 214     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col );
 215     virtual bool Cleared();
 216
 217     // delegatd action
 218     virtual void Resort();
 219
 220     void AddNotifier( wxDataViewModelNotifier *notifier );
 221     void RemoveNotifier( wxDataViewModelNotifier *notifier );
 222
 223     // default compare function
 224     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 225                          unsigned int column, bool ascending );
 226     virtual bool HasDefaultCompare() const { return false; }
 227
 228     // internal
 229     virtual bool IsVirtualListModel() const { return false; }
 230
 231 protected:
 232     // the user should not delete this class directly: he should use DecRef() instead!
 233     virtual ~wxDataViewModel() { }
 234
 235     wxDataViewModelNotifiers  m_notifiers;
 236 };
 237
 238 // ---------------------------------------------------------
 239 // wxDataViewIndexListModel
 240 // ---------------------------------------------------------
 241
 242 class WXDLLIMPEXP_ADV wxDataViewIndexListModel: public wxDataViewModel
 243 {
 244 public:
 245     wxDataViewIndexListModel( unsigned int initial_size = 0 );
 246     ~wxDataViewIndexListModel();
 247
 248     virtual void GetValue( wxVariant &variant,
 249                            unsigned int row, unsigned int col ) const = 0;
 250
 251     virtual bool SetValue( const wxVariant &variant,
 252                            unsigned int row, unsigned int col ) = 0;
 253
 254     virtual bool GetAttr( unsigned int WXUNUSED(row), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
 255         { return false; }
 256
 257     void RowPrepended();
 258     void RowInserted( unsigned int before );
 259     void RowAppended();
 260     void RowDeleted( unsigned int row );
 261     void RowsDeleted( const wxArrayInt &rows );
 262     void RowChanged( unsigned int row );
 263     void RowValueChanged( unsigned int row, unsigned int col );
 264     void Reset( unsigned int new_size );
 265
 266     // convert to/from row/wxDataViewItem
 267
 268     unsigned int GetRow( const wxDataViewItem &item ) const;
 269     wxDataViewItem GetItem( unsigned int row ) const;
 270
 271     // compare based on index
 272
 273     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 274                          unsigned int column, bool ascending );
 275     virtual bool HasDefaultCompare() const;
 276
 277     // implement base methods
 278
 279     virtual void GetValue( wxVariant &variant,
 280                            const wxDataViewItem &item, unsigned int col ) const;
 281     virtual bool SetValue( const wxVariant &variant,
 282                            const wxDataViewItem &item, unsigned int col );
 283     virtual bool GetAttr( const wxDataViewItem &item, unsigned int col, wxDataViewItemAttr &attr );
 284     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
 285     virtual bool IsContainer( const wxDataViewItem &item ) const;
 286     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
 287
 288     // internal
 289     virtual bool IsVirtualListModel() const { return false; }
 290     unsigned int GetLastIndex() const { return m_lastIndex; }
 291
 292 private:
 293     wxDataViewItemArray m_hash;
 294     unsigned int m_lastIndex;
 295     bool m_ordered;
 296 };
 297
 298 // ---------------------------------------------------------
 299 // wxDataViewVirtualListModel
 300 // ---------------------------------------------------------
 301
 302 #ifdef __WXMAC__
 303 // better than nothing
 304 typedef wxDataViewIndexListModel wxDataViewVirtualListModel;
 305 #else
 306
 307 class WXDLLIMPEXP_ADV wxDataViewVirtualListModel: public wxDataViewModel
 308 {
 309 public:
 310     wxDataViewVirtualListModel( unsigned int initial_size = 0 );
 311     ~wxDataViewVirtualListModel();
 312
 313     virtual void GetValue( wxVariant &variant,
 314                            unsigned int row, unsigned int col ) const = 0;
 315
 316     virtual bool SetValue( const wxVariant &variant,
 317                            unsigned int row, unsigned int col ) = 0;
 318
 319     virtual bool GetAttr( unsigned int WXUNUSED(row), unsigned int WXUNUSED(col), wxDataViewItemAttr &WXUNUSED(attr) )
 320         { return false; }
 321
 322     void RowPrepended();
 323     void RowInserted( unsigned int before );
 324     void RowAppended();
 325     void RowDeleted( unsigned int row );
 326     void RowsDeleted( const wxArrayInt &rows );
 327     void RowChanged( unsigned int row );
 328     void RowValueChanged( unsigned int row, unsigned int col );
 329     void Reset( unsigned int new_size );
 330
 331     // convert to/from row/wxDataViewItem
 332
 333     unsigned int GetRow( const wxDataViewItem &item ) const;
 334     wxDataViewItem GetItem( unsigned int row ) const;
 335
 336     // compare based on index
 337
 338     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 339                          unsigned int column, bool ascending );
 340     virtual bool HasDefaultCompare() const;
 341
 342     // implement base methods
 343
 344     virtual void GetValue( wxVariant &variant,
 345                            const wxDataViewItem &item, unsigned int col ) const;
 346     virtual bool SetValue( const wxVariant &variant,
 347                            const wxDataViewItem &item, unsigned int col );
 348     virtual bool GetAttr( const wxDataViewItem &item, unsigned int col, wxDataViewItemAttr &attr );
 349     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
 350     virtual bool IsContainer( const wxDataViewItem &item ) const;
 351     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
 352
 353     // internal
 354     virtual bool IsVirtualListModel() const { return true; }
 355     unsigned int GetLastIndex() const { return m_lastIndex; }
 356
 357 private:
 358     wxDataViewItemArray m_hash;
 359     unsigned int m_lastIndex;
 360     bool m_ordered;
 361 };
 362 #endif
 363
 364 //-----------------------------------------------------------------------------
 365 // wxDataViewEditorCtrlEvtHandler
 366 //-----------------------------------------------------------------------------
 367
 368 class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler
 369 {
 370 public:
 371     wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner );
 372
 373     void AcceptChangesAndFinish();
 374     void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; }
 375
 376 protected:
 377     void OnChar( wxKeyEvent &event );
 378     void OnKillFocus( wxFocusEvent &event );
 379     void OnIdle( wxIdleEvent &event );
 380
 381 private:
 382     wxDataViewRenderer     *m_owner;
 383     wxControl              *m_editorCtrl;
 384     bool                    m_finished;
 385     bool                    m_focusOnIdle;
 386
 387 private:
 388     DECLARE_EVENT_TABLE()
 389 };
 390
 391 // ---------------------------------------------------------
 392 // wxDataViewRendererBase
 393 // ---------------------------------------------------------
 394
 395 enum wxDataViewCellMode
 396 {
 397     wxDATAVIEW_CELL_INERT,
 398     wxDATAVIEW_CELL_ACTIVATABLE,
 399     wxDATAVIEW_CELL_EDITABLE
 400 };
 401
 402 enum wxDataViewCellRenderState
 403 {
 404     wxDATAVIEW_CELL_SELECTED    = 1,
 405     wxDATAVIEW_CELL_PRELIT      = 2,
 406     wxDATAVIEW_CELL_INSENSITIVE = 4,
 407     wxDATAVIEW_CELL_FOCUSED     = 8
 408 };
 409
 410 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 411 {
 412 public:
 413     wxDataViewRendererBase( const wxString &varianttype,
 414                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 415                             int alignment = wxDVR_DEFAULT_ALIGNMENT );
 416     ~wxDataViewRendererBase();
 417
 418     virtual bool Validate( wxVariant& WXUNUSED(value) )
 419         { return true; }
 420
 421     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
 422     wxDataViewColumn* GetOwner() const          { return m_owner; }
 423
 424     // renderer properties:
 425
 426     virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
 427     virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
 428
 429     wxString GetVariantType() const             { return m_variantType; }
 430
 431     virtual void SetMode( wxDataViewCellMode mode ) = 0;
 432     virtual wxDataViewCellMode GetMode() const = 0;
 433
 434     // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
 435     //       rather an "int"; that's because for rendering cells it's allowed
 436     //       to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
 437     virtual void SetAlignment( int align ) = 0;
 438     virtual int GetAlignment() const = 0;
 439
 440     // in-place editing
 441     virtual bool HasEditorCtrl()
 442         { return false; }
 443     virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent),
 444                                         wxRect WXUNUSED(labelRect),
 445                                         const wxVariant& WXUNUSED(value))
 446         { return NULL; }
 447     virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor),
 448                                         wxVariant& WXUNUSED(value))
 449         { return false; }
 450
 451     virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect );
 452     virtual void CancelEditing();
 453     virtual bool FinishEditing();
 454
 455     wxControl *GetEditorCtrl() { return m_editorCtrl; }
 456
 457 protected:
 458     wxString                m_variantType;
 459     wxDataViewColumn       *m_owner;
 460     wxWeakRef<wxControl>    m_editorCtrl;
 461     wxDataViewItem          m_item; // for m_editorCtrl
 462
 463     // internal utility:
 464     const wxDataViewCtrl* GetView() const;
 465
 466 protected:
 467     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 468 };
 469
 470 //-----------------------------------------------------------------------------
 471 // wxDataViewIconText
 472 //-----------------------------------------------------------------------------
 473
 474 class WXDLLIMPEXP_ADV wxDataViewIconText: public wxObject
 475 {
 476 public:
 477     wxDataViewIconText( const wxString &text = wxEmptyString, const wxIcon& icon = wxNullIcon )
 478         : m_text(text), m_icon(icon)
 479     { }
 480     wxDataViewIconText( const wxDataViewIconText &other )
 481         : wxObject()
 482     { m_icon = other.m_icon; m_text = other.m_text; }
 483
 484     void SetText( const wxString &text ) { m_text = text; }
 485     wxString GetText() const             { return m_text; }
 486     void SetIcon( const wxIcon &icon )   { m_icon = icon; }
 487     const wxIcon &GetIcon() const        { return m_icon; }
 488
 489 private:
 490     wxString    m_text;
 491     wxIcon      m_icon;
 492
 493 private:
 494     DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
 495 };
 496
 497 bool operator == (const wxDataViewIconText &one, const wxDataViewIconText &two);
 498
 499 DECLARE_VARIANT_OBJECT_EXPORTED(wxDataViewIconText, WXDLLIMPEXP_ADV)
 500
 501 // ---------------------------------------------------------
 502 // wxDataViewColumnBase
 503 // ---------------------------------------------------------
 504
 505 enum wxDataViewColumnFlags
 506 {
 507     wxDATAVIEW_COL_RESIZABLE     = 1,
 508     wxDATAVIEW_COL_SORTABLE      = 2,
 509     wxDATAVIEW_COL_REORDERABLE   = 4,
 510     wxDATAVIEW_COL_HIDDEN        = 8
 511 };
 512
 513 class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
 514 {
 515 public:
 516     wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer,
 517                           unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 518                           wxAlignment align = wxALIGN_CENTER,
 519                           int flags = wxDATAVIEW_COL_RESIZABLE );
 520     wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
 521                           unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 522                           wxAlignment align = wxALIGN_CENTER,
 523                           int flags = wxDATAVIEW_COL_RESIZABLE );
 524     virtual ~wxDataViewColumnBase();
 525
 526     // setters:
 527
 528     virtual void SetTitle( const wxString &title ) = 0;
 529     virtual void SetAlignment( wxAlignment align ) = 0;
 530     virtual void SetSortable( bool sortable ) = 0;
 531     virtual void SetReorderable(bool reorderable) = 0;
 532     virtual void SetResizeable( bool resizeable ) = 0;
 533     virtual void SetHidden( bool hidden ) = 0;
 534     virtual void SetSortOrder( bool ascending ) = 0;
 535     virtual void SetFlags( int flags );
 536     virtual void SetOwner( wxDataViewCtrl *owner )
 537         { m_owner = owner; }
 538     virtual void SetBitmap( const wxBitmap &bitmap )
 539         { m_bitmap=bitmap; }
 540
 541     virtual void SetMinWidth( int minWidth ) = 0;
 542     virtual void SetWidth( int width ) = 0;
 543
 544
 545     // getters:
 546
 547     virtual wxString GetTitle() const = 0;
 548     virtual wxAlignment GetAlignment() const = 0;
 549     virtual int GetWidth() const = 0;
 550     virtual int GetMinWidth() const = 0;
 551
 552     virtual int GetFlags() const;
 553
 554     virtual bool IsHidden() const = 0;
 555     virtual bool IsReorderable() const = 0;
 556     virtual bool IsResizeable() const = 0;
 557     virtual bool IsSortable() const = 0;
 558     virtual bool IsSortOrderAscending() const = 0;
 559
 560     const wxBitmap &GetBitmap() const       { return m_bitmap; }
 561     unsigned int GetModelColumn() const     { return static_cast<unsigned int>(m_model_column); }
 562
 563     wxDataViewCtrl *GetOwner() const        { return m_owner; }
 564     wxDataViewRenderer* GetRenderer() const { return m_renderer; }
 565
 566 protected:
 567     wxDataViewRenderer      *m_renderer;
 568     int                      m_model_column;
 569     wxBitmap                 m_bitmap;
 570     wxDataViewCtrl          *m_owner;
 571
 572 protected:
 573     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 574 };
 575
 576 // ---------------------------------------------------------
 577 // wxDataViewCtrlBase
 578 // ---------------------------------------------------------
 579
 580 #define wxDV_SINGLE                  0x0000     // for convenience
 581 #define wxDV_MULTIPLE                0x0001     // can select multiple items
 582
 583 #define wxDV_NO_HEADER               0x0002     // column titles not visible
 584 #define wxDV_HORIZ_RULES             0x0004     // light horizontal rules between rows
 585 #define wxDV_VERT_RULES              0x0008     // light vertical rules between columns
 586
 587 #define wxDV_ROW_LINES               0x0010     // alternating colour in rows
 588 #define wxDV_VARIABLE_LINE_HEIGHT    0x0020     // variable line height
 589
 590 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 591 {
 592 public:
 593     wxDataViewCtrlBase();
 594     virtual ~wxDataViewCtrlBase();
 595
 596     virtual bool AssociateModel( wxDataViewModel *model );
 597     wxDataViewModel* GetModel();
 598     const wxDataViewModel* GetModel() const;
 599
 600     // short cuts
 601     wxDataViewColumn *PrependTextColumn( const wxString &label, unsigned int model_column,
 602                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 603                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 604                     int flags = wxDATAVIEW_COL_RESIZABLE );
 605     wxDataViewColumn *PrependIconTextColumn( const wxString &label, unsigned int model_column,
 606                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 607                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 608                     int flags = wxDATAVIEW_COL_RESIZABLE );
 609     wxDataViewColumn *PrependToggleColumn( const wxString &label, unsigned int model_column,
 610                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 611                     wxAlignment align = wxALIGN_CENTER,
 612                     int flags = wxDATAVIEW_COL_RESIZABLE );
 613     wxDataViewColumn *PrependProgressColumn( const wxString &label, unsigned int model_column,
 614                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 615                     wxAlignment align = wxALIGN_CENTER,
 616                     int flags = wxDATAVIEW_COL_RESIZABLE );
 617     wxDataViewColumn *PrependDateColumn( const wxString &label, unsigned int model_column,
 618                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 619                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 620                     int flags = wxDATAVIEW_COL_RESIZABLE );
 621     wxDataViewColumn *PrependBitmapColumn( const wxString &label, unsigned int model_column,
 622                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 623                     wxAlignment align = wxALIGN_CENTER,
 624                     int flags = wxDATAVIEW_COL_RESIZABLE );
 625     wxDataViewColumn *PrependTextColumn( const wxBitmap &label, unsigned int model_column,
 626                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 627                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 628                     int flags = wxDATAVIEW_COL_RESIZABLE );
 629     wxDataViewColumn *PrependIconTextColumn( const wxBitmap &label, unsigned int model_column,
 630                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 631                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 632                     int flags = wxDATAVIEW_COL_RESIZABLE );
 633     wxDataViewColumn *PrependToggleColumn( const wxBitmap &label, unsigned int model_column,
 634                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 635                     wxAlignment align = wxALIGN_CENTER,
 636                     int flags = wxDATAVIEW_COL_RESIZABLE );
 637     wxDataViewColumn *PrependProgressColumn( const wxBitmap &label, unsigned int model_column,
 638                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 639                     wxAlignment align = wxALIGN_CENTER,
 640                     int flags = wxDATAVIEW_COL_RESIZABLE );
 641     wxDataViewColumn *PrependDateColumn( const wxBitmap &label, unsigned int model_column,
 642                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 643                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 644                     int flags = wxDATAVIEW_COL_RESIZABLE );
 645     wxDataViewColumn *PrependBitmapColumn( const wxBitmap &label, unsigned int model_column,
 646                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 647                     wxAlignment align = wxALIGN_CENTER,
 648                     int flags = wxDATAVIEW_COL_RESIZABLE );
 649
 650     wxDataViewColumn *AppendTextColumn( const wxString &label, unsigned int model_column,
 651                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 652                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 653                     int flags = wxDATAVIEW_COL_RESIZABLE );
 654     wxDataViewColumn *AppendIconTextColumn( const wxString &label, unsigned int model_column,
 655                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 656                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 657                     int flags = wxDATAVIEW_COL_RESIZABLE );
 658     wxDataViewColumn *AppendToggleColumn( const wxString &label, unsigned int model_column,
 659                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 660                     wxAlignment align = wxALIGN_CENTER,
 661                     int flags = wxDATAVIEW_COL_RESIZABLE );
 662     wxDataViewColumn *AppendProgressColumn( const wxString &label, unsigned int model_column,
 663                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 664                     wxAlignment align = wxALIGN_CENTER,
 665                     int flags = wxDATAVIEW_COL_RESIZABLE );
 666     wxDataViewColumn *AppendDateColumn( const wxString &label, unsigned int model_column,
 667                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 668                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 669                     int flags = wxDATAVIEW_COL_RESIZABLE );
 670     wxDataViewColumn *AppendBitmapColumn( const wxString &label, unsigned int model_column,
 671                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 672                     wxAlignment align = wxALIGN_CENTER,
 673                     int flags = wxDATAVIEW_COL_RESIZABLE );
 674     wxDataViewColumn *AppendTextColumn( const wxBitmap &label, unsigned int model_column,
 675                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 676                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 677                     int flags = wxDATAVIEW_COL_RESIZABLE );
 678     wxDataViewColumn *AppendIconTextColumn( const wxBitmap &label, unsigned int model_column,
 679                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 680                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 681                     int flags = wxDATAVIEW_COL_RESIZABLE );
 682     wxDataViewColumn *AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
 683                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 684                     wxAlignment align = wxALIGN_CENTER,
 685                     int flags = wxDATAVIEW_COL_RESIZABLE );
 686     wxDataViewColumn *AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
 687                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 688                     wxAlignment align = wxALIGN_CENTER,
 689                     int flags = wxDATAVIEW_COL_RESIZABLE );
 690     wxDataViewColumn *AppendDateColumn( const wxBitmap &label, unsigned int model_column,
 691                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 692                     wxAlignment align = (wxAlignment)(wxALIGN_LEFT|wxALIGN_CENTRE_VERTICAL),
 693                     int flags = wxDATAVIEW_COL_RESIZABLE );
 694     wxDataViewColumn *AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
 695                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 696                     wxAlignment align = wxALIGN_CENTER,
 697                     int flags = wxDATAVIEW_COL_RESIZABLE );
 698
 699
 700     virtual bool PrependColumn( wxDataViewColumn *col );
 701     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 702     virtual bool AppendColumn( wxDataViewColumn *col );
 703
 704     virtual unsigned int GetColumnCount() const = 0;
 705     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const = 0;
 706     virtual int GetColumnPosition( const wxDataViewColumn *column ) const = 0;
 707
 708     virtual bool DeleteColumn( wxDataViewColumn *column ) = 0;
 709     virtual bool ClearColumns() = 0;
 710
 711     void SetExpanderColumn( wxDataViewColumn *col )
 712         { m_expander_column = col ; DoSetExpanderColumn(); }
 713     wxDataViewColumn *GetExpanderColumn() const
 714         { return m_expander_column; }
 715
 716     virtual wxDataViewColumn *GetSortingColumn() const = 0;
 717
 718     void SetIndent( int indent )
 719         { m_indent = indent ; DoSetIndent(); }
 720     int GetIndent() const
 721         { return m_indent; }
 722
 723     virtual wxDataViewItem GetSelection() const = 0;
 724     virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
 725     virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
 726     virtual void Select( const wxDataViewItem & item ) = 0;
 727     virtual void Unselect( const wxDataViewItem & item ) = 0;
 728     virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
 729
 730     virtual void SelectAll() = 0;
 731     virtual void UnselectAll() = 0;
 732
 733     virtual void Expand( const wxDataViewItem & item ) = 0;
 734     virtual void Collapse( const wxDataViewItem & item ) = 0;
 735
 736     virtual void EnsureVisible( const wxDataViewItem & item,
 737                                 const wxDataViewColumn *column = NULL ) = 0;
 738     virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
 739     virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
 740
 741 protected:
 742     virtual void DoSetExpanderColumn() = 0 ;
 743     virtual void DoSetIndent() = 0;
 744
 745 private:
 746     wxDataViewModel        *m_model;
 747     wxDataViewColumn       *m_expander_column;
 748     int m_indent ;
 749
 750 protected:
 751     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 752 };
 753
 754 // ----------------------------------------------------------------------------
 755 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
 756 // ----------------------------------------------------------------------------
 757
 758 class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
 759 {
 760 public:
 761     wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 762         : wxNotifyEvent(commandType, winid),
 763         m_item(0),
 764         m_col(-1),
 765         m_model(NULL),
 766         m_value(wxNullVariant),
 767         m_column(NULL),
 768         m_pos(-1,-1)
 769         { }
 770
 771     wxDataViewEvent(const wxDataViewEvent& event)
 772         : wxNotifyEvent(event),
 773         m_item(event.m_item),
 774         m_col(event.m_col),
 775         m_model(event.m_model),
 776         m_value(event.m_value),
 777         m_column(event.m_column),
 778         m_pos(m_pos)
 779         { }
 780
 781     wxDataViewItem GetItem() const { return m_item; }
 782     void SetItem( const wxDataViewItem &item ) { m_item = item; }
 783
 784     int GetColumn() const { return m_col; }
 785     void SetColumn( int col ) { m_col = col; }
 786
 787     wxDataViewModel* GetModel() const { return m_model; }
 788     void SetModel( wxDataViewModel *model ) { m_model = model; }
 789
 790     const wxVariant &GetValue() const { return m_value; }
 791     void SetValue( const wxVariant &value ) { m_value = value; }
 792
 793     // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
 794     void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
 795     wxDataViewColumn *GetDataViewColumn() const { return m_column; }
 796
 797     // for wxEVT_DATAVIEW_CONTEXT_MENU only
 798     wxPoint GetPosition() const { return m_pos; }
 799     void SetPosition( int x, int y ) { m_pos.x = x; m_pos.y = y; }
 800
 801     virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
 802
 803 protected:
 804     wxDataViewItem      m_item;
 805     int                 m_col;
 806     wxDataViewModel    *m_model;
 807     wxVariant           m_value;
 808     wxDataViewColumn   *m_column;
 809     wxPoint             m_pos;
 810
 811 private:
 812     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
 813 };
 814
 815 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED;
 816
 817 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED;
 818 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED;
 819 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED;
 820 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING;
 821 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING;
 822 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED;
 823 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE;
 824 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED;
 825
 826 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU;
 827
 828 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK;
 829 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK;
 830 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED;
 831 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED;
 832
 833 typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
 834
 835 #define wxDataViewEventHandler(func) \
 836     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
 837
 838 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
 839     wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
 840
 841 #define EVT_DATAVIEW_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
 842
 843 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
 844 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
 845 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
 846 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
 847 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
 848 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
 849 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
 850 #define EVT_DATAVIEW_ITEM_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_VALUE_CHANGED, id, fn)
 851
 852 #define EVT_DATAVIEW_ITEM_CONTEXT_MENU(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_CONTEXT_MENU, id, fn)
 853
 854 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
 855 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
 856 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
 857 #define EVT_DATAVIEW_COLUMN_REORDERED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_REORDERED, id, fn)
 858
 859 #if defined(wxUSE_GENERICDATAVIEWCTRL)
 860     #include "wx/generic/dataview.h"
 861 #elif defined(__WXGTK20__)
 862     #include "wx/gtk/dataview.h"
 863 #elif defined(__WXMAC__)
 864     #include "wx/mac/dataview.h"
 865 #else
 866     #include "wx/generic/dataview.h"
 867 #endif
 868
 869 // -------------------------------------
 870 // wxDataViewSpinRenderer
 871 // -------------------------------------
 872
 873 class WXDLLIMPEXP_ADV wxDataViewSpinRenderer: public wxDataViewCustomRenderer
 874 {
 875 public:
 876     wxDataViewSpinRenderer( int min, int max,
 877                             wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
 878                             int alignment = wxDVR_DEFAULT_ALIGNMENT );
 879     virtual bool HasEditorCtrl() { return true; }
 880     virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
 881     virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
 882     virtual bool Render( wxRect rect, wxDC *dc, int state );
 883     virtual wxSize GetSize() const;
 884     virtual bool SetValue( const wxVariant &value );
 885     virtual bool GetValue( wxVariant &value ) const;
 886
 887 private:
 888     long    m_data;
 889     long    m_min,m_max;
 890 };
 891
 892 //-----------------------------------------------------------------------------
 893 // wxDataViewTreeStore
 894 //-----------------------------------------------------------------------------
 895
 896 class WXDLLIMPEXP_ADV wxDataViewTreeStoreNode
 897 {
 898 public:
 899     wxDataViewTreeStoreNode( wxDataViewTreeStoreNode *parent,
 900         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
 901     virtual ~wxDataViewTreeStoreNode();
 902
 903     void SetText( const wxString &text )
 904         { m_text = text; }
 905     wxString GetText() const
 906         { return m_text; }
 907     void SetIcon( const wxIcon &icon )
 908         { m_icon = icon; }
 909     const wxIcon &GetIcon() const
 910         { return m_icon; }
 911     void SetData( wxClientData *data )
 912         { if (m_data) delete m_data; m_data = data; }
 913     wxClientData *GetData() const
 914         { return m_data; }
 915
 916     wxDataViewItem GetItem() const
 917         { return wxDataViewItem( (void*) this ); }
 918
 919     virtual bool IsContainer()
 920         { return false; }
 921
 922     wxDataViewTreeStoreNode *GetParent()
 923         { return m_parent; }
 924
 925 private:
 926     wxDataViewTreeStoreNode  *m_parent;
 927     wxString                  m_text;
 928     wxIcon                    m_icon;
 929     wxClientData             *m_data;
 930 };
 931
 932 WX_DECLARE_LIST_WITH_DECL(wxDataViewTreeStoreNode, wxDataViewTreeStoreNodeList,
 933                           class WXDLLIMPEXP_ADV);
 934
 935 class WXDLLIMPEXP_ADV wxDataViewTreeStoreContainerNode: public wxDataViewTreeStoreNode
 936 {
 937 public:
 938     wxDataViewTreeStoreContainerNode( wxDataViewTreeStoreNode *parent,
 939         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
 940         wxClientData *data = NULL );
 941     virtual ~wxDataViewTreeStoreContainerNode();
 942
 943     const wxDataViewTreeStoreNodeList &GetChildren() const
 944         { return m_children; }
 945     wxDataViewTreeStoreNodeList &GetChildren()
 946         { return m_children; }
 947
 948     void SetExpandedIcon( const wxIcon &icon )
 949         { m_iconExpanded = icon; }
 950     const wxIcon &GetExpandedIcon() const
 951         { return m_iconExpanded; }
 952
 953     void SetExpanded( bool expanded = true )
 954         { m_isExpanded = expanded; }
 955     bool IsExpanded() const
 956         { return m_isExpanded; }
 957
 958     virtual bool IsContainer()
 959         { return true; }
 960
 961 private:
 962     wxDataViewTreeStoreNodeList  m_children;
 963     wxIcon                       m_iconExpanded;
 964     bool                         m_isExpanded;
 965 };
 966
 967 //-----------------------------------------------------------------------------
 968
 969 class WXDLLIMPEXP_ADV wxDataViewTreeStore: public wxDataViewModel
 970 {
 971 public:
 972     wxDataViewTreeStore();
 973     ~wxDataViewTreeStore();
 974
 975     wxDataViewItem AppendItem( const wxDataViewItem& parent,
 976         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
 977     wxDataViewItem PrependItem( const wxDataViewItem& parent,
 978         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
 979     wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
 980         const wxString &text, const wxIcon &icon = wxNullIcon, wxClientData *data = NULL );
 981
 982     wxDataViewItem PrependContainer( const wxDataViewItem& parent,
 983         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
 984         wxClientData *data = NULL );
 985     wxDataViewItem AppendContainer( const wxDataViewItem& parent,
 986         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
 987         wxClientData *data = NULL );
 988     wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
 989         const wxString &text, const wxIcon &icon = wxNullIcon, const wxIcon &expanded = wxNullIcon,
 990         wxClientData *data = NULL );
 991
 992     wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
 993     int GetChildCount( const wxDataViewItem& parent ) const;
 994
 995     void SetItemText( const wxDataViewItem& item, const wxString &text );
 996     wxString GetItemText( const wxDataViewItem& item ) const;
 997     void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
 998     const wxIcon &GetItemIcon( const wxDataViewItem& item ) const;
 999     void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon );
1000     const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const;
1001     void SetItemData( const wxDataViewItem& item, wxClientData *data );
1002     wxClientData *GetItemData( const wxDataViewItem& item ) const;
1003
1004     void DeleteItem( const wxDataViewItem& item );
1005     void DeleteChildren( const wxDataViewItem& item );
1006     void DeleteAllItems();
1007
1008     // implement base methods
1009
1010     virtual void GetValue( wxVariant &variant,
1011                            const wxDataViewItem &item, unsigned int col ) const;
1012     virtual bool SetValue( const wxVariant &variant,
1013                            const wxDataViewItem &item, unsigned int col );
1014     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
1015     virtual bool IsContainer( const wxDataViewItem &item ) const;
1016     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
1017
1018     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
1019                          unsigned int column, bool ascending );
1020
1021     virtual bool HasDefaultCompare() const
1022         { return true; }
1023     virtual unsigned int GetColumnCount() const
1024         { return 1; };
1025     virtual wxString GetColumnType( unsigned int WXUNUSED(col) ) const
1026         { return wxT("wxDataViewIconText"); }
1027
1028     wxDataViewTreeStoreNode *FindNode( const wxDataViewItem &item ) const;
1029     wxDataViewTreeStoreContainerNode *FindContainerNode( const wxDataViewItem &item ) const;
1030     wxDataViewTreeStoreNode *GetRoot() const { return m_root; }
1031
1032 public:
1033     wxDataViewTreeStoreNode *m_root;
1034 };
1035
1036 class WXDLLIMPEXP_ADV wxDataViewTreeCtrl: public wxDataViewCtrl
1037 {
1038 public:
1039     wxDataViewTreeCtrl();
1040     wxDataViewTreeCtrl( wxWindow *parent, wxWindowID id,
1041            const wxPoint& pos = wxDefaultPosition,
1042            const wxSize& size = wxDefaultSize, long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
1043            const wxValidator& validator = wxDefaultValidator );
1044     ~wxDataViewTreeCtrl();
1045
1046     bool Create( wxWindow *parent, wxWindowID id,
1047            const wxPoint& pos = wxDefaultPosition,
1048            const wxSize& size = wxDefaultSize, long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
1049            const wxValidator& validator = wxDefaultValidator );
1050
1051     wxDataViewTreeStore *GetStore()
1052         { return (wxDataViewTreeStore*) GetModel(); }
1053     const wxDataViewTreeStore *GetStore() const
1054         { return (const wxDataViewTreeStore*) GetModel(); }
1055
1056     void SetImageList( wxImageList *imagelist );
1057     wxImageList* GetImageList() { return m_imageList; }
1058
1059     wxDataViewItem AppendItem( const wxDataViewItem& parent,
1060         const wxString &text, int icon = -1, wxClientData *data = NULL );
1061     wxDataViewItem PrependItem( const wxDataViewItem& parent,
1062         const wxString &text, int icon = -1, wxClientData *data = NULL );
1063     wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
1064         const wxString &text, int icon = -1, wxClientData *data = NULL );
1065
1066     wxDataViewItem PrependContainer( const wxDataViewItem& parent,
1067         const wxString &text, int icon = -1, int expanded = -1,
1068         wxClientData *data = NULL );
1069     wxDataViewItem AppendContainer( const wxDataViewItem& parent,
1070         const wxString &text, int icon = -1, int expanded = -1,
1071         wxClientData *data = NULL );
1072     wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
1073         const wxString &text, int icon = -1, int expanded = -1,
1074         wxClientData *data = NULL );
1075
1076     wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const
1077         { return GetStore()->GetNthChild(parent, pos); }
1078     int GetChildCount( const wxDataViewItem& parent ) const
1079         { return GetStore()->GetChildCount(parent); }
1080
1081     void SetItemText( const wxDataViewItem& item, const wxString &text )
1082         { GetStore()->SetItemText(item,text); }
1083     wxString GetItemText( const wxDataViewItem& item ) const
1084         { return GetStore()->GetItemText(item); }
1085     void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon )
1086         { GetStore()->SetItemIcon(item,icon); }
1087     const wxIcon &GetItemIcon( const wxDataViewItem& item ) const
1088         { return GetStore()->GetItemIcon(item); }
1089     void SetItemExpandedIcon( const wxDataViewItem& item, const wxIcon &icon )
1090         { GetStore()->SetItemExpandedIcon(item,icon); }
1091     const wxIcon &GetItemExpandedIcon( const wxDataViewItem& item ) const
1092         { return GetStore()->GetItemExpandedIcon(item); }
1093     void SetItemData( const wxDataViewItem& item, wxClientData *data )
1094         { GetStore()->SetItemData(item,data); }
1095     wxClientData *GetItemData( const wxDataViewItem& item ) const
1096         { return GetStore()->GetItemData(item); }
1097
1098     void DeleteItem( const wxDataViewItem& item )
1099         { GetStore()->DeleteItem(item); }
1100     void DeleteChildren( const wxDataViewItem& item )
1101         { GetStore()->DeleteChildren(item); }
1102     void DeleteAllItems()
1103         { GetStore()->DeleteAllItems(); }
1104
1105     void OnExpanded( wxDataViewEvent &event );
1106     void OnCollapsed( wxDataViewEvent &event );
1107     void OnSize( wxSizeEvent &event );
1108
1109 private:
1110     wxImageList  *m_imageList;
1111
1112 private:
1113     DECLARE_EVENT_TABLE()
1114     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl)
1115 };
1116
1117 #endif // wxUSE_DATAVIEWCTRL
1118
1119 #endif
1120     // _WX_DATAVIEW_H_BASE_