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