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 #include "wx/icon.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_TOP)
  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 private:
  81     void* m_id;
  82 };
  83
  84 bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
  85
  86 WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
  87
  88 // ---------------------------------------------------------
  89 // wxDataViewModelNotifier
  90 // ---------------------------------------------------------
  91
  92 class WXDLLIMPEXP_ADV wxDataViewModelNotifier
  93 {
  94 public:
  95     wxDataViewModelNotifier() { }
  96     virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
  97
  98     virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
  99     virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
 100     virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
 101     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
 102     virtual bool Cleared() = 0;
 103
 104     virtual void Resort() = 0;
 105
 106     void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
 107     wxDataViewModel *GetOwner()             { return m_owner; }
 108
 109 private:
 110     wxDataViewModel *m_owner;
 111 };
 112
 113
 114 // ---------------------------------------------------------
 115 // wxDataViewModel
 116 // ---------------------------------------------------------
 117
 118 WX_DECLARE_LIST(wxDataViewModelNotifier, wxDataViewModelNotifiers );
 119
 120 class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
 121 {
 122 public:
 123     wxDataViewModel();
 124
 125     virtual unsigned int GetColumnCount() const = 0;
 126
 127     // return type as reported by wxVariant
 128     virtual wxString GetColumnType( unsigned int col ) const = 0;
 129
 130     // get value into a wxVariant
 131     virtual void GetValue( wxVariant &variant,
 132                            const wxDataViewItem &item, unsigned int col ) const = 0;
 133
 134     // set value, call ValueChanged() afterwards!
 135     virtual bool SetValue( const wxVariant &variant,
 136                            const wxDataViewItem &item, unsigned int col ) = 0;
 137
 138     // define hierachy
 139     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
 140     virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
 141     virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) 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() const { 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() const { 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 unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
 213
 214 private:
 215     wxDataViewItemArray m_hash;
 216     unsigned int m_lastIndex;
 217 };
 218
 219 //-----------------------------------------------------------------------------
 220 // wxDataViewEditorCtrlEvtHandler
 221 //-----------------------------------------------------------------------------
 222
 223 class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler
 224 {
 225 public:
 226     wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner );
 227
 228     void AcceptChangesAndFinish();
 229     void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; }
 230
 231 protected:
 232     void OnChar( wxKeyEvent &event );
 233     void OnKillFocus( wxFocusEvent &event );
 234     void OnIdle( wxIdleEvent &event );
 235
 236 private:
 237     wxDataViewRenderer     *m_owner;
 238     wxControl              *m_editorCtrl;
 239     bool                    m_finished;
 240     bool                    m_focusOnIdle;
 241
 242 private:
 243     DECLARE_EVENT_TABLE()
 244 };
 245
 246 // ---------------------------------------------------------
 247 // wxDataViewRendererBase
 248 // ---------------------------------------------------------
 249
 250 enum wxDataViewCellMode
 251 {
 252     wxDATAVIEW_CELL_INERT,
 253     wxDATAVIEW_CELL_ACTIVATABLE,
 254     wxDATAVIEW_CELL_EDITABLE
 255 };
 256
 257 enum wxDataViewCellRenderState
 258 {
 259     wxDATAVIEW_CELL_SELECTED    = 1,
 260     wxDATAVIEW_CELL_PRELIT      = 2,
 261     wxDATAVIEW_CELL_INSENSITIVE = 4,
 262     wxDATAVIEW_CELL_FOCUSED     = 8
 263 };
 264
 265 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 266 {
 267 public:
 268     wxDataViewRendererBase( const wxString &varianttype,
 269                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 270                             int alignment = wxDVR_DEFAULT_ALIGNMENT );
 271
 272     virtual bool Validate( wxVariant& WXUNUSED(value) )
 273         { return true; }
 274
 275     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
 276     wxDataViewColumn* GetOwner()                { return m_owner; }
 277
 278     // renderer properties:
 279
 280     virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0;
 281     virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0;
 282
 283     wxString GetVariantType() const             { return m_variantType; }
 284
 285     virtual void SetMode( wxDataViewCellMode mode ) = 0;
 286     virtual wxDataViewCellMode GetMode() const = 0;
 287
 288     // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but
 289     //       rather an "int"; that's because for rendering cells it's allowed
 290     //       to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM)
 291     virtual void SetAlignment( int align ) = 0;
 292     virtual int GetAlignment() const = 0;
 293
 294     // in-place editing
 295     virtual bool HasEditorCtrl()
 296         { return false; }
 297     virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent),
 298                                         wxRect WXUNUSED(labelRect),
 299                                         const wxVariant& WXUNUSED(value))
 300         { return NULL; }
 301     virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor),
 302                                         wxVariant& WXUNUSED(value))
 303         { return false; }
 304
 305     virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect );
 306     virtual void CancelEditing();
 307     virtual bool FinishEditing();
 308
 309     wxControl *GetEditorCtrl() { return m_editorCtrl; }
 310
 311 protected:
 312     wxString                m_variantType;
 313     wxDataViewColumn       *m_owner;
 314     wxControl              *m_editorCtrl;
 315     wxDataViewItem          m_item; // for m_editorCtrl
 316
 317     // internal utility:
 318     const wxDataViewCtrl* GetView() const;
 319
 320 protected:
 321     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 322 };
 323
 324 //-----------------------------------------------------------------------------
 325 // wxDataViewIconText
 326 //-----------------------------------------------------------------------------
 327
 328 class wxDataViewIconText: public wxObject
 329 {
 330 public:
 331     wxDataViewIconText( const wxString &text = wxEmptyString, const wxIcon& icon = wxNullIcon )
 332     { m_icon = icon; m_text = text; }
 333     wxDataViewIconText( const wxDataViewIconText &other )
 334     { m_icon = other.m_icon; m_text = other.m_text; }
 335
 336     void SetText( const wxString &text ) { m_text = text; }
 337     wxString GetText() const             { return m_text; }
 338     void SetIcon( const wxIcon &icon )   { m_icon = icon; }
 339     const wxIcon &GetIcon() const        { return m_icon; }
 340
 341 private:
 342     wxString    m_text;
 343     wxIcon      m_icon;
 344
 345 private:
 346     DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
 347 };
 348
 349 bool operator == (const wxDataViewIconText &one, const wxDataViewIconText &two);
 350
 351 DECLARE_VARIANT_OBJECT(wxDataViewIconText)
 352
 353 // ---------------------------------------------------------
 354 // wxDataViewColumnBase
 355 // ---------------------------------------------------------
 356
 357 enum wxDataViewColumnFlags
 358 {
 359     wxDATAVIEW_COL_RESIZABLE  = 1,
 360     wxDATAVIEW_COL_SORTABLE   = 2,
 361     wxDATAVIEW_COL_HIDDEN     = 4
 362 };
 363
 364 class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
 365 {
 366 public:
 367     wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer,
 368                           unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 369                           wxAlignment align = wxALIGN_CENTER,
 370                           int flags = wxDATAVIEW_COL_RESIZABLE );
 371     wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
 372                           unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
 373                           wxAlignment align = wxALIGN_CENTER,
 374                           int flags = wxDATAVIEW_COL_RESIZABLE );
 375     virtual ~wxDataViewColumnBase();
 376
 377     // setters:
 378
 379     virtual void SetTitle( const wxString &title ) = 0;
 380     virtual void SetAlignment( wxAlignment align ) = 0;
 381     virtual void SetSortable( bool sortable ) = 0;
 382     virtual void SetResizeable( bool resizeable ) = 0;
 383     virtual void SetHidden( bool hidden ) = 0;
 384     virtual void SetSortOrder( bool ascending ) = 0;
 385     virtual void SetFlags( int flags );
 386     virtual void SetOwner( wxDataViewCtrl *owner )
 387         { m_owner = owner; }
 388     virtual void SetBitmap( const wxBitmap &bitmap )
 389         { m_bitmap=bitmap; }
 390
 391     virtual void SetMinWidth( int minWidth ) = 0;
 392     virtual void SetWidth( int width ) = 0;
 393
 394
 395     // getters:
 396
 397     virtual wxString GetTitle() const = 0;
 398     virtual wxAlignment GetAlignment() const = 0;
 399     virtual int GetWidth() const = 0;
 400     virtual int GetMinWidth() const = 0;
 401
 402     virtual int GetFlags() const;
 403
 404     virtual bool IsSortable() const = 0;
 405     virtual bool IsResizeable() const = 0;
 406     virtual bool IsHidden() const = 0;
 407     virtual bool IsSortOrderAscending() const = 0;
 408
 409     const wxBitmap &GetBitmap() const       { return m_bitmap; }
 410     unsigned int GetModelColumn() const     { return m_model_column; }
 411
 412     wxDataViewCtrl *GetOwner()              { return m_owner; }
 413     wxDataViewRenderer* GetRenderer()       { return m_renderer; }
 414
 415 protected:
 416     wxDataViewRenderer      *m_renderer;
 417     int                      m_model_column;
 418     wxBitmap                 m_bitmap;
 419     wxDataViewCtrl          *m_owner;
 420
 421 protected:
 422     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 423 };
 424
 425 // ---------------------------------------------------------
 426 // wxDataViewCtrlBase
 427 // ---------------------------------------------------------
 428
 429 #define wxDV_SINGLE                  0x0000     // for convenience
 430 #define wxDV_MULTIPLE                0x0001     // can select multiple items
 431
 432 #define wxDV_NO_HEADER               0x0002     // column titles not visible
 433 #define wxDV_HORIZ_RULES             0x0004     // light horizontal rules between rows
 434 #define wxDV_VERT_RULES              0x0008     // light vertical rules between columns
 435
 436 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 437 {
 438 public:
 439     wxDataViewCtrlBase();
 440     virtual ~wxDataViewCtrlBase();
 441
 442     virtual bool AssociateModel( wxDataViewModel *model );
 443     wxDataViewModel* GetModel();
 444
 445     // short cuts
 446     wxDataViewColumn *AppendTextColumn( const wxString &label, unsigned int model_column,
 447                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 448                     wxAlignment align = wxALIGN_CENTER,
 449                     int flags = wxDATAVIEW_COL_RESIZABLE );
 450     wxDataViewColumn *AppendIconTextColumn( const wxString &label, unsigned int model_column,
 451                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 452                     wxAlignment align = wxALIGN_CENTER,
 453                     int flags = wxDATAVIEW_COL_RESIZABLE );
 454     wxDataViewColumn *AppendToggleColumn( const wxString &label, unsigned int model_column,
 455                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 456                     wxAlignment align = wxALIGN_CENTER,
 457                     int flags = wxDATAVIEW_COL_RESIZABLE );
 458     wxDataViewColumn *AppendProgressColumn( const wxString &label, unsigned int model_column,
 459                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 460                     wxAlignment align = wxALIGN_CENTER,
 461                     int flags = wxDATAVIEW_COL_RESIZABLE );
 462     wxDataViewColumn *AppendDateColumn( const wxString &label, unsigned int model_column,
 463                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 464                     wxAlignment align = wxALIGN_CENTER,
 465                     int flags = wxDATAVIEW_COL_RESIZABLE );
 466     wxDataViewColumn *AppendBitmapColumn( const wxString &label, unsigned int model_column,
 467                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 468                     wxAlignment align = wxALIGN_CENTER,
 469                     int flags = wxDATAVIEW_COL_RESIZABLE );
 470     wxDataViewColumn *AppendTextColumn( const wxBitmap &label, unsigned int model_column,
 471                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 472                     wxAlignment align = wxALIGN_CENTER,
 473                     int flags = wxDATAVIEW_COL_RESIZABLE );
 474     wxDataViewColumn *AppendIconTextColumn( const wxBitmap &label, unsigned int model_column,
 475                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 476                     wxAlignment align = wxALIGN_CENTER,
 477                     int flags = wxDATAVIEW_COL_RESIZABLE );
 478     wxDataViewColumn *AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
 479                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
 480                     wxAlignment align = wxALIGN_CENTER,
 481                     int flags = wxDATAVIEW_COL_RESIZABLE );
 482     wxDataViewColumn *AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
 483                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
 484                     wxAlignment align = wxALIGN_CENTER,
 485                     int flags = wxDATAVIEW_COL_RESIZABLE );
 486     wxDataViewColumn *AppendDateColumn( const wxBitmap &label, unsigned int model_column,
 487                     wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
 488                     wxAlignment align = wxALIGN_CENTER,
 489                     int flags = wxDATAVIEW_COL_RESIZABLE );
 490
 491     wxDataViewColumn *AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
 492                     wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
 493                     wxAlignment align = wxALIGN_CENTER,
 494                     int flags = wxDATAVIEW_COL_RESIZABLE );
 495
 496     virtual bool AppendColumn( wxDataViewColumn *col );
 497
 498     virtual unsigned int GetColumnCount() const = 0;
 499     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const = 0;
 500
 501     virtual bool DeleteColumn( wxDataViewColumn *column ) = 0;
 502     virtual bool ClearColumns() = 0;
 503
 504     void SetExpanderColumn( wxDataViewColumn *col )
 505         { m_expander_column = col ; DoSetExpanderColumn(); }
 506     wxDataViewColumn *GetExpanderColumn() const
 507         { return m_expander_column; }
 508
 509     void SetIndent( int indent )
 510         { m_indent = indent ; DoSetIndent(); }
 511     int GetIndent() const
 512         { return m_indent; }
 513
 514     virtual wxDataViewItem GetSelection() const = 0;
 515     virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
 516     virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
 517     virtual void Select( const wxDataViewItem & item ) = 0;
 518     virtual void Unselect( const wxDataViewItem & item ) = 0;
 519     virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
 520
 521     virtual void SelectAll() = 0;
 522     virtual void UnselectAll() = 0;
 523
 524     virtual void Expand( const wxDataViewItem & item ) = 0;
 525     virtual void Collapse( const wxDataViewItem & item ) = 0;
 526
 527     virtual void EnsureVisible( const wxDataViewItem & item,
 528                                 const wxDataViewColumn *column = NULL ) = 0;
 529     virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
 530     virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
 531
 532 protected:
 533     virtual void DoSetExpanderColumn() = 0 ;
 534     virtual void DoSetIndent() = 0;
 535
 536 private:
 537     wxDataViewModel        *m_model;
 538     wxDataViewColumn       *m_expander_column;
 539     int m_indent ;
 540
 541 protected:
 542     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 543 };
 544
 545 // ----------------------------------------------------------------------------
 546 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
 547 // ----------------------------------------------------------------------------
 548
 549 class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
 550 {
 551 public:
 552     wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 553         : wxNotifyEvent(commandType, winid),
 554         m_item(0),
 555         m_col(-1),
 556         m_model(NULL),
 557         m_value(wxNullVariant),
 558         m_column(NULL)
 559         { }
 560
 561     wxDataViewEvent(const wxDataViewEvent& event)
 562         : wxNotifyEvent(event),
 563         m_item(event.m_item),
 564         m_col(event.m_col),
 565         m_model(event.m_model),
 566         m_value(event.m_value),
 567         m_column(event.m_column)
 568         { }
 569
 570     wxDataViewItem GetItem() const { return m_item; }
 571     void SetItem( const wxDataViewItem &item ) { m_item = item; }
 572
 573     int GetColumn() const { return m_col; }
 574     void SetColumn( int col ) { m_col = col; }
 575
 576     wxDataViewModel* GetModel() const { return m_model; }
 577     void SetModel( wxDataViewModel *model ) { m_model = model; }
 578
 579     const wxVariant &GetValue() const { return m_value; }
 580     void SetValue( const wxVariant &value ) { m_value = value; }
 581
 582     // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
 583     void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
 584     wxDataViewColumn *GetDataViewColumn() const { return m_column; }
 585
 586     virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
 587
 588 protected:
 589     wxDataViewItem      m_item;
 590     int                 m_col;
 591     wxDataViewModel    *m_model;
 592     wxVariant           m_value;
 593     wxDataViewColumn   *m_column;
 594
 595 private:
 596     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
 597 };
 598
 599 BEGIN_DECLARE_EVENT_TYPES()
 600     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_SELECTED, -1)
 601     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_DESELECTED, -1)
 602     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, -1)
 603     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED, -1)
 604     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED, -1)
 605     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING, -1)
 606     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, -1)
 607     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED, -1)
 608     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE, -1)
 609
 610     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, -1)
 611     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, -1)
 612     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, -1)
 613
 614     // notifications from the model to the control
 615     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED, -1)
 616     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED, -1)
 617     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED, -1)
 618     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED, -1)
 619     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED, -1)
 620 END_DECLARE_EVENT_TYPES()
 621
 622 typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
 623
 624 #define wxDataViewEventHandler(func) \
 625     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
 626
 627 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
 628     wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
 629
 630 #define EVT_DATAVIEW_ITEM_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_SELECTED, id, fn)
 631 #define EVT_DATAVIEW_ITEM_DESELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_DESELECTED, id, fn)
 632 #define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
 633 #define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
 634 #define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
 635 #define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
 636 #define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
 637 #define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
 638 #define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, id, fn)
 639
 640 #define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn)
 641 #define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn)
 642 #define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn)
 643
 644 #define EVT_DATAVIEW_MODEL_ITEM_ADDED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_ADDED, id, fn)
 645 #define EVT_DATAVIEW_MODEL_ITEM_DELETED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_DELETED, id, fn)
 646 #define EVT_DATAVIEW_MODEL_ITEM_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_CHANGED, id, fn)
 647 #define EVT_DATAVIEW_MODEL_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_VALUE_CHANGED, id, fn)
 648 #define EVT_DATAVIEW_MODEL_CLEARED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_CLEARED, id, fn)
 649
 650
 651 #if defined(wxUSE_GENERICDATAVIEWCTRL)
 652     #include "wx/generic/dataview.h"
 653 #elif defined(__WXGTK20__)
 654     #include "wx/gtk/dataview.h"
 655 #elif defined(__WXMAC__)
 656     #include "wx/mac/dataview.h"
 657 #else
 658     #include "wx/generic/dataview.h"
 659 #endif
 660
 661 #endif // wxUSE_DATAVIEWCTRL
 662
 663 #endif
 664     // _WX_DATAVIEW_H_BASE_