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