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