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