1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxGrid and related classes
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxGridCellRenderer
12 This class is responsible for actually drawing the cell in the grid. You
13 may pass it to the wxGridCellAttr (below) to change the format of one given
14 cell or to wxGrid::SetDefaultRenderer() to change the view of all cells.
15 This is an abstract class, and you will normally use one of the predefined
16 derived classes or derive your own class from it.
21 @see wxGridCellBoolRenderer, wxGridCellFloatRenderer,
22 wxGridCellNumberRenderer, wxGridCellStringRenderer
24 class wxGridCellRenderer
28 This function must be implemented in derived classes to return a copy
31 virtual wxGridCellRenderer
* Clone() const = 0;
34 Draw the given cell on the provided DC inside the given rectangle using
35 the style specified by the attribute and the default or selected state
36 corresponding to the isSelected value.
38 This pure virtual function has a default implementation which will
39 prepare the DC using the given attribute: it will draw the rectangle
40 with the background colour from attr and set the text colour and font.
42 virtual void Draw(wxGrid
& grid
, wxGridCellAttr
& attr
, wxDC
& dc
,
43 const wxRect
& rect
, int row
, int col
,
47 Get the preferred size of the cell for its contents.
49 virtual wxSize
GetBestSize(wxGrid
& grid
, wxGridCellAttr
& attr
, wxDC
& dc
,
50 int row
, int col
) = 0;
54 @class wxGridCellBoolRenderer
56 This class may be used to format boolean data in a cell.
61 @see wxGridCellRenderer, wxGridCellFloatRenderer, wxGridCellNumberRenderer,
62 wxGridCellStringRenderer
64 class wxGridCellBoolRenderer
: public wxGridCellRenderer
70 wxGridCellBoolRenderer();
74 @class wxGridCellFloatRenderer
76 This class may be used to format floating point data in a cell.
81 @see wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellNumberRenderer,
82 wxGridCellStringRenderer
84 class wxGridCellFloatRenderer
: public wxGridCellStringRenderer
89 Minimum number of characters to be shown.
91 Number of digits after the decimal dot.
93 wxGridCellFloatRenderer(int width
= -1, int precision
= -1);
96 Returns the precision.
98 int GetPrecision() const;
103 int GetWidth() const;
106 Parameters string format is "width[,precision]".
108 virtual void SetParameters(const wxString
& params
);
113 void SetPrecision(int precision
);
118 void SetWidth(int width
);
122 @class wxGridCellNumberRenderer
124 This class may be used to format integer data in a cell.
129 @see wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellFloatRenderer,
130 wxGridCellStringRenderer
132 class wxGridCellNumberRenderer
: public wxGridCellStringRenderer
138 wxGridCellNumberRenderer();
142 @class wxGridCellStringRenderer
144 This class may be used to format string data in a cell; it is the default
150 @see wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellFloatRenderer,
151 wxGridCellNumberRenderer
153 class wxGridCellStringRenderer
: public wxGridCellRenderer
159 wxGridCellStringRenderer();
165 @class wxGridCellEditor
167 This class is responsible for providing and manipulating the in-place edit
168 controls for the grid. Instances of wxGridCellEditor (actually, instances
169 of derived classes since it is an abstract class) can be associated with
170 the cell attributes for individual cells, rows, columns, or even for the
176 @see wxGridCellBoolEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
177 wxGridCellNumberEditor, wxGridCellTextEditor
179 class wxGridCellEditor
188 Fetch the value from the table and prepare the edit control to begin
191 This function should save the original value of the grid cell at the
192 given @a row and @a col and show the control allowing the user to
197 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
200 Create a new object which is the copy of this one.
202 virtual wxGridCellEditor
* Clone() const = 0;
205 Creates the actual edit control.
207 virtual void Create(wxWindow
* parent
, wxWindowID id
,
208 wxEvtHandler
* evtHandler
) = 0;
213 virtual void Destroy();
216 End editing the cell.
218 This function must check if the current value of the editing control is
219 valid and different from the original value (available as @a oldval in
220 its string form and possibly saved internally using its real type by
221 BeginEdit()). If it isn't, it just returns @false, otherwise it must do
223 # Save the new value internally so that ApplyEdit() could apply it.
224 # Fill @a newval (which is never @NULL) with the string
225 representation of the new value.
228 Notice that it must @em not modify the grid as the change could still
231 If the user-defined wxEVT_GRID_CELL_CHANGING event handler doesn't veto
232 this change, ApplyEdit() will be called next.
234 virtual bool EndEdit(int row
, int col
, const wxGrid
* grid
,
235 const wxString
& oldval
, wxString
* newval
) = 0;
238 Effectively save the changes in the grid.
240 This function should save the value of the control in the grid. It is
241 called only after EndEdit() returns @true.
243 virtual void ApplyEdit(int row
, int col
, wxGrid
* grid
) = 0;
246 Some types of controls on some platforms may need some help with the
249 virtual void HandleReturn(wxKeyEvent
& event
);
252 Returns @true if the edit control has been created.
257 Draws the part of the cell not occupied by the control: the base class
258 version just fills it with background colour from the attribute.
260 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
* attr
);
263 Reset the value in the control back to its starting value.
265 virtual void Reset() = 0;
268 Size and position the edit control.
270 virtual void SetSize(const wxRect
& rect
);
273 Show or hide the edit control, use the specified attributes to set
274 colours/fonts for it.
276 virtual void Show(bool show
, wxGridCellAttr
* attr
= NULL
);
279 If the editor is enabled by clicking on the cell, this method will be
282 virtual void StartingClick();
285 If the editor is enabled by pressing keys on the grid, this will be
286 called to let the editor do something about that first key if desired.
288 virtual void StartingKey(wxKeyEvent
& event
);
293 The destructor is private because only DecRef() can delete us.
295 virtual ~wxGridCellEditor();
299 @class wxGridCellBoolEditor
301 Grid cell editor for boolean data.
306 @see wxGridCellEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
307 wxGridCellNumberEditor, wxGridCellTextEditor
309 class wxGridCellBoolEditor
: public wxGridCellEditor
315 wxGridCellBoolEditor();
318 Returns @true if the given @a value is equal to the string
319 representation of the truth value we currently use (see
322 static bool IsTrueValue(const wxString
& value
);
325 This method allows you to customize the values returned by GetValue()
326 for the cell using this editor. By default, the default values of the
327 arguments are used, i.e. @c "1" is returned if the cell is checked and
328 an empty string otherwise.
330 static void UseStringValues(const wxString
& valueTrue
= "1",
331 const wxString
& valueFalse
= wxEmptyString
);
335 @class wxGridCellChoiceEditor
337 Grid cell editor for string data providing the user a choice from a list of
343 @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellFloatEditor,
344 wxGridCellNumberEditor, wxGridCellTextEditor
346 class wxGridCellChoiceEditor
: public wxGridCellEditor
351 Number of strings from which the user can choose.
353 An array of strings from which the user can choose.
355 If allowOthers is @true, the user can type a string not in choices
358 wxGridCellChoiceEditor(size_t count
= 0,
359 const wxString choices
[] = NULL
,
360 bool allowOthers
= false);
363 An array of strings from which the user can choose.
365 If allowOthers is @true, the user can type a string not in choices
368 wxGridCellChoiceEditor(const wxArrayString
& choices
,
369 bool allowOthers
= false);
372 Parameters string format is "item1[,item2[...,itemN]]"
374 virtual void SetParameters(const wxString
& params
);
378 @class wxGridCellTextEditor
380 Grid cell editor for string/text data.
385 @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor,
386 wxGridCellFloatEditor, wxGridCellNumberEditor
388 class wxGridCellTextEditor
: public wxGridCellEditor
394 wxGridCellTextEditor();
397 The parameters string format is "n" where n is a number representing
400 virtual void SetParameters(const wxString
& params
);
404 @class wxGridCellFloatEditor
406 The editor for floating point numbers data.
411 @see wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor,
412 wxGridCellTextEditor, wxGridCellChoiceEditor
414 class wxGridCellFloatEditor
: public wxGridCellTextEditor
419 Minimum number of characters to be shown.
421 Number of digits after the decimal dot.
423 wxGridCellFloatEditor(int width
= -1, int precision
= -1);
426 Parameters string format is "width,precision"
428 virtual void SetParameters(const wxString
& params
);
432 @class wxGridCellNumberEditor
434 Grid cell editor for numeric integer data.
439 @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor,
440 wxGridCellFloatEditor, wxGridCellTextEditor
442 class wxGridCellNumberEditor
: public wxGridCellTextEditor
446 Allows you to specify the range for acceptable data. Values equal to
447 -1 for both @a min and @a max indicate that no range checking should be
450 wxGridCellNumberEditor(int min
= -1, int max
= -1);
454 Parameters string format is "min,max".
456 virtual void SetParameters(const wxString
& params
);
461 If the return value is @true, the editor uses a wxSpinCtrl to get user
462 input, otherwise it uses a wxTextCtrl.
464 bool HasRange() const;
467 String representation of the value.
469 wxString
GetString() const;
475 @class wxGridCellAttr
477 This class can be used to alter the cells' appearance in the grid by
478 changing their attributes from the defaults. An object of this class may be
479 returned by wxGridTableBase::GetAttr().
488 Kind of the attribute to retrieve.
490 @see wxGridCellAttrProvider::GetAttr(), wxGridTableBase::GetAttr()
494 /// Return the combined effective attribute for the cell.
497 /// Return the attribute explicitly set for this cell.
500 /// Return the attribute set for this cells row.
503 /// Return the attribute set for this cells column.
510 wxGridCellAttr(wxGridCellAttr
* attrDefault
= NULL
);
512 Constructor specifying some of the often used attributes.
514 wxGridCellAttr(const wxColour
& colText
, const wxColour
& colBack
,
515 const wxFont
& font
, int hAlign
, int vAlign
);
518 Creates a new copy of this object.
520 wxGridCellAttr
* Clone() const;
523 This class is reference counted: it is created with ref count of 1, so
524 calling DecRef() once will delete it. Calling IncRef() allows to lock
525 it until the matching DecRef() is called.
530 See SetAlignment() for the returned values.
532 void GetAlignment(int* hAlign
, int* vAlign
) const;
535 Returns the background colour.
537 const wxColour
& GetBackgroundColour() const;
540 Returns the cell editor.
542 wxGridCellEditor
* GetEditor(const wxGrid
* grid
, int row
, int col
) const;
547 const wxFont
& GetFont() const;
550 Returns the cell renderer.
552 wxGridCellRenderer
* GetRenderer(const wxGrid
* grid
, int row
, int col
) const;
555 Returns the text colour.
557 const wxColour
& GetTextColour() const;
560 Returns @true if this attribute has a valid alignment set.
562 bool HasAlignment() const;
565 Returns @true if this attribute has a valid background colour set.
567 bool HasBackgroundColour() const;
570 Returns @true if this attribute has a valid cell editor set.
572 bool HasEditor() const;
575 Returns @true if this attribute has a valid font set.
577 bool HasFont() const;
580 Returns @true if this attribute has a valid cell renderer set.
582 bool HasRenderer() const;
585 Returns @true if this attribute has a valid text colour set.
587 bool HasTextColour() const;
590 This class is reference counted: it is created with ref count of 1, so
591 calling DecRef() once will delete it. Calling IncRef() allows to lock
592 it until the matching DecRef() is called.
597 Returns @true if this cell is set as read-only.
599 bool IsReadOnly() const;
602 Sets the alignment. @a hAlign can be one of @c wxALIGN_LEFT,
603 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT and @a vAlign can be one of
604 @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
606 void SetAlignment(int hAlign
, int vAlign
);
609 Sets the background colour.
611 void SetBackgroundColour(const wxColour
& colBack
);
614 @todo Needs documentation.
616 void SetDefAttr(wxGridCellAttr
* defAttr
);
619 Sets the editor to be used with the cells with this attribute.
621 void SetEditor(wxGridCellEditor
* editor
);
626 void SetFont(const wxFont
& font
);
629 Sets the cell as read-only.
631 void SetReadOnly(bool isReadOnly
= true);
634 Sets the renderer to be used for cells with this attribute. Takes
635 ownership of the pointer.
637 void SetRenderer(wxGridCellRenderer
* renderer
);
640 Sets the text colour.
642 void SetTextColour(const wxColour
& colText
);
646 Base class for corner window renderer.
648 This is the simplest of all header renderers and only has a single
651 @see wxGridCellAttrProvider::GetCornerRenderer()
655 class wxGridCornerHeaderRenderer
659 Called by the grid to draw the corner window border.
661 This method is responsible for drawing the border inside the given @a
662 rect and adjusting the rectangle size to correspond to the area inside
663 the border, i.e. usually call wxRect::Deflate() to account for the
667 The grid whose corner window is being drawn.
669 The device context to use for drawing.
671 Input/output parameter which contains the border rectangle on input
672 and should be updated to contain the area inside the border on
675 virtual void DrawBorder(const wxGrid
& grid
,
677 wxRect
& rect
) const = 0;
680 Common base class for row and column headers renderers.
682 @see wxGridColumnHeaderRenderer, wxGridRowHeaderRenderer
686 class wxGridHeaderLabelsRenderer
: public wxGridCornerHeaderRenderer
690 Called by the grid to draw the specified label.
692 Notice that the base class DrawBorder() method is called before this
695 The default implementation uses wxGrid::GetLabelTextColour() and
696 wxGrid::GetLabelFont() to draw the label.
698 virtual void DrawLabel(const wxGrid
& grid
,
700 const wxString
& value
,
704 int textOrientation
) const;
708 Base class for row headers renderer.
710 This is the same as wxGridHeaderLabelsRenderer currently but we still use a
711 separate class for it to distinguish it from wxGridColumnHeaderRenderer.
713 @see wxGridRowHeaderRendererDefault
715 @see wxGridCellAttrProvider::GetRowHeaderRenderer()
719 class wxGridRowHeaderRenderer
: public wxGridHeaderLabelsRenderer
724 Base class for column headers renderer.
726 This is the same as wxGridHeaderLabelsRenderer currently but we still use a
727 separate class for it to distinguish it from wxGridRowHeaderRenderer.
729 @see wxGridColumnHeaderRendererDefault
731 @see wxGridCellAttrProvider::GetColumnHeaderRenderer()
735 class wxGridColumnHeaderRenderer
: public wxGridHeaderLabelsRenderer
740 Default row header renderer.
742 You may derive from this class if you need to only override one of its
743 methods (i.e. either DrawLabel() or DrawBorder()) but continue to use the
744 default implementation for the other one.
746 @see wxGridColumnHeaderRendererDefault
750 class wxGridRowHeaderRendererDefault
: public wxGridRowHeaderRendererDefault
753 /// Implement border drawing for the row labels.
754 virtual void DrawBorder(const wxGrid
& grid
,
760 Default column header renderer.
762 @see wxGridRowHeaderRendererDefault
766 class wxGridColumnHeaderRendererDefault
: public wxGridColumnHeaderRenderer
769 /// Implement border drawing for the column labels.
770 virtual void DrawBorder(const wxGrid
& grid
,
776 Default corner window renderer.
778 @see wxGridColumnHeaderRendererDefault, wxGridRowHeaderRendererDefault
782 class wxGridCornerHeaderRendererDefault
: public wxGridCornerHeaderRenderer
785 /// Implement border drawing for the corner window.
786 virtual void DrawBorder(const wxGrid
& grid
,
792 Class providing attributes to be used for the grid cells.
794 This class both defines an interface which grid cell attributes providers
795 should implement -- and which can be implemented differently in derived
796 classes -- and a default implementation of this interface which is often
797 good enough to be used without modification, especially with not very large
798 grids for which the efficiency of attributes storage hardly matters (see
799 the discussion below).
801 An object of this class can be associated with a wxGrid using
802 wxGridTableBase::SetAttrProvider() but it's not necessary to call it if you
803 intend to use the default provider as it is used by wxGridTableBase by
806 Notice that while attributes provided by this class can be set for
807 individual cells using SetAttr() or the entire rows or columns using
808 SetRowAttr() and SetColAttr() they are always retrieved using GetAttr()
812 The default implementation of this class stores the attributes passed to
813 its SetAttr(), SetRowAttr() and SetColAttr() in a straightforward way. A
814 derived class may use its knowledge about how the attributes are used in
815 your program to implement it much more efficiently: for example, using a
816 special background colour for all even-numbered rows can be implemented by
817 simply returning the same attribute from GetAttr() if the row number is
818 even instead of having to store N/2 row attributes where N is the total
819 number of rows in the grid.
821 Notice that objects of this class can't be copied.
823 class wxGridCellAttrProvider
: public wxClientDataContainer
826 /// Trivial default constructor.
827 wxGridCellAttrProvider();
829 /// Destructor releases any attributes held by this class.
830 virtual ~wxGridCellAttrProvider();
833 Get the attribute to use for the specified cell.
835 If wxGridCellAttr::Any is used as @a kind value, this function combines
836 the attributes set for this cell using SetAttr() and those for its row
837 or column (set with SetRowAttr() or SetColAttr() respectively), with
838 the cell attribute having the highest precedence.
840 Notice that the caller must call DecRef() on the returned pointer if it
846 The column of the cell.
848 The kind of the attribute to return.
850 The attribute to use which should be DecRef()'d by caller or @NULL
851 if no attributes are defined for this cell.
853 virtual wxGridCellAttr
*GetAttr(int row
, int col
,
854 wxGridCellAttr::wxAttrKind kind
) const;
859 All these functions take ownership of the attribute passed to them,
860 i.e. will call DecRef() on it themselves later and so it should not be
861 destroyed by the caller. And the attribute can be @NULL to reset a
862 previously set value.
866 /// Set attribute for the specified cell.
867 virtual void SetAttr(wxGridCellAttr
*attr
, int row
, int col
);
869 /// Set attribute for the specified row.
870 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
872 /// Set attribute for the specified column.
873 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
878 Getting header renderers.
880 These functions return the renderers for the given row or column header
881 label and the corner window. Unlike cell attributes, these objects are
882 not reference counted and are never @NULL so they are returned by
883 reference and not pointer and DecRef() shouldn't (and can't) be called
886 All these functions were added in wxWidgets 2.9.1.
891 Return the renderer used for drawing column headers.
893 By default wxGridColumnHeaderRendererDefault is returned.
895 @see wxGrid::SetUseNativeColLabels(), wxGrid::UseNativeColHeader()
899 virtual const wxGridColumnHeaderRenderer
& GetColumnHeaderRenderer(int col
);
902 Return the renderer used for drawing row headers.
904 By default wxGridRowHeaderRendererDefault is returned.
908 virtual const wxGridRowHeaderRenderer
& GetRowHeaderRenderer(int row
);
911 Return the renderer used for drawing the corner window.
913 By default wxGridCornerHeaderRendererDefault is returned.
917 virtual const wxGridCornerHeaderRenderer
& GetCornerRenderer();
924 @class wxGridTableBase
926 The almost abstract base class for grid tables.
928 A grid table is responsible for storing the grid data and, indirectly, grid
929 cell attributes. The data can be stored in the way most convenient for the
930 application but has to be provided in string form to wxGrid. It is also
931 possible to provide cells values in other formats if appropriate, e.g. as
934 This base class is not quite abstract as it implements a trivial strategy
935 for storing the attributes by forwarding it to wxGridCellAttrProvider and
936 also provides stubs for some other functions. However it does have a number
937 of pure virtual methods which must be implemented in the derived classes.
939 @see wxGridStringTable
944 class wxGridTableBase
: public wxObject
953 Destructor frees the attribute provider if it was created.
955 virtual ~wxGridTableBase();
958 Must be overridden to return the number of rows in the table.
960 For backwards compatibility reasons, this method is not const.
961 Use GetRowsCount() instead of it in const methods of derived table
964 virtual int GetNumberRows() = 0;
967 Must be overridden to return the number of columns in the table.
969 For backwards compatibility reasons, this method is not const.
970 Use GetColsCount() instead of it in const methods of derived table
973 virtual int GetNumberCols() = 0;
976 Return the number of rows in the table.
978 This method is not virtual and is only provided as a convenience for
979 the derived classes which can't call GetNumberRows() without a
980 @c const_cast from their const methods.
982 int GetRowsCount() const;
985 Return the number of columns in the table.
987 This method is not virtual and is only provided as a convenience for
988 the derived classes which can't call GetNumberCols() without a
989 @c const_cast from their const methods.
991 int GetColsCount() const;
995 @name Table Cell Accessors
1000 May be overridden to implement testing for empty cells.
1002 This method is used by the grid to test if the given cell is not used
1003 and so whether a neighbouring cell may overflow into it. By default it
1004 only returns true if the value of the given cell, as returned by
1005 GetValue(), is empty.
1007 virtual bool IsEmptyCell(int row
, int col
);
1010 Same as IsEmptyCell() but taking wxGridCellCoords.
1012 Notice that this method is not virtual, only IsEmptyCell() should be
1015 bool IsEmpty(const wxGridCellCoords
& coords
);
1018 Must be overridden to implement accessing the table values as text.
1020 virtual wxString
GetValue(int row
, int col
) = 0;
1023 Must be overridden to implement setting the table values as text.
1025 virtual void SetValue(int row
, int col
, const wxString
& value
) = 0;
1028 Returns the type of the value in the given cell.
1030 By default all cells are strings and this method returns
1031 @c wxGRID_VALUE_STRING.
1033 virtual wxString
GetTypeName(int row
, int col
);
1036 Returns true if the value of the given cell can be accessed as if it
1037 were of the specified type.
1039 By default the cells can only be accessed as strings. Note that a cell
1040 could be accessible in different ways, e.g. a numeric cell may return
1041 @true for @c wxGRID_VALUE_NUMBER but also for @c wxGRID_VALUE_STRING
1042 indicating that the value can be coerced to a string form.
1044 virtual bool CanGetValueAs(int row
, int col
, const wxString
& typeName
);
1047 Returns true if the value of the given cell can be set as if it were of
1050 @see CanGetValueAs()
1052 virtual bool CanSetValueAs(int row
, int col
, const wxString
& typeName
);
1055 Returns the value of the given cell as a long.
1057 This should only be called if CanGetValueAs() returns @true when called
1058 with @c wxGRID_VALUE_NUMBER argument. Default implementation always
1061 virtual long GetValueAsLong(int row
, int col
);
1064 Returns the value of the given cell as a double.
1066 This should only be called if CanGetValueAs() returns @true when called
1067 with @c wxGRID_VALUE_FLOAT argument. Default implementation always
1070 virtual double GetValueAsDouble(int row
, int col
);
1073 Returns the value of the given cell as a boolean.
1075 This should only be called if CanGetValueAs() returns @true when called
1076 with @c wxGRID_VALUE_BOOL argument. Default implementation always
1079 virtual bool GetValueAsBool(int row
, int col
);
1082 Returns the value of the given cell as a user-defined type.
1084 This should only be called if CanGetValueAs() returns @true when called
1085 with @a typeName. Default implementation always return @NULL.
1087 virtual void *GetValueAsCustom(int row
, int col
, const wxString
& typeName
);
1090 Sets the value of the given cell as a long.
1092 This should only be called if CanSetValueAs() returns @true when called
1093 with @c wxGRID_VALUE_NUMBER argument. Default implementation doesn't do
1096 virtual void SetValueAsLong(int row
, int col
, long value
);
1099 Sets the value of the given cell as a double.
1101 This should only be called if CanSetValueAs() returns @true when called
1102 with @c wxGRID_VALUE_FLOAT argument. Default implementation doesn't do
1105 virtual void SetValueAsDouble(int row
, int col
, double value
);
1108 Sets the value of the given cell as a boolean.
1110 This should only be called if CanSetValueAs() returns @true when called
1111 with @c wxGRID_VALUE_BOOL argument. Default implementation doesn't do
1114 virtual void SetValueAsBool( int row
, int col
, bool value
);
1117 Sets the value of the given cell as a user-defined type.
1119 This should only be called if CanSetValueAs() returns @true when called
1120 with @a typeName. Default implementation doesn't do anything.
1122 virtual void SetValueAsCustom(int row
, int col
, const wxString
& typeName
,
1129 Called by the grid when the table is associated with it.
1131 The default implementation stores the pointer and returns it from its
1132 GetView() and so only makes sense if the table cannot be associated
1133 with more than one grid at a time.
1135 virtual void SetView(wxGrid
*grid
);
1138 Returns the last grid passed to SetView().
1140 virtual wxGrid
*GetView() const;
1144 @name Table Structure Modifiers
1146 Notice that none of these functions are pure virtual as they don't have
1147 to be implemented if the table structure is never modified after
1148 creation, i.e. neither rows nor columns are never added or deleted but
1149 that you do need to implement them if they are called, i.e. if your
1150 code either calls them directly or uses the matching wxGrid methods, as
1151 by default they simply do nothing which is definitely inappropriate.
1156 Clear the table contents.
1158 This method is used by wxGrid::ClearGrid().
1160 virtual void Clear();
1163 Insert additional rows into the table.
1166 The position of the first new row.
1168 The number of rows to insert.
1170 virtual bool InsertRows(size_t pos
= 0, size_t numRows
= 1);
1173 Append additional rows at the end of the table.
1175 This method is provided in addition to InsertRows() as some data models
1176 may only support appending rows to them but not inserting them at
1177 arbitrary locations. In such case you may implement this method only
1178 and leave InsertRows() unimplemented.
1181 The number of rows to add.
1183 virtual bool AppendRows(size_t numRows
= 1);
1186 Delete rows from the table.
1189 The first row to delete.
1191 The number of rows to delete.
1193 virtual bool DeleteRows(size_t pos
= 0, size_t numRows
= 1);
1196 Exactly the same as InsertRows() but for columns.
1198 virtual bool InsertCols(size_t pos
= 0, size_t numCols
= 1);
1201 Exactly the same as AppendRows() but for columns.
1203 virtual bool AppendCols(size_t numCols
= 1);
1206 Exactly the same as DeleteRows() but for columns.
1208 virtual bool DeleteCols(size_t pos
= 0, size_t numCols
= 1);
1213 @name Table Row and Column Labels
1215 By default the numbers are used for labeling rows and Latin letters for
1216 labeling columns. If the table has more than 26 columns, the pairs of
1217 letters are used starting from the 27-th one and so on, i.e. the
1218 sequence of labels is A, B, ..., Z, AA, AB, ..., AZ, BA, ..., ..., ZZ,
1224 Return the label of the specified row.
1226 virtual wxString
GetRowLabelValue(int row
);
1229 Return the label of the specified column.
1231 virtual wxString
GetColLabelValue(int col
);
1234 Set the given label for the specified row.
1236 The default version does nothing, i.e. the label is not stored. You
1237 must override this method in your derived class if you wish
1238 wxGrid::SetRowLabelValue() to work.
1240 virtual void SetRowLabelValue(int row
, const wxString
& label
);
1243 Exactly the same as SetRowLabelValue() but for columns.
1245 virtual void SetColLabelValue(int col
, const wxString
& label
);
1251 @name Attributes Management
1253 By default the attributes management is delegated to
1254 wxGridCellAttrProvider class. You may override the methods in this
1255 section to handle the attributes directly if, for example, they can be
1256 computed from the cell values.
1261 Associate this attributes provider with the table.
1263 The table takes ownership of @a attrProvider pointer and will delete it
1264 when it doesn't need it any more. The pointer can be @NULL, however
1265 this won't disable attributes management in the table but will just
1266 result in a default attributes being recreated the next time any of the
1267 other functions in this section is called. To completely disable the
1268 attributes support, should this be needed, you need to override
1269 CanHaveAttributes() to return @false.
1271 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
1274 Returns the attribute provider currently being used.
1276 This function may return @NULL if the attribute provider hasn't been
1277 neither associated with this table by SetAttrProvider() nor created on
1278 demand by any other methods.
1280 wxGridCellAttrProvider
*GetAttrProvider() const;
1283 Return the attribute for the given cell.
1285 By default this function is simply forwarded to
1286 wxGridCellAttrProvider::GetAttr() but it may be overridden to handle
1287 attributes directly in the table.
1289 virtual wxGridCellAttr
*GetAttr(int row
, int col
,
1290 wxGridCellAttr::wxAttrKind kind
);
1293 Set attribute of the specified cell.
1295 By default this function is simply forwarded to
1296 wxGridCellAttrProvider::SetAttr().
1298 The table takes ownership of @a attr, i.e. will call DecRef() on it.
1300 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
1303 Set attribute of the specified row.
1305 By default this function is simply forwarded to
1306 wxGridCellAttrProvider::SetRowAttr().
1308 The table takes ownership of @a attr, i.e. will call DecRef() on it.
1310 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
1313 Set attribute of the specified column.
1315 By default this function is simply forwarded to
1316 wxGridCellAttrProvider::SetColAttr().
1318 The table takes ownership of @a attr, i.e. will call DecRef() on it.
1320 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
1325 Returns true if this table supports attributes or false otherwise.
1327 By default, the table automatically creates a wxGridCellAttrProvider
1328 when this function is called if it had no attribute provider before and
1331 virtual bool CanHaveAttributes();
1335 @class wxGridSizesInfo
1337 wxGridSizesInfo stores information about sizes of all wxGrid rows or
1340 It assumes that most of the rows or columns (which are both called elements
1341 here as the difference between them doesn't matter at this class level)
1342 have the default size and so stores it separately. And it uses a wxHashMap
1343 to store the sizes of all elements which have the non-default size.
1345 This structure is particularly useful for serializing the sizes of all
1346 wxGrid elements at once.
1351 struct wxGridSizesInfo
1354 Default constructor.
1356 m_sizeDefault and m_customSizes must be initialized later.
1363 This constructor is used by wxGrid::GetRowSizes() and GetColSizes()
1364 methods. User code will usually use the default constructor instead.
1367 The default element size.
1369 Array containing the sizes of @em all elements, including those
1370 which have the default size.
1372 wxGridSizesInfo(int defSize
, const wxArrayInt
& allSizes
);
1375 Get the element size.
1378 The index of the element.
1380 The size for this element, using m_customSizes if @a pos is in it
1381 or m_sizeDefault otherwise.
1383 int GetSize(unsigned pos
) const;
1390 Map with element indices as keys and their sizes as values.
1392 This map only contains the elements with non-default size.
1394 wxUnsignedToIntHashMap m_customSizes
;
1401 wxGrid and its related classes are used for displaying and editing tabular
1402 data. They provide a rich set of features for display, editing, and
1403 interacting with a variety of data sources. For simple applications, and to
1404 help you get started, wxGrid is the only class you need to refer to
1405 directly. It will set up default instances of the other classes and manage
1406 them for you. For more complex applications you can derive your own classes
1407 for custom grid views, grid data tables, cell editors and renderers. The
1408 @ref overview_grid has examples of simple and more complex applications,
1409 explains the relationship between the various grid classes and has a
1410 summary of the keyboard shortcuts and mouse functions provided by wxGrid.
1412 A wxGridTableBase class holds the actual data to be displayed by a wxGrid
1413 class. One or more wxGrid classes may act as a view for one table class.
1414 The default table class is called wxGridStringTable and holds an array of
1415 strings. An instance of such a class is created by CreateGrid().
1417 wxGridCellRenderer is the abstract base class for rendereing contents in a
1418 cell. The following renderers are predefined:
1420 - wxGridCellBoolRenderer
1421 - wxGridCellFloatRenderer
1422 - wxGridCellNumberRenderer
1423 - wxGridCellStringRenderer
1425 The look of a cell can be further defined using wxGridCellAttr. An object
1426 of this type may be returned by wxGridTableBase::GetAttr().
1428 wxGridCellEditor is the abstract base class for editing the value of a
1429 cell. The following editors are predefined:
1431 - wxGridCellBoolEditor
1432 - wxGridCellChoiceEditor
1433 - wxGridCellFloatEditor
1434 - wxGridCellNumberEditor
1435 - wxGridCellTextEditor
1437 Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
1438 wxGridEditorCreatedEvent for the documentation of all event types you can
1444 @see @ref overview_grid, wxGridUpdateLocker
1446 class wxGrid
: public wxScrolledWindow
1451 Different selection modes supported by the grid.
1453 enum wxGridSelectionModes
1456 The default selection mode allowing selection of the individual
1457 cells as well as of the entire rows and columns.
1462 The selection mode allowing the selection of the entire rows only.
1464 The user won't be able to select any cells or columns in this mode.
1469 The selection mode allowing the selection of the entire columns only.
1471 The user won't be able to select any cells or rows in this mode.
1478 @name Constructors and Initialization
1483 Default constructor.
1485 You must call Create() to really create the grid window and also call
1486 CreateGrid() or SetTable() to initialize the grid contents.
1490 Constructor creating the grid window.
1492 You must call either CreateGrid() or SetTable() to initialize the grid
1493 contents before using it.
1495 wxGrid(wxWindow
* parent
, wxWindowID id
,
1496 const wxPoint
& pos
= wxDefaultPosition
,
1497 const wxSize
& size
= wxDefaultSize
,
1498 long style
= wxWANTS_CHARS
,
1499 const wxString
& name
= wxGridNameStr
);
1504 This will also destroy the associated grid table unless you passed a
1505 table object to the grid and specified that the grid should not take
1506 ownership of the table (see SetTable()).
1511 Creates the grid window for an object initialized using the default
1514 You must call either CreateGrid() or SetTable() to initialize the grid
1515 contents before using it.
1517 bool Create(wxWindow
* parent
, wxWindowID id
,
1518 const wxPoint
& pos
= wxDefaultPosition
,
1519 const wxSize
& size
= wxDefaultSize
,
1520 long style
= wxWANTS_CHARS
,
1521 const wxString
& name
= wxGridNameStr
);
1524 Creates a grid with the specified initial number of rows and columns.
1526 Call this directly after the grid constructor. When you use this
1527 function wxGrid will create and manage a simple table of string values
1528 for you. All of the grid data will be stored in memory.
1530 For applications with more complex data types or relationships, or for
1531 dealing with very large datasets, you should derive your own grid table
1532 class and pass a table object to the grid with SetTable().
1534 bool CreateGrid(int numRows
, int numCols
,
1535 wxGridSelectionModes selmode
= wxGridSelectCells
);
1538 Passes a pointer to a custom grid table to be used by the grid.
1540 This should be called after the grid constructor and before using the
1541 grid object. If @a takeOwnership is set to @true then the table will be
1542 deleted by the wxGrid destructor.
1544 Use this function instead of CreateGrid() when your application
1545 involves complex or non-string data or data sets that are too large to
1546 fit wholly in memory.
1548 bool SetTable(wxGridTableBase
* table
, bool takeOwnership
= false,
1549 wxGridSelectionModes selmode
= wxGridSelectCells
);
1555 @name Grid Line Formatting
1560 Turns the drawing of grid lines on or off.
1562 void EnableGridLines(bool enable
= true);
1565 Returns the pen used for vertical grid lines.
1567 This virtual function may be overridden in derived classes in order to
1568 change the appearance of individual grid lines for the given column
1571 See GetRowGridLinePen() for an example.
1573 virtual wxPen
GetColGridLinePen(int col
);
1576 Returns the pen used for grid lines.
1578 This virtual function may be overridden in derived classes in order to
1579 change the appearance of grid lines. Note that currently the pen width
1582 @see GetColGridLinePen(), GetRowGridLinePen()
1584 virtual wxPen
GetDefaultGridLinePen();
1587 Returns the colour used for grid lines.
1589 @see GetDefaultGridLinePen()
1591 wxColour
GetGridLineColour() const;
1594 Returns the pen used for horizontal grid lines.
1596 This virtual function may be overridden in derived classes in order to
1597 change the appearance of individual grid line for the given @a row.
1601 // in a grid displaying music notation, use a solid black pen between
1602 // octaves (C0=row 127, C1=row 115 etc.)
1603 wxPen MidiGrid::GetRowGridLinePen(int row)
1605 if ( row % 12 == 7 )
1606 return wxPen(*wxBLACK, 1, wxSOLID);
1608 return GetDefaultGridLinePen();
1612 virtual wxPen
GetRowGridLinePen(int row
);
1615 Returns @true if drawing of grid lines is turned on, @false otherwise.
1617 bool GridLinesEnabled() const;
1620 Sets the colour used to draw grid lines.
1622 void SetGridLineColour(const wxColour
& colour
);
1628 @name Label Values and Formatting
1633 Sets the arguments to the current column label alignment values.
1635 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1636 or @c wxALIGN_RIGHT.
1638 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1641 void GetColLabelAlignment(int* horiz
, int* vert
) const;
1644 Returns the orientation of the column labels (either @c wxHORIZONTAL or
1647 int GetColLabelTextOrientation() const;
1650 Returns the specified column label.
1652 The default grid table class provides column labels of the form
1653 A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can
1654 override wxGridTableBase::GetColLabelValue() to provide your own
1657 wxString
GetColLabelValue(int col
) const;
1660 Returns the colour used for the background of row and column labels.
1662 wxColour
GetLabelBackgroundColour() const;
1665 Returns the font used for row and column labels.
1667 wxFont
GetLabelFont() const;
1670 Returns the colour used for row and column label text.
1672 wxColour
GetLabelTextColour() const;
1675 Returns the alignment used for row labels.
1677 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1678 or @c wxALIGN_RIGHT.
1680 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1683 void GetRowLabelAlignment(int* horiz
, int* vert
) const;
1686 Returns the specified row label.
1688 The default grid table class provides numeric row labels. If you are
1689 using a custom grid table you can override
1690 wxGridTableBase::GetRowLabelValue() to provide your own labels.
1692 wxString
GetRowLabelValue(int row
) const;
1695 Hides the column labels by calling SetColLabelSize() with a size of 0.
1696 Show labels again by calling that method with a width greater than 0.
1698 void HideColLabels();
1701 Hides the row labels by calling SetRowLabelSize() with a size of 0.
1703 The labels can be shown again by calling SetRowLabelSize() with a width
1706 void HideRowLabels();
1709 Sets the horizontal and vertical alignment of column label text.
1711 Horizontal alignment should be one of @c wxALIGN_LEFT,
1712 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT. Vertical alignment should be one
1713 of @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
1715 void SetColLabelAlignment(int horiz
, int vert
);
1718 Sets the orientation of the column labels (either @c wxHORIZONTAL or
1721 void SetColLabelTextOrientation(int textOrientation
);
1724 Set the value for the given column label.
1726 If you are using a custom grid table you must override
1727 wxGridTableBase::SetColLabelValue() for this to have any effect.
1729 void SetColLabelValue(int col
, const wxString
& value
);
1732 Sets the background colour for row and column labels.
1734 void SetLabelBackgroundColour(const wxColour
& colour
);
1737 Sets the font for row and column labels.
1739 void SetLabelFont(const wxFont
& font
);
1742 Sets the colour for row and column label text.
1744 void SetLabelTextColour(const wxColour
& colour
);
1747 Sets the horizontal and vertical alignment of row label text.
1749 Horizontal alignment should be one of @c wxALIGN_LEFT,
1750 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT. Vertical alignment should be one
1751 of @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
1753 void SetRowLabelAlignment(int horiz
, int vert
);
1756 Sets the value for the given row label.
1758 If you are using a derived grid table you must override
1759 wxGridTableBase::SetRowLabelValue() for this to have any effect.
1761 void SetRowLabelValue(int row
, const wxString
& value
);
1764 Call this in order to make the column labels use a native look by using
1765 wxRendererNative::DrawHeaderButton() internally.
1767 There is no equivalent method for drawing row columns as there is not
1768 native look for that. This option is useful when using wxGrid for
1769 displaying tables and not as a spread-sheet.
1771 @see UseNativeColHeader()
1773 void SetUseNativeColLabels(bool native
= true);
1776 Enable the use of native header window for column labels.
1778 If this function is called with @true argument, a wxHeaderCtrl is used
1779 instead to display the column labels instead of drawing them in wxGrid
1780 code itself. This has the advantage of making the grid look and feel
1781 perfectly the same as native applications (using SetUseNativeColLabels()
1782 the grid can be made to look more natively but it still doesn't feel
1783 natively, notably the column resizing and dragging still works slightly
1784 differently as it is implemented in wxWidgets itself) but results in
1785 different behaviour for column and row headers, for which there is no
1786 equivalent function, and, most importantly, is unsuitable for grids
1787 with huge numbers of columns as wxHeaderCtrl doesn't support virtual
1788 mode. Because of this, by default the grid does not use the native
1789 header control but you should call this function to enable it if you
1790 are using the grid to display tabular data and don't have thousands of
1793 Also note that currently @c wxEVT_GRID_LABEL_LEFT_DCLICK and
1794 @c wxEVT_GRID_LABEL_RIGHT_DCLICK events are not generated for the column
1795 labels if the native columns header is used (but this limitation could
1796 possibly be lifted in the future).
1798 void UseNativeColHeader(bool native
= true);
1804 @name Cell Formatting
1806 Note that wxGridCellAttr can be used alternatively to most of these
1807 methods. See the "Attributes Management" of wxGridTableBase.
1812 Sets the arguments to the horizontal and vertical text alignment values
1813 for the grid cell at the specified location.
1815 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1816 or @c wxALIGN_RIGHT.
1818 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1821 void GetCellAlignment(int row
, int col
, int* horiz
, int* vert
) const;
1824 Returns the background colour of the cell at the specified location.
1826 wxColour
GetCellBackgroundColour(int row
, int col
) const;
1829 Returns the font for text in the grid cell at the specified location.
1831 wxFont
GetCellFont(int row
, int col
) const;
1834 Returns the text colour for the grid cell at the specified location.
1836 wxColour
GetCellTextColour(int row
, int col
) const;
1839 Returns the default cell alignment.
1841 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1842 or @c wxALIGN_RIGHT.
1844 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1847 @see SetDefaultCellAlignment()
1849 void GetDefaultCellAlignment(int* horiz
, int* vert
) const;
1852 Returns the current default background colour for grid cells.
1854 wxColour
GetDefaultCellBackgroundColour() const;
1857 Returns the current default font for grid cell text.
1859 wxFont
GetDefaultCellFont() const;
1862 Returns the current default colour for grid cell text.
1864 wxColour
GetDefaultCellTextColour() const;
1867 Sets the horizontal and vertical alignment for grid cell text at the
1870 Horizontal alignment should be one of @c wxALIGN_LEFT,
1871 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT.
1873 Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
1874 or @c wxALIGN_BOTTOM.
1876 void SetCellAlignment(int row
, int col
, int horiz
, int vert
);
1878 Sets the horizontal and vertical alignment for grid cell text at the
1881 Horizontal alignment should be one of @c wxALIGN_LEFT,
1882 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT.
1884 Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
1885 or @c wxALIGN_BOTTOM.
1887 void SetCellAlignment(int align
, int row
, int col
);
1890 Set the background colour for the given cell or all cells by default.
1892 void SetCellBackgroundColour(int row
, int col
, const wxColour
& colour
);
1895 Sets the font for text in the grid cell at the specified location.
1897 void SetCellFont(int row
, int col
, const wxFont
& font
);
1900 Sets the text colour for the given cell.
1902 void SetCellTextColour(int row
, int col
, const wxColour
& colour
);
1904 Sets the text colour for the given cell.
1906 void SetCellTextColour(const wxColour
& val
, int row
, int col
);
1908 Sets the text colour for all cells by default.
1910 void SetCellTextColour(const wxColour
& colour
);
1913 Sets the default horizontal and vertical alignment for grid cell text.
1915 Horizontal alignment should be one of @c wxALIGN_LEFT,
1916 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT. Vertical alignment should be one
1917 of @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
1919 void SetDefaultCellAlignment(int horiz
, int vert
);
1922 Sets the default background colour for grid cells.
1924 void SetDefaultCellBackgroundColour(const wxColour
& colour
);
1927 Sets the default font to be used for grid cell text.
1929 void SetDefaultCellFont(const wxFont
& font
);
1932 Sets the current default colour for grid cell text.
1934 void SetDefaultCellTextColour(const wxColour
& colour
);
1940 @name Cell Values, Editors, and Renderers
1942 Note that wxGridCellAttr can be used alternatively to most of these
1943 methods. See the "Attributes Management" of wxGridTableBase.
1948 Returns @true if the in-place edit control for the current grid cell
1949 can be used and @false otherwise.
1951 This function always returns @false for the read-only cells.
1953 bool CanEnableCellControl() const;
1956 Disables in-place editing of grid cells.
1958 Equivalent to calling EnableCellEditControl(@false).
1960 void DisableCellEditControl();
1963 Enables or disables in-place editing of grid cell data.
1965 The grid will issue either a @c wxEVT_GRID_EDITOR_SHOWN or
1966 @c wxEVT_GRID_EDITOR_HIDDEN event.
1968 void EnableCellEditControl(bool enable
= true);
1971 Makes the grid globally editable or read-only.
1973 If the edit argument is @false this function sets the whole grid as
1974 read-only. If the argument is @true the grid is set to the default
1975 state where cells may be editable. In the default state you can set
1976 single grid cells and whole rows and columns to be editable or
1977 read-only via wxGridCellAttr::SetReadOnly(). For single cells you
1978 can also use the shortcut function SetReadOnly().
1980 For more information about controlling grid cell attributes see the
1981 wxGridCellAttr class and the @ref overview_grid.
1983 void EnableEditing(bool edit
);
1986 Returns a pointer to the editor for the cell at the specified location.
1988 See wxGridCellEditor and the @ref overview_grid for more information
1989 about cell editors and renderers.
1991 The caller must call DecRef() on the returned pointer.
1993 wxGridCellEditor
* GetCellEditor(int row
, int col
) const;
1996 Returns a pointer to the renderer for the grid cell at the specified
1999 See wxGridCellRenderer and the @ref overview_grid for more information
2000 about cell editors and renderers.
2002 The caller must call DecRef() on the returned pointer.
2004 wxGridCellRenderer
* GetCellRenderer(int row
, int col
) const;
2007 Returns the string contained in the cell at the specified location.
2009 For simple applications where a grid object automatically uses a
2010 default grid table of string values you use this function together with
2011 SetCellValue() to access cell values. For more complex applications
2012 where you have derived your own grid table class that contains various
2013 data types (e.g. numeric, boolean or user-defined custom types) then
2014 you only use this function for those cells that contain string values.
2016 See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
2019 wxString
GetCellValue(int row
, int col
) const;
2021 Returns the string contained in the cell at the specified location.
2023 For simple applications where a grid object automatically uses a
2024 default grid table of string values you use this function together with
2025 SetCellValue() to access cell values. For more complex applications
2026 where you have derived your own grid table class that contains various
2027 data types (e.g. numeric, boolean or user-defined custom types) then
2028 you only use this function for those cells that contain string values.
2030 See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
2033 wxString
GetCellValue(const wxGridCellCoords
& coords
) const;
2036 Returns a pointer to the current default grid cell editor.
2038 See wxGridCellEditor and the @ref overview_grid for more information
2039 about cell editors and renderers.
2041 wxGridCellEditor
* GetDefaultEditor() const;
2044 Returns the default editor for the specified cell.
2046 The base class version returns the editor appropriate for the current
2047 cell type but this method may be overridden in the derived classes to
2048 use custom editors for some cells by default.
2050 Notice that the same may be achieved in a usually simpler way by
2051 associating a custom editor with the given cell or cells.
2053 The caller must call DecRef() on the returned pointer.
2055 virtual wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
2057 Returns the default editor for the specified cell.
2059 The base class version returns the editor appropriate for the current
2060 cell type but this method may be overridden in the derived classes to
2061 use custom editors for some cells by default.
2063 Notice that the same may be achieved in a usually simpler way by
2064 associating a custom editor with the given cell or cells.
2066 The caller must call DecRef() on the returned pointer.
2068 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const;
2071 Returns the default editor for the cells containing values of the given
2074 The base class version returns the editor which was associated with the
2075 specified @a typeName when it was registered RegisterDataType() but
2076 this function may be overridden to return something different. This
2077 allows to override an editor used for one of the standard types.
2079 The caller must call DecRef() on the returned pointer.
2081 virtual wxGridCellEditor
* GetDefaultEditorForType(const wxString
& typeName
) const;
2084 Returns a pointer to the current default grid cell renderer.
2086 See wxGridCellRenderer and the @ref overview_grid for more information
2087 about cell editors and renderers.
2089 The caller must call DecRef() on the returned pointer.
2091 wxGridCellRenderer
* GetDefaultRenderer() const;
2094 Returns the default renderer for the given cell.
2096 The base class version returns the renderer appropriate for the current
2097 cell type but this method may be overridden in the derived classes to
2098 use custom renderers for some cells by default.
2100 The caller must call DecRef() on the returned pointer.
2102 virtual wxGridCellRenderer
* GetDefaultRendererForCell(int row
, int col
) const;
2105 Returns the default renderer for the cell containing values of the
2108 @see GetDefaultEditorForType()
2110 virtual wxGridCellRenderer
* GetDefaultRendererForType(const wxString
& typeName
) const;
2113 Hides the in-place cell edit control.
2115 void HideCellEditControl();
2118 Returns @true if the in-place edit control is currently enabled.
2120 bool IsCellEditControlEnabled() const;
2123 Returns @true if the current cell is read-only.
2125 @see SetReadOnly(), IsReadOnly()
2127 bool IsCurrentCellReadOnly() const;
2130 Returns @false if the whole grid has been set as read-only or @true
2133 See EnableEditing() for more information about controlling the editing
2134 status of grid cells.
2136 bool IsEditable() const;
2139 Returns @true if the cell at the specified location can't be edited.
2141 @see SetReadOnly(), IsCurrentCellReadOnly()
2143 bool IsReadOnly(int row
, int col
) const;
2146 Register a new data type.
2148 The data types allow to naturally associate specific renderers and
2149 editors to the cells containing values of the given type. For example,
2150 the grid automatically registers a data type with the name
2151 @c wxGRID_VALUE_STRING which uses wxGridCellStringRenderer and
2152 wxGridCellTextEditor as its renderer and editor respectively -- this is
2153 the data type used by all the cells of the default wxGridStringTable,
2154 so this renderer and editor are used by default for all grid cells.
2156 However if a custom table returns @c wxGRID_VALUE_BOOL from its
2157 wxGridTableBase::GetTypeName() method, then wxGridCellBoolRenderer and
2158 wxGridCellBoolEditor are used for it because the grid also registers a
2159 boolean data type with this name.
2161 And as this mechanism is completely generic, you may register your own
2162 data types using your own custom renderers and editors. Just remember
2163 that the table must identify a cell as being of the given type for them
2164 to be used for this cell.
2167 Name of the new type. May be any string, but if the type name is
2168 the same as the name of an already registered type, including one
2169 of the standard ones (which are @c wxGRID_VALUE_STRING, @c
2170 wxGRID_VALUE_BOOL, @c wxGRID_VALUE_NUMBER, @c wxGRID_VALUE_FLOAT
2171 and @c wxGRID_VALUE_CHOICE), then the new registration information
2172 replaces the previously used renderer and editor.
2174 The renderer to use for the cells of this type. Its ownership is
2175 taken by the grid, i.e. it will call DecRef() on this pointer when
2176 it doesn't need it any longer.
2178 The editor to use for the cells of this type. Its ownership is also
2181 void RegisterDataType(const wxString
& typeName
,
2182 wxGridCellRenderer
* renderer
,
2183 wxGridCellEditor
* editor
);
2186 Sets the value of the current grid cell to the current in-place edit
2189 This is called automatically when the grid cursor moves from the
2190 current cell to a new cell. It is also a good idea to call this
2191 function when closing a grid since any edits to the final cell location
2192 will not be saved otherwise.
2194 void SaveEditControlValue();
2197 Sets the editor for the grid cell at the specified location.
2199 The grid will take ownership of the pointer.
2201 See wxGridCellEditor and the @ref overview_grid for more information
2202 about cell editors and renderers.
2204 void SetCellEditor(int row
, int col
, wxGridCellEditor
* editor
);
2207 Sets the renderer for the grid cell at the specified location.
2209 The grid will take ownership of the pointer.
2211 See wxGridCellRenderer and the @ref overview_grid for more information
2212 about cell editors and renderers.
2214 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
* renderer
);
2217 Sets the string value for the cell at the specified location.
2219 For simple applications where a grid object automatically uses a
2220 default grid table of string values you use this function together with
2221 GetCellValue() to access cell values. For more complex applications
2222 where you have derived your own grid table class that contains various
2223 data types (e.g. numeric, boolean or user-defined custom types) then
2224 you only use this function for those cells that contain string values.
2226 See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
2229 void SetCellValue(int row
, int col
, const wxString
& s
);
2231 Sets the string value for the cell at the specified location.
2233 For simple applications where a grid object automatically uses a
2234 default grid table of string values you use this function together with
2235 GetCellValue() to access cell values. For more complex applications
2236 where you have derived your own grid table class that contains various
2237 data types (e.g. numeric, boolean or user-defined custom types) then
2238 you only use this function for those cells that contain string values.
2240 See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
2243 void SetCellValue(const wxGridCellCoords
& coords
, const wxString
& s
);
2245 @deprecated Please use SetCellValue(int,int,const wxString&) or
2246 SetCellValue(const wxGridCellCoords&,const wxString&)
2249 Sets the string value for the cell at the specified location.
2251 For simple applications where a grid object automatically uses a
2252 default grid table of string values you use this function together with
2253 GetCellValue() to access cell values. For more complex applications
2254 where you have derived your own grid table class that contains various
2255 data types (e.g. numeric, boolean or user-defined custom types) then
2256 you only use this function for those cells that contain string values.
2258 See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
2261 void SetCellValue(const wxString
& val
, int row
, int col
);
2264 Sets the specified column to display boolean values.
2266 @see SetColFormatCustom()
2268 void SetColFormatBool(int col
);
2271 Sets the specified column to display data in a custom format.
2273 This method provides an alternative to defining a custom grid table
2274 which would return @a typeName from its GetTypeName() method for the
2275 cells in this column: while it doesn't really change the type of the
2276 cells in this column, it does associate the renderer and editor used
2277 for the cells of the specified type with them.
2279 See the @ref overview_grid for more information on working with custom
2282 void SetColFormatCustom(int col
, const wxString
& typeName
);
2285 Sets the specified column to display floating point values with the
2286 given width and precision.
2288 @see SetColFormatCustom()
2290 void SetColFormatFloat(int col
, int width
= -1, int precision
= -1);
2293 Sets the specified column to display integer values.
2295 @see SetColFormatCustom()
2297 void SetColFormatNumber(int col
);
2300 Sets the default editor for grid cells.
2302 The grid will take ownership of the pointer.
2304 See wxGridCellEditor and the @ref overview_grid for more information
2305 about cell editors and renderers.
2307 void SetDefaultEditor(wxGridCellEditor
* editor
);
2310 Sets the default renderer for grid cells.
2312 The grid will take ownership of the pointer.
2314 See wxGridCellRenderer and the @ref overview_grid for more information
2315 about cell editors and renderers.
2317 void SetDefaultRenderer(wxGridCellRenderer
* renderer
);
2320 Makes the cell at the specified location read-only or editable.
2324 void SetReadOnly(int row
, int col
, bool isReadOnly
= true);
2327 Displays the in-place cell edit control for the current cell.
2329 void ShowCellEditControl();
2335 @name Column and Row Sizes
2337 @see @ref overview_grid_resizing
2342 Automatically sets the height and width of all rows and columns to fit
2348 Automatically adjusts width of the column to fit its label.
2350 void AutoSizeColLabelSize(int col
);
2353 Automatically sizes the column to fit its contents. If @a setAsMin is
2354 @true the calculated width will also be set as the minimal width for
2357 void AutoSizeColumn(int col
, bool setAsMin
= true);
2360 Automatically sizes all columns to fit their contents. If @a setAsMin
2361 is @true the calculated widths will also be set as the minimal widths
2364 void AutoSizeColumns(bool setAsMin
= true);
2367 Automatically sizes the row to fit its contents. If @a setAsMin is
2368 @true the calculated height will also be set as the minimal height for
2371 void AutoSizeRow(int row
, bool setAsMin
= true);
2374 Automatically adjusts height of the row to fit its label.
2376 void AutoSizeRowLabelSize(int col
);
2379 Automatically sizes all rows to fit their contents. If @a setAsMin is
2380 @true the calculated heights will also be set as the minimal heights
2383 void AutoSizeRows(bool setAsMin
= true);
2386 Returns the current height of the column labels.
2388 int GetColLabelSize() const;
2391 Returns the minimal width to which a column may be resized.
2393 Use SetColMinimalAcceptableWidth() to change this value globally or
2394 SetColMinimalWidth() to do it for individual columns.
2396 @see GetRowMinimalAcceptableHeight()
2398 int GetColMinimalAcceptableWidth() const;
2401 Returns the width of the specified column.
2403 int GetColSize(int col
) const;
2406 Returns @true if the specified column is not currently hidden.
2408 bool IsColShown(int col
) const;
2411 Returns the default height for column labels.
2413 int GetDefaultColLabelSize() const;
2416 Returns the current default width for grid columns.
2418 int GetDefaultColSize() const;
2421 Returns the default width for the row labels.
2423 int GetDefaultRowLabelSize() const;
2426 Returns the current default height for grid rows.
2428 int GetDefaultRowSize() const;
2431 Returns the minimal size to which rows can be resized.
2433 Use SetRowMinimalAcceptableHeight() to change this value globally or
2434 SetRowMinimalHeight() to do it for individual cells.
2436 @see GetColMinimalAcceptableWidth()
2438 int GetRowMinimalAcceptableHeight() const;
2441 Returns the current width of the row labels.
2443 int GetRowLabelSize() const;
2446 Returns the height of the specified row.
2448 int GetRowSize(int row
) const;
2451 Returns @true if the specified row is not currently hidden.
2453 bool IsRowShown(int row
) const;
2456 Sets the height of the column labels.
2458 If @a height equals to @c wxGRID_AUTOSIZE then height is calculated
2459 automatically so that no label is truncated. Note that this could be
2460 slow for a large table.
2462 void SetColLabelSize(int height
);
2465 Sets the minimal @a width to which the user can resize columns.
2467 @see GetColMinimalAcceptableWidth()
2469 void SetColMinimalAcceptableWidth(int width
);
2472 Sets the minimal @a width for the specified column @a col.
2474 It is usually best to call this method during grid creation as calling
2475 it later will not resize the column to the given minimal width even if
2476 it is currently narrower than it.
2478 @a width must be greater than the minimal acceptable column width as
2479 returned by GetColMinimalAcceptableWidth().
2481 void SetColMinimalWidth(int col
, int width
);
2484 Sets the width of the specified column.
2489 The new column width in pixels, 0 to hide the column or -1 to fit
2490 the column width to its label width.
2492 void SetColSize(int col
, int width
);
2495 Hides the specified column.
2497 To show the column later you need to call SetColSize() with non-0
2503 void HideCol(int col
);
2506 Shows the previously hidden column by resizing it to non-0 size.
2508 @see HideCol(), SetColSize()
2510 void ShowCol(int col
);
2514 Sets the default width for columns in the grid.
2516 This will only affect columns subsequently added to the grid unless
2517 @a resizeExistingCols is @true.
2519 If @a width is less than GetColMinimalAcceptableWidth(), then the
2520 minimal acceptable width is used instead of it.
2522 void SetDefaultColSize(int width
, bool resizeExistingCols
= false);
2525 Sets the default height for rows in the grid.
2527 This will only affect rows subsequently added to the grid unless
2528 @a resizeExistingRows is @true.
2530 If @a height is less than GetRowMinimalAcceptableHeight(), then the
2531 minimal acceptable heihgt is used instead of it.
2533 void SetDefaultRowSize(int height
, bool resizeExistingRows
= false);
2536 Sets the width of the row labels.
2538 If @a width equals @c wxGRID_AUTOSIZE then width is calculated
2539 automatically so that no label is truncated. Note that this could be
2540 slow for a large table.
2542 void SetRowLabelSize(int width
);
2545 Sets the minimal row @a height used by default.
2547 See SetColMinimalAcceptableWidth() for more information.
2549 void SetRowMinimalAcceptableHeight(int height
);
2552 Sets the minimal @a height for the specified @a row.
2554 See SetColMinimalWidth() for more information.
2556 void SetRowMinimalHeight(int row
, int height
);
2559 Sets the height of the specified row.
2561 See SetColSize() for more information.
2563 void SetRowSize(int row
, int height
);
2566 Hides the specified row.
2568 To show the row later you need to call SetRowSize() with non-0
2574 void HideRow(int col
);
2577 Shows the previously hidden row by resizing it to non-0 size.
2579 @see HideRow(), SetRowSize()
2581 void ShowRow(int col
);
2584 Get size information for all columns at once.
2586 This method is useful when the information about all column widths
2587 needs to be saved. The widths can be later restored using
2590 @sa wxGridSizesInfo, GetRowSizes()
2592 wxGridSizesInfo
GetColSizes() const;
2595 Get size information for all row at once.
2597 @sa wxGridSizesInfo, GetColSizes()
2599 wxGridSizesInfo
GetRowSizes() const;
2602 Restore all columns sizes.
2604 This is usually called with wxGridSizesInfo object previously returned
2609 void SetColSizes(const wxGridSizesInfo
& sizeInfo
);
2612 Restore all rows sizes.
2616 void SetRowSizes(const wxGridSizesInfo
& sizeInfo
);
2622 @name User-Resizing and Dragging
2624 Functions controlling various interactive mouse operations.
2626 By default, columns and rows can be resized by dragging the edges of
2627 their labels (this can be disabled using DisableDragColSize() and
2628 DisableDragRowSize() methods). And if grid line dragging is enabled with
2629 EnableDragGridSize() they can also be resized by dragging the right or
2630 bottom edge of the grid cells.
2632 Columns can also be moved to interactively change their order but this
2633 needs to be explicitly enabled with EnableDragColMove().
2638 Return @true if the dragging of cells is enabled or @false otherwise.
2640 bool CanDragCell() const;
2643 Returns @true if columns can be moved by dragging with the mouse.
2645 Columns can be moved by dragging on their labels.
2647 bool CanDragColMove() const;
2650 Returns @true if the given column can be resized by dragging with the
2653 This function returns @true if resizing the columns interactively is
2654 globally enabled, i.e. if DisableDragColSize() hadn't been called, and
2655 if this column wasn't explicitly marked as non-resizable with
2658 bool CanDragColSize(int col
) const;
2661 Return @true if the dragging of grid lines to resize rows and columns
2662 is enabled or @false otherwise.
2664 bool CanDragGridSize() const;
2667 Returns @true if the given row can be resized by dragging with the
2670 This is the same as CanDragColSize() but for rows.
2672 bool CanDragRowSize(int row
) const;
2675 Disable interactive resizing of the specified column.
2677 This method allows to disable resizing of an individual column in a
2678 grid where the columns are otherwise resizable (which is the case by
2681 Notice that currently there is no way to make some columns resizable in
2682 a grid where columns can't be resized by default as there doesn't seem
2683 to be any need for this in practice. There is also no way to make the
2684 column marked as fixed using this method resizeable again because it is
2685 supposed that fixed columns are used for static parts of the grid and
2686 so should remain fixed during the entire grid lifetime.
2688 Also notice that disabling interactive column resizing will not prevent
2689 the program from changing the column size.
2691 @see EnableDragColSize()
2693 void DisableColResize(int col
);
2696 Disable interactive resizing of the specified row.
2698 This is the same as DisableColResize() but for rows.
2700 @see EnableDragRowSize()
2702 void DisableRowResize(int row
);
2705 Disables column moving by dragging with the mouse.
2707 Equivalent to passing @false to EnableDragColMove().
2709 void DisableDragColMove();
2712 Disables column sizing by dragging with the mouse.
2714 Equivalent to passing @false to EnableDragColSize().
2716 void DisableDragColSize();
2719 Disable mouse dragging of grid lines to resize rows and columns.
2721 Equivalent to passing @false to EnableDragGridSize()
2723 void DisableDragGridSize();
2726 Disables row sizing by dragging with the mouse.
2728 Equivalent to passing @false to EnableDragRowSize().
2730 void DisableDragRowSize();
2733 Enables or disables cell dragging with the mouse.
2735 void EnableDragCell(bool enable
= true);
2738 Enables or disables column moving by dragging with the mouse.
2740 void EnableDragColMove(bool enable
= true);
2743 Enables or disables column sizing by dragging with the mouse.
2745 @see DisableColResize()
2747 void EnableDragColSize(bool enable
= true);
2750 Enables or disables row and column resizing by dragging gridlines with
2753 void EnableDragGridSize(bool enable
= true);
2756 Enables or disables row sizing by dragging with the mouse.
2758 @see DisableRowResize()
2760 void EnableDragRowSize(bool enable
= true);
2763 Returns the column ID of the specified column position.
2765 int GetColAt(int colPos
) const;
2768 Returns the position of the specified column.
2770 int GetColPos(int colID
) const;
2773 Sets the position of the specified column.
2775 void SetColPos(int colID
, int newPos
);
2778 Sets the positions of all columns at once.
2780 This method takes an array containing the indices of the columns in
2781 their display order, i.e. uses the same convention as
2782 wxHeaderCtrl::SetColumnsOrder().
2784 void SetColumnsOrder(const wxArrayInt
& order
);
2787 Resets the position of the columns to the default.
2795 @name Cursor Movement
2800 Returns the current grid cell column position.
2802 int GetGridCursorCol() const;
2805 Returns the current grid cell row position.
2807 int GetGridCursorRow() const;
2810 Make the given cell current and ensure it is visible.
2812 This method is equivalent to calling MakeCellVisible() and
2813 SetGridCursor() and so, as with the latter, a @c wxEVT_GRID_SELECT_CELL
2814 event is generated by it and the selected cell doesn't change if the
2817 void GoToCell(int row
, int col
);
2819 Make the given cell current and ensure it is visible.
2821 This method is equivalent to calling MakeCellVisible() and
2822 SetGridCursor() and so, as with the latter, a @c wxEVT_GRID_SELECT_CELL
2823 event is generated by it and the selected cell doesn't change if the
2826 void GoToCell(const wxGridCellCoords
& coords
);
2829 Moves the grid cursor down by one row.
2831 If a block of cells was previously selected it will expand if the
2832 argument is @true or be cleared if the argument is @false.
2834 bool MoveCursorDown(bool expandSelection
);
2837 Moves the grid cursor down in the current column such that it skips to
2838 the beginning or end of a block of non-empty cells.
2840 If a block of cells was previously selected it will expand if the
2841 argument is @true or be cleared if the argument is @false.
2843 bool MoveCursorDownBlock(bool expandSelection
);
2846 Moves the grid cursor left by one column.
2848 If a block of cells was previously selected it will expand if the
2849 argument is @true or be cleared if the argument is @false.
2851 bool MoveCursorLeft(bool expandSelection
);
2854 Moves the grid cursor left in the current row such that it skips to the
2855 beginning or end of a block of non-empty cells.
2857 If a block of cells was previously selected it will expand if the
2858 argument is @true or be cleared if the argument is @false.
2860 bool MoveCursorLeftBlock(bool expandSelection
);
2863 Moves the grid cursor right by one column.
2865 If a block of cells was previously selected it will expand if the
2866 argument is @true or be cleared if the argument is @false.
2868 bool MoveCursorRight(bool expandSelection
);
2871 Moves the grid cursor right in the current row such that it skips to
2872 the beginning or end of a block of non-empty cells.
2874 If a block of cells was previously selected it will expand if the
2875 argument is @true or be cleared if the argument is @false.
2877 bool MoveCursorRightBlock(bool expandSelection
);
2880 Moves the grid cursor up by one row.
2882 If a block of cells was previously selected it will expand if the
2883 argument is @true or be cleared if the argument is @false.
2885 bool MoveCursorUp(bool expandSelection
);
2888 Moves the grid cursor up in the current column such that it skips to
2889 the beginning or end of a block of non-empty cells.
2891 If a block of cells was previously selected it will expand if the
2892 argument is @true or be cleared if the argument is @false.
2894 bool MoveCursorUpBlock(bool expandSelection
);
2897 Moves the grid cursor down by some number of rows so that the previous
2898 bottom visible row becomes the top visible row.
2900 bool MovePageDown();
2903 Moves the grid cursor up by some number of rows so that the previous
2904 top visible row becomes the bottom visible row.
2909 Set the grid cursor to the specified cell.
2911 The grid cursor indicates the current cell and can be moved by the user
2912 using the arrow keys or the mouse.
2914 Calling this function generates a @c wxEVT_GRID_SELECT_CELL event and
2915 if the event handler vetoes this event, the cursor is not moved.
2917 This function doesn't make the target call visible, use GoToCell() to
2920 void SetGridCursor(int row
, int col
);
2922 Set the grid cursor to the specified cell.
2924 The grid cursor indicates the current cell and can be moved by the user
2925 using the arrow keys or the mouse.
2927 Calling this function generates a @c wxEVT_GRID_SELECT_CELL event and
2928 if the event handler vetoes this event, the cursor is not moved.
2930 This function doesn't make the target call visible, use GoToCell() to
2933 void SetGridCursor(const wxGridCellCoords
& coords
);
2939 @name User Selection
2944 Deselects all cells that are currently selected.
2946 void ClearSelection();
2949 Returns an array of individually selected cells.
2951 Notice that this array does @em not contain all the selected cells in
2952 general as it doesn't include the cells selected as part of column, row
2953 or block selection. You must use this method, GetSelectedCols(),
2954 GetSelectedRows() and GetSelectionBlockTopLeft() and
2955 GetSelectionBlockBottomRight() methods to obtain the entire selection
2958 Please notice this behaviour is by design and is needed in order to
2959 support grids of arbitrary size (when an entire column is selected in
2960 a grid with a million of columns, we don't want to create an array with
2961 a million of entries in this function, instead it returns an empty
2962 array and GetSelectedCols() returns an array containing one element).
2964 wxGridCellCoordsArray
GetSelectedCells() const;
2967 Returns an array of selected columns.
2969 Please notice that this method alone is not sufficient to find all the
2970 selected columns as it contains only the columns which were
2971 individually selected but not those being part of the block selection
2972 or being selected in virtue of all of their cells being selected
2973 individually, please see GetSelectedCells() for more details.
2975 wxArrayInt
GetSelectedCols() const;
2978 Returns an array of selected rows.
2980 Please notice that this method alone is not sufficient to find all the
2981 selected rows as it contains only the rows which were individually
2982 selected but not those being part of the block selection or being
2983 selected in virtue of all of their cells being selected individually,
2984 please see GetSelectedCells() for more details.
2986 wxArrayInt
GetSelectedRows() const;
2989 Returns the colour used for drawing the selection background.
2991 wxColour
GetSelectionBackground() const;
2994 Returns an array of the bottom right corners of blocks of selected
2997 Please see GetSelectedCells() for more information about the selection
2998 representation in wxGrid.
3000 @see GetSelectionBlockTopLeft()
3002 wxGridCellCoordsArray
GetSelectionBlockBottomRight() const;
3005 Returns an array of the top left corners of blocks of selected cells.
3007 Please see GetSelectedCells() for more information about the selection
3008 representation in wxGrid.
3010 @see GetSelectionBlockBottomRight()
3012 wxGridCellCoordsArray
GetSelectionBlockTopLeft() const;
3015 Returns the colour used for drawing the selection foreground.
3017 wxColour
GetSelectionForeground() const;
3020 Returns the current selection mode.
3022 @see SetSelectionMode().
3024 wxGridSelectionModes
GetSelectionMode() const;
3027 Returns @true if the given cell is selected.
3029 bool IsInSelection(int row
, int col
) const;
3031 Returns @true if the given cell is selected.
3033 bool IsInSelection(const wxGridCellCoords
& coords
) const;
3036 Returns @true if there are currently any selected cells, rows, columns
3039 bool IsSelection() const;
3042 Selects all cells in the grid.
3047 Selects a rectangular block of cells.
3049 If @a addToSelected is @false then any existing selection will be
3050 deselected; if @true the column will be added to the existing
3053 void SelectBlock(int topRow
, int leftCol
, int bottomRow
, int rightCol
,
3054 bool addToSelected
= false);
3056 Selects a rectangular block of cells.
3058 If @a addToSelected is @false then any existing selection will be
3059 deselected; if @true the column will be added to the existing
3062 void SelectBlock(const wxGridCellCoords
& topLeft
,
3063 const wxGridCellCoords
& bottomRight
,
3064 bool addToSelected
= false);
3067 Selects the specified column.
3069 If @a addToSelected is @false then any existing selection will be
3070 deselected; if @true the column will be added to the existing
3073 This method won't select anything if the current selection mode is
3076 void SelectCol(int col
, bool addToSelected
= false);
3079 Selects the specified row.
3081 If @a addToSelected is @false then any existing selection will be
3082 deselected; if @true the row will be added to the existing selection.
3084 This method won't select anything if the current selection mode is
3085 wxGridSelectColumns.
3087 void SelectRow(int row
, bool addToSelected
= false);
3090 Set the colour to be used for drawing the selection background.
3092 void SetSelectionBackground(const wxColour
& c
);
3095 Set the colour to be used for drawing the selection foreground.
3097 void SetSelectionForeground(const wxColour
& c
);
3100 Set the selection behaviour of the grid.
3102 The existing selection is converted to conform to the new mode if
3103 possible and discarded otherwise (e.g. any individual selected cells
3104 are deselected if the new mode allows only the selection of the entire
3107 void SetSelectionMode(wxGridSelectionModes selmode
);
3118 Returns the number of pixels per horizontal scroll increment.
3122 @see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
3124 int GetScrollLineX() const;
3127 Returns the number of pixels per vertical scroll increment.
3131 @see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
3133 int GetScrollLineY() const;
3136 Returns @true if a cell is either entirely or at least partially
3137 visible in the grid window.
3139 By default, the cell must be entirely visible for this function to
3140 return @true but if @a wholeCellVisible is @false, the function returns
3141 @true even if the cell is only partially visible.
3143 bool IsVisible(int row
, int col
, bool wholeCellVisible
= true) const;
3145 Returns @true if a cell is either entirely or at least partially
3146 visible in the grid window.
3148 By default, the cell must be entirely visible for this function to
3149 return @true but if @a wholeCellVisible is @false, the function returns
3150 @true even if the cell is only partially visible.
3152 bool IsVisible(const wxGridCellCoords
& coords
,
3153 bool wholeCellVisible
= true) const;
3156 Brings the specified cell into the visible grid cell area with minimal
3159 Does nothing if the cell is already visible.
3161 void MakeCellVisible(int row
, int col
);
3163 Brings the specified cell into the visible grid cell area with minimal
3166 Does nothing if the cell is already visible.
3168 void MakeCellVisible(const wxGridCellCoords
& coords
);
3171 Sets the number of pixels per horizontal scroll increment.
3175 @see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
3177 void SetScrollLineX(int x
);
3180 Sets the number of pixels per vertical scroll increment.
3184 @see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
3186 void SetScrollLineY(int y
);
3192 @name Cell and Device Coordinate Translation
3197 Convert grid cell coordinates to grid window pixel coordinates.
3199 This function returns the rectangle that encloses the block of cells
3200 limited by @a topLeft and @a bottomRight cell in device coords and
3201 clipped to the client size of the grid window.
3205 wxRect
BlockToDeviceRect(const wxGridCellCoords
& topLeft
,
3206 const wxGridCellCoords
& bottomRight
) const;
3209 Return the rectangle corresponding to the grid cell's size and position
3210 in logical coordinates.
3212 @see BlockToDeviceRect()
3214 wxRect
CellToRect(int row
, int col
) const;
3216 Return the rectangle corresponding to the grid cell's size and position
3217 in logical coordinates.
3219 @see BlockToDeviceRect()
3221 wxRect
CellToRect(const wxGridCellCoords
& coords
) const;
3224 Returns the column at the given pixel position.
3227 The x position to evaluate.
3229 If @true, rather than returning @c wxNOT_FOUND, it returns either
3230 the first or last column depending on whether @a x is too far to
3231 the left or right respectively.
3233 The column index or @c wxNOT_FOUND.
3235 int XToCol(int x
, bool clipToMinMax
= false) const;
3238 Returns the column whose right hand edge is close to the given logical
3241 If no column edge is near to this position @c wxNOT_FOUND is returned.
3243 int XToEdgeOfCol(int x
) const;
3246 Translates logical pixel coordinates to the grid cell coordinates.
3248 Notice that this function expects logical coordinates on input so if
3249 you use this function in a mouse event handler you need to translate
3250 the mouse position, which is expressed in device coordinates, to
3253 @see XToCol(), YToRow()
3255 wxGridCellCoords
XYToCell(int x
, int y
) const;
3257 Translates logical pixel coordinates to the grid cell coordinates.
3259 Notice that this function expects logical coordinates on input so if
3260 you use this function in a mouse event handler you need to translate
3261 the mouse position, which is expressed in device coordinates, to
3264 @see XToCol(), YToRow()
3266 wxGridCellCoords
XYToCell(const wxPoint
& pos
) const;
3267 // XYToCell(int, int, wxGridCellCoords&) overload is intentionally
3268 // undocumented, using it is ugly and non-const reference parameters are
3269 // not used in wxWidgets API
3272 Returns the row whose bottom edge is close to the given logical @a y
3275 If no row edge is near to this position @c wxNOT_FOUND is returned.
3277 int YToEdgeOfRow(int y
) const;
3280 Returns the grid row that corresponds to the logical @a y coordinate.
3282 Returns @c wxNOT_FOUND if there is no row at the @a y position.
3284 int YToRow(int y
, bool clipToMinMax
= false) const;
3290 @name Miscellaneous Functions
3295 Appends one or more new columns to the right of the grid.
3297 The @a updateLabels argument is not used at present. If you are using a
3298 derived grid table class you will need to override
3299 wxGridTableBase::AppendCols(). See InsertCols() for further
3302 @return @true on success or @false if appending columns failed.
3304 bool AppendCols(int numCols
= 1, bool updateLabels
= true);
3307 Appends one or more new rows to the bottom of the grid.
3309 The @a updateLabels argument is not used at present. If you are using a
3310 derived grid table class you will need to override
3311 wxGridTableBase::AppendRows(). See InsertRows() for further
3314 @return @true on success or @false if appending rows failed.
3316 bool AppendRows(int numRows
= 1, bool updateLabels
= true);
3319 Return @true if the horizontal grid lines stop at the last column
3320 boundary or @false if they continue to the end of the window.
3322 The default is to clip grid lines.
3324 @see ClipHorzGridLines(), AreVertGridLinesClipped()
3326 bool AreHorzGridLinesClipped() const;
3329 Return @true if the vertical grid lines stop at the last row
3330 boundary or @false if they continue to the end of the window.
3332 The default is to clip grid lines.
3334 @see ClipVertGridLines(), AreHorzGridLinesClipped()
3336 bool AreVertGridLinesClipped() const;
3339 Increments the grid's batch count.
3341 When the count is greater than zero repainting of the grid is
3342 suppressed. Each call to BeginBatch must be matched by a later call to
3343 EndBatch(). Code that does a lot of grid modification can be enclosed
3344 between BeginBatch() and EndBatch() calls to avoid screen flicker. The
3345 final EndBatch() call will cause the grid to be repainted.
3347 Notice that you should use wxGridUpdateLocker which ensures that there
3348 is always a matching EndBatch() call for this BeginBatch() if possible
3349 instead of calling this method directly.
3354 Clears all data in the underlying grid table and repaints the grid.
3356 The table is not deleted by this function. If you are using a derived
3357 table class then you need to override wxGridTableBase::Clear() for this
3358 function to have any effect.
3363 Change whether the horizontal grid lines are clipped by the end of the
3366 By default the grid lines are not drawn beyond the end of the last
3367 column but after calling this function with @a clip set to @false they
3368 will be drawn across the entire grid window.
3370 @see AreHorzGridLinesClipped(), ClipVertGridLines()
3372 void ClipHorzGridLines(bool clip
);
3375 Change whether the vertical grid lines are clipped by the end of the
3378 By default the grid lines are not drawn beyond the end of the last
3379 row but after calling this function with @a clip set to @false they
3380 will be drawn across the entire grid window.
3382 @see AreVertGridLinesClipped(), ClipHorzGridLines()
3384 void ClipVertGridLines(bool clip
);
3387 Deletes one or more columns from a grid starting at the specified
3390 The @a updateLabels argument is not used at present. If you are using a
3391 derived grid table class you will need to override
3392 wxGridTableBase::DeleteCols(). See InsertCols() for further
3395 @return @true on success or @false if deleting columns failed.
3397 bool DeleteCols(int pos
= 0, int numCols
= 1, bool updateLabels
= true);
3400 Deletes one or more rows from a grid starting at the specified
3403 The @a updateLabels argument is not used at present. If you are using a
3404 derived grid table class you will need to override
3405 wxGridTableBase::DeleteRows(). See InsertRows() for further
3408 @return @true on success or @false if appending rows failed.
3410 bool DeleteRows(int pos
= 0, int numRows
= 1, bool updateLabels
= true);
3413 Decrements the grid's batch count.
3415 When the count is greater than zero repainting of the grid is
3416 suppressed. Each previous call to BeginBatch() must be matched by a
3417 later call to EndBatch(). Code that does a lot of grid modification can
3418 be enclosed between BeginBatch() and EndBatch() calls to avoid screen
3419 flicker. The final EndBatch() will cause the grid to be repainted.
3421 @see wxGridUpdateLocker
3426 Overridden wxWindow method.
3431 Causes immediate repainting of the grid.
3433 Use this instead of the usual wxWindow::Refresh().
3435 void ForceRefresh();
3438 Returns the number of times that BeginBatch() has been called without
3439 (yet) matching calls to EndBatch(). While the grid's batch count is
3440 greater than zero the display will not be updated.
3442 int GetBatchCount();
3445 Returns the total number of grid columns.
3447 This is the same as the number of columns in the underlying grid table.
3449 int GetNumberCols() const;
3452 Returns the total number of grid rows.
3454 This is the same as the number of rows in the underlying grid table.
3456 int GetNumberRows() const;
3459 Returns the attribute for the given cell creating one if necessary.
3461 If the cell already has an attribute, it is returned. Otherwise a new
3462 attribute is created, associated with the cell and returned. In any
3463 case the caller must call DecRef() on the returned pointer.
3465 This function may only be called if CanHaveAttributes() returns @true.
3467 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
3470 Returns a base pointer to the current table object.
3472 The returned pointer is still owned by the grid.
3474 wxGridTableBase
*GetTable() const;
3477 Inserts one or more new columns into a grid with the first new column
3478 at the specified position.
3480 Notice that inserting the columns in the grid requires grid table
3481 cooperation: when this method is called, grid object begins by
3482 requesting the underlying grid table to insert new columns. If this is
3483 successful the table notifies the grid and the grid updates the
3484 display. For a default grid (one where you have called CreateGrid())
3485 this process is automatic. If you are using a custom grid table
3486 (specified with SetTable()) then you must override
3487 wxGridTableBase::InsertCols() in your derived table class.
3490 The position which the first newly inserted column will have.
3492 The number of columns to insert.
3496 @true if the columns were successfully inserted, @false if an error
3497 occurred (most likely the table couldn't be updated).
3499 bool InsertCols(int pos
= 0, int numCols
= 1, bool updateLabels
= true);
3502 Inserts one or more new rows into a grid with the first new row at the
3505 Notice that you must implement wxGridTableBase::InsertRows() if you use
3506 a grid with a custom table, please see InsertCols() for more
3510 The position which the first newly inserted row will have.
3512 The number of rows to insert.
3516 @true if the rows were successfully inserted, @false if an error
3517 occurred (most likely the table couldn't be updated).
3519 bool InsertRows(int pos
= 0, int numRows
= 1, bool updateLabels
= true);
3522 Sets the cell attributes for all cells in the specified column.
3524 For more information about controlling grid cell attributes see the
3525 wxGridCellAttr cell attribute class and the @ref overview_grid.
3527 void SetColAttr(int col
, wxGridCellAttr
* attr
);
3530 Sets the extra margins used around the grid area.
3532 A grid may occupy more space than needed for its data display and
3533 this function allows to set how big this extra space is
3535 void SetMargins(int extraWidth
, int extraHeight
);
3538 Sets the cell attributes for all cells in the specified row.
3540 The grid takes ownership of the attribute pointer.
3542 See the wxGridCellAttr class for more information about controlling
3545 void SetRowAttr(int row
, wxGridCellAttr
* attr
);
3551 @name Sorting support.
3553 wxGrid doesn't provide any support for sorting the data but it does
3554 generate events allowing the user code to sort it and supports
3555 displaying the sort indicator in the column used for sorting.
3557 To use wxGrid sorting support you need to handle wxEVT_GRID_COL_SORT
3558 event (and not veto it) and resort the data displayed in the grid. The
3559 grid will automatically update the sorting indicator on the column
3562 You can also call the functions in this section directly to update the
3563 sorting indicator. Once again, they don't do anything with the grid
3564 data, it remains your responsibility to actually sort it appropriately.
3569 Return the column in which the sorting indicator is currently
3572 Returns @c wxNOT_FOUND if sorting indicator is not currently displayed
3575 @see SetSortingColumn()
3577 int GetSortingColumn() const;
3580 Return @true if this column is currently used for sorting.
3582 @see GetSortingColumn()
3584 bool IsSortingBy(int col
) const;
3587 Return @true if the current sorting order is ascending or @false if it
3590 It only makes sense to call this function if GetSortingColumn() returns
3591 a valid column index and not @c wxNOT_FOUND.
3593 @see SetSortingColumn()
3595 bool IsSortOrderAscending() const;
3598 Set the column to display the sorting indicator in and its direction.
3601 The column to display the sorting indicator in or @c wxNOT_FOUND to
3602 remove any currently displayed sorting indicator.
3604 If @true, display the ascending sort indicator, otherwise display
3605 the descending sort indicator.
3607 @see GetSortingColumn(), IsSortOrderAscending()
3609 void SetSortingColumn(int col
, bool ascending
= true);
3612 Remove any currently shown sorting indicator.
3614 This is equivalent to calling SetSortingColumn() with @c wxNOT_FOUND
3617 void UnsetSortingColumn();
3622 @name Accessors for component windows.
3624 Return the various child windows of wxGrid.
3626 wxGrid is an empty parent window for 4 children representing the column
3627 labels window (top), the row labels window (left), the corner window
3628 (top left) and the main grid window. It may be necessary to use these
3629 individual windows and not the wxGrid window itself if you need to
3630 handle events for them (this can be done using wxEvtHandler::Connect()
3631 or wxWindow::PushEventHandler()) or do something else requiring the use
3632 of the correct window pointer. Notice that you should not, however,
3633 change these windows (e.g. reposition them or draw over them) because
3634 they are managed by wxGrid itself.
3639 Return the main grid window containing the grid cells.
3641 This window is always shown.
3643 wxWindow
*GetGridWindow() const;
3646 Return the row labels window.
3648 This window is not shown if the row labels were hidden using
3651 wxWindow
*GetGridRowLabelWindow() const;
3654 Return the column labels window.
3656 This window is not shown if the columns labels were hidden using
3659 Depending on whether UseNativeColHeader() was called or not this can be
3660 either a wxHeaderCtrl or a plain wxWindow. This function returns a valid
3661 window pointer in either case but in the former case you can also use
3662 GetGridColHeader() to access it if you need wxHeaderCtrl-specific
3665 wxWindow
*GetGridColLabelWindow() const;
3668 Return the window in the top left grid corner.
3670 This window is shown only of both columns and row labels are shown and
3671 normally doesn't contain anything. Clicking on it is handled by wxGrid
3672 however and can be used to select the entire grid.
3674 wxWindow
*GetGridCornerLabelWindow() const;
3677 Return the header control used for column labels display.
3679 This function can only be called if UseNativeColHeader() had been
3682 wxHeaderCtrl
*GetGridColHeader() const;
3688 Returns @true if this grid has support for cell attributes.
3690 The grid supports attributes if it has the associated table which, in
3691 turn, has attributes support, i.e. wxGridTableBase::CanHaveAttributes()
3694 bool CanHaveAttributes() const;
3697 Get the minimal width of the given column/row.
3699 The value returned by this function may be different than that returned
3700 by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
3701 called for this column.
3703 int GetColMinimalWidth(int col
) const;
3706 Returns the coordinate of the right border specified column.
3708 int GetColRight(int col
) const;
3711 Returns the coordinate of the left border specified column.
3713 int GetColLeft(int col
) const;
3716 Returns the minimal size for the given column.
3718 The value returned by this function may be different than that returned
3719 by GetRowMinimalAcceptableHeight() if SetRowMinimalHeight() had been
3720 called for this row.
3722 int GetRowMinimalHeight(int col
) const;
3728 @class wxGridUpdateLocker
3730 This small class can be used to prevent wxGrid from redrawing during its
3731 lifetime by calling wxGrid::BeginBatch() in its constructor and
3732 wxGrid::EndBatch() in its destructor. It is typically used in a function
3733 performing several operations with a grid which would otherwise result in
3734 flicker. For example:
3739 m_grid = new wxGrid(this, ...);
3741 wxGridUpdateLocker noUpdates(m_grid);
3742 m_grid-AppendColumn();
3743 // ... many other operations with m_grid ...
3746 // destructor called, grid refreshed
3750 Using this class is easier and safer than calling wxGrid::BeginBatch() and
3751 wxGrid::EndBatch() because you don't risk missing the call the latter (due
3752 to an exception for example).
3757 class wxGridUpdateLocker
3761 Creates an object preventing the updates of the specified @a grid. The
3762 parameter could be @NULL in which case nothing is done. If @a grid is
3763 non-@NULL then the grid must exist for longer than this
3764 wxGridUpdateLocker object itself.
3766 The default constructor could be followed by a call to Create() to set
3767 the grid object later.
3769 wxGridUpdateLocker(wxGrid
* grid
= NULL
);
3772 Destructor reenables updates for the grid this object is associated
3775 ~wxGridUpdateLocker();
3778 This method can be called if the object had been constructed using the
3779 default constructor. It must not be called more than once.
3781 void Create(wxGrid
* grid
);
3789 This event class contains information about various grid events.
3791 Notice that all grid event table macros are available in two versions:
3792 @c EVT_GRID_XXX and @c EVT_GRID_CMD_XXX. The only difference between the
3793 two is that the former doesn't allow to specify the grid window identifier
3794 and so takes a single parameter, the event handler, but is not suitable if
3795 there is more than one grid control in the window where the event table is
3796 used (as it would catch the events from all the grids). The version with @c
3797 CMD takes the id as first argument and the event handler as the second one
3798 and so can be used with multiple grids as well. Otherwise there are no
3799 difference between the two and only the versions without the id are
3800 documented below for brevity.
3802 @beginEventTable{wxGridEvent}
3803 @event{EVT_GRID_CELL_CHANGING(func)}
3804 The user is about to change the data in a cell. The new cell value as
3805 string is available from GetString() event object method. This event
3806 can be vetoed if the change is not allowed.
3807 Processes a @c wxEVT_GRID_CELL_CHANGING event type.
3808 @event{EVT_GRID_CELL_CHANGED(func)}
3809 The user changed the data in a cell. The old cell value as string is
3810 available from GetString() event object method. Notice that vetoing
3811 this event still works for backwards compatibility reasons but any new
3812 code should only veto EVT_GRID_CELL_CHANGING event and not this one.
3813 Processes a @c wxEVT_GRID_CELL_CHANGED event type.
3814 @event{EVT_GRID_CELL_LEFT_CLICK(func)}
3815 The user clicked a cell with the left mouse button. Processes a
3816 @c wxEVT_GRID_CELL_LEFT_CLICK event type.
3817 @event{EVT_GRID_CELL_LEFT_DCLICK(func)}
3818 The user double-clicked a cell with the left mouse button. Processes a
3819 @c wxEVT_GRID_CELL_LEFT_DCLICK event type.
3820 @event{EVT_GRID_CELL_RIGHT_CLICK(func)}
3821 The user clicked a cell with the right mouse button. Processes a
3822 @c wxEVT_GRID_CELL_RIGHT_CLICK event type.
3823 @event{EVT_GRID_CELL_RIGHT_DCLICK(func)}
3824 The user double-clicked a cell with the right mouse button. Processes a
3825 @c wxEVT_GRID_CELL_RIGHT_DCLICK event type.
3826 @event{EVT_GRID_EDITOR_HIDDEN(func)}
3827 The editor for a cell was hidden. Processes a
3828 @c wxEVT_GRID_EDITOR_HIDDEN event type.
3829 @event{EVT_GRID_EDITOR_SHOWN(func)}
3830 The editor for a cell was shown. Processes a
3831 @c wxEVT_GRID_EDITOR_SHOWN event type.
3832 @event{EVT_GRID_LABEL_LEFT_CLICK(func)}
3833 The user clicked a label with the left mouse button. Processes a
3834 @c wxEVT_GRID_LABEL_LEFT_CLICK event type.
3835 @event{EVT_GRID_LABEL_LEFT_DCLICK(func)}
3836 The user double-clicked a label with the left mouse button. Processes a
3837 @c wxEVT_GRID_LABEL_LEFT_DCLICK event type.
3838 @event{EVT_GRID_LABEL_RIGHT_CLICK(func)}
3839 The user clicked a label with the right mouse button. Processes a
3840 @c wxEVT_GRID_LABEL_RIGHT_CLICK event type.
3841 @event{EVT_GRID_LABEL_RIGHT_DCLICK(func)}
3842 The user double-clicked a label with the right mouse button. Processes
3843 a @c wxEVT_GRID_LABEL_RIGHT_DCLICK event type.
3844 @event{EVT_GRID_SELECT_CELL(func)}
3845 The given cell was made current, either by user or by the program via a
3846 call to SetGridCursor() or GoToCell(). Processes a
3847 @c wxEVT_GRID_SELECT_CELL event type.
3848 @event{EVT_GRID_COL_MOVE(func)}
3849 The user tries to change the order of the columns in the grid by
3850 dragging the column specified by GetCol(). This event can be vetoed to
3851 either prevent the user from reordering the column change completely
3852 (but notice that if you don't want to allow it at all, you simply
3853 shouldn't call wxGrid::EnableDragColMove() in the first place), vetoed
3854 but handled in some way in the handler, e.g. by really moving the
3855 column to the new position at the associated table level, or allowed to
3856 proceed in which case wxGrid::SetColPos() is used to reorder the
3857 columns display order without affecting the use of the column indices
3859 This event macro corresponds to @c wxEVT_GRID_COL_MOVE event type.
3860 @event{EVT_GRID_COL_SORT(func)}
3861 This event is generated when a column is clicked by the user and its
3862 name is explained by the fact that the custom reaction to a click on a
3863 column is to sort the grid contents by this column. However the grid
3864 itself has no special support for sorting and it's up to the handler of
3865 this event to update the associated table. But if the event is handled
3866 (and not vetoed) the grid supposes that the table was indeed resorted
3867 and updates the column to indicate the new sort order and refreshes
3869 This event macro corresponds to @c wxEVT_GRID_COL_SORT event type.
3873 @category{grid,events}
3875 class wxGridEvent
: public wxNotifyEvent
3879 Default constructor.
3883 Constructor for initializing all event attributes.
3885 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
3886 int row
= -1, int col
= -1, int x
= -1, int y
= -1,
3887 bool sel
= true, const wxKeyboardState
& kbd
= wxKeyboardState());
3890 Returns @true if the Alt key was down at the time of the event.
3892 bool AltDown() const;
3895 Returns @true if the Control key was down at the time of the event.
3897 bool ControlDown() const;
3900 Column at which the event occurred.
3902 virtual int GetCol();
3905 Position in pixels at which the event occurred.
3907 wxPoint
GetPosition();
3910 Row at which the event occurred.
3912 virtual int GetRow();
3915 Returns @true if the Meta key was down at the time of the event.
3917 bool MetaDown() const;
3920 Returns @true if the user is selecting grid cells, or @false if
3926 Returns @true if the Shift key was down at the time of the event.
3928 bool ShiftDown() const;
3934 @class wxGridSizeEvent
3936 This event class contains information about a row/column resize event.
3938 @beginEventTable{wxGridSizeEvent}
3939 @event{EVT_GRID_CMD_COL_SIZE(id, func)}
3940 The user resized a column, corresponds to @c wxEVT_GRID_COL_SIZE event
3942 @event{EVT_GRID_CMD_ROW_SIZE(id, func)}
3943 The user resized a row, corresponds to @c wxEVT_GRID_ROW_SIZE event
3945 @event{EVT_GRID_COL_SIZE(func)}
3946 Same as EVT_GRID_CMD_COL_SIZE() but uses `wxID_ANY` id.
3947 @event{EVT_GRID_ROW_SIZE(func)}
3948 Same as EVT_GRID_CMD_ROW_SIZE() but uses `wxID_ANY` id.
3952 @category{grid,events}
3954 class wxGridSizeEvent
: public wxNotifyEvent
3958 Default constructor.
3962 Constructor for initializing all event attributes.
3964 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
3965 int rowOrCol
= -1, int x
= -1, int y
= -1,
3966 const wxKeyboardState
& kbd
= wxKeyboardState());
3969 Returns @true if the Alt key was down at the time of the event.
3971 bool AltDown() const;
3974 Returns @true if the Control key was down at the time of the event.
3976 bool ControlDown() const;
3979 Position in pixels at which the event occurred.
3981 wxPoint
GetPosition();
3984 Row or column at that was resized.
3989 Returns @true if the Meta key was down at the time of the event.
3991 bool MetaDown() const;
3994 Returns @true if the Shift key was down at the time of the event.
3996 bool ShiftDown() const;
4002 @class wxGridRangeSelectEvent
4004 @beginEventTable{wxGridRangeSelectEvent}
4005 @event{EVT_GRID_RANGE_SELECT(func)}
4006 The user selected a group of contiguous cells. Processes a
4007 @c wxEVT_GRID_RANGE_SELECT event type.
4008 @event{EVT_GRID_CMD_RANGE_SELECT(id, func)}
4009 The user selected a group of contiguous cells; variant taking a window
4010 identifier. Processes a @c wxEVT_GRID_RANGE_SELECT event type.
4014 @category{grid,events}
4016 class wxGridRangeSelectEvent
: public wxNotifyEvent
4020 Default constructor.
4022 wxGridRangeSelectEvent();
4024 Constructor for initializing all event attributes.
4026 wxGridRangeSelectEvent(int id
, wxEventType type
,
4028 const wxGridCellCoords
& topLeft
,
4029 const wxGridCellCoords
& bottomRight
,
4030 bool sel
= true, const wxKeyboardState
& kbd
= wxKeyboardState());
4033 Returns @true if the Alt key was down at the time of the event.
4035 bool AltDown() const;
4038 Returns @true if the Control key was down at the time of the event.
4040 bool ControlDown() const;
4043 Top left corner of the rectangular area that was (de)selected.
4045 wxGridCellCoords
GetBottomRightCoords();
4048 Bottom row of the rectangular area that was (de)selected.
4053 Left column of the rectangular area that was (de)selected.
4058 Right column of the rectangular area that was (de)selected.
4063 Top left corner of the rectangular area that was (de)selected.
4065 wxGridCellCoords
GetTopLeftCoords();
4068 Top row of the rectangular area that was (de)selected.
4073 Returns @true if the Meta key was down at the time of the event.
4075 bool MetaDown() const;
4078 Returns @true if the area was selected, @false otherwise.
4083 Returns @true if the Shift key was down at the time of the event.
4085 bool ShiftDown() const;
4091 @class wxGridEditorCreatedEvent
4093 @beginEventTable{wxGridEditorCreatedEvent}
4094 @event{EVT_GRID_EDITOR_CREATED(func)}
4095 The editor for a cell was created. Processes a
4096 @c wxEVT_GRID_EDITOR_CREATED event type.
4097 @event{EVT_GRID_CMD_EDITOR_CREATED(id, func)}
4098 The editor for a cell was created; variant taking a window identifier.
4099 Processes a @c wxEVT_GRID_EDITOR_CREATED event type.
4103 @category{grid,events}
4105 class wxGridEditorCreatedEvent
: public wxCommandEvent
4109 Default constructor.
4111 wxGridEditorCreatedEvent();
4113 Constructor for initializing all event attributes.
4115 wxGridEditorCreatedEvent(int id
, wxEventType type
, wxObject
* obj
,
4116 int row
, int col
, wxControl
* ctrl
);
4119 Returns the column at which the event occurred.
4124 Returns the edit control.
4126 wxControl
* GetControl();
4129 Returns the row at which the event occurred.
4134 Sets the column at which the event occurred.
4136 void SetCol(int col
);
4139 Sets the edit control.
4141 void SetControl(wxControl
* ctrl
);
4144 Sets the row at which the event occurred.
4146 void SetRow(int row
);