include/wx/generic/grid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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
  13 #include "wx/defs.h"
  14
  15 #if !defined(wxUSE_NEW_GRID) || !(wxUSE_NEW_GRID)
  16 #include "gridg.h"
  17 #else
  18
  19 #ifndef __WXGRID_H__
  20 #define __WXGRID_H__
  21
  22 #ifdef __GNUG__
  23 #pragma interface "grid.h"
  24 #endif
  25
  26 #include "wx/panel.h"
  27 #include "wx/scrolwin.h"
  28 #include "wx/string.h"
  29 #include "wx/scrolbar.h"
  30 #include "wx/event.h"
  31 #include "wx/textctrl.h"
  32 #include "wx/combobox.h"
  33 #include "wx/dynarray.h"
  34
  35
  36 // Default parameters for wxGrid
  37 //
  38 #define WXGRID_DEFAULT_NUMBER_ROWS            10
  39 #define WXGRID_DEFAULT_NUMBER_COLS            10
  40 #ifdef __WXMSW__
  41 #define WXGRID_DEFAULT_ROW_HEIGHT             25
  42 #else
  43 #define WXGRID_DEFAULT_ROW_HEIGHT             30
  44 #endif  // __WXMSW__
  45 #define WXGRID_DEFAULT_COL_WIDTH              80
  46 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT       32
  47 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH        82
  48 #define WXGRID_LABEL_EDGE_ZONE                 5
  49 #define WXGRID_MIN_ROW_HEIGHT                 15
  50 #define WXGRID_MIN_COL_WIDTH                  15
  51 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH        16
  52
  53
  54 class WXDLLEXPORT wxGrid;
  55
  56
  57 //////////////////////////////////////////////////////////////////////
  58 //
  59 //  Grid table classes
  60 //
  61 //////////////////////////////////////////////////////////////////////
  62
  63
  64 class WXDLLEXPORT wxGridTableBase : public wxObject
  65 {
  66 public:
  67     wxGridTableBase();
  68     virtual ~wxGridTableBase();
  69
  70     // You must override these functions in a derived table class
  71     //
  72     virtual long GetNumberRows() = 0;
  73     virtual long GetNumberCols() = 0;
  74     virtual wxString GetValue( int row, int col ) = 0;
  75     virtual void SetValue( int row, int col, const wxString& s ) = 0;
  76     virtual bool IsEmptyCell( int row, int col ) = 0;
  77
  78     // Overriding these is optional
  79     //
  80     virtual void SetView( wxGrid *grid ) { m_view = grid; }
  81     virtual wxGrid * GetView() const { return m_view; }
  82
  83     virtual void Clear() {}
  84     virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
  85     virtual bool AppendRows( size_t numRows = 1 );
  86     virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
  87     virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
  88     virtual bool AppendCols( size_t numCols = 1 );
  89     virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
  90
  91     virtual wxString GetRowLabelValue( int row );
  92     virtual wxString GetColLabelValue( int col );
  93     virtual void SetRowLabelValue( int WXUNUSED(row), const wxString& ) {}
  94     virtual void SetColLabelValue( int WXUNUSED(col), const wxString& ) {}
  95
  96 private:
  97     wxGrid * m_view;
  98
  99     DECLARE_ABSTRACT_CLASS( wxGridTableBase );
 100 };
 101
 102
 103
 104 // IDs for messages sent from grid table to view
 105 //
 106 enum wxGridTableRequest
 107 {
 108     wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
 109     wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
 110     wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
 111     wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
 112     wxGRIDTABLE_NOTIFY_ROWS_DELETED,
 113     wxGRIDTABLE_NOTIFY_COLS_INSERTED,
 114     wxGRIDTABLE_NOTIFY_COLS_APPENDED,
 115     wxGRIDTABLE_NOTIFY_COLS_DELETED
 116 };
 117
 118 class WXDLLEXPORT wxGridTableMessage
 119 {
 120 public:
 121     wxGridTableMessage();
 122     wxGridTableMessage( wxGridTableBase *table, int id,
 123                         int comInt1 = -1,
 124                         int comInt2 = -1 );
 125
 126     void SetTableObject( wxGridTableBase *table ) { m_table = table; }
 127     wxGridTableBase * GetTableObject() const { return m_table; }
 128     void SetId( int id ) { m_id = id; }
 129     int  GetId() { return m_id; }
 130     void SetCommandInt( int comInt1 ) { m_comInt1 = comInt1; }
 131     int  GetCommandInt() { return m_comInt1; }
 132     void SetCommandInt2( int comInt2 ) { m_comInt2 = comInt2; }
 133     int  GetCommandInt2() { return m_comInt2; }
 134
 135 private:
 136     wxGridTableBase *m_table;
 137     int m_id;
 138     int m_comInt1;
 139     int m_comInt2;
 140 };
 141
 142
 143
 144 // ------ wxGridStringArray
 145 // A 2-dimensional array of strings for data values
 146 //
 147
 148 WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString, wxGridStringArray);
 149
 150
 151
 152 // ------ wxGridStringTable
 153 //
 154 // Simplest type of data table for a grid for small tables of strings
 155 // that are stored in memory
 156 //
 157
 158 class WXDLLEXPORT wxGridStringTable : public wxGridTableBase
 159 {
 160 public:
 161     wxGridStringTable();
 162     wxGridStringTable( int numRows, int numCols );
 163     ~wxGridStringTable();
 164
 165     // these are pure virtual in wxGridTableBase
 166     //
 167     long GetNumberRows();
 168     long GetNumberCols();
 169     wxString GetValue( int row, int col );
 170     void SetValue( int row, int col, const wxString& s );
 171     bool IsEmptyCell( int row, int col );
 172
 173     // overridden functions from wxGridTableBase
 174     //
 175     void Clear();
 176     bool InsertRows( size_t pos = 0, size_t numRows = 1 );
 177     bool AppendRows( size_t numRows = 1 );
 178     bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
 179     bool InsertCols( size_t pos = 0, size_t numCols = 1 );
 180     bool AppendCols( size_t numCols = 1 );
 181     bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
 182
 183     void SetRowLabelValue( int row, const wxString& );
 184     void SetColLabelValue( int col, const wxString& );
 185     wxString GetRowLabelValue( int row );
 186     wxString GetColLabelValue( int col );
 187
 188 private:
 189     wxGridStringArray m_data;
 190
 191     // These only get used if you set your own labels, otherwise the
 192     // GetRow/ColLabelValue functions return wxGridTableBase defaults
 193     //
 194     wxArrayString     m_rowLabels;
 195     wxArrayString     m_colLabels;
 196
 197     DECLARE_DYNAMIC_CLASS( wxGridStringTable )
 198 };
 199
 200
 201
 202 //////////////////////////////////////////////////////////////////////
 203 //
 204 //  Grid view classes
 205 //
 206 //////////////////////////////////////////////////////////////////////
 207
 208 class WXDLLEXPORT wxGridCellCoords
 209 {
 210 public:
 211     wxGridCellCoords() { m_row = m_col = -1; }
 212     wxGridCellCoords( int r, int c ) { m_row = r; m_col = c; }
 213
 214     // default copy ctor is ok
 215
 216     long GetRow() const { return m_row; }
 217     void SetRow( long n ) { m_row = n; }
 218     long GetCol() const { return m_col; }
 219     void SetCol( long n ) { m_col = n; }
 220     void Set( long row, long col ) { m_row = row; m_col = col; }
 221
 222     wxGridCellCoords& operator=( const wxGridCellCoords& other )
 223     {
 224         if ( &other != this )
 225         {
 226             m_row=other.m_row;
 227             m_col=other.m_col;
 228         }
 229         return *this;
 230     }
 231
 232     bool operator==( const wxGridCellCoords& other )
 233     {
 234         return (m_row == other.m_row  &&  m_col == other.m_col);
 235     }
 236
 237     bool operator!=( const wxGridCellCoords& other )
 238     {
 239         return (m_row != other.m_row  ||  m_col != other.m_col);
 240     }
 241
 242     bool operator!()
 243     {
 244         return (m_row == -1 && m_col == -1 );
 245     }
 246
 247 private:
 248     long m_row;
 249     long m_col;
 250 };
 251
 252
 253 // For comparisons...
 254 //
 255 extern wxGridCellCoords wxGridNoCellCoords;
 256 extern wxRect           wxGridNoCellRect;
 257
 258 // An array of cell coords...
 259 //
 260 WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords, wxGridCellCoordsArray);
 261
 262
 263
 264 // This set of classes is to provide for the use of different types of
 265 // cell edit controls in the grid while avoiding the wx class info
 266 // system in deference to wxPython
 267
 268 class WXDLLEXPORT wxGridTextCtrl : public wxTextCtrl
 269 {
 270 public:
 271     wxGridTextCtrl() {}
 272     wxGridTextCtrl( wxWindow *,
 273                     wxGrid *,
 274                     bool isCellControl,
 275                     wxWindowID id,
 276                     const wxString& value = wxEmptyString,
 277                     const wxPoint& pos = wxDefaultPosition,
 278                     const wxSize& size = wxDefaultSize,
 279                     long style = 0 );
 280
 281     void     SetStartValue( const wxString& );
 282     wxString GetStartValue() { return startValue; }
 283
 284 private:
 285     wxGrid *m_grid;
 286
 287     // TRUE for controls placed over cells,
 288     // FALSE for a control on a grid control panel
 289     bool m_isCellControl;
 290
 291     wxString startValue;
 292
 293     void OnKeyDown( wxKeyEvent& );
 294
 295     DECLARE_DYNAMIC_CLASS( wxGridTextCtrl )
 296     DECLARE_EVENT_TABLE()
 297 };
 298
 299
 300 class WXDLLEXPORT wxGridRowLabelWindow : public wxWindow
 301 {
 302 public:
 303     wxGridRowLabelWindow() { m_owner = (wxGrid *)NULL; }
 304     wxGridRowLabelWindow( wxGrid *parent, wxWindowID id,
 305                           const wxPoint &pos, const wxSize &size );
 306
 307 private:
 308     wxGrid   *m_owner;
 309
 310     void OnPaint( wxPaintEvent& event );
 311     void OnMouseEvent( wxMouseEvent& event );
 312     void OnKeyDown( wxKeyEvent& event );
 313
 314     DECLARE_DYNAMIC_CLASS(wxGridRowLabelWindow)
 315     DECLARE_EVENT_TABLE()
 316 };
 317
 318
 319 class WXDLLEXPORT wxGridColLabelWindow : public wxWindow
 320 {
 321 public:
 322     wxGridColLabelWindow() { m_owner = (wxGrid *)NULL; }
 323     wxGridColLabelWindow( wxGrid *parent, wxWindowID id,
 324                           const wxPoint &pos, const wxSize &size );
 325
 326 private:
 327     wxGrid   *m_owner;
 328
 329     void OnPaint( wxPaintEvent &event );
 330     void OnMouseEvent( wxMouseEvent& event );
 331     void OnKeyDown( wxKeyEvent& event );
 332
 333     DECLARE_DYNAMIC_CLASS(wxGridColLabelWindow)
 334     DECLARE_EVENT_TABLE()
 335 };
 336
 337
 338 class WXDLLEXPORT wxGridCornerLabelWindow : public wxWindow
 339 {
 340 public:
 341     wxGridCornerLabelWindow() { m_owner = (wxGrid *)NULL; }
 342     wxGridCornerLabelWindow( wxGrid *parent, wxWindowID id,
 343                              const wxPoint &pos, const wxSize &size );
 344
 345 private:
 346     wxGrid *m_owner;
 347
 348     void OnMouseEvent( wxMouseEvent& event );
 349     void OnKeyDown( wxKeyEvent& event );
 350
 351     DECLARE_DYNAMIC_CLASS(wxGridCornerLabelWindow)
 352     DECLARE_EVENT_TABLE()
 353 };
 354
 355
 356
 357 class WXDLLEXPORT wxGridWindow : public wxPanel
 358 {
 359 public:
 360     wxGridWindow()
 361     {
 362         m_owner = (wxGrid *)NULL;
 363         m_rowLabelWin = (wxGridRowLabelWindow *)NULL;
 364         m_colLabelWin = (wxGridColLabelWindow *)NULL;
 365     }
 366
 367     wxGridWindow( wxGrid *parent,
 368                   wxGridRowLabelWindow *rowLblWin,
 369                   wxGridColLabelWindow *colLblWin,
 370                   wxWindowID id, const wxPoint &pos, const wxSize &size );
 371     ~wxGridWindow();
 372
 373     void ScrollWindow( int dx, int dy, const wxRect *rect );
 374
 375 private:
 376     wxGrid                   *m_owner;
 377     wxGridRowLabelWindow     *m_rowLabelWin;
 378     wxGridColLabelWindow     *m_colLabelWin;
 379
 380     void OnPaint( wxPaintEvent &event );
 381     void OnMouseEvent( wxMouseEvent& event );
 382     void OnKeyDown( wxKeyEvent& );
 383
 384     DECLARE_DYNAMIC_CLASS(wxGridWindow)
 385     DECLARE_EVENT_TABLE()
 386 };
 387
 388
 389
 390 class WXDLLEXPORT wxGrid : public wxScrolledWindow
 391 {
 392 public:
 393     wxGrid()
 394         { Create(); }
 395
 396     wxGrid( wxWindow *parent,
 397             wxWindowID id,
 398             const wxPoint& pos = wxDefaultPosition,
 399             const wxSize& size = wxDefaultSize,
 400             long style = 0,
 401             const wxString& name = wxPanelNameStr );
 402
 403     ~wxGrid();
 404
 405     bool CreateGrid( int numRows, int numCols );
 406
 407
 408     // ------ grid dimensions
 409     //
 410     int      GetNumberRows() { return  m_numRows; }
 411     int      GetNumberCols() { return  m_numCols; }
 412
 413
 414     // ------ display update functions
 415     //
 416     void CalcRowLabelsExposed( wxRegion& reg );
 417     void CalcColLabelsExposed( wxRegion& reg );
 418     void CalcCellsExposed( wxRegion& reg );
 419
 420
 421     // ------ event handlers
 422     //
 423     void ProcessRowLabelMouseEvent( wxMouseEvent& event );
 424     void ProcessColLabelMouseEvent( wxMouseEvent& event );
 425     void ProcessCornerLabelMouseEvent( wxMouseEvent& event );
 426     void ProcessGridCellMouseEvent( wxMouseEvent& event );
 427     bool ProcessTableMessage( wxGridTableMessage& );
 428
 429
 430     wxGridTableBase * GetTable() const { return m_table; }
 431     void SetTable( wxGridTableBase *table ) { m_table = table; }
 432
 433     void ClearGrid();
 434     bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
 435     bool AppendRows( int numRows = 1, bool updateLabels=TRUE );
 436     bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
 437     bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
 438     bool AppendCols( int numCols = 1, bool updateLabels=TRUE );
 439     bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
 440
 441     void DrawGridCellArea( wxDC& dc );
 442     void DrawCellBorder( wxDC& dc, const wxGridCellCoords& );
 443     void DrawAllGridLines( wxDC& dc );  // TODO - delete this ?
 444     void DrawCell( wxDC& dc, const wxGridCellCoords& );
 445     void DrawCellBackground( wxDC& dc, const wxGridCellCoords& );
 446     void DrawCellValue( wxDC& dc, const wxGridCellCoords& );
 447
 448     void DrawRowLabels( wxDC& dc );
 449     void DrawRowLabel( wxDC& dc, int row );
 450     void DrawColLabels( wxDC& dc );
 451     void DrawColLabel( wxDC& dc, int col );
 452
 453
 454     // ------ Cell text drawing functions
 455     //
 456     void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
 457                             int horizontalAlignment = wxLEFT,
 458                             int verticalAlignment = wxTOP );
 459
 460     // Split a string containing newline chararcters into an array of
 461     // strings and return the number of lines
 462     //
 463     void StringToLines( const wxString& value, wxArrayString& lines );
 464
 465     void GetTextBoxSize( wxDC& dc,
 466                          wxArrayString& lines,
 467                          long *width, long *height );
 468
 469
 470     // ------
 471     // Code that does a lot of grid modification can be enclosed
 472     // between BeginBatch() and EndBatch() calls to avoid screen
 473     // flicker
 474     //
 475     void     BeginBatch() { m_batchCount++; }
 476     void     EndBatch() { if ( m_batchCount > 0 ) m_batchCount--; }
 477     int      GetBatchCount() { return m_batchCount; }
 478
 479
 480     // ------ edit control functions
 481     //
 482     bool IsEditable() { return m_editable; }
 483     void EnableEditing( bool edit );
 484
 485 #if 0  // at the moment the cell edit control is always active
 486     void     EnableCellEditControl( bool enable );
 487 #endif
 488
 489     bool     IsCellEditControlEnabled()
 490              { return (m_cellEditCtrl && m_cellEditCtrlEnabled); }
 491
 492     void ShowCellEditControl();
 493     void HideCellEditControl();
 494     void SetEditControlValue( const wxString& s = wxEmptyString );
 495     void SaveEditControlValue();
 496
 497
 498     // ------ grid location functions
 499     //  Note that all of these functions work with the logical coordinates of
 500     //  grid cells and labels so you will need to convert from device
 501     //  coordinates for mouse events etc.
 502     //
 503     void XYToCell( int x, int y, wxGridCellCoords& );
 504     int  YToRow( int y );
 505     int  XToCol( int x );
 506
 507     int  YToEdgeOfRow( int y );
 508     int  XToEdgeOfCol( int x );
 509
 510     wxRect CellToRect( int row, int col );
 511     wxRect CellToRect( const wxGridCellCoords& coords )
 512         { return CellToRect( coords.GetRow(), coords.GetCol() ); }
 513
 514     int  GetGridCursorRow() { return m_currentCellCoords.GetRow(); }
 515     int  GetGridCursorCol() { return m_currentCellCoords.GetCol(); }
 516
 517     // check to see if a cell is either wholly visible (the default arg) or
 518     // at least partially visible in the grid window
 519     //
 520     bool IsVisible( int row, int col, bool wholeCellVisible = TRUE );
 521     bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = TRUE )
 522         { return IsVisible( coords.GetRow(), coords.GetCol(), wholeCellVisible ); }
 523     void MakeCellVisible( int row, int col );
 524     void MakeCellVisible( const wxGridCellCoords& coords )
 525         { MakeCellVisible( coords.GetRow(), coords.GetCol() ); }
 526
 527
 528     // ------ grid cursor movement functions
 529     //
 530     void SetGridCursor( int row, int col )
 531         { SetCurrentCell( wxGridCellCoords(row, col) ); }
 532
 533     bool MoveCursorUp();
 534     bool MoveCursorDown();
 535     bool MoveCursorLeft();
 536     bool MoveCursorRight();
 537     bool MovePageDown();
 538     bool MovePageUp();
 539     bool MoveCursorUpBlock();
 540     bool MoveCursorDownBlock();
 541     bool MoveCursorLeftBlock();
 542     bool MoveCursorRightBlock();
 543
 544
 545     // ------ label and gridline formatting
 546     //
 547     int      GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH; }
 548     int      GetRowLabelSize() { return m_rowLabelWidth; }
 549     int      GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; }
 550     int      GetColLabelSize() { return m_colLabelHeight; }
 551     wxColour GetLabelBackgroundColour() { return m_labelBackgroundColour; }
 552     wxColour GetLabelTextColour() { return m_labelTextColour; }
 553     wxFont   GetLabelFont() { return m_labelFont; }
 554     void     GetRowLabelAlignment( int *horiz, int *vert );
 555     void     GetColLabelAlignment( int *horiz, int *vert );
 556     wxString GetRowLabelValue( int row );
 557     wxString GetColLabelValue( int col );
 558     wxColour GetGridLineColour() { return m_gridLineColour; }
 559
 560         void     SetRowLabelSize( int width );
 561     void     SetColLabelSize( int height );
 562     void     SetLabelBackgroundColour( const wxColour& );
 563     void     SetLabelTextColour( const wxColour& );
 564     void     SetLabelFont( const wxFont& );
 565     void     SetRowLabelAlignment( int horiz, int vert );
 566     void     SetColLabelAlignment( int horiz, int vert );
 567     void     SetRowLabelValue( int row, const wxString& );
 568     void     SetColLabelValue( int col, const wxString& );
 569     void     SetGridLineColour( const wxColour& );
 570
 571     void     EnableGridLines( bool enable = TRUE );
 572     bool     GridLinesEnabled() { return m_gridLinesEnabled; }
 573
 574
 575     // ------ row and col formatting
 576     //
 577     int      GetDefaultRowSize();
 578     int      GetRowSize( int row );
 579     int      GetDefaultColSize();
 580     int      GetColSize( int col );
 581     wxColour GetDefaultCellBackgroundColour();
 582     wxColour GetCellBackgroundColour( int row, int col );
 583     wxColour GetDefaultCellTextColour();
 584     wxColour GetCellTextColour( int row, int col );
 585     wxFont   GetDefaultCellFont();
 586     wxFont   GetCellFont( int row, int col );
 587     void     GetDefaultCellAlignment( int *horiz, int *vert );
 588     void     GetCellAlignment( int row, int col, int *horiz, int *vert );
 589
 590     void     SetDefaultRowSize( int height, bool resizeExistingRows = FALSE );
 591     void     SetRowSize( int row, int height );
 592     void     SetDefaultColSize( int width, bool resizeExistingCols = FALSE );
 593     void     SetColSize( int col, int width );
 594     void     SetDefaultCellBackgroundColour( const wxColour& );
 595     void     SetCellBackgroundColour( int row, int col, const wxColour& );
 596     void     SetDefaultCellTextColour( const wxColour& );
 597     void     SetCellTextColour( int row, int col, const wxColour& );
 598     void     SetDefaultCellFont( const wxFont& );
 599     void     SetCellFont( int row, int col, const wxFont& );
 600     void     SetDefaultCellAlignment( int horiz, int vert );
 601     void     SetCellAlignment( int row, int col, int horiz, int vert );
 602
 603
 604     // ------ cell value accessors
 605     //
 606     wxString GetCellValue( int row, int col )
 607     {
 608         if ( m_table )
 609         {
 610             return m_table->GetValue( row, col );
 611         }
 612         else
 613         {
 614             return wxEmptyString;
 615         }
 616     }
 617
 618     wxString GetCellValue( const wxGridCellCoords& coords )
 619         { return GetCellValue( coords.GetRow(), coords.GetCol() ); }
 620
 621     void SetCellValue( int row, int col, const wxString& s );
 622     void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
 623         { SetCellValue( coords.GetRow(), coords.GetCol(), s ); }
 624
 625
 626
 627     // ------ selections of blocks of cells
 628     //
 629     void SelectRow( int row, bool addToSelected = FALSE );
 630     void SelectCol( int col, bool addToSelected = FALSE );
 631
 632     void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol );
 633
 634     void SelectBlock( const wxGridCellCoords& topLeft,
 635                       const wxGridCellCoords& bottomRight )
 636         { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),
 637                        bottomRight.GetRow(), bottomRight.GetCol() ); }
 638
 639     void SelectAll();
 640
 641     bool IsSelection()
 642         { return ( m_selectedTopLeft != wxGridNoCellCoords &&
 643                    m_selectedBottomRight != wxGridNoCellCoords );
 644         }
 645
 646     void ClearSelection();
 647
 648     bool IsInSelection( int row, int col )
 649         { return ( IsSelection() &&
 650                    row >= m_selectedTopLeft.GetRow() &&
 651                    col >= m_selectedTopLeft.GetCol() &&
 652                    row <= m_selectedBottomRight.GetRow() &&
 653                    col <= m_selectedBottomRight.GetCol() );
 654         }
 655
 656     bool IsInSelection( const wxGridCellCoords& coords )
 657         { return IsInSelection( coords.GetRow(), coords.GetCol() ); }
 658
 659     void GetSelection( int* topRow, int* leftCol, int* bottomRow, int* rightCol )
 660         {
 661             // these will all be -1 if there is no selected block
 662             //
 663             *topRow    = m_selectedTopLeft.GetRow();
 664             *leftCol   = m_selectedTopLeft.GetCol();
 665             *bottomRow = m_selectedBottomRight.GetRow();
 666             *rightCol  = m_selectedBottomRight.GetCol();
 667         }
 668
 669     // This function returns the rectangle that encloses the selected cells
 670     // in device coords and clipped to the client size of the grid window.
 671     //
 672     wxRect SelectionToDeviceRect();
 673
 674
 675
 676     // ------ For compatibility with previous wxGrid only...
 677     //
 678     //  ************************************************
 679     //  **  Don't use these in new code because they  **
 680     //  **  are liable to disappear in a future       **
 681     //  **  revision                                  **
 682     //  ************************************************
 683     //
 684
 685     wxGrid( wxWindow *parent,
 686             int x = -1, int y = -1, int w = -1, int h = -1,
 687             long style = 0,
 688             const wxString& name = wxPanelNameStr )
 689         : wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h), style, name )
 690         {
 691             Create();
 692         }
 693
 694     void SetCellValue( const wxString& val, int row, int col )
 695         { SetCellValue( row, col, val ); }
 696
 697     void UpdateDimensions()
 698         { CalcDimensions(); }
 699
 700     int GetRows() { return GetNumberRows(); }
 701     int GetCols() { return GetNumberCols(); }
 702     int GetCursorRow() { return GetGridCursorRow(); }
 703     int GetCursorColumn() { return GetGridCursorCol(); }
 704
 705     int GetScrollPosX() { return 0; }
 706     int GetScrollPosY() { return 0; }
 707
 708     void SetScrollX( int x ) { }
 709     void SetScrollY( int y ) { }
 710
 711     void SetColumnWidth( int col, int width )
 712         { SetColSize( col, width ); }
 713
 714     int GetColumnWidth( int col )
 715         { return GetColSize( col ); }
 716
 717     void SetRowHeight( int row, int height )
 718         { SetRowSize( row, height ); }
 719
 720     int GetRowHeight( int row )
 721         { return GetRowSize( row ); }
 722
 723     int GetViewHeight() // returned num whole rows visible
 724         { return 0; }
 725
 726     int GetViewWidth() // returned num whole cols visible
 727         { return 0; }
 728
 729     void SetLabelSize( int orientation, int sz )
 730         {
 731             if ( orientation == wxHORIZONTAL )
 732                 SetColLabelSize( sz );
 733             else
 734                 SetRowLabelSize( sz );
 735         }
 736
 737     int GetLabelSize( int orientation )
 738         {
 739             if ( orientation == wxHORIZONTAL )
 740                 return GetColLabelSize();
 741             else
 742                 return GetRowLabelSize();
 743         }
 744
 745     void SetLabelAlignment( int orientation, int align )
 746         {
 747             if ( orientation == wxHORIZONTAL )
 748                 SetColLabelAlignment( align, -1 );
 749             else
 750                 SetRowLabelAlignment( align, -1 );
 751         }
 752
 753     int GetLabelAlignment( int orientation, int WXUNUSED(align) )
 754         {
 755             int h, v;
 756             if ( orientation == wxHORIZONTAL )
 757             {
 758                 GetColLabelAlignment( &h, &v );
 759                 return h;
 760             }
 761             else
 762             {
 763                 GetRowLabelAlignment( &h, &v );
 764                 return h;
 765             }
 766         }
 767
 768     void SetLabelValue( int orientation, const wxString& val, int pos )
 769         {
 770             if ( orientation == wxHORIZONTAL )
 771                 SetColLabelValue( pos, val );
 772             else
 773                 SetRowLabelValue( pos, val );
 774         }
 775
 776     wxString GetLabelValue( int orientation, int pos)
 777         {
 778             if ( orientation == wxHORIZONTAL )
 779                 return GetColLabelValue( pos );
 780             else
 781                 return GetRowLabelValue( pos );
 782         }
 783
 784     wxFont GetCellTextFont() const
 785         { return m_defaultCellFont; }
 786
 787     wxFont GetCellTextFont(int WXUNUSED(row), int WXUNUSED(col)) const
 788         { return m_defaultCellFont; }
 789
 790     void SetCellTextFont(const wxFont& fnt)
 791         { SetDefaultCellFont( fnt ); }
 792
 793     void SetCellTextFont(const wxFont& fnt, int row, int col)
 794         { SetCellFont( row, col, fnt ); }
 795
 796     void SetCellTextColour(const wxColour& val, int row, int col)
 797         { SetCellTextColour( row, col, val ); }
 798
 799     void SetCellTextColour(const wxColour& col)
 800         { SetDefaultCellTextColour( col ); }
 801
 802     void SetCellBackgroundColour(const wxColour& col)
 803         { SetDefaultCellBackgroundColour( col ); }
 804
 805     void SetCellBackgroundColour(const wxColour& colour, int row, int col)
 806         { SetCellBackgroundColour( row, col, colour ); }
 807
 808     bool GetEditable() { return IsEditable(); }
 809     void SetEditable( bool edit = TRUE ) { EnableEditing( edit ); }
 810     bool GetEditInPlace() { return IsCellEditControlEnabled(); }
 811     void SetEditInPlace(bool edit = TRUE) { }
 812
 813     void SetCellAlignment( int align, int row, int col)
 814     { SetCellAlignment(row, col, align, wxCENTER); }
 815     void SetCellAlignment( int WXUNUSED(align) ) {}
 816     void SetCellBitmap(wxBitmap *WXUNUSED(bitmap), int WXUNUSED(row), int WXUNUSED(col))
 817     { }
 818     void SetDividerPen(const wxPen& WXUNUSED(pen)) { }
 819     wxPen& GetDividerPen() const { return wxNullPen; }
 820     void OnActivate(bool WXUNUSED(active)) {}
 821
 822     // ******** End of compatibility functions **********
 823
 824
 825
 826     // ------ control IDs
 827     enum { wxGRID_CELLCTRL = 2000,
 828            wxGRID_TOPCTRL };
 829
 830     // ------ control types
 831     enum { wxGRID_TEXTCTRL = 2100,
 832            wxGRID_CHECKBOX,
 833            wxGRID_CHOICE,
 834            wxGRID_COMBOBOX };
 835
 836 protected:
 837     bool m_created;
 838
 839     wxGridWindow             *m_gridWin;
 840     wxGridRowLabelWindow     *m_rowLabelWin;
 841     wxGridColLabelWindow     *m_colLabelWin;
 842     wxGridCornerLabelWindow  *m_cornerLabelWin;
 843
 844     wxBoxSizer               *m_mainSizer;
 845     wxBoxSizer               *m_topSizer;
 846     wxBoxSizer               *m_middleSizer;
 847
 848     wxGridTableBase          *m_table;
 849
 850     int m_left;
 851     int m_top;
 852     int m_right;
 853     int m_bottom;
 854
 855     int m_numRows;
 856     int m_numCols;
 857
 858     wxGridCellCoords m_currentCellCoords;
 859
 860     wxGridCellCoords m_selectedTopLeft;
 861     wxGridCellCoords m_selectedBottomRight;
 862
 863     int        m_defaultRowHeight;
 864     wxArrayInt m_rowHeights;
 865     wxArrayInt m_rowBottoms;
 866
 867     int        m_defaultColWidth;
 868     wxArrayInt m_colWidths;
 869     wxArrayInt m_colRights;
 870
 871     int m_rowLabelWidth;
 872     int m_colLabelHeight;
 873
 874     wxColour   m_labelBackgroundColour;
 875     wxColour   m_labelTextColour;
 876     wxFont     m_labelFont;
 877
 878     int        m_rowLabelHorizAlign;
 879     int        m_rowLabelVertAlign;
 880     int        m_colLabelHorizAlign;
 881     int        m_colLabelVertAlign;
 882
 883     bool       m_defaultRowLabelValues;
 884     bool       m_defaultColLabelValues;
 885
 886     wxColour   m_gridLineColour;
 887     bool       m_gridLinesEnabled;
 888
 889     wxFont     m_defaultCellFont;
 890
 891     wxGridCellCoordsArray  m_cellsExposed;
 892     wxArrayInt             m_rowsExposed;
 893     wxArrayInt             m_colsExposed;
 894     wxArrayInt             m_rowLabelsExposed;
 895     wxArrayInt             m_colLabelsExposed;
 896
 897     bool m_inOnKeyDown;
 898     int  m_batchCount;
 899
 900     int  m_cursorMode;
 901     enum { WXGRID_CURSOR_DEFAULT,
 902            WXGRID_CURSOR_SELECT_CELL,
 903            WXGRID_CURSOR_RESIZE_ROW,
 904            WXGRID_CURSOR_RESIZE_COL,
 905            WXGRID_CURSOR_SELECT_ROW,
 906            WXGRID_CURSOR_SELECT_COL
 907     };
 908
 909     int  m_dragLastPos;
 910     int  m_dragRowOrCol;
 911     bool m_isDragging;
 912
 913     wxGridCellCoords m_selectionStart;
 914
 915     wxCursor m_rowResizeCursor;
 916     wxCursor m_colResizeCursor;
 917
 918     bool       m_editable;  // applies to whole grid
 919     int        m_editCtrlType;  // for current cell
 920     wxWindow*  m_cellEditCtrl;
 921     bool       m_cellEditCtrlEnabled;
 922
 923
 924     void Create();
 925     void Init();
 926     void CalcDimensions();
 927     bool Redimension( wxGridTableMessage& );
 928
 929
 930     bool SendEvent( const wxEventType,
 931                     int row, int col,
 932                     wxMouseEvent& );
 933
 934     bool SendEvent( const wxEventType,
 935                     int row, int col );
 936
 937
 938     void OnPaint( wxPaintEvent& );
 939     void OnSize( wxSizeEvent& );
 940     void OnKeyDown( wxKeyEvent& );
 941
 942
 943     void SetCurrentCell( const wxGridCellCoords& coords );
 944     void SetCurrentCell( int row, int col )
 945         { SetCurrentCell( wxGridCellCoords(row, col) ); }
 946
 947
 948     // ------ functions to get/send data (see also public functions)
 949     //
 950     bool GetModelValues();
 951     bool SetModelValues();
 952
 953
 954     ////////////////////// Public section ////////////////////
 955
 956
 957     DECLARE_DYNAMIC_CLASS( wxGrid )
 958     DECLARE_EVENT_TABLE()
 959 };
 960
 961
 962
 963
 964
 965 //
 966 // ------ Grid event class and event types
 967 //
 968
 969 class WXDLLEXPORT wxGridEvent : public wxNotifyEvent
 970 {
 971 public:
 972     wxGridEvent()
 973         : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
 974         m_control(0), m_meta(0), m_shift(0), m_alt(0)
 975         {
 976         }
 977
 978     wxGridEvent(int id, wxEventType type, wxObject* obj,
 979                 int row=-1, int col=-1, int x=-1, int y=-1,
 980                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
 981
 982     virtual int GetRow() { return m_row; }
 983     virtual int GetCol() { return m_col; }
 984     wxPoint     GetPosition() { return wxPoint( m_x, m_y ); }
 985     bool        ControlDown() { return m_control; }
 986     bool        MetaDown() { return m_meta; }
 987     bool        ShiftDown() { return m_shift; }
 988     bool        AltDown() { return m_alt; }
 989
 990 protected:
 991     int         m_row;
 992     int         m_col;
 993     int         m_x;
 994     int         m_y;
 995     bool        m_control;
 996     bool        m_meta;
 997     bool        m_shift;
 998     bool        m_alt;
 999
1000     DECLARE_DYNAMIC_CLASS(wxGridEvent)
1001 };
1002
1003
1004 class WXDLLEXPORT wxGridSizeEvent : public wxNotifyEvent
1005 {
1006 public:
1007     wxGridSizeEvent()
1008         : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
1009         m_control(0), m_meta(0), m_shift(0), m_alt(0)
1010         {
1011         }
1012
1013     wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
1014                 int rowOrCol=-1, int x=-1, int y=-1,
1015                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
1016
1017     int         GetRowOrCol() { return m_rowOrCol; }
1018     wxPoint     GetPosition() { return wxPoint( m_x, m_y ); }
1019     bool        ControlDown() { return m_control; }
1020     bool        MetaDown() { return m_meta; }
1021     bool        ShiftDown() { return m_shift; }
1022     bool        AltDown() { return m_alt; }
1023
1024 protected:
1025     int         m_rowOrCol;
1026     int         m_x;
1027     int         m_y;
1028     bool        m_control;
1029     bool        m_meta;
1030     bool        m_shift;
1031     bool        m_alt;
1032
1033     DECLARE_DYNAMIC_CLASS(wxGridSizeEvent)
1034 };
1035
1036
1037 class WXDLLEXPORT wxGridRangeSelectEvent : public wxNotifyEvent
1038 {
1039 public:
1040     wxGridRangeSelectEvent()
1041         : wxNotifyEvent()
1042         {
1043             m_topLeft     = wxGridNoCellCoords;
1044             m_bottomRight = wxGridNoCellCoords;
1045             m_control     = FALSE;
1046             m_meta        = FALSE;
1047             m_shift       = FALSE;
1048             m_alt         = FALSE;
1049         }
1050
1051     wxGridRangeSelectEvent(int id, wxEventType type, wxObject* obj,
1052                            const wxGridCellCoords& topLeft,
1053                            const wxGridCellCoords& bottomRight,
1054                            bool control=FALSE, bool shift=FALSE,
1055                            bool alt=FALSE, bool meta=FALSE);
1056
1057     wxGridCellCoords GetTopLeftCoords() { return m_topLeft; }
1058     wxGridCellCoords GetBottomRightCoords() { return m_bottomRight; }
1059     int         GetTopRow()    { return m_topLeft.GetRow(); }
1060     int         GetBottomRow() { return m_bottomRight.GetRow(); }
1061     int         GetLeftCol()   { return m_topLeft.GetCol(); }
1062     int         GetRightCol()  { return m_bottomRight.GetCol(); }
1063     bool        ControlDown()  { return m_control; }
1064     bool        MetaDown()     { return m_meta; }
1065     bool        ShiftDown()    { return m_shift; }
1066     bool        AltDown()      { return m_alt; }
1067
1068 protected:
1069     wxGridCellCoords  m_topLeft;
1070     wxGridCellCoords  m_bottomRight;
1071     bool              m_control;
1072     bool              m_meta;
1073     bool              m_shift;
1074     bool              m_alt;
1075
1076     DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent)
1077 };
1078
1079
1080 const wxEventType EVT_GRID_CELL_LEFT_CLICK    = wxEVT_FIRST + 1580;
1081 const wxEventType EVT_GRID_CELL_RIGHT_CLICK   = wxEVT_FIRST + 1581;
1082 const wxEventType EVT_GRID_CELL_LEFT_DCLICK   = wxEVT_FIRST + 1582;
1083 const wxEventType EVT_GRID_CELL_RIGHT_DCLICK  = wxEVT_FIRST + 1583;
1084 const wxEventType EVT_GRID_LABEL_LEFT_CLICK   = wxEVT_FIRST + 1584;
1085 const wxEventType EVT_GRID_LABEL_RIGHT_CLICK  = wxEVT_FIRST + 1585;
1086 const wxEventType EVT_GRID_LABEL_LEFT_DCLICK  = wxEVT_FIRST + 1586;
1087 const wxEventType EVT_GRID_LABEL_RIGHT_DCLICK = wxEVT_FIRST + 1587;
1088 const wxEventType EVT_GRID_ROW_SIZE           = wxEVT_FIRST + 1588;
1089 const wxEventType EVT_GRID_COL_SIZE           = wxEVT_FIRST + 1589;
1090 const wxEventType EVT_GRID_RANGE_SELECT       = wxEVT_FIRST + 1590;
1091 const wxEventType EVT_GRID_CELL_CHANGE        = wxEVT_FIRST + 1591;
1092 const wxEventType EVT_GRID_SELECT_CELL        = wxEVT_FIRST + 1592;
1093
1094
1095 typedef void (wxEvtHandler::*wxGridEventFunction)(wxGridEvent&);
1096 typedef void (wxEvtHandler::*wxGridSizeEventFunction)(wxGridSizeEvent&);
1097 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction)(wxGridRangeSelectEvent&);
1098
1099 #define EVT_GRID_CELL_LEFT_CLICK(fn)     { EVT_GRID_CELL_LEFT_CLICK,    -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1100 #define EVT_GRID_CELL_RIGHT_CLICK(fn)    { EVT_GRID_CELL_RIGHT_CLICK,   -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1101 #define EVT_GRID_CELL_LEFT_DCLICK(fn)    { EVT_GRID_CELL_LEFT_DCLICK,   -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1102 #define EVT_GRID_CELL_RIGHT_DCLICK(fn)   { EVT_GRID_CELL_RIGHT_DCLICK,  -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1103 #define EVT_GRID_LABEL_LEFT_CLICK(fn)    { EVT_GRID_LABEL_LEFT_CLICK,   -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1104 #define EVT_GRID_LABEL_RIGHT_CLICK(fn)   { EVT_GRID_LABEL_RIGHT_CLICK,  -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1105 #define EVT_GRID_LABEL_LEFT_DCLICK(fn)   { EVT_GRID_LABEL_LEFT_DCLICK,  -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1106 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn)  { EVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1107 #define EVT_GRID_ROW_SIZE(fn)            { EVT_GRID_ROW_SIZE,           -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1108 #define EVT_GRID_COL_SIZE(fn)            { EVT_GRID_COL_SIZE,           -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1109 #define EVT_GRID_RANGE_SELECT(fn)        { EVT_GRID_RANGE_SELECT,       -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
1110 #define EVT_GRID_CELL_CHANGE(fn)         { EVT_GRID_CELL_CHANGE,        -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1111 #define EVT_GRID_SELECT_CELL(fn)         { EVT_GRID_SELECT_CELL,        -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1112
1113
1114 #if 0  // TODO: implement these ?  others ?
1115
1116 const wxEventType EVT_GRID_CREATE_CELL      = wxEVT_FIRST + 1576;
1117 const wxEventType EVT_GRID_CHANGE_LABELS    = wxEVT_FIRST + 1577;
1118 const wxEventType EVT_GRID_CHANGE_SEL_LABEL = wxEVT_FIRST + 1578;
1119
1120 #define EVT_GRID_CREATE_CELL(fn)      { EVT_GRID_CREATE_CELL,      -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1121 #define EVT_GRID_CHANGE_LABELS(fn)    { EVT_GRID_CHANGE_LABELS,    -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1122 #define EVT_GRID_CHANGE_SEL_LABEL(fn) { EVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1123
1124 #endif
1125
1126 #endif  // #ifndef __WXGRID_H__
1127
1128 #endif  // ifndef wxUSE_NEW_GRID