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