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