include/wx/generic/grid.h

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