include/wx/generic/grid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/grid.h
   3 // Purpose:     wxGrid and related classes
   4 // Author:      Michael Bedward (based on code by Julian Smart, Robin Dunn)
   5 // Modified by:
   6 // Created:     1/08/1999
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Michael Bedward
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/defs.h"
  13
  14 #if !defined(wxUSE_NEW_GRID) || !(wxUSE_NEW_GRID)
  15 #include "gridg.h"
  16 #else
  17
  18 #ifndef __WXGRID_H__
  19 #define __WXGRID_H__
  20
  21 #ifdef __GNUG__
  22 #pragma interface "grid.h"
  23 #endif
  24
  25 #include "wx/hash.h"
  26 #include "wx/panel.h"
  27 #include "wx/scrolwin.h"
  28 #include "wx/string.h"
  29 #include "wx/scrolbar.h"
  30 #include "wx/event.h"
  31 #include "wx/combobox.h"
  32 #include "wx/dynarray.h"
  33 #include "wx/timer.h"
  34
  35 // ----------------------------------------------------------------------------
  36 // constants
  37 // ----------------------------------------------------------------------------
  38
  39 // Default parameters for wxGrid
  40 //
  41 #define WXGRID_DEFAULT_NUMBER_ROWS            10
  42 #define WXGRID_DEFAULT_NUMBER_COLS            10
  43 #ifdef __WXMSW__
  44 #define WXGRID_DEFAULT_ROW_HEIGHT             25
  45 #else
  46 #define WXGRID_DEFAULT_ROW_HEIGHT             30
  47 #endif  // __WXMSW__
  48 #define WXGRID_DEFAULT_COL_WIDTH              80
  49 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT       32
  50 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH        82
  51 #define WXGRID_LABEL_EDGE_ZONE                 2
  52 #define WXGRID_MIN_ROW_HEIGHT                 15
  53 #define WXGRID_MIN_COL_WIDTH                  15
  54 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH        16
  55
  56 // type names for grid table values
  57 #define wxGRID_VALUE_STRING     _T("string")
  58 #define wxGRID_VALUE_BOOL       _T("bool")
  59 #define wxGRID_VALUE_NUMBER     _T("long")
  60 #define wxGRID_VALUE_FLOAT      _T("double")
  61 #define wxGRID_VALUE_CHOICE     _T("choice")
  62
  63 #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING
  64 #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER
  65
  66 // ----------------------------------------------------------------------------
  67 // forward declarations
  68 // ----------------------------------------------------------------------------
  69
  70 class WXDLLEXPORT wxGrid;
  71 class WXDLLEXPORT wxGridCellAttr;
  72 class WXDLLEXPORT wxGridCellAttrProviderData;
  73 class WXDLLEXPORT wxGridColLabelWindow;
  74 class WXDLLEXPORT wxGridCornerLabelWindow;
  75 class WXDLLEXPORT wxGridRowLabelWindow;
  76 class WXDLLEXPORT wxGridTableBase;
  77 class WXDLLEXPORT wxGridWindow;
  78 class WXDLLEXPORT wxGridTypeRegistry;
  79 class WXDLLEXPORT wxGridSelection;
  80
  81 class WXDLLEXPORT wxCheckBox;
  82 class WXDLLEXPORT wxComboBox;
  83 class WXDLLEXPORT wxTextCtrl;
  84 class WXDLLEXPORT wxSpinCtrl;
  85
  86 // ----------------------------------------------------------------------------
  87 // macros
  88 // ----------------------------------------------------------------------------
  89
  90 #define wxSafeIncRef(p) if ( p ) (p)->IncRef()
  91 #define wxSafeDecRef(p) if ( p ) (p)->DecRef()
  92
  93 // ----------------------------------------------------------------------------
  94 // wxGridCellWorker: common base class for wxGridCellRenderer and
  95 // wxGridCellEditor
  96 //
  97 // NB: this is more an implementation convenience than a design issue, so this
  98 //     class is not documented and is not public at all
  99 // ----------------------------------------------------------------------------
 100
 101 class WXDLLEXPORT wxGridCellWorker
 102 {
 103 public:
 104     wxGridCellWorker() { m_nRef = 1; }
 105
 106     // this class is ref counted: it is created with ref count of 1, so
 107     // calling DecRef() once will delete it. Calling IncRef() allows to lock
 108     // it until the matching DecRef() is called
 109     void IncRef() { m_nRef++; }
 110     void DecRef() { if ( !--m_nRef ) delete this; }
 111
 112     // interpret renderer parameters: arbitrary string whose interpretatin is
 113     // left to the derived classes
 114     virtual void SetParameters(const wxString& params);
 115
 116 protected:
 117     // virtual dtor for any base class - private because only DecRef() can
 118     // delete us
 119     virtual ~wxGridCellWorker();
 120
 121 private:
 122     size_t m_nRef;
 123
 124     // suppress the stupid gcc warning about the class having private dtor and
 125     // no friends
 126     friend class wxGridCellWorkerDummyFriend;
 127 };
 128
 129 // ----------------------------------------------------------------------------
 130 // wxGridCellRenderer: this class is responsible for actually drawing the cell
 131 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
 132 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
 133 // view of all cells. This is an ABC, you will normally use one of the
 134 // predefined derived classes or derive your own class from it.
 135 // ----------------------------------------------------------------------------
 136
 137 class WXDLLEXPORT wxGridCellRenderer : public wxGridCellWorker
 138 {
 139 public:
 140     // draw the given cell on the provided DC inside the given rectangle
 141     // using the style specified by the attribute and the default or selected
 142     // state corresponding to the isSelected value.
 143     //
 144     // this pure virtual function has a default implementation which will
 145     // prepare the DC using the given attribute: it will draw the rectangle
 146     // with the bg colour from attr and set the text colour and font
 147     virtual void Draw(wxGrid& grid,
 148                       wxGridCellAttr& attr,
 149                       wxDC& dc,
 150                       const wxRect& rect,
 151                       int row, int col,
 152                       bool isSelected) = 0;
 153
 154     // get the preferred size of the cell for its contents
 155     virtual wxSize GetBestSize(wxGrid& grid,
 156                                wxGridCellAttr& attr,
 157                                wxDC& dc,
 158                                int row, int col) = 0;
 159
 160     // create a new object which is the copy of this one
 161     virtual wxGridCellRenderer *Clone() const = 0;
 162 };
 163
 164 // the default renderer for the cells containing string data
 165 class WXDLLEXPORT wxGridCellStringRenderer : public wxGridCellRenderer
 166 {
 167 public:
 168     // draw the string
 169     virtual void Draw(wxGrid& grid,
 170                       wxGridCellAttr& attr,
 171                       wxDC& dc,
 172                       const wxRect& rect,
 173                       int row, int col,
 174                       bool isSelected);
 175
 176     // return the string extent
 177     virtual wxSize GetBestSize(wxGrid& grid,
 178                                wxGridCellAttr& attr,
 179                                wxDC& dc,
 180                                int row, int col);
 181
 182     virtual wxGridCellRenderer *Clone() const
 183         { return new wxGridCellStringRenderer; }
 184
 185 protected:
 186     // set the text colours before drawing
 187     void SetTextColoursAndFont(wxGrid& grid,
 188                                wxGridCellAttr& attr,
 189                                wxDC& dc,
 190                                bool isSelected);
 191
 192     // calc the string extent for given string/font
 193     wxSize DoGetBestSize(wxGridCellAttr& attr,
 194                          wxDC& dc,
 195                          const wxString& text);
 196 };
 197
 198 // the default renderer for the cells containing numeric (long) data
 199 class WXDLLEXPORT wxGridCellNumberRenderer : public wxGridCellStringRenderer
 200 {
 201 public:
 202     // draw the string right aligned
 203     virtual void Draw(wxGrid& grid,
 204                       wxGridCellAttr& attr,
 205                       wxDC& dc,
 206                       const wxRect& rect,
 207                       int row, int col,
 208                       bool isSelected);
 209
 210     virtual wxSize GetBestSize(wxGrid& grid,
 211                                wxGridCellAttr& attr,
 212                                wxDC& dc,
 213                                int row, int col);
 214
 215     virtual wxGridCellRenderer *Clone() const
 216         { return new wxGridCellNumberRenderer; }
 217
 218 protected:
 219     wxString GetString(wxGrid& grid, int row, int col);
 220 };
 221
 222 class WXDLLEXPORT wxGridCellFloatRenderer : public wxGridCellStringRenderer
 223 {
 224 public:
 225     wxGridCellFloatRenderer(int width = -1, int precision = -1);
 226
 227     // get/change formatting parameters
 228     int GetWidth() const { return m_width; }
 229     void SetWidth(int width) { m_width = width; m_format.clear(); }
 230     int GetPrecision() const { return m_precision; }
 231     void SetPrecision(int precision) { m_precision = precision; m_format.clear(); }
 232
 233     // draw the string right aligned with given width/precision
 234     virtual void Draw(wxGrid& grid,
 235                       wxGridCellAttr& attr,
 236                       wxDC& dc,
 237                       const wxRect& rect,
 238                       int row, int col,
 239                       bool isSelected);
 240
 241     virtual wxSize GetBestSize(wxGrid& grid,
 242                                wxGridCellAttr& attr,
 243                                wxDC& dc,
 244                                int row, int col);
 245
 246     // parameters string format is "width[,precision]"
 247     virtual void SetParameters(const wxString& params);
 248
 249     virtual wxGridCellRenderer *Clone() const;
 250
 251 protected:
 252     wxString GetString(wxGrid& grid, int row, int col);
 253
 254 private:
 255     // formatting parameters
 256     int m_width,
 257         m_precision;
 258
 259     wxString m_format;
 260 };
 261
 262 // renderer for boolean fields
 263 class WXDLLEXPORT wxGridCellBoolRenderer : public wxGridCellRenderer
 264 {
 265 public:
 266     // draw a check mark or nothing
 267     virtual void Draw(wxGrid& grid,
 268                       wxGridCellAttr& attr,
 269                       wxDC& dc,
 270                       const wxRect& rect,
 271                       int row, int col,
 272                       bool isSelected);
 273
 274     // return the checkmark size
 275     virtual wxSize GetBestSize(wxGrid& grid,
 276                                wxGridCellAttr& attr,
 277                                wxDC& dc,
 278                                int row, int col);
 279
 280     virtual wxGridCellRenderer *Clone() const
 281         { return new wxGridCellBoolRenderer; }
 282
 283 private:
 284     static wxSize ms_sizeCheckMark;
 285 };
 286
 287 // ----------------------------------------------------------------------------
 288 // wxGridCellEditor:  This class is responsible for providing and manipulating
 289 // the in-place edit controls for the grid.  Instances of wxGridCellEditor
 290 // (actually, instances of derived classes since it is an ABC) can be
 291 // associated with the cell attributes for individual cells, rows, columns, or
 292 // even for the entire grid.
 293 // ----------------------------------------------------------------------------
 294
 295 class WXDLLEXPORT wxGridCellEditor : public wxGridCellWorker
 296 {
 297 public:
 298     wxGridCellEditor();
 299
 300     bool IsCreated() { return m_control != NULL; }
 301     wxControl* GetControl() { return m_control; }
 302     void SetControl(wxControl* control) { m_control = control; }
 303
 304     // Creates the actual edit control
 305     virtual void Create(wxWindow* parent,
 306                         wxWindowID id,
 307                         wxEvtHandler* evtHandler) = 0;
 308
 309     // Size and position the edit control
 310     virtual void SetSize(const wxRect& rect);
 311
 312     // Show or hide the edit control, use the specified attributes to set
 313     // colours/fonts for it
 314     virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL);
 315
 316     // Draws the part of the cell not occupied by the control: the base class
 317     // version just fills it with background colour from the attribute
 318     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 319
 320     // Fetch the value from the table and prepare the edit control
 321     // to begin editing.  Set the focus to the edit control.
 322     virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
 323
 324     // Complete the editing of the current cell. Returns true if the value has
 325     // changed.  If necessary, the control may be destroyed.
 326     virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
 327
 328     // Reset the value in the control back to its starting value
 329     virtual void Reset() = 0;
 330
 331     // return TRUE to allow the given key to start editing: the base class
 332     // version only checks that the event has no modifiers. The derived
 333     // classes are supposed to do "if ( base::IsAcceptedKey() && ... )" in
 334     // their IsAcceptedKey() implementation, although, of course, it is not a
 335     // mandatory requirment.
 336     //
 337     // NB: if the key is F2 (special), editing will always start and this
 338     //     method will not be called at all (but StartingKey() will)
 339     virtual bool IsAcceptedKey(wxKeyEvent& event);
 340
 341     // If the editor is enabled by pressing keys on the grid, this will be
 342     // called to let the editor do something about that first key if desired
 343     virtual void StartingKey(wxKeyEvent& event);
 344
 345     // if the editor is enabled by clicking on the cell, this method will be
 346     // called
 347     virtual void StartingClick();
 348
 349     // Some types of controls on some platforms may need some help
 350     // with the Return key.
 351     virtual void HandleReturn(wxKeyEvent& event);
 352
 353     // Final cleanup
 354     virtual void Destroy();
 355
 356     // create a new object which is the copy of this one
 357     virtual wxGridCellEditor *Clone() const = 0;
 358
 359 protected:
 360     // the dtor is private because only DecRef() can delete us
 361     virtual ~wxGridCellEditor();
 362
 363     // the control we show on screen
 364     wxControl*  m_control;
 365
 366     // if we change the colours/font of the control from the default ones, we
 367     // must restore the default later and we save them here between calls to
 368     // Show(TRUE) and Show(FALSE)
 369     wxColour m_colFgOld,
 370              m_colBgOld;
 371     wxFont m_fontOld;
 372
 373     // suppress the stupid gcc warning about the class having private dtor and
 374     // no friends
 375     friend class wxGridCellEditorDummyFriend;
 376 };
 377
 378 // the editor for string/text data
 379 class WXDLLEXPORT wxGridCellTextEditor : public wxGridCellEditor
 380 {
 381 public:
 382     wxGridCellTextEditor();
 383
 384     virtual void Create(wxWindow* parent,
 385                         wxWindowID id,
 386                         wxEvtHandler* evtHandler);
 387     virtual void SetSize(const wxRect& rect);
 388
 389     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 390
 391     virtual bool IsAcceptedKey(wxKeyEvent& event);
 392     virtual void BeginEdit(int row, int col, wxGrid* grid);
 393     virtual bool EndEdit(int row, int col, wxGrid* grid);
 394
 395     virtual void Reset();
 396     virtual void StartingKey(wxKeyEvent& event);
 397     virtual void HandleReturn(wxKeyEvent& event);
 398
 399     // parameters string format is "max_width"
 400     virtual void SetParameters(const wxString& params);
 401
 402     virtual wxGridCellEditor *Clone() const
 403         { return new wxGridCellTextEditor; }
 404
 405 protected:
 406     wxTextCtrl *Text() const { return (wxTextCtrl *)m_control; }
 407
 408     // parts of our virtual functions reused by the derived classes
 409     void DoBeginEdit(const wxString& startValue);
 410     void DoReset(const wxString& startValue);
 411
 412 private:
 413     size_t   m_maxChars;        // max number of chars allowed
 414     wxString m_startValue;
 415 };
 416
 417 // the editor for numeric (long) data
 418 class WXDLLEXPORT wxGridCellNumberEditor : public wxGridCellTextEditor
 419 {
 420 public:
 421     // allows to specify the range - if min == max == -1, no range checking is
 422     // done
 423     wxGridCellNumberEditor(int min = -1, int max = -1);
 424
 425     virtual void Create(wxWindow* parent,
 426                         wxWindowID id,
 427                         wxEvtHandler* evtHandler);
 428
 429     virtual bool IsAcceptedKey(wxKeyEvent& event);
 430     virtual void BeginEdit(int row, int col, wxGrid* grid);
 431     virtual bool EndEdit(int row, int col, wxGrid* grid);
 432
 433     virtual void Reset();
 434     virtual void StartingKey(wxKeyEvent& event);
 435
 436     // parameters string format is "min,max"
 437     virtual void SetParameters(const wxString& params);
 438
 439     virtual wxGridCellEditor *Clone() const
 440         { return new wxGridCellNumberEditor(m_min, m_max); }
 441
 442 protected:
 443     wxSpinCtrl *Spin() const { return (wxSpinCtrl *)m_control; }
 444
 445     // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl
 446     bool HasRange() const { return m_min != m_max; }
 447
 448     // string representation of m_valueOld
 449     wxString GetString() const
 450         { return wxString::Format(_T("%ld"), m_valueOld); }
 451
 452 private:
 453     int m_min,
 454         m_max;
 455
 456     long m_valueOld;
 457 };
 458
 459 // the editor for floating point numbers (double) data
 460 class WXDLLEXPORT wxGridCellFloatEditor : public wxGridCellTextEditor
 461 {
 462 public:
 463     wxGridCellFloatEditor(int width = -1, int precision = -1);
 464
 465     virtual void Create(wxWindow* parent,
 466                         wxWindowID id,
 467                         wxEvtHandler* evtHandler);
 468
 469     virtual bool IsAcceptedKey(wxKeyEvent& event);
 470     virtual void BeginEdit(int row, int col, wxGrid* grid);
 471     virtual bool EndEdit(int row, int col, wxGrid* grid);
 472
 473     virtual void Reset();
 474     virtual void StartingKey(wxKeyEvent& event);
 475
 476     virtual wxGridCellEditor *Clone() const
 477         { return new wxGridCellFloatEditor; }
 478
 479     // parameters string format is "width,precision"
 480     virtual void SetParameters(const wxString& params);
 481
 482 protected:
 483     // string representation of m_valueOld
 484     wxString GetString() const;
 485
 486 private:
 487     int m_width,
 488         m_precision;
 489     double m_valueOld;
 490 };
 491
 492 // the editor for boolean data
 493 class WXDLLEXPORT wxGridCellBoolEditor : public wxGridCellEditor
 494 {
 495 public:
 496     virtual void Create(wxWindow* parent,
 497                         wxWindowID id,
 498                         wxEvtHandler* evtHandler);
 499
 500     virtual void SetSize(const wxRect& rect);
 501     virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL);
 502
 503     virtual bool IsAcceptedKey(wxKeyEvent& event);
 504     virtual void BeginEdit(int row, int col, wxGrid* grid);
 505     virtual bool EndEdit(int row, int col, wxGrid* grid);
 506
 507     virtual void Reset();
 508     virtual void StartingClick();
 509
 510     virtual wxGridCellEditor *Clone() const
 511         { return new wxGridCellBoolEditor; }
 512
 513 protected:
 514     wxCheckBox *CBox() const { return (wxCheckBox *)m_control; }
 515
 516 private:
 517     bool m_startValue;
 518 };
 519
 520 // the editor for string data allowing to choose from the list of strings
 521 class WXDLLEXPORT wxGridCellChoiceEditor : public wxGridCellEditor
 522 {
 523 public:
 524     // if !allowOthers, user can't type a string not in choices array
 525     wxGridCellChoiceEditor(size_t count = 0,
 526                            const wxString choices[] = NULL,
 527                            bool allowOthers = FALSE);
 528
 529     virtual void Create(wxWindow* parent,
 530                         wxWindowID id,
 531                         wxEvtHandler* evtHandler);
 532
 533     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 534
 535     virtual void BeginEdit(int row, int col, wxGrid* grid);
 536     virtual bool EndEdit(int row, int col, wxGrid* grid);
 537
 538     virtual void Reset();
 539
 540     // parameters string format is "item1[,item2[...,itemN]]"
 541     virtual void SetParameters(const wxString& params);
 542
 543     virtual wxGridCellEditor *Clone() const;
 544
 545 protected:
 546     wxComboBox *Combo() const { return (wxComboBox *)m_control; }
 547
 548 private:
 549     wxString        m_startValue;
 550     wxArrayString   m_choices;
 551     bool            m_allowOthers;
 552 };
 553
 554 // ----------------------------------------------------------------------------
 555 // wxGridCellAttr: this class can be used to alter the cells appearance in
 556 // the grid by changing their colour/font/... from default. An object of this
 557 // class may be returned by wxGridTable::GetAttr().
 558 // ----------------------------------------------------------------------------
 559
 560 class WXDLLEXPORT wxGridCellAttr
 561 {
 562 public:
 563     // ctors
 564     wxGridCellAttr()
 565     {
 566         Init();
 567         // MB: args used to be 0,0 here but wxALIGN_LEFT is 0
 568         SetAlignment(-1, -1);
 569     }
 570
 571     // VZ: considering the number of members wxGridCellAttr has now, this ctor
 572     //     seems to be pretty useless... may be we should just remove it?
 573     wxGridCellAttr(const wxColour& colText,
 574                    const wxColour& colBack,
 575                    const wxFont& font,
 576                    int hAlign,
 577                    int vAlign)
 578         : m_colText(colText), m_colBack(colBack), m_font(font)
 579     {
 580         Init();
 581         SetAlignment(hAlign, vAlign);
 582     }
 583
 584     // creates a new copy of this object
 585     wxGridCellAttr *Clone() const;
 586
 587     // this class is ref counted: it is created with ref count of 1, so
 588     // calling DecRef() once will delete it. Calling IncRef() allows to lock
 589     // it until the matching DecRef() is called
 590     void IncRef() { m_nRef++; }
 591     void DecRef() { if ( !--m_nRef ) delete this; }
 592
 593     // setters
 594     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 595     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 596     void SetFont(const wxFont& font) { m_font = font; }
 597     void SetAlignment(int hAlign, int vAlign)
 598     {
 599         m_hAlign = hAlign;
 600         m_vAlign = vAlign;
 601     }
 602     void SetReadOnly(bool isReadOnly = TRUE) { m_isReadOnly = isReadOnly; }
 603
 604     // takes ownership of the pointer
 605     void SetRenderer(wxGridCellRenderer *renderer)
 606         { wxSafeDecRef(m_renderer); m_renderer = renderer; }
 607     void SetEditor(wxGridCellEditor* editor)
 608         { wxSafeDecRef(m_editor); m_editor = editor; }
 609
 610     // accessors
 611     bool HasTextColour() const { return m_colText.Ok(); }
 612     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 613     bool HasFont() const { return m_font.Ok(); }
 614     bool HasAlignment() const { return (m_hAlign != -1 || m_vAlign != -1); }
 615     bool HasRenderer() const { return m_renderer != NULL; }
 616     bool HasEditor() const { return m_editor != NULL; }
 617
 618     const wxColour& GetTextColour() const;
 619     const wxColour& GetBackgroundColour() const;
 620     const wxFont& GetFont() const;
 621     void GetAlignment(int *hAlign, int *vAlign) const;
 622     wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const;
 623     wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const;
 624
 625     bool IsReadOnly() const { return m_isReadOnly; }
 626
 627     void SetDefAttr(wxGridCellAttr* defAttr) { m_defGridAttr = defAttr; }
 628
 629 private:
 630     // the common part of all ctors
 631     void Init()
 632     {
 633         m_nRef = 1;
 634
 635         m_isReadOnly = FALSE;
 636
 637         m_renderer = NULL;
 638         m_editor = NULL;
 639     }
 640
 641     // the dtor is private because only DecRef() can delete us
 642     ~wxGridCellAttr()
 643     {
 644         wxSafeDecRef(m_renderer);
 645         wxSafeDecRef(m_editor);
 646     }
 647
 648     // the ref count - when it goes to 0, we die
 649     size_t   m_nRef;
 650
 651     wxColour m_colText,
 652              m_colBack;
 653     wxFont   m_font;
 654     int      m_hAlign,
 655              m_vAlign;
 656
 657     wxGridCellRenderer* m_renderer;
 658     wxGridCellEditor*   m_editor;
 659     wxGridCellAttr*     m_defGridAttr;
 660
 661     bool m_isReadOnly;
 662
 663     // use Clone() instead
 664     DECLARE_NO_COPY_CLASS(wxGridCellAttr);
 665
 666     // suppress the stupid gcc warning about the class having private dtor and
 667     // no friends
 668     friend class wxGridCellAttrDummyFriend;
 669 };
 670
 671 // ----------------------------------------------------------------------------
 672 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
 673 // cell attributes.
 674 // ----------------------------------------------------------------------------
 675
 676 // implementation note: we separate it from wxGridTableBase because we wish to
 677 // avoid deriving a new table class if possible, and sometimes it will be
 678 // enough to just derive another wxGridCellAttrProvider instead
 679 //
 680 // the default implementation is reasonably efficient for the generic case,
 681 // but you might still wish to implement your own for some specific situations
 682 // if you have performance problems with the stock one
 683 class WXDLLEXPORT wxGridCellAttrProvider
 684 {
 685 public:
 686     wxGridCellAttrProvider();
 687     virtual ~wxGridCellAttrProvider();
 688
 689     // DecRef() must be called on the returned pointer
 690     virtual wxGridCellAttr *GetAttr(int row, int col) const;
 691
 692     // all these functions take ownership of the pointer, don't call DecRef()
 693     // on it
 694     virtual void SetAttr(wxGridCellAttr *attr, int row, int col);
 695     virtual void SetRowAttr(wxGridCellAttr *attr, int row);
 696     virtual void SetColAttr(wxGridCellAttr *attr, int col);
 697
 698     // these functions must be called whenever some rows/cols are deleted
 699     // because the internal data must be updated then
 700     void UpdateAttrRows( size_t pos, int numRows );
 701     void UpdateAttrCols( size_t pos, int numCols );
 702
 703 private:
 704     void InitData();
 705
 706     wxGridCellAttrProviderData *m_data;
 707 };
 708
 709 //////////////////////////////////////////////////////////////////////
 710 //
 711 //  Grid table classes
 712 //
 713 //////////////////////////////////////////////////////////////////////
 714
 715
 716 class WXDLLEXPORT wxGridTableBase : public wxObject
 717 {
 718 public:
 719     wxGridTableBase();
 720     virtual ~wxGridTableBase();
 721
 722     // You must override these functions in a derived table class
 723     //
 724     virtual int GetNumberRows() = 0;
 725     virtual int GetNumberCols() = 0;
 726     virtual bool IsEmptyCell( int row, int col ) = 0;
 727     virtual wxString GetValue( int row, int col ) = 0;
 728     virtual void SetValue( int row, int col, const wxString& value ) = 0;
 729
 730     // Data type determination and value access
 731     virtual wxString GetTypeName( int row, int col );
 732     virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
 733     virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
 734
 735     virtual long GetValueAsLong( int row, int col );
 736     virtual double GetValueAsDouble( int row, int col );
 737     virtual bool GetValueAsBool( int row, int col );
 738
 739     virtual void SetValueAsLong( int row, int col, long value );
 740     virtual void SetValueAsDouble( int row, int col, double value );
 741     virtual void SetValueAsBool( int row, int col, bool value );
 742
 743     // For user defined types
 744     virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
 745     virtual void  SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
 746
 747
 748     // Overriding these is optional
 749     //
 750     virtual void SetView( wxGrid *grid ) { m_view = grid; }
 751     virtual wxGrid * GetView() const { return m_view; }
 752
 753     virtual void Clear() {}
 754     virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
 755     virtual bool AppendRows( size_t numRows = 1 );
 756     virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
 757     virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
 758     virtual bool AppendCols( size_t numCols = 1 );
 759     virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
 760
 761     virtual wxString GetRowLabelValue( int row );
 762     virtual wxString GetColLabelValue( int col );
 763     virtual void SetRowLabelValue( int WXUNUSED(row), const wxString& ) {}
 764     virtual void SetColLabelValue( int WXUNUSED(col), const wxString& ) {}
 765
 766     // Attribute handling
 767     //
 768
 769     // give us the attr provider to use - we take ownership of the pointer
 770     void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
 771
 772     // get the currently used attr provider (may be NULL)
 773     wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; }
 774
 775     // Does this table allow attributes?  Default implementation creates
 776     // a wxGridCellAttrProvider if necessary.
 777     virtual bool CanHaveAttributes();
 778
 779     // by default forwarded to wxGridCellAttrProvider if any. May be
 780     // overridden to handle attributes directly in the table.
 781     virtual wxGridCellAttr *GetAttr( int row, int col );
 782
 783     // these functions take ownership of the pointer
 784     virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
 785     virtual void SetRowAttr(wxGridCellAttr *attr, int row);
 786     virtual void SetColAttr(wxGridCellAttr *attr, int col);
 787
 788 private:
 789     wxGrid * m_view;
 790     wxGridCellAttrProvider *m_attrProvider;
 791
 792     DECLARE_ABSTRACT_CLASS( wxGridTableBase );
 793 };
 794
 795
 796 // ----------------------------------------------------------------------------
 797 // wxGridTableMessage
 798 // ----------------------------------------------------------------------------
 799
 800 // IDs for messages sent from grid table to view
 801 //
 802 enum wxGridTableRequest
 803 {
 804     wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
 805     wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
 806     wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
 807     wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
 808     wxGRIDTABLE_NOTIFY_ROWS_DELETED,
 809     wxGRIDTABLE_NOTIFY_COLS_INSERTED,
 810     wxGRIDTABLE_NOTIFY_COLS_APPENDED,
 811     wxGRIDTABLE_NOTIFY_COLS_DELETED
 812 };
 813
 814 class WXDLLEXPORT wxGridTableMessage
 815 {
 816 public:
 817     wxGridTableMessage();
 818     wxGridTableMessage( wxGridTableBase *table, int id,
 819                         int comInt1 = -1,
 820                         int comInt2 = -1 );
 821
 822     void SetTableObject( wxGridTableBase *table ) { m_table = table; }
 823     wxGridTableBase * GetTableObject() const { return m_table; }
 824     void SetId( int id ) { m_id = id; }
 825     int  GetId() { return m_id; }
 826     void SetCommandInt( int comInt1 ) { m_comInt1 = comInt1; }
 827     int  GetCommandInt() { return m_comInt1; }
 828     void SetCommandInt2( int comInt2 ) { m_comInt2 = comInt2; }
 829     int  GetCommandInt2() { return m_comInt2; }
 830
 831 private:
 832     wxGridTableBase *m_table;
 833     int m_id;
 834     int m_comInt1;
 835     int m_comInt2;
 836 };
 837
 838
 839
 840 // ------ wxGridStringArray
 841 // A 2-dimensional array of strings for data values
 842 //
 843
 844 WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString, wxGridStringArray);
 845
 846
 847
 848 // ------ wxGridStringTable
 849 //
 850 // Simplest type of data table for a grid for small tables of strings
 851 // that are stored in memory
 852 //
 853
 854 class WXDLLEXPORT wxGridStringTable : public wxGridTableBase
 855 {
 856 public:
 857     wxGridStringTable();
 858     wxGridStringTable( int numRows, int numCols );
 859     ~wxGridStringTable();
 860
 861     // these are pure virtual in wxGridTableBase
 862     //
 863     int GetNumberRows();
 864     int GetNumberCols();
 865     wxString GetValue( int row, int col );
 866     void SetValue( int row, int col, const wxString& s );
 867     bool IsEmptyCell( int row, int col );
 868
 869     // overridden functions from wxGridTableBase
 870     //
 871     void Clear();
 872     bool InsertRows( size_t pos = 0, size_t numRows = 1 );
 873     bool AppendRows( size_t numRows = 1 );
 874     bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
 875     bool InsertCols( size_t pos = 0, size_t numCols = 1 );
 876     bool AppendCols( size_t numCols = 1 );
 877     bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
 878
 879     void SetRowLabelValue( int row, const wxString& );
 880     void SetColLabelValue( int col, const wxString& );
 881     wxString GetRowLabelValue( int row );
 882     wxString GetColLabelValue( int col );
 883
 884 private:
 885     wxGridStringArray m_data;
 886
 887     // These only get used if you set your own labels, otherwise the
 888     // GetRow/ColLabelValue functions return wxGridTableBase defaults
 889     //
 890     wxArrayString     m_rowLabels;
 891     wxArrayString     m_colLabels;
 892
 893     DECLARE_DYNAMIC_CLASS( wxGridStringTable )
 894 };
 895
 896
 897
 898 // ============================================================================
 899 //  Grid view classes
 900 // ============================================================================
 901
 902 // ----------------------------------------------------------------------------
 903 // wxGridCellCoords: location of a cell in the grid
 904 // ----------------------------------------------------------------------------
 905
 906 class WXDLLEXPORT wxGridCellCoords
 907 {
 908 public:
 909     wxGridCellCoords() { m_row = m_col = -1; }
 910     wxGridCellCoords( int r, int c ) { m_row = r; m_col = c; }
 911
 912     // default copy ctor is ok
 913
 914     int GetRow() const { return m_row; }
 915     void SetRow( int n ) { m_row = n; }
 916     int GetCol() const { return m_col; }
 917     void SetCol( int n ) { m_col = n; }
 918     void Set( int row, int col ) { m_row = row; m_col = col; }
 919
 920     wxGridCellCoords& operator=( const wxGridCellCoords& other )
 921     {
 922         if ( &other != this )
 923         {
 924             m_row=other.m_row;
 925             m_col=other.m_col;
 926         }
 927         return *this;
 928     }
 929
 930     bool operator==( const wxGridCellCoords& other ) const
 931     {
 932         return (m_row == other.m_row  &&  m_col == other.m_col);
 933     }
 934
 935     bool operator!=( const wxGridCellCoords& other ) const
 936     {
 937         return (m_row != other.m_row  ||  m_col != other.m_col);
 938     }
 939
 940     bool operator!() const
 941     {
 942         return (m_row == -1 && m_col == -1 );
 943     }
 944
 945 private:
 946     int m_row;
 947     int m_col;
 948 };
 949
 950
 951 // For comparisons...
 952 //
 953 extern WXDLLEXPORT wxGridCellCoords wxGridNoCellCoords;
 954 extern WXDLLEXPORT wxRect           wxGridNoCellRect;
 955
 956 // An array of cell coords...
 957 //
 958 WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords, wxGridCellCoordsArray);
 959
 960 // ----------------------------------------------------------------------------
 961 // wxGrid
 962 // ----------------------------------------------------------------------------
 963
 964 class WXDLLEXPORT wxGrid : public wxScrolledWindow
 965 {
 966 public:
 967     wxGrid()
 968         {
 969             Create();
 970         }
 971
 972     wxGrid( wxWindow *parent,
 973             wxWindowID id,
 974             const wxPoint& pos = wxDefaultPosition,
 975             const wxSize& size = wxDefaultSize,
 976             long style = wxWANTS_CHARS,
 977             const wxString& name = wxPanelNameStr );
 978
 979     ~wxGrid();
 980
 981     enum wxGridSelectionModes {wxGridSelectCells,
 982                                wxGridSelectRows,
 983                                wxGridSelectColumns};
 984
 985     bool CreateGrid( int numRows, int numCols,
 986                      wxGrid::wxGridSelectionModes selmode =
 987                      wxGrid::wxGridSelectCells );
 988
 989     void SetSelectionMode(wxGrid::wxGridSelectionModes selmode);
 990
 991     // ------ grid dimensions
 992     //
 993     int      GetNumberRows() { return  m_numRows; }
 994     int      GetNumberCols() { return  m_numCols; }
 995
 996
 997     // ------ display update functions
 998     //
 999     void CalcRowLabelsExposed( const wxRegion& reg );
1000
1001     void CalcColLabelsExposed( const wxRegion& reg );
1002     void CalcCellsExposed( const wxRegion& reg );
1003
1004
1005     // ------ event handlers
1006     //
1007     void ProcessRowLabelMouseEvent( wxMouseEvent& event );
1008     void ProcessColLabelMouseEvent( wxMouseEvent& event );
1009     void ProcessCornerLabelMouseEvent( wxMouseEvent& event );
1010     void ProcessGridCellMouseEvent( wxMouseEvent& event );
1011     bool ProcessTableMessage( wxGridTableMessage& );
1012
1013     void DoEndDragResizeRow();
1014     void DoEndDragResizeCol();
1015
1016     wxGridTableBase * GetTable() const { return m_table; }
1017     bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE,
1018                    wxGrid::wxGridSelectionModes selmode =
1019                    wxGrid::wxGridSelectCells );
1020
1021     void ClearGrid();
1022     bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
1023     bool AppendRows( int numRows = 1, bool updateLabels=TRUE );
1024     bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
1025     bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
1026     bool AppendCols( int numCols = 1, bool updateLabels=TRUE );
1027     bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
1028
1029     void DrawGridCellArea( wxDC& dc );
1030     void DrawGridSpace( wxDC& dc );
1031     void DrawCellBorder( wxDC& dc, const wxGridCellCoords& );
1032     void DrawAllGridLines( wxDC& dc, const wxRegion & reg );
1033     void DrawCell( wxDC& dc, const wxGridCellCoords& );
1034     void DrawHighlight(wxDC& dc);
1035
1036     // this function is called when the current cell highlight must be redrawn
1037     // and may be overridden by the user
1038     virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
1039
1040     void DrawRowLabels( wxDC& dc );
1041     void DrawRowLabel( wxDC& dc, int row );
1042
1043     void DrawColLabels( wxDC& dc );
1044     void DrawColLabel( wxDC& dc, int col );
1045
1046
1047     // ------ Cell text drawing functions
1048     //
1049     void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
1050                             int horizontalAlignment = wxALIGN_LEFT,
1051                             int verticalAlignment = wxALIGN_TOP );
1052
1053     // Split a string containing newline chararcters into an array of
1054     // strings and return the number of lines
1055     //
1056     void StringToLines( const wxString& value, wxArrayString& lines );
1057
1058     void GetTextBoxSize( wxDC& dc,
1059                          wxArrayString& lines,
1060                          long *width, long *height );
1061
1062
1063     // ------
1064     // Code that does a lot of grid modification can be enclosed
1065     // between BeginBatch() and EndBatch() calls to avoid screen
1066     // flicker
1067     //
1068     void     BeginBatch() { m_batchCount++; }
1069     void     EndBatch();
1070
1071     int      GetBatchCount() { return m_batchCount; }
1072
1073     // Use this, rather than wxWindow::Refresh(), to force an
1074     // immediate repainting of the grid. Has no effect if you are
1075     // already inside a BeginBatch / EndBatch block.
1076     //
1077     // This function is necessary because wxGrid has a minimal OnPaint()
1078     // handler to reduce screen flicker.
1079     //
1080     void     ForceRefresh();
1081
1082
1083     // ------ edit control functions
1084     //
1085     bool IsEditable() { return m_editable; }
1086     void EnableEditing( bool edit );
1087
1088     void EnableCellEditControl( bool enable = TRUE );
1089     void DisableCellEditControl() { EnableCellEditControl(FALSE); }
1090     bool CanEnableCellControl() const;
1091     bool IsCellEditControlEnabled() const;
1092     bool IsCellEditControlShown() const;
1093
1094     bool IsCurrentCellReadOnly() const;
1095
1096     void ShowCellEditControl();
1097     void HideCellEditControl();
1098     void SaveEditControlValue();
1099
1100
1101     // ------ grid location functions
1102     //  Note that all of these functions work with the logical coordinates of
1103     //  grid cells and labels so you will need to convert from device
1104     //  coordinates for mouse events etc.
1105     //
1106     void XYToCell( int x, int y, wxGridCellCoords& );
1107     int  YToRow( int y );
1108     int  XToCol( int x );
1109
1110     int  YToEdgeOfRow( int y );
1111     int  XToEdgeOfCol( int x );
1112
1113     wxRect CellToRect( int row, int col );
1114     wxRect CellToRect( const wxGridCellCoords& coords )
1115         { return CellToRect( coords.GetRow(), coords.GetCol() ); }
1116
1117     int  GetGridCursorRow() { return m_currentCellCoords.GetRow(); }
1118     int  GetGridCursorCol() { return m_currentCellCoords.GetCol(); }
1119
1120     // check to see if a cell is either wholly visible (the default arg) or
1121     // at least partially visible in the grid window
1122     //
1123     bool IsVisible( int row, int col, bool wholeCellVisible = TRUE );
1124     bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = TRUE )
1125         { return IsVisible( coords.GetRow(), coords.GetCol(), wholeCellVisible ); }
1126     void MakeCellVisible( int row, int col );
1127     void MakeCellVisible( const wxGridCellCoords& coords )
1128         { MakeCellVisible( coords.GetRow(), coords.GetCol() ); }
1129
1130
1131     // ------ grid cursor movement functions
1132     //
1133     void SetGridCursor( int row, int col )
1134         { SetCurrentCell( wxGridCellCoords(row, col) ); }
1135
1136     bool MoveCursorUp( bool expandSelection );
1137     bool MoveCursorDown( bool expandSelection );
1138     bool MoveCursorLeft( bool expandSelection );
1139     bool MoveCursorRight( bool expandSelection );
1140     bool MovePageDown();
1141     bool MovePageUp();
1142     bool MoveCursorUpBlock( bool expandSelection );
1143     bool MoveCursorDownBlock( bool expandSelection );
1144     bool MoveCursorLeftBlock( bool expandSelection );
1145     bool MoveCursorRightBlock( bool expandSelection );
1146
1147
1148     // ------ label and gridline formatting
1149     //
1150     int      GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH; }
1151     int      GetRowLabelSize() { return m_rowLabelWidth; }
1152     int      GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; }
1153     int      GetColLabelSize() { return m_colLabelHeight; }
1154     wxColour GetLabelBackgroundColour() { return m_labelBackgroundColour; }
1155     wxColour GetLabelTextColour() { return m_labelTextColour; }
1156     wxFont   GetLabelFont() { return m_labelFont; }
1157     void     GetRowLabelAlignment( int *horiz, int *vert );
1158     void     GetColLabelAlignment( int *horiz, int *vert );
1159     wxString GetRowLabelValue( int row );
1160     wxString GetColLabelValue( int col );
1161     wxColour GetGridLineColour() { return m_gridLineColour; }
1162     wxColour GetCellHighlightColour() { return m_cellHighlightColour; }
1163
1164     void     SetRowLabelSize( int width );
1165     void     SetColLabelSize( int height );
1166     void     SetLabelBackgroundColour( const wxColour& );
1167     void     SetLabelTextColour( const wxColour& );
1168     void     SetLabelFont( const wxFont& );
1169     void     SetRowLabelAlignment( int horiz, int vert );
1170     void     SetColLabelAlignment( int horiz, int vert );
1171     void     SetRowLabelValue( int row, const wxString& );
1172     void     SetColLabelValue( int col, const wxString& );
1173     void     SetGridLineColour( const wxColour& );
1174     void     SetCellHighlightColour( const wxColour& );
1175
1176     void     EnableDragRowSize( bool enable = TRUE );
1177     void     DisableDragRowSize() { EnableDragRowSize( FALSE ); }
1178     bool     CanDragRowSize() { return m_canDragRowSize; }
1179     void     EnableDragColSize( bool enable = TRUE );
1180     void     DisableDragColSize() { EnableDragColSize( FALSE ); }
1181     bool     CanDragColSize() { return m_canDragColSize; }
1182     void     EnableDragGridSize(bool enable = TRUE);
1183     void     DisableDragGridSize() { EnableDragGridSize(FALSE); }
1184     bool     CanDragGridSize() { return m_canDragGridSize; }
1185
1186     // this sets the specified attribute for all cells in this row/col
1187     void     SetRowAttr(int row, wxGridCellAttr *attr);
1188     void     SetColAttr(int col, wxGridCellAttr *attr);
1189
1190     // shortcuts for setting the column parameters
1191
1192     // set the format for the data in the column: default is string
1193     void     SetColFormatBool(int col);
1194     void     SetColFormatNumber(int col);
1195     void     SetColFormatFloat(int col, int width = -1, int precision = -1);
1196     void     SetColFormatCustom(int col, const wxString& typeName);
1197
1198     void     EnableGridLines( bool enable = TRUE );
1199     bool     GridLinesEnabled() { return m_gridLinesEnabled; }
1200
1201     // ------ row and col formatting
1202     //
1203     int      GetDefaultRowSize();
1204     int      GetRowSize( int row );
1205     int      GetDefaultColSize();
1206     int      GetColSize( int col );
1207     wxColour GetDefaultCellBackgroundColour();
1208     wxColour GetCellBackgroundColour( int row, int col );
1209     wxColour GetDefaultCellTextColour();
1210     wxColour GetCellTextColour( int row, int col );
1211     wxFont   GetDefaultCellFont();
1212     wxFont   GetCellFont( int row, int col );
1213     void     GetDefaultCellAlignment( int *horiz, int *vert );
1214     void     GetCellAlignment( int row, int col, int *horiz, int *vert );
1215
1216     void     SetDefaultRowSize( int height, bool resizeExistingRows = FALSE );
1217     void     SetRowSize( int row, int height );
1218     void     SetDefaultColSize( int width, bool resizeExistingCols = FALSE );
1219
1220     void     SetColSize( int col, int width );
1221
1222     // automatically size the column or row to fit to its contents, if
1223     // setAsMin is TRUE, this optimal width will also be set as minimal width
1224     // for this column
1225     void     AutoSizeColumn( int col, bool setAsMin = TRUE )
1226         { AutoSizeColOrRow(col, setAsMin, TRUE); }
1227     void     AutoSizeRow( int row, bool setAsMin = TRUE )
1228         { AutoSizeColOrRow(row, setAsMin, FALSE); }
1229
1230     // auto size all columns (very ineffective for big grids!)
1231     void     AutoSizeColumns( bool setAsMin = TRUE )
1232         { (void)SetOrCalcColumnSizes(FALSE, setAsMin); }
1233
1234     void     AutoSizeRows( bool setAsMin = TRUE )
1235         { (void)SetOrCalcRowSizes(FALSE, setAsMin); }
1236
1237     // auto size the grid, that is make the columns/rows of the "right" size
1238     // and also set the grid size to just fit its contents
1239     void     AutoSize();
1240
1241     // column won't be resized to be lesser width - this must be called during
1242     // the grid creation because it won't resize the column if it's already
1243     // narrower than the minimal width
1244     void     SetColMinimalWidth( int col, int width );
1245     void     SetRowMinimalHeight( int row, int width );
1246
1247     void     SetDefaultCellBackgroundColour( const wxColour& );
1248     void     SetCellBackgroundColour( int row, int col, const wxColour& );
1249     void     SetDefaultCellTextColour( const wxColour& );
1250
1251     void     SetCellTextColour( int row, int col, const wxColour& );
1252     void     SetDefaultCellFont( const wxFont& );
1253     void     SetCellFont( int row, int col, const wxFont& );
1254     void     SetDefaultCellAlignment( int horiz, int vert );
1255     void     SetCellAlignment( int row, int col, int horiz, int vert );
1256
1257     // takes ownership of the pointer
1258     void SetDefaultRenderer(wxGridCellRenderer *renderer);
1259     void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
1260     wxGridCellRenderer *GetDefaultRenderer() const;
1261     wxGridCellRenderer* GetCellRenderer(int row, int col);
1262
1263     // takes ownership of the pointer
1264     void SetDefaultEditor(wxGridCellEditor *editor);
1265     void SetCellEditor(int row, int col, wxGridCellEditor *editor);
1266     wxGridCellEditor *GetDefaultEditor() const;
1267     wxGridCellEditor* GetCellEditor(int row, int col);
1268
1269
1270
1271     // ------ cell value accessors
1272     //
1273     wxString GetCellValue( int row, int col )
1274     {
1275         if ( m_table )
1276         {
1277             return m_table->GetValue( row, col );
1278         }
1279         else
1280         {
1281             return wxEmptyString;
1282         }
1283     }
1284
1285     wxString GetCellValue( const wxGridCellCoords& coords )
1286         { return GetCellValue( coords.GetRow(), coords.GetCol() ); }
1287
1288     void SetCellValue( int row, int col, const wxString& s );
1289     void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
1290         { SetCellValue( coords.GetRow(), coords.GetCol(), s ); }
1291
1292     // returns TRUE if the cell can't be edited
1293     bool IsReadOnly(int row, int col) const;
1294
1295     // make the cell editable/readonly
1296     void SetReadOnly(int row, int col, bool isReadOnly = TRUE);
1297
1298     // ------ selections of blocks of cells
1299     //
1300     void SelectRow( int row, bool addToSelected = FALSE );
1301     void SelectCol( int col, bool addToSelected = FALSE );
1302
1303     void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
1304                       bool addToSelected = FALSE );
1305
1306     void SelectBlock( const wxGridCellCoords& topLeft,
1307                       const wxGridCellCoords& bottomRight,
1308                       bool addToSelected = FALSE )
1309         { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),
1310                        bottomRight.GetRow(), bottomRight.GetCol(),
1311                        addToSelected ); }
1312
1313     void SelectAll();
1314
1315     bool IsSelection();
1316
1317     void ClearSelection();
1318
1319     bool IsInSelection( int row, int col );
1320
1321     bool IsInSelection( const wxGridCellCoords& coords )
1322         { return IsInSelection( coords.GetRow(), coords.GetCol() ); }
1323
1324
1325     // This function returns the rectangle that encloses the block of cells
1326     // limited by TopLeft and BottomRight cell in device coords and clipped
1327     //  to the client size of the grid window.
1328     //
1329     wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
1330                               const wxGridCellCoords & bottomRight );
1331
1332     // Access or update the selection fore/back colours
1333     wxColour GetSelectionBackground() const
1334         { return m_selectionBackground; }
1335     wxColour GetSelectionForeground() const
1336         { return m_selectionForeground; }
1337
1338     void SetSelectionBackground(const wxColour& c) { m_selectionBackground = c; }
1339     void SetSelectionForeground(const wxColour& c) { m_selectionForeground = c; }
1340
1341
1342     // Methods for a registry for mapping data types to Renderers/Editors
1343     void RegisterDataType(const wxString& typeName,
1344                           wxGridCellRenderer* renderer,
1345                           wxGridCellEditor* editor);
1346     wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
1347     wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
1348         { return GetDefaultEditorForCell(c.GetRow(), c.GetCol()); }
1349     wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
1350     wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
1351     wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
1352
1353     // grid may occupy more space than needed for its rows/columns, this
1354     // function allows to set how big this extra space is
1355     void SetMargins(int extraWidth, int extraHeight)
1356     {
1357         m_extraWidth = extraWidth;
1358         m_extraHeight = extraHeight;
1359     }
1360
1361     // ------ For compatibility with previous wxGrid only...
1362     //
1363     //  ************************************************
1364     //  **  Don't use these in new code because they  **
1365     //  **  are liable to disappear in a future       **
1366     //  **  revision                                  **
1367     //  ************************************************
1368     //
1369
1370     wxGrid( wxWindow *parent,
1371             int x, int y, int w = -1, int h = -1,
1372             long style = wxWANTS_CHARS,
1373             const wxString& name = wxPanelNameStr )
1374         : wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h),
1375                             (style|wxWANTS_CHARS), name )
1376         {
1377             Create();
1378         }
1379
1380     void SetCellValue( const wxString& val, int row, int col )
1381         { SetCellValue( row, col, val ); }
1382
1383     void UpdateDimensions()
1384         { CalcDimensions(); }
1385
1386     int GetRows() { return GetNumberRows(); }
1387     int GetCols() { return GetNumberCols(); }
1388     int GetCursorRow() { return GetGridCursorRow(); }
1389     int GetCursorColumn() { return GetGridCursorCol(); }
1390
1391     int GetScrollPosX() { return 0; }
1392     int GetScrollPosY() { return 0; }
1393
1394     void SetScrollX( int WXUNUSED(x) ) { }
1395     void SetScrollY( int WXUNUSED(y) ) { }
1396
1397     void SetColumnWidth( int col, int width )
1398         { SetColSize( col, width ); }
1399
1400     int GetColumnWidth( int col )
1401         { return GetColSize( col ); }
1402
1403     void SetRowHeight( int row, int height )
1404         { SetRowSize( row, height ); }
1405
1406     // GetRowHeight() is below
1407
1408     int GetViewHeight() // returned num whole rows visible
1409         { return 0; }
1410
1411     int GetViewWidth() // returned num whole cols visible
1412         { return 0; }
1413
1414     void SetLabelSize( int orientation, int sz )
1415         {
1416             if ( orientation == wxHORIZONTAL )
1417                 SetColLabelSize( sz );
1418             else
1419                 SetRowLabelSize( sz );
1420         }
1421
1422     int GetLabelSize( int orientation )
1423         {
1424             if ( orientation == wxHORIZONTAL )
1425                 return GetColLabelSize();
1426             else
1427                 return GetRowLabelSize();
1428         }
1429
1430     void SetLabelAlignment( int orientation, int align )
1431         {
1432             if ( orientation == wxHORIZONTAL )
1433                 SetColLabelAlignment( align, -1 );
1434             else
1435                 SetRowLabelAlignment( align, -1 );
1436         }
1437
1438     int GetLabelAlignment( int orientation, int WXUNUSED(align) )
1439         {
1440             int h, v;
1441             if ( orientation == wxHORIZONTAL )
1442             {
1443                 GetColLabelAlignment( &h, &v );
1444                 return h;
1445             }
1446             else
1447             {
1448                 GetRowLabelAlignment( &h, &v );
1449                 return h;
1450             }
1451         }
1452
1453     void SetLabelValue( int orientation, const wxString& val, int pos )
1454         {
1455             if ( orientation == wxHORIZONTAL )
1456                 SetColLabelValue( pos, val );
1457             else
1458                 SetRowLabelValue( pos, val );
1459         }
1460
1461     wxString GetLabelValue( int orientation, int pos)
1462         {
1463             if ( orientation == wxHORIZONTAL )
1464                 return GetColLabelValue( pos );
1465             else
1466                 return GetRowLabelValue( pos );
1467         }
1468
1469     wxFont GetCellTextFont() const
1470         { return m_defaultCellAttr->GetFont(); }
1471
1472     wxFont GetCellTextFont(int WXUNUSED(row), int WXUNUSED(col)) const
1473         { return m_defaultCellAttr->GetFont(); }
1474
1475     void SetCellTextFont(const wxFont& fnt)
1476         { SetDefaultCellFont( fnt ); }
1477
1478     void SetCellTextFont(const wxFont& fnt, int row, int col)
1479         { SetCellFont( row, col, fnt ); }
1480
1481     void SetCellTextColour(const wxColour& val, int row, int col)
1482         { SetCellTextColour( row, col, val ); }
1483
1484     void SetCellTextColour(const wxColour& col)
1485         { SetDefaultCellTextColour( col ); }
1486
1487     void SetCellBackgroundColour(const wxColour& col)
1488         { SetDefaultCellBackgroundColour( col ); }
1489
1490     void SetCellBackgroundColour(const wxColour& colour, int row, int col)
1491         { SetCellBackgroundColour( row, col, colour ); }
1492
1493     bool GetEditable() { return IsEditable(); }
1494     void SetEditable( bool edit = TRUE ) { EnableEditing( edit ); }
1495     bool GetEditInPlace() { return IsCellEditControlEnabled(); }
1496
1497     void SetEditInPlace(bool WXUNUSED(edit) = TRUE) { }
1498
1499     void SetCellAlignment( int align, int row, int col)
1500     { SetCellAlignment(row, col, align, wxALIGN_CENTER); }
1501     void SetCellAlignment( int WXUNUSED(align) ) {}
1502     void SetCellBitmap(wxBitmap *WXUNUSED(bitmap), int WXUNUSED(row), int WXUNUSED(col))
1503     { }
1504     void SetDividerPen(const wxPen& WXUNUSED(pen)) { }
1505     wxPen& GetDividerPen() const;
1506     void OnActivate(bool WXUNUSED(active)) {}
1507
1508     // ******** End of compatibility functions **********
1509
1510
1511
1512     // ------ control IDs
1513     enum { wxGRID_CELLCTRL = 2000,
1514            wxGRID_TOPCTRL };
1515
1516     // ------ control types
1517     enum { wxGRID_TEXTCTRL = 2100,
1518            wxGRID_CHECKBOX,
1519            wxGRID_CHOICE,
1520            wxGRID_COMBOBOX };
1521
1522     // overridden wxWindow methods
1523     virtual void Fit();
1524
1525 protected:
1526     virtual wxSize DoGetBestSize() const;
1527
1528     bool m_created;
1529
1530     wxGridWindow             *m_gridWin;
1531     wxGridRowLabelWindow     *m_rowLabelWin;
1532     wxGridColLabelWindow     *m_colLabelWin;
1533     wxGridCornerLabelWindow  *m_cornerLabelWin;
1534
1535     wxGridTableBase          *m_table;
1536     bool                      m_ownTable;
1537
1538     int m_numRows;
1539     int m_numCols;
1540
1541     wxGridCellCoords m_currentCellCoords;
1542
1543     wxGridCellCoords m_selectingTopLeft;
1544     wxGridCellCoords m_selectingBottomRight;
1545     wxGridCellCoords m_selectingKeyboard;
1546     wxGridSelection  *m_selection;
1547     wxColour    m_selectionBackground;
1548     wxColour    m_selectionForeground;
1549
1550     // NB: *never* access m_row/col arrays directly because they are created
1551     //     on demand, *always* use accessor functions instead!
1552
1553     // init the m_rowHeights/Bottoms arrays with default values
1554     void InitRowHeights();
1555
1556     int        m_defaultRowHeight;
1557     wxArrayInt m_rowHeights;
1558     wxArrayInt m_rowBottoms;
1559
1560     // init the m_colWidths/Rights arrays
1561     void InitColWidths();
1562
1563     int        m_defaultColWidth;
1564     wxArrayInt m_colWidths;
1565     wxArrayInt m_colRights;
1566
1567     // get the col/row coords
1568     int GetColWidth(int col) const;
1569     int GetColLeft(int col) const;
1570     int GetColRight(int col) const;
1571
1572     // this function must be public for compatibility...
1573 public:
1574     int GetRowHeight(int row) const;
1575 protected:
1576
1577     int GetRowTop(int row) const;
1578     int GetRowBottom(int row) const;
1579
1580     int m_rowLabelWidth;
1581     int m_colLabelHeight;
1582
1583     // the size of the margin left to the right and bottom of the cell area
1584     int m_extraWidth,
1585         m_extraHeight;
1586
1587     wxColour   m_labelBackgroundColour;
1588     wxColour   m_labelTextColour;
1589     wxFont     m_labelFont;
1590
1591     int        m_rowLabelHorizAlign;
1592     int        m_rowLabelVertAlign;
1593     int        m_colLabelHorizAlign;
1594     int        m_colLabelVertAlign;
1595
1596     bool       m_defaultRowLabelValues;
1597     bool       m_defaultColLabelValues;
1598
1599     wxColour   m_gridLineColour;
1600     bool       m_gridLinesEnabled;
1601     wxColour   m_cellHighlightColour;
1602
1603     // common part of AutoSizeColumn/Row() and GetBestSize()
1604     int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = TRUE);
1605     int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = TRUE);
1606
1607     // common part of AutoSizeColumn/Row()
1608     void AutoSizeColOrRow(int n, bool setAsMin, bool column /* or row? */);
1609
1610     // if a column has a minimal width, it will be the value for it in this
1611     // hash table
1612     wxHashTableLong m_colMinWidths,
1613                     m_rowMinHeights;
1614
1615     // get the minimal width of the given column/row
1616     int GetColMinimalWidth(int col) const;
1617     int GetRowMinimalHeight(int col) const;
1618
1619     // do we have some place to store attributes in?
1620     bool CanHaveAttributes();
1621
1622     // returns the attribute we may modify in place: a new one if this cell
1623     // doesn't have any yet or the existing one if it does
1624     //
1625     // DecRef() must be called on the returned pointer, as usual
1626     wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
1627
1628     // cell attribute cache (currently we only cache 1, may be will do
1629     // more/better later)
1630     struct CachedAttr
1631     {
1632         int             row, col;
1633         wxGridCellAttr *attr;
1634     } m_attrCache;
1635
1636     // invalidates the attribute cache
1637     void ClearAttrCache();
1638
1639     // adds an attribute to cache
1640     void CacheAttr(int row, int col, wxGridCellAttr *attr) const;
1641
1642     // looks for an attr in cache, returns TRUE if found
1643     bool LookupAttr(int row, int col, wxGridCellAttr **attr) const;
1644
1645     // looks for the attr in cache, if not found asks the table and caches the
1646     // result
1647     wxGridCellAttr *GetCellAttr(int row, int col) const;
1648     wxGridCellAttr *GetCellAttr(const wxGridCellCoords& coords )
1649         { return GetCellAttr( coords.GetRow(), coords.GetCol() ); }
1650
1651     // the default cell attr object for cells that don't have their own
1652     wxGridCellAttr*     m_defaultCellAttr;
1653
1654
1655     wxGridCellCoordsArray  m_cellsExposed;
1656     wxArrayInt             m_rowsExposed;
1657     wxArrayInt             m_colsExposed;
1658     wxArrayInt             m_rowLabelsExposed;
1659     wxArrayInt             m_colLabelsExposed;
1660
1661     bool m_inOnKeyDown;
1662     int  m_batchCount;
1663
1664
1665     wxGridTypeRegistry*    m_typeRegistry;
1666
1667     enum CursorMode
1668     {
1669         WXGRID_CURSOR_SELECT_CELL,
1670         WXGRID_CURSOR_RESIZE_ROW,
1671         WXGRID_CURSOR_RESIZE_COL,
1672         WXGRID_CURSOR_SELECT_ROW,
1673         WXGRID_CURSOR_SELECT_COL
1674     };
1675
1676     // this method not only sets m_cursorMode but also sets the correct cursor
1677     // for the given mode and, if captureMouse is not FALSE releases the mouse
1678     // if it was captured and captures it if it must be captured
1679     //
1680     // for this to work, you should always use it and not set m_cursorMode
1681     // directly!
1682     void ChangeCursorMode(CursorMode mode,
1683                           wxWindow *win = (wxWindow *)NULL,
1684                           bool captureMouse = TRUE);
1685
1686     wxWindow *m_winCapture;     // the window which captured the mouse
1687     CursorMode m_cursorMode;
1688
1689     bool    m_canDragRowSize;
1690     bool    m_canDragColSize;
1691     bool    m_canDragGridSize;
1692     int     m_dragLastPos;
1693     int     m_dragRowOrCol;
1694     bool    m_isDragging;
1695     wxPoint m_startDragPos;
1696
1697     bool    m_waitForSlowClick;
1698
1699     wxGridCellCoords m_selectionStart;
1700
1701     wxCursor m_rowResizeCursor;
1702     wxCursor m_colResizeCursor;
1703
1704     bool       m_editable;              // applies to whole grid
1705     bool       m_cellEditCtrlEnabled;   // is in-place edit currently shown?
1706
1707
1708     void Create();
1709     void Init();
1710     void CalcDimensions();
1711     void CalcWindowSizes();
1712     bool Redimension( wxGridTableMessage& );
1713
1714
1715     bool SendEvent( const wxEventType, int row, int col, wxMouseEvent& );
1716     bool SendEvent( const wxEventType, int row, int col );
1717     bool SendEvent( const wxEventType type)
1718     {
1719         return SendEvent(type,
1720                          m_currentCellCoords.GetRow(),
1721                          m_currentCellCoords.GetCol());
1722     }
1723
1724     void OnPaint( wxPaintEvent& );
1725     void OnSize( wxSizeEvent& );
1726     void OnKeyDown( wxKeyEvent& );
1727     void OnKeyUp( wxKeyEvent& );
1728     void OnEraseBackground( wxEraseEvent& );
1729
1730
1731     void SetCurrentCell( const wxGridCellCoords& coords );
1732     void SetCurrentCell( int row, int col )
1733         { SetCurrentCell( wxGridCellCoords(row, col) ); }
1734
1735     void HighlightBlock( int topRow, int leftCol, int bottomRow, int rightCol );
1736
1737     void HighlightBlock( const wxGridCellCoords& topLeft,
1738                       const wxGridCellCoords& bottomRight )
1739         { HighlightBlock( topLeft.GetRow(), topLeft.GetCol(),
1740                        bottomRight.GetRow(), bottomRight.GetCol() ); }
1741
1742     // ------ functions to get/send data (see also public functions)
1743     //
1744     bool GetModelValues();
1745     bool SetModelValues();
1746
1747         friend class wxGridSelection;
1748
1749     DECLARE_DYNAMIC_CLASS( wxGrid )
1750     DECLARE_EVENT_TABLE()
1751 };
1752
1753 // ----------------------------------------------------------------------------
1754 // Grid event class and event types
1755 // ----------------------------------------------------------------------------
1756
1757 class WXDLLEXPORT wxGridEvent : public wxNotifyEvent
1758 {
1759 public:
1760     wxGridEvent()
1761         : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
1762         m_selecting(0), m_control(0), m_meta(0), m_shift(0), m_alt(0)
1763         {
1764         }
1765
1766     wxGridEvent(int id, wxEventType type, wxObject* obj,
1767                 int row=-1, int col=-1, int x=-1, int y=-1, bool sel = TRUE,
1768                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
1769
1770     virtual int GetRow() { return m_row; }
1771     virtual int GetCol() { return m_col; }
1772     wxPoint     GetPosition() { return wxPoint( m_x, m_y ); }
1773     bool        Selecting() { return m_selecting; }
1774     bool        ControlDown() { return m_control; }
1775     bool        MetaDown() { return m_meta; }
1776     bool        ShiftDown() { return m_shift; }
1777     bool        AltDown() { return m_alt; }
1778
1779 protected:
1780     int         m_row;
1781     int         m_col;
1782     int         m_x;
1783     int         m_y;
1784     bool        m_selecting;
1785     bool        m_control;
1786     bool        m_meta;
1787     bool        m_shift;
1788     bool        m_alt;
1789
1790     DECLARE_DYNAMIC_CLASS(wxGridEvent)
1791 };
1792
1793 class WXDLLEXPORT wxGridSizeEvent : public wxNotifyEvent
1794 {
1795 public:
1796     wxGridSizeEvent()
1797         : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
1798         m_control(0), m_meta(0), m_shift(0), m_alt(0)
1799         {
1800         }
1801
1802     wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
1803                 int rowOrCol=-1, int x=-1, int y=-1,
1804                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
1805
1806     int         GetRowOrCol() { return m_rowOrCol; }
1807     wxPoint     GetPosition() { return wxPoint( m_x, m_y ); }
1808     bool        ControlDown() { return m_control; }
1809     bool        MetaDown() { return m_meta; }
1810     bool        ShiftDown() { return m_shift; }
1811     bool        AltDown() { return m_alt; }
1812
1813 protected:
1814     int         m_rowOrCol;
1815     int         m_x;
1816     int         m_y;
1817     bool        m_control;
1818     bool        m_meta;
1819     bool        m_shift;
1820     bool        m_alt;
1821
1822     DECLARE_DYNAMIC_CLASS(wxGridSizeEvent)
1823 };
1824
1825
1826 class WXDLLEXPORT wxGridRangeSelectEvent : public wxNotifyEvent
1827 {
1828 public:
1829     wxGridRangeSelectEvent()
1830         : wxNotifyEvent()
1831         {
1832             m_topLeft     = wxGridNoCellCoords;
1833             m_bottomRight = wxGridNoCellCoords;
1834             m_selecting   = FALSE;
1835             m_control     = FALSE;
1836             m_meta        = FALSE;
1837             m_shift       = FALSE;
1838             m_alt         = FALSE;
1839         }
1840
1841     wxGridRangeSelectEvent(int id, wxEventType type, wxObject* obj,
1842                            const wxGridCellCoords& topLeft,
1843                            const wxGridCellCoords& bottomRight,
1844                            bool sel = TRUE,
1845                            bool control=FALSE, bool shift=FALSE,
1846                            bool alt=FALSE, bool meta=FALSE);
1847
1848     wxGridCellCoords GetTopLeftCoords() { return m_topLeft; }
1849     wxGridCellCoords GetBottomRightCoords() { return m_bottomRight; }
1850     int         GetTopRow()    { return m_topLeft.GetRow(); }
1851     int         GetBottomRow() { return m_bottomRight.GetRow(); }
1852     int         GetLeftCol()   { return m_topLeft.GetCol(); }
1853     int         GetRightCol()  { return m_bottomRight.GetCol(); }
1854     bool        Selecting() { return m_selecting; }
1855     bool        ControlDown()  { return m_control; }
1856     bool        MetaDown()     { return m_meta; }
1857     bool        ShiftDown()    { return m_shift; }
1858     bool        AltDown()      { return m_alt; }
1859
1860 protected:
1861     wxGridCellCoords  m_topLeft;
1862     wxGridCellCoords  m_bottomRight;
1863     bool              m_selecting;
1864     bool              m_control;
1865     bool              m_meta;
1866     bool              m_shift;
1867     bool              m_alt;
1868
1869     DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent)
1870 };
1871
1872 // TODO move to wx/event.h
1873 const wxEventType wxEVT_GRID_CELL_LEFT_CLICK    = wxEVT_FIRST + 1580;
1874 const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK   = wxEVT_FIRST + 1581;
1875 const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK   = wxEVT_FIRST + 1582;
1876 const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK  = wxEVT_FIRST + 1583;
1877 const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK   = wxEVT_FIRST + 1584;
1878 const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK  = wxEVT_FIRST + 1585;
1879 const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK  = wxEVT_FIRST + 1586;
1880 const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK = wxEVT_FIRST + 1587;
1881 const wxEventType wxEVT_GRID_ROW_SIZE           = wxEVT_FIRST + 1588;
1882 const wxEventType wxEVT_GRID_COL_SIZE           = wxEVT_FIRST + 1589;
1883 const wxEventType wxEVT_GRID_RANGE_SELECT       = wxEVT_FIRST + 1590;
1884 const wxEventType wxEVT_GRID_CELL_CHANGE        = wxEVT_FIRST + 1591;
1885 const wxEventType wxEVT_GRID_SELECT_CELL        = wxEVT_FIRST + 1592;
1886 const wxEventType wxEVT_GRID_EDITOR_SHOWN       = wxEVT_FIRST + 1593;
1887 const wxEventType wxEVT_GRID_EDITOR_HIDDEN      = wxEVT_FIRST + 1594;
1888
1889
1890 typedef void (wxEvtHandler::*wxGridEventFunction)(wxGridEvent&);
1891 typedef void (wxEvtHandler::*wxGridSizeEventFunction)(wxGridSizeEvent&);
1892 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction)(wxGridRangeSelectEvent&);
1893
1894 #define EVT_GRID_CELL_LEFT_CLICK(fn)     { wxEVT_GRID_CELL_LEFT_CLICK,    -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1895 #define EVT_GRID_CELL_RIGHT_CLICK(fn)    { wxEVT_GRID_CELL_RIGHT_CLICK,   -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1896 #define EVT_GRID_CELL_LEFT_DCLICK(fn)    { wxEVT_GRID_CELL_LEFT_DCLICK,   -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1897 #define EVT_GRID_CELL_RIGHT_DCLICK(fn)   { wxEVT_GRID_CELL_RIGHT_DCLICK,  -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1898 #define EVT_GRID_LABEL_LEFT_CLICK(fn)    { wxEVT_GRID_LABEL_LEFT_CLICK,   -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1899 #define EVT_GRID_LABEL_RIGHT_CLICK(fn)   { wxEVT_GRID_LABEL_RIGHT_CLICK,  -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1900 #define EVT_GRID_LABEL_LEFT_DCLICK(fn)   { wxEVT_GRID_LABEL_LEFT_DCLICK,  -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1901 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn)  { wxEVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1902 #define EVT_GRID_ROW_SIZE(fn)            { wxEVT_GRID_ROW_SIZE,           -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1903 #define EVT_GRID_COL_SIZE(fn)            { wxEVT_GRID_COL_SIZE,           -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1904 #define EVT_GRID_RANGE_SELECT(fn)        { wxEVT_GRID_RANGE_SELECT,       -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
1905 #define EVT_GRID_CELL_CHANGE(fn)         { wxEVT_GRID_CELL_CHANGE,        -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1906 #define EVT_GRID_SELECT_CELL(fn)         { wxEVT_GRID_SELECT_CELL,        -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1907 #define EVT_GRID_EDITOR_SHOWN(fn)        { wxEVT_GRID_EDITOR_SHOWN,       -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1908 #define EVT_GRID_EDITOR_HIDDEN(fn)       { wxEVT_GRID_EDITOR_HIDDEN,      -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1909
1910
1911 #if 0  // TODO: implement these ?  others ?
1912
1913 const wxEventType wxEVT_GRID_CREATE_CELL      = wxEVT_FIRST + 1576;
1914 const wxEventType wxEVT_GRID_CHANGE_LABELS    = wxEVT_FIRST + 1577;
1915 const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL = wxEVT_FIRST + 1578;
1916
1917 #define EVT_GRID_CREATE_CELL(fn)      { wxEVT_GRID_CREATE_CELL,      -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1918 #define EVT_GRID_CHANGE_LABELS(fn)    { wxEVT_GRID_CHANGE_LABELS,    -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1919 #define EVT_GRID_CHANGE_SEL_LABEL(fn) { wxEVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1920
1921 #endif
1922
1923 #endif  // #ifndef __WXGRID_H__
1924
1925 #endif  // ifndef wxUSE_NEW_GRID