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/listctrl.h"
  24 #include "wx/dynarray.h"
  25
  26 #if defined(__WXGTK20__)
  27     // for testing
  28     // #define wxUSE_GENERICDATAVIEWCTRL 1
  29 #elif defined(__WXMAC__)
  30 #else
  31     #define wxUSE_GENERICDATAVIEWCTRL 1
  32 #endif
  33
  34 // ----------------------------------------------------------------------------
  35 // wxDataViewCtrl flags
  36 // ----------------------------------------------------------------------------
  37
  38 // ----------------------------------------------------------------------------
  39 // wxDataViewCtrl globals
  40 // ----------------------------------------------------------------------------
  41
  42 class WXDLLIMPEXP_FWD_ADV wxDataViewItem;
  43 class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
  44 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
  45 class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
  46 class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
  47 class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
  48
  49 extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
  50
  51 // the default width of new (text) columns:
  52 #define wxDVC_DEFAULT_WIDTH             80
  53
  54 // the default width of new toggle columns:
  55 #define wxDVC_TOGGLE_DEFAULT_WIDTH      30
  56
  57 // the default minimal width of the columns:
  58 #define wxDVC_DEFAULT_MINWIDTH          30
  59
  60 // the default alignment of wxDataViewRenderers:
  61 #define wxDVR_DEFAULT_ALIGNMENT         (wxALIGN_LEFT|wxALIGN_TOP)
  62
  63
  64 // ---------------------------------------------------------
  65 // wxDataViewItem
  66 // ---------------------------------------------------------
  67
  68 class WXDLLIMPEXP_ADV wxDataViewItem
  69 {
  70 public:
  71     wxDataViewItem( void* id = NULL )
  72         { m_id = id; }
  73     wxDataViewItem( const wxDataViewItem &item )
  74         { m_id = item.m_id; }
  75     bool IsOk() const                  { return m_id != NULL; }
  76     void* GetID() const                { return m_id; }
  77     operator const void* () const      { return m_id; }
  78
  79 private:
  80     void* m_id;
  81 };
  82
  83 bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
  84
  85 WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
  86
  87 // ---------------------------------------------------------
  88 // wxDataViewModelNotifier
  89 // ---------------------------------------------------------
  90
  91 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
  92 {
  93 public:
  94     wxDataViewModelNotifier() { }
  95     virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
  96
  97     virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
  98     virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
  99     virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
 100     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
 101     virtual bool Cleared() = 0;
 102
 103     virtual void Resort() = 0;
 104
 105     void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
 106     wxDataViewModel *GetOwner()             { return m_owner; }
 107
 108 private:
 109     wxDataViewModel *m_owner;
 110 };
 111
 112
 113 // ---------------------------------------------------------
 114 // wxDataViewModel
 115 // ---------------------------------------------------------
 116
 117 WX_DECLARE_LIST(wxDataViewModelNotifier, wxDataViewModelNotifiers );
 118
 119 class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
 120 {
 121 public:
 122     wxDataViewModel();
 123
 124     virtual unsigned int GetColumnCount() const = 0;
 125
 126     // return type as reported by wxVariant
 127     virtual wxString GetColumnType( unsigned int col ) const = 0;
 128
 129     // get value into a wxVariant
 130     virtual void GetValue( wxVariant &variant,
 131                            const wxDataViewItem &item, unsigned int col ) const = 0;
 132
 133     // set value, call ValueChanged() afterwards!
 134     virtual bool SetValue( const wxVariant &variant,
 135                            const wxDataViewItem &item, unsigned int col ) = 0;
 136
 137     // define hierachy
 138     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
 139     virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
 140     virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const = 0;
 141     virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const = 0;
 142
 143     // delegated notifiers
 144     virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
 145     virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
 146     virtual bool ItemChanged( const wxDataViewItem &item );
 147     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col );
 148     virtual bool Cleared();
 149
 150     // delegatd action
 151     virtual void Resort();
 152
 153     void AddNotifier( wxDataViewModelNotifier *notifier );
 154     void RemoveNotifier( wxDataViewModelNotifier *notifier );
 155
 156     // default compare function
 157     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 158                          unsigned int column, bool ascending );
 159     virtual bool HasDefaultCompare() { return false; }
 160
 161 protected:
 162     // the user should not delete this class directly: he should use DecRef() instead!
 163     virtual ~wxDataViewModel() { }
 164
 165     wxDataViewModelNotifiers  m_notifiers;
 166 };
 167
 168 // ---------------------------------------------------------
 169 // wxDataViewIndexListModel
 170 // ---------------------------------------------------------
 171
 172 class wxDataViewIndexListModel: public wxDataViewModel
 173 {
 174 public:
 175     wxDataViewIndexListModel( unsigned int initial_size = 0 );
 176     ~wxDataViewIndexListModel();
 177
 178     virtual unsigned int GetRowCount() = 0;
 179
 180     virtual void GetValue( wxVariant &variant,
 181                            unsigned int row, unsigned int col ) const = 0;
 182
 183     virtual bool SetValue( const wxVariant &variant,
 184                            unsigned int row, unsigned int col ) = 0;
 185
 186     void RowPrepended();
 187     void RowInserted( unsigned int before );
 188     void RowAppended();
 189     void RowDeleted( unsigned int row );
 190     void RowChanged( unsigned int row );
 191     void RowValueChanged( unsigned int row, unsigned int col );
 192
 193     // convert to/from row/wxDataViewItem
 194
 195     unsigned int GetRow( const wxDataViewItem &item ) const;
 196     wxDataViewItem GetItem( unsigned int row ) const;
 197
 198     // compare based on index
 199
 200     virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 201                          unsigned int column, bool ascending );
 202     virtual bool HasDefaultCompare() { return true; }
 203
 204     // implement base methods
 205
 206     virtual void GetValue( wxVariant &variant,
 207                            const wxDataViewItem &item, unsigned int col ) const;
 208     virtual bool SetValue( const wxVariant &variant,
 209                            const wxDataViewItem &item, unsigned int col );
 210     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const;
 211     virtual bool IsContainer( const wxDataViewItem &item ) const;
 212     virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const;
 213     virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const;
 214
 215 private:
 216     wxDataViewItemArray m_hash;
 217     unsigned int m_lastIndex;
 218 };
 219
 220 //-----------------------------------------------------------------------------
 221 // wxDataViewEditorCtrlEvtHandler
 222 //-----------------------------------------------------------------------------
 223
 224 class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler
 225 {
 226 public:
 227     wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner );
 228
 229     void AcceptChangesAndFinish();
 230     void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; }
 231
 232 protected:
 233     void OnChar( wxKeyEvent &event );
 234     void OnKillFocus( wxFocusEvent &event );
 235     void OnIdle( wxIdleEvent &event );
 236
 237 private:
 238     wxDataViewRenderer     *m_owner;
 239     wxControl              *m_editorCtrl;
 240     bool                    m_finished;
 241     bool                    m_focusOnIdle;
 242
 243 private:
 244     DECLARE_EVENT_TABLE()
 245 };
 246
 247 // ---------------------------------------------------------
 248 // wxDataViewRendererBase
 249 // ---------------------------------------------------------
 250
 251 enum wxDataViewCellMode
 252 {
 253     wxDATAVIEW_CELL_INERT,
 254     wxDATAVIEW_CELL_ACTIVATABLE,
 255     wxDATAVIEW_CELL_EDITABLE
 256 };
 257
 258 enum wxDataViewCellRenderState
 259 {
 260     wxDATAVIEW_CELL_SELECTED    = 1,
 261     wxDATAVIEW_CELL_PRELIT      = 2,
 262     wxDATAVIEW_CELL_INSENSITIVE = 4,
 263     wxDATAVIEW_CELL_FOCUSED     = 8
 264 };
 265
 266 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 267 {
 268 public:
 269     wxDataViewRendererBase( const wxString &varianttype,
 270                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 271                             int alignment = wxDVR_DEFAULT_ALIGNMENT );
 272
 273     virtual bool Validate( wxVariant& WXUNUSED(value) )
 274         { return true; }
 275
 276     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
 277     wxDataViewColumn* GetOwner()                { return m_owner; }
 278
 279     // renderer properties:
 280
 281     virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
 282     virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
 283
 284     wxString GetVariantType() const             { return m_variantType; }
 285
 286     virtual void SetMode( wxDataViewCellMode mode ) = 0;
 287     virtual wxDataViewCellMode GetMode() const = 0;
 288
 289     // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
 290     //       rather an "int"; that's because for rendering cells it's allowed
 291     //       to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
 292     virtual void SetAlignment( int align ) = 0;
 293     virtual int GetAlignment() const = 0;
 294
 295     // in-place editing
 296     virtual bool HasEditorCtrl()
 297         { return false; }
 298     virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent),
 299                                         wxRect WXUNUSED(labelRect),
 300                                         const wxVariant& WXUNUSED(value))
 301         { return NULL; }
 302     virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor),
 303                                         wxVariant& WXUNUSED(value))
 304         { return false; }
 305
 306     virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect );
 307     virtual void CancelEditing();
 308     virtual bool FinishEditing();
 309
 310     wxControl *GetEditorCtrl() { return m_editorCtrl; }
 311
 312 protected:
 313     wxString                m_variantType;
 314     wxDataViewColumn       *m_owner;
 315     wxControl              *m_editorCtrl;
 316     wxDataViewItem          m_item; // for m_editorCtrl
 317
 318     // internal utility:
 319     const wxDataViewCtrl* GetView() const;
 320
 321 protected:
 322     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 323 };
 324
 325 // ---------------------------------------------------------
 326 // wxDataViewColumnBase
 327 // ---------------------------------------------------------
 328
 329 enum wxDataViewColumnFlags
 330 {
 331     wxDATAVIEW_COL_RESIZABLE  = 1,
 332     wxDATAVIEW_COL_SORTABLE   = 2,
 333     wxDATAVIEW_COL_HIDDEN     = 4
 334 };
 335
 336 class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
 337 {
 338 public:
 339     wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer,
 340                           unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 341                           wxAlignment align = wxALIGN_CENTER,
 342                           int flags = wxDATAVIEW_COL_RESIZABLE );
 343     wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
 344                           unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 345                           wxAlignment align = wxALIGN_CENTER,
 346                           int flags = wxDATAVIEW_COL_RESIZABLE );
 347     virtual ~wxDataViewColumnBase();
 348
 349     // setters:
 350
 351     virtual void SetTitle( const wxString &title ) = 0;
 352     virtual void SetAlignment( wxAlignment align ) = 0;
 353     virtual void SetSortable( bool sortable ) = 0;
 354     virtual void SetResizeable( bool resizeable ) = 0;
 355     virtual void SetHidden( bool hidden ) = 0;
 356     virtual void SetSortOrder( bool ascending ) = 0;
 357     virtual void SetFlags( int flags );
 358     virtual void SetOwner( wxDataViewCtrl *owner )
 359         { m_owner = owner; }
 360     virtual void SetBitmap( const wxBitmap &bitmap )
 361         { m_bitmap=bitmap; }
 362
 363     virtual void SetMinWidth( int minWidth ) = 0;
 364     virtual void SetWidth( int width ) = 0;
 365
 366
 367     // getters:
 368
 369     virtual wxString GetTitle() const = 0;
 370     virtual wxAlignment GetAlignment() const = 0;
 371     virtual int GetWidth() const = 0;
 372     virtual int GetMinWidth() const = 0;
 373
 374     virtual int GetFlags() const;
 375
 376     virtual bool IsSortable() const = 0;
 377     virtual bool IsResizeable() const = 0;
 378     virtual bool IsHidden() const = 0;
 379     virtual bool IsSortOrderAscending() const = 0;
 380
 381     const wxBitmap &GetBitmap() const       { return m_bitmap; }
 382     unsigned int GetModelColumn() const     { return m_model_column; }
 383
 384     wxDataViewCtrl *GetOwner()              { return m_owner; }
 385     wxDataViewRenderer* GetRenderer()       { return m_renderer; }
 386
 387 protected:
 388     wxDataViewRenderer      *m_renderer;
 389     int                      m_model_column;
 390     wxBitmap                 m_bitmap;
 391     wxDataViewCtrl          *m_owner;
 392
 393 protected:
 394     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 395 };
 396
 397 // ---------------------------------------------------------
 398 // wxDataViewCtrlBase
 399 // ---------------------------------------------------------
 400
 401 #define wxDV_SINGLE                  0x0000     // for convenience
 402 #define wxDV_MULTIPLE                0x0001     // can select multiple items
 403
 404 #define wxDV_NO_HEADER               0x0002     // column titles not visible
 405 #define wxDV_HORIZ_RULES             0x0004     // light horizontal rules between rows
 406 #define wxDV_VERT_RULES              0x0008     // light vertical rules between columns
 407
 408 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 409 {
 410 public:
 411     wxDataViewCtrlBase();
 412     virtual ~wxDataViewCtrlBase();
 413
 414     virtual bool AssociateModel( wxDataViewModel *model );
 415     wxDataViewModel* GetModel();
 416
 417     // short cuts
 418     wxDataViewColumn *AppendTextColumn( const wxString &label, unsigned int model_column,
 419                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 420                     wxAlignment align = wxALIGN_CENTER,
 421                     int flags = wxDATAVIEW_COL_RESIZABLE );
 422     wxDataViewColumn *AppendToggleColumn( const wxString &label, unsigned int model_column,
 423                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 424                     wxAlignment align = wxALIGN_CENTER,
 425                     int flags = wxDATAVIEW_COL_RESIZABLE );
 426     wxDataViewColumn *AppendProgressColumn( const wxString &label, unsigned int model_column,
 427                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 428                     wxAlignment align = wxALIGN_CENTER,
 429                     int flags = wxDATAVIEW_COL_RESIZABLE );
 430     wxDataViewColumn *AppendDateColumn( const wxString &label, unsigned int model_column,
 431                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 432                     wxAlignment align = wxALIGN_CENTER,
 433                     int flags = wxDATAVIEW_COL_RESIZABLE );
 434     wxDataViewColumn *AppendBitmapColumn( const wxString &label, unsigned int model_column,
 435                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 436                     wxAlignment align = wxALIGN_CENTER,
 437                     int flags = wxDATAVIEW_COL_RESIZABLE );
 438     wxDataViewColumn *AppendTextColumn( const wxBitmap &label, unsigned int model_column,
 439                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 440                     wxAlignment align = wxALIGN_CENTER,
 441                     int flags = wxDATAVIEW_COL_RESIZABLE );
 442     wxDataViewColumn *AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
 443                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 444                     wxAlignment align = wxALIGN_CENTER,
 445                     int flags = wxDATAVIEW_COL_RESIZABLE );
 446     wxDataViewColumn *AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
 447                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 448                     wxAlignment align = wxALIGN_CENTER,
 449                     int flags = wxDATAVIEW_COL_RESIZABLE );
 450     wxDataViewColumn *AppendDateColumn( const wxBitmap &label, unsigned int model_column,
 451                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 452                     wxAlignment align = wxALIGN_CENTER,
 453                     int flags = wxDATAVIEW_COL_RESIZABLE );
 454
 455     wxDataViewColumn *AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
 456                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 457                     wxAlignment align = wxALIGN_CENTER,
 458                     int flags = wxDATAVIEW_COL_RESIZABLE );
 459
 460     virtual bool AppendColumn( wxDataViewColumn *col );
 461
 462     virtual unsigned int GetColumnCount() const;
 463
 464     virtual bool DeleteColumn( unsigned int pos );
 465     virtual bool ClearColumns();
 466     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
 467
 468     void SetExpanderColumn( wxDataViewColumn *col )
 469         { m_expander_column = col ; DoSetExpanderColumn(); }
 470     wxDataViewColumn *GetExpanderColumn() const
 471         { return m_expander_column; }
 472
 473     void SetIndent( int indent )
 474         { m_indent = indent ; DoSetIndent(); }
 475     int GetIndent() const
 476         { return m_indent; }
 477
 478     virtual wxDataViewItem GetSelection() const = 0;
 479     virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
 480     virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
 481     virtual void Select( const wxDataViewItem & item ) = 0;
 482     virtual void Unselect( const wxDataViewItem & item ) = 0;
 483     virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
 484
 485     virtual void SelectAll() = 0;
 486     virtual void UnselectAll() = 0;
 487
 488     virtual void Expand( const wxDataViewItem & item ) = 0;
 489     virtual void Collapse( const wxDataViewItem & item ) = 0;
 490
 491     virtual void EnsureVisible( const wxDataViewItem & item,
 492                                 const wxDataViewColumn *column = NULL ) = 0;
 493     virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
 494     virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
 495
 496 protected:
 497     virtual void DoSetExpanderColumn() = 0 ;
 498     virtual void DoSetIndent() = 0;
 499
 500 private:
 501     wxDataViewModel        *m_model;
 502     wxList                  m_cols;
 503     wxDataViewColumn       *m_expander_column;
 504     int m_indent ;
 505
 506 protected:
 507     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 508 };
 509
 510 // ----------------------------------------------------------------------------
 511 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
 512 // ----------------------------------------------------------------------------
 513
 514 class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
 515 {
 516 public:
 517     wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 518         : wxNotifyEvent(commandType, winid),
 519         m_item(0),
 520         m_col(-1),
 521         m_model(NULL),
 522         m_value(wxNullVariant),
 523         m_column(NULL)
 524         { }
 525
 526     wxDataViewEvent(const wxDataViewEvent& event)
 527         : wxNotifyEvent(event),
 528         m_item(event.m_item),
 529         m_col(event.m_col),
 530         m_model(event.m_model),
 531         m_value(event.m_value),
 532         m_column(event.m_column)
 533         { }
 534
 535     wxDataViewItem GetItem() const { return m_item; }
 536     void SetItem( const wxDataViewItem &item ) { m_item = item; }
 537
 538     int GetColumn() const { return m_col; }
 539     void SetColumn( int col ) { m_col = col; }
 540
 541     wxDataViewModel* GetModel() const { return m_model; }
 542     void SetModel( wxDataViewModel *model ) { m_model = model; }
 543
 544     const wxVariant &GetValue() const { return m_value; }
 545     void SetValue( const wxVariant &value ) { m_value = value; }
 546
 547     // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
 548     void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
 549     wxDataViewColumn *GetDataViewColumn() const { return m_column; }
 550
 551     virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
 552
 553 protected:
 554     wxDataViewItem      m_item;
 555     int                 m_col;
 556     wxDataViewModel    *m_model;
 557     wxVariant           m_value;
 558     wxDataViewColumn   *m_column;
 559
 560 private:
 561     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
 562 };
 563
 564 BEGIN_DECLARE_EVENT_TYPES()
 565     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_SELECTED, -1)
 566     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_DESELECTED, -1)
 567     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, -1)
 568     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED, -1)
 569     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED, -1)
 570     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING, -1)
 571     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, -1)
 572     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED, -1)
 573     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE, -1)
 574
 575     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, -1)
 576     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, -1)
 577     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, -1)
 578
 579     // notifications from the model to the control
 580     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED, -1)
 581     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED, -1)
 582     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED, -1)
 583     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED, -1)
 584     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED, -1)
 585 END_DECLARE_EVENT_TYPES()
 586
 587 typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
 588
 589 #define wxDataViewEventHandler(func) \
 590     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
 591
 592 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
 593     wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
 594
 595 #define EVT_DATAVIEW_ITEM_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_SELECTED, id, fn)
 596 #define EVT_DATAVIEW_ITEM_DESELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DESELECTED, id, fn)
 597 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
 598 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
 599 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
 600 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
 601 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
 602 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
 603 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
 604
 605 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
 606 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
 607 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
 608
 609 #define EVT_DATAVIEW_MODEL_ITEM_ADDED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_ADDED, id, fn)
 610 #define EVT_DATAVIEW_MODEL_ITEM_DELETED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_DELETED, id, fn)
 611 #define EVT_DATAVIEW_MODEL_ITEM_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_CHANGED, id, fn)
 612 #define EVT_DATAVIEW_MODEL_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_VALUE_CHANGED, id, fn)
 613 #define EVT_DATAVIEW_MODEL_CLEARED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_CLEARED, id, fn)
 614
 615
 616 #if defined(wxUSE_GENERICDATAVIEWCTRL)
 617     #include "wx/generic/dataview.h"
 618 #elif defined(__WXGTK20__)
 619     #include "wx/gtk/dataview.h"
 620 #elif defined(__WXMAC__)
 621     #include "wx/mac/dataview.h"
 622 #else
 623     #include "wx/generic/dataview.h"
 624 #endif
 625
 626 #endif // wxUSE_DATAVIEWCTRL
 627
 628 #endif
 629     // _WX_DATAVIEW_H_BASE_