1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxGrid and related classes
4 // Author: Michael Bedward (based on code by Julian Smart, Robin Dunn)
8 // Copyright: (c) Michael Bedward
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 #if !defined(wxUSE_NEW_GRID) || !(wxUSE_NEW_GRID)
23 #pragma interface "grid.h"
27 #include "wx/scrolwin.h"
28 #include "wx/string.h"
29 #include "wx/scrolbar.h"
31 #include "wx/textctrl.h"
32 #include "wx/combobox.h"
33 #include "wx/dynarray.h"
36 // Default parameters for wxGrid
38 #define WXGRID_DEFAULT_NUMBER_ROWS 10
39 #define WXGRID_DEFAULT_NUMBER_COLS 10
41 #define WXGRID_DEFAULT_ROW_HEIGHT 25
43 #define WXGRID_DEFAULT_ROW_HEIGHT 30
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
53 // ----------------------------------------------------------------------------
54 // forward declarations
55 // ----------------------------------------------------------------------------
57 class WXDLLEXPORT wxGrid
;
58 class WXDLLEXPORT wxGridCellAttr
;
59 class WXDLLEXPORT wxGridCellAttrProviderData
;
60 class WXDLLEXPORT wxGridColLabelWindow
;
61 class WXDLLEXPORT wxGridCornerLabelWindow
;
62 class WXDLLEXPORT wxGridRowLabelWindow
;
63 class WXDLLEXPORT wxGridTableBase
;
64 class WXDLLEXPORT wxGridWindow
;
66 // ----------------------------------------------------------------------------
67 // wxGridCellRenderer: this class is responsible for actually drawing the cell
68 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
69 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
70 // view of all cells. This is an ABC, you will normally use one of the
71 // predefined derived classes or derive oyur own class from it.
72 // ----------------------------------------------------------------------------
74 class WXDLLEXPORT wxGridCellRenderer
77 // draw the given cell on the provided DC inside the given rectangle
78 // using the style specified by the attribute and the default or selected
79 // state corresponding to the isSelected value.
81 // this pure virtual function has a default implementation which will
82 // prepare the DC using the given attribute: it will draw the rectangle
83 // with the bg colour from attr and set the text colour and font
84 virtual void Draw(wxGrid
& grid
,
92 // the default renderer for the cells containing string data
93 class WXDLLEXPORT wxGridCellStringRenderer
: public wxGridCellRenderer
97 virtual void Draw(wxGrid
& grid
,
106 // ----------------------------------------------------------------------------
107 // wxGridCellEditor: This class is responsible for providing and manipulating
108 // the in-place edit controls for the grid. Instances of wxGridCellEditor
109 // (actually, instances of derived classes since it is an ABC) can be
110 // associated with the cell attributes for individual cells, rows, columns, or
111 // even for the entire grid.
112 // ----------------------------------------------------------------------------
114 class WXDLLEXPORT wxGridCellEditor
118 virtual ~wxGridCellEditor();
120 bool IsCreated() { return m_control
!= NULL
; }
122 // Creates the actual edit control
123 virtual void Create(wxWindow
* parent
,
125 wxEvtHandler
* evtHandler
) = 0;
127 // Size and position the edit control
128 virtual void SetSize(const wxRect
& rect
);
130 // Show or hide the edit control
131 virtual void Show(bool show
);
133 // Fetch the value from the table and prepare the edit control
134 // to begin editing. Set the focus to the edit control.
135 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
,
136 wxGridCellAttr
* attr
) = 0;
138 // Complete the editing of the current cell. If saveValue is
139 // true then send the new value back to the table. Returns true
140 // if the value has changed. If necessary, the control may be
142 virtual bool EndEdit(int row
, int col
, bool saveValue
,
143 wxGrid
* grid
, wxGridCellAttr
* attr
) = 0;
145 // Reset the value in the control back to its starting value
146 virtual void Reset() = 0;
148 // If the editor is enabled by pressing keys on the grid,
149 // this will be called to let the editor do something about
150 // that first key if desired.
151 virtual void StartingKey(wxKeyEvent
& event
);
153 // Some types of controls on some platforms may need some help
154 // with the Return key.
155 virtual void HandleReturn(wxKeyEvent
& event
);
158 virtual void Destroy();
161 wxControl
* m_control
;
165 class WXDLLEXPORT wxGridCellTextEditor
: public wxGridCellEditor
168 wxGridCellTextEditor();
170 virtual void Create(wxWindow
* parent
,
172 wxEvtHandler
* evtHandler
);
174 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
,
175 wxGridCellAttr
* attr
);
177 virtual bool EndEdit(int row
, int col
, bool saveValue
,
178 wxGrid
* grid
, wxGridCellAttr
* attr
);
180 virtual void Reset();
181 virtual void StartingKey(wxKeyEvent
& event
);
182 virtual void HandleReturn(wxKeyEvent
& event
);
186 wxString m_startValue
;
189 // ----------------------------------------------------------------------------
190 // wxGridCellAttr: this class can be used to alter the cells appearance in
191 // the grid by changing their colour/font/... from default. An object of this
192 // class may be returned by wxGridTable::GetAttr().
193 // ----------------------------------------------------------------------------
195 class WXDLLEXPORT wxGridCellAttr
205 wxGridCellAttr(const wxColour
& colText
,
206 const wxColour
& colBack
,
210 : m_colText(colText
), m_colBack(colBack
), m_font(font
)
213 SetAlignment(hAlign
, vAlign
);
216 // default copy ctor ok
218 // this class is ref counted: it is created with ref count of 1, so
219 // calling DecRef() once will delete it. Calling IncRef() allows to lock
220 // it until the matching DecRef() is called
221 void IncRef() { m_nRef
++; }
222 void DecRef() { if ( !--m_nRef
) delete this; }
223 void SafeIncRef() { if ( this ) IncRef(); }
224 void SafeDecRef() { if ( this ) DecRef(); }
227 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
228 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
229 void SetFont(const wxFont
& font
) { m_font
= font
; }
230 void SetAlignment(int hAlign
, int vAlign
)
236 // takes ownership of the pointer
237 void SetRenderer(wxGridCellRenderer
*renderer
)
238 { delete m_renderer
; m_renderer
= renderer
; }
239 void SetEditor(wxGridCellEditor
* editor
)
240 { delete m_editor
; m_editor
= editor
; }
243 bool HasTextColour() const { return m_colText
.Ok(); }
244 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
245 bool HasFont() const { return m_font
.Ok(); }
246 bool HasAlignment() const { return m_hAlign
|| m_vAlign
; }
247 bool HasRenderer() const { return m_renderer
!= NULL
; }
248 bool HasEditor() const { return m_editor
!= NULL
; }
250 const wxColour
& GetTextColour() const;
251 const wxColour
& GetBackgroundColour() const;
252 const wxFont
& GetFont() const;
253 void GetAlignment(int *hAlign
, int *vAlign
) const;
254 wxGridCellRenderer
*GetRenderer() const;
255 wxGridCellEditor
*GetEditor() const;
257 void SetDefAttr(wxGridCellAttr
* defAttr
) { m_defGridAttr
= defAttr
; }
260 // the common part of all ctors
267 // the dtor is private because only DecRef() can delete us
268 ~wxGridCellAttr() { delete m_renderer
; delete m_editor
; }
270 // the ref count - when it goes to 0, we die
279 wxGridCellRenderer
* m_renderer
;
280 wxGridCellEditor
* m_editor
;
281 wxGridCellAttr
* m_defGridAttr
;
283 // suppress the stupid gcc warning about the class having private dtor and
285 friend class wxGridCellAttrDummyFriend
;
288 // ----------------------------------------------------------------------------
289 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
291 // ----------------------------------------------------------------------------
293 // implementation note: we separate it from wxGridTableBase because we wish to
294 // avoid deriving a new table class if possible, and sometimes it will be
295 // enough to just derive another wxGridCellAttrProvider instead
297 // the default implementation is reasonably efficient for the generic case,
298 // but you might still wish to implement your own for some specific situations
299 // if you have performance problems with the stock one
300 class WXDLLEXPORT wxGridCellAttrProvider
303 wxGridCellAttrProvider();
304 virtual ~wxGridCellAttrProvider();
306 // DecRef() must be called on the returned pointer
307 virtual wxGridCellAttr
*GetAttr(int row
, int col
) const;
309 // all these functions take ownership of the pointer, don't call DecRef()
311 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
312 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
313 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
318 wxGridCellAttrProviderData
*m_data
;
321 //////////////////////////////////////////////////////////////////////
323 // Grid table classes
325 //////////////////////////////////////////////////////////////////////
328 class WXDLLEXPORT wxGridTableBase
: public wxObject
332 virtual ~wxGridTableBase();
334 // You must override these functions in a derived table class
336 virtual long GetNumberRows() = 0;
337 virtual long GetNumberCols() = 0;
338 virtual wxString
GetValue( int row
, int col
) = 0;
339 virtual void SetValue( int row
, int col
, const wxString
& s
) = 0;
340 virtual bool IsEmptyCell( int row
, int col
) = 0;
342 // Overriding these is optional
344 virtual void SetView( wxGrid
*grid
) { m_view
= grid
; }
345 virtual wxGrid
* GetView() const { return m_view
; }
347 virtual void Clear() {}
348 virtual bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
349 virtual bool AppendRows( size_t numRows
= 1 );
350 virtual bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
351 virtual bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
352 virtual bool AppendCols( size_t numCols
= 1 );
353 virtual bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
355 virtual wxString
GetRowLabelValue( int row
);
356 virtual wxString
GetColLabelValue( int col
);
357 virtual void SetRowLabelValue( int WXUNUSED(row
), const wxString
& ) {}
358 virtual void SetColLabelValue( int WXUNUSED(col
), const wxString
& ) {}
360 // Attribute handling
363 // give us the attr provider to use - we take ownership of the pointer
364 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
366 // get the currently used attr provider (may be NULL)
367 wxGridCellAttrProvider
*GetAttrProvider() const { return m_attrProvider
; }
369 // by default forwarded to wxGridCellAttrProvider if any. May be
370 // overridden to handle attributes directly in this class.
371 virtual wxGridCellAttr
*GetAttr( int row
, int col
);
373 // these functions take ownership of the pointer
374 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
375 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
376 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
380 wxGridCellAttrProvider
*m_attrProvider
;
382 DECLARE_ABSTRACT_CLASS( wxGridTableBase
);
386 // ----------------------------------------------------------------------------
387 // wxGridTableMessage
388 // ----------------------------------------------------------------------------
390 // IDs for messages sent from grid table to view
392 enum wxGridTableRequest
394 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
= 2000,
395 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES
,
396 wxGRIDTABLE_NOTIFY_ROWS_INSERTED
,
397 wxGRIDTABLE_NOTIFY_ROWS_APPENDED
,
398 wxGRIDTABLE_NOTIFY_ROWS_DELETED
,
399 wxGRIDTABLE_NOTIFY_COLS_INSERTED
,
400 wxGRIDTABLE_NOTIFY_COLS_APPENDED
,
401 wxGRIDTABLE_NOTIFY_COLS_DELETED
404 class WXDLLEXPORT wxGridTableMessage
407 wxGridTableMessage();
408 wxGridTableMessage( wxGridTableBase
*table
, int id
,
412 void SetTableObject( wxGridTableBase
*table
) { m_table
= table
; }
413 wxGridTableBase
* GetTableObject() const { return m_table
; }
414 void SetId( int id
) { m_id
= id
; }
415 int GetId() { return m_id
; }
416 void SetCommandInt( int comInt1
) { m_comInt1
= comInt1
; }
417 int GetCommandInt() { return m_comInt1
; }
418 void SetCommandInt2( int comInt2
) { m_comInt2
= comInt2
; }
419 int GetCommandInt2() { return m_comInt2
; }
422 wxGridTableBase
*m_table
;
430 // ------ wxGridStringArray
431 // A 2-dimensional array of strings for data values
434 WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString
, wxGridStringArray
);
438 // ------ wxGridStringTable
440 // Simplest type of data table for a grid for small tables of strings
441 // that are stored in memory
444 class WXDLLEXPORT wxGridStringTable
: public wxGridTableBase
448 wxGridStringTable( int numRows
, int numCols
);
449 ~wxGridStringTable();
451 // these are pure virtual in wxGridTableBase
453 long GetNumberRows();
454 long GetNumberCols();
455 wxString
GetValue( int row
, int col
);
456 void SetValue( int row
, int col
, const wxString
& s
);
457 bool IsEmptyCell( int row
, int col
);
459 // overridden functions from wxGridTableBase
462 bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
463 bool AppendRows( size_t numRows
= 1 );
464 bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
465 bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
466 bool AppendCols( size_t numCols
= 1 );
467 bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
469 void SetRowLabelValue( int row
, const wxString
& );
470 void SetColLabelValue( int col
, const wxString
& );
471 wxString
GetRowLabelValue( int row
);
472 wxString
GetColLabelValue( int col
);
475 wxGridStringArray m_data
;
477 // These only get used if you set your own labels, otherwise the
478 // GetRow/ColLabelValue functions return wxGridTableBase defaults
480 wxArrayString m_rowLabels
;
481 wxArrayString m_colLabels
;
483 DECLARE_DYNAMIC_CLASS( wxGridStringTable
)
488 //////////////////////////////////////////////////////////////////////
492 //////////////////////////////////////////////////////////////////////
494 class WXDLLEXPORT wxGridCellCoords
497 wxGridCellCoords() { m_row
= m_col
= -1; }
498 wxGridCellCoords( int r
, int c
) { m_row
= r
; m_col
= c
; }
500 // default copy ctor is ok
502 long GetRow() const { return m_row
; }
503 void SetRow( long n
) { m_row
= n
; }
504 long GetCol() const { return m_col
; }
505 void SetCol( long n
) { m_col
= n
; }
506 void Set( long row
, long col
) { m_row
= row
; m_col
= col
; }
508 wxGridCellCoords
& operator=( const wxGridCellCoords
& other
)
510 if ( &other
!= this )
518 bool operator==( const wxGridCellCoords
& other
)
520 return (m_row
== other
.m_row
&& m_col
== other
.m_col
);
523 bool operator!=( const wxGridCellCoords
& other
)
525 return (m_row
!= other
.m_row
|| m_col
!= other
.m_col
);
530 return (m_row
== -1 && m_col
== -1 );
539 // For comparisons...
541 extern wxGridCellCoords wxGridNoCellCoords
;
542 extern wxRect wxGridNoCellRect
;
544 // An array of cell coords...
546 WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords
, wxGridCellCoordsArray
);
550 // ----------------------------------------------------------------------------
552 // ----------------------------------------------------------------------------
554 class WXDLLEXPORT wxGrid
: public wxScrolledWindow
562 wxGrid( wxWindow
*parent
,
564 const wxPoint
& pos
= wxDefaultPosition
,
565 const wxSize
& size
= wxDefaultSize
,
567 const wxString
& name
= wxPanelNameStr
);
571 bool CreateGrid( int numRows
, int numCols
);
574 // ------ grid dimensions
576 int GetNumberRows() { return m_numRows
; }
577 int GetNumberCols() { return m_numCols
; }
580 // ------ display update functions
582 void CalcRowLabelsExposed( wxRegion
& reg
);
584 void CalcColLabelsExposed( wxRegion
& reg
);
585 void CalcCellsExposed( wxRegion
& reg
);
588 // ------ event handlers
590 void ProcessRowLabelMouseEvent( wxMouseEvent
& event
);
591 void ProcessColLabelMouseEvent( wxMouseEvent
& event
);
592 void ProcessCornerLabelMouseEvent( wxMouseEvent
& event
);
593 void ProcessGridCellMouseEvent( wxMouseEvent
& event
);
594 bool ProcessTableMessage( wxGridTableMessage
& );
596 void DoEndDragResizeRow();
597 void DoEndDragResizeCol();
599 wxGridTableBase
* GetTable() const { return m_table
; }
600 bool SetTable( wxGridTableBase
*table
, bool takeOwnership
=FALSE
);
603 bool InsertRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
604 bool AppendRows( int numRows
= 1, bool updateLabels
=TRUE
);
605 bool DeleteRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
606 bool InsertCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
607 bool AppendCols( int numCols
= 1, bool updateLabels
=TRUE
);
608 bool DeleteCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
610 void DrawGridCellArea( wxDC
& dc
);
611 void DrawCellBorder( wxDC
& dc
, const wxGridCellCoords
& );
612 void DrawAllGridLines( wxDC
& dc
, const wxRegion
& reg
);
613 void DrawCell( wxDC
& dc
, const wxGridCellCoords
& );
614 void DrawCellHighlight( wxDC
& dc
);
616 void DrawRowLabels( wxDC
& dc
);
617 void DrawRowLabel( wxDC
& dc
, int row
);
619 void DrawColLabels( wxDC
& dc
);
620 void DrawColLabel( wxDC
& dc
, int col
);
623 // ------ Cell text drawing functions
625 void DrawTextRectangle( wxDC
& dc
, const wxString
&, const wxRect
&,
626 int horizontalAlignment
= wxLEFT
,
627 int verticalAlignment
= wxTOP
);
629 // Split a string containing newline chararcters into an array of
630 // strings and return the number of lines
632 void StringToLines( const wxString
& value
, wxArrayString
& lines
);
634 void GetTextBoxSize( wxDC
& dc
,
635 wxArrayString
& lines
,
636 long *width
, long *height
);
640 // Code that does a lot of grid modification can be enclosed
641 // between BeginBatch() and EndBatch() calls to avoid screen
644 void BeginBatch() { m_batchCount
++; }
645 void EndBatch() { if ( m_batchCount
> 0 ) m_batchCount
--; }
646 int GetBatchCount() { return m_batchCount
; }
649 // ------ edit control functions
651 bool IsEditable() { return m_editable
; }
652 void EnableEditing( bool edit
);
654 void EnableCellEditControl( bool enable
);
656 bool IsCellEditControlEnabled()
657 { return m_cellEditCtrlEnabled
; }
659 void ShowCellEditControl();
660 void HideCellEditControl();
661 void SetEditControlValue( const wxString
& s
= wxEmptyString
);
662 void SaveEditControlValue();
665 // ------ grid location functions
666 // Note that all of these functions work with the logical coordinates of
667 // grid cells and labels so you will need to convert from device
668 // coordinates for mouse events etc.
670 void XYToCell( int x
, int y
, wxGridCellCoords
& );
674 int YToEdgeOfRow( int y
);
675 int XToEdgeOfCol( int x
);
677 wxRect
CellToRect( int row
, int col
);
678 wxRect
CellToRect( const wxGridCellCoords
& coords
)
679 { return CellToRect( coords
.GetRow(), coords
.GetCol() ); }
681 int GetGridCursorRow() { return m_currentCellCoords
.GetRow(); }
682 int GetGridCursorCol() { return m_currentCellCoords
.GetCol(); }
684 // check to see if a cell is either wholly visible (the default arg) or
685 // at least partially visible in the grid window
687 bool IsVisible( int row
, int col
, bool wholeCellVisible
= TRUE
);
688 bool IsVisible( const wxGridCellCoords
& coords
, bool wholeCellVisible
= TRUE
)
689 { return IsVisible( coords
.GetRow(), coords
.GetCol(), wholeCellVisible
); }
690 void MakeCellVisible( int row
, int col
);
691 void MakeCellVisible( const wxGridCellCoords
& coords
)
692 { MakeCellVisible( coords
.GetRow(), coords
.GetCol() ); }
695 // ------ grid cursor movement functions
697 void SetGridCursor( int row
, int col
)
698 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
701 bool MoveCursorDown();
702 bool MoveCursorLeft();
703 bool MoveCursorRight();
706 bool MoveCursorUpBlock();
707 bool MoveCursorDownBlock();
708 bool MoveCursorLeftBlock();
709 bool MoveCursorRightBlock();
712 // ------ label and gridline formatting
714 int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH
; }
715 int GetRowLabelSize() { return m_rowLabelWidth
; }
716 int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT
; }
717 int GetColLabelSize() { return m_colLabelHeight
; }
718 wxColour
GetLabelBackgroundColour() { return m_labelBackgroundColour
; }
719 wxColour
GetLabelTextColour() { return m_labelTextColour
; }
720 wxFont
GetLabelFont() { return m_labelFont
; }
721 void GetRowLabelAlignment( int *horiz
, int *vert
);
722 void GetColLabelAlignment( int *horiz
, int *vert
);
723 wxString
GetRowLabelValue( int row
);
724 wxString
GetColLabelValue( int col
);
725 wxColour
GetGridLineColour() { return m_gridLineColour
; }
727 void SetRowLabelSize( int width
);
728 void SetColLabelSize( int height
);
729 void SetLabelBackgroundColour( const wxColour
& );
730 void SetLabelTextColour( const wxColour
& );
731 void SetLabelFont( const wxFont
& );
732 void SetRowLabelAlignment( int horiz
, int vert
);
733 void SetColLabelAlignment( int horiz
, int vert
);
734 void SetRowLabelValue( int row
, const wxString
& );
735 void SetColLabelValue( int col
, const wxString
& );
736 void SetGridLineColour( const wxColour
& );
738 // this sets the specified attribute for all cells in this row/col
739 void SetRowAttr(int row
, wxGridCellAttr
*attr
);
740 void SetColAttr(int col
, wxGridCellAttr
*attr
);
742 void EnableGridLines( bool enable
= TRUE
);
743 bool GridLinesEnabled() { return m_gridLinesEnabled
; }
745 // ------ row and col formatting
747 int GetDefaultRowSize();
748 int GetRowSize( int row
);
749 int GetDefaultColSize();
750 int GetColSize( int col
);
751 wxColour
GetDefaultCellBackgroundColour();
752 wxColour
GetCellBackgroundColour( int row
, int col
);
753 wxColour
GetDefaultCellTextColour();
754 wxColour
GetCellTextColour( int row
, int col
);
755 wxFont
GetDefaultCellFont();
756 wxFont
GetCellFont( int row
, int col
);
757 void GetDefaultCellAlignment( int *horiz
, int *vert
);
758 void GetCellAlignment( int row
, int col
, int *horiz
, int *vert
);
760 void SetDefaultRowSize( int height
, bool resizeExistingRows
= FALSE
);
761 void SetRowSize( int row
, int height
);
762 void SetDefaultColSize( int width
, bool resizeExistingCols
= FALSE
);
764 void SetColSize( int col
, int width
);
765 void SetDefaultCellBackgroundColour( const wxColour
& );
766 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
767 void SetDefaultCellTextColour( const wxColour
& );
769 void SetCellTextColour( int row
, int col
, const wxColour
& );
770 void SetDefaultCellFont( const wxFont
& );
771 void SetCellFont( int row
, int col
, const wxFont
& );
772 void SetDefaultCellAlignment( int horiz
, int vert
);
773 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
775 // takes ownership of the pointer
776 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
777 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
778 wxGridCellRenderer
*GetDefaultRenderer() const;
779 wxGridCellRenderer
* GetCellRenderer(int row
, int col
);
782 // ------ cell value accessors
784 wxString
GetCellValue( int row
, int col
)
788 return m_table
->GetValue( row
, col
);
792 return wxEmptyString
;
796 wxString
GetCellValue( const wxGridCellCoords
& coords
)
797 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
799 void SetCellValue( int row
, int col
, const wxString
& s
);
800 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
801 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
805 // ------ selections of blocks of cells
807 void SelectRow( int row
, bool addToSelected
= FALSE
);
808 void SelectCol( int col
, bool addToSelected
= FALSE
);
810 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
);
812 void SelectBlock( const wxGridCellCoords
& topLeft
,
813 const wxGridCellCoords
& bottomRight
)
814 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
815 bottomRight
.GetRow(), bottomRight
.GetCol() ); }
820 { return ( m_selectedTopLeft
!= wxGridNoCellCoords
&&
821 m_selectedBottomRight
!= wxGridNoCellCoords
);
824 void ClearSelection();
826 bool IsInSelection( int row
, int col
)
827 { return ( IsSelection() &&
828 row
>= m_selectedTopLeft
.GetRow() &&
829 col
>= m_selectedTopLeft
.GetCol() &&
830 row
<= m_selectedBottomRight
.GetRow() &&
831 col
<= m_selectedBottomRight
.GetCol() );
834 bool IsInSelection( const wxGridCellCoords
& coords
)
835 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
837 void GetSelection( int* topRow
, int* leftCol
, int* bottomRow
, int* rightCol
)
839 // these will all be -1 if there is no selected block
841 *topRow
= m_selectedTopLeft
.GetRow();
842 *leftCol
= m_selectedTopLeft
.GetCol();
843 *bottomRow
= m_selectedBottomRight
.GetRow();
844 *rightCol
= m_selectedBottomRight
.GetCol();
848 // This function returns the rectangle that encloses the block of cells
849 // limited by TopLeft and BottomRight cell in device coords and clipped
850 // to the client size of the grid window.
852 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
853 const wxGridCellCoords
& bottomRight
);
855 // This function returns the rectangle that encloses the selected cells
856 // in device coords and clipped to the client size of the grid window.
858 wxRect
SelectionToDeviceRect()
860 return BlockToDeviceRect( m_selectedTopLeft
,
861 m_selectedBottomRight
);
864 // Access or update the selection fore/back colours
865 wxColour
GetSelectionBackground() const
866 { return m_selectionBackground
; }
867 wxColour
GetSelectionForeground() const
868 { return m_selectionForeground
; }
870 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
871 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
875 // ------ For compatibility with previous wxGrid only...
877 // ************************************************
878 // ** Don't use these in new code because they **
879 // ** are liable to disappear in a future **
881 // ************************************************
884 wxGrid( wxWindow
*parent
,
885 int x
= -1, int y
= -1, int w
= -1, int h
= -1,
887 const wxString
& name
= wxPanelNameStr
)
888 : wxScrolledWindow( parent
, -1, wxPoint(x
,y
), wxSize(w
,h
), style
, name
)
893 void SetCellValue( const wxString
& val
, int row
, int col
)
894 { SetCellValue( row
, col
, val
); }
896 void UpdateDimensions()
897 { CalcDimensions(); }
899 int GetRows() { return GetNumberRows(); }
900 int GetCols() { return GetNumberCols(); }
901 int GetCursorRow() { return GetGridCursorRow(); }
902 int GetCursorColumn() { return GetGridCursorCol(); }
904 int GetScrollPosX() { return 0; }
905 int GetScrollPosY() { return 0; }
907 void SetScrollX( int x
) { }
908 void SetScrollY( int y
) { }
910 void SetColumnWidth( int col
, int width
)
911 { SetColSize( col
, width
); }
913 int GetColumnWidth( int col
)
914 { return GetColSize( col
); }
916 void SetRowHeight( int row
, int height
)
917 { SetRowSize( row
, height
); }
919 int GetRowHeight( int row
)
920 { return GetRowSize( row
); }
922 int GetViewHeight() // returned num whole rows visible
925 int GetViewWidth() // returned num whole cols visible
928 void SetLabelSize( int orientation
, int sz
)
930 if ( orientation
== wxHORIZONTAL
)
931 SetColLabelSize( sz
);
933 SetRowLabelSize( sz
);
936 int GetLabelSize( int orientation
)
938 if ( orientation
== wxHORIZONTAL
)
939 return GetColLabelSize();
941 return GetRowLabelSize();
944 void SetLabelAlignment( int orientation
, int align
)
946 if ( orientation
== wxHORIZONTAL
)
947 SetColLabelAlignment( align
, -1 );
949 SetRowLabelAlignment( align
, -1 );
952 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) )
955 if ( orientation
== wxHORIZONTAL
)
957 GetColLabelAlignment( &h
, &v
);
962 GetRowLabelAlignment( &h
, &v
);
967 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
969 if ( orientation
== wxHORIZONTAL
)
970 SetColLabelValue( pos
, val
);
972 SetRowLabelValue( pos
, val
);
975 wxString
GetLabelValue( int orientation
, int pos
)
977 if ( orientation
== wxHORIZONTAL
)
978 return GetColLabelValue( pos
);
980 return GetRowLabelValue( pos
);
983 wxFont
GetCellTextFont() const
984 { return m_defaultCellAttr
->GetFont(); }
986 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
987 { return m_defaultCellAttr
->GetFont(); }
989 void SetCellTextFont(const wxFont
& fnt
)
990 { SetDefaultCellFont( fnt
); }
992 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
993 { SetCellFont( row
, col
, fnt
); }
995 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
996 { SetCellTextColour( row
, col
, val
); }
998 void SetCellTextColour(const wxColour
& col
)
999 { SetDefaultCellTextColour( col
); }
1001 void SetCellBackgroundColour(const wxColour
& col
)
1002 { SetDefaultCellBackgroundColour( col
); }
1004 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1005 { SetCellBackgroundColour( row
, col
, colour
); }
1007 bool GetEditable() { return IsEditable(); }
1008 void SetEditable( bool edit
= TRUE
) { EnableEditing( edit
); }
1009 bool GetEditInPlace() { return IsCellEditControlEnabled(); }
1011 void SetEditInPlace(bool edit
= TRUE
) { }
1013 void SetCellAlignment( int align
, int row
, int col
)
1014 { SetCellAlignment(row
, col
, align
, wxCENTER
); }
1015 void SetCellAlignment( int WXUNUSED(align
) ) {}
1016 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1018 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1019 wxPen
& GetDividerPen() const { return wxNullPen
; }
1020 void OnActivate(bool WXUNUSED(active
)) {}
1022 // ******** End of compatibility functions **********
1026 // ------ control IDs
1027 enum { wxGRID_CELLCTRL
= 2000,
1030 // ------ control types
1031 enum { wxGRID_TEXTCTRL
= 2100,
1040 wxGridWindow
*m_gridWin
;
1041 wxGridRowLabelWindow
*m_rowLabelWin
;
1042 wxGridColLabelWindow
*m_colLabelWin
;
1043 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1045 wxGridTableBase
*m_table
;
1056 wxGridCellCoords m_currentCellCoords
;
1058 wxGridCellCoords m_selectedTopLeft
;
1059 wxGridCellCoords m_selectedBottomRight
;
1060 wxColour m_selectionBackground
;
1061 wxColour m_selectionForeground
;
1063 int m_defaultRowHeight
;
1064 wxArrayInt m_rowHeights
;
1065 wxArrayInt m_rowBottoms
;
1067 int m_defaultColWidth
;
1068 wxArrayInt m_colWidths
;
1069 wxArrayInt m_colRights
;
1070 int m_rowLabelWidth
;
1071 int m_colLabelHeight
;
1073 wxColour m_labelBackgroundColour
;
1074 wxColour m_labelTextColour
;
1077 int m_rowLabelHorizAlign
;
1078 int m_rowLabelVertAlign
;
1079 int m_colLabelHorizAlign
;
1080 int m_colLabelVertAlign
;
1082 bool m_defaultRowLabelValues
;
1083 bool m_defaultColLabelValues
;
1085 wxColour m_gridLineColour
;
1086 bool m_gridLinesEnabled
;
1089 // do we have some place to store attributes in?
1090 bool CanHaveAttributes();
1092 // returns the attribute we may modify in place: a new one if this cell
1093 // doesn't have any yet or the existing one if it does
1095 // DecRef() must be called on the returned pointer, as usual
1096 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1098 // cell attribute cache (currently we only cache 1, may be will do
1099 // more/better later)
1103 wxGridCellAttr
*attr
;
1106 // invalidates the attribute cache
1107 void ClearAttrCache();
1109 // adds an attribute to cache
1110 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
1112 // looks for an attr in cache, returns TRUE if found
1113 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
1115 // looks for the attr in cache, if not found asks the table and caches the
1117 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
1118 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
)
1119 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
1121 // the default cell attr object for cells that don't have their own
1122 wxGridCellAttr
* m_defaultCellAttr
;
1125 wxGridCellCoordsArray m_cellsExposed
;
1126 wxArrayInt m_rowsExposed
;
1127 wxArrayInt m_colsExposed
;
1128 wxArrayInt m_rowLabelsExposed
;
1129 wxArrayInt m_colLabelsExposed
;
1136 WXGRID_CURSOR_SELECT_CELL
,
1137 WXGRID_CURSOR_RESIZE_ROW
,
1138 WXGRID_CURSOR_RESIZE_COL
,
1139 WXGRID_CURSOR_SELECT_ROW
,
1140 WXGRID_CURSOR_SELECT_COL
1143 // this method not only sets m_cursorMode but also sets the correct cursor
1144 // for the given mode and, if captureMouse is not FALSE releases the mouse
1145 // if it was captured and captures it if it must be captured
1147 // for this to work, you should always use it and not set m_cursorMode
1149 void ChangeCursorMode(CursorMode mode
,
1150 wxWindow
*win
= (wxWindow
*)NULL
,
1151 bool captureMouse
= TRUE
);
1153 wxWindow
*m_winCapture
; // the window which captured the mouse
1154 CursorMode m_cursorMode
;
1159 wxPoint m_startDragPos
;
1161 bool m_waitForSlowClick
;
1163 wxGridCellCoords m_selectionStart
;
1165 wxCursor m_rowResizeCursor
;
1166 wxCursor m_colResizeCursor
;
1168 bool m_editable
; // applies to whole grid
1169 bool m_cellEditCtrlEnabled
;
1174 void CalcDimensions();
1175 void CalcWindowSizes();
1176 bool Redimension( wxGridTableMessage
& );
1179 bool SendEvent( const wxEventType
,
1183 bool SendEvent( const wxEventType
,
1187 void OnPaint( wxPaintEvent
& );
1188 void OnSize( wxSizeEvent
& );
1189 void OnKeyDown( wxKeyEvent
& );
1190 void OnEraseBackground( wxEraseEvent
& );
1193 void SetCurrentCell( const wxGridCellCoords
& coords
);
1194 void SetCurrentCell( int row
, int col
)
1195 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1198 // ------ functions to get/send data (see also public functions)
1200 bool GetModelValues();
1201 bool SetModelValues();
1204 DECLARE_DYNAMIC_CLASS( wxGrid
)
1205 DECLARE_EVENT_TABLE()
1213 // ------ Grid event class and event types
1216 class WXDLLEXPORT wxGridEvent
: public wxNotifyEvent
1220 : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
1221 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1225 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
1226 int row
=-1, int col
=-1, int x
=-1, int y
=-1,
1227 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1229 virtual int GetRow() { return m_row
; }
1230 virtual int GetCol() { return m_col
; }
1231 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1232 bool ControlDown() { return m_control
; }
1233 bool MetaDown() { return m_meta
; }
1234 bool ShiftDown() { return m_shift
; }
1235 bool AltDown() { return m_alt
; }
1247 DECLARE_DYNAMIC_CLASS(wxGridEvent
)
1251 class WXDLLEXPORT wxGridSizeEvent
: public wxNotifyEvent
1255 : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
1256 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1260 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
1261 int rowOrCol
=-1, int x
=-1, int y
=-1,
1262 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1264 int GetRowOrCol() { return m_rowOrCol
; }
1265 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1266 bool ControlDown() { return m_control
; }
1267 bool MetaDown() { return m_meta
; }
1268 bool ShiftDown() { return m_shift
; }
1269 bool AltDown() { return m_alt
; }
1280 DECLARE_DYNAMIC_CLASS(wxGridSizeEvent
)
1284 class WXDLLEXPORT wxGridRangeSelectEvent
: public wxNotifyEvent
1287 wxGridRangeSelectEvent()
1290 m_topLeft
= wxGridNoCellCoords
;
1291 m_bottomRight
= wxGridNoCellCoords
;
1298 wxGridRangeSelectEvent(int id
, wxEventType type
, wxObject
* obj
,
1299 const wxGridCellCoords
& topLeft
,
1300 const wxGridCellCoords
& bottomRight
,
1301 bool control
=FALSE
, bool shift
=FALSE
,
1302 bool alt
=FALSE
, bool meta
=FALSE
);
1304 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
1305 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
1306 int GetTopRow() { return m_topLeft
.GetRow(); }
1307 int GetBottomRow() { return m_bottomRight
.GetRow(); }
1308 int GetLeftCol() { return m_topLeft
.GetCol(); }
1309 int GetRightCol() { return m_bottomRight
.GetCol(); }
1310 bool ControlDown() { return m_control
; }
1311 bool MetaDown() { return m_meta
; }
1312 bool ShiftDown() { return m_shift
; }
1313 bool AltDown() { return m_alt
; }
1316 wxGridCellCoords m_topLeft
;
1317 wxGridCellCoords m_bottomRight
;
1323 DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent
)
1327 const wxEventType EVT_GRID_CELL_LEFT_CLICK
= wxEVT_FIRST
+ 1580;
1328 const wxEventType EVT_GRID_CELL_RIGHT_CLICK
= wxEVT_FIRST
+ 1581;
1329 const wxEventType EVT_GRID_CELL_LEFT_DCLICK
= wxEVT_FIRST
+ 1582;
1330 const wxEventType EVT_GRID_CELL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1583;
1331 const wxEventType EVT_GRID_LABEL_LEFT_CLICK
= wxEVT_FIRST
+ 1584;
1332 const wxEventType EVT_GRID_LABEL_RIGHT_CLICK
= wxEVT_FIRST
+ 1585;
1333 const wxEventType EVT_GRID_LABEL_LEFT_DCLICK
= wxEVT_FIRST
+ 1586;
1334 const wxEventType EVT_GRID_LABEL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1587;
1335 const wxEventType EVT_GRID_ROW_SIZE
= wxEVT_FIRST
+ 1588;
1336 const wxEventType EVT_GRID_COL_SIZE
= wxEVT_FIRST
+ 1589;
1337 const wxEventType EVT_GRID_RANGE_SELECT
= wxEVT_FIRST
+ 1590;
1338 const wxEventType EVT_GRID_CELL_CHANGE
= wxEVT_FIRST
+ 1591;
1339 const wxEventType EVT_GRID_SELECT_CELL
= wxEVT_FIRST
+ 1592;
1342 typedef void (wxEvtHandler
::*wxGridEventFunction
)(wxGridEvent
&);
1343 typedef void (wxEvtHandler
::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
1344 typedef void (wxEvtHandler
::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
1346 #define EVT_GRID_CELL_LEFT_CLICK(fn) { EVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1347 #define EVT_GRID_CELL_RIGHT_CLICK(fn) { EVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1348 #define EVT_GRID_CELL_LEFT_DCLICK(fn) { EVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1349 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) { EVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1350 #define EVT_GRID_LABEL_LEFT_CLICK(fn) { EVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1351 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) { EVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1352 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) { EVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1353 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) { EVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1354 #define EVT_GRID_ROW_SIZE(fn) { EVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1355 #define EVT_GRID_COL_SIZE(fn) { EVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1356 #define EVT_GRID_RANGE_SELECT(fn) { EVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
1357 #define EVT_GRID_CELL_CHANGE(fn) { EVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1358 #define EVT_GRID_SELECT_CELL(fn) { EVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1361 #if 0 // TODO: implement these ? others ?
1363 const wxEventType EVT_GRID_CREATE_CELL
= wxEVT_FIRST
+ 1576;
1364 const wxEventType EVT_GRID_CHANGE_LABELS
= wxEVT_FIRST
+ 1577;
1365 const wxEventType EVT_GRID_CHANGE_SEL_LABEL
= wxEVT_FIRST
+ 1578;
1367 #define EVT_GRID_CREATE_CELL(fn) { EVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1368 #define EVT_GRID_CHANGE_LABELS(fn) { EVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1369 #define EVT_GRID_CHANGE_SEL_LABEL(fn) { EVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1373 #endif // #ifndef __WXGRID_H__
1375 #endif // ifndef wxUSE_NEW_GRID