1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/generic/grid.h
3 // Purpose: wxGrid and related classes
4 // Author: Michael Bedward (based on code by Julian Smart, Robin Dunn)
5 // Modified by: Santiago Palacios
8 // Copyright: (c) Michael Bedward
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_GENERIC_GRID_H_
13 #define _WX_GENERIC_GRID_H_
19 #include "wx/scrolwin.h"
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
25 extern WXDLLIMPEXP_DATA_ADV(const wxChar
) wxGridNameStr
[];
27 // Default parameters for wxGrid
29 #define WXGRID_DEFAULT_NUMBER_ROWS 10
30 #define WXGRID_DEFAULT_NUMBER_COLS 10
31 #if defined(__WXMSW__) || defined(__WXGTK20__)
32 #define WXGRID_DEFAULT_ROW_HEIGHT 25
34 #define WXGRID_DEFAULT_ROW_HEIGHT 30
36 #define WXGRID_DEFAULT_COL_WIDTH 80
37 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT 32
38 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH 82
39 #define WXGRID_LABEL_EDGE_ZONE 2
40 #define WXGRID_MIN_ROW_HEIGHT 15
41 #define WXGRID_MIN_COL_WIDTH 15
42 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH 16
44 // type names for grid table values
45 #define wxGRID_VALUE_STRING _T("string")
46 #define wxGRID_VALUE_BOOL _T("bool")
47 #define wxGRID_VALUE_NUMBER _T("long")
48 #define wxGRID_VALUE_FLOAT _T("double")
49 #define wxGRID_VALUE_CHOICE _T("choice")
51 #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING
52 #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER
54 // magic constant which tells (to some functions) to automatically calculate
55 // the appropriate size
56 #define wxGRID_AUTOSIZE (-1)
58 // many wxGrid methods work either with columns or rows, this enum is used for
59 // the parameter indicating which one should it be
66 // ----------------------------------------------------------------------------
67 // forward declarations
68 // ----------------------------------------------------------------------------
70 class WXDLLIMPEXP_FWD_ADV wxGrid
;
71 class WXDLLIMPEXP_FWD_ADV wxGridCellAttr
;
72 class WXDLLIMPEXP_FWD_ADV wxGridCellAttrProviderData
;
73 class WXDLLIMPEXP_FWD_ADV wxGridColLabelWindow
;
74 class WXDLLIMPEXP_FWD_ADV wxGridCornerLabelWindow
;
75 class WXDLLIMPEXP_FWD_ADV wxGridRowLabelWindow
;
76 class WXDLLIMPEXP_FWD_ADV wxGridWindow
;
77 class WXDLLIMPEXP_FWD_ADV wxGridTypeRegistry
;
78 class WXDLLIMPEXP_FWD_ADV wxGridSelection
;
80 class WXDLLIMPEXP_FWD_CORE wxCheckBox
;
81 class WXDLLIMPEXP_FWD_CORE wxComboBox
;
82 class WXDLLIMPEXP_FWD_CORE wxTextCtrl
;
84 class WXDLLIMPEXP_FWD_CORE wxSpinCtrl
;
87 // ----------------------------------------------------------------------------
89 // ----------------------------------------------------------------------------
91 #define wxSafeIncRef(p) if ( p ) (p)->IncRef()
92 #define wxSafeDecRef(p) if ( p ) (p)->DecRef()
94 // ----------------------------------------------------------------------------
95 // wxGridCellWorker: common base class for wxGridCellRenderer and
98 // NB: this is more an implementation convenience than a design issue, so this
99 // class is not documented and is not public at all
100 // ----------------------------------------------------------------------------
102 class WXDLLIMPEXP_ADV wxGridCellWorker
: public wxClientDataContainer
105 wxGridCellWorker() { m_nRef
= 1; }
107 // this class is ref counted: it is created with ref count of 1, so
108 // calling DecRef() once will delete it. Calling IncRef() allows to lock
109 // it until the matching DecRef() is called
110 void IncRef() { m_nRef
++; }
111 void DecRef() { if ( --m_nRef
== 0 ) delete this; }
113 // interpret renderer parameters: arbitrary string whose interpretatin is
114 // left to the derived classes
115 virtual void SetParameters(const wxString
& params
);
118 // virtual dtor for any base class - private because only DecRef() can
120 virtual ~wxGridCellWorker();
125 // suppress the stupid gcc warning about the class having private dtor and
127 friend class wxGridCellWorkerDummyFriend
;
130 // ----------------------------------------------------------------------------
131 // wxGridCellRenderer: this class is responsible for actually drawing the cell
132 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
133 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
134 // view of all cells. This is an ABC, you will normally use one of the
135 // predefined derived classes or derive your own class from it.
136 // ----------------------------------------------------------------------------
138 class WXDLLIMPEXP_ADV wxGridCellRenderer
: public wxGridCellWorker
141 // draw the given cell on the provided DC inside the given rectangle
142 // using the style specified by the attribute and the default or selected
143 // state corresponding to the isSelected value.
145 // this pure virtual function has a default implementation which will
146 // prepare the DC using the given attribute: it will draw the rectangle
147 // with the bg colour from attr and set the text colour and font
148 virtual void Draw(wxGrid
& grid
,
149 wxGridCellAttr
& attr
,
153 bool isSelected
) = 0;
155 // get the preferred size of the cell for its contents
156 virtual wxSize
GetBestSize(wxGrid
& grid
,
157 wxGridCellAttr
& attr
,
159 int row
, int col
) = 0;
161 // create a new object which is the copy of this one
162 virtual wxGridCellRenderer
*Clone() const = 0;
165 // the default renderer for the cells containing string data
166 class WXDLLIMPEXP_ADV wxGridCellStringRenderer
: public wxGridCellRenderer
170 virtual void Draw(wxGrid
& grid
,
171 wxGridCellAttr
& attr
,
177 // return the string extent
178 virtual wxSize
GetBestSize(wxGrid
& grid
,
179 wxGridCellAttr
& attr
,
183 virtual wxGridCellRenderer
*Clone() const
184 { return new wxGridCellStringRenderer
; }
187 // set the text colours before drawing
188 void SetTextColoursAndFont(const wxGrid
& grid
,
189 const wxGridCellAttr
& attr
,
193 // calc the string extent for given string/font
194 wxSize
DoGetBestSize(const wxGridCellAttr
& attr
,
196 const wxString
& text
);
199 // the default renderer for the cells containing numeric (long) data
200 class WXDLLIMPEXP_ADV wxGridCellNumberRenderer
: public wxGridCellStringRenderer
203 // draw the string right aligned
204 virtual void Draw(wxGrid
& grid
,
205 wxGridCellAttr
& attr
,
211 virtual wxSize
GetBestSize(wxGrid
& grid
,
212 wxGridCellAttr
& attr
,
216 virtual wxGridCellRenderer
*Clone() const
217 { return new wxGridCellNumberRenderer
; }
220 wxString
GetString(const wxGrid
& grid
, int row
, int col
);
223 class WXDLLIMPEXP_ADV wxGridCellFloatRenderer
: public wxGridCellStringRenderer
226 wxGridCellFloatRenderer(int width
= -1, int precision
= -1);
228 // get/change formatting parameters
229 int GetWidth() const { return m_width
; }
230 void SetWidth(int width
) { m_width
= width
; m_format
.clear(); }
231 int GetPrecision() const { return m_precision
; }
232 void SetPrecision(int precision
) { m_precision
= precision
; m_format
.clear(); }
234 // draw the string right aligned with given width/precision
235 virtual void Draw(wxGrid
& grid
,
236 wxGridCellAttr
& attr
,
242 virtual wxSize
GetBestSize(wxGrid
& grid
,
243 wxGridCellAttr
& attr
,
247 // parameters string format is "width[,precision]"
248 virtual void SetParameters(const wxString
& params
);
250 virtual wxGridCellRenderer
*Clone() const;
253 wxString
GetString(const wxGrid
& grid
, int row
, int col
);
256 // formatting parameters
263 // renderer for boolean fields
264 class WXDLLIMPEXP_ADV wxGridCellBoolRenderer
: public wxGridCellRenderer
267 // draw a check mark or nothing
268 virtual void Draw(wxGrid
& grid
,
269 wxGridCellAttr
& attr
,
275 // return the checkmark size
276 virtual wxSize
GetBestSize(wxGrid
& grid
,
277 wxGridCellAttr
& attr
,
281 virtual wxGridCellRenderer
*Clone() const
282 { return new wxGridCellBoolRenderer
; }
285 static wxSize ms_sizeCheckMark
;
288 // ----------------------------------------------------------------------------
289 // wxGridCellEditor: This class is responsible for providing and manipulating
290 // the in-place edit controls for the grid. Instances of wxGridCellEditor
291 // (actually, instances of derived classes since it is an ABC) can be
292 // associated with the cell attributes for individual cells, rows, columns, or
293 // even for the entire grid.
294 // ----------------------------------------------------------------------------
296 class WXDLLIMPEXP_ADV wxGridCellEditor
: public wxGridCellWorker
301 bool IsCreated() { return m_control
!= NULL
; }
302 wxControl
* GetControl() { return m_control
; }
303 void SetControl(wxControl
* control
) { m_control
= control
; }
305 wxGridCellAttr
* GetCellAttr() { return m_attr
; }
306 void SetCellAttr(wxGridCellAttr
* attr
) { m_attr
= attr
; }
308 // Creates the actual edit control
309 virtual void Create(wxWindow
* parent
,
311 wxEvtHandler
* evtHandler
) = 0;
313 // Size and position the edit control
314 virtual void SetSize(const wxRect
& rect
);
316 // Show or hide the edit control, use the specified attributes to set
317 // colours/fonts for it
318 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
320 // Draws the part of the cell not occupied by the control: the base class
321 // version just fills it with background colour from the attribute
322 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
324 // Fetch the value from the table and prepare the edit control
325 // to begin editing. Set the focus to the edit control.
326 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
328 // Complete the editing of the current cell. Returns true if the value has
329 // changed. If necessary, the control may be destroyed.
330 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
) = 0;
332 // Reset the value in the control back to its starting value
333 virtual void Reset() = 0;
335 // return true to allow the given key to start editing: the base class
336 // version only checks that the event has no modifiers. The derived
337 // classes are supposed to do "if ( base::IsAcceptedKey() && ... )" in
338 // their IsAcceptedKey() implementation, although, of course, it is not a
339 // mandatory requirment.
341 // NB: if the key is F2 (special), editing will always start and this
342 // method will not be called at all (but StartingKey() will)
343 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
345 // If the editor is enabled by pressing keys on the grid, this will be
346 // called to let the editor do something about that first key if desired
347 virtual void StartingKey(wxKeyEvent
& event
);
349 // if the editor is enabled by clicking on the cell, this method will be
351 virtual void StartingClick();
353 // Some types of controls on some platforms may need some help
354 // with the Return key.
355 virtual void HandleReturn(wxKeyEvent
& event
);
358 virtual void Destroy();
360 // create a new object which is the copy of this one
361 virtual wxGridCellEditor
*Clone() const = 0;
363 // added GetValue so we can get the value which is in the control
364 virtual wxString
GetValue() const = 0;
367 // the dtor is private because only DecRef() can delete us
368 virtual ~wxGridCellEditor();
370 // the control we show on screen
371 wxControl
* m_control
;
373 // a temporary pointer to the attribute being edited
374 wxGridCellAttr
* m_attr
;
376 // if we change the colours/font of the control from the default ones, we
377 // must restore the default later and we save them here between calls to
378 // Show(true) and Show(false)
383 // suppress the stupid gcc warning about the class having private dtor and
385 friend class wxGridCellEditorDummyFriend
;
387 DECLARE_NO_COPY_CLASS(wxGridCellEditor
)
392 // the editor for string/text data
393 class WXDLLIMPEXP_ADV wxGridCellTextEditor
: public wxGridCellEditor
396 wxGridCellTextEditor();
398 virtual void Create(wxWindow
* parent
,
400 wxEvtHandler
* evtHandler
);
401 virtual void SetSize(const wxRect
& rect
);
403 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
405 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
406 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
407 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
409 virtual void Reset();
410 virtual void StartingKey(wxKeyEvent
& event
);
411 virtual void HandleReturn(wxKeyEvent
& event
);
413 // parameters string format is "max_width"
414 virtual void SetParameters(const wxString
& params
);
416 virtual wxGridCellEditor
*Clone() const
417 { return new wxGridCellTextEditor
; }
419 // added GetValue so we can get the value which is in the control
420 virtual wxString
GetValue() const;
423 wxTextCtrl
*Text() const { return (wxTextCtrl
*)m_control
; }
425 // parts of our virtual functions reused by the derived classes
426 void DoCreate(wxWindow
* parent
, wxWindowID id
, wxEvtHandler
* evtHandler
,
428 void DoBeginEdit(const wxString
& startValue
);
429 void DoReset(const wxString
& startValue
);
432 size_t m_maxChars
; // max number of chars allowed
433 wxString m_startValue
;
435 DECLARE_NO_COPY_CLASS(wxGridCellTextEditor
)
438 // the editor for numeric (long) data
439 class WXDLLIMPEXP_ADV wxGridCellNumberEditor
: public wxGridCellTextEditor
442 // allows to specify the range - if min == max == -1, no range checking is
444 wxGridCellNumberEditor(int min
= -1, int max
= -1);
446 virtual void Create(wxWindow
* parent
,
448 wxEvtHandler
* evtHandler
);
450 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
451 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
452 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
454 virtual void Reset();
455 virtual void StartingKey(wxKeyEvent
& event
);
457 // parameters string format is "min,max"
458 virtual void SetParameters(const wxString
& params
);
460 virtual wxGridCellEditor
*Clone() const
461 { return new wxGridCellNumberEditor(m_min
, m_max
); }
463 // added GetValue so we can get the value which is in the control
464 virtual wxString
GetValue() const;
468 wxSpinCtrl
*Spin() const { return (wxSpinCtrl
*)m_control
; }
471 // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl
472 bool HasRange() const
475 return m_min
!= m_max
;
481 // string representation of m_valueOld
482 wxString
GetString() const
483 { return wxString::Format(_T("%ld"), m_valueOld
); }
491 DECLARE_NO_COPY_CLASS(wxGridCellNumberEditor
)
494 // the editor for floating point numbers (double) data
495 class WXDLLIMPEXP_ADV wxGridCellFloatEditor
: public wxGridCellTextEditor
498 wxGridCellFloatEditor(int width
= -1, int precision
= -1);
500 virtual void Create(wxWindow
* parent
,
502 wxEvtHandler
* evtHandler
);
504 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
505 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
506 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
508 virtual void Reset();
509 virtual void StartingKey(wxKeyEvent
& event
);
511 virtual wxGridCellEditor
*Clone() const
512 { return new wxGridCellFloatEditor(m_width
, m_precision
); }
514 // parameters string format is "width,precision"
515 virtual void SetParameters(const wxString
& params
);
518 // string representation of m_valueOld
519 wxString
GetString() const;
526 DECLARE_NO_COPY_CLASS(wxGridCellFloatEditor
)
529 #endif // wxUSE_TEXTCTRL
533 // the editor for boolean data
534 class WXDLLIMPEXP_ADV wxGridCellBoolEditor
: public wxGridCellEditor
537 wxGridCellBoolEditor() { }
539 virtual void Create(wxWindow
* parent
,
541 wxEvtHandler
* evtHandler
);
543 virtual void SetSize(const wxRect
& rect
);
544 virtual void Show(bool show
, wxGridCellAttr
*attr
= NULL
);
546 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
547 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
548 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
550 virtual void Reset();
551 virtual void StartingClick();
552 virtual void StartingKey(wxKeyEvent
& event
);
554 virtual wxGridCellEditor
*Clone() const
555 { return new wxGridCellBoolEditor
; }
557 // added GetValue so we can get the value which is in the control, see
558 // also UseStringValues()
559 virtual wxString
GetValue() const;
561 // set the string values returned by GetValue() for the true and false
562 // states, respectively
563 static void UseStringValues(const wxString
& valueTrue
= _T("1"),
564 const wxString
& valueFalse
= wxEmptyString
);
566 // return true if the given string is equal to the string representation of
567 // true value which we currently use
568 static bool IsTrueValue(const wxString
& value
);
571 wxCheckBox
*CBox() const { return (wxCheckBox
*)m_control
; }
576 static wxString ms_stringValues
[2];
578 DECLARE_NO_COPY_CLASS(wxGridCellBoolEditor
)
581 #endif // wxUSE_CHECKBOX
585 // the editor for string data allowing to choose from the list of strings
586 class WXDLLIMPEXP_ADV wxGridCellChoiceEditor
: public wxGridCellEditor
589 // if !allowOthers, user can't type a string not in choices array
590 wxGridCellChoiceEditor(size_t count
= 0,
591 const wxString choices
[] = NULL
,
592 bool allowOthers
= false);
593 wxGridCellChoiceEditor(const wxArrayString
& choices
,
594 bool allowOthers
= false);
596 virtual void Create(wxWindow
* parent
,
598 wxEvtHandler
* evtHandler
);
600 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
602 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
603 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
605 virtual void Reset();
607 // parameters string format is "item1[,item2[...,itemN]]"
608 virtual void SetParameters(const wxString
& params
);
610 virtual wxGridCellEditor
*Clone() const;
612 // added GetValue so we can get the value which is in the control
613 virtual wxString
GetValue() const;
616 wxComboBox
*Combo() const { return (wxComboBox
*)m_control
; }
618 // DJC - (MAPTEK) you at least need access to m_choices if you
619 // wish to override this class
621 wxString m_startValue
;
622 wxArrayString m_choices
;
625 DECLARE_NO_COPY_CLASS(wxGridCellChoiceEditor
)
628 #endif // wxUSE_COMBOBOX
630 // ----------------------------------------------------------------------------
631 // wxGridCellAttr: this class can be used to alter the cells appearance in
632 // the grid by changing their colour/font/... from default. An object of this
633 // class may be returned by wxGridTable::GetAttr().
634 // ----------------------------------------------------------------------------
636 class WXDLLIMPEXP_ADV wxGridCellAttr
: public wxClientDataContainer
650 wxGridCellAttr(wxGridCellAttr
*attrDefault
= NULL
)
654 // MB: args used to be 0,0 here but wxALIGN_LEFT is 0
655 SetAlignment(-1, -1);
658 // VZ: considering the number of members wxGridCellAttr has now, this ctor
659 // seems to be pretty useless... may be we should just remove it?
660 wxGridCellAttr(const wxColour
& colText
,
661 const wxColour
& colBack
,
665 : m_colText(colText
), m_colBack(colBack
), m_font(font
)
668 SetAlignment(hAlign
, vAlign
);
671 // creates a new copy of this object
672 wxGridCellAttr
*Clone() const;
673 void MergeWith(wxGridCellAttr
*mergefrom
);
675 // this class is ref counted: it is created with ref count of 1, so
676 // calling DecRef() once will delete it. Calling IncRef() allows to lock
677 // it until the matching DecRef() is called
678 void IncRef() { m_nRef
++; }
679 void DecRef() { if ( --m_nRef
== 0 ) delete this; }
682 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
683 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
684 void SetFont(const wxFont
& font
) { m_font
= font
; }
685 void SetAlignment(int hAlign
, int vAlign
)
690 void SetSize(int num_rows
, int num_cols
);
691 void SetOverflow(bool allow
= true)
692 { m_overflow
= allow
? Overflow
: SingleCell
; }
693 void SetReadOnly(bool isReadOnly
= true)
694 { m_isReadOnly
= isReadOnly
? ReadOnly
: ReadWrite
; }
696 // takes ownership of the pointer
697 void SetRenderer(wxGridCellRenderer
*renderer
)
698 { wxSafeDecRef(m_renderer
); m_renderer
= renderer
; }
699 void SetEditor(wxGridCellEditor
* editor
)
700 { wxSafeDecRef(m_editor
); m_editor
= editor
; }
702 void SetKind(wxAttrKind kind
) { m_attrkind
= kind
; }
705 bool HasTextColour() const { return m_colText
.Ok(); }
706 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
707 bool HasFont() const { return m_font
.Ok(); }
708 bool HasAlignment() const { return (m_hAlign
!= -1 || m_vAlign
!= -1); }
709 bool HasRenderer() const { return m_renderer
!= NULL
; }
710 bool HasEditor() const { return m_editor
!= NULL
; }
711 bool HasReadWriteMode() const { return m_isReadOnly
!= Unset
; }
712 bool HasOverflowMode() const { return m_overflow
!= UnsetOverflow
; }
713 bool HasSize() const { return m_sizeRows
!= 1 || m_sizeCols
!= 1; }
715 const wxColour
& GetTextColour() const;
716 const wxColour
& GetBackgroundColour() const;
717 const wxFont
& GetFont() const;
718 void GetAlignment(int *hAlign
, int *vAlign
) const;
719 void GetSize(int *num_rows
, int *num_cols
) const;
720 bool GetOverflow() const
721 { return m_overflow
!= SingleCell
; }
722 wxGridCellRenderer
*GetRenderer(const wxGrid
* grid
, int row
, int col
) const;
723 wxGridCellEditor
*GetEditor(const wxGrid
* grid
, int row
, int col
) const;
725 bool IsReadOnly() const { return m_isReadOnly
== wxGridCellAttr::ReadOnly
; }
727 wxAttrKind
GetKind() { return m_attrkind
; }
729 void SetDefAttr(wxGridCellAttr
* defAttr
) { m_defGridAttr
= defAttr
; }
732 // the dtor is private because only DecRef() can delete us
733 virtual ~wxGridCellAttr()
735 wxSafeDecRef(m_renderer
);
736 wxSafeDecRef(m_editor
);
747 enum wxAttrOverflowMode
754 // the common part of all ctors
755 void Init(wxGridCellAttr
*attrDefault
= NULL
);
758 // the ref count - when it goes to 0, we die
769 wxAttrOverflowMode m_overflow
;
771 wxGridCellRenderer
* m_renderer
;
772 wxGridCellEditor
* m_editor
;
773 wxGridCellAttr
* m_defGridAttr
;
775 wxAttrReadMode m_isReadOnly
;
777 wxAttrKind m_attrkind
;
779 // use Clone() instead
780 DECLARE_NO_COPY_CLASS(wxGridCellAttr
)
782 // suppress the stupid gcc warning about the class having private dtor and
784 friend class wxGridCellAttrDummyFriend
;
787 // ----------------------------------------------------------------------------
788 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
790 // ----------------------------------------------------------------------------
792 // implementation note: we separate it from wxGridTableBase because we wish to
793 // avoid deriving a new table class if possible, and sometimes it will be
794 // enough to just derive another wxGridCellAttrProvider instead
796 // the default implementation is reasonably efficient for the generic case,
797 // but you might still wish to implement your own for some specific situations
798 // if you have performance problems with the stock one
799 class WXDLLIMPEXP_ADV wxGridCellAttrProvider
: public wxClientDataContainer
802 wxGridCellAttrProvider();
803 virtual ~wxGridCellAttrProvider();
805 // DecRef() must be called on the returned pointer
806 virtual wxGridCellAttr
*GetAttr(int row
, int col
,
807 wxGridCellAttr::wxAttrKind kind
) const;
809 // all these functions take ownership of the pointer, don't call DecRef()
811 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
812 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
813 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
815 // these functions must be called whenever some rows/cols are deleted
816 // because the internal data must be updated then
817 void UpdateAttrRows( size_t pos
, int numRows
);
818 void UpdateAttrCols( size_t pos
, int numCols
);
823 wxGridCellAttrProviderData
*m_data
;
825 DECLARE_NO_COPY_CLASS(wxGridCellAttrProvider
)
828 //////////////////////////////////////////////////////////////////////
830 // Grid table classes
832 //////////////////////////////////////////////////////////////////////
835 class WXDLLIMPEXP_ADV wxGridTableBase
: public wxObject
, public wxClientDataContainer
839 virtual ~wxGridTableBase();
841 // You must override these functions in a derived table class
843 virtual int GetNumberRows() = 0;
844 virtual int GetNumberCols() = 0;
845 virtual bool IsEmptyCell( int row
, int col
) = 0;
846 virtual wxString
GetValue( int row
, int col
) = 0;
847 virtual void SetValue( int row
, int col
, const wxString
& value
) = 0;
849 // Data type determination and value access
850 virtual wxString
GetTypeName( int row
, int col
);
851 virtual bool CanGetValueAs( int row
, int col
, const wxString
& typeName
);
852 virtual bool CanSetValueAs( int row
, int col
, const wxString
& typeName
);
854 virtual long GetValueAsLong( int row
, int col
);
855 virtual double GetValueAsDouble( int row
, int col
);
856 virtual bool GetValueAsBool( int row
, int col
);
858 virtual void SetValueAsLong( int row
, int col
, long value
);
859 virtual void SetValueAsDouble( int row
, int col
, double value
);
860 virtual void SetValueAsBool( int row
, int col
, bool value
);
862 // For user defined types
863 virtual void* GetValueAsCustom( int row
, int col
, const wxString
& typeName
);
864 virtual void SetValueAsCustom( int row
, int col
, const wxString
& typeName
, void* value
);
867 // Overriding these is optional
869 virtual void SetView( wxGrid
*grid
) { m_view
= grid
; }
870 virtual wxGrid
* GetView() const { return m_view
; }
872 virtual void Clear() {}
873 virtual bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
874 virtual bool AppendRows( size_t numRows
= 1 );
875 virtual bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
876 virtual bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
877 virtual bool AppendCols( size_t numCols
= 1 );
878 virtual bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
880 virtual wxString
GetRowLabelValue( int row
);
881 virtual wxString
GetColLabelValue( int col
);
882 virtual void SetRowLabelValue( int WXUNUSED(row
), const wxString
& ) {}
883 virtual void SetColLabelValue( int WXUNUSED(col
), const wxString
& ) {}
885 // Attribute handling
888 // give us the attr provider to use - we take ownership of the pointer
889 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
891 // get the currently used attr provider (may be NULL)
892 wxGridCellAttrProvider
*GetAttrProvider() const { return m_attrProvider
; }
894 // Does this table allow attributes? Default implementation creates
895 // a wxGridCellAttrProvider if necessary.
896 virtual bool CanHaveAttributes();
898 // by default forwarded to wxGridCellAttrProvider if any. May be
899 // overridden to handle attributes directly in the table.
900 virtual wxGridCellAttr
*GetAttr( int row
, int col
,
901 wxGridCellAttr::wxAttrKind kind
);
904 // these functions take ownership of the pointer
905 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
906 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
907 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
911 wxGridCellAttrProvider
*m_attrProvider
;
913 DECLARE_ABSTRACT_CLASS(wxGridTableBase
)
914 DECLARE_NO_COPY_CLASS(wxGridTableBase
)
918 // ----------------------------------------------------------------------------
919 // wxGridTableMessage
920 // ----------------------------------------------------------------------------
922 // IDs for messages sent from grid table to view
924 enum wxGridTableRequest
926 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
= 2000,
927 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES
,
928 wxGRIDTABLE_NOTIFY_ROWS_INSERTED
,
929 wxGRIDTABLE_NOTIFY_ROWS_APPENDED
,
930 wxGRIDTABLE_NOTIFY_ROWS_DELETED
,
931 wxGRIDTABLE_NOTIFY_COLS_INSERTED
,
932 wxGRIDTABLE_NOTIFY_COLS_APPENDED
,
933 wxGRIDTABLE_NOTIFY_COLS_DELETED
936 class WXDLLIMPEXP_ADV wxGridTableMessage
939 wxGridTableMessage();
940 wxGridTableMessage( wxGridTableBase
*table
, int id
,
944 void SetTableObject( wxGridTableBase
*table
) { m_table
= table
; }
945 wxGridTableBase
* GetTableObject() const { return m_table
; }
946 void SetId( int id
) { m_id
= id
; }
947 int GetId() { return m_id
; }
948 void SetCommandInt( int comInt1
) { m_comInt1
= comInt1
; }
949 int GetCommandInt() { return m_comInt1
; }
950 void SetCommandInt2( int comInt2
) { m_comInt2
= comInt2
; }
951 int GetCommandInt2() { return m_comInt2
; }
954 wxGridTableBase
*m_table
;
959 DECLARE_NO_COPY_CLASS(wxGridTableMessage
)
964 // ------ wxGridStringArray
965 // A 2-dimensional array of strings for data values
968 WX_DECLARE_OBJARRAY_WITH_DECL(wxArrayString
, wxGridStringArray
,
969 class WXDLLIMPEXP_ADV
);
973 // ------ wxGridStringTable
975 // Simplest type of data table for a grid for small tables of strings
976 // that are stored in memory
979 class WXDLLIMPEXP_ADV wxGridStringTable
: public wxGridTableBase
983 wxGridStringTable( int numRows
, int numCols
);
984 virtual ~wxGridStringTable();
986 // these are pure virtual in wxGridTableBase
990 wxString
GetValue( int row
, int col
);
991 void SetValue( int row
, int col
, const wxString
& s
);
992 bool IsEmptyCell( int row
, int col
);
994 // overridden functions from wxGridTableBase
997 bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
998 bool AppendRows( size_t numRows
= 1 );
999 bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
1000 bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
1001 bool AppendCols( size_t numCols
= 1 );
1002 bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
1004 void SetRowLabelValue( int row
, const wxString
& );
1005 void SetColLabelValue( int col
, const wxString
& );
1006 wxString
GetRowLabelValue( int row
);
1007 wxString
GetColLabelValue( int col
);
1010 wxGridStringArray m_data
;
1012 // These only get used if you set your own labels, otherwise the
1013 // GetRow/ColLabelValue functions return wxGridTableBase defaults
1015 wxArrayString m_rowLabels
;
1016 wxArrayString m_colLabels
;
1018 DECLARE_DYNAMIC_CLASS_NO_COPY( wxGridStringTable
)
1023 // ============================================================================
1024 // Grid view classes
1025 // ============================================================================
1027 // ----------------------------------------------------------------------------
1028 // wxGridCellCoords: location of a cell in the grid
1029 // ----------------------------------------------------------------------------
1031 class WXDLLIMPEXP_ADV wxGridCellCoords
1034 wxGridCellCoords() { m_row
= m_col
= -1; }
1035 wxGridCellCoords( int r
, int c
) { m_row
= r
; m_col
= c
; }
1037 // default copy ctor is ok
1039 int GetRow() const { return m_row
; }
1040 void SetRow( int n
) { m_row
= n
; }
1041 int GetCol() const { return m_col
; }
1042 void SetCol( int n
) { m_col
= n
; }
1043 void Set( int row
, int col
) { m_row
= row
; m_col
= col
; }
1045 wxGridCellCoords
& operator=( const wxGridCellCoords
& other
)
1047 if ( &other
!= this )
1055 bool operator==( const wxGridCellCoords
& other
) const
1057 return (m_row
== other
.m_row
&& m_col
== other
.m_col
);
1060 bool operator!=( const wxGridCellCoords
& other
) const
1062 return (m_row
!= other
.m_row
|| m_col
!= other
.m_col
);
1065 bool operator!() const
1067 return (m_row
== -1 && m_col
== -1 );
1076 // For comparisons...
1078 extern WXDLLIMPEXP_ADV wxGridCellCoords wxGridNoCellCoords
;
1079 extern WXDLLIMPEXP_ADV wxRect wxGridNoCellRect
;
1081 // An array of cell coords...
1083 WX_DECLARE_OBJARRAY_WITH_DECL(wxGridCellCoords
, wxGridCellCoordsArray
,
1084 class WXDLLIMPEXP_ADV
);
1086 // ----------------------------------------------------------------------------
1088 // ----------------------------------------------------------------------------
1090 class WXDLLIMPEXP_ADV wxGrid
: public wxScrolledWindow
1093 // possible selection modes
1094 enum wxGridSelectionModes
1096 wxGridSelectCells
= 0, // allow selecting anything
1097 wxGridSelectRows
= 1, // allow selecting only entire rows
1098 wxGridSelectColumns
= 2, // allow selecting only entire columns
1099 wxGridSelectRowsOrColumns
= wxGridSelectRows
| wxGridSelectColumns
1102 // creation and destruction
1103 // ------------------------
1105 // ctor and Create() create the grid window, as with the other controls
1108 wxGrid(wxWindow
*parent
,
1110 const wxPoint
& pos
= wxDefaultPosition
,
1111 const wxSize
& size
= wxDefaultSize
,
1112 long style
= wxWANTS_CHARS
,
1113 const wxString
& name
= wxGridNameStr
);
1115 bool Create(wxWindow
*parent
,
1117 const wxPoint
& pos
= wxDefaultPosition
,
1118 const wxSize
& size
= wxDefaultSize
,
1119 long style
= wxWANTS_CHARS
,
1120 const wxString
& name
= wxGridNameStr
);
1124 // however to initialize grid data either CreateGrid() or SetTable() must
1127 // this is basically equivalent to
1129 // SetTable(new wxGridStringTable(numRows, numCols), true, selmode)
1131 bool CreateGrid( int numRows
, int numCols
,
1132 wxGridSelectionModes selmode
= wxGridSelectCells
);
1134 bool SetTable( wxGridTableBase
*table
,
1135 bool takeOwnership
= false,
1136 wxGridSelectionModes selmode
= wxGridSelectCells
);
1139 void SetSelectionMode(wxGridSelectionModes selmode
);
1140 wxGridSelectionModes
GetSelectionMode() const;
1142 // ------ grid dimensions
1144 int GetNumberRows() const { return m_numRows
; }
1145 int GetNumberCols() const { return m_numCols
; }
1148 // ------ display update functions
1150 wxArrayInt
CalcRowLabelsExposed( const wxRegion
& reg
) const;
1152 wxArrayInt
CalcColLabelsExposed( const wxRegion
& reg
) const;
1153 wxGridCellCoordsArray
CalcCellsExposed( const wxRegion
& reg
) const;
1156 // ------ event handlers
1158 void ProcessRowLabelMouseEvent( wxMouseEvent
& event
);
1159 void ProcessColLabelMouseEvent( wxMouseEvent
& event
);
1160 void ProcessCornerLabelMouseEvent( wxMouseEvent
& event
);
1161 void ProcessGridCellMouseEvent( wxMouseEvent
& event
);
1162 bool ProcessTableMessage( wxGridTableMessage
& );
1164 void DoEndDragResizeRow();
1165 void DoEndDragResizeCol();
1166 void DoEndDragMoveCol();
1168 wxGridTableBase
* GetTable() const { return m_table
; }
1171 bool InsertRows( int pos
= 0, int numRows
= 1, bool updateLabels
= true );
1172 bool AppendRows( int numRows
= 1, bool updateLabels
= true );
1173 bool DeleteRows( int pos
= 0, int numRows
= 1, bool updateLabels
= true );
1174 bool InsertCols( int pos
= 0, int numCols
= 1, bool updateLabels
= true );
1175 bool AppendCols( int numCols
= 1, bool updateLabels
= true );
1176 bool DeleteCols( int pos
= 0, int numCols
= 1, bool updateLabels
= true );
1178 void DrawGridCellArea( wxDC
& dc
, const wxGridCellCoordsArray
& cells
);
1179 void DrawGridSpace( wxDC
& dc
);
1180 void DrawCellBorder( wxDC
& dc
, const wxGridCellCoords
& );
1181 void DrawAllGridLines( wxDC
& dc
, const wxRegion
& reg
);
1182 void DrawCell( wxDC
& dc
, const wxGridCellCoords
& );
1183 void DrawHighlight(wxDC
& dc
, const wxGridCellCoordsArray
& cells
);
1185 // this function is called when the current cell highlight must be redrawn
1186 // and may be overridden by the user
1187 virtual void DrawCellHighlight( wxDC
& dc
, const wxGridCellAttr
*attr
);
1189 virtual void DrawRowLabels( wxDC
& dc
, const wxArrayInt
& rows
);
1190 virtual void DrawRowLabel( wxDC
& dc
, int row
);
1192 virtual void DrawColLabels( wxDC
& dc
, const wxArrayInt
& cols
);
1193 virtual void DrawColLabel( wxDC
& dc
, int col
);
1195 virtual void DrawCornerLabel(wxDC
& dc
);
1197 // ------ Cell text drawing functions
1199 void DrawTextRectangle( wxDC
& dc
, const wxString
&, const wxRect
&,
1200 int horizontalAlignment
= wxALIGN_LEFT
,
1201 int verticalAlignment
= wxALIGN_TOP
,
1202 int textOrientation
= wxHORIZONTAL
);
1204 void DrawTextRectangle( wxDC
& dc
, const wxArrayString
& lines
, const wxRect
&,
1205 int horizontalAlignment
= wxALIGN_LEFT
,
1206 int verticalAlignment
= wxALIGN_TOP
,
1207 int textOrientation
= wxHORIZONTAL
);
1210 // Split a string containing newline characters into an array of
1211 // strings and return the number of lines
1213 void StringToLines( const wxString
& value
, wxArrayString
& lines
) const;
1215 void GetTextBoxSize( const wxDC
& dc
,
1216 const wxArrayString
& lines
,
1217 long *width
, long *height
) const;
1221 // Code that does a lot of grid modification can be enclosed
1222 // between BeginBatch() and EndBatch() calls to avoid screen
1225 void BeginBatch() { m_batchCount
++; }
1228 int GetBatchCount() { return m_batchCount
; }
1230 virtual void Refresh(bool eraseb
= true,
1231 const wxRect
* rect
= (const wxRect
*) NULL
);
1233 // Use this, rather than wxWindow::Refresh(), to force an
1234 // immediate repainting of the grid. Has no effect if you are
1235 // already inside a BeginBatch / EndBatch block.
1237 // This function is necessary because wxGrid has a minimal OnPaint()
1238 // handler to reduce screen flicker.
1240 void ForceRefresh();
1243 // ------ edit control functions
1245 bool IsEditable() const { return m_editable
; }
1246 void EnableEditing( bool edit
);
1248 void EnableCellEditControl( bool enable
= true );
1249 void DisableCellEditControl() { EnableCellEditControl(false); }
1250 bool CanEnableCellControl() const;
1251 bool IsCellEditControlEnabled() const;
1252 bool IsCellEditControlShown() const;
1254 bool IsCurrentCellReadOnly() const;
1256 void ShowCellEditControl();
1257 void HideCellEditControl();
1258 void SaveEditControlValue();
1261 // ------ grid location functions
1262 // Note that all of these functions work with the logical coordinates of
1263 // grid cells and labels so you will need to convert from device
1264 // coordinates for mouse events etc.
1266 void XYToCell( int x
, int y
, wxGridCellCoords
& ) const;
1267 int YToRow( int y
) const;
1268 int XToCol( int x
, bool clipToMinMax
= false ) const;
1270 int YToEdgeOfRow( int y
) const;
1271 int XToEdgeOfCol( int x
) const;
1273 wxRect
CellToRect( int row
, int col
) const;
1274 wxRect
CellToRect( const wxGridCellCoords
& coords
) const
1275 { return CellToRect( coords
.GetRow(), coords
.GetCol() ); }
1277 int GetGridCursorRow() const { return m_currentCellCoords
.GetRow(); }
1278 int GetGridCursorCol() const { return m_currentCellCoords
.GetCol(); }
1280 // check to see if a cell is either wholly visible (the default arg) or
1281 // at least partially visible in the grid window
1283 bool IsVisible( int row
, int col
, bool wholeCellVisible
= true ) const;
1284 bool IsVisible( const wxGridCellCoords
& coords
, bool wholeCellVisible
= true ) const
1285 { return IsVisible( coords
.GetRow(), coords
.GetCol(), wholeCellVisible
); }
1286 void MakeCellVisible( int row
, int col
);
1287 void MakeCellVisible( const wxGridCellCoords
& coords
)
1288 { MakeCellVisible( coords
.GetRow(), coords
.GetCol() ); }
1291 // ------ grid cursor movement functions
1293 void SetGridCursor( int row
, int col
)
1294 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1296 bool MoveCursorUp( bool expandSelection
);
1297 bool MoveCursorDown( bool expandSelection
);
1298 bool MoveCursorLeft( bool expandSelection
);
1299 bool MoveCursorRight( bool expandSelection
);
1300 bool MovePageDown();
1302 bool MoveCursorUpBlock( bool expandSelection
);
1303 bool MoveCursorDownBlock( bool expandSelection
);
1304 bool MoveCursorLeftBlock( bool expandSelection
);
1305 bool MoveCursorRightBlock( bool expandSelection
);
1308 // ------ label and gridline formatting
1310 int GetDefaultRowLabelSize() const { return WXGRID_DEFAULT_ROW_LABEL_WIDTH
; }
1311 int GetRowLabelSize() const { return m_rowLabelWidth
; }
1312 int GetDefaultColLabelSize() const { return WXGRID_DEFAULT_COL_LABEL_HEIGHT
; }
1313 int GetColLabelSize() const { return m_colLabelHeight
; }
1314 wxColour
GetLabelBackgroundColour() const { return m_labelBackgroundColour
; }
1315 wxColour
GetLabelTextColour() const { return m_labelTextColour
; }
1316 wxFont
GetLabelFont() const { return m_labelFont
; }
1317 void GetRowLabelAlignment( int *horiz
, int *vert
) const;
1318 void GetColLabelAlignment( int *horiz
, int *vert
) const;
1319 int GetColLabelTextOrientation() const;
1320 wxString
GetRowLabelValue( int row
) const;
1321 wxString
GetColLabelValue( int col
) const;
1322 wxColour
GetGridLineColour() const { return m_gridLineColour
; }
1324 // these methods may be overridden to customize individual grid lines
1326 virtual wxPen
GetDefaultGridLinePen();
1327 virtual wxPen
GetRowGridLinePen(int row
);
1328 virtual wxPen
GetColGridLinePen(int col
);
1329 wxColour
GetCellHighlightColour() const { return m_cellHighlightColour
; }
1330 int GetCellHighlightPenWidth() const { return m_cellHighlightPenWidth
; }
1331 int GetCellHighlightROPenWidth() const { return m_cellHighlightROPenWidth
; }
1333 void SetUseNativeColLabels( bool native
= true );
1334 void SetRowLabelSize( int width
);
1335 void SetColLabelSize( int height
);
1336 void HideRowLabels() { SetRowLabelSize( 0 ); }
1337 void HideColLabels() { SetColLabelSize( 0 ); }
1338 void SetLabelBackgroundColour( const wxColour
& );
1339 void SetLabelTextColour( const wxColour
& );
1340 void SetLabelFont( const wxFont
& );
1341 void SetRowLabelAlignment( int horiz
, int vert
);
1342 void SetColLabelAlignment( int horiz
, int vert
);
1343 void SetColLabelTextOrientation( int textOrientation
);
1344 void SetRowLabelValue( int row
, const wxString
& );
1345 void SetColLabelValue( int col
, const wxString
& );
1346 void SetGridLineColour( const wxColour
& );
1347 void SetCellHighlightColour( const wxColour
& );
1348 void SetCellHighlightPenWidth(int width
);
1349 void SetCellHighlightROPenWidth(int width
);
1351 void EnableDragRowSize( bool enable
= true );
1352 void DisableDragRowSize() { EnableDragRowSize( false ); }
1353 bool CanDragRowSize() const { return m_canDragRowSize
; }
1354 void EnableDragColSize( bool enable
= true );
1355 void DisableDragColSize() { EnableDragColSize( false ); }
1356 bool CanDragColSize() const { return m_canDragColSize
; }
1357 void EnableDragColMove( bool enable
= true );
1358 void DisableDragColMove() { EnableDragColMove( false ); }
1359 bool CanDragColMove() const { return m_canDragColMove
; }
1360 void EnableDragGridSize(bool enable
= true);
1361 void DisableDragGridSize() { EnableDragGridSize(false); }
1362 bool CanDragGridSize() const { return m_canDragGridSize
; }
1364 void EnableDragCell( bool enable
= true );
1365 void DisableDragCell() { EnableDragCell( false ); }
1366 bool CanDragCell() const { return m_canDragCell
; }
1368 // this sets the specified attribute for this cell or in this row/col
1369 void SetAttr(int row
, int col
, wxGridCellAttr
*attr
);
1370 void SetRowAttr(int row
, wxGridCellAttr
*attr
);
1371 void SetColAttr(int col
, wxGridCellAttr
*attr
);
1373 // returns the attribute we may modify in place: a new one if this cell
1374 // doesn't have any yet or the existing one if it does
1376 // DecRef() must be called on the returned pointer, as usual
1377 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1380 // shortcuts for setting the column parameters
1382 // set the format for the data in the column: default is string
1383 void SetColFormatBool(int col
);
1384 void SetColFormatNumber(int col
);
1385 void SetColFormatFloat(int col
, int width
= -1, int precision
= -1);
1386 void SetColFormatCustom(int col
, const wxString
& typeName
);
1388 void EnableGridLines( bool enable
= true );
1389 bool GridLinesEnabled() const { return m_gridLinesEnabled
; }
1391 // ------ row and col formatting
1393 int GetDefaultRowSize() const;
1394 int GetRowSize( int row
) const;
1395 int GetDefaultColSize() const;
1396 int GetColSize( int col
) const;
1397 wxColour
GetDefaultCellBackgroundColour() const;
1398 wxColour
GetCellBackgroundColour( int row
, int col
) const;
1399 wxColour
GetDefaultCellTextColour() const;
1400 wxColour
GetCellTextColour( int row
, int col
) const;
1401 wxFont
GetDefaultCellFont() const;
1402 wxFont
GetCellFont( int row
, int col
) const;
1403 void GetDefaultCellAlignment( int *horiz
, int *vert
) const;
1404 void GetCellAlignment( int row
, int col
, int *horiz
, int *vert
) const;
1405 bool GetDefaultCellOverflow() const;
1406 bool GetCellOverflow( int row
, int col
) const;
1407 void GetCellSize( int row
, int col
, int *num_rows
, int *num_cols
) const;
1409 void SetDefaultRowSize( int height
, bool resizeExistingRows
= false );
1410 void SetRowSize( int row
, int height
);
1411 void SetDefaultColSize( int width
, bool resizeExistingCols
= false );
1413 void SetColSize( int col
, int width
);
1416 int GetColAt( int colPos
) const
1418 if ( m_colAt
.IsEmpty() )
1421 return m_colAt
[colPos
];
1424 void SetColPos( int colID
, int newPos
);
1426 int GetColPos( int colID
) const
1428 if ( m_colAt
.IsEmpty() )
1432 for ( int i
= 0; i
< m_numCols
; i
++ )
1434 if ( m_colAt
[i
] == colID
)
1442 // automatically size the column or row to fit to its contents, if
1443 // setAsMin is true, this optimal width will also be set as minimal width
1445 void AutoSizeColumn( int col
, bool setAsMin
= true )
1446 { AutoSizeColOrRow(col
, setAsMin
, wxGRID_COLUMN
); }
1447 void AutoSizeRow( int row
, bool setAsMin
= true )
1448 { AutoSizeColOrRow(row
, setAsMin
, wxGRID_ROW
); }
1450 // auto size all columns (very ineffective for big grids!)
1451 void AutoSizeColumns( bool setAsMin
= true )
1452 { (void)SetOrCalcColumnSizes(false, setAsMin
); }
1454 void AutoSizeRows( bool setAsMin
= true )
1455 { (void)SetOrCalcRowSizes(false, setAsMin
); }
1457 // auto size the grid, that is make the columns/rows of the "right" size
1458 // and also set the grid size to just fit its contents
1461 // Note for both AutoSizeRowLabelSize and AutoSizeColLabelSize:
1462 // If col equals to wxGRID_AUTOSIZE value then function autosizes labels column
1463 // instead of data column. Note that this operation may be slow for large
1465 // autosize row height depending on label text
1466 void AutoSizeRowLabelSize( int row
);
1468 // autosize column width depending on label text
1469 void AutoSizeColLabelSize( int col
);
1471 // column won't be resized to be lesser width - this must be called during
1472 // the grid creation because it won't resize the column if it's already
1473 // narrower than the minimal width
1474 void SetColMinimalWidth( int col
, int width
);
1475 void SetRowMinimalHeight( int row
, int width
);
1477 /* These members can be used to query and modify the minimal
1478 * acceptable size of grid rows and columns. Call this function in
1479 * your code which creates the grid if you want to display cells
1480 * with a size smaller than the default acceptable minimum size.
1481 * Like the members SetColMinimalWidth and SetRowMinimalWidth,
1482 * the existing rows or columns will not be checked/resized.
1484 void SetColMinimalAcceptableWidth( int width
);
1485 void SetRowMinimalAcceptableHeight( int width
);
1486 int GetColMinimalAcceptableWidth() const;
1487 int GetRowMinimalAcceptableHeight() const;
1489 void SetDefaultCellBackgroundColour( const wxColour
& );
1490 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
1491 void SetDefaultCellTextColour( const wxColour
& );
1493 void SetCellTextColour( int row
, int col
, const wxColour
& );
1494 void SetDefaultCellFont( const wxFont
& );
1495 void SetCellFont( int row
, int col
, const wxFont
& );
1496 void SetDefaultCellAlignment( int horiz
, int vert
);
1497 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
1498 void SetDefaultCellOverflow( bool allow
);
1499 void SetCellOverflow( int row
, int col
, bool allow
);
1500 void SetCellSize( int row
, int col
, int num_rows
, int num_cols
);
1502 // takes ownership of the pointer
1503 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
1504 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
1505 wxGridCellRenderer
*GetDefaultRenderer() const;
1506 wxGridCellRenderer
* GetCellRenderer(int row
, int col
) const;
1508 // takes ownership of the pointer
1509 void SetDefaultEditor(wxGridCellEditor
*editor
);
1510 void SetCellEditor(int row
, int col
, wxGridCellEditor
*editor
);
1511 wxGridCellEditor
*GetDefaultEditor() const;
1512 wxGridCellEditor
* GetCellEditor(int row
, int col
) const;
1516 // ------ cell value accessors
1518 wxString
GetCellValue( int row
, int col
) const
1522 return m_table
->GetValue( row
, col
);
1526 return wxEmptyString
;
1530 wxString
GetCellValue( const wxGridCellCoords
& coords
) const
1531 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
1533 void SetCellValue( int row
, int col
, const wxString
& s
);
1534 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
1535 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
1537 // returns true if the cell can't be edited
1538 bool IsReadOnly(int row
, int col
) const;
1540 // make the cell editable/readonly
1541 void SetReadOnly(int row
, int col
, bool isReadOnly
= true);
1543 // ------ select blocks of cells
1545 void SelectRow( int row
, bool addToSelected
= false );
1546 void SelectCol( int col
, bool addToSelected
= false );
1548 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
,
1549 bool addToSelected
= false );
1551 void SelectBlock( const wxGridCellCoords
& topLeft
,
1552 const wxGridCellCoords
& bottomRight
,
1553 bool addToSelected
= false )
1554 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
1555 bottomRight
.GetRow(), bottomRight
.GetCol(),
1560 bool IsSelection() const;
1562 // ------ deselect blocks or cells
1564 void DeselectRow( int row
);
1565 void DeselectCol( int col
);
1566 void DeselectCell( int row
, int col
);
1568 void ClearSelection();
1570 bool IsInSelection( int row
, int col
) const;
1572 bool IsInSelection( const wxGridCellCoords
& coords
) const
1573 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
1575 wxGridCellCoordsArray
GetSelectedCells() const;
1576 wxGridCellCoordsArray
GetSelectionBlockTopLeft() const;
1577 wxGridCellCoordsArray
GetSelectionBlockBottomRight() const;
1578 wxArrayInt
GetSelectedRows() const;
1579 wxArrayInt
GetSelectedCols() const;
1581 // This function returns the rectangle that encloses the block of cells
1582 // limited by TopLeft and BottomRight cell in device coords and clipped
1583 // to the client size of the grid window.
1585 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
1586 const wxGridCellCoords
& bottomRight
) const;
1588 // Access or update the selection fore/back colours
1589 wxColour
GetSelectionBackground() const
1590 { return m_selectionBackground
; }
1591 wxColour
GetSelectionForeground() const
1592 { return m_selectionForeground
; }
1594 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
1595 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
1598 // Methods for a registry for mapping data types to Renderers/Editors
1599 void RegisterDataType(const wxString
& typeName
,
1600 wxGridCellRenderer
* renderer
,
1601 wxGridCellEditor
* editor
);
1603 virtual wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1604 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const
1605 { return GetDefaultEditorForCell(c
.GetRow(), c
.GetCol()); }
1606 virtual wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
1607 virtual wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
1608 virtual wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
1610 // grid may occupy more space than needed for its rows/columns, this
1611 // function allows to set how big this extra space is
1612 void SetMargins(int extraWidth
, int extraHeight
)
1614 m_extraWidth
= extraWidth
;
1615 m_extraHeight
= extraHeight
;
1620 // Accessors for component windows
1621 wxWindow
* GetGridWindow() const { return (wxWindow
*)m_gridWin
; }
1622 wxWindow
* GetGridRowLabelWindow() const { return (wxWindow
*)m_rowLabelWin
; }
1623 wxWindow
* GetGridColLabelWindow() const { return (wxWindow
*)m_colLabelWin
; }
1624 wxWindow
* GetGridCornerLabelWindow() const { return (wxWindow
*)m_cornerLabelWin
; }
1626 // Allow adjustment of scroll increment. The default is (15, 15).
1627 void SetScrollLineX(int x
) { m_scrollLineX
= x
; }
1628 void SetScrollLineY(int y
) { m_scrollLineY
= y
; }
1629 int GetScrollLineX() const { return m_scrollLineX
; }
1630 int GetScrollLineY() const { return m_scrollLineY
; }
1632 // ------- drag and drop
1633 #if wxUSE_DRAG_AND_DROP
1634 virtual void SetDropTarget(wxDropTarget
*dropTarget
);
1635 #endif // wxUSE_DRAG_AND_DROP
1638 #ifdef WXWIN_COMPATIBILITY_2_8
1639 // ------ For compatibility with previous wxGrid only...
1641 // ************************************************
1642 // ** Don't use these in new code because they **
1643 // ** are liable to disappear in a future **
1645 // ************************************************
1648 wxGrid( wxWindow
*parent
,
1649 int x
, int y
, int w
= wxDefaultCoord
, int h
= wxDefaultCoord
,
1650 long style
= wxWANTS_CHARS
,
1651 const wxString
& name
= wxPanelNameStr
)
1652 : wxScrolledWindow( parent
, wxID_ANY
, wxPoint(x
,y
), wxSize(w
,h
),
1653 (style
|wxWANTS_CHARS
), name
)
1659 void SetCellValue( const wxString
& val
, int row
, int col
)
1660 { SetCellValue( row
, col
, val
); }
1662 void UpdateDimensions()
1663 { CalcDimensions(); }
1665 int GetRows() const { return GetNumberRows(); }
1666 int GetCols() const { return GetNumberCols(); }
1667 int GetCursorRow() const { return GetGridCursorRow(); }
1668 int GetCursorColumn() const { return GetGridCursorCol(); }
1670 int GetScrollPosX() const { return 0; }
1671 int GetScrollPosY() const { return 0; }
1673 void SetScrollX( int WXUNUSED(x
) ) { }
1674 void SetScrollY( int WXUNUSED(y
) ) { }
1676 void SetColumnWidth( int col
, int width
)
1677 { SetColSize( col
, width
); }
1679 int GetColumnWidth( int col
) const
1680 { return GetColSize( col
); }
1682 void SetRowHeight( int row
, int height
)
1683 { SetRowSize( row
, height
); }
1685 // GetRowHeight() is below
1687 int GetViewHeight() const // returned num whole rows visible
1690 int GetViewWidth() const // returned num whole cols visible
1693 void SetLabelSize( int orientation
, int sz
)
1695 if ( orientation
== wxHORIZONTAL
)
1696 SetColLabelSize( sz
);
1698 SetRowLabelSize( sz
);
1701 int GetLabelSize( int orientation
) const
1703 if ( orientation
== wxHORIZONTAL
)
1704 return GetColLabelSize();
1706 return GetRowLabelSize();
1709 void SetLabelAlignment( int orientation
, int align
)
1711 if ( orientation
== wxHORIZONTAL
)
1712 SetColLabelAlignment( align
, -1 );
1714 SetRowLabelAlignment( align
, -1 );
1717 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) ) const
1720 if ( orientation
== wxHORIZONTAL
)
1722 GetColLabelAlignment( &h
, &v
);
1727 GetRowLabelAlignment( &h
, &v
);
1732 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
1734 if ( orientation
== wxHORIZONTAL
)
1735 SetColLabelValue( pos
, val
);
1737 SetRowLabelValue( pos
, val
);
1740 wxString
GetLabelValue( int orientation
, int pos
) const
1742 if ( orientation
== wxHORIZONTAL
)
1743 return GetColLabelValue( pos
);
1745 return GetRowLabelValue( pos
);
1748 wxFont
GetCellTextFont() const
1749 { return m_defaultCellAttr
->GetFont(); }
1751 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
1752 { return m_defaultCellAttr
->GetFont(); }
1754 void SetCellTextFont(const wxFont
& fnt
)
1755 { SetDefaultCellFont( fnt
); }
1757 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
1758 { SetCellFont( row
, col
, fnt
); }
1760 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
1761 { SetCellTextColour( row
, col
, val
); }
1763 void SetCellTextColour(const wxColour
& col
)
1764 { SetDefaultCellTextColour( col
); }
1766 void SetCellBackgroundColour(const wxColour
& col
)
1767 { SetDefaultCellBackgroundColour( col
); }
1769 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1770 { SetCellBackgroundColour( row
, col
, colour
); }
1772 bool GetEditable() const { return IsEditable(); }
1773 void SetEditable( bool edit
= true ) { EnableEditing( edit
); }
1774 bool GetEditInPlace() const { return IsCellEditControlEnabled(); }
1776 void SetEditInPlace(bool WXUNUSED(edit
) = true) { }
1778 void SetCellAlignment( int align
, int row
, int col
)
1779 { SetCellAlignment(row
, col
, align
, wxALIGN_CENTER
); }
1780 void SetCellAlignment( int WXUNUSED(align
) ) {}
1781 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1783 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1784 wxPen
& GetDividerPen() const;
1785 void OnActivate(bool WXUNUSED(active
)) {}
1787 // ******** End of compatibility functions **********
1791 // ------ control IDs
1792 enum { wxGRID_CELLCTRL
= 2000,
1795 // ------ control types
1796 enum { wxGRID_TEXTCTRL
= 2100,
1800 #endif // WXWIN_COMPATIBILITY_2_8
1803 // override some base class functions
1804 virtual bool Enable(bool enable
= true);
1805 virtual wxWindow
*GetMainWindowOfCompositeControl()
1806 { return (wxWindow
*)m_gridWin
; }
1809 // implementation only
1810 void CancelMouseCapture();
1813 virtual wxSize
DoGetBestSize() const;
1817 wxGridWindow
*m_gridWin
;
1818 wxGridRowLabelWindow
*m_rowLabelWin
;
1819 wxGridColLabelWindow
*m_colLabelWin
;
1820 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1822 wxGridTableBase
*m_table
;
1828 wxGridCellCoords m_currentCellCoords
;
1830 wxGridCellCoords m_selectingTopLeft
;
1831 wxGridCellCoords m_selectingBottomRight
;
1832 wxGridCellCoords m_selectingKeyboard
;
1833 wxGridSelection
*m_selection
;
1834 wxColour m_selectionBackground
;
1835 wxColour m_selectionForeground
;
1837 // NB: *never* access m_row/col arrays directly because they are created
1838 // on demand, *always* use accessor functions instead!
1840 // init the m_rowHeights/Bottoms arrays with default values
1841 void InitRowHeights();
1843 int m_defaultRowHeight
;
1844 int m_minAcceptableRowHeight
;
1845 wxArrayInt m_rowHeights
;
1846 wxArrayInt m_rowBottoms
;
1848 // init the m_colWidths/Rights arrays
1849 void InitColWidths();
1851 int m_defaultColWidth
;
1852 int m_minAcceptableColWidth
;
1853 wxArrayInt m_colWidths
;
1854 wxArrayInt m_colRights
;
1856 bool m_nativeColumnLabels
;
1858 // get the col/row coords
1859 int GetColWidth(int col
) const;
1860 int GetColLeft(int col
) const;
1861 int GetColRight(int col
) const;
1863 // this function must be public for compatibility...
1865 int GetRowHeight(int row
) const;
1868 int GetRowTop(int row
) const;
1869 int GetRowBottom(int row
) const;
1871 int m_rowLabelWidth
;
1872 int m_colLabelHeight
;
1874 // the size of the margin left to the right and bottom of the cell area
1878 wxColour m_labelBackgroundColour
;
1879 wxColour m_labelTextColour
;
1882 int m_rowLabelHorizAlign
;
1883 int m_rowLabelVertAlign
;
1884 int m_colLabelHorizAlign
;
1885 int m_colLabelVertAlign
;
1886 int m_colLabelTextOrientation
;
1888 bool m_defaultRowLabelValues
;
1889 bool m_defaultColLabelValues
;
1891 wxColour m_gridLineColour
;
1892 bool m_gridLinesEnabled
;
1893 wxColour m_cellHighlightColour
;
1894 int m_cellHighlightPenWidth
;
1895 int m_cellHighlightROPenWidth
;
1898 // common part of AutoSizeColumn/Row() and GetBestSize()
1899 int SetOrCalcColumnSizes(bool calcOnly
, bool setAsMin
= true);
1900 int SetOrCalcRowSizes(bool calcOnly
, bool setAsMin
= true);
1902 // common part of AutoSizeColumn/Row()
1903 void AutoSizeColOrRow(int n
, bool setAsMin
, wxGridDirection direction
);
1905 // Calculate the minimum acceptable size for labels area
1906 wxCoord
CalcColOrRowLabelAreaMinSize(wxGridDirection direction
);
1908 // if a column has a minimal width, it will be the value for it in this
1910 wxLongToLongHashMap m_colMinWidths
,
1913 // get the minimal width of the given column/row
1914 int GetColMinimalWidth(int col
) const;
1915 int GetRowMinimalHeight(int col
) const;
1917 // do we have some place to store attributes in?
1918 bool CanHaveAttributes() const;
1920 // cell attribute cache (currently we only cache 1, may be will do
1921 // more/better later)
1925 wxGridCellAttr
*attr
;
1928 // invalidates the attribute cache
1929 void ClearAttrCache();
1931 // adds an attribute to cache
1932 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
1934 // looks for an attr in cache, returns true if found
1935 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
1937 // looks for the attr in cache, if not found asks the table and caches the
1939 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
1940 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
) const
1941 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
1943 // the default cell attr object for cells that don't have their own
1944 wxGridCellAttr
* m_defaultCellAttr
;
1951 wxGridTypeRegistry
* m_typeRegistry
;
1955 WXGRID_CURSOR_SELECT_CELL
,
1956 WXGRID_CURSOR_RESIZE_ROW
,
1957 WXGRID_CURSOR_RESIZE_COL
,
1958 WXGRID_CURSOR_SELECT_ROW
,
1959 WXGRID_CURSOR_SELECT_COL
,
1960 WXGRID_CURSOR_MOVE_COL
1963 // this method not only sets m_cursorMode but also sets the correct cursor
1964 // for the given mode and, if captureMouse is not false releases the mouse
1965 // if it was captured and captures it if it must be captured
1967 // for this to work, you should always use it and not set m_cursorMode
1969 void ChangeCursorMode(CursorMode mode
,
1970 wxWindow
*win
= (wxWindow
*)NULL
,
1971 bool captureMouse
= true);
1973 wxWindow
*m_winCapture
; // the window which captured the mouse
1974 CursorMode m_cursorMode
;
1980 bool m_canDragRowSize
;
1981 bool m_canDragColSize
;
1982 bool m_canDragColMove
;
1983 bool m_canDragGridSize
;
1988 wxPoint m_startDragPos
;
1990 bool m_waitForSlowClick
;
1992 wxGridCellCoords m_selectionStart
;
1994 wxCursor m_rowResizeCursor
;
1995 wxCursor m_colResizeCursor
;
1997 bool m_editable
; // applies to whole grid
1998 bool m_cellEditCtrlEnabled
; // is in-place edit currently shown?
2000 int m_scrollLineX
; // X scroll increment
2001 int m_scrollLineY
; // Y scroll increment
2006 void CalcDimensions();
2007 void CalcWindowSizes();
2008 bool Redimension( wxGridTableMessage
& );
2011 int SendEvent( const wxEventType
, int row
, int col
, wxMouseEvent
& );
2012 int SendEvent( const wxEventType
, int row
, int col
);
2013 int SendEvent( const wxEventType type
)
2015 return SendEvent(type
,
2016 m_currentCellCoords
.GetRow(),
2017 m_currentCellCoords
.GetCol());
2020 void OnPaint( wxPaintEvent
& );
2021 void OnSize( wxSizeEvent
& );
2022 void OnKeyDown( wxKeyEvent
& );
2023 void OnKeyUp( wxKeyEvent
& );
2024 void OnChar( wxKeyEvent
& );
2025 void OnEraseBackground( wxEraseEvent
& );
2028 void SetCurrentCell( const wxGridCellCoords
& coords
);
2029 void SetCurrentCell( int row
, int col
)
2030 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
2032 void HighlightBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
);
2034 void HighlightBlock( const wxGridCellCoords
& topLeft
,
2035 const wxGridCellCoords
& bottomRight
)
2036 { HighlightBlock( topLeft
.GetRow(), topLeft
.GetCol(),
2037 bottomRight
.GetRow(), bottomRight
.GetCol() ); }
2039 // ------ functions to get/send data (see also public functions)
2041 bool GetModelValues();
2042 bool SetModelValues();
2044 friend class WXDLLIMPEXP_FWD_ADV wxGridSelection
;
2047 // implement wxScrolledWindow method to return m_gridWin size
2048 virtual wxSize
GetSizeAvailableForScrollTarget(const wxSize
& size
);
2050 DECLARE_DYNAMIC_CLASS( wxGrid
)
2051 DECLARE_EVENT_TABLE()
2052 DECLARE_NO_COPY_CLASS(wxGrid
)
2055 // ----------------------------------------------------------------------------
2056 // wxGridUpdateLocker prevents updates to a grid during its lifetime
2057 // ----------------------------------------------------------------------------
2059 class WXDLLIMPEXP_ADV wxGridUpdateLocker
2062 // if the pointer is NULL, Create() can be called later
2063 wxGridUpdateLocker(wxGrid
*grid
= NULL
)
2068 // can be called if ctor was used with a NULL pointer, must not be called
2070 void Create(wxGrid
*grid
)
2072 wxASSERT_MSG( !m_grid
, _T("shouldn't be called more than once") );
2077 ~wxGridUpdateLocker()
2084 void Init(wxGrid
*grid
)
2088 m_grid
->BeginBatch();
2093 DECLARE_NO_COPY_CLASS(wxGridUpdateLocker
)
2096 // ----------------------------------------------------------------------------
2097 // Grid event class and event types
2098 // ----------------------------------------------------------------------------
2100 class WXDLLIMPEXP_ADV wxGridEvent
: public wxNotifyEvent
2104 : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
2105 m_selecting(0), m_control(0), m_meta(0), m_shift(0), m_alt(0)
2109 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
2110 int row
=-1, int col
=-1, int x
=-1, int y
=-1, bool sel
= true,
2111 bool control
= false, bool shift
= false, bool alt
= false, bool meta
= false);
2113 virtual int GetRow() { return m_row
; }
2114 virtual int GetCol() { return m_col
; }
2115 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
2116 bool Selecting() { return m_selecting
; }
2117 bool ControlDown() { return m_control
; }
2118 bool MetaDown() { return m_meta
; }
2119 bool ShiftDown() { return m_shift
; }
2120 bool AltDown() { return m_alt
; }
2123 #if defined(__WXMAC__) || defined(__WXCOCOA__)
2126 return ControlDown();
2130 virtual wxEvent
*Clone() const { return new wxGridEvent(*this); }
2143 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEvent
)
2146 class WXDLLIMPEXP_ADV wxGridSizeEvent
: public wxNotifyEvent
2150 : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
2151 m_control(0), m_meta(0), m_shift(0), m_alt(0)
2155 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
2156 int rowOrCol
=-1, int x
=-1, int y
=-1,
2157 bool control
= false, bool shift
= false, bool alt
= false, bool meta
= false);
2159 int GetRowOrCol() { return m_rowOrCol
; }
2160 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
2161 bool ControlDown() { return m_control
; }
2162 bool MetaDown() { return m_meta
; }
2163 bool ShiftDown() { return m_shift
; }
2164 bool AltDown() { return m_alt
; }
2167 #if defined(__WXMAC__) || defined(__WXCOCOA__)
2170 return ControlDown();
2174 virtual wxEvent
*Clone() const { return new wxGridSizeEvent(*this); }
2185 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridSizeEvent
)
2189 class WXDLLIMPEXP_ADV wxGridRangeSelectEvent
: public wxNotifyEvent
2192 wxGridRangeSelectEvent()
2195 m_topLeft
= wxGridNoCellCoords
;
2196 m_bottomRight
= wxGridNoCellCoords
;
2197 m_selecting
= false;
2204 wxGridRangeSelectEvent(int id
, wxEventType type
, wxObject
* obj
,
2205 const wxGridCellCoords
& topLeft
,
2206 const wxGridCellCoords
& bottomRight
,
2208 bool control
= false, bool shift
= false,
2209 bool alt
= false, bool meta
= false);
2211 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
2212 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
2213 int GetTopRow() { return m_topLeft
.GetRow(); }
2214 int GetBottomRow() { return m_bottomRight
.GetRow(); }
2215 int GetLeftCol() { return m_topLeft
.GetCol(); }
2216 int GetRightCol() { return m_bottomRight
.GetCol(); }
2217 bool Selecting() { return m_selecting
; }
2218 bool ControlDown() { return m_control
; }
2219 bool MetaDown() { return m_meta
; }
2220 bool ShiftDown() { return m_shift
; }
2221 bool AltDown() { return m_alt
; }
2224 #if defined(__WXMAC__) || defined(__WXCOCOA__)
2227 return ControlDown();
2231 virtual wxEvent
*Clone() const { return new wxGridRangeSelectEvent(*this); }
2234 wxGridCellCoords m_topLeft
;
2235 wxGridCellCoords m_bottomRight
;
2242 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridRangeSelectEvent
)
2246 class WXDLLIMPEXP_ADV wxGridEditorCreatedEvent
: public wxCommandEvent
{
2248 wxGridEditorCreatedEvent()
2256 wxGridEditorCreatedEvent(int id
, wxEventType type
, wxObject
* obj
,
2257 int row
, int col
, wxControl
* ctrl
);
2259 int GetRow() { return m_row
; }
2260 int GetCol() { return m_col
; }
2261 wxControl
* GetControl() { return m_ctrl
; }
2262 void SetRow(int row
) { m_row
= row
; }
2263 void SetCol(int col
) { m_col
= col
; }
2264 void SetControl(wxControl
* ctrl
) { m_ctrl
= ctrl
; }
2266 virtual wxEvent
*Clone() const { return new wxGridEditorCreatedEvent(*this); }
2273 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEditorCreatedEvent
)
2277 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_LEFT_CLICK
;
2278 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK
;
2279 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK
;
2280 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK
;
2281 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK
;
2282 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK
;
2283 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK
;
2284 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK
;
2285 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_ROW_SIZE
;
2286 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_SIZE
;
2287 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_RANGE_SELECT
;
2288 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_CHANGE
;
2289 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_SELECT_CELL
;
2290 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_SHOWN
;
2291 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_HIDDEN
;
2292 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_CREATED
;
2293 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_BEGIN_DRAG
;
2294 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_MOVE
;
2297 typedef void (wxEvtHandler::*wxGridEventFunction
)(wxGridEvent
&);
2298 typedef void (wxEvtHandler::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
2299 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
2300 typedef void (wxEvtHandler::*wxGridEditorCreatedEventFunction
)(wxGridEditorCreatedEvent
&);
2302 #define wxGridEventHandler(func) \
2303 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEventFunction, &func)
2305 #define wxGridSizeEventHandler(func) \
2306 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridSizeEventFunction, &func)
2308 #define wxGridRangeSelectEventHandler(func) \
2309 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridRangeSelectEventFunction, &func)
2311 #define wxGridEditorCreatedEventHandler(func) \
2312 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEditorCreatedEventFunction, &func)
2314 #define wx__DECLARE_GRIDEVT(evt, id, fn) \
2315 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEventHandler(fn))
2317 #define wx__DECLARE_GRIDSIZEEVT(evt, id, fn) \
2318 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridSizeEventHandler(fn))
2320 #define wx__DECLARE_GRIDRANGESELEVT(evt, id, fn) \
2321 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridRangeSelectEventHandler(fn))
2323 #define wx__DECLARE_GRIDEDITOREVT(evt, id, fn) \
2324 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEditorCreatedEventHandler(fn))
2326 #define EVT_GRID_CMD_CELL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_CLICK, id, fn)
2327 #define EVT_GRID_CMD_CELL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_CLICK, id, fn)
2328 #define EVT_GRID_CMD_CELL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_DCLICK, id, fn)
2329 #define EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_DCLICK, id, fn)
2330 #define EVT_GRID_CMD_LABEL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_CLICK, id, fn)
2331 #define EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_CLICK, id, fn)
2332 #define EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_DCLICK, id, fn)
2333 #define EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_DCLICK, id, fn)
2334 #define EVT_GRID_CMD_ROW_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(ROW_SIZE, id, fn)
2335 #define EVT_GRID_CMD_COL_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(COL_SIZE, id, fn)
2336 #define EVT_GRID_CMD_COL_MOVE(id, fn) wx__DECLARE_GRIDEVT(COL_MOVE, id, fn)
2337 #define EVT_GRID_CMD_RANGE_SELECT(id, fn) wx__DECLARE_GRIDRANGESELEVT(RANGE_SELECT, id, fn)
2338 #define EVT_GRID_CMD_CELL_CHANGE(id, fn) wx__DECLARE_GRIDEVT(CELL_CHANGE, id, fn)
2339 #define EVT_GRID_CMD_SELECT_CELL(id, fn) wx__DECLARE_GRIDEVT(SELECT_CELL, id, fn)
2340 #define EVT_GRID_CMD_EDITOR_SHOWN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_SHOWN, id, fn)
2341 #define EVT_GRID_CMD_EDITOR_HIDDEN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_HIDDEN, id, fn)
2342 #define EVT_GRID_CMD_EDITOR_CREATED(id, fn) wx__DECLARE_GRIDEDITOREVT(EDITOR_CREATED, id, fn)
2343 #define EVT_GRID_CMD_CELL_BEGIN_DRAG(id, fn) wx__DECLARE_GRIDEVT(CELL_BEGIN_DRAG, id, fn)
2345 // same as above but for any id (exists mainly for backwards compatibility but
2346 // then it's also true that you rarely have multiple grid in the same window)
2347 #define EVT_GRID_CELL_LEFT_CLICK(fn) EVT_GRID_CMD_CELL_LEFT_CLICK(wxID_ANY, fn)
2348 #define EVT_GRID_CELL_RIGHT_CLICK(fn) EVT_GRID_CMD_CELL_RIGHT_CLICK(wxID_ANY, fn)
2349 #define EVT_GRID_CELL_LEFT_DCLICK(fn) EVT_GRID_CMD_CELL_LEFT_DCLICK(wxID_ANY, fn)
2350 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) EVT_GRID_CMD_CELL_RIGHT_DCLICK(wxID_ANY, fn)
2351 #define EVT_GRID_LABEL_LEFT_CLICK(fn) EVT_GRID_CMD_LABEL_LEFT_CLICK(wxID_ANY, fn)
2352 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_CLICK(wxID_ANY, fn)
2353 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) EVT_GRID_CMD_LABEL_LEFT_DCLICK(wxID_ANY, fn)
2354 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_DCLICK(wxID_ANY, fn)
2355 #define EVT_GRID_ROW_SIZE(fn) EVT_GRID_CMD_ROW_SIZE(wxID_ANY, fn)
2356 #define EVT_GRID_COL_SIZE(fn) EVT_GRID_CMD_COL_SIZE(wxID_ANY, fn)
2357 #define EVT_GRID_COL_MOVE(fn) EVT_GRID_CMD_COL_MOVE(wxID_ANY, fn)
2358 #define EVT_GRID_RANGE_SELECT(fn) EVT_GRID_CMD_RANGE_SELECT(wxID_ANY, fn)
2359 #define EVT_GRID_CELL_CHANGE(fn) EVT_GRID_CMD_CELL_CHANGE(wxID_ANY, fn)
2360 #define EVT_GRID_SELECT_CELL(fn) EVT_GRID_CMD_SELECT_CELL(wxID_ANY, fn)
2361 #define EVT_GRID_EDITOR_SHOWN(fn) EVT_GRID_CMD_EDITOR_SHOWN(wxID_ANY, fn)
2362 #define EVT_GRID_EDITOR_HIDDEN(fn) EVT_GRID_CMD_EDITOR_HIDDEN(wxID_ANY, fn)
2363 #define EVT_GRID_EDITOR_CREATED(fn) EVT_GRID_CMD_EDITOR_CREATED(wxID_ANY, fn)
2364 #define EVT_GRID_CELL_BEGIN_DRAG(fn) EVT_GRID_CMD_CELL_BEGIN_DRAG(wxID_ANY, fn)
2366 #if 0 // TODO: implement these ? others ?
2368 extern const int wxEVT_GRID_CREATE_CELL
;
2369 extern const int wxEVT_GRID_CHANGE_LABELS
;
2370 extern const int wxEVT_GRID_CHANGE_SEL_LABEL
;
2372 #define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2373 #define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2374 #define EVT_GRID_CHANGE_SEL_LABEL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_SEL_LABEL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2378 #endif // wxUSE_GRID
2379 #endif // _WX_GENERIC_GRID_H_