include/wx/generic/grid.h

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