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 char) 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 wxHeaderCtrl
;
81 class WXDLLIMPEXP_FWD_CORE wxCheckBox
;
82 class WXDLLIMPEXP_FWD_CORE wxComboBox
;
83 class WXDLLIMPEXP_FWD_CORE wxTextCtrl
;
85 class WXDLLIMPEXP_FWD_CORE wxSpinCtrl
;
88 class wxGridOperations
;
89 class wxGridRowOperations
;
90 class wxGridColumnOperations
;
91 class wxGridDirectionOperations
;
93 // ----------------------------------------------------------------------------
95 // ----------------------------------------------------------------------------
97 #define wxSafeIncRef(p) if ( p ) (p)->IncRef()
98 #define wxSafeDecRef(p) if ( p ) (p)->DecRef()
100 // ----------------------------------------------------------------------------
101 // wxGridCellWorker: common base class for wxGridCellRenderer and
104 // NB: this is more an implementation convenience than a design issue, so this
105 // class is not documented and is not public at all
106 // ----------------------------------------------------------------------------
108 class WXDLLIMPEXP_ADV wxGridCellWorker
: public wxClientDataContainer
111 wxGridCellWorker() { m_nRef
= 1; }
113 // this class is ref counted: it is created with ref count of 1, so
114 // calling DecRef() once will delete it. Calling IncRef() allows to lock
115 // it until the matching DecRef() is called
116 void IncRef() { m_nRef
++; }
117 void DecRef() { if ( --m_nRef
== 0 ) delete this; }
119 // interpret renderer parameters: arbitrary string whose interpretatin is
120 // left to the derived classes
121 virtual void SetParameters(const wxString
& params
);
124 // virtual dtor for any base class - private because only DecRef() can
126 virtual ~wxGridCellWorker();
131 // suppress the stupid gcc warning about the class having private dtor and
133 friend class wxGridCellWorkerDummyFriend
;
136 // ----------------------------------------------------------------------------
137 // wxGridCellRenderer: this class is responsible for actually drawing the cell
138 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
139 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
140 // view of all cells. This is an ABC, you will normally use one of the
141 // predefined derived classes or derive your own class from it.
142 // ----------------------------------------------------------------------------
144 class WXDLLIMPEXP_ADV wxGridCellRenderer
: public wxGridCellWorker
147 // draw the given cell on the provided DC inside the given rectangle
148 // using the style specified by the attribute and the default or selected
149 // state corresponding to the isSelected value.
151 // this pure virtual function has a default implementation which will
152 // prepare the DC using the given attribute: it will draw the rectangle
153 // with the bg colour from attr and set the text colour and font
154 virtual void Draw(wxGrid
& grid
,
155 wxGridCellAttr
& attr
,
159 bool isSelected
) = 0;
161 // get the preferred size of the cell for its contents
162 virtual wxSize
GetBestSize(wxGrid
& grid
,
163 wxGridCellAttr
& attr
,
165 int row
, int col
) = 0;
167 // create a new object which is the copy of this one
168 virtual wxGridCellRenderer
*Clone() const = 0;
171 // the default renderer for the cells containing string data
172 class WXDLLIMPEXP_ADV wxGridCellStringRenderer
: public wxGridCellRenderer
176 virtual void Draw(wxGrid
& grid
,
177 wxGridCellAttr
& attr
,
183 // return the string extent
184 virtual wxSize
GetBestSize(wxGrid
& grid
,
185 wxGridCellAttr
& attr
,
189 virtual wxGridCellRenderer
*Clone() const
190 { return new wxGridCellStringRenderer
; }
193 // set the text colours before drawing
194 void SetTextColoursAndFont(const wxGrid
& grid
,
195 const wxGridCellAttr
& attr
,
199 // calc the string extent for given string/font
200 wxSize
DoGetBestSize(const wxGridCellAttr
& attr
,
202 const wxString
& text
);
205 // the default renderer for the cells containing numeric (long) data
206 class WXDLLIMPEXP_ADV wxGridCellNumberRenderer
: public wxGridCellStringRenderer
209 // draw the string right aligned
210 virtual void Draw(wxGrid
& grid
,
211 wxGridCellAttr
& attr
,
217 virtual wxSize
GetBestSize(wxGrid
& grid
,
218 wxGridCellAttr
& attr
,
222 virtual wxGridCellRenderer
*Clone() const
223 { return new wxGridCellNumberRenderer
; }
226 wxString
GetString(const wxGrid
& grid
, int row
, int col
);
229 class WXDLLIMPEXP_ADV wxGridCellFloatRenderer
: public wxGridCellStringRenderer
232 wxGridCellFloatRenderer(int width
= -1, int precision
= -1);
234 // get/change formatting parameters
235 int GetWidth() const { return m_width
; }
236 void SetWidth(int width
) { m_width
= width
; m_format
.clear(); }
237 int GetPrecision() const { return m_precision
; }
238 void SetPrecision(int precision
) { m_precision
= precision
; m_format
.clear(); }
240 // draw the string right aligned with given width/precision
241 virtual void Draw(wxGrid
& grid
,
242 wxGridCellAttr
& attr
,
248 virtual wxSize
GetBestSize(wxGrid
& grid
,
249 wxGridCellAttr
& attr
,
253 // parameters string format is "width[,precision]"
254 virtual void SetParameters(const wxString
& params
);
256 virtual wxGridCellRenderer
*Clone() const;
259 wxString
GetString(const wxGrid
& grid
, int row
, int col
);
262 // formatting parameters
269 // renderer for boolean fields
270 class WXDLLIMPEXP_ADV wxGridCellBoolRenderer
: public wxGridCellRenderer
273 // draw a check mark or nothing
274 virtual void Draw(wxGrid
& grid
,
275 wxGridCellAttr
& attr
,
281 // return the checkmark size
282 virtual wxSize
GetBestSize(wxGrid
& grid
,
283 wxGridCellAttr
& attr
,
287 virtual wxGridCellRenderer
*Clone() const
288 { return new wxGridCellBoolRenderer
; }
291 static wxSize ms_sizeCheckMark
;
294 // ----------------------------------------------------------------------------
295 // wxGridCellEditor: This class is responsible for providing and manipulating
296 // the in-place edit controls for the grid. Instances of wxGridCellEditor
297 // (actually, instances of derived classes since it is an ABC) can be
298 // associated with the cell attributes for individual cells, rows, columns, or
299 // even for the entire grid.
300 // ----------------------------------------------------------------------------
302 class WXDLLIMPEXP_ADV wxGridCellEditor
: public wxGridCellWorker
307 bool IsCreated() { return m_control
!= NULL
; }
308 wxControl
* GetControl() { return m_control
; }
309 void SetControl(wxControl
* control
) { m_control
= control
; }
311 wxGridCellAttr
* GetCellAttr() { return m_attr
; }
312 void SetCellAttr(wxGridCellAttr
* attr
) { m_attr
= attr
; }
314 // Creates the actual edit control
315 virtual void Create(wxWindow
* parent
,
317 wxEvtHandler
* evtHandler
) = 0;
319 // Size and position the edit control
320 virtual void SetSize(const wxRect
& rect
);
322 // Show or hide the edit control, use the specified attributes to set
323 // colours/fonts for it
324 virtual void Show(bool show
, wxGridCellAttr
*attr
= NULL
);
326 // Draws the part of the cell not occupied by the control: the base class
327 // version just fills it with background colour from the attribute
328 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
330 // Fetch the value from the table and prepare the edit control
331 // to begin editing. Set the focus to the edit control.
332 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
334 // Complete the editing of the current cell. Returns true if the value has
335 // changed. If necessary, the control may be destroyed.
336 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
) = 0;
338 // Reset the value in the control back to its starting value
339 virtual void Reset() = 0;
341 // return true to allow the given key to start editing: the base class
342 // version only checks that the event has no modifiers. The derived
343 // classes are supposed to do "if ( base::IsAcceptedKey() && ... )" in
344 // their IsAcceptedKey() implementation, although, of course, it is not a
345 // mandatory requirment.
347 // NB: if the key is F2 (special), editing will always start and this
348 // method will not be called at all (but StartingKey() will)
349 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
351 // If the editor is enabled by pressing keys on the grid, this will be
352 // called to let the editor do something about that first key if desired
353 virtual void StartingKey(wxKeyEvent
& event
);
355 // if the editor is enabled by clicking on the cell, this method will be
357 virtual void StartingClick();
359 // Some types of controls on some platforms may need some help
360 // with the Return key.
361 virtual void HandleReturn(wxKeyEvent
& event
);
364 virtual void Destroy();
366 // create a new object which is the copy of this one
367 virtual wxGridCellEditor
*Clone() const = 0;
369 // added GetValue so we can get the value which is in the control
370 virtual wxString
GetValue() const = 0;
373 // the dtor is private because only DecRef() can delete us
374 virtual ~wxGridCellEditor();
376 // the control we show on screen
377 wxControl
* m_control
;
379 // a temporary pointer to the attribute being edited
380 wxGridCellAttr
* m_attr
;
382 // if we change the colours/font of the control from the default ones, we
383 // must restore the default later and we save them here between calls to
384 // Show(true) and Show(false)
389 // suppress the stupid gcc warning about the class having private dtor and
391 friend class wxGridCellEditorDummyFriend
;
393 DECLARE_NO_COPY_CLASS(wxGridCellEditor
)
398 // the editor for string/text data
399 class WXDLLIMPEXP_ADV wxGridCellTextEditor
: public wxGridCellEditor
402 wxGridCellTextEditor();
404 virtual void Create(wxWindow
* parent
,
406 wxEvtHandler
* evtHandler
);
407 virtual void SetSize(const wxRect
& rect
);
409 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
411 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
412 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
413 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
415 virtual void Reset();
416 virtual void StartingKey(wxKeyEvent
& event
);
417 virtual void HandleReturn(wxKeyEvent
& event
);
419 // parameters string format is "max_width"
420 virtual void SetParameters(const wxString
& params
);
422 virtual wxGridCellEditor
*Clone() const
423 { return new wxGridCellTextEditor
; }
425 // added GetValue so we can get the value which is in the control
426 virtual wxString
GetValue() const;
429 wxTextCtrl
*Text() const { return (wxTextCtrl
*)m_control
; }
431 // parts of our virtual functions reused by the derived classes
432 void DoCreate(wxWindow
* parent
, wxWindowID id
, wxEvtHandler
* evtHandler
,
434 void DoBeginEdit(const wxString
& startValue
);
435 void DoReset(const wxString
& startValue
);
438 size_t m_maxChars
; // max number of chars allowed
439 wxString m_startValue
;
441 DECLARE_NO_COPY_CLASS(wxGridCellTextEditor
)
444 // the editor for numeric (long) data
445 class WXDLLIMPEXP_ADV wxGridCellNumberEditor
: public wxGridCellTextEditor
448 // allows to specify the range - if min == max == -1, no range checking is
450 wxGridCellNumberEditor(int min
= -1, int max
= -1);
452 virtual void Create(wxWindow
* parent
,
454 wxEvtHandler
* evtHandler
);
456 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
457 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
458 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
460 virtual void Reset();
461 virtual void StartingKey(wxKeyEvent
& event
);
463 // parameters string format is "min,max"
464 virtual void SetParameters(const wxString
& params
);
466 virtual wxGridCellEditor
*Clone() const
467 { return new wxGridCellNumberEditor(m_min
, m_max
); }
469 // added GetValue so we can get the value which is in the control
470 virtual wxString
GetValue() const;
474 wxSpinCtrl
*Spin() const { return (wxSpinCtrl
*)m_control
; }
477 // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl
478 bool HasRange() const
481 return m_min
!= m_max
;
487 // string representation of m_valueOld
488 wxString
GetString() const
489 { return wxString::Format(_T("%ld"), m_valueOld
); }
497 DECLARE_NO_COPY_CLASS(wxGridCellNumberEditor
)
500 // the editor for floating point numbers (double) data
501 class WXDLLIMPEXP_ADV wxGridCellFloatEditor
: public wxGridCellTextEditor
504 wxGridCellFloatEditor(int width
= -1, int precision
= -1);
506 virtual void Create(wxWindow
* parent
,
508 wxEvtHandler
* evtHandler
);
510 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
511 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
512 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
514 virtual void Reset();
515 virtual void StartingKey(wxKeyEvent
& event
);
517 virtual wxGridCellEditor
*Clone() const
518 { return new wxGridCellFloatEditor(m_width
, m_precision
); }
520 // parameters string format is "width,precision"
521 virtual void SetParameters(const wxString
& params
);
524 // string representation of m_valueOld
525 wxString
GetString() const;
532 DECLARE_NO_COPY_CLASS(wxGridCellFloatEditor
)
535 #endif // wxUSE_TEXTCTRL
539 // the editor for boolean data
540 class WXDLLIMPEXP_ADV wxGridCellBoolEditor
: public wxGridCellEditor
543 wxGridCellBoolEditor() { }
545 virtual void Create(wxWindow
* parent
,
547 wxEvtHandler
* evtHandler
);
549 virtual void SetSize(const wxRect
& rect
);
550 virtual void Show(bool show
, wxGridCellAttr
*attr
= NULL
);
552 virtual bool IsAcceptedKey(wxKeyEvent
& event
);
553 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
554 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
556 virtual void Reset();
557 virtual void StartingClick();
558 virtual void StartingKey(wxKeyEvent
& event
);
560 virtual wxGridCellEditor
*Clone() const
561 { return new wxGridCellBoolEditor
; }
563 // added GetValue so we can get the value which is in the control, see
564 // also UseStringValues()
565 virtual wxString
GetValue() const;
567 // set the string values returned by GetValue() for the true and false
568 // states, respectively
569 static void UseStringValues(const wxString
& valueTrue
= _T("1"),
570 const wxString
& valueFalse
= wxEmptyString
);
572 // return true if the given string is equal to the string representation of
573 // true value which we currently use
574 static bool IsTrueValue(const wxString
& value
);
577 wxCheckBox
*CBox() const { return (wxCheckBox
*)m_control
; }
582 static wxString ms_stringValues
[2];
584 DECLARE_NO_COPY_CLASS(wxGridCellBoolEditor
)
587 #endif // wxUSE_CHECKBOX
591 // the editor for string data allowing to choose from the list of strings
592 class WXDLLIMPEXP_ADV wxGridCellChoiceEditor
: public wxGridCellEditor
595 // if !allowOthers, user can't type a string not in choices array
596 wxGridCellChoiceEditor(size_t count
= 0,
597 const wxString choices
[] = NULL
,
598 bool allowOthers
= false);
599 wxGridCellChoiceEditor(const wxArrayString
& choices
,
600 bool allowOthers
= false);
602 virtual void Create(wxWindow
* parent
,
604 wxEvtHandler
* evtHandler
);
606 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
608 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
609 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
);
611 virtual void Reset();
613 // parameters string format is "item1[,item2[...,itemN]]"
614 virtual void SetParameters(const wxString
& params
);
616 virtual wxGridCellEditor
*Clone() const;
618 // added GetValue so we can get the value which is in the control
619 virtual wxString
GetValue() const;
622 wxComboBox
*Combo() const { return (wxComboBox
*)m_control
; }
624 // DJC - (MAPTEK) you at least need access to m_choices if you
625 // wish to override this class
627 wxString m_startValue
;
628 wxArrayString m_choices
;
631 DECLARE_NO_COPY_CLASS(wxGridCellChoiceEditor
)
634 #endif // wxUSE_COMBOBOX
636 // ----------------------------------------------------------------------------
637 // wxGridCellAttr: this class can be used to alter the cells appearance in
638 // the grid by changing their colour/font/... from default. An object of this
639 // class may be returned by wxGridTable::GetAttr().
640 // ----------------------------------------------------------------------------
642 class WXDLLIMPEXP_ADV wxGridCellAttr
: public wxClientDataContainer
656 wxGridCellAttr(wxGridCellAttr
*attrDefault
= NULL
)
660 // MB: args used to be 0,0 here but wxALIGN_LEFT is 0
661 SetAlignment(-1, -1);
664 // VZ: considering the number of members wxGridCellAttr has now, this ctor
665 // seems to be pretty useless... may be we should just remove it?
666 wxGridCellAttr(const wxColour
& colText
,
667 const wxColour
& colBack
,
671 : m_colText(colText
), m_colBack(colBack
), m_font(font
)
674 SetAlignment(hAlign
, vAlign
);
677 // creates a new copy of this object
678 wxGridCellAttr
*Clone() const;
679 void MergeWith(wxGridCellAttr
*mergefrom
);
681 // this class is ref counted: it is created with ref count of 1, so
682 // calling DecRef() once will delete it. Calling IncRef() allows to lock
683 // it until the matching DecRef() is called
684 void IncRef() { m_nRef
++; }
685 void DecRef() { if ( --m_nRef
== 0 ) delete this; }
688 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
689 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
690 void SetFont(const wxFont
& font
) { m_font
= font
; }
691 void SetAlignment(int hAlign
, int vAlign
)
696 void SetSize(int num_rows
, int num_cols
);
697 void SetOverflow(bool allow
= true)
698 { m_overflow
= allow
? Overflow
: SingleCell
; }
699 void SetReadOnly(bool isReadOnly
= true)
700 { m_isReadOnly
= isReadOnly
? ReadOnly
: ReadWrite
; }
702 // takes ownership of the pointer
703 void SetRenderer(wxGridCellRenderer
*renderer
)
704 { wxSafeDecRef(m_renderer
); m_renderer
= renderer
; }
705 void SetEditor(wxGridCellEditor
* editor
)
706 { wxSafeDecRef(m_editor
); m_editor
= editor
; }
708 void SetKind(wxAttrKind kind
) { m_attrkind
= kind
; }
711 bool HasTextColour() const { return m_colText
.Ok(); }
712 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
713 bool HasFont() const { return m_font
.Ok(); }
714 bool HasAlignment() const { return (m_hAlign
!= -1 || m_vAlign
!= -1); }
715 bool HasRenderer() const { return m_renderer
!= NULL
; }
716 bool HasEditor() const { return m_editor
!= NULL
; }
717 bool HasReadWriteMode() const { return m_isReadOnly
!= Unset
; }
718 bool HasOverflowMode() const { return m_overflow
!= UnsetOverflow
; }
719 bool HasSize() const { return m_sizeRows
!= 1 || m_sizeCols
!= 1; }
721 const wxColour
& GetTextColour() const;
722 const wxColour
& GetBackgroundColour() const;
723 const wxFont
& GetFont() const;
724 void GetAlignment(int *hAlign
, int *vAlign
) const;
725 void GetSize(int *num_rows
, int *num_cols
) const;
726 bool GetOverflow() const
727 { return m_overflow
!= SingleCell
; }
728 wxGridCellRenderer
*GetRenderer(const wxGrid
* grid
, int row
, int col
) const;
729 wxGridCellEditor
*GetEditor(const wxGrid
* grid
, int row
, int col
) const;
731 bool IsReadOnly() const { return m_isReadOnly
== wxGridCellAttr::ReadOnly
; }
733 wxAttrKind
GetKind() { return m_attrkind
; }
735 void SetDefAttr(wxGridCellAttr
* defAttr
) { m_defGridAttr
= defAttr
; }
738 // the dtor is private because only DecRef() can delete us
739 virtual ~wxGridCellAttr()
741 wxSafeDecRef(m_renderer
);
742 wxSafeDecRef(m_editor
);
753 enum wxAttrOverflowMode
760 // the common part of all ctors
761 void Init(wxGridCellAttr
*attrDefault
= NULL
);
764 // the ref count - when it goes to 0, we die
775 wxAttrOverflowMode m_overflow
;
777 wxGridCellRenderer
* m_renderer
;
778 wxGridCellEditor
* m_editor
;
779 wxGridCellAttr
* m_defGridAttr
;
781 wxAttrReadMode m_isReadOnly
;
783 wxAttrKind m_attrkind
;
785 // use Clone() instead
786 DECLARE_NO_COPY_CLASS(wxGridCellAttr
)
788 // suppress the stupid gcc warning about the class having private dtor and
790 friend class wxGridCellAttrDummyFriend
;
793 // ----------------------------------------------------------------------------
794 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
796 // ----------------------------------------------------------------------------
798 // implementation note: we separate it from wxGridTableBase because we wish to
799 // avoid deriving a new table class if possible, and sometimes it will be
800 // enough to just derive another wxGridCellAttrProvider instead
802 // the default implementation is reasonably efficient for the generic case,
803 // but you might still wish to implement your own for some specific situations
804 // if you have performance problems with the stock one
805 class WXDLLIMPEXP_ADV wxGridCellAttrProvider
: public wxClientDataContainer
808 wxGridCellAttrProvider();
809 virtual ~wxGridCellAttrProvider();
811 // DecRef() must be called on the returned pointer
812 virtual wxGridCellAttr
*GetAttr(int row
, int col
,
813 wxGridCellAttr::wxAttrKind kind
) const;
815 // all these functions take ownership of the pointer, don't call DecRef()
817 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
818 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
819 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
821 // these functions must be called whenever some rows/cols are deleted
822 // because the internal data must be updated then
823 void UpdateAttrRows( size_t pos
, int numRows
);
824 void UpdateAttrCols( size_t pos
, int numCols
);
829 wxGridCellAttrProviderData
*m_data
;
831 DECLARE_NO_COPY_CLASS(wxGridCellAttrProvider
)
834 // ----------------------------------------------------------------------------
835 // wxGridCellCoords: location of a cell in the grid
836 // ----------------------------------------------------------------------------
838 class WXDLLIMPEXP_ADV wxGridCellCoords
841 wxGridCellCoords() { m_row
= m_col
= -1; }
842 wxGridCellCoords( int r
, int c
) { m_row
= r
; m_col
= c
; }
844 // default copy ctor is ok
846 int GetRow() const { return m_row
; }
847 void SetRow( int n
) { m_row
= n
; }
848 int GetCol() const { return m_col
; }
849 void SetCol( int n
) { m_col
= n
; }
850 void Set( int row
, int col
) { m_row
= row
; m_col
= col
; }
852 wxGridCellCoords
& operator=( const wxGridCellCoords
& other
)
854 if ( &other
!= this )
862 bool operator==( const wxGridCellCoords
& other
) const
864 return (m_row
== other
.m_row
&& m_col
== other
.m_col
);
867 bool operator!=( const wxGridCellCoords
& other
) const
869 return (m_row
!= other
.m_row
|| m_col
!= other
.m_col
);
872 bool operator!() const
874 return (m_row
== -1 && m_col
== -1 );
883 // For comparisons...
885 extern WXDLLIMPEXP_ADV wxGridCellCoords wxGridNoCellCoords
;
886 extern WXDLLIMPEXP_ADV wxRect wxGridNoCellRect
;
888 // An array of cell coords...
890 WX_DECLARE_OBJARRAY_WITH_DECL(wxGridCellCoords
, wxGridCellCoordsArray
,
891 class WXDLLIMPEXP_ADV
);
893 // ----------------------------------------------------------------------------
894 // Grid table classes
895 // ----------------------------------------------------------------------------
897 // the abstract base class
898 class WXDLLIMPEXP_ADV wxGridTableBase
: public wxObject
,
899 public wxClientDataContainer
903 virtual ~wxGridTableBase();
905 // You must override these functions in a derived table class
908 // return the number of rows and columns in this table
909 virtual int GetNumberRows() = 0;
910 virtual int GetNumberCols() = 0;
912 // the methods above are unfortunately non-const even though they should
913 // have been const -- but changing it now is not possible any longer as it
914 // would break the existing code overriding them, so instead we provide
915 // these const synonyms which can be used from const-correct code
916 int GetRowsCount() const
917 { return const_cast<wxGridTableBase
*>(this)->GetNumberRows(); }
918 int GetColsCount() const
919 { return const_cast<wxGridTableBase
*>(this)->GetNumberCols(); }
922 virtual bool IsEmptyCell( int row
, int col
)
924 return GetValue(row
, col
).empty();
927 bool IsEmpty(const wxGridCellCoords
& coord
)
929 return IsEmptyCell(coord
.GetRow(), coord
.GetCol());
932 virtual wxString
GetValue( int row
, int col
) = 0;
933 virtual void SetValue( int row
, int col
, const wxString
& value
) = 0;
935 // Data type determination and value access
936 virtual wxString
GetTypeName( int row
, int col
);
937 virtual bool CanGetValueAs( int row
, int col
, const wxString
& typeName
);
938 virtual bool CanSetValueAs( int row
, int col
, const wxString
& typeName
);
940 virtual long GetValueAsLong( int row
, int col
);
941 virtual double GetValueAsDouble( int row
, int col
);
942 virtual bool GetValueAsBool( int row
, int col
);
944 virtual void SetValueAsLong( int row
, int col
, long value
);
945 virtual void SetValueAsDouble( int row
, int col
, double value
);
946 virtual void SetValueAsBool( int row
, int col
, bool value
);
948 // For user defined types
949 virtual void* GetValueAsCustom( int row
, int col
, const wxString
& typeName
);
950 virtual void SetValueAsCustom( int row
, int col
, const wxString
& typeName
, void* value
);
953 // Overriding these is optional
955 virtual void SetView( wxGrid
*grid
) { m_view
= grid
; }
956 virtual wxGrid
* GetView() const { return m_view
; }
958 virtual void Clear() {}
959 virtual bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
960 virtual bool AppendRows( size_t numRows
= 1 );
961 virtual bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
962 virtual bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
963 virtual bool AppendCols( size_t numCols
= 1 );
964 virtual bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
966 virtual wxString
GetRowLabelValue( int row
);
967 virtual wxString
GetColLabelValue( int col
);
968 virtual void SetRowLabelValue( int WXUNUSED(row
), const wxString
& ) {}
969 virtual void SetColLabelValue( int WXUNUSED(col
), const wxString
& ) {}
971 // Attribute handling
974 // give us the attr provider to use - we take ownership of the pointer
975 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
977 // get the currently used attr provider (may be NULL)
978 wxGridCellAttrProvider
*GetAttrProvider() const { return m_attrProvider
; }
980 // Does this table allow attributes? Default implementation creates
981 // a wxGridCellAttrProvider if necessary.
982 virtual bool CanHaveAttributes();
984 // by default forwarded to wxGridCellAttrProvider if any. May be
985 // overridden to handle attributes directly in the table.
986 virtual wxGridCellAttr
*GetAttr( int row
, int col
,
987 wxGridCellAttr::wxAttrKind kind
);
990 // these functions take ownership of the pointer
991 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
992 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
993 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
997 wxGridCellAttrProvider
*m_attrProvider
;
999 DECLARE_ABSTRACT_CLASS(wxGridTableBase
)
1000 DECLARE_NO_COPY_CLASS(wxGridTableBase
)
1004 // ----------------------------------------------------------------------------
1005 // wxGridTableMessage
1006 // ----------------------------------------------------------------------------
1008 // IDs for messages sent from grid table to view
1010 enum wxGridTableRequest
1012 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
= 2000,
1013 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES
,
1014 wxGRIDTABLE_NOTIFY_ROWS_INSERTED
,
1015 wxGRIDTABLE_NOTIFY_ROWS_APPENDED
,
1016 wxGRIDTABLE_NOTIFY_ROWS_DELETED
,
1017 wxGRIDTABLE_NOTIFY_COLS_INSERTED
,
1018 wxGRIDTABLE_NOTIFY_COLS_APPENDED
,
1019 wxGRIDTABLE_NOTIFY_COLS_DELETED
1022 class WXDLLIMPEXP_ADV wxGridTableMessage
1025 wxGridTableMessage();
1026 wxGridTableMessage( wxGridTableBase
*table
, int id
,
1030 void SetTableObject( wxGridTableBase
*table
) { m_table
= table
; }
1031 wxGridTableBase
* GetTableObject() const { return m_table
; }
1032 void SetId( int id
) { m_id
= id
; }
1033 int GetId() { return m_id
; }
1034 void SetCommandInt( int comInt1
) { m_comInt1
= comInt1
; }
1035 int GetCommandInt() { return m_comInt1
; }
1036 void SetCommandInt2( int comInt2
) { m_comInt2
= comInt2
; }
1037 int GetCommandInt2() { return m_comInt2
; }
1040 wxGridTableBase
*m_table
;
1045 DECLARE_NO_COPY_CLASS(wxGridTableMessage
)
1050 // ------ wxGridStringArray
1051 // A 2-dimensional array of strings for data values
1054 WX_DECLARE_OBJARRAY_WITH_DECL(wxArrayString
, wxGridStringArray
,
1055 class WXDLLIMPEXP_ADV
);
1059 // ------ wxGridStringTable
1061 // Simplest type of data table for a grid for small tables of strings
1062 // that are stored in memory
1065 class WXDLLIMPEXP_ADV wxGridStringTable
: public wxGridTableBase
1068 wxGridStringTable();
1069 wxGridStringTable( int numRows
, int numCols
);
1070 virtual ~wxGridStringTable();
1072 // these are pure virtual in wxGridTableBase
1074 int GetNumberRows();
1075 int GetNumberCols();
1076 wxString
GetValue( int row
, int col
);
1077 void SetValue( int row
, int col
, const wxString
& s
);
1079 // overridden functions from wxGridTableBase
1082 bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
1083 bool AppendRows( size_t numRows
= 1 );
1084 bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
1085 bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
1086 bool AppendCols( size_t numCols
= 1 );
1087 bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
1089 void SetRowLabelValue( int row
, const wxString
& );
1090 void SetColLabelValue( int col
, const wxString
& );
1091 wxString
GetRowLabelValue( int row
);
1092 wxString
GetColLabelValue( int col
);
1095 wxGridStringArray m_data
;
1097 // These only get used if you set your own labels, otherwise the
1098 // GetRow/ColLabelValue functions return wxGridTableBase defaults
1100 wxArrayString m_rowLabels
;
1101 wxArrayString m_colLabels
;
1103 DECLARE_DYNAMIC_CLASS_NO_COPY( wxGridStringTable
)
1108 // ============================================================================
1109 // Grid view classes
1110 // ============================================================================
1112 // ----------------------------------------------------------------------------
1114 // ----------------------------------------------------------------------------
1116 class WXDLLIMPEXP_ADV wxGrid
: public wxScrolledWindow
1119 // possible selection modes
1120 enum wxGridSelectionModes
1122 wxGridSelectCells
= 0, // allow selecting anything
1123 wxGridSelectRows
= 1, // allow selecting only entire rows
1124 wxGridSelectColumns
= 2, // allow selecting only entire columns
1125 wxGridSelectRowsOrColumns
= wxGridSelectRows
| wxGridSelectColumns
1128 // creation and destruction
1129 // ------------------------
1131 // ctor and Create() create the grid window, as with the other controls
1132 wxGrid() { Init(); }
1134 wxGrid(wxWindow
*parent
,
1136 const wxPoint
& pos
= wxDefaultPosition
,
1137 const wxSize
& size
= wxDefaultSize
,
1138 long style
= wxWANTS_CHARS
,
1139 const wxString
& name
= wxGridNameStr
)
1143 Create(parent
, id
, pos
, size
, style
, name
);
1146 bool Create(wxWindow
*parent
,
1148 const wxPoint
& pos
= wxDefaultPosition
,
1149 const wxSize
& size
= wxDefaultSize
,
1150 long style
= wxWANTS_CHARS
,
1151 const wxString
& name
= wxGridNameStr
);
1155 // however to initialize grid data either CreateGrid() or SetTable() must
1158 // this is basically equivalent to
1160 // SetTable(new wxGridStringTable(numRows, numCols), true, selmode)
1162 bool CreateGrid( int numRows
, int numCols
,
1163 wxGridSelectionModes selmode
= wxGridSelectCells
);
1165 bool SetTable( wxGridTableBase
*table
,
1166 bool takeOwnership
= false,
1167 wxGridSelectionModes selmode
= wxGridSelectCells
);
1169 bool ProcessTableMessage(wxGridTableMessage
&);
1171 wxGridTableBase
*GetTable() const { return m_table
; }
1174 void SetSelectionMode(wxGridSelectionModes selmode
);
1175 wxGridSelectionModes
GetSelectionMode() const;
1177 // ------ grid dimensions
1179 int GetNumberRows() const { return m_numRows
; }
1180 int GetNumberCols() const { return m_numCols
; }
1183 // ------ display update functions
1185 wxArrayInt
CalcRowLabelsExposed( const wxRegion
& reg
) const;
1187 wxArrayInt
CalcColLabelsExposed( const wxRegion
& reg
) const;
1188 wxGridCellCoordsArray
CalcCellsExposed( const wxRegion
& reg
) const;
1192 bool InsertRows(int pos
= 0, int numRows
= 1, bool updateLabels
= true)
1194 return DoModifyLines(&wxGridTableBase::InsertRows
,
1195 pos
, numRows
, updateLabels
);
1197 bool InsertCols(int pos
= 0, int numCols
= 1, bool updateLabels
= true)
1199 return DoModifyLines(&wxGridTableBase::InsertCols
,
1200 pos
, numCols
, updateLabels
);
1203 bool AppendRows(int numRows
= 1, bool updateLabels
= true)
1205 return DoAppendLines(&wxGridTableBase::AppendRows
, numRows
, updateLabels
);
1207 bool AppendCols(int numCols
= 1, bool updateLabels
= true)
1209 return DoAppendLines(&wxGridTableBase::AppendCols
, numCols
, updateLabels
);
1212 bool DeleteRows(int pos
= 0, int numRows
= 1, bool updateLabels
= true)
1214 return DoModifyLines(&wxGridTableBase::DeleteRows
,
1215 pos
, numRows
, updateLabels
);
1217 bool DeleteCols(int pos
= 0, int numCols
= 1, bool updateLabels
= true)
1219 return DoModifyLines(&wxGridTableBase::DeleteCols
,
1220 pos
, numCols
, updateLabels
);
1223 void DrawGridCellArea( wxDC
& dc
, const wxGridCellCoordsArray
& cells
);
1224 void DrawGridSpace( wxDC
& dc
);
1225 void DrawCellBorder( wxDC
& dc
, const wxGridCellCoords
& );
1226 void DrawAllGridLines( wxDC
& dc
, const wxRegion
& reg
);
1227 void DrawCell( wxDC
& dc
, const wxGridCellCoords
& );
1228 void DrawHighlight(wxDC
& dc
, const wxGridCellCoordsArray
& cells
);
1230 // this function is called when the current cell highlight must be redrawn
1231 // and may be overridden by the user
1232 virtual void DrawCellHighlight( wxDC
& dc
, const wxGridCellAttr
*attr
);
1234 virtual void DrawRowLabels( wxDC
& dc
, const wxArrayInt
& rows
);
1235 virtual void DrawRowLabel( wxDC
& dc
, int row
);
1237 virtual void DrawColLabels( wxDC
& dc
, const wxArrayInt
& cols
);
1238 virtual void DrawColLabel( wxDC
& dc
, int col
);
1240 virtual void DrawCornerLabel(wxDC
& dc
);
1242 // ------ Cell text drawing functions
1244 void DrawTextRectangle( wxDC
& dc
, const wxString
&, const wxRect
&,
1245 int horizontalAlignment
= wxALIGN_LEFT
,
1246 int verticalAlignment
= wxALIGN_TOP
,
1247 int textOrientation
= wxHORIZONTAL
);
1249 void DrawTextRectangle( wxDC
& dc
, const wxArrayString
& lines
, const wxRect
&,
1250 int horizontalAlignment
= wxALIGN_LEFT
,
1251 int verticalAlignment
= wxALIGN_TOP
,
1252 int textOrientation
= wxHORIZONTAL
);
1255 // Split a string containing newline characters into an array of
1256 // strings and return the number of lines
1258 void StringToLines( const wxString
& value
, wxArrayString
& lines
) const;
1260 void GetTextBoxSize( const wxDC
& dc
,
1261 const wxArrayString
& lines
,
1262 long *width
, long *height
) const;
1266 // Code that does a lot of grid modification can be enclosed
1267 // between BeginBatch() and EndBatch() calls to avoid screen
1270 void BeginBatch() { m_batchCount
++; }
1273 int GetBatchCount() { return m_batchCount
; }
1275 virtual void Refresh(bool eraseb
= true, const wxRect
* rect
= NULL
);
1277 // Use this, rather than wxWindow::Refresh(), to force an
1278 // immediate repainting of the grid. Has no effect if you are
1279 // already inside a BeginBatch / EndBatch block.
1281 // This function is necessary because wxGrid has a minimal OnPaint()
1282 // handler to reduce screen flicker.
1284 void ForceRefresh();
1287 // ------ edit control functions
1289 bool IsEditable() const { return m_editable
; }
1290 void EnableEditing( bool edit
);
1292 void EnableCellEditControl( bool enable
= true );
1293 void DisableCellEditControl() { EnableCellEditControl(false); }
1294 bool CanEnableCellControl() const;
1295 bool IsCellEditControlEnabled() const;
1296 bool IsCellEditControlShown() const;
1298 bool IsCurrentCellReadOnly() const;
1300 void ShowCellEditControl();
1301 void HideCellEditControl();
1302 void SaveEditControlValue();
1305 // ------ grid location functions
1306 // Note that all of these functions work with the logical coordinates of
1307 // grid cells and labels so you will need to convert from device
1308 // coordinates for mouse events etc.
1310 wxGridCellCoords
XYToCell(int x
, int y
) const;
1311 void XYToCell(int x
, int y
, wxGridCellCoords
& coords
) const
1312 { coords
= XYToCell(x
, y
); }
1313 wxGridCellCoords
XYToCell(const wxPoint
& pos
) const
1314 { return XYToCell(pos
.x
, pos
.y
); }
1316 // these functions return the index of the row/columns corresponding to the
1317 // given logical position in pixels
1319 // if clipToMinMax is false (default, wxNOT_FOUND is returned if the
1320 // position is outside any row/column, otherwise the first/last element is
1321 // returned in this case
1322 int YToRow( int y
, bool clipToMinMax
= false ) const;
1323 int XToCol( int x
, bool clipToMinMax
= false ) const;
1325 int YToEdgeOfRow( int y
) const;
1326 int XToEdgeOfCol( int x
) const;
1328 wxRect
CellToRect( int row
, int col
) const;
1329 wxRect
CellToRect( const wxGridCellCoords
& coords
) const
1330 { return CellToRect( coords
.GetRow(), coords
.GetCol() ); }
1332 int GetGridCursorRow() const { return m_currentCellCoords
.GetRow(); }
1333 int GetGridCursorCol() const { return m_currentCellCoords
.GetCol(); }
1335 // check to see if a cell is either wholly visible (the default arg) or
1336 // at least partially visible in the grid window
1338 bool IsVisible( int row
, int col
, bool wholeCellVisible
= true ) const;
1339 bool IsVisible( const wxGridCellCoords
& coords
, bool wholeCellVisible
= true ) const
1340 { return IsVisible( coords
.GetRow(), coords
.GetCol(), wholeCellVisible
); }
1341 void MakeCellVisible( int row
, int col
);
1342 void MakeCellVisible( const wxGridCellCoords
& coords
)
1343 { MakeCellVisible( coords
.GetRow(), coords
.GetCol() ); }
1346 // ------ grid cursor movement functions
1348 void SetGridCursor(int row
, int col
) { SetCurrentCell(row
, col
); }
1349 void SetGridCursor(const wxGridCellCoords
& c
) { SetCurrentCell(c
); }
1351 void GoToCell(int row
, int col
)
1353 if ( SetCurrentCell(row
, col
) )
1354 MakeCellVisible(row
, col
);
1357 void GoToCell(const wxGridCellCoords
& coords
)
1359 if ( SetCurrentCell(coords
) )
1360 MakeCellVisible(coords
);
1363 bool MoveCursorUp( bool expandSelection
);
1364 bool MoveCursorDown( bool expandSelection
);
1365 bool MoveCursorLeft( bool expandSelection
);
1366 bool MoveCursorRight( bool expandSelection
);
1367 bool MovePageDown();
1369 bool MoveCursorUpBlock( bool expandSelection
);
1370 bool MoveCursorDownBlock( bool expandSelection
);
1371 bool MoveCursorLeftBlock( bool expandSelection
);
1372 bool MoveCursorRightBlock( bool expandSelection
);
1375 // ------ label and gridline formatting
1377 int GetDefaultRowLabelSize() const { return WXGRID_DEFAULT_ROW_LABEL_WIDTH
; }
1378 int GetRowLabelSize() const { return m_rowLabelWidth
; }
1379 int GetDefaultColLabelSize() const { return WXGRID_DEFAULT_COL_LABEL_HEIGHT
; }
1380 int GetColLabelSize() const { return m_colLabelHeight
; }
1381 wxColour
GetLabelBackgroundColour() const { return m_labelBackgroundColour
; }
1382 wxColour
GetLabelTextColour() const { return m_labelTextColour
; }
1383 wxFont
GetLabelFont() const { return m_labelFont
; }
1384 void GetRowLabelAlignment( int *horiz
, int *vert
) const;
1385 void GetColLabelAlignment( int *horiz
, int *vert
) const;
1386 int GetColLabelTextOrientation() const;
1387 wxString
GetRowLabelValue( int row
) const;
1388 wxString
GetColLabelValue( int col
) const;
1390 wxColour
GetCellHighlightColour() const { return m_cellHighlightColour
; }
1391 int GetCellHighlightPenWidth() const { return m_cellHighlightPenWidth
; }
1392 int GetCellHighlightROPenWidth() const { return m_cellHighlightROPenWidth
; }
1394 // this one will use wxHeaderCtrl for the column labels
1395 void UseNativeColHeader(bool native
= true);
1397 // this one will still draw them manually but using the native renderer
1398 // instead of using the same appearance as for the row labels
1399 void SetUseNativeColLabels( bool native
= true );
1401 void SetRowLabelSize( int width
);
1402 void SetColLabelSize( int height
);
1403 void HideRowLabels() { SetRowLabelSize( 0 ); }
1404 void HideColLabels() { SetColLabelSize( 0 ); }
1405 void SetLabelBackgroundColour( const wxColour
& );
1406 void SetLabelTextColour( const wxColour
& );
1407 void SetLabelFont( const wxFont
& );
1408 void SetRowLabelAlignment( int horiz
, int vert
);
1409 void SetColLabelAlignment( int horiz
, int vert
);
1410 void SetColLabelTextOrientation( int textOrientation
);
1411 void SetRowLabelValue( int row
, const wxString
& );
1412 void SetColLabelValue( int col
, const wxString
& );
1413 void SetCellHighlightColour( const wxColour
& );
1414 void SetCellHighlightPenWidth(int width
);
1415 void SetCellHighlightROPenWidth(int width
);
1417 void EnableDragRowSize( bool enable
= true );
1418 void DisableDragRowSize() { EnableDragRowSize( false ); }
1419 bool CanDragRowSize() const { return m_canDragRowSize
; }
1420 void EnableDragColSize( bool enable
= true );
1421 void DisableDragColSize() { EnableDragColSize( false ); }
1422 bool CanDragColSize() const { return m_canDragColSize
; }
1423 void EnableDragColMove( bool enable
= true );
1424 void DisableDragColMove() { EnableDragColMove( false ); }
1425 bool CanDragColMove() const { return m_canDragColMove
; }
1426 void EnableDragGridSize(bool enable
= true);
1427 void DisableDragGridSize() { EnableDragGridSize(false); }
1428 bool CanDragGridSize() const { return m_canDragGridSize
; }
1430 void EnableDragCell( bool enable
= true );
1431 void DisableDragCell() { EnableDragCell( false ); }
1432 bool CanDragCell() const { return m_canDragCell
; }
1438 // enable or disable drawing of the lines
1439 void EnableGridLines(bool enable
= true);
1440 bool GridLinesEnabled() const { return m_gridLinesEnabled
; }
1442 // by default grid lines stop at last column/row, but this may be changed
1443 void ClipHorzGridLines(bool clip
)
1444 { DoClipGridLines(m_gridLinesClipHorz
, clip
); }
1445 void ClipVertGridLines(bool clip
)
1446 { DoClipGridLines(m_gridLinesClipVert
, clip
); }
1447 bool AreHorzGridLinesClipped() const { return m_gridLinesClipHorz
; }
1448 bool AreVertGridLinesClipped() const { return m_gridLinesClipVert
; }
1450 // this can be used to change the global grid lines colour
1451 void SetGridLineColour(const wxColour
& col
);
1452 wxColour
GetGridLineColour() const { return m_gridLineColour
; }
1454 // these methods may be overridden to customize individual grid lines
1456 virtual wxPen
GetDefaultGridLinePen();
1457 virtual wxPen
GetRowGridLinePen(int row
);
1458 virtual wxPen
GetColGridLinePen(int col
);
1464 // this sets the specified attribute for this cell or in this row/col
1465 void SetAttr(int row
, int col
, wxGridCellAttr
*attr
);
1466 void SetRowAttr(int row
, wxGridCellAttr
*attr
);
1467 void SetColAttr(int col
, wxGridCellAttr
*attr
);
1469 // returns the attribute we may modify in place: a new one if this cell
1470 // doesn't have any yet or the existing one if it does
1472 // DecRef() must be called on the returned pointer, as usual
1473 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1476 // shortcuts for setting the column parameters
1478 // set the format for the data in the column: default is string
1479 void SetColFormatBool(int col
);
1480 void SetColFormatNumber(int col
);
1481 void SetColFormatFloat(int col
, int width
= -1, int precision
= -1);
1482 void SetColFormatCustom(int col
, const wxString
& typeName
);
1484 // ------ row and col formatting
1486 int GetDefaultRowSize() const;
1487 int GetRowSize( int row
) const;
1488 int GetDefaultColSize() const;
1489 int GetColSize( int col
) const;
1490 wxColour
GetDefaultCellBackgroundColour() const;
1491 wxColour
GetCellBackgroundColour( int row
, int col
) const;
1492 wxColour
GetDefaultCellTextColour() const;
1493 wxColour
GetCellTextColour( int row
, int col
) const;
1494 wxFont
GetDefaultCellFont() const;
1495 wxFont
GetCellFont( int row
, int col
) const;
1496 void GetDefaultCellAlignment( int *horiz
, int *vert
) const;
1497 void GetCellAlignment( int row
, int col
, int *horiz
, int *vert
) const;
1498 bool GetDefaultCellOverflow() const;
1499 bool GetCellOverflow( int row
, int col
) const;
1500 void GetCellSize( int row
, int col
, int *num_rows
, int *num_cols
) const;
1501 wxSize
GetCellSize(const wxGridCellCoords
& coords
)
1504 GetCellSize(coords
.GetRow(), coords
.GetCol(), &s
.x
, &s
.y
);
1508 void SetDefaultRowSize( int height
, bool resizeExistingRows
= false );
1509 void SetRowSize( int row
, int height
);
1510 void SetDefaultColSize( int width
, bool resizeExistingCols
= false );
1512 void SetColSize( int col
, int width
);
1514 // columns index <-> positions mapping: by default, the position of the
1515 // column is the same as its index, but the columns can also be reordered
1516 // (either by calling SetColPos() explicitly or by the user dragging the
1517 // columns around) in which case their indices don't correspond to their
1518 // positions on display any longer
1520 // internally we always work with indices except for the functions which
1521 // have "Pos" in their names (and which work with columns, not pixels) and
1522 // only the display and hit testing code really cares about display
1525 // return the column index corresponding to the given (valid) position
1526 int GetColAt(int pos
) const
1528 return m_colAt
.empty() ? pos
: m_colAt
[pos
];
1531 // reorder the columns so that the column with the given index is now shown
1532 // as the position pos
1533 void SetColPos(int idx
, int pos
);
1535 // return the position at which the column with the given index is
1536 // displayed: notice that this is a slow operation as we don't maintain the
1537 // reverse mapping currently
1538 int GetColPos(int idx
) const
1540 if ( m_colAt
.IsEmpty() )
1543 for ( int i
= 0; i
< m_numCols
; i
++ )
1545 if ( m_colAt
[i
] == idx
)
1549 wxFAIL_MSG( "invalid column index" );
1556 // automatically size the column or row to fit to its contents, if
1557 // setAsMin is true, this optimal width will also be set as minimal width
1559 void AutoSizeColumn( int col
, bool setAsMin
= true )
1560 { AutoSizeColOrRow(col
, setAsMin
, wxGRID_COLUMN
); }
1561 void AutoSizeRow( int row
, bool setAsMin
= true )
1562 { AutoSizeColOrRow(row
, setAsMin
, wxGRID_ROW
); }
1564 // auto size all columns (very ineffective for big grids!)
1565 void AutoSizeColumns( bool setAsMin
= true )
1566 { (void)SetOrCalcColumnSizes(false, setAsMin
); }
1568 void AutoSizeRows( bool setAsMin
= true )
1569 { (void)SetOrCalcRowSizes(false, setAsMin
); }
1571 // auto size the grid, that is make the columns/rows of the "right" size
1572 // and also set the grid size to just fit its contents
1575 // Note for both AutoSizeRowLabelSize and AutoSizeColLabelSize:
1576 // If col equals to wxGRID_AUTOSIZE value then function autosizes labels column
1577 // instead of data column. Note that this operation may be slow for large
1579 // autosize row height depending on label text
1580 void AutoSizeRowLabelSize( int row
);
1582 // autosize column width depending on label text
1583 void AutoSizeColLabelSize( int col
);
1585 // column won't be resized to be lesser width - this must be called during
1586 // the grid creation because it won't resize the column if it's already
1587 // narrower than the minimal width
1588 void SetColMinimalWidth( int col
, int width
);
1589 void SetRowMinimalHeight( int row
, int width
);
1591 /* These members can be used to query and modify the minimal
1592 * acceptable size of grid rows and columns. Call this function in
1593 * your code which creates the grid if you want to display cells
1594 * with a size smaller than the default acceptable minimum size.
1595 * Like the members SetColMinimalWidth and SetRowMinimalWidth,
1596 * the existing rows or columns will not be checked/resized.
1598 void SetColMinimalAcceptableWidth( int width
);
1599 void SetRowMinimalAcceptableHeight( int width
);
1600 int GetColMinimalAcceptableWidth() const;
1601 int GetRowMinimalAcceptableHeight() const;
1603 void SetDefaultCellBackgroundColour( const wxColour
& );
1604 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
1605 void SetDefaultCellTextColour( const wxColour
& );
1607 void SetCellTextColour( int row
, int col
, const wxColour
& );
1608 void SetDefaultCellFont( const wxFont
& );
1609 void SetCellFont( int row
, int col
, const wxFont
& );
1610 void SetDefaultCellAlignment( int horiz
, int vert
);
1611 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
1612 void SetDefaultCellOverflow( bool allow
);
1613 void SetCellOverflow( int row
, int col
, bool allow
);
1614 void SetCellSize( int row
, int col
, int num_rows
, int num_cols
);
1616 // takes ownership of the pointer
1617 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
1618 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
1619 wxGridCellRenderer
*GetDefaultRenderer() const;
1620 wxGridCellRenderer
* GetCellRenderer(int row
, int col
) const;
1622 // takes ownership of the pointer
1623 void SetDefaultEditor(wxGridCellEditor
*editor
);
1624 void SetCellEditor(int row
, int col
, wxGridCellEditor
*editor
);
1625 wxGridCellEditor
*GetDefaultEditor() const;
1626 wxGridCellEditor
* GetCellEditor(int row
, int col
) const;
1630 // ------ cell value accessors
1632 wxString
GetCellValue( int row
, int col
) const
1636 return m_table
->GetValue( row
, col
);
1640 return wxEmptyString
;
1644 wxString
GetCellValue( const wxGridCellCoords
& coords
) const
1645 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
1647 void SetCellValue( int row
, int col
, const wxString
& s
);
1648 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
1649 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
1651 // returns true if the cell can't be edited
1652 bool IsReadOnly(int row
, int col
) const;
1654 // make the cell editable/readonly
1655 void SetReadOnly(int row
, int col
, bool isReadOnly
= true);
1657 // ------ select blocks of cells
1659 void SelectRow( int row
, bool addToSelected
= false );
1660 void SelectCol( int col
, bool addToSelected
= false );
1662 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
,
1663 bool addToSelected
= false );
1665 void SelectBlock( const wxGridCellCoords
& topLeft
,
1666 const wxGridCellCoords
& bottomRight
,
1667 bool addToSelected
= false )
1668 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
1669 bottomRight
.GetRow(), bottomRight
.GetCol(),
1674 bool IsSelection() const;
1676 // ------ deselect blocks or cells
1678 void DeselectRow( int row
);
1679 void DeselectCol( int col
);
1680 void DeselectCell( int row
, int col
);
1682 void ClearSelection();
1684 bool IsInSelection( int row
, int col
) const;
1686 bool IsInSelection( const wxGridCellCoords
& coords
) const
1687 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
1689 wxGridCellCoordsArray
GetSelectedCells() const;
1690 wxGridCellCoordsArray
GetSelectionBlockTopLeft() const;
1691 wxGridCellCoordsArray
GetSelectionBlockBottomRight() const;
1692 wxArrayInt
GetSelectedRows() const;
1693 wxArrayInt
GetSelectedCols() const;
1695 // This function returns the rectangle that encloses the block of cells
1696 // limited by TopLeft and BottomRight cell in device coords and clipped
1697 // to the client size of the grid window.
1699 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
1700 const wxGridCellCoords
& bottomRight
) const;
1702 // Access or update the selection fore/back colours
1703 wxColour
GetSelectionBackground() const
1704 { return m_selectionBackground
; }
1705 wxColour
GetSelectionForeground() const
1706 { return m_selectionForeground
; }
1708 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
1709 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
1712 // Methods for a registry for mapping data types to Renderers/Editors
1713 void RegisterDataType(const wxString
& typeName
,
1714 wxGridCellRenderer
* renderer
,
1715 wxGridCellEditor
* editor
);
1717 virtual wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1718 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const
1719 { return GetDefaultEditorForCell(c
.GetRow(), c
.GetCol()); }
1720 virtual wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
1721 virtual wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
1722 virtual wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
1724 // grid may occupy more space than needed for its rows/columns, this
1725 // function allows to set how big this extra space is
1726 void SetMargins(int extraWidth
, int extraHeight
)
1728 m_extraWidth
= extraWidth
;
1729 m_extraHeight
= extraHeight
;
1734 // Accessors for component windows
1735 wxWindow
* GetGridWindow() const { return (wxWindow
*)m_gridWin
; }
1736 wxWindow
* GetGridRowLabelWindow() const { return (wxWindow
*)m_rowLabelWin
; }
1737 wxWindow
* GetGridColLabelWindow() const { return m_colWindow
; }
1738 wxWindow
* GetGridCornerLabelWindow() const { return (wxWindow
*)m_cornerLabelWin
; }
1740 // Allow adjustment of scroll increment. The default is (15, 15).
1741 void SetScrollLineX(int x
) { m_scrollLineX
= x
; }
1742 void SetScrollLineY(int y
) { m_scrollLineY
= y
; }
1743 int GetScrollLineX() const { return m_scrollLineX
; }
1744 int GetScrollLineY() const { return m_scrollLineY
; }
1746 // ------- drag and drop
1747 #if wxUSE_DRAG_AND_DROP
1748 virtual void SetDropTarget(wxDropTarget
*dropTarget
);
1749 #endif // wxUSE_DRAG_AND_DROP
1752 #ifdef WXWIN_COMPATIBILITY_2_8
1753 // ------ For compatibility with previous wxGrid only...
1755 // ************************************************
1756 // ** Don't use these in new code because they **
1757 // ** are liable to disappear in a future **
1759 // ************************************************
1762 wxGrid( wxWindow
*parent
,
1763 int x
, int y
, int w
= wxDefaultCoord
, int h
= wxDefaultCoord
,
1764 long style
= wxWANTS_CHARS
,
1765 const wxString
& name
= wxPanelNameStr
)
1768 Create(parent
, wxID_ANY
, wxPoint(x
, y
), wxSize(w
, h
), style
, name
);
1771 void SetCellValue( const wxString
& val
, int row
, int col
)
1772 { SetCellValue( row
, col
, val
); }
1774 void UpdateDimensions()
1775 { CalcDimensions(); }
1777 int GetRows() const { return GetNumberRows(); }
1778 int GetCols() const { return GetNumberCols(); }
1779 int GetCursorRow() const { return GetGridCursorRow(); }
1780 int GetCursorColumn() const { return GetGridCursorCol(); }
1782 int GetScrollPosX() const { return 0; }
1783 int GetScrollPosY() const { return 0; }
1785 void SetScrollX( int WXUNUSED(x
) ) { }
1786 void SetScrollY( int WXUNUSED(y
) ) { }
1788 void SetColumnWidth( int col
, int width
)
1789 { SetColSize( col
, width
); }
1791 int GetColumnWidth( int col
) const
1792 { return GetColSize( col
); }
1794 void SetRowHeight( int row
, int height
)
1795 { SetRowSize( row
, height
); }
1797 // GetRowHeight() is below
1799 int GetViewHeight() const // returned num whole rows visible
1802 int GetViewWidth() const // returned num whole cols visible
1805 void SetLabelSize( int orientation
, int sz
)
1807 if ( orientation
== wxHORIZONTAL
)
1808 SetColLabelSize( sz
);
1810 SetRowLabelSize( sz
);
1813 int GetLabelSize( int orientation
) const
1815 if ( orientation
== wxHORIZONTAL
)
1816 return GetColLabelSize();
1818 return GetRowLabelSize();
1821 void SetLabelAlignment( int orientation
, int align
)
1823 if ( orientation
== wxHORIZONTAL
)
1824 SetColLabelAlignment( align
, -1 );
1826 SetRowLabelAlignment( align
, -1 );
1829 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) ) const
1832 if ( orientation
== wxHORIZONTAL
)
1834 GetColLabelAlignment( &h
, &v
);
1839 GetRowLabelAlignment( &h
, &v
);
1844 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
1846 if ( orientation
== wxHORIZONTAL
)
1847 SetColLabelValue( pos
, val
);
1849 SetRowLabelValue( pos
, val
);
1852 wxString
GetLabelValue( int orientation
, int pos
) const
1854 if ( orientation
== wxHORIZONTAL
)
1855 return GetColLabelValue( pos
);
1857 return GetRowLabelValue( pos
);
1860 wxFont
GetCellTextFont() const
1861 { return m_defaultCellAttr
->GetFont(); }
1863 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
1864 { return m_defaultCellAttr
->GetFont(); }
1866 void SetCellTextFont(const wxFont
& fnt
)
1867 { SetDefaultCellFont( fnt
); }
1869 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
1870 { SetCellFont( row
, col
, fnt
); }
1872 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
1873 { SetCellTextColour( row
, col
, val
); }
1875 void SetCellTextColour(const wxColour
& col
)
1876 { SetDefaultCellTextColour( col
); }
1878 void SetCellBackgroundColour(const wxColour
& col
)
1879 { SetDefaultCellBackgroundColour( col
); }
1881 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1882 { SetCellBackgroundColour( row
, col
, colour
); }
1884 bool GetEditable() const { return IsEditable(); }
1885 void SetEditable( bool edit
= true ) { EnableEditing( edit
); }
1886 bool GetEditInPlace() const { return IsCellEditControlEnabled(); }
1888 void SetEditInPlace(bool WXUNUSED(edit
) = true) { }
1890 void SetCellAlignment( int align
, int row
, int col
)
1891 { SetCellAlignment(row
, col
, align
, wxALIGN_CENTER
); }
1892 void SetCellAlignment( int WXUNUSED(align
) ) {}
1893 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1895 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1896 wxPen
& GetDividerPen() const;
1897 void OnActivate(bool WXUNUSED(active
)) {}
1899 // ******** End of compatibility functions **********
1903 // ------ control IDs
1904 enum { wxGRID_CELLCTRL
= 2000,
1907 // ------ control types
1908 enum { wxGRID_TEXTCTRL
= 2100,
1912 #endif // WXWIN_COMPATIBILITY_2_8
1915 // override some base class functions
1916 virtual bool Enable(bool enable
= true);
1917 virtual wxWindow
*GetMainWindowOfCompositeControl()
1918 { return (wxWindow
*)m_gridWin
; }
1921 // implementation only
1922 void CancelMouseCapture();
1925 virtual wxSize
DoGetBestSize() const;
1929 wxGridWindow
*m_gridWin
;
1930 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1931 wxGridRowLabelWindow
*m_rowLabelWin
;
1933 // the real type of the column window depends on m_useNativeHeader value:
1934 // if it is true, its dynamic type is wxHeaderCtrl, otherwise it is
1935 // wxGridColLabelWindow, use accessors below when the real type matters
1936 wxWindow
*m_colWindow
;
1938 wxHeaderCtrl
*GetColHeader() const
1940 wxASSERT_MSG( m_useNativeHeader
, "no column header window" );
1942 // static_cast<> doesn't work without the full class declaration in
1943 // view and we prefer to avoid adding more compile-time dependencies
1944 // even at the cost of using reinterpret_cast<>
1945 return reinterpret_cast<wxHeaderCtrl
*>(m_colWindow
);
1948 wxGridColLabelWindow
*GetColLabelWindow() const
1950 wxASSERT_MSG( !m_useNativeHeader
, "no column label window" );
1952 return reinterpret_cast<wxGridColLabelWindow
*>(m_colWindow
);
1955 wxGridTableBase
*m_table
;
1961 wxGridCellCoords m_currentCellCoords
;
1963 // the corners of the block being currently selected or wxGridNoCellCoords
1964 wxGridCellCoords m_selectedBlockTopLeft
;
1965 wxGridCellCoords m_selectedBlockBottomRight
;
1967 // when selecting blocks of cells (either from the keyboard using Shift
1968 // with cursor keys, or by dragging the mouse), the selection is anchored
1969 // at m_currentCellCoords which defines one of the corners of the rectangle
1970 // being selected -- and this variable defines the other corner, i.e. it's
1971 // either m_selectedBlockTopLeft or m_selectedBlockBottomRight depending on
1972 // which of them is not m_currentCellCoords
1974 // if no block selection is in process, it is set to wxGridNoCellCoords
1975 wxGridCellCoords m_selectedBlockCorner
;
1977 wxGridSelection
*m_selection
;
1979 wxColour m_selectionBackground
;
1980 wxColour m_selectionForeground
;
1982 // NB: *never* access m_row/col arrays directly because they are created
1983 // on demand, *always* use accessor functions instead!
1985 // init the m_rowHeights/Bottoms arrays with default values
1986 void InitRowHeights();
1988 int m_defaultRowHeight
;
1989 int m_minAcceptableRowHeight
;
1990 wxArrayInt m_rowHeights
;
1991 wxArrayInt m_rowBottoms
;
1993 // init the m_colWidths/Rights arrays
1994 void InitColWidths();
1996 int m_defaultColWidth
;
1997 int m_minAcceptableColWidth
;
1998 wxArrayInt m_colWidths
;
1999 wxArrayInt m_colRights
;
2001 bool m_useNativeHeader
,
2002 m_nativeColumnLabels
;
2004 // get the col/row coords
2005 int GetColWidth(int col
) const;
2006 int GetColLeft(int col
) const;
2007 int GetColRight(int col
) const;
2009 // this function must be public for compatibility...
2011 int GetRowHeight(int row
) const;
2014 int GetRowTop(int row
) const;
2015 int GetRowBottom(int row
) const;
2017 int m_rowLabelWidth
;
2018 int m_colLabelHeight
;
2020 // the size of the margin left to the right and bottom of the cell area
2024 wxColour m_labelBackgroundColour
;
2025 wxColour m_labelTextColour
;
2028 int m_rowLabelHorizAlign
;
2029 int m_rowLabelVertAlign
;
2030 int m_colLabelHorizAlign
;
2031 int m_colLabelVertAlign
;
2032 int m_colLabelTextOrientation
;
2034 bool m_defaultRowLabelValues
;
2035 bool m_defaultColLabelValues
;
2037 wxColour m_gridLineColour
;
2038 bool m_gridLinesEnabled
;
2039 bool m_gridLinesClipHorz
,
2040 m_gridLinesClipVert
;
2041 wxColour m_cellHighlightColour
;
2042 int m_cellHighlightPenWidth
;
2043 int m_cellHighlightROPenWidth
;
2046 // common part of AutoSizeColumn/Row() and GetBestSize()
2047 int SetOrCalcColumnSizes(bool calcOnly
, bool setAsMin
= true);
2048 int SetOrCalcRowSizes(bool calcOnly
, bool setAsMin
= true);
2050 // common part of AutoSizeColumn/Row()
2051 void AutoSizeColOrRow(int n
, bool setAsMin
, wxGridDirection direction
);
2053 // Calculate the minimum acceptable size for labels area
2054 wxCoord
CalcColOrRowLabelAreaMinSize(wxGridDirection direction
);
2056 // if a column has a minimal width, it will be the value for it in this
2058 wxLongToLongHashMap m_colMinWidths
,
2061 // get the minimal width of the given column/row
2062 int GetColMinimalWidth(int col
) const;
2063 int GetRowMinimalHeight(int col
) const;
2065 // do we have some place to store attributes in?
2066 bool CanHaveAttributes() const;
2068 // cell attribute cache (currently we only cache 1, may be will do
2069 // more/better later)
2073 wxGridCellAttr
*attr
;
2076 // invalidates the attribute cache
2077 void ClearAttrCache();
2079 // adds an attribute to cache
2080 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
2082 // looks for an attr in cache, returns true if found
2083 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
2085 // looks for the attr in cache, if not found asks the table and caches the
2087 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
2088 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
) const
2089 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
2091 // the default cell attr object for cells that don't have their own
2092 wxGridCellAttr
* m_defaultCellAttr
;
2099 wxGridTypeRegistry
* m_typeRegistry
;
2103 WXGRID_CURSOR_SELECT_CELL
,
2104 WXGRID_CURSOR_RESIZE_ROW
,
2105 WXGRID_CURSOR_RESIZE_COL
,
2106 WXGRID_CURSOR_SELECT_ROW
,
2107 WXGRID_CURSOR_SELECT_COL
,
2108 WXGRID_CURSOR_MOVE_COL
2111 // this method not only sets m_cursorMode but also sets the correct cursor
2112 // for the given mode and, if captureMouse is not false releases the mouse
2113 // if it was captured and captures it if it must be captured
2115 // for this to work, you should always use it and not set m_cursorMode
2117 void ChangeCursorMode(CursorMode mode
,
2118 wxWindow
*win
= NULL
,
2119 bool captureMouse
= true);
2121 wxWindow
*m_winCapture
; // the window which captured the mouse
2123 // this variable is used not for finding the correct current cursor but
2124 // mainly for finding out what is going to happen if the mouse starts being
2125 // dragged right now
2127 // by default it is WXGRID_CURSOR_SELECT_CELL meaning that nothing else is
2128 // going on, and it is set to one of RESIZE/SELECT/MOVE values while the
2129 // corresponding operation will be started if the user starts dragging the
2130 // mouse from the current position
2131 CursorMode m_cursorMode
;
2138 bool m_canDragRowSize
;
2139 bool m_canDragColSize
;
2140 bool m_canDragColMove
;
2141 bool m_canDragGridSize
;
2144 // the last position (horizontal or vertical depending on whether the user
2145 // is resizing a column or a row) where a row or column separator line was
2146 // dragged by the user or -1 of there is no drag operation in progress
2150 // true if a drag operation is in progress; when this is true,
2151 // m_startDragPos is valid, i.e. not wxDefaultPosition
2154 // the position (in physical coordinates) where the user started dragging
2155 // the mouse or wxDefaultPosition if mouse isn't being dragged
2157 // notice that this can be != wxDefaultPosition while m_isDragging is still
2158 // false because we wait until the mouse is moved some distance away before
2159 // setting m_isDragging to true
2160 wxPoint m_startDragPos
;
2162 bool m_waitForSlowClick
;
2164 wxGridCellCoords m_selectionStart
;
2166 wxCursor m_rowResizeCursor
;
2167 wxCursor m_colResizeCursor
;
2169 bool m_editable
; // applies to whole grid
2170 bool m_cellEditCtrlEnabled
; // is in-place edit currently shown?
2172 int m_scrollLineX
; // X scroll increment
2173 int m_scrollLineY
; // Y scroll increment
2175 void Init(); // common part of all ctors
2177 void CreateColumnWindow();
2178 void CalcDimensions();
2179 void CalcWindowSizes();
2180 bool Redimension( wxGridTableMessage
& );
2183 // generate the appropriate grid event and return -1 if it was vetoed, 1 if
2184 // it was processed (but not vetoed) and 0 if it wasn't processed
2185 int SendEvent(const wxEventType evtType
,
2188 int SendEvent(const wxEventType evtType
,
2189 const wxGridCellCoords
& coords
,
2191 { return SendEvent(evtType
, coords
.GetRow(), coords
.GetCol(), e
); }
2192 int SendEvent(const wxEventType evtType
, int row
, int col
);
2193 int SendEvent(const wxEventType evtType
, const wxGridCellCoords
& coords
)
2194 { return SendEvent(evtType
, coords
.GetRow(), coords
.GetCol()); }
2195 int SendEvent(const wxEventType evtType
)
2196 { return SendEvent(evtType
, m_currentCellCoords
); }
2198 void OnPaint( wxPaintEvent
& );
2199 void OnSize( wxSizeEvent
& );
2200 void OnKeyDown( wxKeyEvent
& );
2201 void OnKeyUp( wxKeyEvent
& );
2202 void OnChar( wxKeyEvent
& );
2203 void OnEraseBackground( wxEraseEvent
& );
2206 bool SetCurrentCell( const wxGridCellCoords
& coords
);
2207 bool SetCurrentCell( int row
, int col
)
2208 { return SetCurrentCell( wxGridCellCoords(row
, col
) ); }
2211 // this function is called to extend the block being currently selected
2212 // from mouse and keyboard event handlers
2213 void UpdateBlockBeingSelected(int topRow
, int leftCol
,
2214 int bottomRow
, int rightCol
);
2216 void UpdateBlockBeingSelected(const wxGridCellCoords
& topLeft
,
2217 const wxGridCellCoords
& bottomRight
)
2218 { UpdateBlockBeingSelected(topLeft
.GetRow(), topLeft
.GetCol(),
2219 bottomRight
.GetRow(), bottomRight
.GetCol()); }
2221 // ------ functions to get/send data (see also public functions)
2223 bool GetModelValues();
2224 bool SetModelValues();
2226 friend class WXDLLIMPEXP_FWD_ADV wxGridSelection
;
2227 friend class wxGridRowOperations
;
2228 friend class wxGridColumnOperations
;
2230 // they call our private Process{{Corner,Col,Row}Label,GridCell}MouseEvent()
2231 friend class wxGridCornerLabelWindow
;
2232 friend class wxGridColLabelWindow
;
2233 friend class wxGridRowLabelWindow
;
2234 friend class wxGridWindow
;
2236 friend class wxGridHeaderCtrl
;
2239 // implement wxScrolledWindow method to return m_gridWin size
2240 virtual wxSize
GetSizeAvailableForScrollTarget(const wxSize
& size
);
2242 // redraw the grid lines, should be called after changing their attributes
2243 void RedrawGridLines();
2245 // common part of Clip{Horz,Vert}GridLines
2246 void DoClipGridLines(bool& var
, bool clip
);
2249 // return the position (not index) of the column at the given logical pixel
2252 // this always returns a valid position, even if the coordinate is out of
2253 // bounds (in which case first/last column is returned)
2254 int XToPos(int x
) const;
2257 // event handlers and their helpers
2258 // --------------------------------
2260 // process mouse drag event in WXGRID_CURSOR_SELECT_CELL mode
2261 void DoGridCellDrag(wxMouseEvent
& event
,
2262 const wxGridCellCoords
& coords
,
2265 // process row/column resizing drag event
2266 void DoGridLineDrag(wxMouseEvent
& event
, const wxGridOperations
& oper
);
2268 // process mouse drag event in the grid window
2269 void DoGridDragEvent(wxMouseEvent
& event
, const wxGridCellCoords
& coords
);
2271 // process different clicks on grid cells
2272 void DoGridCellLeftDown(wxMouseEvent
& event
,
2273 const wxGridCellCoords
& coords
,
2274 const wxPoint
& pos
);
2275 void DoGridCellLeftDClick(wxMouseEvent
& event
,
2276 const wxGridCellCoords
& coords
,
2277 const wxPoint
& pos
);
2278 void DoGridCellLeftUp(wxMouseEvent
& event
, const wxGridCellCoords
& coords
);
2280 // process movement (but not dragging) event in the grid cell area
2281 void DoGridMouseMoveEvent(wxMouseEvent
& event
,
2282 const wxGridCellCoords
& coords
,
2283 const wxPoint
& pos
);
2285 // process mouse events in the grid window
2286 void ProcessGridCellMouseEvent(wxMouseEvent
& event
);
2288 // process mouse events in the row/column labels/corner windows
2289 void ProcessRowLabelMouseEvent(wxMouseEvent
& event
);
2290 void ProcessColLabelMouseEvent(wxMouseEvent
& event
);
2291 void ProcessCornerLabelMouseEvent(wxMouseEvent
& event
);
2293 void DoStartResizeCol(int col
);
2294 void DoUpdateResizeCol(int x
);
2295 void DoUpdateResizeColWidth(int w
);
2297 void DoEndDragResizeRow();
2298 void DoEndDragResizeCol(wxMouseEvent
*event
= NULL
);
2299 void DoEndDragMoveCol();
2302 // common implementations of methods defined for both rows and columns
2303 void DeselectLine(int line
, const wxGridOperations
& oper
);
2304 void DoEndDragResizeLine(const wxGridOperations
& oper
);
2305 int PosToLinePos(int pos
, bool clipToMinMax
,
2306 const wxGridOperations
& oper
) const;
2307 int PosToLine(int pos
, bool clipToMinMax
,
2308 const wxGridOperations
& oper
) const;
2309 int PosToEdgeOfLine(int pos
, const wxGridOperations
& oper
) const;
2311 bool DoMoveCursor(bool expandSelection
,
2312 const wxGridDirectionOperations
& diroper
);
2313 bool DoMoveCursorByPage(const wxGridDirectionOperations
& diroper
);
2314 bool DoMoveCursorByBlock(bool expandSelection
,
2315 const wxGridDirectionOperations
& diroper
);
2316 void AdvanceToNextNonEmpty(wxGridCellCoords
& coords
,
2317 const wxGridDirectionOperations
& diroper
);
2319 // common part of {Insert,Delete}{Rows,Cols}
2320 bool DoModifyLines(bool (wxGridTableBase::*funcModify
)(size_t, size_t),
2321 int pos
, int num
, bool updateLabels
);
2322 // Append{Rows,Cols} is a bit different because of one less parameter
2323 bool DoAppendLines(bool (wxGridTableBase::*funcAppend
)(size_t),
2324 int num
, bool updateLabels
);
2326 DECLARE_DYNAMIC_CLASS( wxGrid
)
2327 DECLARE_EVENT_TABLE()
2328 DECLARE_NO_COPY_CLASS(wxGrid
)
2331 // ----------------------------------------------------------------------------
2332 // wxGridUpdateLocker prevents updates to a grid during its lifetime
2333 // ----------------------------------------------------------------------------
2335 class WXDLLIMPEXP_ADV wxGridUpdateLocker
2338 // if the pointer is NULL, Create() can be called later
2339 wxGridUpdateLocker(wxGrid
*grid
= NULL
)
2344 // can be called if ctor was used with a NULL pointer, must not be called
2346 void Create(wxGrid
*grid
)
2348 wxASSERT_MSG( !m_grid
, _T("shouldn't be called more than once") );
2353 ~wxGridUpdateLocker()
2360 void Init(wxGrid
*grid
)
2364 m_grid
->BeginBatch();
2369 DECLARE_NO_COPY_CLASS(wxGridUpdateLocker
)
2372 // ----------------------------------------------------------------------------
2373 // Grid event class and event types
2374 // ----------------------------------------------------------------------------
2376 class WXDLLIMPEXP_ADV wxGridEvent
: public wxNotifyEvent
,
2377 public wxKeyboardState
2383 Init(-1, -1, -1, -1, false);
2389 int row
= -1, int col
= -1,
2390 int x
= -1, int y
= -1,
2392 const wxKeyboardState
& kbd
= wxKeyboardState())
2393 : wxNotifyEvent(type
, id
),
2394 wxKeyboardState(kbd
)
2396 Init(row
, col
, x
, y
, sel
);
2397 SetEventObject(obj
);
2400 // explicitly specifying inline allows gcc < 3.4 to
2401 // handle the deprecation attribute even in the constructor.
2402 wxDEPRECATED( inline
2410 bool shift
= false, bool alt
= false, bool meta
= false));
2412 virtual int GetRow() { return m_row
; }
2413 virtual int GetCol() { return m_col
; }
2414 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
2415 bool Selecting() { return m_selecting
; }
2417 virtual wxEvent
*Clone() const { return new wxGridEvent(*this); }
2427 void Init(int row
, int col
, int x
, int y
, bool sel
)
2436 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEvent
)
2439 class WXDLLIMPEXP_ADV wxGridSizeEvent
: public wxNotifyEvent
,
2440 public wxKeyboardState
2449 wxGridSizeEvent(int id
,
2453 int x
= -1, int y
= -1,
2454 const wxKeyboardState
& kbd
= wxKeyboardState())
2455 : wxNotifyEvent(type
, id
),
2456 wxKeyboardState(kbd
)
2458 Init(rowOrCol
, x
, y
);
2460 SetEventObject(obj
);
2463 wxDEPRECATED( inline
2464 wxGridSizeEvent(int id
,
2472 bool meta
= false) );
2474 int GetRowOrCol() { return m_rowOrCol
; }
2475 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
2477 virtual wxEvent
*Clone() const { return new wxGridSizeEvent(*this); }
2485 void Init(int rowOrCol
, int x
, int y
)
2487 m_rowOrCol
= rowOrCol
;
2492 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridSizeEvent
)
2496 class WXDLLIMPEXP_ADV wxGridRangeSelectEvent
: public wxNotifyEvent
,
2497 public wxKeyboardState
2500 wxGridRangeSelectEvent()
2503 Init(wxGridNoCellCoords
, wxGridNoCellCoords
, false);
2506 wxGridRangeSelectEvent(int id
,
2509 const wxGridCellCoords
& topLeft
,
2510 const wxGridCellCoords
& bottomRight
,
2512 const wxKeyboardState
& kbd
= wxKeyboardState())
2513 : wxNotifyEvent(type
, id
),
2514 wxKeyboardState(kbd
)
2516 Init(topLeft
, bottomRight
, sel
);
2518 SetEventObject(obj
);
2521 wxDEPRECATED( inline
2522 wxGridRangeSelectEvent(int id
,
2525 const wxGridCellCoords
& topLeft
,
2526 const wxGridCellCoords
& bottomRight
,
2531 bool meta
= false) );
2533 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
2534 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
2535 int GetTopRow() { return m_topLeft
.GetRow(); }
2536 int GetBottomRow() { return m_bottomRight
.GetRow(); }
2537 int GetLeftCol() { return m_topLeft
.GetCol(); }
2538 int GetRightCol() { return m_bottomRight
.GetCol(); }
2539 bool Selecting() { return m_selecting
; }
2541 virtual wxEvent
*Clone() const { return new wxGridRangeSelectEvent(*this); }
2544 void Init(const wxGridCellCoords
& topLeft
,
2545 const wxGridCellCoords
& bottomRight
,
2548 m_topLeft
= topLeft
;
2549 m_bottomRight
= bottomRight
;
2550 m_selecting
= selecting
;
2553 wxGridCellCoords m_topLeft
;
2554 wxGridCellCoords m_bottomRight
;
2557 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridRangeSelectEvent
)
2561 class WXDLLIMPEXP_ADV wxGridEditorCreatedEvent
: public wxCommandEvent
2564 wxGridEditorCreatedEvent()
2572 wxGridEditorCreatedEvent(int id
, wxEventType type
, wxObject
* obj
,
2573 int row
, int col
, wxControl
* ctrl
);
2575 int GetRow() { return m_row
; }
2576 int GetCol() { return m_col
; }
2577 wxControl
* GetControl() { return m_ctrl
; }
2578 void SetRow(int row
) { m_row
= row
; }
2579 void SetCol(int col
) { m_col
= col
; }
2580 void SetControl(wxControl
* ctrl
) { m_ctrl
= ctrl
; }
2582 virtual wxEvent
*Clone() const { return new wxGridEditorCreatedEvent(*this); }
2589 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEditorCreatedEvent
)
2593 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_LEFT_CLICK
;
2594 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK
;
2595 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK
;
2596 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK
;
2597 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK
;
2598 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK
;
2599 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK
;
2600 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK
;
2601 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_ROW_SIZE
;
2602 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_SIZE
;
2603 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_RANGE_SELECT
;
2604 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_CHANGE
;
2605 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_SELECT_CELL
;
2606 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_SHOWN
;
2607 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_HIDDEN
;
2608 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_CREATED
;
2609 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_BEGIN_DRAG
;
2610 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_MOVE
;
2613 typedef void (wxEvtHandler::*wxGridEventFunction
)(wxGridEvent
&);
2614 typedef void (wxEvtHandler::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
2615 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
2616 typedef void (wxEvtHandler::*wxGridEditorCreatedEventFunction
)(wxGridEditorCreatedEvent
&);
2618 #define wxGridEventHandler(func) \
2619 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEventFunction, &func)
2621 #define wxGridSizeEventHandler(func) \
2622 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridSizeEventFunction, &func)
2624 #define wxGridRangeSelectEventHandler(func) \
2625 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridRangeSelectEventFunction, &func)
2627 #define wxGridEditorCreatedEventHandler(func) \
2628 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEditorCreatedEventFunction, &func)
2630 #define wx__DECLARE_GRIDEVT(evt, id, fn) \
2631 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEventHandler(fn))
2633 #define wx__DECLARE_GRIDSIZEEVT(evt, id, fn) \
2634 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridSizeEventHandler(fn))
2636 #define wx__DECLARE_GRIDRANGESELEVT(evt, id, fn) \
2637 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridRangeSelectEventHandler(fn))
2639 #define wx__DECLARE_GRIDEDITOREVT(evt, id, fn) \
2640 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEditorCreatedEventHandler(fn))
2642 #define EVT_GRID_CMD_CELL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_CLICK, id, fn)
2643 #define EVT_GRID_CMD_CELL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_CLICK, id, fn)
2644 #define EVT_GRID_CMD_CELL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_DCLICK, id, fn)
2645 #define EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_DCLICK, id, fn)
2646 #define EVT_GRID_CMD_LABEL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_CLICK, id, fn)
2647 #define EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_CLICK, id, fn)
2648 #define EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_DCLICK, id, fn)
2649 #define EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_DCLICK, id, fn)
2650 #define EVT_GRID_CMD_ROW_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(ROW_SIZE, id, fn)
2651 #define EVT_GRID_CMD_COL_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(COL_SIZE, id, fn)
2652 #define EVT_GRID_CMD_COL_MOVE(id, fn) wx__DECLARE_GRIDEVT(COL_MOVE, id, fn)
2653 #define EVT_GRID_CMD_RANGE_SELECT(id, fn) wx__DECLARE_GRIDRANGESELEVT(RANGE_SELECT, id, fn)
2654 #define EVT_GRID_CMD_CELL_CHANGE(id, fn) wx__DECLARE_GRIDEVT(CELL_CHANGE, id, fn)
2655 #define EVT_GRID_CMD_SELECT_CELL(id, fn) wx__DECLARE_GRIDEVT(SELECT_CELL, id, fn)
2656 #define EVT_GRID_CMD_EDITOR_SHOWN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_SHOWN, id, fn)
2657 #define EVT_GRID_CMD_EDITOR_HIDDEN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_HIDDEN, id, fn)
2658 #define EVT_GRID_CMD_EDITOR_CREATED(id, fn) wx__DECLARE_GRIDEDITOREVT(EDITOR_CREATED, id, fn)
2659 #define EVT_GRID_CMD_CELL_BEGIN_DRAG(id, fn) wx__DECLARE_GRIDEVT(CELL_BEGIN_DRAG, id, fn)
2661 // same as above but for any id (exists mainly for backwards compatibility but
2662 // then it's also true that you rarely have multiple grid in the same window)
2663 #define EVT_GRID_CELL_LEFT_CLICK(fn) EVT_GRID_CMD_CELL_LEFT_CLICK(wxID_ANY, fn)
2664 #define EVT_GRID_CELL_RIGHT_CLICK(fn) EVT_GRID_CMD_CELL_RIGHT_CLICK(wxID_ANY, fn)
2665 #define EVT_GRID_CELL_LEFT_DCLICK(fn) EVT_GRID_CMD_CELL_LEFT_DCLICK(wxID_ANY, fn)
2666 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) EVT_GRID_CMD_CELL_RIGHT_DCLICK(wxID_ANY, fn)
2667 #define EVT_GRID_LABEL_LEFT_CLICK(fn) EVT_GRID_CMD_LABEL_LEFT_CLICK(wxID_ANY, fn)
2668 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_CLICK(wxID_ANY, fn)
2669 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) EVT_GRID_CMD_LABEL_LEFT_DCLICK(wxID_ANY, fn)
2670 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_DCLICK(wxID_ANY, fn)
2671 #define EVT_GRID_ROW_SIZE(fn) EVT_GRID_CMD_ROW_SIZE(wxID_ANY, fn)
2672 #define EVT_GRID_COL_SIZE(fn) EVT_GRID_CMD_COL_SIZE(wxID_ANY, fn)
2673 #define EVT_GRID_COL_MOVE(fn) EVT_GRID_CMD_COL_MOVE(wxID_ANY, fn)
2674 #define EVT_GRID_RANGE_SELECT(fn) EVT_GRID_CMD_RANGE_SELECT(wxID_ANY, fn)
2675 #define EVT_GRID_CELL_CHANGE(fn) EVT_GRID_CMD_CELL_CHANGE(wxID_ANY, fn)
2676 #define EVT_GRID_SELECT_CELL(fn) EVT_GRID_CMD_SELECT_CELL(wxID_ANY, fn)
2677 #define EVT_GRID_EDITOR_SHOWN(fn) EVT_GRID_CMD_EDITOR_SHOWN(wxID_ANY, fn)
2678 #define EVT_GRID_EDITOR_HIDDEN(fn) EVT_GRID_CMD_EDITOR_HIDDEN(wxID_ANY, fn)
2679 #define EVT_GRID_EDITOR_CREATED(fn) EVT_GRID_CMD_EDITOR_CREATED(wxID_ANY, fn)
2680 #define EVT_GRID_CELL_BEGIN_DRAG(fn) EVT_GRID_CMD_CELL_BEGIN_DRAG(wxID_ANY, fn)
2682 #if 0 // TODO: implement these ? others ?
2684 extern const int wxEVT_GRID_CREATE_CELL
;
2685 extern const int wxEVT_GRID_CHANGE_LABELS
;
2686 extern const int wxEVT_GRID_CHANGE_SEL_LABEL
;
2688 #define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2689 #define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2690 #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 ),
2694 #endif // wxUSE_GRID
2695 #endif // _WX_GENERIC_GRID_H_