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 // ------ row and col sizes
1509 void SetDefaultRowSize( int height
, bool resizeExistingRows
= false );
1510 void SetRowSize( int row
, int height
);
1511 void HideRow(int row
) { SetRowSize(row
, 0); }
1512 void ShowRow(int row
) { SetRowSize(row
, -1); }
1514 void SetDefaultColSize( int width
, bool resizeExistingCols
= false );
1515 void SetColSize( int col
, int width
);
1516 void HideCol(int col
) { SetColSize(col
, 0); }
1517 void ShowCol(int col
) { SetColSize(col
, -1); }
1520 // ------- columns (only, for now) reordering
1522 // columns index <-> positions mapping: by default, the position of the
1523 // column is the same as its index, but the columns can also be reordered
1524 // (either by calling SetColPos() explicitly or by the user dragging the
1525 // columns around) in which case their indices don't correspond to their
1526 // positions on display any longer
1528 // internally we always work with indices except for the functions which
1529 // have "Pos" in their names (and which work with columns, not pixels) and
1530 // only the display and hit testing code really cares about display
1533 // return the column index corresponding to the given (valid) position
1534 int GetColAt(int pos
) const
1536 return m_colAt
.empty() ? pos
: m_colAt
[pos
];
1539 // reorder the columns so that the column with the given index is now shown
1540 // as the position pos
1541 void SetColPos(int idx
, int pos
);
1543 // return the position at which the column with the given index is
1544 // displayed: notice that this is a slow operation as we don't maintain the
1545 // reverse mapping currently
1546 int GetColPos(int idx
) const
1548 if ( m_colAt
.IsEmpty() )
1551 for ( int i
= 0; i
< m_numCols
; i
++ )
1553 if ( m_colAt
[i
] == idx
)
1557 wxFAIL_MSG( "invalid column index" );
1562 // reset the columns positions to the default order
1566 // automatically size the column or row to fit to its contents, if
1567 // setAsMin is true, this optimal width will also be set as minimal width
1569 void AutoSizeColumn( int col
, bool setAsMin
= true )
1570 { AutoSizeColOrRow(col
, setAsMin
, wxGRID_COLUMN
); }
1571 void AutoSizeRow( int row
, bool setAsMin
= true )
1572 { AutoSizeColOrRow(row
, setAsMin
, wxGRID_ROW
); }
1574 // auto size all columns (very ineffective for big grids!)
1575 void AutoSizeColumns( bool setAsMin
= true )
1576 { (void)SetOrCalcColumnSizes(false, setAsMin
); }
1578 void AutoSizeRows( bool setAsMin
= true )
1579 { (void)SetOrCalcRowSizes(false, setAsMin
); }
1581 // auto size the grid, that is make the columns/rows of the "right" size
1582 // and also set the grid size to just fit its contents
1585 // Note for both AutoSizeRowLabelSize and AutoSizeColLabelSize:
1586 // If col equals to wxGRID_AUTOSIZE value then function autosizes labels column
1587 // instead of data column. Note that this operation may be slow for large
1589 // autosize row height depending on label text
1590 void AutoSizeRowLabelSize( int row
);
1592 // autosize column width depending on label text
1593 void AutoSizeColLabelSize( int col
);
1595 // column won't be resized to be lesser width - this must be called during
1596 // the grid creation because it won't resize the column if it's already
1597 // narrower than the minimal width
1598 void SetColMinimalWidth( int col
, int width
);
1599 void SetRowMinimalHeight( int row
, int width
);
1601 /* These members can be used to query and modify the minimal
1602 * acceptable size of grid rows and columns. Call this function in
1603 * your code which creates the grid if you want to display cells
1604 * with a size smaller than the default acceptable minimum size.
1605 * Like the members SetColMinimalWidth and SetRowMinimalWidth,
1606 * the existing rows or columns will not be checked/resized.
1608 void SetColMinimalAcceptableWidth( int width
);
1609 void SetRowMinimalAcceptableHeight( int width
);
1610 int GetColMinimalAcceptableWidth() const;
1611 int GetRowMinimalAcceptableHeight() const;
1613 void SetDefaultCellBackgroundColour( const wxColour
& );
1614 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
1615 void SetDefaultCellTextColour( const wxColour
& );
1617 void SetCellTextColour( int row
, int col
, const wxColour
& );
1618 void SetDefaultCellFont( const wxFont
& );
1619 void SetCellFont( int row
, int col
, const wxFont
& );
1620 void SetDefaultCellAlignment( int horiz
, int vert
);
1621 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
1622 void SetDefaultCellOverflow( bool allow
);
1623 void SetCellOverflow( int row
, int col
, bool allow
);
1624 void SetCellSize( int row
, int col
, int num_rows
, int num_cols
);
1626 // takes ownership of the pointer
1627 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
1628 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
1629 wxGridCellRenderer
*GetDefaultRenderer() const;
1630 wxGridCellRenderer
* GetCellRenderer(int row
, int col
) const;
1632 // takes ownership of the pointer
1633 void SetDefaultEditor(wxGridCellEditor
*editor
);
1634 void SetCellEditor(int row
, int col
, wxGridCellEditor
*editor
);
1635 wxGridCellEditor
*GetDefaultEditor() const;
1636 wxGridCellEditor
* GetCellEditor(int row
, int col
) const;
1640 // ------ cell value accessors
1642 wxString
GetCellValue( int row
, int col
) const
1646 return m_table
->GetValue( row
, col
);
1650 return wxEmptyString
;
1654 wxString
GetCellValue( const wxGridCellCoords
& coords
) const
1655 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
1657 void SetCellValue( int row
, int col
, const wxString
& s
);
1658 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
1659 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
1661 // returns true if the cell can't be edited
1662 bool IsReadOnly(int row
, int col
) const;
1664 // make the cell editable/readonly
1665 void SetReadOnly(int row
, int col
, bool isReadOnly
= true);
1667 // ------ select blocks of cells
1669 void SelectRow( int row
, bool addToSelected
= false );
1670 void SelectCol( int col
, bool addToSelected
= false );
1672 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
,
1673 bool addToSelected
= false );
1675 void SelectBlock( const wxGridCellCoords
& topLeft
,
1676 const wxGridCellCoords
& bottomRight
,
1677 bool addToSelected
= false )
1678 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
1679 bottomRight
.GetRow(), bottomRight
.GetCol(),
1684 bool IsSelection() const;
1686 // ------ deselect blocks or cells
1688 void DeselectRow( int row
);
1689 void DeselectCol( int col
);
1690 void DeselectCell( int row
, int col
);
1692 void ClearSelection();
1694 bool IsInSelection( int row
, int col
) const;
1696 bool IsInSelection( const wxGridCellCoords
& coords
) const
1697 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
1699 wxGridCellCoordsArray
GetSelectedCells() const;
1700 wxGridCellCoordsArray
GetSelectionBlockTopLeft() const;
1701 wxGridCellCoordsArray
GetSelectionBlockBottomRight() const;
1702 wxArrayInt
GetSelectedRows() const;
1703 wxArrayInt
GetSelectedCols() const;
1705 // This function returns the rectangle that encloses the block of cells
1706 // limited by TopLeft and BottomRight cell in device coords and clipped
1707 // to the client size of the grid window.
1709 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
1710 const wxGridCellCoords
& bottomRight
) const;
1712 // Access or update the selection fore/back colours
1713 wxColour
GetSelectionBackground() const
1714 { return m_selectionBackground
; }
1715 wxColour
GetSelectionForeground() const
1716 { return m_selectionForeground
; }
1718 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
1719 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
1722 // Methods for a registry for mapping data types to Renderers/Editors
1723 void RegisterDataType(const wxString
& typeName
,
1724 wxGridCellRenderer
* renderer
,
1725 wxGridCellEditor
* editor
);
1727 virtual wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1728 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const
1729 { return GetDefaultEditorForCell(c
.GetRow(), c
.GetCol()); }
1730 virtual wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
1731 virtual wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
1732 virtual wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
1734 // grid may occupy more space than needed for its rows/columns, this
1735 // function allows to set how big this extra space is
1736 void SetMargins(int extraWidth
, int extraHeight
)
1738 m_extraWidth
= extraWidth
;
1739 m_extraHeight
= extraHeight
;
1744 // Accessors for component windows
1745 wxWindow
* GetGridWindow() const { return (wxWindow
*)m_gridWin
; }
1746 wxWindow
* GetGridRowLabelWindow() const { return (wxWindow
*)m_rowLabelWin
; }
1747 wxWindow
* GetGridColLabelWindow() const { return m_colWindow
; }
1748 wxWindow
* GetGridCornerLabelWindow() const { return (wxWindow
*)m_cornerLabelWin
; }
1750 // Allow adjustment of scroll increment. The default is (15, 15).
1751 void SetScrollLineX(int x
) { m_scrollLineX
= x
; }
1752 void SetScrollLineY(int y
) { m_scrollLineY
= y
; }
1753 int GetScrollLineX() const { return m_scrollLineX
; }
1754 int GetScrollLineY() const { return m_scrollLineY
; }
1756 // ------- drag and drop
1757 #if wxUSE_DRAG_AND_DROP
1758 virtual void SetDropTarget(wxDropTarget
*dropTarget
);
1759 #endif // wxUSE_DRAG_AND_DROP
1762 // ------- sorting support
1764 // wxGrid doesn't support sorting on its own but it can indicate the sort
1765 // order in the column header (currently only if native header control is
1768 // return the column currently displaying the sort indicator or wxNOT_FOUND
1770 int GetSortingColumn() const { return m_sortCol
; }
1772 // return true if this column is currently used for sorting
1773 bool IsSortingBy(int col
) const { return GetSortingColumn() == col
; }
1775 // return the current sorting order (on GetSortingColumn()): true for
1776 // ascending sort and false for descending; it doesn't make sense to call
1777 // it if GetSortingColumn() returns wxNOT_FOUND
1778 bool IsSortOrderAscending() const { return m_sortIsAscending
; }
1780 // set the sorting column (or unsets any existing one if wxNOT_FOUND) and
1781 // the order in which to sort
1782 void SetSortingColumn(int col
, bool ascending
= true);
1784 // unset any existing sorting column
1785 void UnsetSortingColumn() { SetSortingColumn(wxNOT_FOUND
); }
1787 #ifdef WXWIN_COMPATIBILITY_2_8
1788 // ------ For compatibility with previous wxGrid only...
1790 // ************************************************
1791 // ** Don't use these in new code because they **
1792 // ** are liable to disappear in a future **
1794 // ************************************************
1797 wxGrid( wxWindow
*parent
,
1798 int x
, int y
, int w
= wxDefaultCoord
, int h
= wxDefaultCoord
,
1799 long style
= wxWANTS_CHARS
,
1800 const wxString
& name
= wxPanelNameStr
)
1803 Create(parent
, wxID_ANY
, wxPoint(x
, y
), wxSize(w
, h
), style
, name
);
1806 void SetCellValue( const wxString
& val
, int row
, int col
)
1807 { SetCellValue( row
, col
, val
); }
1809 void UpdateDimensions()
1810 { CalcDimensions(); }
1812 int GetRows() const { return GetNumberRows(); }
1813 int GetCols() const { return GetNumberCols(); }
1814 int GetCursorRow() const { return GetGridCursorRow(); }
1815 int GetCursorColumn() const { return GetGridCursorCol(); }
1817 int GetScrollPosX() const { return 0; }
1818 int GetScrollPosY() const { return 0; }
1820 void SetScrollX( int WXUNUSED(x
) ) { }
1821 void SetScrollY( int WXUNUSED(y
) ) { }
1823 void SetColumnWidth( int col
, int width
)
1824 { SetColSize( col
, width
); }
1826 int GetColumnWidth( int col
) const
1827 { return GetColSize( col
); }
1829 void SetRowHeight( int row
, int height
)
1830 { SetRowSize( row
, height
); }
1832 // GetRowHeight() is below
1834 int GetViewHeight() const // returned num whole rows visible
1837 int GetViewWidth() const // returned num whole cols visible
1840 void SetLabelSize( int orientation
, int sz
)
1842 if ( orientation
== wxHORIZONTAL
)
1843 SetColLabelSize( sz
);
1845 SetRowLabelSize( sz
);
1848 int GetLabelSize( int orientation
) const
1850 if ( orientation
== wxHORIZONTAL
)
1851 return GetColLabelSize();
1853 return GetRowLabelSize();
1856 void SetLabelAlignment( int orientation
, int align
)
1858 if ( orientation
== wxHORIZONTAL
)
1859 SetColLabelAlignment( align
, -1 );
1861 SetRowLabelAlignment( align
, -1 );
1864 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) ) const
1867 if ( orientation
== wxHORIZONTAL
)
1869 GetColLabelAlignment( &h
, &v
);
1874 GetRowLabelAlignment( &h
, &v
);
1879 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
1881 if ( orientation
== wxHORIZONTAL
)
1882 SetColLabelValue( pos
, val
);
1884 SetRowLabelValue( pos
, val
);
1887 wxString
GetLabelValue( int orientation
, int pos
) const
1889 if ( orientation
== wxHORIZONTAL
)
1890 return GetColLabelValue( pos
);
1892 return GetRowLabelValue( pos
);
1895 wxFont
GetCellTextFont() const
1896 { return m_defaultCellAttr
->GetFont(); }
1898 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
1899 { return m_defaultCellAttr
->GetFont(); }
1901 void SetCellTextFont(const wxFont
& fnt
)
1902 { SetDefaultCellFont( fnt
); }
1904 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
1905 { SetCellFont( row
, col
, fnt
); }
1907 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
1908 { SetCellTextColour( row
, col
, val
); }
1910 void SetCellTextColour(const wxColour
& col
)
1911 { SetDefaultCellTextColour( col
); }
1913 void SetCellBackgroundColour(const wxColour
& col
)
1914 { SetDefaultCellBackgroundColour( col
); }
1916 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1917 { SetCellBackgroundColour( row
, col
, colour
); }
1919 bool GetEditable() const { return IsEditable(); }
1920 void SetEditable( bool edit
= true ) { EnableEditing( edit
); }
1921 bool GetEditInPlace() const { return IsCellEditControlEnabled(); }
1923 void SetEditInPlace(bool WXUNUSED(edit
) = true) { }
1925 void SetCellAlignment( int align
, int row
, int col
)
1926 { SetCellAlignment(row
, col
, align
, wxALIGN_CENTER
); }
1927 void SetCellAlignment( int WXUNUSED(align
) ) {}
1928 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1930 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1931 wxPen
& GetDividerPen() const;
1932 void OnActivate(bool WXUNUSED(active
)) {}
1934 // ******** End of compatibility functions **********
1938 // ------ control IDs
1939 enum { wxGRID_CELLCTRL
= 2000,
1942 // ------ control types
1943 enum { wxGRID_TEXTCTRL
= 2100,
1947 #endif // WXWIN_COMPATIBILITY_2_8
1950 // override some base class functions
1951 virtual bool Enable(bool enable
= true);
1952 virtual wxWindow
*GetMainWindowOfCompositeControl()
1953 { return (wxWindow
*)m_gridWin
; }
1956 // implementation only
1957 void CancelMouseCapture();
1960 virtual wxSize
DoGetBestSize() const;
1964 wxGridWindow
*m_gridWin
;
1965 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1966 wxGridRowLabelWindow
*m_rowLabelWin
;
1968 // the real type of the column window depends on m_useNativeHeader value:
1969 // if it is true, its dynamic type is wxHeaderCtrl, otherwise it is
1970 // wxGridColLabelWindow, use accessors below when the real type matters
1971 wxWindow
*m_colWindow
;
1973 wxHeaderCtrl
*GetColHeader() const
1975 wxASSERT_MSG( m_useNativeHeader
, "no column header window" );
1977 // static_cast<> doesn't work without the full class declaration in
1978 // view and we prefer to avoid adding more compile-time dependencies
1979 // even at the cost of using reinterpret_cast<>
1980 return reinterpret_cast<wxHeaderCtrl
*>(m_colWindow
);
1983 wxGridColLabelWindow
*GetColLabelWindow() const
1985 wxASSERT_MSG( !m_useNativeHeader
, "no column label window" );
1987 return reinterpret_cast<wxGridColLabelWindow
*>(m_colWindow
);
1990 wxGridTableBase
*m_table
;
1996 wxGridCellCoords m_currentCellCoords
;
1998 // the corners of the block being currently selected or wxGridNoCellCoords
1999 wxGridCellCoords m_selectedBlockTopLeft
;
2000 wxGridCellCoords m_selectedBlockBottomRight
;
2002 // when selecting blocks of cells (either from the keyboard using Shift
2003 // with cursor keys, or by dragging the mouse), the selection is anchored
2004 // at m_currentCellCoords which defines one of the corners of the rectangle
2005 // being selected -- and this variable defines the other corner, i.e. it's
2006 // either m_selectedBlockTopLeft or m_selectedBlockBottomRight depending on
2007 // which of them is not m_currentCellCoords
2009 // if no block selection is in process, it is set to wxGridNoCellCoords
2010 wxGridCellCoords m_selectedBlockCorner
;
2012 wxGridSelection
*m_selection
;
2014 wxColour m_selectionBackground
;
2015 wxColour m_selectionForeground
;
2017 // NB: *never* access m_row/col arrays directly because they are created
2018 // on demand, *always* use accessor functions instead!
2020 // init the m_rowHeights/Bottoms arrays with default values
2021 void InitRowHeights();
2023 int m_defaultRowHeight
;
2024 int m_minAcceptableRowHeight
;
2025 wxArrayInt m_rowHeights
;
2026 wxArrayInt m_rowBottoms
;
2028 // init the m_colWidths/Rights arrays
2029 void InitColWidths();
2031 int m_defaultColWidth
;
2032 int m_minAcceptableColWidth
;
2033 wxArrayInt m_colWidths
;
2034 wxArrayInt m_colRights
;
2037 bool m_sortIsAscending
;
2039 bool m_useNativeHeader
,
2040 m_nativeColumnLabels
;
2042 // get the col/row coords
2043 int GetColWidth(int col
) const;
2044 int GetColLeft(int col
) const;
2045 int GetColRight(int col
) const;
2047 // this function must be public for compatibility...
2049 int GetRowHeight(int row
) const;
2052 int GetRowTop(int row
) const;
2053 int GetRowBottom(int row
) const;
2055 int m_rowLabelWidth
;
2056 int m_colLabelHeight
;
2058 // the size of the margin left to the right and bottom of the cell area
2062 wxColour m_labelBackgroundColour
;
2063 wxColour m_labelTextColour
;
2066 int m_rowLabelHorizAlign
;
2067 int m_rowLabelVertAlign
;
2068 int m_colLabelHorizAlign
;
2069 int m_colLabelVertAlign
;
2070 int m_colLabelTextOrientation
;
2072 bool m_defaultRowLabelValues
;
2073 bool m_defaultColLabelValues
;
2075 wxColour m_gridLineColour
;
2076 bool m_gridLinesEnabled
;
2077 bool m_gridLinesClipHorz
,
2078 m_gridLinesClipVert
;
2079 wxColour m_cellHighlightColour
;
2080 int m_cellHighlightPenWidth
;
2081 int m_cellHighlightROPenWidth
;
2084 // common part of AutoSizeColumn/Row() and GetBestSize()
2085 int SetOrCalcColumnSizes(bool calcOnly
, bool setAsMin
= true);
2086 int SetOrCalcRowSizes(bool calcOnly
, bool setAsMin
= true);
2088 // common part of AutoSizeColumn/Row()
2089 void AutoSizeColOrRow(int n
, bool setAsMin
, wxGridDirection direction
);
2091 // Calculate the minimum acceptable size for labels area
2092 wxCoord
CalcColOrRowLabelAreaMinSize(wxGridDirection direction
);
2094 // if a column has a minimal width, it will be the value for it in this
2096 wxLongToLongHashMap m_colMinWidths
,
2099 // get the minimal width of the given column/row
2100 int GetColMinimalWidth(int col
) const;
2101 int GetRowMinimalHeight(int col
) const;
2103 // do we have some place to store attributes in?
2104 bool CanHaveAttributes() const;
2106 // cell attribute cache (currently we only cache 1, may be will do
2107 // more/better later)
2111 wxGridCellAttr
*attr
;
2114 // invalidates the attribute cache
2115 void ClearAttrCache();
2117 // adds an attribute to cache
2118 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
2120 // looks for an attr in cache, returns true if found
2121 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
2123 // looks for the attr in cache, if not found asks the table and caches the
2125 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
2126 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
) const
2127 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
2129 // the default cell attr object for cells that don't have their own
2130 wxGridCellAttr
* m_defaultCellAttr
;
2137 wxGridTypeRegistry
* m_typeRegistry
;
2141 WXGRID_CURSOR_SELECT_CELL
,
2142 WXGRID_CURSOR_RESIZE_ROW
,
2143 WXGRID_CURSOR_RESIZE_COL
,
2144 WXGRID_CURSOR_SELECT_ROW
,
2145 WXGRID_CURSOR_SELECT_COL
,
2146 WXGRID_CURSOR_MOVE_COL
2149 // this method not only sets m_cursorMode but also sets the correct cursor
2150 // for the given mode and, if captureMouse is not false releases the mouse
2151 // if it was captured and captures it if it must be captured
2153 // for this to work, you should always use it and not set m_cursorMode
2155 void ChangeCursorMode(CursorMode mode
,
2156 wxWindow
*win
= NULL
,
2157 bool captureMouse
= true);
2159 wxWindow
*m_winCapture
; // the window which captured the mouse
2161 // this variable is used not for finding the correct current cursor but
2162 // mainly for finding out what is going to happen if the mouse starts being
2163 // dragged right now
2165 // by default it is WXGRID_CURSOR_SELECT_CELL meaning that nothing else is
2166 // going on, and it is set to one of RESIZE/SELECT/MOVE values while the
2167 // corresponding operation will be started if the user starts dragging the
2168 // mouse from the current position
2169 CursorMode m_cursorMode
;
2175 bool m_canDragRowSize
;
2176 bool m_canDragColSize
;
2177 bool m_canDragColMove
;
2178 bool m_canDragGridSize
;
2181 // the last position (horizontal or vertical depending on whether the user
2182 // is resizing a column or a row) where a row or column separator line was
2183 // dragged by the user or -1 of there is no drag operation in progress
2187 // true if a drag operation is in progress; when this is true,
2188 // m_startDragPos is valid, i.e. not wxDefaultPosition
2191 // the position (in physical coordinates) where the user started dragging
2192 // the mouse or wxDefaultPosition if mouse isn't being dragged
2194 // notice that this can be != wxDefaultPosition while m_isDragging is still
2195 // false because we wait until the mouse is moved some distance away before
2196 // setting m_isDragging to true
2197 wxPoint m_startDragPos
;
2199 bool m_waitForSlowClick
;
2201 wxGridCellCoords m_selectionStart
;
2203 wxCursor m_rowResizeCursor
;
2204 wxCursor m_colResizeCursor
;
2206 bool m_editable
; // applies to whole grid
2207 bool m_cellEditCtrlEnabled
; // is in-place edit currently shown?
2209 int m_scrollLineX
; // X scroll increment
2210 int m_scrollLineY
; // Y scroll increment
2212 void Init(); // common part of all ctors
2214 void CreateColumnWindow();
2215 void CalcDimensions();
2216 void CalcWindowSizes();
2217 bool Redimension( wxGridTableMessage
& );
2220 // generate the appropriate grid event and return -1 if it was vetoed, 1 if
2221 // it was processed (but not vetoed) and 0 if it wasn't processed
2222 int SendEvent(const wxEventType evtType
,
2225 int SendEvent(const wxEventType evtType
,
2226 const wxGridCellCoords
& coords
,
2228 { return SendEvent(evtType
, coords
.GetRow(), coords
.GetCol(), e
); }
2229 int SendEvent(const wxEventType evtType
, int row
, int col
);
2230 int SendEvent(const wxEventType evtType
, const wxGridCellCoords
& coords
)
2231 { return SendEvent(evtType
, coords
.GetRow(), coords
.GetCol()); }
2232 int SendEvent(const wxEventType evtType
)
2233 { return SendEvent(evtType
, m_currentCellCoords
); }
2235 void OnPaint( wxPaintEvent
& );
2236 void OnSize( wxSizeEvent
& );
2237 void OnKeyDown( wxKeyEvent
& );
2238 void OnKeyUp( wxKeyEvent
& );
2239 void OnChar( wxKeyEvent
& );
2240 void OnEraseBackground( wxEraseEvent
& );
2243 bool SetCurrentCell( const wxGridCellCoords
& coords
);
2244 bool SetCurrentCell( int row
, int col
)
2245 { return SetCurrentCell( wxGridCellCoords(row
, col
) ); }
2248 // this function is called to extend the block being currently selected
2249 // from mouse and keyboard event handlers
2250 void UpdateBlockBeingSelected(int topRow
, int leftCol
,
2251 int bottomRow
, int rightCol
);
2253 void UpdateBlockBeingSelected(const wxGridCellCoords
& topLeft
,
2254 const wxGridCellCoords
& bottomRight
)
2255 { UpdateBlockBeingSelected(topLeft
.GetRow(), topLeft
.GetCol(),
2256 bottomRight
.GetRow(), bottomRight
.GetCol()); }
2258 // ------ functions to get/send data (see also public functions)
2260 bool GetModelValues();
2261 bool SetModelValues();
2263 friend class WXDLLIMPEXP_FWD_ADV wxGridSelection
;
2264 friend class wxGridRowOperations
;
2265 friend class wxGridColumnOperations
;
2267 // they call our private Process{{Corner,Col,Row}Label,GridCell}MouseEvent()
2268 friend class wxGridCornerLabelWindow
;
2269 friend class wxGridColLabelWindow
;
2270 friend class wxGridRowLabelWindow
;
2271 friend class wxGridWindow
;
2273 friend class wxGridHeaderCtrl
;
2276 // implement wxScrolledWindow method to return m_gridWin size
2277 virtual wxSize
GetSizeAvailableForScrollTarget(const wxSize
& size
);
2279 // redraw the grid lines, should be called after changing their attributes
2280 void RedrawGridLines();
2282 // common part of Clip{Horz,Vert}GridLines
2283 void DoClipGridLines(bool& var
, bool clip
);
2285 // update the sorting indicator shown in the specified column (whose index
2288 // this will use GetSortingColumn() and IsSortOrderAscending() to determine
2289 // the sorting indicator to effectively show
2290 void UpdateColumnSortingIndicator(int col
);
2292 // update the grid after changing the columns order (common part of
2293 // SetColPos() and ResetColPos())
2294 void RefreshAfterColPosChange();
2297 // return the position (not index) of the column at the given logical pixel
2300 // this always returns a valid position, even if the coordinate is out of
2301 // bounds (in which case first/last column is returned)
2302 int XToPos(int x
) const;
2305 // event handlers and their helpers
2306 // --------------------------------
2308 // process mouse drag event in WXGRID_CURSOR_SELECT_CELL mode
2309 void DoGridCellDrag(wxMouseEvent
& event
,
2310 const wxGridCellCoords
& coords
,
2313 // process row/column resizing drag event
2314 void DoGridLineDrag(wxMouseEvent
& event
, const wxGridOperations
& oper
);
2316 // process mouse drag event in the grid window
2317 void DoGridDragEvent(wxMouseEvent
& event
, const wxGridCellCoords
& coords
);
2319 // process different clicks on grid cells
2320 void DoGridCellLeftDown(wxMouseEvent
& event
,
2321 const wxGridCellCoords
& coords
,
2322 const wxPoint
& pos
);
2323 void DoGridCellLeftDClick(wxMouseEvent
& event
,
2324 const wxGridCellCoords
& coords
,
2325 const wxPoint
& pos
);
2326 void DoGridCellLeftUp(wxMouseEvent
& event
, const wxGridCellCoords
& coords
);
2328 // process movement (but not dragging) event in the grid cell area
2329 void DoGridMouseMoveEvent(wxMouseEvent
& event
,
2330 const wxGridCellCoords
& coords
,
2331 const wxPoint
& pos
);
2333 // process mouse events in the grid window
2334 void ProcessGridCellMouseEvent(wxMouseEvent
& event
);
2336 // process mouse events in the row/column labels/corner windows
2337 void ProcessRowLabelMouseEvent(wxMouseEvent
& event
);
2338 void ProcessColLabelMouseEvent(wxMouseEvent
& event
);
2339 void ProcessCornerLabelMouseEvent(wxMouseEvent
& event
);
2341 void DoColHeaderClick(int col
);
2343 void DoStartResizeCol(int col
);
2344 void DoUpdateResizeCol(int x
);
2345 void DoUpdateResizeColWidth(int w
);
2346 void DoStartMoveCol(int col
);
2348 void DoEndDragResizeRow();
2349 void DoEndDragResizeCol(wxMouseEvent
*event
= NULL
);
2350 void DoEndMoveCol(int pos
);
2353 // common implementations of methods defined for both rows and columns
2354 void DeselectLine(int line
, const wxGridOperations
& oper
);
2355 void DoEndDragResizeLine(const wxGridOperations
& oper
);
2356 int PosToLinePos(int pos
, bool clipToMinMax
,
2357 const wxGridOperations
& oper
) const;
2358 int PosToLine(int pos
, bool clipToMinMax
,
2359 const wxGridOperations
& oper
) const;
2360 int PosToEdgeOfLine(int pos
, const wxGridOperations
& oper
) const;
2362 bool DoMoveCursor(bool expandSelection
,
2363 const wxGridDirectionOperations
& diroper
);
2364 bool DoMoveCursorByPage(const wxGridDirectionOperations
& diroper
);
2365 bool DoMoveCursorByBlock(bool expandSelection
,
2366 const wxGridDirectionOperations
& diroper
);
2367 void AdvanceToNextNonEmpty(wxGridCellCoords
& coords
,
2368 const wxGridDirectionOperations
& diroper
);
2370 // common part of {Insert,Delete}{Rows,Cols}
2371 bool DoModifyLines(bool (wxGridTableBase::*funcModify
)(size_t, size_t),
2372 int pos
, int num
, bool updateLabels
);
2373 // Append{Rows,Cols} is a bit different because of one less parameter
2374 bool DoAppendLines(bool (wxGridTableBase::*funcAppend
)(size_t),
2375 int num
, bool updateLabels
);
2377 DECLARE_DYNAMIC_CLASS( wxGrid
)
2378 DECLARE_EVENT_TABLE()
2379 DECLARE_NO_COPY_CLASS(wxGrid
)
2382 // ----------------------------------------------------------------------------
2383 // wxGridUpdateLocker prevents updates to a grid during its lifetime
2384 // ----------------------------------------------------------------------------
2386 class WXDLLIMPEXP_ADV wxGridUpdateLocker
2389 // if the pointer is NULL, Create() can be called later
2390 wxGridUpdateLocker(wxGrid
*grid
= NULL
)
2395 // can be called if ctor was used with a NULL pointer, must not be called
2397 void Create(wxGrid
*grid
)
2399 wxASSERT_MSG( !m_grid
, _T("shouldn't be called more than once") );
2404 ~wxGridUpdateLocker()
2411 void Init(wxGrid
*grid
)
2415 m_grid
->BeginBatch();
2420 DECLARE_NO_COPY_CLASS(wxGridUpdateLocker
)
2423 // ----------------------------------------------------------------------------
2424 // Grid event class and event types
2425 // ----------------------------------------------------------------------------
2427 class WXDLLIMPEXP_ADV wxGridEvent
: public wxNotifyEvent
,
2428 public wxKeyboardState
2434 Init(-1, -1, -1, -1, false);
2440 int row
= -1, int col
= -1,
2441 int x
= -1, int y
= -1,
2443 const wxKeyboardState
& kbd
= wxKeyboardState())
2444 : wxNotifyEvent(type
, id
),
2445 wxKeyboardState(kbd
)
2447 Init(row
, col
, x
, y
, sel
);
2448 SetEventObject(obj
);
2451 // explicitly specifying inline allows gcc < 3.4 to
2452 // handle the deprecation attribute even in the constructor.
2453 wxDEPRECATED( inline
2461 bool shift
= false, bool alt
= false, bool meta
= false));
2463 virtual int GetRow() { return m_row
; }
2464 virtual int GetCol() { return m_col
; }
2465 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
2466 bool Selecting() { return m_selecting
; }
2468 virtual wxEvent
*Clone() const { return new wxGridEvent(*this); }
2478 void Init(int row
, int col
, int x
, int y
, bool sel
)
2487 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEvent
)
2490 class WXDLLIMPEXP_ADV wxGridSizeEvent
: public wxNotifyEvent
,
2491 public wxKeyboardState
2500 wxGridSizeEvent(int id
,
2504 int x
= -1, int y
= -1,
2505 const wxKeyboardState
& kbd
= wxKeyboardState())
2506 : wxNotifyEvent(type
, id
),
2507 wxKeyboardState(kbd
)
2509 Init(rowOrCol
, x
, y
);
2511 SetEventObject(obj
);
2514 wxDEPRECATED( inline
2515 wxGridSizeEvent(int id
,
2523 bool meta
= false) );
2525 int GetRowOrCol() { return m_rowOrCol
; }
2526 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
2528 virtual wxEvent
*Clone() const { return new wxGridSizeEvent(*this); }
2536 void Init(int rowOrCol
, int x
, int y
)
2538 m_rowOrCol
= rowOrCol
;
2543 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridSizeEvent
)
2547 class WXDLLIMPEXP_ADV wxGridRangeSelectEvent
: public wxNotifyEvent
,
2548 public wxKeyboardState
2551 wxGridRangeSelectEvent()
2554 Init(wxGridNoCellCoords
, wxGridNoCellCoords
, false);
2557 wxGridRangeSelectEvent(int id
,
2560 const wxGridCellCoords
& topLeft
,
2561 const wxGridCellCoords
& bottomRight
,
2563 const wxKeyboardState
& kbd
= wxKeyboardState())
2564 : wxNotifyEvent(type
, id
),
2565 wxKeyboardState(kbd
)
2567 Init(topLeft
, bottomRight
, sel
);
2569 SetEventObject(obj
);
2572 wxDEPRECATED( inline
2573 wxGridRangeSelectEvent(int id
,
2576 const wxGridCellCoords
& topLeft
,
2577 const wxGridCellCoords
& bottomRight
,
2582 bool meta
= false) );
2584 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
2585 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
2586 int GetTopRow() { return m_topLeft
.GetRow(); }
2587 int GetBottomRow() { return m_bottomRight
.GetRow(); }
2588 int GetLeftCol() { return m_topLeft
.GetCol(); }
2589 int GetRightCol() { return m_bottomRight
.GetCol(); }
2590 bool Selecting() { return m_selecting
; }
2592 virtual wxEvent
*Clone() const { return new wxGridRangeSelectEvent(*this); }
2595 void Init(const wxGridCellCoords
& topLeft
,
2596 const wxGridCellCoords
& bottomRight
,
2599 m_topLeft
= topLeft
;
2600 m_bottomRight
= bottomRight
;
2601 m_selecting
= selecting
;
2604 wxGridCellCoords m_topLeft
;
2605 wxGridCellCoords m_bottomRight
;
2608 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridRangeSelectEvent
)
2612 class WXDLLIMPEXP_ADV wxGridEditorCreatedEvent
: public wxCommandEvent
2615 wxGridEditorCreatedEvent()
2623 wxGridEditorCreatedEvent(int id
, wxEventType type
, wxObject
* obj
,
2624 int row
, int col
, wxControl
* ctrl
);
2626 int GetRow() { return m_row
; }
2627 int GetCol() { return m_col
; }
2628 wxControl
* GetControl() { return m_ctrl
; }
2629 void SetRow(int row
) { m_row
= row
; }
2630 void SetCol(int col
) { m_col
= col
; }
2631 void SetControl(wxControl
* ctrl
) { m_ctrl
= ctrl
; }
2633 virtual wxEvent
*Clone() const { return new wxGridEditorCreatedEvent(*this); }
2640 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEditorCreatedEvent
)
2644 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_LEFT_CLICK
;
2645 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK
;
2646 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK
;
2647 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK
;
2648 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK
;
2649 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK
;
2650 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK
;
2651 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK
;
2652 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_ROW_SIZE
;
2653 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_SIZE
;
2654 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_RANGE_SELECT
;
2655 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_CHANGE
;
2656 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_SELECT_CELL
;
2657 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_SHOWN
;
2658 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_HIDDEN
;
2659 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_EDITOR_CREATED
;
2660 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_CELL_BEGIN_DRAG
;
2661 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_MOVE
;
2662 extern WXDLLIMPEXP_ADV
const wxEventType wxEVT_GRID_COL_SORT
;
2665 typedef void (wxEvtHandler::*wxGridEventFunction
)(wxGridEvent
&);
2666 typedef void (wxEvtHandler::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
2667 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
2668 typedef void (wxEvtHandler::*wxGridEditorCreatedEventFunction
)(wxGridEditorCreatedEvent
&);
2670 #define wxGridEventHandler(func) \
2671 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEventFunction, &func)
2673 #define wxGridSizeEventHandler(func) \
2674 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridSizeEventFunction, &func)
2676 #define wxGridRangeSelectEventHandler(func) \
2677 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridRangeSelectEventFunction, &func)
2679 #define wxGridEditorCreatedEventHandler(func) \
2680 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEditorCreatedEventFunction, &func)
2682 #define wx__DECLARE_GRIDEVT(evt, id, fn) \
2683 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEventHandler(fn))
2685 #define wx__DECLARE_GRIDSIZEEVT(evt, id, fn) \
2686 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridSizeEventHandler(fn))
2688 #define wx__DECLARE_GRIDRANGESELEVT(evt, id, fn) \
2689 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridRangeSelectEventHandler(fn))
2691 #define wx__DECLARE_GRIDEDITOREVT(evt, id, fn) \
2692 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEditorCreatedEventHandler(fn))
2694 #define EVT_GRID_CMD_CELL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_CLICK, id, fn)
2695 #define EVT_GRID_CMD_CELL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_CLICK, id, fn)
2696 #define EVT_GRID_CMD_CELL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_DCLICK, id, fn)
2697 #define EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_DCLICK, id, fn)
2698 #define EVT_GRID_CMD_LABEL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_CLICK, id, fn)
2699 #define EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_CLICK, id, fn)
2700 #define EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_DCLICK, id, fn)
2701 #define EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_DCLICK, id, fn)
2702 #define EVT_GRID_CMD_ROW_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(ROW_SIZE, id, fn)
2703 #define EVT_GRID_CMD_COL_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(COL_SIZE, id, fn)
2704 #define EVT_GRID_CMD_COL_MOVE(id, fn) wx__DECLARE_GRIDEVT(COL_MOVE, id, fn)
2705 #define EVT_GRID_CMD_COL_SORT(id, fn) wx__DECLARE_GRIDEVT(COL_SORT, id, fn)
2706 #define EVT_GRID_CMD_RANGE_SELECT(id, fn) wx__DECLARE_GRIDRANGESELEVT(RANGE_SELECT, id, fn)
2707 #define EVT_GRID_CMD_CELL_CHANGE(id, fn) wx__DECLARE_GRIDEVT(CELL_CHANGE, id, fn)
2708 #define EVT_GRID_CMD_SELECT_CELL(id, fn) wx__DECLARE_GRIDEVT(SELECT_CELL, id, fn)
2709 #define EVT_GRID_CMD_EDITOR_SHOWN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_SHOWN, id, fn)
2710 #define EVT_GRID_CMD_EDITOR_HIDDEN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_HIDDEN, id, fn)
2711 #define EVT_GRID_CMD_EDITOR_CREATED(id, fn) wx__DECLARE_GRIDEDITOREVT(EDITOR_CREATED, id, fn)
2712 #define EVT_GRID_CMD_CELL_BEGIN_DRAG(id, fn) wx__DECLARE_GRIDEVT(CELL_BEGIN_DRAG, id, fn)
2714 // same as above but for any id (exists mainly for backwards compatibility but
2715 // then it's also true that you rarely have multiple grid in the same window)
2716 #define EVT_GRID_CELL_LEFT_CLICK(fn) EVT_GRID_CMD_CELL_LEFT_CLICK(wxID_ANY, fn)
2717 #define EVT_GRID_CELL_RIGHT_CLICK(fn) EVT_GRID_CMD_CELL_RIGHT_CLICK(wxID_ANY, fn)
2718 #define EVT_GRID_CELL_LEFT_DCLICK(fn) EVT_GRID_CMD_CELL_LEFT_DCLICK(wxID_ANY, fn)
2719 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) EVT_GRID_CMD_CELL_RIGHT_DCLICK(wxID_ANY, fn)
2720 #define EVT_GRID_LABEL_LEFT_CLICK(fn) EVT_GRID_CMD_LABEL_LEFT_CLICK(wxID_ANY, fn)
2721 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_CLICK(wxID_ANY, fn)
2722 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) EVT_GRID_CMD_LABEL_LEFT_DCLICK(wxID_ANY, fn)
2723 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_DCLICK(wxID_ANY, fn)
2724 #define EVT_GRID_ROW_SIZE(fn) EVT_GRID_CMD_ROW_SIZE(wxID_ANY, fn)
2725 #define EVT_GRID_COL_SIZE(fn) EVT_GRID_CMD_COL_SIZE(wxID_ANY, fn)
2726 #define EVT_GRID_COL_MOVE(fn) EVT_GRID_CMD_COL_MOVE(wxID_ANY, fn)
2727 #define EVT_GRID_COL_SORT(fn) EVT_GRID_CMD_COL_SORT(wxID_ANY, fn)
2728 #define EVT_GRID_RANGE_SELECT(fn) EVT_GRID_CMD_RANGE_SELECT(wxID_ANY, fn)
2729 #define EVT_GRID_CELL_CHANGE(fn) EVT_GRID_CMD_CELL_CHANGE(wxID_ANY, fn)
2730 #define EVT_GRID_SELECT_CELL(fn) EVT_GRID_CMD_SELECT_CELL(wxID_ANY, fn)
2731 #define EVT_GRID_EDITOR_SHOWN(fn) EVT_GRID_CMD_EDITOR_SHOWN(wxID_ANY, fn)
2732 #define EVT_GRID_EDITOR_HIDDEN(fn) EVT_GRID_CMD_EDITOR_HIDDEN(wxID_ANY, fn)
2733 #define EVT_GRID_EDITOR_CREATED(fn) EVT_GRID_CMD_EDITOR_CREATED(wxID_ANY, fn)
2734 #define EVT_GRID_CELL_BEGIN_DRAG(fn) EVT_GRID_CMD_CELL_BEGIN_DRAG(wxID_ANY, fn)
2736 #if 0 // TODO: implement these ? others ?
2738 extern const int wxEVT_GRID_CREATE_CELL
;
2739 extern const int wxEVT_GRID_CHANGE_LABELS
;
2740 extern const int wxEVT_GRID_CHANGE_SEL_LABEL
;
2742 #define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2743 #define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2744 #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 ),
2748 #endif // wxUSE_GRID
2749 #endif // _WX_GENERIC_GRID_H_