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 2
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")
61 #define wxGRID_VALUE_CHOICE _T("choice")
63 #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING
64 #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER
66 // ----------------------------------------------------------------------------
67 // forward declarations
68 // ----------------------------------------------------------------------------
70 class WXDLLEXPORT wxGrid
;
71 class WXDLLEXPORT wxGridCellAttr
;
72 class WXDLLEXPORT wxGridCellAttrProviderData
;
73 class WXDLLEXPORT wxGridColLabelWindow
;
74 class WXDLLEXPORT wxGridCornerLabelWindow
;
75 class WXDLLEXPORT wxGridRowLabelWindow
;
76 class WXDLLEXPORT wxGridTableBase
;
77 class WXDLLEXPORT wxGridWindow
;
78 class WXDLLEXPORT wxGridTypeRegistry
;
79 class WXDLLEXPORT wxGridSelection
;
81 class WXDLLEXPORT wxCheckBox
;
82 class WXDLLEXPORT wxComboBox
;
83 class WXDLLEXPORT wxTextCtrl
;
84 class WXDLLEXPORT wxSpinCtrl
;
86 // ----------------------------------------------------------------------------
88 // ----------------------------------------------------------------------------
90 #define wxSafeIncRef(p) if ( p ) (p)->IncRef()
91 #define wxSafeDecRef(p) if ( p ) (p)->DecRef()
93 // ----------------------------------------------------------------------------
94 // wxGridCellWorker: common base class for wxGridCellRenderer and
97 // NB: this is more an implementation convenience than a design issue, so this
98 // class is not documented and is not public at all
99 // ----------------------------------------------------------------------------
101 class WXDLLEXPORT wxGridCellWorker
104 wxGridCellWorker() { m_nRef
= 1; }
106 // this class is ref counted: it is created with ref count of 1, so
107 // calling DecRef() once will delete it. Calling IncRef() allows to lock
108 // it until the matching DecRef() is called
109 void IncRef() { m_nRef
++; }
110 void DecRef() { if ( !--m_nRef
) delete this; }
112 // interpret renderer parameters: arbitrary string whose interpretatin is
113 // left to the derived classes
114 virtual void SetParameters(const wxString
& params
);
117 // virtual dtor for any base class - private because only DecRef() can
119 virtual ~wxGridCellWorker();
124 // suppress the stupid gcc warning about the class having private dtor and
126 friend class wxGridCellWorkerDummyFriend
;
129 // ----------------------------------------------------------------------------
130 // wxGridCellRenderer: this class is responsible for actually drawing the cell
131 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
132 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
133 // view of all cells. This is an ABC, you will normally use one of the
134 // predefined derived classes or derive your own class from it.
135 // ----------------------------------------------------------------------------
137 class WXDLLEXPORT wxGridCellRenderer
: public wxGridCellWorker
140 // draw the given cell on the provided DC inside the given rectangle
141 // using the style specified by the attribute and the default or selected
142 // state corresponding to the isSelected value.
144 // this pure virtual function has a default implementation which will
145 // prepare the DC using the given attribute: it will draw the rectangle
146 // with the bg colour from attr and set the text colour and font
147 virtual void Draw(wxGrid
& grid
,
148 wxGridCellAttr
& attr
,
152 bool isSelected
) = 0;
154 // get the preferred size of the cell for its contents
155 virtual wxSize
GetBestSize(wxGrid
& grid
,
156 wxGridCellAttr
& attr
,
158 int row
, int col
) = 0;
160 // create a new object which is the copy of this one
161 virtual wxGridCellRenderer
*Clone() const = 0;
164 // the default renderer for the cells containing string data
165 class WXDLLEXPORT wxGridCellStringRenderer
: public wxGridCellRenderer
169 virtual void Draw(wxGrid
& grid
,
170 wxGridCellAttr
& attr
,
176 // return the string extent
177 virtual wxSize
GetBestSize(wxGrid
& grid
,
178 wxGridCellAttr
& attr
,
182 virtual wxGridCellRenderer
*Clone() const
183 { return new wxGridCellStringRenderer
; }
186 // set the text colours before drawing
187 void SetTextColoursAndFont(wxGrid
& grid
,
188 wxGridCellAttr
& attr
,
192 // calc the string extent for given string/font
193 wxSize
DoGetBestSize(wxGridCellAttr
& attr
,
195 const wxString
& text
);
198 // the default renderer for the cells containing numeric (long) data
199 class WXDLLEXPORT wxGridCellNumberRenderer
: public wxGridCellStringRenderer
202 // draw the string right aligned
203 virtual void Draw(wxGrid
& grid
,
204 wxGridCellAttr
& attr
,
210 virtual wxSize
GetBestSize(wxGrid
& grid
,
211 wxGridCellAttr
& attr
,
215 virtual wxGridCellRenderer
*Clone() const
216 { return new wxGridCellNumberRenderer
; }
219 wxString
GetString(wxGrid
& grid
, int row
, int col
);
222 class WXDLLEXPORT wxGridCellFloatRenderer
: public wxGridCellStringRenderer
225 wxGridCellFloatRenderer(int width
= -1, int precision
= -1);
227 // get/change formatting parameters
228 int GetWidth() const { return m_width
; }
229 void SetWidth(int width
) { m_width
= width
; m_format
.clear(); }
230 int GetPrecision() const { return m_precision
; }
231 void SetPrecision(int precision
) { m_precision
= precision
; m_format
.clear(); }
233 // draw the string right aligned with given width/precision
234 virtual void Draw(wxGrid
& grid
,
235 wxGridCellAttr
& attr
,
241 virtual wxSize
GetBestSize(wxGrid
& grid
,
242 wxGridCellAttr
& attr
,
246 // parameters string format is "width[,precision]"
247 virtual void SetParameters(const wxString
& params
);
249 virtual wxGridCellRenderer
*Clone() const;
252 wxString
GetString(wxGrid
& grid
, int row
, int col
);
255 // formatting parameters
262 // renderer for boolean fields
263 class WXDLLEXPORT wxGridCellBoolRenderer
: public wxGridCellRenderer
266 // draw a check mark or nothing
267 virtual void Draw(wxGrid
& grid
,
268 wxGridCellAttr
& attr
,
274 // return the checkmark size
275 virtual wxSize
GetBestSize(wxGrid
& grid
,
276 wxGridCellAttr
& attr
,
280 virtual wxGridCellRenderer
*Clone() const
281 { return new wxGridCellBoolRenderer
; }
284 static wxSize ms_sizeCheckMark
;
287 // ----------------------------------------------------------------------------
288 // wxGridCellEditor: This class is responsible for providing and manipulating
289 // the in-place edit controls for the grid. Instances of wxGridCellEditor
290 // (actually, instances of derived classes since it is an ABC) can be
291 // associated with the cell attributes for individual cells, rows, columns, or
292 // even for the entire grid.
293 // ----------------------------------------------------------------------------
295 class WXDLLEXPORT wxGridCellEditor
: public wxGridCellWorker
300 bool IsCreated() { return m_control
!= NULL
; }
302 // Creates the actual edit control
303 virtual void Create(wxWindow
* parent
,
305 wxEvtHandler
* evtHandler
) = 0;
307 // Size and position the edit control
308 virtual void SetSize(const wxRect
& rect
);
310 // Show or hide the edit control, use the specified attributes to set
311 // colours/fonts for it
312 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
314 // Draws the part of the cell not occupied by the control: the base class
315 // version just fills it with background colour from the attribute
316 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
318 // Fetch the value from the table and prepare the edit control
319 // to begin editing. Set the focus to the edit control.
320 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
322 // Complete the editing of the current cell. Returns true if the value has
323 // changed. If necessary, the control may be destroyed.
324 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
) = 0;
326 // Reset the value in the control back to its starting value
327 virtual void Reset() = 0;
329 // If the editor is enabled by pressing keys on the grid,
330 // this will be called to let the editor do something about
331 // that first key if desired.
332 virtual void StartingKey(wxKeyEvent
& event
);
334 // if the editor is enabled by clicking on the cell, this method will be
336 virtual void StartingClick();
338 // Some types of controls on some platforms may need some help
339 // with the Return key.
340 virtual void HandleReturn(wxKeyEvent
& event
);
343 virtual void Destroy();
345 // create a new object which is the copy of this one
346 virtual wxGridCellEditor
*Clone() const = 0;
349 // the dtor is private because only DecRef() can delete us
350 virtual ~wxGridCellEditor();
352 // the control we show on screen
353 wxControl
* m_control
;
355 // if we change the colours/font of the control from the default ones, we
356 // must restore the default later and we save them here between calls to
357 // Show(TRUE) and Show(FALSE)
362 // suppress the stupid gcc warning about the class having private dtor and
364 friend class wxGridCellEditorDummyFriend
;
367 // the editor for string/text data
368 class WXDLLEXPORT wxGridCellTextEditor
: public wxGridCellEditor
371 wxGridCellTextEditor();
373 virtual void Create(wxWindow
* parent
,
375 wxEvtHandler
* evtHandler
);
376 virtual void SetSize(const wxRect
& rect
);
378 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
380 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
381 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
383 virtual void Reset();
384 virtual void StartingKey(wxKeyEvent
& event
);
385 virtual void HandleReturn(wxKeyEvent
& event
);
387 // parameters string format is "max_width"
388 virtual void SetParameters(const wxString
& params
);
390 virtual wxGridCellEditor
*Clone() const
391 { return new wxGridCellTextEditor
; }
394 wxTextCtrl
*Text() const { return (wxTextCtrl
*)m_control
; }
396 // parts of our virtual functions reused by the derived classes
397 void DoBeginEdit(const wxString
& startValue
);
398 void DoReset(const wxString
& startValue
);
401 size_t m_maxChars
; // max number of chars allowed
402 wxString m_startValue
;
405 // the editor for numeric (long) data
406 class WXDLLEXPORT wxGridCellNumberEditor
: public wxGridCellTextEditor
409 // allows to specify the range - if min == max == -1, no range checking is
411 wxGridCellNumberEditor(int min
= -1, int max
= -1);
413 virtual void Create(wxWindow
* parent
,
415 wxEvtHandler
* evtHandler
);
417 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
418 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
420 virtual void Reset();
421 virtual void StartingKey(wxKeyEvent
& event
);
423 // parameters string format is "min,max"
424 virtual void SetParameters(const wxString
& params
);
426 virtual wxGridCellEditor
*Clone() const
427 { return new wxGridCellNumberEditor(m_min
, m_max
); }
430 wxSpinCtrl
*Spin() const { return (wxSpinCtrl
*)m_control
; }
432 // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl
433 bool HasRange() const { return m_min
!= m_max
; }
435 // string representation of m_valueOld
436 wxString
GetString() const
437 { return wxString::Format(_T("%ld"), m_valueOld
); }
446 // the editor for floating point numbers (double) data
447 class WXDLLEXPORT wxGridCellFloatEditor
: public wxGridCellTextEditor
450 virtual void Create(wxWindow
* parent
,
452 wxEvtHandler
* evtHandler
);
454 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
455 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
457 virtual void Reset();
458 virtual void StartingKey(wxKeyEvent
& event
);
460 virtual wxGridCellEditor
*Clone() const
461 { return new wxGridCellFloatEditor
; }
464 // string representation of m_valueOld
465 wxString
GetString() const
466 { return wxString::Format(_T("%f"), m_valueOld
); }
472 // the editor for boolean data
473 class WXDLLEXPORT wxGridCellBoolEditor
: public wxGridCellEditor
476 virtual void Create(wxWindow
* parent
,
478 wxEvtHandler
* evtHandler
);
480 virtual void SetSize(const wxRect
& rect
);
481 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
483 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
484 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
486 virtual void Reset();
487 virtual void StartingClick();
489 virtual wxGridCellEditor
*Clone() const
490 { return new wxGridCellBoolEditor
; }
493 wxCheckBox
*CBox() const { return (wxCheckBox
*)m_control
; }
499 // the editor for string data allowing to choose from the list of strings
500 class WXDLLEXPORT wxGridCellChoiceEditor
: public wxGridCellEditor
503 // if !allowOthers, user can't type a string not in choices array
504 wxGridCellChoiceEditor(size_t count
= 0,
505 const wxChar
* choices
[] = NULL
,
506 bool allowOthers
= FALSE
);
508 virtual void Create(wxWindow
* parent
,
510 wxEvtHandler
* evtHandler
);
512 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
514 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
515 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
517 virtual void Reset();
519 // parameters string format is "item1[,item2[...,itemN]]"
520 virtual void SetParameters(const wxString
& params
);
522 virtual wxGridCellEditor
*Clone() const;
525 wxComboBox
*Combo() const { return (wxComboBox
*)m_control
; }
528 wxString m_startValue
;
529 wxArrayString m_choices
;
533 // ----------------------------------------------------------------------------
534 // wxGridCellAttr: this class can be used to alter the cells appearance in
535 // the grid by changing their colour/font/... from default. An object of this
536 // class may be returned by wxGridTable::GetAttr().
537 // ----------------------------------------------------------------------------
539 class WXDLLEXPORT wxGridCellAttr
549 // VZ: considering the number of members wxGridCellAttr has now, this ctor
550 // seems to be pretty useless... may be we should just remove it?
551 wxGridCellAttr(const wxColour
& colText
,
552 const wxColour
& colBack
,
556 : m_colText(colText
), m_colBack(colBack
), m_font(font
)
559 SetAlignment(hAlign
, vAlign
);
562 // creates a new copy of this object
563 wxGridCellAttr
*Clone() const;
565 // this class is ref counted: it is created with ref count of 1, so
566 // calling DecRef() once will delete it. Calling IncRef() allows to lock
567 // it until the matching DecRef() is called
568 void IncRef() { m_nRef
++; }
569 void DecRef() { if ( !--m_nRef
) delete this; }
572 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
573 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
574 void SetFont(const wxFont
& font
) { m_font
= font
; }
575 void SetAlignment(int hAlign
, int vAlign
)
580 void SetReadOnly(bool isReadOnly
= TRUE
) { m_isReadOnly
= isReadOnly
; }
582 // takes ownership of the pointer
583 void SetRenderer(wxGridCellRenderer
*renderer
)
584 { wxSafeDecRef(m_renderer
); m_renderer
= renderer
; }
585 void SetEditor(wxGridCellEditor
* editor
)
586 { wxSafeDecRef(m_editor
); m_editor
= editor
; }
589 bool HasTextColour() const { return m_colText
.Ok(); }
590 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
591 bool HasFont() const { return m_font
.Ok(); }
592 bool HasAlignment() const { return m_hAlign
|| m_vAlign
; }
593 bool HasRenderer() const { return m_renderer
!= NULL
; }
594 bool HasEditor() const { return m_editor
!= NULL
; }
596 const wxColour
& GetTextColour() const;
597 const wxColour
& GetBackgroundColour() const;
598 const wxFont
& GetFont() const;
599 void GetAlignment(int *hAlign
, int *vAlign
) const;
600 wxGridCellRenderer
*GetRenderer(wxGrid
* grid
, int row
, int col
) const;
601 wxGridCellEditor
*GetEditor(wxGrid
* grid
, int row
, int col
) const;
603 bool IsReadOnly() const { return m_isReadOnly
; }
605 void SetDefAttr(wxGridCellAttr
* defAttr
) { m_defGridAttr
= defAttr
; }
608 // the common part of all ctors
613 m_isReadOnly
= FALSE
;
619 // the dtor is private because only DecRef() can delete us
622 wxSafeDecRef(m_renderer
);
623 wxSafeDecRef(m_editor
);
626 // the ref count - when it goes to 0, we die
635 wxGridCellRenderer
* m_renderer
;
636 wxGridCellEditor
* m_editor
;
637 wxGridCellAttr
* m_defGridAttr
;
641 // use Clone() instead
642 DECLARE_NO_COPY_CLASS(wxGridCellAttr
);
644 // suppress the stupid gcc warning about the class having private dtor and
646 friend class wxGridCellAttrDummyFriend
;
649 // ----------------------------------------------------------------------------
650 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
652 // ----------------------------------------------------------------------------
654 // implementation note: we separate it from wxGridTableBase because we wish to
655 // avoid deriving a new table class if possible, and sometimes it will be
656 // enough to just derive another wxGridCellAttrProvider instead
658 // the default implementation is reasonably efficient for the generic case,
659 // but you might still wish to implement your own for some specific situations
660 // if you have performance problems with the stock one
661 class WXDLLEXPORT wxGridCellAttrProvider
664 wxGridCellAttrProvider();
665 virtual ~wxGridCellAttrProvider();
667 // DecRef() must be called on the returned pointer
668 virtual wxGridCellAttr
*GetAttr(int row
, int col
) const;
670 // all these functions take ownership of the pointer, don't call DecRef()
672 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
673 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
674 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
676 // these functions must be called whenever some rows/cols are deleted
677 // because the internal data must be updated then
678 void UpdateAttrRows( size_t pos
, int numRows
);
679 void UpdateAttrCols( size_t pos
, int numCols
);
684 wxGridCellAttrProviderData
*m_data
;
687 //////////////////////////////////////////////////////////////////////
689 // Grid table classes
691 //////////////////////////////////////////////////////////////////////
694 class WXDLLEXPORT wxGridTableBase
: public wxObject
698 virtual ~wxGridTableBase();
700 // You must override these functions in a derived table class
702 virtual long GetNumberRows() = 0;
703 virtual long GetNumberCols() = 0;
704 virtual bool IsEmptyCell( int row
, int col
) = 0;
705 virtual wxString
GetValue( int row
, int col
) = 0;
706 virtual void SetValue( int row
, int col
, const wxString
& value
) = 0;
708 // Data type determination and value access
709 virtual wxString
GetTypeName( int row
, int col
);
710 virtual bool CanGetValueAs( int row
, int col
, const wxString
& typeName
);
711 virtual bool CanSetValueAs( int row
, int col
, const wxString
& typeName
);
713 virtual long GetValueAsLong( int row
, int col
);
714 virtual double GetValueAsDouble( int row
, int col
);
715 virtual bool GetValueAsBool( int row
, int col
);
717 virtual void SetValueAsLong( int row
, int col
, long value
);
718 virtual void SetValueAsDouble( int row
, int col
, double value
);
719 virtual void SetValueAsBool( int row
, int col
, bool value
);
721 // For user defined types
722 virtual void* GetValueAsCustom( int row
, int col
, const wxString
& typeName
);
723 virtual void SetValueAsCustom( int row
, int col
, const wxString
& typeName
, void* value
);
726 // Overriding these is optional
728 virtual void SetView( wxGrid
*grid
) { m_view
= grid
; }
729 virtual wxGrid
* GetView() const { return m_view
; }
731 virtual void Clear() {}
732 virtual bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
733 virtual bool AppendRows( size_t numRows
= 1 );
734 virtual bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
735 virtual bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
736 virtual bool AppendCols( size_t numCols
= 1 );
737 virtual bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
739 virtual wxString
GetRowLabelValue( int row
);
740 virtual wxString
GetColLabelValue( int col
);
741 virtual void SetRowLabelValue( int WXUNUSED(row
), const wxString
& ) {}
742 virtual void SetColLabelValue( int WXUNUSED(col
), const wxString
& ) {}
744 // Attribute handling
747 // give us the attr provider to use - we take ownership of the pointer
748 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
750 // get the currently used attr provider (may be NULL)
751 wxGridCellAttrProvider
*GetAttrProvider() const { return m_attrProvider
; }
753 // Does this table allow attributes? Default implementation creates
754 // a wxGridCellAttrProvider if necessary.
755 virtual bool CanHaveAttributes();
758 // change row/col number in attribute if needed
759 virtual void UpdateAttrRows( size_t pos
, int numRows
);
760 virtual void UpdateAttrCols( size_t pos
, int numCols
);
762 // by default forwarded to wxGridCellAttrProvider if any. May be
763 // overridden to handle attributes directly in the table.
764 virtual wxGridCellAttr
*GetAttr( int row
, int col
);
766 // these functions take ownership of the pointer
767 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
768 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
769 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
773 wxGridCellAttrProvider
*m_attrProvider
;
775 DECLARE_ABSTRACT_CLASS( wxGridTableBase
);
779 // ----------------------------------------------------------------------------
780 // wxGridTableMessage
781 // ----------------------------------------------------------------------------
783 // IDs for messages sent from grid table to view
785 enum wxGridTableRequest
787 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
= 2000,
788 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES
,
789 wxGRIDTABLE_NOTIFY_ROWS_INSERTED
,
790 wxGRIDTABLE_NOTIFY_ROWS_APPENDED
,
791 wxGRIDTABLE_NOTIFY_ROWS_DELETED
,
792 wxGRIDTABLE_NOTIFY_COLS_INSERTED
,
793 wxGRIDTABLE_NOTIFY_COLS_APPENDED
,
794 wxGRIDTABLE_NOTIFY_COLS_DELETED
797 class WXDLLEXPORT wxGridTableMessage
800 wxGridTableMessage();
801 wxGridTableMessage( wxGridTableBase
*table
, int id
,
805 void SetTableObject( wxGridTableBase
*table
) { m_table
= table
; }
806 wxGridTableBase
* GetTableObject() const { return m_table
; }
807 void SetId( int id
) { m_id
= id
; }
808 int GetId() { return m_id
; }
809 void SetCommandInt( int comInt1
) { m_comInt1
= comInt1
; }
810 int GetCommandInt() { return m_comInt1
; }
811 void SetCommandInt2( int comInt2
) { m_comInt2
= comInt2
; }
812 int GetCommandInt2() { return m_comInt2
; }
815 wxGridTableBase
*m_table
;
823 // ------ wxGridStringArray
824 // A 2-dimensional array of strings for data values
827 WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString
, wxGridStringArray
);
831 // ------ wxGridStringTable
833 // Simplest type of data table for a grid for small tables of strings
834 // that are stored in memory
837 class WXDLLEXPORT wxGridStringTable
: public wxGridTableBase
841 wxGridStringTable( int numRows
, int numCols
);
842 ~wxGridStringTable();
844 // these are pure virtual in wxGridTableBase
846 long GetNumberRows();
847 long GetNumberCols();
848 wxString
GetValue( int row
, int col
);
849 void SetValue( int row
, int col
, const wxString
& s
);
850 bool IsEmptyCell( int row
, int col
);
852 // overridden functions from wxGridTableBase
855 bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
856 bool AppendRows( size_t numRows
= 1 );
857 bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
858 bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
859 bool AppendCols( size_t numCols
= 1 );
860 bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
862 void SetRowLabelValue( int row
, const wxString
& );
863 void SetColLabelValue( int col
, const wxString
& );
864 wxString
GetRowLabelValue( int row
);
865 wxString
GetColLabelValue( int col
);
868 wxGridStringArray m_data
;
870 // These only get used if you set your own labels, otherwise the
871 // GetRow/ColLabelValue functions return wxGridTableBase defaults
873 wxArrayString m_rowLabels
;
874 wxArrayString m_colLabels
;
876 DECLARE_DYNAMIC_CLASS( wxGridStringTable
)
881 // ============================================================================
883 // ============================================================================
885 // ----------------------------------------------------------------------------
886 // wxGridCellCoords: location of a cell in the grid
887 // ----------------------------------------------------------------------------
889 class WXDLLEXPORT wxGridCellCoords
892 wxGridCellCoords() { m_row
= m_col
= -1; }
893 wxGridCellCoords( int r
, int c
) { m_row
= r
; m_col
= c
; }
895 // default copy ctor is ok
897 long GetRow() const { return m_row
; }
898 void SetRow( long n
) { m_row
= n
; }
899 long GetCol() const { return m_col
; }
900 void SetCol( long n
) { m_col
= n
; }
901 void Set( long row
, long col
) { m_row
= row
; m_col
= col
; }
903 wxGridCellCoords
& operator=( const wxGridCellCoords
& other
)
905 if ( &other
!= this )
913 bool operator==( const wxGridCellCoords
& other
) const
915 return (m_row
== other
.m_row
&& m_col
== other
.m_col
);
918 bool operator!=( const wxGridCellCoords
& other
) const
920 return (m_row
!= other
.m_row
|| m_col
!= other
.m_col
);
923 bool operator!() const
925 return (m_row
== -1 && m_col
== -1 );
934 // For comparisons...
936 extern wxGridCellCoords wxGridNoCellCoords
;
937 extern wxRect wxGridNoCellRect
;
939 // An array of cell coords...
941 WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords
, wxGridCellCoordsArray
);
943 // ----------------------------------------------------------------------------
945 // ----------------------------------------------------------------------------
947 class WXDLLEXPORT wxGrid
: public wxScrolledWindow
955 wxGrid( wxWindow
*parent
,
957 const wxPoint
& pos
= wxDefaultPosition
,
958 const wxSize
& size
= wxDefaultSize
,
959 long style
= wxWANTS_CHARS
,
960 const wxString
& name
= wxPanelNameStr
);
964 enum wxGridSelectionModes
{wxGridSelectCells
,
966 wxGridSelectColumns
};
968 bool CreateGrid( int numRows
, int numCols
,
969 wxGrid::wxGridSelectionModes selmode
=
970 wxGrid::wxGridSelectCells
);
972 void SetSelectionMode(wxGrid::wxGridSelectionModes selmode
);
974 // ------ grid dimensions
976 int GetNumberRows() { return m_numRows
; }
977 int GetNumberCols() { return m_numCols
; }
980 // ------ display update functions
982 void CalcRowLabelsExposed( wxRegion
& reg
);
984 void CalcColLabelsExposed( wxRegion
& reg
);
985 void CalcCellsExposed( wxRegion
& reg
);
988 // ------ event handlers
990 void ProcessRowLabelMouseEvent( wxMouseEvent
& event
);
991 void ProcessColLabelMouseEvent( wxMouseEvent
& event
);
992 void ProcessCornerLabelMouseEvent( wxMouseEvent
& event
);
993 void ProcessGridCellMouseEvent( wxMouseEvent
& event
);
994 bool ProcessTableMessage( wxGridTableMessage
& );
996 void DoEndDragResizeRow();
997 void DoEndDragResizeCol();
999 wxGridTableBase
* GetTable() const { return m_table
; }
1000 bool SetTable( wxGridTableBase
*table
, bool takeOwnership
=FALSE
,
1001 wxGrid::wxGridSelectionModes selmode
=
1002 wxGrid::wxGridSelectCells
);
1005 bool InsertRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
1006 bool AppendRows( int numRows
= 1, bool updateLabels
=TRUE
);
1007 bool DeleteRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
1008 bool InsertCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
1009 bool AppendCols( int numCols
= 1, bool updateLabels
=TRUE
);
1010 bool DeleteCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
1012 void DrawGridCellArea( wxDC
& dc
);
1013 void DrawGridSpace( wxDC
& dc
);
1014 void DrawCellBorder( wxDC
& dc
, const wxGridCellCoords
& );
1015 void DrawAllGridLines( wxDC
& dc
, const wxRegion
& reg
);
1016 void DrawCell( wxDC
& dc
, const wxGridCellCoords
& );
1017 void DrawHighlight(wxDC
& dc
);
1019 // this function is called when the current cell highlight must be redrawn
1020 // and may be overridden by the user
1021 virtual void DrawCellHighlight( wxDC
& dc
, const wxGridCellAttr
*attr
);
1023 void DrawRowLabels( wxDC
& dc
);
1024 void DrawRowLabel( wxDC
& dc
, int row
);
1026 void DrawColLabels( wxDC
& dc
);
1027 void DrawColLabel( wxDC
& dc
, int col
);
1030 // ------ Cell text drawing functions
1032 void DrawTextRectangle( wxDC
& dc
, const wxString
&, const wxRect
&,
1033 int horizontalAlignment
= wxLEFT
,
1034 int verticalAlignment
= wxTOP
);
1036 // Split a string containing newline chararcters into an array of
1037 // strings and return the number of lines
1039 void StringToLines( const wxString
& value
, wxArrayString
& lines
);
1041 void GetTextBoxSize( wxDC
& dc
,
1042 wxArrayString
& lines
,
1043 long *width
, long *height
);
1047 // Code that does a lot of grid modification can be enclosed
1048 // between BeginBatch() and EndBatch() calls to avoid screen
1051 void BeginBatch() { m_batchCount
++; }
1052 void EndBatch() { if ( m_batchCount
> 0 ) m_batchCount
--; }
1053 int GetBatchCount() { return m_batchCount
; }
1056 // ------ edit control functions
1058 bool IsEditable() { return m_editable
; }
1059 void EnableEditing( bool edit
);
1061 void EnableCellEditControl( bool enable
= TRUE
);
1062 void DisableCellEditControl() { EnableCellEditControl(FALSE
); }
1063 bool CanEnableCellControl() const;
1064 bool IsCellEditControlEnabled() const;
1066 bool IsCurrentCellReadOnly() const;
1068 void ShowCellEditControl();
1069 void HideCellEditControl();
1070 void SaveEditControlValue();
1073 // ------ grid location functions
1074 // Note that all of these functions work with the logical coordinates of
1075 // grid cells and labels so you will need to convert from device
1076 // coordinates for mouse events etc.
1078 void XYToCell( int x
, int y
, wxGridCellCoords
& );
1079 int YToRow( int y
);
1080 int XToCol( int x
);
1082 int YToEdgeOfRow( int y
);
1083 int XToEdgeOfCol( int x
);
1085 wxRect
CellToRect( int row
, int col
);
1086 wxRect
CellToRect( const wxGridCellCoords
& coords
)
1087 { return CellToRect( coords
.GetRow(), coords
.GetCol() ); }
1089 int GetGridCursorRow() { return m_currentCellCoords
.GetRow(); }
1090 int GetGridCursorCol() { return m_currentCellCoords
.GetCol(); }
1092 // check to see if a cell is either wholly visible (the default arg) or
1093 // at least partially visible in the grid window
1095 bool IsVisible( int row
, int col
, bool wholeCellVisible
= TRUE
);
1096 bool IsVisible( const wxGridCellCoords
& coords
, bool wholeCellVisible
= TRUE
)
1097 { return IsVisible( coords
.GetRow(), coords
.GetCol(), wholeCellVisible
); }
1098 void MakeCellVisible( int row
, int col
);
1099 void MakeCellVisible( const wxGridCellCoords
& coords
)
1100 { MakeCellVisible( coords
.GetRow(), coords
.GetCol() ); }
1103 // ------ grid cursor movement functions
1105 void SetGridCursor( int row
, int col
)
1106 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1108 bool MoveCursorUp( bool expandSelection
);
1109 bool MoveCursorDown( bool expandSelection
);
1110 bool MoveCursorLeft( bool expandSelection
);
1111 bool MoveCursorRight( bool expandSelection
);
1112 bool MovePageDown();
1114 bool MoveCursorUpBlock( bool expandSelection
);
1115 bool MoveCursorDownBlock( bool expandSelection
);
1116 bool MoveCursorLeftBlock( bool expandSelection
);
1117 bool MoveCursorRightBlock( bool expandSelection
);
1120 // ------ label and gridline formatting
1122 int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH
; }
1123 int GetRowLabelSize() { return m_rowLabelWidth
; }
1124 int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT
; }
1125 int GetColLabelSize() { return m_colLabelHeight
; }
1126 wxColour
GetLabelBackgroundColour() { return m_labelBackgroundColour
; }
1127 wxColour
GetLabelTextColour() { return m_labelTextColour
; }
1128 wxFont
GetLabelFont() { return m_labelFont
; }
1129 void GetRowLabelAlignment( int *horiz
, int *vert
);
1130 void GetColLabelAlignment( int *horiz
, int *vert
);
1131 wxString
GetRowLabelValue( int row
);
1132 wxString
GetColLabelValue( int col
);
1133 wxColour
GetGridLineColour() { return m_gridLineColour
; }
1135 void SetRowLabelSize( int width
);
1136 void SetColLabelSize( int height
);
1137 void SetLabelBackgroundColour( const wxColour
& );
1138 void SetLabelTextColour( const wxColour
& );
1139 void SetLabelFont( const wxFont
& );
1140 void SetRowLabelAlignment( int horiz
, int vert
);
1141 void SetColLabelAlignment( int horiz
, int vert
);
1142 void SetRowLabelValue( int row
, const wxString
& );
1143 void SetColLabelValue( int col
, const wxString
& );
1144 void SetGridLineColour( const wxColour
& );
1146 void EnableDragRowSize( bool enable
= TRUE
);
1147 void DisableDragRowSize() { EnableDragRowSize( FALSE
); }
1148 bool CanDragRowSize() { return m_canDragRowSize
; }
1149 void EnableDragColSize( bool enable
= TRUE
);
1150 void DisableDragColSize() { EnableDragColSize( FALSE
); }
1151 bool CanDragColSize() { return m_canDragColSize
; }
1152 void EnableDragGridSize(bool enable
= TRUE
);
1153 void DisableDragGridSize() { EnableDragGridSize(FALSE
); }
1154 bool CanDragGridSize() { return m_canDragGridSize
; }
1156 // this sets the specified attribute for all cells in this row/col
1157 void SetRowAttr(int row
, wxGridCellAttr
*attr
);
1158 void SetColAttr(int col
, wxGridCellAttr
*attr
);
1160 // shortcuts for setting the column parameters
1162 // set the format for the data in the column: default is string
1163 void SetColFormatBool(int col
);
1164 void SetColFormatNumber(int col
);
1165 void SetColFormatFloat(int col
, int width
= -1, int precision
= -1);
1166 void SetColFormatCustom(int col
, const wxString
& typeName
);
1168 void EnableGridLines( bool enable
= TRUE
);
1169 bool GridLinesEnabled() { return m_gridLinesEnabled
; }
1171 // ------ row and col formatting
1173 int GetDefaultRowSize();
1174 int GetRowSize( int row
);
1175 int GetDefaultColSize();
1176 int GetColSize( int col
);
1177 wxColour
GetDefaultCellBackgroundColour();
1178 wxColour
GetCellBackgroundColour( int row
, int col
);
1179 wxColour
GetDefaultCellTextColour();
1180 wxColour
GetCellTextColour( int row
, int col
);
1181 wxFont
GetDefaultCellFont();
1182 wxFont
GetCellFont( int row
, int col
);
1183 void GetDefaultCellAlignment( int *horiz
, int *vert
);
1184 void GetCellAlignment( int row
, int col
, int *horiz
, int *vert
);
1186 void SetDefaultRowSize( int height
, bool resizeExistingRows
= FALSE
);
1187 void SetRowSize( int row
, int height
);
1188 void SetDefaultColSize( int width
, bool resizeExistingCols
= FALSE
);
1190 void SetColSize( int col
, int width
);
1192 // automatically size the column or row to fit to its contents, if
1193 // setAsMin is TRUE, this optimal width will also be set as minimal width
1195 void AutoSizeColumn( int col
, bool setAsMin
= TRUE
)
1196 { AutoSizeColOrRow(col
, setAsMin
, TRUE
); }
1197 void AutoSizeRow( int row
, bool setAsMin
= TRUE
)
1198 { AutoSizeColOrRow(row
, setAsMin
, FALSE
); }
1200 // auto size all columns (very ineffective for big grids!)
1201 void AutoSizeColumns( bool setAsMin
= TRUE
)
1202 { (void)SetOrCalcColumnSizes(FALSE
, setAsMin
); }
1204 void AutoSizeRows( bool setAsMin
= TRUE
)
1205 { (void)SetOrCalcRowSizes(FALSE
, setAsMin
); }
1207 // auto size the grid, that is make the columns/rows of the "right" size
1208 // and also set the grid size to just fit its contents
1211 // column won't be resized to be lesser width - this must be called during
1212 // the grid creation because it won't resize the column if it's already
1213 // narrower than the minimal width
1214 void SetColMinimalWidth( int col
, int width
);
1215 void SetRowMinimalHeight( int row
, int width
);
1217 void SetDefaultCellBackgroundColour( const wxColour
& );
1218 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
1219 void SetDefaultCellTextColour( const wxColour
& );
1221 void SetCellTextColour( int row
, int col
, const wxColour
& );
1222 void SetDefaultCellFont( const wxFont
& );
1223 void SetCellFont( int row
, int col
, const wxFont
& );
1224 void SetDefaultCellAlignment( int horiz
, int vert
);
1225 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
1227 // takes ownership of the pointer
1228 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
1229 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
1230 wxGridCellRenderer
*GetDefaultRenderer() const;
1231 wxGridCellRenderer
* GetCellRenderer(int row
, int col
);
1233 // takes ownership of the pointer
1234 void SetDefaultEditor(wxGridCellEditor
*editor
);
1235 void SetCellEditor(int row
, int col
, wxGridCellEditor
*editor
);
1236 wxGridCellEditor
*GetDefaultEditor() const;
1237 wxGridCellEditor
* GetCellEditor(int row
, int col
);
1241 // ------ cell value accessors
1243 wxString
GetCellValue( int row
, int col
)
1247 return m_table
->GetValue( row
, col
);
1251 return wxEmptyString
;
1255 wxString
GetCellValue( const wxGridCellCoords
& coords
)
1256 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
1258 void SetCellValue( int row
, int col
, const wxString
& s
);
1259 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
1260 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
1262 // returns TRUE if the cell can't be edited
1263 bool IsReadOnly(int row
, int col
) const;
1265 // make the cell editable/readonly
1266 void SetReadOnly(int row
, int col
, bool isReadOnly
= TRUE
);
1268 // ------ selections of blocks of cells
1270 void SelectRow( int row
, bool addToSelected
= FALSE
);
1271 void SelectCol( int col
, bool addToSelected
= FALSE
);
1273 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
);
1275 void SelectBlock( const wxGridCellCoords
& topLeft
,
1276 const wxGridCellCoords
& bottomRight
)
1277 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
1278 bottomRight
.GetRow(), bottomRight
.GetCol() ); }
1284 void ClearSelection();
1286 bool IsInSelection( int row
, int col
);
1288 bool IsInSelection( const wxGridCellCoords
& coords
)
1289 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
1292 // This function returns the rectangle that encloses the block of cells
1293 // limited by TopLeft and BottomRight cell in device coords and clipped
1294 // to the client size of the grid window.
1296 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
1297 const wxGridCellCoords
& bottomRight
);
1299 // This function returns the rectangle that encloses the selected cells
1300 // in device coords and clipped to the client size of the grid window.
1302 wxRect
SelectionToDeviceRect()
1304 return BlockToDeviceRect( m_selectingTopLeft
,
1305 m_selectingBottomRight
);
1308 // Access or update the selection fore/back colours
1309 wxColour
GetSelectionBackground() const
1310 { return m_selectionBackground
; }
1311 wxColour
GetSelectionForeground() const
1312 { return m_selectionForeground
; }
1314 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
1315 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
1318 // Methods for a registry for mapping data types to Renderers/Editors
1319 void RegisterDataType(const wxString
& typeName
,
1320 wxGridCellRenderer
* renderer
,
1321 wxGridCellEditor
* editor
);
1322 wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1323 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const
1324 { return GetDefaultEditorForCell(c
.GetRow(), c
.GetCol()); }
1325 wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
1326 wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
1327 wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
1329 // grid may occupy more space than needed for its rows/columns, this
1330 // function allows to set how big this extra space is
1331 void SetMargins(int extraWidth
, int extraHeight
)
1333 m_extraWidth
= extraWidth
;
1334 m_extraHeight
= extraHeight
;
1337 // ------ For compatibility with previous wxGrid only...
1339 // ************************************************
1340 // ** Don't use these in new code because they **
1341 // ** are liable to disappear in a future **
1343 // ************************************************
1346 wxGrid( wxWindow
*parent
,
1347 int x
, int y
, int w
= -1, int h
= -1,
1348 long style
= wxWANTS_CHARS
,
1349 const wxString
& name
= wxPanelNameStr
)
1350 : wxScrolledWindow( parent
, -1, wxPoint(x
,y
), wxSize(w
,h
),
1351 (style
|wxWANTS_CHARS
), name
)
1356 void SetCellValue( const wxString
& val
, int row
, int col
)
1357 { SetCellValue( row
, col
, val
); }
1359 void UpdateDimensions()
1360 { CalcDimensions(); }
1362 int GetRows() { return GetNumberRows(); }
1363 int GetCols() { return GetNumberCols(); }
1364 int GetCursorRow() { return GetGridCursorRow(); }
1365 int GetCursorColumn() { return GetGridCursorCol(); }
1367 int GetScrollPosX() { return 0; }
1368 int GetScrollPosY() { return 0; }
1370 void SetScrollX( int x
) { }
1371 void SetScrollY( int y
) { }
1373 void SetColumnWidth( int col
, int width
)
1374 { SetColSize( col
, width
); }
1376 int GetColumnWidth( int col
)
1377 { return GetColSize( col
); }
1379 void SetRowHeight( int row
, int height
)
1380 { SetRowSize( row
, height
); }
1382 // GetRowHeight() is below
1384 int GetViewHeight() // returned num whole rows visible
1387 int GetViewWidth() // returned num whole cols visible
1390 void SetLabelSize( int orientation
, int sz
)
1392 if ( orientation
== wxHORIZONTAL
)
1393 SetColLabelSize( sz
);
1395 SetRowLabelSize( sz
);
1398 int GetLabelSize( int orientation
)
1400 if ( orientation
== wxHORIZONTAL
)
1401 return GetColLabelSize();
1403 return GetRowLabelSize();
1406 void SetLabelAlignment( int orientation
, int align
)
1408 if ( orientation
== wxHORIZONTAL
)
1409 SetColLabelAlignment( align
, -1 );
1411 SetRowLabelAlignment( align
, -1 );
1414 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) )
1417 if ( orientation
== wxHORIZONTAL
)
1419 GetColLabelAlignment( &h
, &v
);
1424 GetRowLabelAlignment( &h
, &v
);
1429 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
1431 if ( orientation
== wxHORIZONTAL
)
1432 SetColLabelValue( pos
, val
);
1434 SetRowLabelValue( pos
, val
);
1437 wxString
GetLabelValue( int orientation
, int pos
)
1439 if ( orientation
== wxHORIZONTAL
)
1440 return GetColLabelValue( pos
);
1442 return GetRowLabelValue( pos
);
1445 wxFont
GetCellTextFont() const
1446 { return m_defaultCellAttr
->GetFont(); }
1448 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
1449 { return m_defaultCellAttr
->GetFont(); }
1451 void SetCellTextFont(const wxFont
& fnt
)
1452 { SetDefaultCellFont( fnt
); }
1454 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
1455 { SetCellFont( row
, col
, fnt
); }
1457 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
1458 { SetCellTextColour( row
, col
, val
); }
1460 void SetCellTextColour(const wxColour
& col
)
1461 { SetDefaultCellTextColour( col
); }
1463 void SetCellBackgroundColour(const wxColour
& col
)
1464 { SetDefaultCellBackgroundColour( col
); }
1466 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1467 { SetCellBackgroundColour( row
, col
, colour
); }
1469 bool GetEditable() { return IsEditable(); }
1470 void SetEditable( bool edit
= TRUE
) { EnableEditing( edit
); }
1471 bool GetEditInPlace() { return IsCellEditControlEnabled(); }
1473 void SetEditInPlace(bool edit
= TRUE
) { }
1475 void SetCellAlignment( int align
, int row
, int col
)
1476 { SetCellAlignment(row
, col
, align
, wxCENTER
); }
1477 void SetCellAlignment( int WXUNUSED(align
) ) {}
1478 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1480 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1481 wxPen
& GetDividerPen() const { return wxNullPen
; }
1482 void OnActivate(bool WXUNUSED(active
)) {}
1484 // ******** End of compatibility functions **********
1488 // ------ control IDs
1489 enum { wxGRID_CELLCTRL
= 2000,
1492 // ------ control types
1493 enum { wxGRID_TEXTCTRL
= 2100,
1498 // overridden wxWindow methods
1502 virtual wxSize
DoGetBestSize() const;
1506 wxGridWindow
*m_gridWin
;
1507 wxGridRowLabelWindow
*m_rowLabelWin
;
1508 wxGridColLabelWindow
*m_colLabelWin
;
1509 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1511 wxGridTableBase
*m_table
;
1522 wxGridCellCoords m_currentCellCoords
;
1524 wxGridCellCoords m_selectingTopLeft
;
1525 wxGridCellCoords m_selectingBottomRight
;
1526 wxGridCellCoords m_selectingKeyboard
;
1527 wxGridSelection
*m_selection
;
1528 wxColour m_selectionBackground
;
1529 wxColour m_selectionForeground
;
1531 // NB: *never* access m_row/col arrays directly because they are created
1532 // on demand, *always* use accessor functions instead!
1534 // init the m_rowHeights/Bottoms arrays with default values
1535 void InitRowHeights();
1537 int m_defaultRowHeight
;
1538 wxArrayInt m_rowHeights
;
1539 wxArrayInt m_rowBottoms
;
1541 // init the m_colWidths/Rights arrays
1542 void InitColWidths();
1544 int m_defaultColWidth
;
1545 wxArrayInt m_colWidths
;
1546 wxArrayInt m_colRights
;
1548 // get the col/row coords
1549 int GetColWidth(int col
) const;
1550 int GetColLeft(int col
) const;
1551 int GetColRight(int col
) const;
1553 // this function must be public for compatibility...
1555 int GetRowHeight(int row
) const;
1558 int GetRowTop(int row
) const;
1559 int GetRowBottom(int row
) const;
1561 int m_rowLabelWidth
;
1562 int m_colLabelHeight
;
1564 // the size of the margin left to the right and bottom of the cell area
1568 wxColour m_labelBackgroundColour
;
1569 wxColour m_labelTextColour
;
1572 int m_rowLabelHorizAlign
;
1573 int m_rowLabelVertAlign
;
1574 int m_colLabelHorizAlign
;
1575 int m_colLabelVertAlign
;
1577 bool m_defaultRowLabelValues
;
1578 bool m_defaultColLabelValues
;
1580 wxColour m_gridLineColour
;
1581 bool m_gridLinesEnabled
;
1583 // common part of AutoSizeColumn/Row() and GetBestSize()
1584 int SetOrCalcColumnSizes(bool calcOnly
, bool setAsMin
= TRUE
);
1585 int SetOrCalcRowSizes(bool calcOnly
, bool setAsMin
= TRUE
);
1587 // common part of AutoSizeColumn/Row()
1588 void AutoSizeColOrRow(int n
, bool setAsMin
, bool column
/* or row? */);
1590 // if a column has a minimal width, it will be the value for it in this
1592 wxHashTableLong m_colMinWidths
,
1595 // get the minimal width of the given column/row
1596 int GetColMinimalWidth(int col
) const;
1597 int GetRowMinimalHeight(int col
) const;
1599 // do we have some place to store attributes in?
1600 bool CanHaveAttributes();
1602 // returns the attribute we may modify in place: a new one if this cell
1603 // doesn't have any yet or the existing one if it does
1605 // DecRef() must be called on the returned pointer, as usual
1606 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1608 // cell attribute cache (currently we only cache 1, may be will do
1609 // more/better later)
1613 wxGridCellAttr
*attr
;
1616 // invalidates the attribute cache
1617 void ClearAttrCache();
1619 // adds an attribute to cache
1620 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
1622 // looks for an attr in cache, returns TRUE if found
1623 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
1625 // looks for the attr in cache, if not found asks the table and caches the
1627 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
1628 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
)
1629 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
1631 // the default cell attr object for cells that don't have their own
1632 wxGridCellAttr
* m_defaultCellAttr
;
1635 wxGridCellCoordsArray m_cellsExposed
;
1636 wxArrayInt m_rowsExposed
;
1637 wxArrayInt m_colsExposed
;
1638 wxArrayInt m_rowLabelsExposed
;
1639 wxArrayInt m_colLabelsExposed
;
1645 wxGridTypeRegistry
* m_typeRegistry
;
1649 WXGRID_CURSOR_SELECT_CELL
,
1650 WXGRID_CURSOR_RESIZE_ROW
,
1651 WXGRID_CURSOR_RESIZE_COL
,
1652 WXGRID_CURSOR_SELECT_ROW
,
1653 WXGRID_CURSOR_SELECT_COL
1656 // this method not only sets m_cursorMode but also sets the correct cursor
1657 // for the given mode and, if captureMouse is not FALSE releases the mouse
1658 // if it was captured and captures it if it must be captured
1660 // for this to work, you should always use it and not set m_cursorMode
1662 void ChangeCursorMode(CursorMode mode
,
1663 wxWindow
*win
= (wxWindow
*)NULL
,
1664 bool captureMouse
= TRUE
);
1666 wxWindow
*m_winCapture
; // the window which captured the mouse
1667 CursorMode m_cursorMode
;
1669 bool m_canDragRowSize
;
1670 bool m_canDragColSize
;
1671 bool m_canDragGridSize
;
1675 wxPoint m_startDragPos
;
1677 bool m_waitForSlowClick
;
1679 wxGridCellCoords m_selectionStart
;
1681 wxCursor m_rowResizeCursor
;
1682 wxCursor m_colResizeCursor
;
1684 bool m_editable
; // applies to whole grid
1685 bool m_cellEditCtrlEnabled
; // is in-place edit currently shown?
1690 void CalcDimensions();
1691 void CalcWindowSizes();
1692 bool Redimension( wxGridTableMessage
& );
1695 bool SendEvent( const wxEventType
, int row
, int col
, wxMouseEvent
& );
1696 bool SendEvent( const wxEventType
, int row
, int col
);
1697 bool SendEvent( const wxEventType type
)
1699 return SendEvent(type
,
1700 m_currentCellCoords
.GetRow(),
1701 m_currentCellCoords
.GetCol());
1704 void OnPaint( wxPaintEvent
& );
1705 void OnSize( wxSizeEvent
& );
1706 void OnKeyDown( wxKeyEvent
& );
1707 void OnEraseBackground( wxEraseEvent
& );
1710 void SetCurrentCell( const wxGridCellCoords
& coords
);
1711 void SetCurrentCell( int row
, int col
)
1712 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1715 // ------ functions to get/send data (see also public functions)
1717 bool GetModelValues();
1718 bool SetModelValues();
1720 friend class wxGridSelection
;
1722 DECLARE_DYNAMIC_CLASS( wxGrid
)
1723 DECLARE_EVENT_TABLE()
1726 // ----------------------------------------------------------------------------
1727 // Grid event class and event types
1728 // ----------------------------------------------------------------------------
1730 class WXDLLEXPORT wxGridEvent
: public wxNotifyEvent
1734 : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
1735 m_selecting(0), m_control(0), m_meta(0), m_shift(0), m_alt(0)
1739 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
1740 int row
=-1, int col
=-1, int x
=-1, int y
=-1, bool sel
= TRUE
,
1741 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1743 virtual int GetRow() { return m_row
; }
1744 virtual int GetCol() { return m_col
; }
1745 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1746 bool Selecting() { return m_selecting
; }
1747 bool ControlDown() { return m_control
; }
1748 bool MetaDown() { return m_meta
; }
1749 bool ShiftDown() { return m_shift
; }
1750 bool AltDown() { return m_alt
; }
1763 DECLARE_DYNAMIC_CLASS(wxGridEvent
)
1766 class WXDLLEXPORT wxGridSizeEvent
: public wxNotifyEvent
1770 : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
1771 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1775 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
1776 int rowOrCol
=-1, int x
=-1, int y
=-1,
1777 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1779 int GetRowOrCol() { return m_rowOrCol
; }
1780 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1781 bool ControlDown() { return m_control
; }
1782 bool MetaDown() { return m_meta
; }
1783 bool ShiftDown() { return m_shift
; }
1784 bool AltDown() { return m_alt
; }
1795 DECLARE_DYNAMIC_CLASS(wxGridSizeEvent
)
1799 class WXDLLEXPORT wxGridRangeSelectEvent
: public wxNotifyEvent
1802 wxGridRangeSelectEvent()
1805 m_topLeft
= wxGridNoCellCoords
;
1806 m_bottomRight
= wxGridNoCellCoords
;
1807 m_selecting
= FALSE
;
1814 wxGridRangeSelectEvent(int id
, wxEventType type
, wxObject
* obj
,
1815 const wxGridCellCoords
& topLeft
,
1816 const wxGridCellCoords
& bottomRight
,
1818 bool control
=FALSE
, bool shift
=FALSE
,
1819 bool alt
=FALSE
, bool meta
=FALSE
);
1821 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
1822 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
1823 int GetTopRow() { return m_topLeft
.GetRow(); }
1824 int GetBottomRow() { return m_bottomRight
.GetRow(); }
1825 int GetLeftCol() { return m_topLeft
.GetCol(); }
1826 int GetRightCol() { return m_bottomRight
.GetCol(); }
1827 bool Selecting() { return m_selecting
; }
1828 bool ControlDown() { return m_control
; }
1829 bool MetaDown() { return m_meta
; }
1830 bool ShiftDown() { return m_shift
; }
1831 bool AltDown() { return m_alt
; }
1834 wxGridCellCoords m_topLeft
;
1835 wxGridCellCoords m_bottomRight
;
1842 DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent
)
1845 // TODO move to wx/event.h
1846 const wxEventType wxEVT_GRID_CELL_LEFT_CLICK
= wxEVT_FIRST
+ 1580;
1847 const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK
= wxEVT_FIRST
+ 1581;
1848 const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK
= wxEVT_FIRST
+ 1582;
1849 const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1583;
1850 const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK
= wxEVT_FIRST
+ 1584;
1851 const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK
= wxEVT_FIRST
+ 1585;
1852 const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK
= wxEVT_FIRST
+ 1586;
1853 const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1587;
1854 const wxEventType wxEVT_GRID_ROW_SIZE
= wxEVT_FIRST
+ 1588;
1855 const wxEventType wxEVT_GRID_COL_SIZE
= wxEVT_FIRST
+ 1589;
1856 const wxEventType wxEVT_GRID_RANGE_SELECT
= wxEVT_FIRST
+ 1590;
1857 const wxEventType wxEVT_GRID_CELL_CHANGE
= wxEVT_FIRST
+ 1591;
1858 const wxEventType wxEVT_GRID_SELECT_CELL
= wxEVT_FIRST
+ 1592;
1859 const wxEventType wxEVT_GRID_EDITOR_SHOWN
= wxEVT_FIRST
+ 1593;
1860 const wxEventType wxEVT_GRID_EDITOR_HIDDEN
= wxEVT_FIRST
+ 1594;
1863 typedef void (wxEvtHandler::*wxGridEventFunction
)(wxGridEvent
&);
1864 typedef void (wxEvtHandler::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
1865 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
1867 #define EVT_GRID_CELL_LEFT_CLICK(fn) { wxEVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1868 #define EVT_GRID_CELL_RIGHT_CLICK(fn) { wxEVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1869 #define EVT_GRID_CELL_LEFT_DCLICK(fn) { wxEVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1870 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) { wxEVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1871 #define EVT_GRID_LABEL_LEFT_CLICK(fn) { wxEVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1872 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) { wxEVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1873 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) { wxEVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1874 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) { wxEVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1875 #define EVT_GRID_ROW_SIZE(fn) { wxEVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1876 #define EVT_GRID_COL_SIZE(fn) { wxEVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1877 #define EVT_GRID_RANGE_SELECT(fn) { wxEVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
1878 #define EVT_GRID_CELL_CHANGE(fn) { wxEVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1879 #define EVT_GRID_SELECT_CELL(fn) { wxEVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1880 #define EVT_GRID_EDITOR_SHOWN(fn) { wxEVT_GRID_EDITOR_SHOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1881 #define EVT_GRID_EDITOR_HIDDEN(fn) { wxEVT_GRID_EDITOR_HIDDEN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1884 #if 0 // TODO: implement these ? others ?
1886 const wxEventType wxEVT_GRID_CREATE_CELL
= wxEVT_FIRST
+ 1576;
1887 const wxEventType wxEVT_GRID_CHANGE_LABELS
= wxEVT_FIRST
+ 1577;
1888 const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL
= wxEVT_FIRST
+ 1578;
1890 #define EVT_GRID_CREATE_CELL(fn) { wxEVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1891 #define EVT_GRID_CHANGE_LABELS(fn) { wxEVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1892 #define EVT_GRID_CHANGE_SEL_LABEL(fn) { wxEVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1896 #endif // #ifndef __WXGRID_H__
1898 #endif // ifndef wxUSE_NEW_GRID