1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/generic/grid.h
3 // Purpose: wxGrid and related classes
4 // Author: Michael Bedward (based on code by Julian Smart, Robin Dunn)
8 // Copyright: (c) Michael Bedward
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
14 #if !defined(wxUSE_NEW_GRID) || !(wxUSE_NEW_GRID)
22 #pragma interface "grid.h"
27 #include "wx/scrolwin.h"
28 #include "wx/string.h"
29 #include "wx/scrolbar.h"
31 #include "wx/combobox.h"
32 #include "wx/dynarray.h"
35 // Default parameters for wxGrid
37 #define WXGRID_DEFAULT_NUMBER_ROWS 10
38 #define WXGRID_DEFAULT_NUMBER_COLS 10
40 #define WXGRID_DEFAULT_ROW_HEIGHT 25
42 #define WXGRID_DEFAULT_ROW_HEIGHT 30
44 #define WXGRID_DEFAULT_COL_WIDTH 80
45 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT 32
46 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH 82
47 #define WXGRID_LABEL_EDGE_ZONE 5
48 #define WXGRID_MIN_ROW_HEIGHT 15
49 #define WXGRID_MIN_COL_WIDTH 15
50 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH 16
52 // ----------------------------------------------------------------------------
53 // forward declarations
54 // ----------------------------------------------------------------------------
56 class WXDLLEXPORT wxGrid
;
57 class WXDLLEXPORT wxGridCellAttr
;
58 class WXDLLEXPORT wxGridCellAttrProviderData
;
59 class WXDLLEXPORT wxGridColLabelWindow
;
60 class WXDLLEXPORT wxGridCornerLabelWindow
;
61 class WXDLLEXPORT wxGridRowLabelWindow
;
62 class WXDLLEXPORT wxGridTableBase
;
63 class WXDLLEXPORT wxGridWindow
;
64 class WXDLLEXPORT wxGridTypeRegistry
;
66 class WXDLLEXPORT wxCheckBox
;
67 class WXDLLEXPORT wxTextCtrl
;
69 // ----------------------------------------------------------------------------
70 // wxGridCellRenderer: this class is responsible for actually drawing the cell
71 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
72 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
73 // view of all cells. This is an ABC, you will normally use one of the
74 // predefined derived classes or derive oyur own class from it.
75 // ----------------------------------------------------------------------------
77 class WXDLLEXPORT wxGridCellRenderer
80 // draw the given cell on the provided DC inside the given rectangle
81 // using the style specified by the attribute and the default or selected
82 // state corresponding to the isSelected value.
84 // this pure virtual function has a default implementation which will
85 // prepare the DC using the given attribute: it will draw the rectangle
86 // with the bg colour from attr and set the text colour and font
87 virtual void Draw(wxGrid
& grid
,
95 // the default renderer for the cells containing string data
96 class WXDLLEXPORT wxGridCellStringRenderer
: public wxGridCellRenderer
100 virtual void Draw(wxGrid
& grid
,
101 wxGridCellAttr
& attr
,
108 // renderer for boolean fields
109 class WXDLLEXPORT wxGridCellBoolRenderer
: public wxGridCellRenderer
113 // draw a check mark or nothing
114 virtual void Draw(wxGrid
& grid
,
115 wxGridCellAttr
& attr
,
122 // ----------------------------------------------------------------------------
123 // wxGridCellEditor: This class is responsible for providing and manipulating
124 // the in-place edit controls for the grid. Instances of wxGridCellEditor
125 // (actually, instances of derived classes since it is an ABC) can be
126 // associated with the cell attributes for individual cells, rows, columns, or
127 // even for the entire grid.
128 // ----------------------------------------------------------------------------
130 class WXDLLEXPORT wxGridCellEditor
134 virtual ~wxGridCellEditor();
136 bool IsCreated() { return m_control
!= NULL
; }
138 // Creates the actual edit control
139 virtual void Create(wxWindow
* parent
,
141 wxEvtHandler
* evtHandler
) = 0;
143 // Size and position the edit control
144 virtual void SetSize(const wxRect
& rect
);
146 // Show or hide the edit control, use the specified attributes to set
147 // colours/fonts for it
148 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
150 // Draws the part of the cell not occupied by the control: the base class
151 // version just fills it with background colour from the attribute
152 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
154 // Fetch the value from the table and prepare the edit control
155 // to begin editing. Set the focus to the edit control.
156 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
158 // Complete the editing of the current cell. If saveValue is
159 // true then send the new value back to the table. Returns true
160 // if the value has changed. If necessary, the control may be
162 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
) = 0;
164 // Reset the value in the control back to its starting value
165 virtual void Reset() = 0;
167 // If the editor is enabled by pressing keys on the grid,
168 // this will be called to let the editor do something about
169 // that first key if desired.
170 virtual void StartingKey(wxKeyEvent
& event
);
172 // if the editor is enabled by clicking on the cell, this method will be
174 virtual void StartingClick();
176 // Some types of controls on some platforms may need some help
177 // with the Return key.
178 virtual void HandleReturn(wxKeyEvent
& event
);
181 virtual void Destroy();
184 // the control we show on screen
185 wxControl
* m_control
;
187 // if we change the colours/font of the control from the default ones, we
188 // must restore the default later and we save them here between calls to
189 // Show(TRUE) and Show(FALSE)
195 // the editor for string/text data
196 class WXDLLEXPORT wxGridCellTextEditor
: public wxGridCellEditor
199 wxGridCellTextEditor();
201 virtual void Create(wxWindow
* parent
,
203 wxEvtHandler
* evtHandler
);
204 virtual void SetSize(const wxRect
& rect
);
206 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
*attr
);
208 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
209 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
211 virtual void Reset();
212 virtual void StartingKey(wxKeyEvent
& event
);
213 virtual void HandleReturn(wxKeyEvent
& event
);
216 wxTextCtrl
*Text() const { return (wxTextCtrl
*)m_control
; }
219 wxString m_startValue
;
222 // the editor for boolean data
223 class WXDLLEXPORT wxGridCellBoolEditor
: public wxGridCellEditor
226 virtual void Create(wxWindow
* parent
,
228 wxEvtHandler
* evtHandler
);
230 virtual void SetSize(const wxRect
& rect
);
231 virtual void Show(bool show
, wxGridCellAttr
*attr
= (wxGridCellAttr
*)NULL
);
233 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
);
234 virtual bool EndEdit(int row
, int col
, bool saveValue
, wxGrid
* grid
);
236 virtual void Reset();
237 virtual void StartingClick();
240 wxCheckBox
*CBox() const { return (wxCheckBox
*)m_control
; }
246 // ----------------------------------------------------------------------------
247 // wxGridCellAttr: this class can be used to alter the cells appearance in
248 // the grid by changing their colour/font/... from default. An object of this
249 // class may be returned by wxGridTable::GetAttr().
250 // ----------------------------------------------------------------------------
252 class WXDLLEXPORT wxGridCellAttr
262 // VZ: considering the number of members wxGridCellAttr has now, this ctor
263 // seems to be pretty useless... may be we should just remove it?
264 wxGridCellAttr(const wxColour
& colText
,
265 const wxColour
& colBack
,
269 : m_colText(colText
), m_colBack(colBack
), m_font(font
)
272 SetAlignment(hAlign
, vAlign
);
275 // default copy ctor ok
277 // this class is ref counted: it is created with ref count of 1, so
278 // calling DecRef() once will delete it. Calling IncRef() allows to lock
279 // it until the matching DecRef() is called
280 void IncRef() { m_nRef
++; }
281 void DecRef() { if ( !--m_nRef
) delete this; }
282 void SafeIncRef() { if ( this ) IncRef(); }
283 void SafeDecRef() { if ( this ) DecRef(); }
286 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
287 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
288 void SetFont(const wxFont
& font
) { m_font
= font
; }
289 void SetAlignment(int hAlign
, int vAlign
)
294 void SetReadOnly(bool isReadOnly
= TRUE
) { m_isReadOnly
= isReadOnly
; }
296 // takes ownership of the pointer
297 void SetRenderer(wxGridCellRenderer
*renderer
)
298 { delete m_renderer
; m_renderer
= renderer
; }
299 void SetEditor(wxGridCellEditor
* editor
)
300 { delete m_editor
; m_editor
= editor
; }
303 bool HasTextColour() const { return m_colText
.Ok(); }
304 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
305 bool HasFont() const { return m_font
.Ok(); }
306 bool HasAlignment() const { return m_hAlign
|| m_vAlign
; }
307 bool HasRenderer() const { return m_renderer
!= NULL
; }
308 bool HasEditor() const { return m_editor
!= NULL
; }
310 const wxColour
& GetTextColour() const;
311 const wxColour
& GetBackgroundColour() const;
312 const wxFont
& GetFont() const;
313 void GetAlignment(int *hAlign
, int *vAlign
) const;
314 wxGridCellRenderer
*GetRenderer(wxGridCellRenderer
* def
) const;
315 wxGridCellEditor
*GetEditor(wxGridCellEditor
* def
) const;
317 bool IsReadOnly() const { return m_isReadOnly
; }
319 void SetDefAttr(wxGridCellAttr
* defAttr
) { m_defGridAttr
= defAttr
; }
322 // the common part of all ctors
327 m_isReadOnly
= FALSE
;
333 // the dtor is private because only DecRef() can delete us
334 ~wxGridCellAttr() { delete m_renderer
; delete m_editor
; }
336 // the ref count - when it goes to 0, we die
345 wxGridCellRenderer
* m_renderer
;
346 wxGridCellEditor
* m_editor
;
347 wxGridCellAttr
* m_defGridAttr
;
351 // suppress the stupid gcc warning about the class having private dtor and
353 friend class wxGridCellAttrDummyFriend
;
356 // ----------------------------------------------------------------------------
357 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
359 // ----------------------------------------------------------------------------
361 // implementation note: we separate it from wxGridTableBase because we wish to
362 // avoid deriving a new table class if possible, and sometimes it will be
363 // enough to just derive another wxGridCellAttrProvider instead
365 // the default implementation is reasonably efficient for the generic case,
366 // but you might still wish to implement your own for some specific situations
367 // if you have performance problems with the stock one
368 class WXDLLEXPORT wxGridCellAttrProvider
371 wxGridCellAttrProvider();
372 virtual ~wxGridCellAttrProvider();
374 // DecRef() must be called on the returned pointer
375 virtual wxGridCellAttr
*GetAttr(int row
, int col
) const;
377 // all these functions take ownership of the pointer, don't call DecRef()
379 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
380 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
381 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
383 // these functions must be called whenever some rows/cols are deleted
384 // because the internal data must be updated then
385 void UpdateAttrRows( size_t pos
, int numRows
);
386 void UpdateAttrCols( size_t pos
, int numCols
);
391 wxGridCellAttrProviderData
*m_data
;
394 //////////////////////////////////////////////////////////////////////
396 // Grid table classes
398 //////////////////////////////////////////////////////////////////////
401 class WXDLLEXPORT wxGridTableBase
: public wxObject
405 virtual ~wxGridTableBase();
407 // You must override these functions in a derived table class
409 virtual long GetNumberRows() = 0;
410 virtual long GetNumberCols() = 0;
411 virtual bool IsEmptyCell( int row
, int col
) = 0;
412 virtual wxString
GetValue( int row
, int col
) = 0;
413 virtual void SetValue( int row
, int col
, const wxString
& value
) = 0;
415 // Data type determination and value access
416 virtual wxString
GetTypeName( int row
, int col
);
417 virtual bool CanGetValueAs( int row
, int col
, const wxString
& typeName
);
418 virtual bool CanSetValueAs( int row
, int col
, const wxString
& typeName
);
420 virtual long GetValueAsLong( int row
, int col
);
421 virtual double GetValueAsDouble( int row
, int col
);
422 virtual bool GetValueAsBool( int row
, int col
);
424 virtual void SetValueAsLong( int row
, int col
, long value
);
425 virtual void SetValueAsDouble( int row
, int col
, double value
);
426 virtual void SetValueAsBool( int row
, int col
, bool value
);
428 // For user defined types
429 virtual void* GetValueAsCustom( int row
, int col
, const wxString
& typeName
);
430 virtual void SetValueAsCustom( int row
, int col
, const wxString
& typeName
, void* value
);
433 // Overriding these is optional
435 virtual void SetView( wxGrid
*grid
) { m_view
= grid
; }
436 virtual wxGrid
* GetView() const { return m_view
; }
438 virtual void Clear() {}
439 virtual bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
440 virtual bool AppendRows( size_t numRows
= 1 );
441 virtual bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
442 virtual bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
443 virtual bool AppendCols( size_t numCols
= 1 );
444 virtual bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
446 virtual wxString
GetRowLabelValue( int row
);
447 virtual wxString
GetColLabelValue( int col
);
448 virtual void SetRowLabelValue( int WXUNUSED(row
), const wxString
& ) {}
449 virtual void SetColLabelValue( int WXUNUSED(col
), const wxString
& ) {}
451 // Attribute handling
454 // give us the attr provider to use - we take ownership of the pointer
455 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
457 // get the currently used attr provider (may be NULL)
458 wxGridCellAttrProvider
*GetAttrProvider() const { return m_attrProvider
; }
460 // Does this table allow attributes? Default implementation creates
461 // a wxGridCellAttrProvider if necessary.
462 virtual bool CanHaveAttributes();
465 // change row/col number in attribute if needed
466 virtual void UpdateAttrRows( size_t pos
, int numRows
);
467 virtual void UpdateAttrCols( size_t pos
, int numCols
);
469 // by default forwarded to wxGridCellAttrProvider if any. May be
470 // overridden to handle attributes directly in the table.
471 virtual wxGridCellAttr
*GetAttr( int row
, int col
);
473 // these functions take ownership of the pointer
474 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
475 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
476 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
480 wxGridCellAttrProvider
*m_attrProvider
;
482 DECLARE_ABSTRACT_CLASS( wxGridTableBase
);
486 // ----------------------------------------------------------------------------
487 // wxGridTableMessage
488 // ----------------------------------------------------------------------------
490 // IDs for messages sent from grid table to view
492 enum wxGridTableRequest
494 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
= 2000,
495 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES
,
496 wxGRIDTABLE_NOTIFY_ROWS_INSERTED
,
497 wxGRIDTABLE_NOTIFY_ROWS_APPENDED
,
498 wxGRIDTABLE_NOTIFY_ROWS_DELETED
,
499 wxGRIDTABLE_NOTIFY_COLS_INSERTED
,
500 wxGRIDTABLE_NOTIFY_COLS_APPENDED
,
501 wxGRIDTABLE_NOTIFY_COLS_DELETED
504 class WXDLLEXPORT wxGridTableMessage
507 wxGridTableMessage();
508 wxGridTableMessage( wxGridTableBase
*table
, int id
,
512 void SetTableObject( wxGridTableBase
*table
) { m_table
= table
; }
513 wxGridTableBase
* GetTableObject() const { return m_table
; }
514 void SetId( int id
) { m_id
= id
; }
515 int GetId() { return m_id
; }
516 void SetCommandInt( int comInt1
) { m_comInt1
= comInt1
; }
517 int GetCommandInt() { return m_comInt1
; }
518 void SetCommandInt2( int comInt2
) { m_comInt2
= comInt2
; }
519 int GetCommandInt2() { return m_comInt2
; }
522 wxGridTableBase
*m_table
;
530 // ------ wxGridStringArray
531 // A 2-dimensional array of strings for data values
534 WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString
, wxGridStringArray
);
538 // ------ wxGridStringTable
540 // Simplest type of data table for a grid for small tables of strings
541 // that are stored in memory
544 class WXDLLEXPORT wxGridStringTable
: public wxGridTableBase
548 wxGridStringTable( int numRows
, int numCols
);
549 ~wxGridStringTable();
551 // these are pure virtual in wxGridTableBase
553 long GetNumberRows();
554 long GetNumberCols();
555 wxString
GetValue( int row
, int col
);
556 void SetValue( int row
, int col
, const wxString
& s
);
557 bool IsEmptyCell( int row
, int col
);
559 // overridden functions from wxGridTableBase
562 bool InsertRows( size_t pos
= 0, size_t numRows
= 1 );
563 bool AppendRows( size_t numRows
= 1 );
564 bool DeleteRows( size_t pos
= 0, size_t numRows
= 1 );
565 bool InsertCols( size_t pos
= 0, size_t numCols
= 1 );
566 bool AppendCols( size_t numCols
= 1 );
567 bool DeleteCols( size_t pos
= 0, size_t numCols
= 1 );
569 void SetRowLabelValue( int row
, const wxString
& );
570 void SetColLabelValue( int col
, const wxString
& );
571 wxString
GetRowLabelValue( int row
);
572 wxString
GetColLabelValue( int col
);
575 wxGridStringArray m_data
;
577 // These only get used if you set your own labels, otherwise the
578 // GetRow/ColLabelValue functions return wxGridTableBase defaults
580 wxArrayString m_rowLabels
;
581 wxArrayString m_colLabels
;
583 DECLARE_DYNAMIC_CLASS( wxGridStringTable
)
588 // ============================================================================
590 // ============================================================================
592 // ----------------------------------------------------------------------------
593 // wxGridCellCoords: location of a cell in the grid
594 // ----------------------------------------------------------------------------
596 class WXDLLEXPORT wxGridCellCoords
599 wxGridCellCoords() { m_row
= m_col
= -1; }
600 wxGridCellCoords( int r
, int c
) { m_row
= r
; m_col
= c
; }
602 // default copy ctor is ok
604 long GetRow() const { return m_row
; }
605 void SetRow( long n
) { m_row
= n
; }
606 long GetCol() const { return m_col
; }
607 void SetCol( long n
) { m_col
= n
; }
608 void Set( long row
, long col
) { m_row
= row
; m_col
= col
; }
610 wxGridCellCoords
& operator=( const wxGridCellCoords
& other
)
612 if ( &other
!= this )
620 bool operator==( const wxGridCellCoords
& other
) const
622 return (m_row
== other
.m_row
&& m_col
== other
.m_col
);
625 bool operator!=( const wxGridCellCoords
& other
) const
627 return (m_row
!= other
.m_row
|| m_col
!= other
.m_col
);
630 bool operator!() const
632 return (m_row
== -1 && m_col
== -1 );
641 // For comparisons...
643 extern wxGridCellCoords wxGridNoCellCoords
;
644 extern wxRect wxGridNoCellRect
;
646 // An array of cell coords...
648 WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords
, wxGridCellCoordsArray
);
650 // ----------------------------------------------------------------------------
652 // ----------------------------------------------------------------------------
654 class WXDLLEXPORT wxGrid
: public wxScrolledWindow
662 wxGrid( wxWindow
*parent
,
664 const wxPoint
& pos
= wxDefaultPosition
,
665 const wxSize
& size
= wxDefaultSize
,
667 const wxString
& name
= wxPanelNameStr
);
671 bool CreateGrid( int numRows
, int numCols
);
674 // ------ grid dimensions
676 int GetNumberRows() { return m_numRows
; }
677 int GetNumberCols() { return m_numCols
; }
680 // ------ display update functions
682 void CalcRowLabelsExposed( wxRegion
& reg
);
684 void CalcColLabelsExposed( wxRegion
& reg
);
685 void CalcCellsExposed( wxRegion
& reg
);
688 // ------ event handlers
690 void ProcessRowLabelMouseEvent( wxMouseEvent
& event
);
691 void ProcessColLabelMouseEvent( wxMouseEvent
& event
);
692 void ProcessCornerLabelMouseEvent( wxMouseEvent
& event
);
693 void ProcessGridCellMouseEvent( wxMouseEvent
& event
);
694 bool ProcessTableMessage( wxGridTableMessage
& );
696 void DoEndDragResizeRow();
697 void DoEndDragResizeCol();
699 wxGridTableBase
* GetTable() const { return m_table
; }
700 bool SetTable( wxGridTableBase
*table
, bool takeOwnership
=FALSE
);
703 bool InsertRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
704 bool AppendRows( int numRows
= 1, bool updateLabels
=TRUE
);
705 bool DeleteRows( int pos
= 0, int numRows
= 1, bool updateLabels
=TRUE
);
706 bool InsertCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
707 bool AppendCols( int numCols
= 1, bool updateLabels
=TRUE
);
708 bool DeleteCols( int pos
= 0, int numCols
= 1, bool updateLabels
=TRUE
);
710 void DrawGridCellArea( wxDC
& dc
);
711 void DrawCellBorder( wxDC
& dc
, const wxGridCellCoords
& );
712 void DrawAllGridLines( wxDC
& dc
, const wxRegion
& reg
);
713 void DrawCell( wxDC
& dc
, const wxGridCellCoords
& );
714 void DrawHighlight(wxDC
& dc
);
716 // this function is called when the current cell highlight must be redrawn
717 // and may be overridden by the user
718 virtual void DrawCellHighlight( wxDC
& dc
, const wxGridCellAttr
*attr
);
720 void DrawRowLabels( wxDC
& dc
);
721 void DrawRowLabel( wxDC
& dc
, int row
);
723 void DrawColLabels( wxDC
& dc
);
724 void DrawColLabel( wxDC
& dc
, int col
);
727 // ------ Cell text drawing functions
729 void DrawTextRectangle( wxDC
& dc
, const wxString
&, const wxRect
&,
730 int horizontalAlignment
= wxLEFT
,
731 int verticalAlignment
= wxTOP
);
733 // Split a string containing newline chararcters into an array of
734 // strings and return the number of lines
736 void StringToLines( const wxString
& value
, wxArrayString
& lines
);
738 void GetTextBoxSize( wxDC
& dc
,
739 wxArrayString
& lines
,
740 long *width
, long *height
);
744 // Code that does a lot of grid modification can be enclosed
745 // between BeginBatch() and EndBatch() calls to avoid screen
748 void BeginBatch() { m_batchCount
++; }
749 void EndBatch() { if ( m_batchCount
> 0 ) m_batchCount
--; }
750 int GetBatchCount() { return m_batchCount
; }
753 // ------ edit control functions
755 bool IsEditable() { return m_editable
; }
756 void EnableEditing( bool edit
);
758 void EnableCellEditControl( bool enable
= TRUE
);
759 void DisableCellEditControl() { EnableCellEditControl(FALSE
); }
760 bool CanEnableCellControl() const;
761 bool IsCellEditControlEnabled() const;
763 bool IsCurrentCellReadOnly() const;
765 void ShowCellEditControl();
766 void HideCellEditControl();
767 void SetEditControlValue( const wxString
& s
= wxEmptyString
);
768 void SaveEditControlValue();
771 // ------ grid location functions
772 // Note that all of these functions work with the logical coordinates of
773 // grid cells and labels so you will need to convert from device
774 // coordinates for mouse events etc.
776 void XYToCell( int x
, int y
, wxGridCellCoords
& );
780 int YToEdgeOfRow( int y
);
781 int XToEdgeOfCol( int x
);
783 wxRect
CellToRect( int row
, int col
);
784 wxRect
CellToRect( const wxGridCellCoords
& coords
)
785 { return CellToRect( coords
.GetRow(), coords
.GetCol() ); }
787 int GetGridCursorRow() { return m_currentCellCoords
.GetRow(); }
788 int GetGridCursorCol() { return m_currentCellCoords
.GetCol(); }
790 // check to see if a cell is either wholly visible (the default arg) or
791 // at least partially visible in the grid window
793 bool IsVisible( int row
, int col
, bool wholeCellVisible
= TRUE
);
794 bool IsVisible( const wxGridCellCoords
& coords
, bool wholeCellVisible
= TRUE
)
795 { return IsVisible( coords
.GetRow(), coords
.GetCol(), wholeCellVisible
); }
796 void MakeCellVisible( int row
, int col
);
797 void MakeCellVisible( const wxGridCellCoords
& coords
)
798 { MakeCellVisible( coords
.GetRow(), coords
.GetCol() ); }
801 // ------ grid cursor movement functions
803 void SetGridCursor( int row
, int col
)
804 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
807 bool MoveCursorDown();
808 bool MoveCursorLeft();
809 bool MoveCursorRight();
812 bool MoveCursorUpBlock();
813 bool MoveCursorDownBlock();
814 bool MoveCursorLeftBlock();
815 bool MoveCursorRightBlock();
818 // ------ label and gridline formatting
820 int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH
; }
821 int GetRowLabelSize() { return m_rowLabelWidth
; }
822 int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT
; }
823 int GetColLabelSize() { return m_colLabelHeight
; }
824 wxColour
GetLabelBackgroundColour() { return m_labelBackgroundColour
; }
825 wxColour
GetLabelTextColour() { return m_labelTextColour
; }
826 wxFont
GetLabelFont() { return m_labelFont
; }
827 void GetRowLabelAlignment( int *horiz
, int *vert
);
828 void GetColLabelAlignment( int *horiz
, int *vert
);
829 wxString
GetRowLabelValue( int row
);
830 wxString
GetColLabelValue( int col
);
831 wxColour
GetGridLineColour() { return m_gridLineColour
; }
833 void SetRowLabelSize( int width
);
834 void SetColLabelSize( int height
);
835 void SetLabelBackgroundColour( const wxColour
& );
836 void SetLabelTextColour( const wxColour
& );
837 void SetLabelFont( const wxFont
& );
838 void SetRowLabelAlignment( int horiz
, int vert
);
839 void SetColLabelAlignment( int horiz
, int vert
);
840 void SetRowLabelValue( int row
, const wxString
& );
841 void SetColLabelValue( int col
, const wxString
& );
842 void SetGridLineColour( const wxColour
& );
844 void EnableDragRowSize( bool enable
= TRUE
);
845 void DisableDragRowSize() { EnableDragRowSize( FALSE
); }
846 bool CanDragRowSize() { return m_canDragRowSize
; }
847 void EnableDragColSize( bool enable
= TRUE
);
848 void DisableDragColSize() { EnableDragColSize( FALSE
); }
849 bool CanDragColSize() { return m_canDragColSize
; }
851 // this sets the specified attribute for all cells in this row/col
852 void SetRowAttr(int row
, wxGridCellAttr
*attr
);
853 void SetColAttr(int col
, wxGridCellAttr
*attr
);
855 void EnableGridLines( bool enable
= TRUE
);
856 bool GridLinesEnabled() { return m_gridLinesEnabled
; }
858 // ------ row and col formatting
860 int GetDefaultRowSize();
861 int GetRowSize( int row
);
862 int GetDefaultColSize();
863 int GetColSize( int col
);
864 wxColour
GetDefaultCellBackgroundColour();
865 wxColour
GetCellBackgroundColour( int row
, int col
);
866 wxColour
GetDefaultCellTextColour();
867 wxColour
GetCellTextColour( int row
, int col
);
868 wxFont
GetDefaultCellFont();
869 wxFont
GetCellFont( int row
, int col
);
870 void GetDefaultCellAlignment( int *horiz
, int *vert
);
871 void GetCellAlignment( int row
, int col
, int *horiz
, int *vert
);
873 void SetDefaultRowSize( int height
, bool resizeExistingRows
= FALSE
);
874 void SetRowSize( int row
, int height
);
875 void SetDefaultColSize( int width
, bool resizeExistingCols
= FALSE
);
877 void SetColSize( int col
, int width
);
879 // column won't be resized to be lesser width - this must be called during
880 // the grid creation because it won't resize the column if it's already
881 // narrower than the minimal width
882 void SetColMinimalWidth( int col
, int width
);
884 void SetDefaultCellBackgroundColour( const wxColour
& );
885 void SetCellBackgroundColour( int row
, int col
, const wxColour
& );
886 void SetDefaultCellTextColour( const wxColour
& );
888 void SetCellTextColour( int row
, int col
, const wxColour
& );
889 void SetDefaultCellFont( const wxFont
& );
890 void SetCellFont( int row
, int col
, const wxFont
& );
891 void SetDefaultCellAlignment( int horiz
, int vert
);
892 void SetCellAlignment( int row
, int col
, int horiz
, int vert
);
894 // takes ownership of the pointer
895 void SetDefaultRenderer(wxGridCellRenderer
*renderer
);
896 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
*renderer
);
897 wxGridCellRenderer
*GetDefaultRenderer() const;
898 wxGridCellRenderer
* GetCellRenderer(int row
, int col
);
900 // takes ownership of the pointer
901 void SetDefaultEditor(wxGridCellEditor
*editor
);
902 void SetCellEditor(int row
, int col
, wxGridCellEditor
*editor
);
903 wxGridCellEditor
*GetDefaultEditor() const;
904 wxGridCellEditor
* GetCellEditor(int row
, int col
);
908 // ------ cell value accessors
910 wxString
GetCellValue( int row
, int col
)
914 return m_table
->GetValue( row
, col
);
918 return wxEmptyString
;
922 wxString
GetCellValue( const wxGridCellCoords
& coords
)
923 { return GetCellValue( coords
.GetRow(), coords
.GetCol() ); }
925 void SetCellValue( int row
, int col
, const wxString
& s
);
926 void SetCellValue( const wxGridCellCoords
& coords
, const wxString
& s
)
927 { SetCellValue( coords
.GetRow(), coords
.GetCol(), s
); }
929 // returns TRUE if the cell can't be edited
930 bool IsReadOnly(int row
, int col
) const;
932 // make the cell editable/readonly
933 void SetReadOnly(int row
, int col
, bool isReadOnly
= TRUE
);
935 // ------ selections of blocks of cells
937 void SelectRow( int row
, bool addToSelected
= FALSE
);
938 void SelectCol( int col
, bool addToSelected
= FALSE
);
940 void SelectBlock( int topRow
, int leftCol
, int bottomRow
, int rightCol
);
942 void SelectBlock( const wxGridCellCoords
& topLeft
,
943 const wxGridCellCoords
& bottomRight
)
944 { SelectBlock( topLeft
.GetRow(), topLeft
.GetCol(),
945 bottomRight
.GetRow(), bottomRight
.GetCol() ); }
950 { return ( m_selectedTopLeft
!= wxGridNoCellCoords
&&
951 m_selectedBottomRight
!= wxGridNoCellCoords
);
954 void ClearSelection();
956 bool IsInSelection( int row
, int col
)
957 { return ( IsSelection() &&
958 row
>= m_selectedTopLeft
.GetRow() &&
959 col
>= m_selectedTopLeft
.GetCol() &&
960 row
<= m_selectedBottomRight
.GetRow() &&
961 col
<= m_selectedBottomRight
.GetCol() );
964 bool IsInSelection( const wxGridCellCoords
& coords
)
965 { return IsInSelection( coords
.GetRow(), coords
.GetCol() ); }
967 void GetSelection( int* topRow
, int* leftCol
, int* bottomRow
, int* rightCol
)
969 // these will all be -1 if there is no selected block
971 *topRow
= m_selectedTopLeft
.GetRow();
972 *leftCol
= m_selectedTopLeft
.GetCol();
973 *bottomRow
= m_selectedBottomRight
.GetRow();
974 *rightCol
= m_selectedBottomRight
.GetCol();
978 // This function returns the rectangle that encloses the block of cells
979 // limited by TopLeft and BottomRight cell in device coords and clipped
980 // to the client size of the grid window.
982 wxRect
BlockToDeviceRect( const wxGridCellCoords
& topLeft
,
983 const wxGridCellCoords
& bottomRight
);
985 // This function returns the rectangle that encloses the selected cells
986 // in device coords and clipped to the client size of the grid window.
988 wxRect
SelectionToDeviceRect()
990 return BlockToDeviceRect( m_selectedTopLeft
,
991 m_selectedBottomRight
);
994 // Access or update the selection fore/back colours
995 wxColour
GetSelectionBackground() const
996 { return m_selectionBackground
; }
997 wxColour
GetSelectionForeground() const
998 { return m_selectionForeground
; }
1000 void SetSelectionBackground(const wxColour
& c
) { m_selectionBackground
= c
; }
1001 void SetSelectionForeground(const wxColour
& c
) { m_selectionForeground
= c
; }
1004 // Methods for a registry for mapping data types to Renderers/Editors
1005 void RegisterDataType(const wxString
& typeName
,
1006 wxGridCellRenderer
* renderer
,
1007 wxGridCellEditor
* editor
);
1008 wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1009 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const
1010 { return GetDefaultEditorForCell(c
.GetRow(), c
.GetCol()); }
1011 wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
1012 wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
1013 wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
1017 // ------ For compatibility with previous wxGrid only...
1019 // ************************************************
1020 // ** Don't use these in new code because they **
1021 // ** are liable to disappear in a future **
1023 // ************************************************
1026 wxGrid( wxWindow
*parent
,
1027 int x
, int y
, int w
= -1, int h
= -1,
1029 const wxString
& name
= wxPanelNameStr
)
1030 : wxScrolledWindow( parent
, -1, wxPoint(x
,y
), wxSize(w
,h
), style
, name
)
1035 void SetCellValue( const wxString
& val
, int row
, int col
)
1036 { SetCellValue( row
, col
, val
); }
1038 void UpdateDimensions()
1039 { CalcDimensions(); }
1041 int GetRows() { return GetNumberRows(); }
1042 int GetCols() { return GetNumberCols(); }
1043 int GetCursorRow() { return GetGridCursorRow(); }
1044 int GetCursorColumn() { return GetGridCursorCol(); }
1046 int GetScrollPosX() { return 0; }
1047 int GetScrollPosY() { return 0; }
1049 void SetScrollX( int x
) { }
1050 void SetScrollY( int y
) { }
1052 void SetColumnWidth( int col
, int width
)
1053 { SetColSize( col
, width
); }
1055 int GetColumnWidth( int col
)
1056 { return GetColSize( col
); }
1058 void SetRowHeight( int row
, int height
)
1059 { SetRowSize( row
, height
); }
1061 // GetRowHeight() is below
1063 int GetViewHeight() // returned num whole rows visible
1066 int GetViewWidth() // returned num whole cols visible
1069 void SetLabelSize( int orientation
, int sz
)
1071 if ( orientation
== wxHORIZONTAL
)
1072 SetColLabelSize( sz
);
1074 SetRowLabelSize( sz
);
1077 int GetLabelSize( int orientation
)
1079 if ( orientation
== wxHORIZONTAL
)
1080 return GetColLabelSize();
1082 return GetRowLabelSize();
1085 void SetLabelAlignment( int orientation
, int align
)
1087 if ( orientation
== wxHORIZONTAL
)
1088 SetColLabelAlignment( align
, -1 );
1090 SetRowLabelAlignment( align
, -1 );
1093 int GetLabelAlignment( int orientation
, int WXUNUSED(align
) )
1096 if ( orientation
== wxHORIZONTAL
)
1098 GetColLabelAlignment( &h
, &v
);
1103 GetRowLabelAlignment( &h
, &v
);
1108 void SetLabelValue( int orientation
, const wxString
& val
, int pos
)
1110 if ( orientation
== wxHORIZONTAL
)
1111 SetColLabelValue( pos
, val
);
1113 SetRowLabelValue( pos
, val
);
1116 wxString
GetLabelValue( int orientation
, int pos
)
1118 if ( orientation
== wxHORIZONTAL
)
1119 return GetColLabelValue( pos
);
1121 return GetRowLabelValue( pos
);
1124 wxFont
GetCellTextFont() const
1125 { return m_defaultCellAttr
->GetFont(); }
1127 wxFont
GetCellTextFont(int WXUNUSED(row
), int WXUNUSED(col
)) const
1128 { return m_defaultCellAttr
->GetFont(); }
1130 void SetCellTextFont(const wxFont
& fnt
)
1131 { SetDefaultCellFont( fnt
); }
1133 void SetCellTextFont(const wxFont
& fnt
, int row
, int col
)
1134 { SetCellFont( row
, col
, fnt
); }
1136 void SetCellTextColour(const wxColour
& val
, int row
, int col
)
1137 { SetCellTextColour( row
, col
, val
); }
1139 void SetCellTextColour(const wxColour
& col
)
1140 { SetDefaultCellTextColour( col
); }
1142 void SetCellBackgroundColour(const wxColour
& col
)
1143 { SetDefaultCellBackgroundColour( col
); }
1145 void SetCellBackgroundColour(const wxColour
& colour
, int row
, int col
)
1146 { SetCellBackgroundColour( row
, col
, colour
); }
1148 bool GetEditable() { return IsEditable(); }
1149 void SetEditable( bool edit
= TRUE
) { EnableEditing( edit
); }
1150 bool GetEditInPlace() { return IsCellEditControlEnabled(); }
1152 void SetEditInPlace(bool edit
= TRUE
) { }
1154 void SetCellAlignment( int align
, int row
, int col
)
1155 { SetCellAlignment(row
, col
, align
, wxCENTER
); }
1156 void SetCellAlignment( int WXUNUSED(align
) ) {}
1157 void SetCellBitmap(wxBitmap
*WXUNUSED(bitmap
), int WXUNUSED(row
), int WXUNUSED(col
))
1159 void SetDividerPen(const wxPen
& WXUNUSED(pen
)) { }
1160 wxPen
& GetDividerPen() const { return wxNullPen
; }
1161 void OnActivate(bool WXUNUSED(active
)) {}
1163 // ******** End of compatibility functions **********
1167 // ------ control IDs
1168 enum { wxGRID_CELLCTRL
= 2000,
1171 // ------ control types
1172 enum { wxGRID_TEXTCTRL
= 2100,
1181 wxGridWindow
*m_gridWin
;
1182 wxGridRowLabelWindow
*m_rowLabelWin
;
1183 wxGridColLabelWindow
*m_colLabelWin
;
1184 wxGridCornerLabelWindow
*m_cornerLabelWin
;
1186 wxGridTableBase
*m_table
;
1197 wxGridCellCoords m_currentCellCoords
;
1199 wxGridCellCoords m_selectedTopLeft
;
1200 wxGridCellCoords m_selectedBottomRight
;
1201 wxColour m_selectionBackground
;
1202 wxColour m_selectionForeground
;
1204 // NB: *never* access m_row/col arrays directly because they are created
1205 // on demand, *always* use accessor functions instead!
1207 // init the m_rowHeights/Bottoms arrays with default values
1208 void InitRowHeights();
1210 int m_defaultRowHeight
;
1211 wxArrayInt m_rowHeights
;
1212 wxArrayInt m_rowBottoms
;
1214 // init the m_colWidths/Rights arrays
1215 void InitColWidths();
1217 int m_defaultColWidth
;
1218 wxArrayInt m_colWidths
;
1219 wxArrayInt m_colRights
;
1221 // get the col/row coords
1222 int GetColWidth(int col
) const;
1223 int GetColLeft(int col
) const;
1224 int GetColRight(int col
) const;
1226 // this function must be public for compatibility...
1228 int GetRowHeight(int row
) const;
1231 int GetRowTop(int row
) const;
1232 int GetRowBottom(int row
) const;
1234 int m_rowLabelWidth
;
1235 int m_colLabelHeight
;
1237 wxColour m_labelBackgroundColour
;
1238 wxColour m_labelTextColour
;
1241 int m_rowLabelHorizAlign
;
1242 int m_rowLabelVertAlign
;
1243 int m_colLabelHorizAlign
;
1244 int m_colLabelVertAlign
;
1246 bool m_defaultRowLabelValues
;
1247 bool m_defaultColLabelValues
;
1249 wxColour m_gridLineColour
;
1250 bool m_gridLinesEnabled
;
1252 // if a column has a minimal width, it will be the value for it in this
1254 wxHashTable m_colMinWidths
;
1256 // get the minimal width of the given column
1257 int GetColMinimalWidth(int col
) const;
1259 // do we have some place to store attributes in?
1260 bool CanHaveAttributes();
1262 // returns the attribute we may modify in place: a new one if this cell
1263 // doesn't have any yet or the existing one if it does
1265 // DecRef() must be called on the returned pointer, as usual
1266 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1268 // cell attribute cache (currently we only cache 1, may be will do
1269 // more/better later)
1273 wxGridCellAttr
*attr
;
1276 // invalidates the attribute cache
1277 void ClearAttrCache();
1279 // adds an attribute to cache
1280 void CacheAttr(int row
, int col
, wxGridCellAttr
*attr
) const;
1282 // looks for an attr in cache, returns TRUE if found
1283 bool LookupAttr(int row
, int col
, wxGridCellAttr
**attr
) const;
1285 // looks for the attr in cache, if not found asks the table and caches the
1287 wxGridCellAttr
*GetCellAttr(int row
, int col
) const;
1288 wxGridCellAttr
*GetCellAttr(const wxGridCellCoords
& coords
)
1289 { return GetCellAttr( coords
.GetRow(), coords
.GetCol() ); }
1291 // the default cell attr object for cells that don't have their own
1292 wxGridCellAttr
* m_defaultCellAttr
;
1295 wxGridCellCoordsArray m_cellsExposed
;
1296 wxArrayInt m_rowsExposed
;
1297 wxArrayInt m_colsExposed
;
1298 wxArrayInt m_rowLabelsExposed
;
1299 wxArrayInt m_colLabelsExposed
;
1305 wxGridTypeRegistry
* m_typeRegistry
;
1309 WXGRID_CURSOR_SELECT_CELL
,
1310 WXGRID_CURSOR_RESIZE_ROW
,
1311 WXGRID_CURSOR_RESIZE_COL
,
1312 WXGRID_CURSOR_SELECT_ROW
,
1313 WXGRID_CURSOR_SELECT_COL
1316 // this method not only sets m_cursorMode but also sets the correct cursor
1317 // for the given mode and, if captureMouse is not FALSE releases the mouse
1318 // if it was captured and captures it if it must be captured
1320 // for this to work, you should always use it and not set m_cursorMode
1322 void ChangeCursorMode(CursorMode mode
,
1323 wxWindow
*win
= (wxWindow
*)NULL
,
1324 bool captureMouse
= TRUE
);
1326 wxWindow
*m_winCapture
; // the window which captured the mouse
1327 CursorMode m_cursorMode
;
1329 bool m_canDragRowSize
;
1330 bool m_canDragColSize
;
1334 wxPoint m_startDragPos
;
1336 bool m_waitForSlowClick
;
1338 wxGridCellCoords m_selectionStart
;
1340 wxCursor m_rowResizeCursor
;
1341 wxCursor m_colResizeCursor
;
1343 bool m_editable
; // applies to whole grid
1344 bool m_cellEditCtrlEnabled
; // is in-place edit currently shown?
1349 void CalcDimensions();
1350 void CalcWindowSizes();
1351 bool Redimension( wxGridTableMessage
& );
1354 bool SendEvent( const wxEventType
, int row
, int col
, wxMouseEvent
& );
1355 bool SendEvent( const wxEventType
, int row
, int col
);
1356 bool SendEvent( const wxEventType type
)
1358 return SendEvent(type
,
1359 m_currentCellCoords
.GetRow(),
1360 m_currentCellCoords
.GetCol());
1363 void OnPaint( wxPaintEvent
& );
1364 void OnSize( wxSizeEvent
& );
1365 void OnKeyDown( wxKeyEvent
& );
1366 void OnEraseBackground( wxEraseEvent
& );
1369 void SetCurrentCell( const wxGridCellCoords
& coords
);
1370 void SetCurrentCell( int row
, int col
)
1371 { SetCurrentCell( wxGridCellCoords(row
, col
) ); }
1374 // ------ functions to get/send data (see also public functions)
1376 bool GetModelValues();
1377 bool SetModelValues();
1380 DECLARE_DYNAMIC_CLASS( wxGrid
)
1381 DECLARE_EVENT_TABLE()
1386 // ----------------------------------------------------------------------------
1387 // Grid event class and event types
1388 // ----------------------------------------------------------------------------
1390 class WXDLLEXPORT wxGridEvent
: public wxNotifyEvent
1394 : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
1395 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1399 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
1400 int row
=-1, int col
=-1, int x
=-1, int y
=-1,
1401 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1403 virtual int GetRow() { return m_row
; }
1404 virtual int GetCol() { return m_col
; }
1405 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1406 bool ControlDown() { return m_control
; }
1407 bool MetaDown() { return m_meta
; }
1408 bool ShiftDown() { return m_shift
; }
1409 bool AltDown() { return m_alt
; }
1421 DECLARE_DYNAMIC_CLASS(wxGridEvent
)
1424 class WXDLLEXPORT wxGridSizeEvent
: public wxNotifyEvent
1428 : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
1429 m_control(0), m_meta(0), m_shift(0), m_alt(0)
1433 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
1434 int rowOrCol
=-1, int x
=-1, int y
=-1,
1435 bool control
=FALSE
, bool shift
=FALSE
, bool alt
=FALSE
, bool meta
=FALSE
);
1437 int GetRowOrCol() { return m_rowOrCol
; }
1438 wxPoint
GetPosition() { return wxPoint( m_x
, m_y
); }
1439 bool ControlDown() { return m_control
; }
1440 bool MetaDown() { return m_meta
; }
1441 bool ShiftDown() { return m_shift
; }
1442 bool AltDown() { return m_alt
; }
1453 DECLARE_DYNAMIC_CLASS(wxGridSizeEvent
)
1457 class WXDLLEXPORT wxGridRangeSelectEvent
: public wxNotifyEvent
1460 wxGridRangeSelectEvent()
1463 m_topLeft
= wxGridNoCellCoords
;
1464 m_bottomRight
= wxGridNoCellCoords
;
1471 wxGridRangeSelectEvent(int id
, wxEventType type
, wxObject
* obj
,
1472 const wxGridCellCoords
& topLeft
,
1473 const wxGridCellCoords
& bottomRight
,
1474 bool control
=FALSE
, bool shift
=FALSE
,
1475 bool alt
=FALSE
, bool meta
=FALSE
);
1477 wxGridCellCoords
GetTopLeftCoords() { return m_topLeft
; }
1478 wxGridCellCoords
GetBottomRightCoords() { return m_bottomRight
; }
1479 int GetTopRow() { return m_topLeft
.GetRow(); }
1480 int GetBottomRow() { return m_bottomRight
.GetRow(); }
1481 int GetLeftCol() { return m_topLeft
.GetCol(); }
1482 int GetRightCol() { return m_bottomRight
.GetCol(); }
1483 bool ControlDown() { return m_control
; }
1484 bool MetaDown() { return m_meta
; }
1485 bool ShiftDown() { return m_shift
; }
1486 bool AltDown() { return m_alt
; }
1489 wxGridCellCoords m_topLeft
;
1490 wxGridCellCoords m_bottomRight
;
1496 DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent
)
1499 // TODO move to wx/event.h
1500 const wxEventType wxEVT_GRID_CELL_LEFT_CLICK
= wxEVT_FIRST
+ 1580;
1501 const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK
= wxEVT_FIRST
+ 1581;
1502 const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK
= wxEVT_FIRST
+ 1582;
1503 const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1583;
1504 const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK
= wxEVT_FIRST
+ 1584;
1505 const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK
= wxEVT_FIRST
+ 1585;
1506 const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK
= wxEVT_FIRST
+ 1586;
1507 const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK
= wxEVT_FIRST
+ 1587;
1508 const wxEventType wxEVT_GRID_ROW_SIZE
= wxEVT_FIRST
+ 1588;
1509 const wxEventType wxEVT_GRID_COL_SIZE
= wxEVT_FIRST
+ 1589;
1510 const wxEventType wxEVT_GRID_RANGE_SELECT
= wxEVT_FIRST
+ 1590;
1511 const wxEventType wxEVT_GRID_CELL_CHANGE
= wxEVT_FIRST
+ 1591;
1512 const wxEventType wxEVT_GRID_SELECT_CELL
= wxEVT_FIRST
+ 1592;
1513 const wxEventType wxEVT_GRID_EDITOR_SHOWN
= wxEVT_FIRST
+ 1593;
1514 const wxEventType wxEVT_GRID_EDITOR_HIDDEN
= wxEVT_FIRST
+ 1594;
1517 typedef void (wxEvtHandler
::*wxGridEventFunction
)(wxGridEvent
&);
1518 typedef void (wxEvtHandler
::*wxGridSizeEventFunction
)(wxGridSizeEvent
&);
1519 typedef void (wxEvtHandler
::*wxGridRangeSelectEventFunction
)(wxGridRangeSelectEvent
&);
1521 #define EVT_GRID_CELL_LEFT_CLICK(fn) { wxEVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1522 #define EVT_GRID_CELL_RIGHT_CLICK(fn) { wxEVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1523 #define EVT_GRID_CELL_LEFT_DCLICK(fn) { wxEVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1524 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) { wxEVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1525 #define EVT_GRID_LABEL_LEFT_CLICK(fn) { wxEVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1526 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) { wxEVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1527 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) { wxEVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1528 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) { wxEVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1529 #define EVT_GRID_ROW_SIZE(fn) { wxEVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1530 #define EVT_GRID_COL_SIZE(fn) { wxEVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
1531 #define EVT_GRID_RANGE_SELECT(fn) { wxEVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
1532 #define EVT_GRID_CELL_CHANGE(fn) { wxEVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1533 #define EVT_GRID_SELECT_CELL(fn) { wxEVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1534 #define EVT_GRID_EDITOR_SHOWN(fn) { wxEVT_GRID_EDITOR_SHOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1535 #define EVT_GRID_EDITOR_HIDDEN(fn) { wxEVT_GRID_EDITOR_HIDDEN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1538 #if 0 // TODO: implement these ? others ?
1540 const wxEventType wxEVT_GRID_CREATE_CELL
= wxEVT_FIRST
+ 1576;
1541 const wxEventType wxEVT_GRID_CHANGE_LABELS
= wxEVT_FIRST
+ 1577;
1542 const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL
= wxEVT_FIRST
+ 1578;
1544 #define EVT_GRID_CREATE_CELL(fn) { wxEVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1545 #define EVT_GRID_CHANGE_LABELS(fn) { wxEVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1546 #define EVT_GRID_CHANGE_SEL_LABEL(fn) { wxEVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
1550 #endif // #ifndef __WXGRID_H__
1552 #endif // ifndef wxUSE_NEW_GRID