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)
8 // Copyright: (c) Michael Bedward
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
14 #if !defined(wxUSE_NEW_GRID) || !(wxUSE_NEW_GRID)
22 #pragma interface "grid.h"
27 #include "wx/scrolwin.h"
28 #include "wx/string.h"
29 #include "wx/scrolbar.h"
31 #include "wx/combobox.h"
32 #include "wx/dynarray.h"
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
39 // Default parameters for wxGrid
41 #define WXGRID_DEFAULT_NUMBER_ROWS 10
42 #define WXGRID_DEFAULT_NUMBER_COLS 10
44 #define WXGRID_DEFAULT_ROW_HEIGHT 25
46 #define WXGRID_DEFAULT_ROW_HEIGHT 30
48 #define WXGRID_DEFAULT_COL_WIDTH 80
49 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT 32
50 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH 82
51 #define WXGRID_LABEL_EDGE_ZONE 5
52 #define WXGRID_MIN_ROW_HEIGHT 15
53 #define WXGRID_MIN_COL_WIDTH 15
54 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH 16
56 // type names for grid table values
57 #define wxGRID_VALUE_STRING _T("string")
58 #define wxGRID_VALUE_BOOL _T("bool")
59 #define wxGRID_VALUE_NUMBER _T("long")
60 #define wxGRID_VALUE_FLOAT _T("double")
62 #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING
63 #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER
65 // ----------------------------------------------------------------------------
66 // forward declarations
67 // ----------------------------------------------------------------------------
69 class WXDLLEXPORT wxGrid
;
70 class WXDLLEXPORT wxGridCellAttr
;
71 class WXDLLEXPORT wxGridCellAttrProviderData
;
72 class WXDLLEXPORT wxGridColLabelWindow
;
73 class WXDLLEXPORT wxGridCornerLabelWindow
;
74 class WXDLLEXPORT wxGridRowLabelWindow
;
75 class WXDLLEXPORT wxGridTableBase
;
76 class WXDLLEXPORT wxGridWindow
;
77 class WXDLLEXPORT wxGridTypeRegistry
;
79 class WXDLLEXPORT wxCheckBox
;
80 class WXDLLEXPORT wxComboBox
;
81 class WXDLLEXPORT wxTextCtrl
;
82 class WXDLLEXPORT wxSpinCtrl
;
84 // ----------------------------------------------------------------------------
85 // wxGridCellRenderer: this class is responsible for actually drawing the cell
86 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
87 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
88 // view of all cells. This is an ABC, you will normally use one of the
89 // predefined derived classes or derive oyur own class from it.
90 // ----------------------------------------------------------------------------
92 class WXDLLEXPORT wxGridCellRenderer
95 // draw the given cell on the provided DC inside the given rectangle
96 // using the style specified by the attribute and the default or selected
97 // state corresponding to the isSelected value.
99 // this pure virtual function has a default implementation which will
100 // prepare the DC using the given attribute: it will draw the rectangle
101 // with the bg colour from attr and set the text colour and font
102 virtual void Draw(wxGrid
& grid
,
103 wxGridCellAttr
& attr
,
107 bool isSelected
) = 0;
109 // get the preferred size of the cell for its contents
110 virtual wxSize
GetBestSize(wxGrid
& grid
,
111 wxGridCellAttr
& attr
,
113 int row
, int col
) = 0;
115 // virtual dtor for any base class
116 virtual ~wxGridCellRenderer();
119 // the default renderer for the cells containing string data
120 class WXDLLEXPORT wxGridCellStringRenderer
: public wxGridCellRenderer
124 virtual void Draw(wxGrid
& grid
,
125 wxGridCellAttr
& attr
,
131 // return the string extent
132 virtual wxSize
GetBestSize(wxGrid
& grid
,
133 wxGridCellAttr
& attr
,
138 // set the text colours before drawing
139 void SetTextColoursAndFont(wxGrid
& grid
,
140 wxGridCellAttr
& attr
,
144 // calc the string extent for given string/font
145 wxSize
DoGetBestSize(wxGridCellAttr
& attr
,
147 const wxString
& text
);
150 // the default renderer for the cells containing numeric (long) data
151 class WXDLLEXPORT wxGridCellNumberRenderer
: public wxGridCellStringRenderer
154 // draw the string right aligned
155 virtual void Draw(wxGrid
& grid
,
156 wxGridCellAttr
& attr
,
162 virtual wxSize
GetBestSize(wxGrid
& grid
,
163 wxGridCellAttr
& attr
,
168 wxString
GetString(wxGrid
& grid
, int row
, int col
);
171 class WXDLLEXPORT wxGridCellFloatRenderer
: public wxGridCellStringRenderer
174 wxGridCellFloatRenderer(int width
, int precision
);
176 // get/change formatting parameters
177 int GetWidth() const { return m_width
; }
178 void SetWidth(int width
) { m_width
= width
; }
179 int GetPrecision() const { return m_precision
; }
180 void SetPrecision(int precision
) { m_precision
= precision
; }
182 // draw the string right aligned with given width/precision
183 virtual void Draw(wxGrid
& grid
,
184 wxGridCellAttr
& attr
,
190 virtual wxSize
GetBestSize(wxGrid
& grid
,
191 wxGridCellAttr
& attr
,
195 wxString
GetString(wxGrid
& grid
, int row
, int col
);
198 // formatting parameters
205 // renderer for boolean fields
206 class WXDLLEXPORT wxGridCellBoolRenderer
: public wxGridCellRenderer
209 // draw a check mark or nothing
210 virtual void Draw(wxGrid
& grid
,
211 wxGridCellAttr
& attr
,
217 // return the checkmark size
218 virtual wxSize
GetBestSize(wxGrid
& grid
,
219 wxGridCellAttr
& attr
,
224 static wxSize ms_sizeCheckMark
;
227 // ----------------------------------------------------------------------------
228 // wxGridCellEditor: This class is responsible for providing and manipulating
229 // the in-place edit controls for the grid. Instances of wxGridCellEditor
230 // (actually, instances of derived classes since it is an ABC) can be
231 // associated with the cell attributes for individual cells, rows, columns, or
232 // even for the entire grid.
233 // ----------------------------------------------------------------------------
235 class WXDLLEXPORT wxGridCellEditor
239 virtual ~wxGridCellEditor();
241 bool IsCreated() { return m_control
!= NULL
; }
243 // Creates the actual edit control
244 virtual void Create(wxWindow
* parent
,
246 wxEvtHandler
* evtHandler
) = 0;
248 // Size and position the edit control
249 virtual void SetSize(const wxRect
& rect
);
251 // Show or hide the edit control, use the specified attributes to set
252 // colours/fonts for it
253 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
255 // Draws the part of the cell not occupied by the control: the base class
256 // version just fills it with background colour from the attribute
257 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
259 // Fetch the value from the table and prepare the edit control
260 // to begin editing. Set the focus to the edit control.
261 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
263 // Complete the editing of the current cell. If saveValue is
264 // true then send the new value back to the table. Returns true
265 // if the value has changed. If necessary, the control may be
267 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
) = 0;
269 // Reset the value in the control back to its starting value
270 virtual void Reset() = 0;
272 // If the editor is enabled by pressing keys on the grid,
273 // this will be called to let the editor do something about
274 // that first key if desired.
275 virtual void StartingKey(wxKeyEvent
& event
);
277 // if the editor is enabled by clicking on the cell, this method will be
279 virtual void StartingClick();
281 // Some types of controls on some platforms may need some help
282 // with the Return key.
283 virtual void HandleReturn(wxKeyEvent
& event
);
286 virtual void Destroy();
289 // the control we show on screen
290 wxControl
* m_control
;
292 // if we change the colours/font of the control from the default ones, we
293 // must restore the default later and we save them here between calls to
294 // Show(TRUE) and Show(FALSE)
300 // the editor for string/text data
301 class WXDLLEXPORT wxGridCellTextEditor
: public wxGridCellEditor
304 wxGridCellTextEditor();
306 virtual void Create(wxWindow
* parent
,
308 wxEvtHandler
* evtHandler
);
309 virtual void SetSize(const wxRect
& rect
);
311 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
313 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
314 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
316 virtual void Reset();
317 virtual void StartingKey(wxKeyEvent
& event
);
318 virtual void HandleReturn(wxKeyEvent
& event
);
321 wxTextCtrl
*Text() const { return (wxTextCtrl
*)m_control
; }
323 // parts of our virtual functions reused by the derived classes
324 void DoBeginEdit(const wxString
& startValue
);
325 void DoReset(const wxString
& startValue
);
328 wxString m_startValue
;
331 // the editor for numeric (long) data
332 class WXDLLEXPORT wxGridCellNumberEditor
: public wxGridCellTextEditor
335 // allows to specify the range - if min == max == -1, no range checking is
337 wxGridCellNumberEditor(int min
= -1, int max
= -1);
339 virtual void Create(wxWindow
* parent
,
341 wxEvtHandler
* evtHandler
);
343 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
344 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
346 virtual void Reset();
347 virtual void StartingKey(wxKeyEvent
& event
);
350 wxSpinCtrl
*Spin() const { return (wxSpinCtrl
*)m_control
; }
352 // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl
353 bool HasRange() const { return m_min
!= m_max
; }
355 // string representation of m_valueOld
356 wxString
GetString() const
357 { return wxString
::Format(_T("%ld"), m_valueOld
); }
366 // the editor for floating point numbers (double) data
367 class WXDLLEXPORT wxGridCellFloatEditor
: public wxGridCellTextEditor
370 virtual void Create(wxWindow
* parent
,
372 wxEvtHandler
* evtHandler
);
374 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
375 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
377 virtual void Reset();
378 virtual void StartingKey(wxKeyEvent
& event
);
381 // string representation of m_valueOld
382 wxString
GetString() const
383 { return wxString
::Format(_T("%f"), m_valueOld
); }
389 // the editor for boolean data
390 class WXDLLEXPORT wxGridCellBoolEditor
: public wxGridCellEditor
393 virtual void Create(wxWindow
* parent
,
395 wxEvtHandler
* evtHandler
);
397 virtual void SetSize(const wxRect
& rect
);
398 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
400 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
401 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
403 virtual void Reset();
404 virtual void StartingClick();
407 wxCheckBox
*CBox() const { return (wxCheckBox
*)m_control
; }
413 // the editor for string data allowing to choose from the list of strings
414 class WXDLLEXPORT wxGridCellChoiceEditor
: public wxGridCellEditor
417 // if !allowOthers, user can't type a string not in choices array
418 wxGridCellChoiceEditor(size_t count
, const wxChar
* choices
[],
419 bool allowOthers
= FALSE
);
421 virtual void Create(wxWindow
* parent
,
423 wxEvtHandler
* evtHandler
);
425 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
427 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
428 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
430 virtual void Reset();
433 wxComboBox
*Combo() const { return (wxComboBox
*)m_control
; }
436 wxString m_startValue
;
437 wxArrayString m_choices
;
440 // ----------------------------------------------------------------------------
441 // wxGridCellAttr: this class can be used to alter the cells appearance in
442 // the grid by changing their colour/font/... from default. An object of this
443 // class may be returned by wxGridTable::GetAttr().
444 // ----------------------------------------------------------------------------
446 class WXDLLEXPORT wxGridCellAttr
456 // VZ: considering the number of members wxGridCellAttr has now, this ctor
457 // seems to be pretty useless... may be we should just remove it?
458 wxGridCellAttr(const wxColour
& colText
,
459 const wxColour
& colBack
,
463 : m_colText(colText
), m_colBack(colBack
), m_font(font
)
466 SetAlignment(hAlign
, vAlign
);
469 // default copy ctor ok
471 // this class is ref counted: it is created with ref count of 1, so
472 // calling DecRef() once will delete it. Calling IncRef() allows to lock
473 // it until the matching DecRef() is called
474 void IncRef() { m_nRef
++; }
475 void DecRef() { if ( !--m_nRef
) delete this; }
476 void SafeIncRef() { if ( this ) IncRef(); }
477 void SafeDecRef() { if ( this ) DecRef(); }
480 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
481 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
482 void SetFont(const wxFont
& font
) { m_font
= font
; }
483 void SetAlignment(int hAlign
, int vAlign
)
488 void SetReadOnly(bool isReadOnly
= TRUE
) { m_isReadOnly
= isReadOnly
; }
490 // takes ownership of the pointer
491 void SetRenderer(wxGridCellRenderer
*renderer
)
492 { delete m_renderer
; m_renderer
= renderer
; }
493 void SetEditor(wxGridCellEditor
* editor
)
494 { delete m_editor
; m_editor
= editor
; }
497 bool HasTextColour() const { return m_colText
.Ok(); }
498 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
499 bool HasFont() const { return m_font
.Ok(); }
500 bool HasAlignment() const { return m_hAlign
|| m_vAlign
; }
501 bool HasRenderer() const { return m_renderer
!= NULL
; }
502 bool HasEditor() const { return m_editor
!= NULL
; }
504 const wxColour
& GetTextColour() const;
505 const wxColour
& GetBackgroundColour() const;
506 const wxFont
& GetFont() const;
507 void GetAlignment(int *hAlign
, int *vAlign
) const;
508 wxGridCellRenderer
*GetRenderer(wxGrid
* grid
, int row
, int col
) const;
509 wxGridCellEditor
*GetEditor(wxGrid
* grid
, int row
, int col
) const;
511 bool IsReadOnly() const { return m_isReadOnly
; }
513 void SetDefAttr(wxGridCellAttr
* defAttr
) { m_defGridAttr
= defAttr
; }
516 // the common part of all ctors
521 m_isReadOnly
= FALSE
;
527 // the dtor is private because only DecRef() can delete us
528 ~wxGridCellAttr() { delete m_renderer
; delete m_editor
; }
530 // the ref count - when it goes to 0, we die
539 wxGridCellRenderer
* m_renderer
;
540 wxGridCellEditor
* m_editor
;
541 wxGridCellAttr
* m_defGridAttr
;
545 // suppress the stupid gcc warning about the class having private dtor and
547 friend class wxGridCellAttrDummyFriend
;
550 // ----------------------------------------------------------------------------
551 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
553 // ----------------------------------------------------------------------------
555 // implementation note: we separate it from wxGridTableBase because we wish to
556 // avoid deriving a new table class if possible, and sometimes it will be
557 // enough to just derive another wxGridCellAttrProvider instead
559 // the default implementation is reasonably efficient for the generic case,
560 // but you might still wish to implement your own for some specific situations
561 // if you have performance problems with the stock one
562 class WXDLLEXPORT wxGridCellAttrProvider
565 wxGridCellAttrProvider();
566 virtual ~wxGridCellAttrProvider();
568 // DecRef() must be called on the returned pointer
569 virtual wxGridCellAttr
*GetAttr(int row
, int col
) const;
571 // all these functions take ownership of the pointer, don't call DecRef()
573 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
574 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
575 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
577 // these functions must be called whenever some rows/cols are deleted
578 // because the internal data must be updated then
579 void UpdateAttrRows( size_t pos
, int numRows
);
580 void UpdateAttrCols( size_t pos
, int numCols
);
585 wxGridCellAttrProviderData
*m_data
;
588 //////////////////////////////////////////////////////////////////////
590 // Grid table classes
592 //////////////////////////////////////////////////////////////////////
595 class WXDLLEXPORT wxGridTableBase
: public wxObject
599 virtual ~wxGridTableBase();
601 // You must override these functions in a derived table class
603 virtual long GetNumberRows() = 0;
604 virtual long GetNumberCols() = 0;
605 virtual bool IsEmptyCell( int row
, int col
) = 0;
606 virtual wxString
GetValue( int row
, int col
) = 0;
607 virtual void SetValue( int row
, int col
, const wxString
& value
) = 0;
609 // Data type determination and value access
610 virtual wxString
GetTypeName( int row
, int col
);
611 virtual bool CanGetValueAs( int row
, int col
, const wxString
& typeName
);
612 virtual bool CanSetValueAs( int row
, int col
, const wxString
& typeName
);
614 virtual long GetValueAsLong( int row
, int col
);
615 virtual double GetValueAsDouble( int row
, int col
);
616 virtual bool GetValueAsBool( int row
, int col
);
618 virtual void SetValueAsLong( int row
, int col
, long value
);
619 virtual void SetValueAsDouble( int row
, int col
, double value
);
620 virtual void SetValueAsBool( int row
, int col
, bool value
);
622 // For user defined types
623 virtual void* GetValueAsCustom( int row
, int col
, const wxString
& typeName
);
624 virtual void SetValueAsCustom( int row
, int col
, const wxString
& typeName
, void* value
);
627 // Overriding these is optional
629 virtual void SetView( wxGrid
*grid
) { m_view
= grid
; }
630 virtual wxGrid
* GetView() const { return m_view
; }
632 virtual void Clear() {}
633 virtual bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
634 virtual bool AppendRows( size_t numRows
= 1 );
635 virtual bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
636 virtual bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
637 virtual bool AppendCols( size_t numCols
= 1 );
638 virtual bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
640 virtual wxString
GetRowLabelValue( int row
);
641 virtual wxString
GetColLabelValue( int col
);
642 virtual void SetRowLabelValue( int WXUNUSED(row
), const wxString
& ) {}
643 virtual void SetColLabelValue( int WXUNUSED(col
), const wxString
& ) {}
645 // Attribute handling
648 // give us the attr provider to use - we take ownership of the pointer
649 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
651 // get the currently used attr provider (may be NULL)
652 wxGridCellAttrProvider
*GetAttrProvider() const { return m_attrProvider
; }
654 // Does this table allow attributes? Default implementation creates
655 // a wxGridCellAttrProvider if necessary.
656 virtual bool CanHaveAttributes();
659 // change row/col number in attribute if needed
660 virtual void UpdateAttrRows( size_t pos
, int numRows
);
661 virtual void UpdateAttrCols( size_t pos
, int numCols
);
663 // by default forwarded to wxGridCellAttrProvider if any. May be
664 // overridden to handle attributes directly in the table.
665 virtual wxGridCellAttr
*GetAttr( int row
, int col
);
667 // these functions take ownership of the pointer
668 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
669 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
670 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
674 wxGridCellAttrProvider
*m_attrProvider
;
676 DECLARE_ABSTRACT_CLASS( wxGridTableBase
);
680 // ----------------------------------------------------------------------------
681 // wxGridTableMessage
682 // ----------------------------------------------------------------------------
684 // IDs for messages sent from grid table to view
686 enum wxGridTableRequest
688 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
= 2000,
689 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES
,
690 wxGRIDTABLE_NOTIFY_ROWS_INSERTED
,
691 wxGRIDTABLE_NOTIFY_ROWS_APPENDED
,
692 wxGRIDTABLE_NOTIFY_ROWS_DELETED
,
693 wxGRIDTABLE_NOTIFY_COLS_INSERTED
,
694 wxGRIDTABLE_NOTIFY_COLS_APPENDED
,
695 wxGRIDTABLE_NOTIFY_COLS_DELETED
698 class WXDLLEXPORT wxGridTableMessage
701 wxGridTableMessage();
702 wxGridTableMessage( wxGridTableBase
*table
, int id
,
706 void SetTableObject( wxGridTableBase
*table
) { m_table
= table
; }
707 wxGridTableBase
* GetTableObject() const { return m_table
; }
708 void SetId( int id
) { m_id
= id
; }
709 int GetId() { return m_id
; }
710 void SetCommandInt( int comInt1
) { m_comInt1
= comInt1
; }
711 int GetCommandInt() { return m_comInt1
; }
712 void SetCommandInt2( int comInt2
) { m_comInt2
= comInt2
; }
713 int GetCommandInt2() { return m_comInt2
; }
716 wxGridTableBase
*m_table
;
724 // ------ wxGridStringArray
725 // A 2-dimensional array of strings for data values
728 WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString
, wxGridStringArray
);
732 // ------ wxGridStringTable
734 // Simplest type of data table for a grid for small tables of strings
735 // that are stored in memory
738 class WXDLLEXPORT wxGridStringTable
: public wxGridTableBase
742 wxGridStringTable( int numRows
, int numCols
);
743 ~wxGridStringTable();
745 // these are pure virtual in wxGridTableBase
747 long GetNumberRows();
748 long GetNumberCols();
749 wxString
GetValue( int row
, int col
);
750 void SetValue( int row
, int col
, const wxString
& s
);
751 bool IsEmptyCell( int row
, int col
);
753 // overridden functions from wxGridTableBase
756 bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
757 bool AppendRows( size_t numRows
= 1 );
758 bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
759 bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
760 bool AppendCols( size_t numCols
= 1 );
761 bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
763 void SetRowLabelValue( int row
, const wxString
& );
764 void SetColLabelValue( int col
, const wxString
& );
765 wxString
GetRowLabelValue( int row
);
766 wxString
GetColLabelValue( int col
);
769 wxGridStringArray m_data
;
771 // These only get used if you set your own labels, otherwise the
772 // GetRow/ColLabelValue functions return wxGridTableBase defaults
774 wxArrayString m_rowLabels
;
775 wxArrayString m_colLabels
;
777 DECLARE_DYNAMIC_CLASS( wxGridStringTable
)
782 // ============================================================================
784 // ============================================================================
786 // ----------------------------------------------------------------------------
787 // wxGridCellCoords: location of a cell in the grid
788 // ----------------------------------------------------------------------------
790 class WXDLLEXPORT wxGridCellCoords
793 wxGridCellCoords() { m_row
= m_col
= -1; }
794 wxGridCellCoords( int r
, int c
) { m_row
= r
; m_col
= c
; }
796 // default copy ctor is ok
798 long GetRow() const { return m_row
; }
799 void SetRow( long n
) { m_row
= n
; }
800 long GetCol() const { return m_col
; }
801 void SetCol( long n
) { m_col
= n
; }
802 void Set( long row
, long col
) { m_row
= row
; m_col
= col
; }
804 wxGridCellCoords
& operator=( const wxGridCellCoords
& other
)
806 if ( &other
!= this )
814 bool operator==( const wxGridCellCoords
& other
) const
816 return (m_row
== other
.m_row
&& m_col
== other
.m_col
);
819 bool operator!=( const wxGridCellCoords
& other
) const
821 return (m_row
!= other
.m_row
|| m_col
!= other
.m_col
);
824 bool operator!() const
826 return (m_row
== -1 && m_col
== -1 );
835 // For comparisons...
837 extern wxGridCellCoords wxGridNoCellCoords
;
838 extern wxRect wxGridNoCellRect
;
840 // An array of cell coords...
842 WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords
, wxGridCellCoordsArray
);
844 // ----------------------------------------------------------------------------
846 // ----------------------------------------------------------------------------
848 class WXDLLEXPORT wxGrid
: public wxScrolledWindow
856 wxGrid( wxWindow
*parent
,
858 const wxPoint
& pos
= wxDefaultPosition
,
859 const wxSize
& size
= wxDefaultSize
,
861 const wxString
& name
= wxPanelNameStr
);
865 bool CreateGrid( int numRows
, int numCols
);
868 // ------ grid dimensions
870 int GetNumberRows() { return m_numRows
; }
871 int GetNumberCols() { return m_numCols
; }
874 // ------ display update functions
876 void CalcRowLabelsExposed( wxRegion
& reg
);
878 void CalcColLabelsExposed( wxRegion
& reg
);
879 void CalcCellsExposed( wxRegion
& reg
);
882 // ------ event handlers
884 void ProcessRowLabelMouseEvent( wxMouseEvent
& event
);
885 void ProcessColLabelMouseEvent( wxMouseEvent
& event
);
886 void ProcessCornerLabelMouseEvent( wxMouseEvent
& event
);
887 void ProcessGridCellMouseEvent( wxMouseEvent
& event
);
888 bool ProcessTableMessage( wxGridTableMessage
& );
890 void DoEndDragResizeRow();
891 void DoEndDragResizeCol();
893 wxGridTableBase
* GetTable() const { return m_table
; }
894 bool SetTable( wxGridTableBase
*table
, bool takeOwnership
=FALSE
);
897 bool InsertRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
898 bool AppendRows( int numRows
= 1, bool updateLabels
=TRUE
);
899 bool DeleteRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
900 bool InsertCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
901 bool AppendCols( int numCols
= 1, bool updateLabels
=TRUE
);
902 bool DeleteCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
904 void DrawGridCellArea( wxDC
& dc
);
905 void DrawCellBorder( wxDC
& dc
, const wxGridCellCoords
& );
906 void DrawAllGridLines( wxDC
& dc
, const wxRegion
& reg
);
907 void DrawCell( wxDC
& dc
, const wxGridCellCoords
& );
908 void DrawHighlight(wxDC
& dc
);
910 // this function is called when the current cell highlight must be redrawn
911 // and may be overridden by the user
912 virtual void DrawCellHighlight( wxDC
& dc
, const wxGridCellAttr
*attr
);
914 void DrawRowLabels( wxDC
& dc
);
915 void DrawRowLabel( wxDC
& dc
, int row
);
917 void DrawColLabels( wxDC
& dc
);
918 void DrawColLabel( wxDC
& dc
, int col
);
921 // ------ Cell text drawing functions
923 void DrawTextRectangle( wxDC
& dc
, const wxString
&, const wxRect
&,
924 int horizontalAlignment
= wxLEFT
,
925 int verticalAlignment
= wxTOP
);
927 // Split a string containing newline chararcters into an array of
928 // strings and return the number of lines
930 void StringToLines( const wxString
& value
, wxArrayString
& lines
);
932 void GetTextBoxSize( wxDC
& dc
,
933 wxArrayString
& lines
,
934 long *width
, long *height
);
938 // Code that does a lot of grid modification can be enclosed
939 // between BeginBatch() and EndBatch() calls to avoid screen
942 void BeginBatch() { m_batchCount
++; }
943 void EndBatch() { if ( m_batchCount
> 0 ) m_batchCount
--; }
944 int GetBatchCount() { return m_batchCount
; }
947 // ------ edit control functions
949 bool IsEditable() { return m_editable
; }
950 void EnableEditing( bool edit
);
952 void EnableCellEditControl( bool enable
= TRUE
);
953 void DisableCellEditControl() { EnableCellEditControl(FALSE
); }
954 bool CanEnableCellControl() const;
955 bool IsCellEditControlEnabled() const;
957 bool IsCurrentCellReadOnly() const;
959 void ShowCellEditControl();
960 void HideCellEditControl();
961 void SaveEditControlValue();
964 // ------ grid location functions
965 // Note that all of these functions work with the logical coordinates of
966 // grid cells and labels so you will need to convert from device
967 // coordinates for mouse events etc.
969 void XYToCell( int x
, int y
, wxGridCellCoords
& );
973 int YToEdgeOfRow( int y
);
974 int XToEdgeOfCol( int x
);
976 wxRect
CellToRect( int row
, int col
);
977 wxRect
CellToRect( const wxGridCellCoords
& coords
)
978 { return CellToRect( coords
.GetRow(), coords
.GetCol() ); }
980 int GetGridCursorRow() { return m_currentCellCoords
.GetRow(); }
981 int GetGridCursorCol() { return m_currentCellCoords
.GetCol(); }
983 // check to see if a cell is either wholly visible (the default arg) or
984 // at least partially visible in the grid window
986 bool IsVisible( int row
, int col
, bool wholeCellVisible
= TRUE
);
987 bool IsVisible( const wxGridCellCoords
& coords
, bool wholeCellVisible
= TRUE
)
988 { return IsVisible( coords
.GetRow(), coords
.GetCol(), wholeCellVisible
); }
989 void MakeCellVisible( int row
, int col
);
990 void MakeCellVisible( const wxGridCellCoords
& coords
)
991 { MakeCellVisible( coords
.GetRow(), coords
.GetCol() ); }
994 // ------ grid cursor movement functions
996 void SetGridCursor( int row
, int col
)
997 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1000 bool MoveCursorDown();
1001 bool MoveCursorLeft();
1002 bool MoveCursorRight();
1003 bool MovePageDown();
1005 bool MoveCursorUpBlock();
1006 bool MoveCursorDownBlock();
1007 bool MoveCursorLeftBlock();
1008 bool MoveCursorRightBlock();
1011 // ------ label and gridline formatting
1013 int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH
; }
1014 int GetRowLabelSize() { return m_rowLabelWidth
; }
1015 int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT
; }
1016 int GetColLabelSize() { return m_colLabelHeight
; }
1017 wxColour
GetLabelBackgroundColour() { return m_labelBackgroundColour
; }
1018 wxColour
GetLabelTextColour() { return m_labelTextColour
; }
1019 wxFont
GetLabelFont() { return m_labelFont
; }
1020 void GetRowLabelAlignment( int *horiz
, int *vert
);
1021 void GetColLabelAlignment( int *horiz
, int *vert
);
1022 wxString
GetRowLabelValue( int row
);
1023 wxString
GetColLabelValue( int col
);
1024 wxColour
GetGridLineColour() { return m_gridLineColour
; }
1026 void SetRowLabelSize( int width
);
1027 void SetColLabelSize( int height
);
1028 void SetLabelBackgroundColour( const wxColour
& );
1029 void SetLabelTextColour( const wxColour
& );
1030 void SetLabelFont( const wxFont
& );
1031 void SetRowLabelAlignment( int horiz
, int vert
);
1032 void SetColLabelAlignment( int horiz
, int vert
);
1033 void SetRowLabelValue( int row
, const wxString
& );
1034 void SetColLabelValue( int col
, const wxString
& );
1035 void SetGridLineColour( const wxColour
& );
1037 void EnableDragRowSize( bool enable
= TRUE
);
1038 void DisableDragRowSize() { EnableDragRowSize( FALSE
); }
1039 bool CanDragRowSize() { return m_canDragRowSize
; }
1040 void EnableDragColSize( bool enable
= TRUE
);
1041 void DisableDragColSize() { EnableDragColSize( FALSE
); }
1042 bool CanDragColSize() { return m_canDragColSize
; }
1043 void EnableDragGridSize(bool enable
= TRUE
);
1044 void DisableDragGridSize() { EnableDragGridSize(FALSE
); }
1045 bool CanDragGridSize() { return m_canDragGridSize
; }
1048 // this sets the specified attribute for all cells in this row/col
1049 void SetRowAttr(int row
, wxGridCellAttr
*attr
);
1050 void SetColAttr(int col
, wxGridCellAttr
*attr
);
1052 void EnableGridLines( bool enable
= TRUE
);
1053 bool GridLinesEnabled() { return m_gridLinesEnabled
; }
1055 // ------ row and col formatting
1057 int GetDefaultRowSize();
1058 int GetRowSize( int row
);
1059 int GetDefaultColSize();
1060 int GetColSize( int col
);
1061 wxColour
GetDefaultCellBackgroundColour();
1062 wxColour
GetCellBackgroundColour( int row
, int col
);
1063 wxColour
GetDefaultCellTextColour();
1064 wxColour
GetCellTextColour( int row
, int col
);
1065 wxFont
GetDefaultCellFont();
1066 wxFont
GetCellFont( int row
, int col
);
1067 void GetDefaultCellAlignment( int *horiz
, int *vert
);
1068 void GetCellAlignment( int row
, int col
, int *horiz
, int *vert
);
1070 void SetDefaultRowSize( int height
, bool resizeExistingRows
= FALSE
);
1071 void SetRowSize( int row
, int height
);
1072 void SetDefaultColSize( int width
, bool resizeExistingCols
= FALSE
);
1074 void SetColSize( int col
, int width
);
1076 // automatically size the column to fit to its contents, if setAsMin is
1077 // TRUE, this optimal width will also be set as minimal width for this
1079 void AutoSizeColumn( int col
, bool setAsMin
= TRUE
);
1081 // auto size all columns (very ineffective for big grids!)
1082 void AutoSizeColumns( bool setAsMin
= TRUE
);
1084 // column won't be resized to be lesser width - this must be called during
1085 // the grid creation because it won't resize the column if it's already
1086 // narrower than the minimal width
1087 void SetColMinimalWidth( int col
, int width
);
1089 void SetDefaultCellBackgroundColour( const wxColour
& );
1090 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
1091 void SetDefaultCellTextColour( const wxColour
& );
1093 void SetCellTextColour( int row
, int col
, const wxColour
& );
1094 void SetDefaultCellFont( const wxFont
& );
1095 void SetCellFont( int row
, int col
, const wxFont
& );
1096 void SetDefaultCellAlignment( int horiz
, int vert
);
1097 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
1099 // takes ownership of the pointer
1100 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
1101 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
1102 wxGridCellRenderer
*GetDefaultRenderer() const;
1103 wxGridCellRenderer
* GetCellRenderer(int row
, int col
);
1105 // takes ownership of the pointer
1106 void SetDefaultEditor(wxGridCellEditor
*editor
);
1107 void SetCellEditor(int row
, int col
, wxGridCellEditor
*editor
);
1108 wxGridCellEditor
*GetDefaultEditor() const;
1109 wxGridCellEditor
* GetCellEditor(int row
, int col
);
1113 // ------ cell value accessors
1115 wxString
GetCellValue( int row
, int col
)
1119 return m_table
->GetValue( row
, col
);
1123 return wxEmptyString
;
1127 wxString
GetCellValue( const wxGridCellCoords
& coords
)
1128 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
1130 void SetCellValue( int row
, int col
, const wxString
& s
);
1131 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
1132 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
1134 // returns TRUE if the cell can't be edited
1135 bool IsReadOnly(int row
, int col
) const;
1137 // make the cell editable/readonly
1138 void SetReadOnly(int row
, int col
, bool isReadOnly
= TRUE
);
1140 // ------ selections of blocks of cells
1142 void SelectRow( int row
, bool addToSelected
= FALSE
);
1143 void SelectCol( int col
, bool addToSelected
= FALSE
);
1145 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
);
1147 void SelectBlock( const wxGridCellCoords
& topLeft
,
1148 const wxGridCellCoords
& bottomRight
)
1149 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
1150 bottomRight
.GetRow(), bottomRight
.GetCol() ); }
1155 { return ( m_selectedTopLeft
!= wxGridNoCellCoords
&&
1156 m_selectedBottomRight
!= wxGridNoCellCoords
);
1159 void ClearSelection();
1161 bool IsInSelection( int row
, int col
)
1162 { return ( IsSelection() &&
1163 row
>= m_selectedTopLeft
.GetRow() &&
1164 col
>= m_selectedTopLeft
.GetCol() &&
1165 row
<= m_selectedBottomRight
.GetRow() &&
1166 col
<= m_selectedBottomRight
.GetCol() );
1169 bool IsInSelection( const wxGridCellCoords
& coords
)
1170 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
1172 void GetSelection( int* topRow
, int* leftCol
, int* bottomRow
, int* rightCol
)
1174 // these will all be -1 if there is no selected block
1176 *topRow
= m_selectedTopLeft
.GetRow();
1177 *leftCol
= m_selectedTopLeft
.GetCol();
1178 *bottomRow
= m_selectedBottomRight
.GetRow();
1179 *rightCol
= m_selectedBottomRight
.GetCol();
1183 // This function returns the rectangle that encloses the block of cells
1184 // limited by TopLeft and BottomRight cell in device coords and clipped
1185 // to the client size of the grid window.
1187 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
1188 const wxGridCellCoords
& bottomRight
);
1190 // This function returns the rectangle that encloses the selected cells
1191 // in device coords and clipped to the client size of the grid window.
1193 wxRect
SelectionToDeviceRect()
1195 return BlockToDeviceRect( m_selectedTopLeft
,
1196 m_selectedBottomRight
);
1199 // Access or update the selection fore/back colours
1200 wxColour
GetSelectionBackground() const
1201 { return m_selectionBackground
; }
1202 wxColour
GetSelectionForeground() const
1203 { return m_selectionForeground
; }
1205 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
1206 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
1209 // Methods for a registry for mapping data types to Renderers/Editors
1210 void RegisterDataType(const wxString
& typeName
,
1211 wxGridCellRenderer
* renderer
,
1212 wxGridCellEditor
* editor
);
1213 wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1214 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const
1215 { return GetDefaultEditorForCell(c
.GetRow(), c
.GetCol()); }
1216 wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
1217 wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
1218 wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
1222 // ------ For compatibility with previous wxGrid only...
1224 // ************************************************
1225 // ** Don't use these in new code because they **
1226 // ** are liable to disappear in a future **
1228 // ************************************************
1231 wxGrid( wxWindow
*parent
,
1232 int x
, int y
, int w
= -1, int h
= -1,
1234 const wxString
& name
= wxPanelNameStr
)
1235 : wxScrolledWindow( parent
, -1, wxPoint(x
,y
), wxSize(w
,h
), style
, name
)
1240 void SetCellValue( const wxString
& val
, int row
, int col
)
1241 { SetCellValue( row
, col
, val
); }
1243 void UpdateDimensions()
1244 { CalcDimensions(); }
1246 int GetRows() { return GetNumberRows(); }
1247 int GetCols() { return GetNumberCols(); }
1248 int GetCursorRow() { return GetGridCursorRow(); }
1249 int GetCursorColumn() { return GetGridCursorCol(); }
1251 int GetScrollPosX() { return 0; }
1252 int GetScrollPosY() { return 0; }
1254 void SetScrollX( int x
) { }
1255 void SetScrollY( int y
) { }
1257 void SetColumnWidth( int col
, int width
)
1258 { SetColSize( col
, width
); }
1260 int GetColumnWidth( int col
)
1261 { return GetColSize( col
); }
1263 void SetRowHeight( int row
, int height
)
1264 { SetRowSize( row
, height
); }
1266 // GetRowHeight() is below
1268 int GetViewHeight() // returned num whole rows visible
1271 int GetViewWidth() // returned num whole cols visible
1274 void SetLabelSize( int orientation
, int sz
)
1276 if ( orientation
== wxHORIZONTAL
)
1277 SetColLabelSize( sz
);
1279 SetRowLabelSize( sz
);
1282 int GetLabelSize( int orientation
)
1284 if ( orientation
== wxHORIZONTAL
)
1285 return GetColLabelSize();
1287 return GetRowLabelSize();
1290 void SetLabelAlignment( int orientation
, int align
)
1292 if ( orientation
== wxHORIZONTAL
)
1293 SetColLabelAlignment( align
, -1 );
1295 SetRowLabelAlignment( align
, -1 );
1298 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) )
1301 if ( orientation
== wxHORIZONTAL
)
1303 GetColLabelAlignment( &h
, &v
);
1308 GetRowLabelAlignment( &h
, &v
);
1313 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
1315 if ( orientation
== wxHORIZONTAL
)
1316 SetColLabelValue( pos
, val
);
1318 SetRowLabelValue( pos
, val
);
1321 wxString
GetLabelValue( int orientation
, int pos
)
1323 if ( orientation
== wxHORIZONTAL
)
1324 return GetColLabelValue( pos
);
1326 return GetRowLabelValue( pos
);
1329 wxFont
GetCellTextFont() const
1330 { return m_defaultCellAttr
->GetFont(); }
1332 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
1333 { return m_defaultCellAttr
->GetFont(); }
1335 void SetCellTextFont(const wxFont
& fnt
)
1336 { SetDefaultCellFont( fnt
); }
1338 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
1339 { SetCellFont( row
, col
, fnt
); }
1341 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
1342 { SetCellTextColour( row
, col
, val
); }
1344 void SetCellTextColour(const wxColour
& col
)
1345 { SetDefaultCellTextColour( col
); }
1347 void SetCellBackgroundColour(const wxColour
& col
)
1348 { SetDefaultCellBackgroundColour( col
); }
1350 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1351 { SetCellBackgroundColour( row
, col
, colour
); }
1353 bool GetEditable() { return IsEditable(); }
1354 void SetEditable( bool edit
= TRUE
) { EnableEditing( edit
); }
1355 bool GetEditInPlace() { return IsCellEditControlEnabled(); }
1357 void SetEditInPlace(bool edit
= TRUE
) { }
1359 void SetCellAlignment( int align
, int row
, int col
)
1360 { SetCellAlignment(row
, col
, align
, wxCENTER
); }
1361 void SetCellAlignment( int WXUNUSED(align
) ) {}
1362 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1364 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1365 wxPen
& GetDividerPen() const { return wxNullPen
; }
1366 void OnActivate(bool WXUNUSED(active
)) {}
1368 // ******** End of compatibility functions **********
1372 // ------ control IDs
1373 enum { wxGRID_CELLCTRL
= 2000,
1376 // ------ control types
1377 enum { wxGRID_TEXTCTRL
= 2100,
1386 wxGridWindow
*m_gridWin
;
1387 wxGridRowLabelWindow
*m_rowLabelWin
;
1388 wxGridColLabelWindow
*m_colLabelWin
;
1389 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1391 wxGridTableBase
*m_table
;
1402 wxGridCellCoords m_currentCellCoords
;
1404 wxGridCellCoords m_selectedTopLeft
;
1405 wxGridCellCoords m_selectedBottomRight
;
1406 wxColour m_selectionBackground
;
1407 wxColour m_selectionForeground
;
1409 // NB: *never* access m_row/col arrays directly because they are created
1410 // on demand, *always* use accessor functions instead!
1412 // init the m_rowHeights/Bottoms arrays with default values
1413 void InitRowHeights();
1415 int m_defaultRowHeight
;
1416 wxArrayInt m_rowHeights
;
1417 wxArrayInt m_rowBottoms
;
1419 // init the m_colWidths/Rights arrays
1420 void InitColWidths();
1422 int m_defaultColWidth
;
1423 wxArrayInt m_colWidths
;
1424 wxArrayInt m_colRights
;
1426 // get the col/row coords
1427 int GetColWidth(int col
) const;
1428 int GetColLeft(int col
) const;
1429 int GetColRight(int col
) const;
1431 // this function must be public for compatibility...
1433 int GetRowHeight(int row
) const;
1436 int GetRowTop(int row
) const;
1437 int GetRowBottom(int row
) const;
1439 int m_rowLabelWidth
;
1440 int m_colLabelHeight
;
1442 wxColour m_labelBackgroundColour
;
1443 wxColour m_labelTextColour
;
1446 int m_rowLabelHorizAlign
;
1447 int m_rowLabelVertAlign
;
1448 int m_colLabelHorizAlign
;
1449 int m_colLabelVertAlign
;
1451 bool m_defaultRowLabelValues
;
1452 bool m_defaultColLabelValues
;
1454 wxColour m_gridLineColour
;
1455 bool m_gridLinesEnabled
;
1457 // if a column has a minimal width, it will be the value for it in this
1459 wxHashTable m_colMinWidths
;
1461 // get the minimal width of the given column
1462 int GetColMinimalWidth(int col
) const;
1464 // do we have some place to store attributes in?
1465 bool CanHaveAttributes();
1467 // returns the attribute we may modify in place: a new one if this cell
1468 // doesn't have any yet or the existing one if it does
1470 // DecRef() must be called on the returned pointer, as usual
1471 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1473 // cell attribute cache (currently we only cache 1, may be will do
1474 // more/better later)
1478 wxGridCellAttr
*attr
;
1481 // invalidates the attribute cache
1482 void ClearAttrCache();
1484 // adds an attribute to cache
1485 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
1487 // looks for an attr in cache, returns TRUE if found
1488 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
1490 // looks for the attr in cache, if not found asks the table and caches the
1492 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
1493 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
)
1494 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
1496 // the default cell attr object for cells that don't have their own
1497 wxGridCellAttr
* m_defaultCellAttr
;
1500 wxGridCellCoordsArray m_cellsExposed
;
1501 wxArrayInt m_rowsExposed
;
1502 wxArrayInt m_colsExposed
;
1503 wxArrayInt m_rowLabelsExposed
;
1504 wxArrayInt m_colLabelsExposed
;
1510 wxGridTypeRegistry
* m_typeRegistry
;
1514 WXGRID_CURSOR_SELECT_CELL
,
1515 WXGRID_CURSOR_RESIZE_ROW
,
1516 WXGRID_CURSOR_RESIZE_COL
,
1517 WXGRID_CURSOR_SELECT_ROW
,
1518 WXGRID_CURSOR_SELECT_COL
1521 // this method not only sets m_cursorMode but also sets the correct cursor
1522 // for the given mode and, if captureMouse is not FALSE releases the mouse
1523 // if it was captured and captures it if it must be captured
1525 // for this to work, you should always use it and not set m_cursorMode
1527 void ChangeCursorMode(CursorMode mode
,
1528 wxWindow
*win
= (wxWindow
*)NULL
,
1529 bool captureMouse
= TRUE
);
1531 wxWindow
*m_winCapture
; // the window which captured the mouse
1532 CursorMode m_cursorMode
;
1534 bool m_canDragRowSize
;
1535 bool m_canDragColSize
;
1536 bool m_canDragGridSize
;
1540 wxPoint m_startDragPos
;
1542 bool m_waitForSlowClick
;
1544 wxGridCellCoords m_selectionStart
;
1546 wxCursor m_rowResizeCursor
;
1547 wxCursor m_colResizeCursor
;
1549 bool m_editable
; // applies to whole grid
1550 bool m_cellEditCtrlEnabled
; // is in-place edit currently shown?
1555 void CalcDimensions();
1556 void CalcWindowSizes();
1557 bool Redimension( wxGridTableMessage
& );
1560 bool SendEvent( const wxEventType
, int row
, int col
, wxMouseEvent
& );
1561 bool SendEvent( const wxEventType
, int row
, int col
);
1562 bool SendEvent( const wxEventType type
)
1564 return SendEvent(type
,
1565 m_currentCellCoords
.GetRow(),
1566 m_currentCellCoords
.GetCol());
1569 void OnPaint( wxPaintEvent
& );
1570 void OnSize( wxSizeEvent
& );
1571 void OnKeyDown( wxKeyEvent
& );
1572 void OnEraseBackground( wxEraseEvent
& );
1575 void SetCurrentCell( const wxGridCellCoords
& coords
);
1576 void SetCurrentCell( int row
, int col
)
1577 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1580 // ------ functions to get/send data (see also public functions)
1582 bool GetModelValues();
1583 bool SetModelValues();
1586 DECLARE_DYNAMIC_CLASS( wxGrid
)
1587 DECLARE_EVENT_TABLE()
1590 // ----------------------------------------------------------------------------
1591 // Grid event class and event types
1592 // ----------------------------------------------------------------------------
1594 class WXDLLEXPORT wxGridEvent
: public wxNotifyEvent
1598 : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
1599 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1603 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
1604 int row
=-1, int col
=-1, int x
=-1, int y
=-1,
1605 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1607 virtual int GetRow() { return m_row
; }
1608 virtual int GetCol() { return m_col
; }
1609 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1610 bool ControlDown() { return m_control
; }
1611 bool MetaDown() { return m_meta
; }
1612 bool ShiftDown() { return m_shift
; }
1613 bool AltDown() { return m_alt
; }
1625 DECLARE_DYNAMIC_CLASS(wxGridEvent
)
1628 class WXDLLEXPORT wxGridSizeEvent
: public wxNotifyEvent
1632 : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
1633 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1637 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
1638 int rowOrCol
=-1, int x
=-1, int y
=-1,
1639 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1641 int GetRowOrCol() { return m_rowOrCol
; }
1642 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1643 bool ControlDown() { return m_control
; }
1644 bool MetaDown() { return m_meta
; }
1645 bool ShiftDown() { return m_shift
; }
1646 bool AltDown() { return m_alt
; }
1657 DECLARE_DYNAMIC_CLASS(wxGridSizeEvent
)
1661 class WXDLLEXPORT wxGridRangeSelectEvent
: public wxNotifyEvent
1664 wxGridRangeSelectEvent()
1667 m_topLeft
= wxGridNoCellCoords
;
1668 m_bottomRight
= wxGridNoCellCoords
;
1675 wxGridRangeSelectEvent(int id
, wxEventType type
, wxObject
* obj
,
1676 const wxGridCellCoords
& topLeft
,
1677 const wxGridCellCoords
& bottomRight
,
1678 bool control
=FALSE
, bool shift
=FALSE
,
1679 bool alt
=FALSE
, bool meta
=FALSE
);
1681 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
1682 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
1683 int GetTopRow() { return m_topLeft
.GetRow(); }
1684 int GetBottomRow() { return m_bottomRight
.GetRow(); }
1685 int GetLeftCol() { return m_topLeft
.GetCol(); }
1686 int GetRightCol() { return m_bottomRight
.GetCol(); }
1687 bool ControlDown() { return m_control
; }
1688 bool MetaDown() { return m_meta
; }
1689 bool ShiftDown() { return m_shift
; }
1690 bool AltDown() { return m_alt
; }
1693 wxGridCellCoords m_topLeft
;
1694 wxGridCellCoords m_bottomRight
;
1700 DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent
)
1703 // TODO move to wx/event.h
1704 const wxEventType wxEVT_GRID_CELL_LEFT_CLICK
= wxEVT_FIRST
+ 1580;
1705 const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK
= wxEVT_FIRST
+ 1581;
1706 const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK
= wxEVT_FIRST
+ 1582;
1707 const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1583;
1708 const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK
= wxEVT_FIRST
+ 1584;
1709 const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK
= wxEVT_FIRST
+ 1585;
1710 const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK
= wxEVT_FIRST
+ 1586;
1711 const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1587;
1712 const wxEventType wxEVT_GRID_ROW_SIZE
= wxEVT_FIRST
+ 1588;
1713 const wxEventType wxEVT_GRID_COL_SIZE
= wxEVT_FIRST
+ 1589;
1714 const wxEventType wxEVT_GRID_RANGE_SELECT
= wxEVT_FIRST
+ 1590;
1715 const wxEventType wxEVT_GRID_CELL_CHANGE
= wxEVT_FIRST
+ 1591;
1716 const wxEventType wxEVT_GRID_SELECT_CELL
= wxEVT_FIRST
+ 1592;
1717 const wxEventType wxEVT_GRID_EDITOR_SHOWN
= wxEVT_FIRST
+ 1593;
1718 const wxEventType wxEVT_GRID_EDITOR_HIDDEN
= wxEVT_FIRST
+ 1594;
1721 typedef void (wxEvtHandler
::*wxGridEventFunction
)(wxGridEvent
&);
1722 typedef void (wxEvtHandler
::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
1723 typedef void (wxEvtHandler
::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
1725 #define EVT_GRID_CELL_LEFT_CLICK(fn) { wxEVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1726 #define EVT_GRID_CELL_RIGHT_CLICK(fn) { wxEVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1727 #define EVT_GRID_CELL_LEFT_DCLICK(fn) { wxEVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1728 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) { wxEVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1729 #define EVT_GRID_LABEL_LEFT_CLICK(fn) { wxEVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1730 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) { wxEVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1731 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) { wxEVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1732 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) { wxEVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1733 #define EVT_GRID_ROW_SIZE(fn) { wxEVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1734 #define EVT_GRID_COL_SIZE(fn) { wxEVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1735 #define EVT_GRID_RANGE_SELECT(fn) { wxEVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
1736 #define EVT_GRID_CELL_CHANGE(fn) { wxEVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1737 #define EVT_GRID_SELECT_CELL(fn) { wxEVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1738 #define EVT_GRID_EDITOR_SHOWN(fn) { wxEVT_GRID_EDITOR_SHOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1739 #define EVT_GRID_EDITOR_HIDDEN(fn) { wxEVT_GRID_EDITOR_HIDDEN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1742 #if 0 // TODO: implement these ? others ?
1744 const wxEventType wxEVT_GRID_CREATE_CELL
= wxEVT_FIRST
+ 1576;
1745 const wxEventType wxEVT_GRID_CHANGE_LABELS
= wxEVT_FIRST
+ 1577;
1746 const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL
= wxEVT_FIRST
+ 1578;
1748 #define EVT_GRID_CREATE_CELL(fn) { wxEVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1749 #define EVT_GRID_CHANGE_LABELS(fn) { wxEVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1750 #define EVT_GRID_CHANGE_SEL_LABEL(fn) { wxEVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1754 #endif // #ifndef __WXGRID_H__
1756 #endif // ifndef wxUSE_NEW_GRID