include/wx/dataview.h

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