include/wx/generic/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/dataview.h
   3 // Purpose:     wxDataViewCtrl generic implementation header
   4 // Author:      Robert Roebling
   5 // Modified By: Bo Yang
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __GENERICDATAVIEWCTRLH__
  12 #define __GENERICDATAVIEWCTRLH__
  13
  14 #include "wx/defs.h"
  15 #include "wx/object.h"
  16 #include "wx/list.h"
  17 #include "wx/control.h"
  18 #include "wx/scrolwin.h"
  19 #include "wx/icon.h"
  20
  21 // ---------------------------------------------------------
  22 // classes
  23 // ---------------------------------------------------------
  24
  25 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
  26 class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
  27 class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
  28
  29 // ---------------------------------------------------------
  30 // wxDataViewRenderer
  31 // ---------------------------------------------------------
  32
  33 class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
  34 {
  35 public:
  36     wxDataViewRenderer( const wxString &varianttype,
  37                         wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
  38                         int align = wxDVR_DEFAULT_ALIGNMENT );
  39     virtual ~wxDataViewRenderer();
  40
  41     // these methods are used to draw the cell contents, Render() doesn't care
  42     // about the attributes while RenderWithAttr() does -- override it if you
  43     // want to take the attributes defined for this cell into account, otherwise
  44     // overriding Render() is enough
  45     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
  46
  47     // NB: RenderWithAttr() also has more standard parameter order and types
  48     virtual bool
  49     RenderWithAttr(wxDC& dc,
  50                    const wxRect& rect,
  51                    int align,   // combination of horizontal and vertical
  52                    const wxDataViewItemAttr *attr, // may be NULL if none
  53                    int state);
  54
  55     virtual wxSize GetSize() const = 0;
  56
  57     virtual void SetAlignment( int align );
  58     virtual int GetAlignment() const;
  59
  60     virtual void SetMode( wxDataViewCellMode mode )
  61         { m_mode=mode; }
  62     virtual wxDataViewCellMode GetMode() const
  63         { return m_mode; }
  64
  65     virtual bool Activate( wxRect WXUNUSED(cell),
  66                            wxDataViewModel *WXUNUSED(model),
  67                            const wxDataViewItem & WXUNUSED(item),
  68                            unsigned int WXUNUSED(col) )
  69                            { return false; }
  70
  71     virtual bool LeftClick( wxPoint WXUNUSED(cursor),
  72                             wxRect WXUNUSED(cell),
  73                             wxDataViewModel *WXUNUSED(model),
  74                             const wxDataViewItem & WXUNUSED(item),
  75                             unsigned int WXUNUSED(col) )
  76                             { return false; }
  77     virtual bool RightClick( wxPoint WXUNUSED(cursor),
  78                              wxRect WXUNUSED(cell),
  79                              wxDataViewModel *WXUNUSED(model),
  80                              const wxDataViewItem & WXUNUSED(item),
  81                              unsigned int WXUNUSED(col) )
  82                              { return false; }
  83     virtual bool StartDrag( wxPoint WXUNUSED(cursor),
  84                             wxRect WXUNUSED(cell),
  85                             wxDataViewModel *WXUNUSED(model),
  86                             const wxDataViewItem & WXUNUSED(item),
  87                             unsigned int WXUNUSED(col) )
  88                             { return false; }
  89
  90     // Create DC on request
  91     virtual wxDC *GetDC();
  92
  93     // implementation
  94     int CalculateAlignment() const;
  95
  96 protected:
  97     // This is just a convenience for the derived classes overriding
  98     // RenderWithAttr() to avoid repeating the same wxFAIL_MSG() in all of them
  99     bool DummyRender(wxRect WXUNUSED(cell),
 100                      wxDC * WXUNUSED(dc),
 101                      int WXUNUSED(state))
 102     {
 103         wxFAIL_MSG("shouldn't be called at all, use RenderWithAttr() instead");
 104
 105         return false;
 106     }
 107
 108 private:
 109     wxDC                        *m_dc;
 110     int                          m_align;
 111     wxDataViewCellMode           m_mode;
 112
 113     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
 114 };
 115
 116 // ---------------------------------------------------------
 117 // wxDataViewCustomRenderer
 118 // ---------------------------------------------------------
 119
 120 class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
 121 {
 122 public:
 123     wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
 124                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 125                               int align = wxDVR_DEFAULT_ALIGNMENT );
 126
 127     // Draw the text using the provided attributes
 128     void RenderText(wxDC& dc,
 129                     const wxRect& rect,
 130                     int align,
 131                     const wxString& text,
 132                     const wxDataViewItemAttr *attr, // may be NULL if none
 133                     int state,
 134                     int xoffset = 0);
 135
 136     // Overload using standard attributes
 137     void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
 138
 139 protected:
 140     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
 141 };
 142
 143
 144 // ---------------------------------------------------------
 145 // wxDataViewTextRenderer
 146 // ---------------------------------------------------------
 147
 148 class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer
 149 {
 150 public:
 151     wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
 152                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 153                             int align = wxDVR_DEFAULT_ALIGNMENT );
 154
 155     bool SetValue( const wxVariant &value );
 156     bool GetValue( wxVariant &value ) const;
 157
 158     virtual bool RenderWithAttr(wxDC& dc,
 159                                 const wxRect& rect,
 160                                 int align,
 161                                 const wxDataViewItemAttr *attr,
 162                                 int state);
 163     virtual bool Render(wxRect cell, wxDC *dc, int state)
 164     {
 165         return DummyRender(cell, dc, state);
 166     }
 167
 168     wxSize GetSize() const;
 169
 170     // in-place editing
 171     virtual bool HasEditorCtrl() const;
 172     virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect,
 173                                          const wxVariant &value );
 174     virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
 175
 176 protected:
 177     wxString   m_text;
 178
 179 protected:
 180     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
 181 };
 182
 183 // ---------------------------------------------------------
 184 // wxDataViewBitmapRenderer
 185 // ---------------------------------------------------------
 186
 187 class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer
 188 {
 189 public:
 190     wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
 191                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 192                               int align = wxDVR_DEFAULT_ALIGNMENT );
 193
 194     bool SetValue( const wxVariant &value );
 195     bool GetValue( wxVariant &value ) const;
 196
 197     bool Render( wxRect cell, wxDC *dc, int state );
 198     wxSize GetSize() const;
 199
 200 private:
 201     wxIcon m_icon;
 202     wxBitmap m_bitmap;
 203
 204 protected:
 205     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
 206 };
 207
 208 // ---------------------------------------------------------
 209 // wxDataViewToggleRenderer
 210 // ---------------------------------------------------------
 211
 212 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer
 213 {
 214 public:
 215     wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
 216                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 217                               int align = wxDVR_DEFAULT_ALIGNMENT );
 218
 219     bool SetValue( const wxVariant &value );
 220     bool GetValue( wxVariant &value ) const;
 221
 222     bool Render( wxRect cell, wxDC *dc, int state );
 223     bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item,
 224                             unsigned int col );
 225     wxSize GetSize() const;
 226
 227 private:
 228     bool    m_toggle;
 229
 230 protected:
 231     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
 232 };
 233
 234 // ---------------------------------------------------------
 235 // wxDataViewProgressRenderer
 236 // ---------------------------------------------------------
 237
 238 class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
 239 {
 240 public:
 241     wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
 242                                 const wxString &varianttype = wxT("long"),
 243                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 244                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 245
 246     bool SetValue( const wxVariant &value );
 247     bool GetValue( wxVariant& value ) const;
 248
 249     virtual bool RenderWithAttr(wxDC& dc,
 250                                 const wxRect& rect,
 251                                 int align,
 252                                 const wxDataViewItemAttr *attr,
 253                                 int state);
 254     virtual bool Render(wxRect cell, wxDC *dc, int state)
 255     {
 256         return DummyRender(cell, dc, state);
 257     }
 258     virtual wxSize GetSize() const;
 259
 260 private:
 261     wxString    m_label;
 262     int         m_value;
 263
 264 protected:
 265     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
 266 };
 267
 268 // ---------------------------------------------------------
 269 // wxDataViewIconTextRenderer
 270 // ---------------------------------------------------------
 271
 272 class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewCustomRenderer
 273 {
 274 public:
 275     wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
 276                                 wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
 277                                 int align = wxDVR_DEFAULT_ALIGNMENT );
 278     virtual ~wxDataViewIconTextRenderer();
 279
 280     bool SetValue( const wxVariant &value );
 281     bool GetValue( wxVariant &value ) const;
 282
 283     virtual bool Render( wxRect cell, wxDC *dc, int state );
 284     virtual wxSize GetSize() const;
 285
 286     virtual bool HasEditorCtrl() const { return true; }
 287     virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect,
 288                                          const wxVariant &value );
 289     virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
 290
 291 private:
 292     wxDataViewIconText   m_value;
 293
 294 protected:
 295     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
 296 };
 297
 298 // ---------------------------------------------------------
 299 // wxDataViewDateRenderer
 300 // ---------------------------------------------------------
 301
 302 class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
 303 {
 304 public:
 305     wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
 306                             wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
 307                             int align = wxDVR_DEFAULT_ALIGNMENT );
 308
 309     bool SetValue( const wxVariant &value );
 310     bool GetValue( wxVariant& value ) const;
 311
 312     virtual bool Render( wxRect cell, wxDC *dc, int state );
 313     virtual wxSize GetSize() const;
 314     virtual bool Activate( wxRect cell,
 315                            wxDataViewModel *model,
 316                            const wxDataViewItem& item,
 317                            unsigned int col );
 318
 319 private:
 320     wxDateTime    m_date;
 321
 322 protected:
 323     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
 324 };
 325
 326 // ---------------------------------------------------------
 327 // wxDataViewColumn
 328 // ---------------------------------------------------------
 329
 330 class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase
 331 {
 332 public:
 333     wxDataViewColumn(const wxString& title,
 334                      wxDataViewRenderer *renderer,
 335                      unsigned int model_column,
 336                      int width = wxDVC_DEFAULT_WIDTH,
 337                      wxAlignment align = wxALIGN_CENTER,
 338                      int flags = wxDATAVIEW_COL_RESIZABLE)
 339         : wxDataViewColumnBase(renderer, model_column),
 340           m_title(title)
 341     {
 342         Init(width, align, flags);
 343     }
 344
 345     wxDataViewColumn(const wxBitmap& bitmap,
 346                      wxDataViewRenderer *renderer,
 347                      unsigned int model_column,
 348                      int width = wxDVC_DEFAULT_WIDTH,
 349                      wxAlignment align = wxALIGN_CENTER,
 350                      int flags = wxDATAVIEW_COL_RESIZABLE)
 351         : wxDataViewColumnBase(bitmap, renderer, model_column)
 352     {
 353         Init(width, align, flags);
 354     }
 355
 356     // implement wxHeaderColumnBase methods
 357     virtual void SetTitle(const wxString& title) { m_title = title; }
 358     virtual wxString GetTitle() const { return m_title; }
 359
 360     virtual void SetWidth(int width) { m_width = width; }
 361     virtual int GetWidth() const { return m_width; }
 362
 363     virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; }
 364     virtual int GetMinWidth() const { return m_minWidth; }
 365
 366     virtual void SetAlignment(wxAlignment align) { m_align = align; }
 367     virtual wxAlignment GetAlignment() const { return m_align; }
 368
 369     virtual void SetFlags(int flags) { m_flags = flags; }
 370     virtual int GetFlags() const { return m_flags; }
 371
 372     virtual void SetAsSortKey(bool sort = true) { m_sort = sort; }
 373     virtual bool IsSortKey() const { return m_sort; }
 374
 375     virtual void SetSortOrder(bool ascending) { m_sortAscending = ascending; }
 376     virtual bool IsSortOrderAscending() const { return m_sortAscending; }
 377
 378 private:
 379     // common part of all ctors
 380     void Init(int width, wxAlignment align, int flags)
 381     {
 382         m_width = width == wxCOL_WIDTH_DEFAULT ? wxDVC_DEFAULT_WIDTH : width;
 383         m_minWidth = 0;
 384         m_align = align;
 385         m_flags = flags;
 386         m_sort = false;
 387         m_sortAscending = true;
 388     }
 389
 390     wxString m_title;
 391     int m_width,
 392         m_minWidth;
 393     wxAlignment m_align;
 394     int m_flags;
 395     bool m_sort,
 396          m_sortAscending;
 397
 398     friend class wxDataViewHeaderWindowBase;
 399     friend class wxDataViewHeaderWindow;
 400     friend class wxDataViewHeaderWindowMSW;
 401 };
 402
 403 // ---------------------------------------------------------
 404 // wxDataViewCtrl
 405 // ---------------------------------------------------------
 406
 407 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
 408                           class WXDLLIMPEXP_ADV);
 409
 410 class WXDLLIMPEXP_ADV wxDataViewCtrl : public wxDataViewCtrlBase,
 411                                        public wxScrollHelper
 412 {
 413     friend class wxDataViewMainWindow;
 414     friend class wxDataViewHeaderWindowBase;
 415     friend class wxDataViewHeaderWindow;
 416     friend class wxDataViewHeaderWindowMSW;
 417     friend class wxDataViewColumn;
 418
 419 public:
 420     wxDataViewCtrl() : wxScrollHelper(this)
 421     {
 422         Init();
 423     }
 424
 425     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
 426            const wxPoint& pos = wxDefaultPosition,
 427            const wxSize& size = wxDefaultSize, long style = 0,
 428            const wxValidator& validator = wxDefaultValidator )
 429              : wxScrollHelper(this)
 430     {
 431         Create(parent, id, pos, size, style, validator );
 432     }
 433
 434     virtual ~wxDataViewCtrl();
 435
 436     void Init();
 437
 438     bool Create(wxWindow *parent, wxWindowID id,
 439                 const wxPoint& pos = wxDefaultPosition,
 440                 const wxSize& size = wxDefaultSize, long style = 0,
 441                 const wxValidator& validator = wxDefaultValidator );
 442
 443     virtual bool AssociateModel( wxDataViewModel *model );
 444
 445     virtual bool AppendColumn( wxDataViewColumn *col );
 446     virtual bool PrependColumn( wxDataViewColumn *col );
 447     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 448
 449     virtual void DoSetExpanderColumn();
 450     virtual void DoSetIndent();
 451
 452     virtual unsigned int GetColumnCount() const;
 453     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
 454     virtual bool DeleteColumn( wxDataViewColumn *column );
 455     virtual bool ClearColumns();
 456     virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
 457
 458     virtual wxDataViewColumn *GetSortingColumn() const;
 459
 460     virtual wxDataViewItem GetSelection() const;
 461     virtual int GetSelections( wxDataViewItemArray & sel ) const;
 462     virtual void SetSelections( const wxDataViewItemArray & sel );
 463     virtual void Select( const wxDataViewItem & item );
 464     virtual void Unselect( const wxDataViewItem & item );
 465     virtual bool IsSelected( const wxDataViewItem & item ) const;
 466
 467     virtual void SelectAll();
 468     virtual void UnselectAll();
 469
 470     virtual void EnsureVisible( const wxDataViewItem & item,
 471                                 const wxDataViewColumn *column = NULL );
 472     virtual void HitTest( const wxPoint & point, wxDataViewItem & item,
 473                           wxDataViewColumn* &column ) const;
 474     virtual wxRect GetItemRect( const wxDataViewItem & item,
 475                                 const wxDataViewColumn *column = NULL ) const;
 476
 477     virtual void Expand( const wxDataViewItem & item );
 478     virtual void Collapse( const wxDataViewItem & item );
 479     virtual bool IsExpanded( const wxDataViewItem & item ) const;
 480
 481     virtual void SetFocus();
 482
 483 #if wxUSE_DRAG_AND_DROP
 484     virtual bool EnableDragSource( const wxDataFormat &format );
 485     virtual bool EnableDropTarget( const wxDataFormat &format );
 486 #endif // wxUSE_DRAG_AND_DROP
 487
 488     virtual wxBorder GetDefaultBorder() const;
 489
 490     void StartEditor( const wxDataViewItem & item, unsigned int column );
 491
 492 protected:
 493     virtual int GetSelections( wxArrayInt & sel ) const;
 494     virtual void SetSelections( const wxArrayInt & sel );
 495     virtual void Select( int row );
 496     virtual void Unselect( int row );
 497     virtual bool IsSelected( int row ) const;
 498     virtual void SelectRange( int from, int to );
 499     virtual void UnselectRange( int from, int to );
 500
 501     virtual void EnsureVisible( int row, int column );
 502
 503     virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
 504     virtual int GetRowByItem( const wxDataViewItem & item ) const;
 505
 506     int GetSortingColumnIndex() const { return m_sortingColumnIdx; }
 507     void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; }
 508
 509 public:     // utility functions not part of the API
 510
 511     // returns the "best" width for the idx-th column
 512     unsigned int GetBestColumnWidth(int WXUNUSED(idx)) const
 513     {
 514         return GetClientSize().GetWidth() / GetColumnCount();
 515     }
 516
 517     // called by header window after reorder
 518     void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
 519
 520     // update the display after a change to an individual column
 521     void OnColumnChange(unsigned int idx);
 522
 523     // update after a change to the number of columns
 524     void OnColumnsCountChanged();
 525
 526     wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
 527
 528     // return the index of the given column in m_cols
 529     int GetColumnIndex(const wxDataViewColumn *column) const;
 530
 531     // return the column displayed at the given position in the control
 532     wxDataViewColumn *GetColumnAt(unsigned int pos) const;
 533
 534 private:
 535     wxDataViewColumnList      m_cols;
 536     wxDataViewModelNotifier  *m_notifier;
 537     wxDataViewMainWindow     *m_clientArea;
 538     wxDataViewHeaderWindow   *m_headerArea;
 539
 540     // the index of the column currently used for sorting or -1
 541     int m_sortingColumnIdx;
 542
 543 private:
 544     void OnSize( wxSizeEvent &event );
 545     virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
 546
 547     // we need to return a special WM_GETDLGCODE value to process just the
 548     // arrows but let the other navigation characters through
 549 #ifdef __WXMSW__
 550     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 551 #endif // __WXMSW__
 552
 553     WX_FORWARD_TO_SCROLL_HELPER()
 554
 555 private:
 556     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
 557     wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);
 558     DECLARE_EVENT_TABLE()
 559 };
 560
 561
 562 #endif // __GENERICDATAVIEWCTRLH__