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