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