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