include/wx/dataview.h

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