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
189 editing. Sets the focus to the edit control.
191 virtual void BeginEdit(int row
, int col
, wxGrid
* grid
) = 0;
194 Create a new object which is the copy of this one.
196 virtual wxGridCellEditor
* Clone() const = 0;
199 Creates the actual edit control.
201 virtual void Create(wxWindow
* parent
, wxWindowID id
,
202 wxEvtHandler
* evtHandler
) = 0;
207 virtual void Destroy();
210 Complete the editing of the current cell. If necessary, the control may
213 @return @true if the value has changed.
215 virtual bool EndEdit(int row
, int col
, wxGrid
* grid
) = 0;
218 Some types of controls on some platforms may need some help with the
221 virtual void HandleReturn(wxKeyEvent
& event
);
224 Returns @true if the edit control has been created.
229 Draws the part of the cell not occupied by the control: the base class
230 version just fills it with background colour from the attribute.
232 virtual void PaintBackground(const wxRect
& rectCell
, wxGridCellAttr
* attr
);
235 Reset the value in the control back to its starting value.
237 virtual void Reset() = 0;
240 Size and position the edit control.
242 virtual void SetSize(const wxRect
& rect
);
245 Show or hide the edit control, use the specified attributes to set
246 colours/fonts for it.
248 virtual void Show(bool show
, wxGridCellAttr
* attr
= NULL
);
251 If the editor is enabled by clicking on the cell, this method will be
254 virtual void StartingClick();
257 If the editor is enabled by pressing keys on the grid, this will be
258 called to let the editor do something about that first key if desired.
260 virtual void StartingKey(wxKeyEvent
& event
);
265 The destructor is private because only DecRef() can delete us.
267 virtual ~wxGridCellEditor();
271 @class wxGridCellBoolEditor
273 Grid cell editor for boolean data.
278 @see wxGridCellEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
279 wxGridCellNumberEditor, wxGridCellTextEditor
281 class wxGridCellBoolEditor
: public wxGridCellEditor
287 wxGridCellBoolEditor();
290 Returns @true if the given @a value is equal to the string
291 representation of the truth value we currently use (see
294 static bool IsTrueValue(const wxString
& value
);
297 This method allows you to customize the values returned by GetValue()
298 for the cell using this editor. By default, the default values of the
299 arguments are used, i.e. @c "1" is returned if the cell is checked and
300 an empty string otherwise.
302 static void UseStringValues(const wxString
& valueTrue
= "1",
303 const wxString
& valueFalse
= wxEmptyString
) const;
307 @class wxGridCellChoiceEditor
309 Grid cell editor for string data providing the user a choice from a list of
315 @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellFloatEditor,
316 wxGridCellNumberEditor, wxGridCellTextEditor
318 class wxGridCellChoiceEditor
: public wxGridCellEditor
323 Number of strings from which the user can choose.
325 An array of strings from which the user can choose.
327 If allowOthers is @true, the user can type a string not in choices
330 wxGridCellChoiceEditor(size_t count
= 0,
331 const wxString choices
[] = NULL
,
332 bool allowOthers
= false);
335 An array of strings from which the user can choose.
337 If allowOthers is @true, the user can type a string not in choices
340 wxGridCellChoiceEditor(const wxArrayString
& choices
,
341 bool allowOthers
= false);
344 Parameters string format is "item1[,item2[...,itemN]]"
346 virtual void SetParameters(const wxString
& params
);
350 @class wxGridCellTextEditor
352 Grid cell editor for string/text data.
357 @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor,
358 wxGridCellFloatEditor, wxGridCellNumberEditor
360 class wxGridCellTextEditor
: public wxGridCellEditor
366 wxGridCellTextEditor();
369 The parameters string format is "n" where n is a number representing
372 virtual void SetParameters(const wxString
& params
);
376 @class wxGridCellFloatEditor
378 The editor for floating point numbers data.
383 @see wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor,
384 wxGridCellTextEditor, wxGridCellChoiceEditor
386 class wxGridCellFloatEditor
: public wxGridCellTextEditor
391 Minimum number of characters to be shown.
393 Number of digits after the decimal dot.
395 wxGridCellFloatEditor(int width
= -1, int precision
= -1);
398 Parameters string format is "width,precision"
400 virtual void SetParameters(const wxString
& params
);
404 @class wxGridCellNumberEditor
406 Grid cell editor for numeric integer data.
411 @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor,
412 wxGridCellFloatEditor, wxGridCellTextEditor
414 class wxGridCellNumberEditor
: public wxGridCellTextEditor
418 Allows you to specify the range for acceptable data. Values equal to
419 -1 for both @a min and @a max indicate that no range checking should be
422 wxGridCellNumberEditor(int min
= -1, int max
= -1);
426 Parameters string format is "min,max".
428 virtual void SetParameters(const wxString
& params
);
433 If the return value is @true, the editor uses a wxSpinCtrl to get user
434 input, otherwise it uses a wxTextCtrl.
436 bool HasRange() const;
439 String representation of the value.
441 wxString
GetString() const;
447 @class wxGridCellAttr
449 This class can be used to alter the cells' appearance in the grid by
450 changing their attributes from the defaults. An object of this class may be
451 returned by wxGridTableBase::GetAttr().
464 Constructor specifying some of the often used attributes.
466 wxGridCellAttr(const wxColour
& colText
, const wxColour
& colBack
,
467 const wxFont
& font
, int hAlign
, int vAlign
);
470 Creates a new copy of this object.
472 wxGridCellAttr
* Clone() const;
475 This class is reference counted: it is created with ref count of 1, so
476 calling DecRef() once will delete it. Calling IncRef() allows to lock
477 it until the matching DecRef() is called.
482 See SetAlignment() for the returned values.
484 void GetAlignment(int* hAlign
, int* vAlign
) const;
487 Returns the background colour.
489 const wxColour
& GetBackgroundColour() const;
492 Returns the cell editor.
494 wxGridCellEditor
* GetEditor(const wxGrid
* grid
, int row
, int col
) const;
499 const wxFont
& GetFont() const;
502 Returns the cell renderer.
504 wxGridCellRenderer
* GetRenderer(const wxGrid
* grid
, int row
, int col
) const;
507 Returns the text colour.
509 const wxColour
& GetTextColour() const;
512 Returns @true if this attribute has a valid alignment set.
514 bool HasAlignment() const;
517 Returns @true if this attribute has a valid background colour set.
519 bool HasBackgroundColour() const;
522 Returns @true if this attribute has a valid cell editor set.
524 bool HasEditor() const;
527 Returns @true if this attribute has a valid font set.
529 bool HasFont() const;
532 Returns @true if this attribute has a valid cell renderer set.
534 bool HasRenderer() const;
537 Returns @true if this attribute has a valid text colour set.
539 bool HasTextColour() const;
542 This class is reference counted: it is created with ref count of 1, so
543 calling DecRef() once will delete it. Calling IncRef() allows to lock
544 it until the matching DecRef() is called.
549 Returns @true if this cell is set as read-only.
551 bool IsReadOnly() const;
554 Sets the alignment. @a hAlign can be one of @c wxALIGN_LEFT,
555 @c wxALIGN_CENTRE or @c wxALIGN_RIGHT and @a vAlign can be one of
556 @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
558 void SetAlignment(int hAlign
, int vAlign
);
561 Sets the background colour.
563 void SetBackgroundColour(const wxColour
& colBack
);
566 @todo Needs documentation.
568 void SetDefAttr(wxGridCellAttr
* defAttr
);
571 Sets the editor to be used with the cells with this attribute.
573 void SetEditor(wxGridCellEditor
* editor
);
578 void SetFont(const wxFont
& font
);
581 Sets the cell as read-only.
583 void SetReadOnly(bool isReadOnly
= true);
586 Sets the renderer to be used for cells with this attribute. Takes
587 ownership of the pointer.
589 void SetRenderer(wxGridCellRenderer
* renderer
);
592 Sets the text colour.
594 void SetTextColour(const wxColour
& colText
);
600 @class wxGridTableBase
602 The almost abstract base class for grid tables.
604 A grid table is responsible for storing the grid data and, indirectly, grid
605 cell attributes. The data can be stored in the way most convenient for the
606 application but has to be provided in string form to wxGrid. It is also
607 possible to provide cells values in other formats if appropriate, e.g. as
610 This base class is not quite abstract as it implements a trivial strategy
611 for storing the attributes by forwarding it to wxGridCellAttrProvider and
612 also provides stubs for some other functions. However it does have a number
613 of pure virtual methods which must be implemented in the derived classes.
615 @see wxGridStringTable
620 class wxGridTableBase
: public wxObject
629 Destructor frees the attribute provider if it was created.
631 virtual ~wxGridTableBase();
634 Must be overridden to return the number of rows in the table.
636 For backwards compatibility reasons, this method is not const.
637 Use GetRowsCount() instead of it in const methods of derived table
640 virtual int GetNumberRows() = 0;
643 Must be overridden to return the number of columns in the table.
645 For backwards compatibility reasons, this method is not const.
646 Use GetColsCount() instead of it in const methods of derived table
649 virtual int GetNumberCols() = 0;
652 Return the number of rows in the table.
654 This method is not virtual and is only provided as a convenience for
655 the derived classes which can't call GetNumberRows() without a
656 @c const_cast from their const methods.
658 int GetRowsCount() const;
661 Return the number of columns in the table.
663 This method is not virtual and is only provided as a convenience for
664 the derived classes which can't call GetNumberCols() without a
665 @c const_cast from their const methods.
667 int GetColsCount() const;
671 @name Table Cell Accessors
676 Must be overridden to implement testing for empty cells.
678 virtual bool IsEmptyCell(int row
, int col
) = 0;
681 Same as IsEmptyCell() but taking wxGridCellCoords.
683 Notice that this method is not virtual, only IsEmptyCell() should be
686 bool IsEmpty(const wxGridCellCoords
& coords
);
689 Must be overridden to implement accessing the table values as text.
691 virtual wxString
GetValue(int row
, int col
) = 0;
694 Must be overridden to implement setting the table values as text.
696 virtual void SetValue(int row
, int col
, const wxString
& value
) = 0;
699 Returns the type of the value in the given cell.
701 By default all cells are strings and this method returns
702 @c wxGRID_VALUE_STRING.
704 virtual wxString
GetTypeName(int row
, int col
);
707 Returns true if the value of the given cell can be accessed as if it
708 were of the specified type.
710 By default the cells can only be accessed as strings. Note that a cell
711 could be accessible in different ways, e.g. a numeric cell may return
712 @true for @c wxGRID_VALUE_NUMBER but also for @c wxGRID_VALUE_STRING
713 indicating that the value can be coerced to a string form.
715 virtual bool CanGetValueAs(int row
, int col
, const wxString
& typeName
);
718 Returns true if the value of the given cell can be set as if it were of
723 virtual bool CanSetValueAs(int row
, int col
, const wxString
& typeName
);
726 Returns the value of the given cell as a long.
728 This should only be called if CanGetValueAs() returns @true when called
729 with @c wxGRID_VALUE_NUMBER argument. Default implementation always
732 virtual long GetValueAsLong(int row
, int col
);
735 Returns the value of the given cell as a double.
737 This should only be called if CanGetValueAs() returns @true when called
738 with @c wxGRID_VALUE_FLOAT argument. Default implementation always
741 virtual double GetValueAsDouble(int row
, int col
);
744 Returns the value of the given cell as a boolean.
746 This should only be called if CanGetValueAs() returns @true when called
747 with @c wxGRID_VALUE_BOOL argument. Default implementation always
750 virtual bool GetValueAsBool(int row
, int col
);
753 Returns the value of the given cell as a user-defined type.
755 This should only be called if CanGetValueAs() returns @true when called
756 with @a typeName. Default implementation always return @NULL.
758 virtual void *GetValueAsCustom(int row
, int col
, const wxString
& typeName
);
761 Sets the value of the given cell as a long.
763 This should only be called if CanSetValueAs() returns @true when called
764 with @c wxGRID_VALUE_NUMBER argument. Default implementation doesn't do
767 virtual void SetValueAsLong(int row
, int col
, long value
);
770 Sets the value of the given cell as a double.
772 This should only be called if CanSetValueAs() returns @true when called
773 with @c wxGRID_VALUE_FLOAT argument. Default implementation doesn't do
776 virtual void SetValueAsDouble(int row
, int col
, double value
);
779 Sets the value of the given cell as a boolean.
781 This should only be called if CanSetValueAs() returns @true when called
782 with @c wxGRID_VALUE_BOOL argument. Default implementation doesn't do
785 virtual void SetValueAsBool( int row
, int col
, bool value
);
788 Sets the value of the given cell as a user-defined type.
790 This should only be called if CanSetValueAs() returns @true when called
791 with @a typeName. Default implementation doesn't do anything.
793 virtual void SetValueAsCustom(int row
, int col
, const wxString
& typeName
,
800 Called by the grid when the table is associated with it.
802 The default implementation stores the pointer and returns it from its
803 GetView() and so only makes sense if the table cannot be associated
804 with more than one grid at a time.
806 virtual void SetView(wxGrid
*grid
);
809 Returns the last grid passed to SetView().
811 virtual wxGrid
*GetView() const;
815 @name Table Structure Modifiers
817 Notice that none of these functions are pure virtual as they don't have
818 to be implemented if the table structure is never modified after
819 creation, i.e. neither rows nor columns are never added or deleted but
820 that you do need to implement them if they are called, i.e. if your
821 code either calls them directly or uses the matching wxGrid methods, as
822 by default they simply do nothing which is definitely inappropriate.
827 Clear the table contents.
829 This method is used by wxGrid::ClearGrid().
831 virtual void Clear();
834 Insert additional rows into the table.
837 The position of the first new row.
839 The number of rows to insert.
841 virtual bool InsertRows(size_t pos
= 0, size_t numRows
= 1);
844 Append additional rows at the end of the table.
846 This method is provided in addition to InsertRows() as some data models
847 may only support appending rows to them but not inserting them at
848 arbitrary locations. In such case you may implement this method only
849 and leave InsertRows() unimplemented.
852 The number of rows to add.
854 virtual bool AppendRows(size_t numRows
= 1);
857 Delete rows from the table.
860 The first row to delete.
862 The number of rows to delete.
864 virtual bool DeleteRows(size_t pos
= 0, size_t numRows
= 1);
867 Exactly the same as InsertRows() but for columns.
869 virtual bool InsertCols(size_t pos
= 0, size_t numCols
= 1);
872 Exactly the same as AppendRows() but for columns.
874 virtual bool AppendCols(size_t numCols
= 1);
877 Exactly the same as DeleteRows() but for columns.
879 virtual bool DeleteCols(size_t pos
= 0, size_t numCols
= 1);
884 @name Table Row and Column Labels
886 By default the numbers are used for labeling rows and Latin letters for
887 labeling columns. If the table has more than 26 columns, the pairs of
888 letters are used starting from the 27-th one and so on, i.e. the
889 sequence of labels is A, B, ..., Z, AA, AB, ..., AZ, BA, ..., ..., ZZ,
895 Return the label of the specified row.
897 virtual wxString
GetRowLabelValue(int row
);
900 Return the label of the specified column.
902 virtual wxString
GetColLabelValue(int col
);
905 Set the given label for the specified row.
907 The default version does nothing, i.e. the label is not stored. You
908 must override this method in your derived class if you wish
909 wxGrid::SetRowLabelValue() to work.
911 virtual void SetRowLabelValue(int row
, const wxString
& label
);
914 Exactly the same as SetRowLabelValue() but for columns.
916 virtual void SetColLabelValue(int col
, const wxString
& label
);
922 @name Attributes Management
924 By default the attributes management is delegated to
925 wxGridCellAttrProvider class. You may override the methods in this
926 section to handle the attributes directly if, for example, they can be
927 computed from the cell values.
932 Associate this attributes provider with the table.
934 The table takes ownership of @a attrProvider pointer and will delete it
935 when it doesn't need it any more. The pointer can be @NULL, however
936 this won't disable attributes management in the table but will just
937 result in a default attributes being recreated the next time any of the
938 other functions in this section is called. To completely disable the
939 attributes support, should this be needed, you need to override
940 CanHaveAttributes() to return @false.
942 void SetAttrProvider(wxGridCellAttrProvider
*attrProvider
);
945 Returns the attribute provider currently being used.
947 This function may return @NULL if the attribute provider hasn't been
948 neither associated with this table by SetAttrProvider() nor created on
949 demand by any other methods.
951 wxGridCellAttrProvider
*GetAttrProvider() const;
954 Return the attribute for the given cell.
956 By default this function is simply forwarded to
957 wxGridCellAttrProvider::GetAttr() but it may be overridden to handle
958 attributes directly in the table.
960 virtual wxGridCellAttr
*GetAttr(int row
, int col
,
961 wxGridCellAttr
::wxAttrKind kind
);
964 Set attribute of the specified cell.
966 By default this function is simply forwarded to
967 wxGridCellAttrProvider::SetAttr().
969 The table takes ownership of @a attr, i.e. will call DecRef() on it.
971 virtual void SetAttr(wxGridCellAttr
* attr
, int row
, int col
);
974 Set attribute of the specified row.
976 By default this function is simply forwarded to
977 wxGridCellAttrProvider::SetRowAttr().
979 The table takes ownership of @a attr, i.e. will call DecRef() on it.
981 virtual void SetRowAttr(wxGridCellAttr
*attr
, int row
);
984 Set attribute of the specified column.
986 By default this function is simply forwarded to
987 wxGridCellAttrProvider::SetColAttr().
989 The table takes ownership of @a attr, i.e. will call DecRef() on it.
991 virtual void SetColAttr(wxGridCellAttr
*attr
, int col
);
996 Returns true if this table supports attributes or false otherwise.
998 By default, the table automatically creates a wxGridCellAttrProvider
999 when this function is called if it had no attribute provider before and
1002 virtual bool CanHaveAttributes();
1010 wxGrid and its related classes are used for displaying and editing tabular
1012 They provide a rich set of features for display, editing, and interacting
1013 with a variety of data sources. For simple applications, and to help you
1014 get started, wxGrid is the only class you need to refer to directly. It
1015 will set up default instances of the other classes and manage them for you.
1016 For more complex applications you can derive your own classes for custom
1017 grid views, grid data tables, cell editors and renderers. The @ref
1018 overview_grid "wxGrid overview" has examples of simple and more complex applications,
1019 explains the relationship between the various grid classes and has a
1020 summary of the keyboard shortcuts and mouse functions provided by wxGrid.
1022 wxGrid has been greatly expanded and redesigned for wxWidgets 2.2 onwards.
1023 The new grid classes are reasonably backward-compatible but there are some
1024 exceptions. There are also easier ways of doing many things compared to the
1025 previous implementation.
1027 A wxGridTableBase class holds the actual data to be displayed by a wxGrid
1028 class. One or more wxGrid classes may act as a view for one table class.
1029 The default table class is called wxGridStringTable and holds an array of
1030 strings. An instance of such a class is created by wxGrid::CreateGrid.
1032 wxGridCellRenderer is the abstract base class for rendereing contents in a
1033 cell. The following renderers are predefined:
1034 - wxGridCellStringRenderer,
1035 - wxGridCellBoolRenderer,
1036 - wxGridCellFloatRenderer,
1037 - wxGridCellNumberRenderer.
1038 The look of a cell can be further defined using wxGridCellAttr. An object
1039 of this type may be returned by wxGridTableBase::GetAttr.
1041 wxGridCellEditor is the abstract base class for editing the value of a
1042 cell. The following editors are predefined:
1043 - wxGridCellTextEditor
1044 - wxGridCellBoolEditor
1045 - wxGridCellChoiceEditor
1046 - wxGridCellNumberEditor.
1051 @see @ref overview_grid "wxGrid overview"
1053 class wxGrid
: public wxScrolledWindow
1057 Different selection modes supported by the grid.
1059 enum wxGridSelectionModes
1062 The default selection mode allowing selection of the individual
1063 cells as well as of the entire rows and columns.
1068 The selection mode allowing the selection of the entire rows only.
1070 The user won't be able to select any cells or columns in this mode.
1075 The selection mode allowing the selection of the entire columns only.
1077 The user won't be able to select any cells or rows in this mode.
1083 Default constructor.
1085 You must call Create() to really create the grid window and also call
1086 CreateGrid() or SetTable() to initialize the grid contents.
1091 Constructor creating the grid window.
1093 You must call either CreateGrid() or SetTable() to initialize the grid
1094 contents before using it.
1096 wxGrid(wxWindow
* parent
,
1098 const wxPoint
& pos
= wxDefaultPosition
,
1099 const wxSize
& size
= wxDefaultSize
,
1100 long style
= wxWANTS_CHARS
,
1101 const wxString
& name
= wxGridNameStr
);
1104 Creates the grid window for an object initialized using the default
1107 You must call either CreateGrid() or SetTable() to initialize the grid
1108 contents before using it.
1110 bool Create(wxWindow
* parent
,
1112 const wxPoint
& pos
= wxDefaultPosition
,
1113 const wxSize
& size
= wxDefaultSize
,
1114 long style
= wxWANTS_CHARS
,
1115 const wxString
& name
= wxGridNameStr
);
1120 This will also destroy the associated grid table unless you passed a
1121 table object to the grid and specified that the grid should not take
1122 ownership of the table (see wxGrid::SetTable).
1127 Appends one or more new columns to the right of the grid.
1129 The @a updateLabels argument is not used at present. If you are using a
1130 derived grid table class you will need to override
1131 wxGridTableBase::AppendCols. See InsertCols() for further information.
1133 @return @true on success or @false if appending columns failed.
1135 bool AppendCols(int numCols
= 1, bool updateLabels
= true);
1138 Appends one or more new rows to the bottom of the grid.
1140 The @a updateLabels argument is not used at present. If you are using a
1141 derived grid table class you will need to override
1142 wxGridTableBase::AppendRows. See InsertRows() for further information.
1144 @return @true on success or @false if appending rows failed.
1146 bool AppendRows(int numRows
= 1, bool updateLabels
= true);
1149 Return @true if the horizontal grid lines stop at the last column
1150 boundary or @false if they continue to the end of the window.
1152 The default is to clip grid lines.
1154 @see ClipHorzGridLines(), AreVertGridLinesClipped()
1156 bool AreHorzGridLinesClipped() const;
1159 Return @true if the vertical grid lines stop at the last row
1160 boundary or @false if they continue to the end of the window.
1162 The default is to clip grid lines.
1164 @see ClipVertGridLines(), AreHorzGridLinesClipped()
1166 bool AreVertGridLinesClipped() const;
1169 Automatically sets the height and width of all rows and columns to fit their
1175 Automatically adjusts width of the column to fit its label.
1177 void AutoSizeColLabelSize(int col
);
1180 Automatically sizes the column to fit its contents. If setAsMin is @true the
1181 calculated width will
1182 also be set as the minimal width for the column.
1184 void AutoSizeColumn(int col
, bool setAsMin
= true);
1187 Automatically sizes all columns to fit their contents. If setAsMin is @true the
1188 calculated widths will
1189 also be set as the minimal widths for the columns.
1191 void AutoSizeColumns(bool setAsMin
= true);
1194 Automatically sizes the row to fit its contents. If setAsMin is @true the
1195 calculated height will
1196 also be set as the minimal height for the row.
1198 void AutoSizeRow(int row
, bool setAsMin
= true);
1201 Automatically adjusts height of the row to fit its label.
1203 void AutoSizeRowLabelSize(int col
);
1206 Automatically sizes all rows to fit their contents. If setAsMin is @true the
1207 calculated heights will
1208 also be set as the minimal heights for the rows.
1210 void AutoSizeRows(bool setAsMin
= true);
1213 Increments the grid's batch count.
1215 When the count is greater than zero repainting of the grid is
1216 suppressed. Each call to BeginBatch must be matched by a later call to
1217 EndBatch(). Code that does a lot of grid modification can be enclosed
1218 between BeginBatch and EndBatch calls to avoid screen flicker. The
1219 final EndBatch will cause the grid to be repainted.
1221 Notice that you should use wxGridUpdateLocker which ensures that there
1222 is always a matching EndBatch() call for this BeginBatch() if possible
1223 instead of calling this method directly.
1228 Convert grid cell coordinates to grid window pixel coordinates.
1230 This function returns the rectangle that encloses the block of cells
1231 limited by @a topLeft and @a bottomRight cell in device coords and
1232 clipped to the client size of the grid window.
1236 wxRect
BlockToDeviceRect(const wxGridCellCoords
& topLeft
,
1237 const wxGridCellCoords
& bottomRight
) const;
1240 Returns @true if columns can be moved by dragging with the mouse.
1242 Columns can be moved by dragging on their labels.
1244 bool CanDragColMove() const;
1247 Returns @true if columns can be resized by dragging with the mouse.
1249 Columns can be resized by dragging the edges of their labels. If grid
1250 line dragging is enabled they can also be resized by dragging the right
1251 edge of the column in the grid cell area (see
1252 wxGrid::EnableDragGridSize).
1254 bool CanDragColSize() const;
1257 Return @true if the dragging of grid lines to resize rows and columns
1258 is enabled or @false otherwise.
1260 bool CanDragGridSize() const;
1263 Returns @true if rows can be resized by dragging with the mouse.
1265 Rows can be resized by dragging the edges of their labels. If grid line
1266 dragging is enabled they can also be resized by dragging the lower edge
1267 of the row in the grid cell area (see wxGrid::EnableDragGridSize).
1269 bool CanDragRowSize() const;
1272 Returns @true if the in-place edit control for the current grid cell
1273 can be used and @false otherwise.
1275 This function always returns @false for the read-only cells.
1277 bool CanEnableCellControl() const;
1281 Return the rectangle corresponding to the grid cell's size and position
1282 in logical coordinates.
1284 @see BlockToDeviceRect()
1286 wxRect
CellToRect(int row
, int col
) const;
1287 const wxRect
CellToRect(const wxGridCellCoords
& coords
) const;
1292 Clears all data in the underlying grid table and repaints the grid.
1294 The table is not deleted by this function. If you are using a derived
1295 table class then you need to override wxGridTableBase::Clear() for this
1296 function to have any effect.
1301 Deselects all cells that are currently selected.
1303 void ClearSelection();
1306 Change whether the horizontal grid lines are clipped by the end of the
1309 By default the grid lines are not drawn beyond the end of the last
1310 column but after calling this function with @a clip set to @false they
1311 will be drawn across the entire grid window.
1313 @see AreHorzGridLinesClipped(), ClipVertGridLines()
1315 void ClipHorzGridLines(bool clip
);
1318 Change whether the vertical grid lines are clipped by the end of the
1321 By default the grid lines are not drawn beyond the end of the last
1322 row but after calling this function with @a clip set to @false they
1323 will be drawn across the entire grid window.
1325 @see AreVertzGridLinesClipped(), ClipHorzGridLines()
1327 void ClipVertzGridLines(bool clip
);
1330 Creates a grid with the specified initial number of rows and columns.
1332 Call this directly after the grid constructor. When you use this
1333 function wxGrid will create and manage a simple table of string values
1334 for you. All of the grid data will be stored in memory.
1335 For applications with more complex data types or relationships, or for
1336 dealing with very large datasets, you should derive your own grid table
1337 class and pass a table object to the grid with SetTable().
1339 bool CreateGrid(int numRows
, int numCols
,
1340 wxGridSelectionModes selmode
= wxGridSelectCells
);
1343 Deletes one or more columns from a grid starting at the specified
1346 The @a updateLabels argument is not used at present. If you are using a
1347 derived grid table class you will need to override
1348 wxGridTableBase::DeleteCols. See InsertCols() for further information.
1350 @return @true on success or @false if deleting columns failed.
1352 bool DeleteCols(int pos
= 0, int numCols
= 1, bool updateLabels
= true);
1355 Deletes one or more rows from a grid starting at the specified position.
1357 The @a updateLabels argument is not used at present. If you are using a
1358 derived grid table class you will need to override
1359 wxGridTableBase::DeleteRows. See InsertRows() for further information.
1361 @return @true on success or @false if appending rows failed.
1363 bool DeleteRows(int pos
= 0, int numRows
= 1, bool updateLabels
= true);
1366 Disables in-place editing of grid cells.
1368 Equivalent to calling EnableCellEditControl(@false).
1370 void DisableCellEditControl();
1373 Disables column moving by dragging with the mouse.
1375 Equivalent to passing @false to EnableDragColMove().
1377 void DisableDragColMove();
1380 Disables column sizing by dragging with the mouse.
1382 Equivalent to passing @false to EnableDragColSize().
1384 void DisableDragColSize();
1387 Disable mouse dragging of grid lines to resize rows and columns.
1389 Equivalent to passing @false to EnableDragGridSize()
1391 void DisableDragGridSize();
1394 Disables row sizing by dragging with the mouse.
1396 Equivalent to passing @false to EnableDragRowSize().
1398 void DisableDragRowSize();
1401 Enables or disables in-place editing of grid cell data.
1403 The grid will issue either a wxEVT_GRID_EDITOR_SHOWN or
1404 wxEVT_GRID_EDITOR_HIDDEN event.
1406 void EnableCellEditControl(bool enable
= true);
1409 Enables or disables column moving by dragging with the mouse.
1411 void EnableDragColMove(bool enable
= true);
1414 Enables or disables column sizing by dragging with the mouse.
1416 void EnableDragColSize(bool enable
= true);
1419 Enables or disables row and column resizing by dragging gridlines with the
1422 void EnableDragGridSize(bool enable
= true);
1425 Enables or disables row sizing by dragging with the mouse.
1427 void EnableDragRowSize(bool enable
= true);
1430 Makes the grid globally editable or read-only.
1432 If the edit argument is @false this function sets the whole grid as
1433 read-only. If the argument is @true the grid is set to the default
1434 state where cells may be editable. In the default state you can set
1435 single grid cells and whole rows and columns to be editable or
1436 read-only via wxGridCellAttribute::SetReadOnly. For single cells you
1437 can also use the shortcut function SetReadOnly().
1439 For more information about controlling grid cell attributes see the
1440 wxGridCellAttr cell attribute class and the
1441 @ref overview_grid "wxGrid overview".
1443 void EnableEditing(bool edit
);
1446 Turns the drawing of grid lines on or off.
1448 void EnableGridLines(bool enable
= true);
1451 Decrements the grid's batch count.
1453 When the count is greater than zero repainting of the grid is
1454 suppressed. Each previous call to BeginBatch() must be matched by a
1455 later call to EndBatch. Code that does a lot of grid modification can
1456 be enclosed between BeginBatch and EndBatch calls to avoid screen
1457 flicker. The final EndBatch will cause the grid to be repainted.
1459 @see wxGridUpdateLocker
1464 Overridden wxWindow method.
1469 Causes immediate repainting of the grid.
1471 Use this instead of the usual wxWindow::Refresh.
1473 void ForceRefresh();
1476 Returns the number of times that BeginBatch() has been called
1477 without (yet) matching calls to EndBatch(). While
1478 the grid's batch count is greater than zero the display will not be updated.
1480 int GetBatchCount();
1483 Sets the arguments to the horizontal and vertical text alignment values
1484 for the grid cell at the specified location.
1486 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1487 or @c wxALIGN_RIGHT.
1489 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1492 void GetCellAlignment(int row
, int col
, int* horiz
, int* vert
) const;
1495 Returns the background colour of the cell at the specified location.
1497 wxColour
GetCellBackgroundColour(int row
, int col
) const;
1500 Returns a pointer to the editor for the cell at the specified location.
1502 See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
1503 for more information about cell editors and renderers.
1505 The caller must call DecRef() on the returned pointer.
1507 wxGridCellEditor
* GetCellEditor(int row
, int col
) const;
1510 Returns the font for text in the grid cell at the specified location.
1512 wxFont
GetCellFont(int row
, int col
) const;
1515 Returns a pointer to the renderer for the grid cell at the specified
1518 See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
1519 for more information about cell editors and renderers.
1521 The caller must call DecRef() on the returned pointer.
1523 wxGridCellRenderer
* GetCellRenderer(int row
, int col
) const;
1526 Returns the text colour for the grid cell at the specified location.
1528 wxColour
GetCellTextColour(int row
, int col
) const;
1532 Returns the string contained in the cell at the specified location.
1534 For simple applications where a grid object automatically uses a
1535 default grid table of string values you use this function together with
1536 SetCellValue() to access cell values. For more complex applications
1537 where you have derived your own grid table class that contains various
1538 data types (e.g. numeric, boolean or user-defined custom types) then
1539 you only use this function for those cells that contain string values.
1541 See wxGridTableBase::CanGetValueAs and the @ref overview_grid "wxGrid overview"
1542 for more information.
1544 wxString
GetCellValue(int row
, int col
) const;
1545 const wxString
GetCellValue(const wxGridCellCoords
& coords
) const;
1549 Returns the column ID of the specified column position.
1551 int GetColAt(int colPos
) const;
1554 Returns the pen used for vertical grid lines.
1556 This virtual function may be overridden in derived classes in order to
1557 change the appearance of individual grid lines for the given column @e
1560 See GetRowGridLinePen() for an example.
1562 virtual wxPen
GetColGridLinePen(int col
);
1565 Sets the arguments to the current column label alignment values.
1567 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1568 or @c wxALIGN_RIGHT.
1570 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1573 void GetColLabelAlignment(int* horiz
, int* vert
) const;
1576 Returns the current height of the column labels.
1578 int GetColLabelSize() const;
1581 Returns the specified column label.
1583 The default grid table class provides column labels of the form
1584 A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can
1585 override wxGridTableBase::GetColLabelValue to provide your own labels.
1587 wxString
GetColLabelValue(int col
) const;
1590 Returns the minimal width to which a column may be resized.
1592 Use SetColMinimalAcceptableWidth() to change this value globally or
1593 SetColMinimalWidth() to do it for individual columns.
1595 int GetColMinimalAcceptableWidth() const;
1598 Returns the position of the specified column.
1600 int GetColPos(int colID
) const;
1603 Returns the width of the specified column.
1605 int GetColSize(int col
) const;
1608 Returns the default cell alignment.
1610 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1611 or @c wxALIGN_RIGHT.
1613 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1616 @see SetDefaultCellAlignment()
1618 void GetDefaultCellAlignment(int* horiz
, int* vert
) const;
1621 Returns the current default background colour for grid cells.
1623 wxColour
GetDefaultCellBackgroundColour() const;
1626 Returns the current default font for grid cell text.
1628 wxFont
GetDefaultCellFont() const;
1631 Returns the current default colour for grid cell text.
1633 wxColour
GetDefaultCellTextColour() const;
1636 Returns the default height for column labels.
1638 int GetDefaultColLabelSize() const;
1641 Returns the current default width for grid columns.
1643 int GetDefaultColSize() const;
1646 Returns a pointer to the current default grid cell editor.
1648 See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
1649 for more information about cell editors and renderers.
1651 wxGridCellEditor
* GetDefaultEditor() const;
1655 Returns the default editor for the specified cell.
1657 The base class version returns the editor appropriate for the current
1658 cell type but this method may be overridden in the derived classes to
1659 use custom editors for some cells by default.
1661 Notice that the same may be usually achieved in simpler way by
1662 associating a custom editor with the given cell or cells.
1664 The caller must call DecRef() on the returned pointer.
1666 virtual wxGridCellEditor
* GetDefaultEditorForCell(int row
, int col
) const;
1667 wxGridCellEditor
* GetDefaultEditorForCell(const wxGridCellCoords
& c
) const;
1671 Returns the default editor for the cells containing values of the given
1674 The base class version returns the editor which was associated with the
1675 specified @a typeName when it was registered RegisterDataType() but
1676 this function may be overridden to return something different. This
1677 allows to override an editor used for one of the standard types.
1679 The caller must call DecRef() on the returned pointer.
1681 virtual wxGridCellEditor
*
1682 GetDefaultEditorForType(const wxString
& typeName
) const;
1685 Returns the pen used for grid lines.
1687 This virtual function may be overridden in derived classes in order to
1688 change the appearance of grid lines. Note that currently the pen width
1691 @see GetColGridLinePen(), GetRowGridLinePen()
1693 virtual wxPen
GetDefaultGridLinePen();
1696 Returns a pointer to the current default grid cell renderer.
1698 See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
1699 for more information about cell editors and renderers.
1701 The caller must call DecRef() on the returned pointer.
1703 wxGridCellRenderer
* GetDefaultRenderer() const;
1706 Returns the default renderer for the given cell.
1708 The base class version returns the renderer appropriate for the current
1709 cell type but this method may be overridden in the derived classes to
1710 use custom renderers for some cells by default.
1712 The caller must call DecRef() on the returned pointer.
1714 virtual wxGridCellRenderer
*GetDefaultRendererForCell(int row
, int col
) const;
1717 Returns the default renderer for the cell containing values of the
1720 @see GetDefaultEditorForType()
1722 virtual wxGridCellRenderer
*
1723 GetDefaultRendererForType(const wxString
& typeName
) const;
1726 Returns the default width for the row labels.
1728 int GetDefaultRowLabelSize() const;
1731 Returns the current default height for grid rows.
1733 int GetDefaultRowSize() const;
1736 Returns the current grid cell column position.
1738 int GetGridCursorCol() const;
1741 Returns the current grid cell row position.
1743 int GetGridCursorRow() const;
1746 Returns the colour used for grid lines.
1748 @see GetDefaultGridLinePen()
1750 wxColour
GetGridLineColour() const;
1753 Returns the colour used for the background of row and column labels.
1755 wxColour
GetLabelBackgroundColour() const;
1758 Returns the font used for row and column labels.
1760 wxFont
GetLabelFont() const;
1763 Returns the colour used for row and column label text.
1765 wxColour
GetLabelTextColour() const;
1768 Returns the total number of grid columns.
1770 This is the same as the number of columns in the underlying grid
1773 int GetNumberCols() const;
1776 Returns the total number of grid rows.
1778 This is the same as the number of rows in the underlying grid table.
1780 int GetNumberRows() const;
1783 Returns the attribute for the given cell creating one if necessary.
1785 If the cell already has an attribute, it is returned. Otherwise a new
1786 attribute is created, associated with the cell and returned. In any
1787 case the caller must call DecRef() on the returned pointer.
1789 This function may only be called if CanHaveAttributes() returns @true.
1791 wxGridCellAttr
*GetOrCreateCellAttr(int row
, int col
) const;
1794 Returns the pen used for horizontal grid lines.
1796 This virtual function may be overridden in derived classes in order to
1797 change the appearance of individual grid line for the given row @e row.
1801 // in a grid displaying music notation, use a solid black pen between
1802 // octaves (C0=row 127, C1=row 115 etc.)
1803 wxPen MidiGrid::GetRowGridLinePen(int row)
1805 if ( row % 12 == 7 )
1806 return wxPen(*wxBLACK, 1, wxSOLID);
1808 return GetDefaultGridLinePen();
1812 virtual wxPen
GetRowGridLinePen(int row
);
1815 Returns the alignment used for row labels.
1817 Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
1818 or @c wxALIGN_RIGHT.
1820 Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
1823 void GetRowLabelAlignment(int* horiz
, int* vert
) const;
1826 Returns the current width of the row labels.
1828 int GetRowLabelSize() const;
1831 Returns the specified row label.
1833 The default grid table class provides numeric row labels. If you are
1834 using a custom grid table you can override
1835 wxGridTableBase::GetRowLabelValue to provide your own labels.
1837 wxString
GetRowLabelValue(int row
) const;
1840 Returns the minimal size to which rows can be resized.
1842 Use SetRowMinimalAcceptableHeight() to change this value globally or
1843 SetRowMinimalHeight() to do it for individual cells.
1845 @see GetColMinimalAcceptableWidth()
1847 int GetRowMinimalAcceptableHeight() const;
1850 Returns the height of the specified row.
1852 int GetRowSize(int row
) const;
1855 Returns the number of pixels per horizontal scroll increment.
1859 @see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
1861 int GetScrollLineX() const;
1864 Returns the number of pixels per vertical scroll increment.
1868 @see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
1870 int GetScrollLineY() const;
1873 Returns an array of individually selected cells.
1875 Notice that this array does @em not contain all the selected cells in
1876 general as it doesn't include the cells selected as part of column, row
1877 or block selection. You must use this method, GetSelectedCols(),
1878 GetSelectedRows() and GetSelectionBlockTopLeft() and
1879 GetSelectionBlockBottomRight() methods to obtain the entire selection
1882 Please notice this behaviour is by design and is needed in order to
1883 support grids of arbitrary size (when an entire column is selected in
1884 a grid with a million of columns, we don't want to create an array with
1885 a million of entries in this function, instead it returns an empty
1886 array and GetSelectedCols() returns an array containing one element).
1888 wxGridCellCoordsArray
GetSelectedCells() const;
1891 Returns an array of selected columns.
1893 Please notice that this method alone is not sufficient to find all the
1894 selected columns as it contains only the columns which were
1895 individually selected but not those being part of the block selection
1896 or being selected in virtue of all of their cells being selected
1897 individually, please see GetSelectedCells() for more details.
1899 wxArrayInt
GetSelectedCols() const;
1902 Returns an array of selected rows.
1904 Please notice that this method alone is not sufficient to find all the
1905 selected rows as it contains only the rows which were individually
1906 selected but not those being part of the block selection or being
1907 selected in virtue of all of their cells being selected individually,
1908 please see GetSelectedCells() for more details.
1910 wxArrayInt
GetSelectedRows() const;
1913 Access or update the selection fore/back colours
1915 wxColour
GetSelectionBackground() const;
1918 Returns an array of the bottom right corners of blocks of selected
1921 Please see GetSelectedCells() for more information about the selection
1922 representation in wxGrid.
1924 @see GetSelectionBlockTopLeft()
1926 wxGridCellCoordsArray
GetSelectionBlockBottomRight() const;
1929 Returns an array of the top left corners of blocks of selected cells.
1931 Please see GetSelectedCells() for more information about the selection
1932 representation in wxGrid.
1934 @see GetSelectionBlockBottomRight()
1936 wxGridCellCoordsArray
GetSelectionBlockTopLeft() const;
1939 Returns the colour used for drawing the selection foreground.
1941 wxColour
GetSelectionForeground() const;
1944 Returns the current selection mode.
1946 @see SetSelectionMode().
1948 wxGridSelectionModes
GetSelectionMode() const;
1951 Returns a base pointer to the current table object.
1953 The returned pointer is still owned by the grid.
1955 wxGridTableBase
*GetTable() const;
1959 Make the given cell current and ensure it is visible.
1961 This method is equivalent to calling MakeCellVisible() and
1962 SetGridCursor() and so, as with the latter, a wxEVT_GRID_SELECT_CELL
1963 event is generated by it and the selected cell doesn't change if the
1966 void GoToCell(int row
, int col
);
1967 void GoToCell(const wxGridCellCoords
& coords
);
1971 Returns @true if drawing of grid lines is turned on, @false otherwise.
1973 bool GridLinesEnabled() const;
1976 Hides the in-place cell edit control.
1978 void HideCellEditControl();
1981 Hides the column labels by calling SetColLabelSize()
1982 with a size of 0. Show labels again by calling that method with
1983 a width greater than 0.
1985 void HideColLabels();
1988 Hides the row labels by calling SetRowLabelSize() with a size of 0.
1990 The labels can be shown again by calling SetRowLabelSize() with a width
1993 void HideRowLabels();
1996 Inserts one or more new columns into a grid with the first new column
1997 at the specified position.
1999 Notice that inserting the columns in the grid requires grid table
2000 cooperation: when this method is called, grid object begins by
2001 requesting the underlying grid table to insert new columns. If this is
2002 successful the table notifies the grid and the grid updates the
2003 display. For a default grid (one where you have called
2004 wxGrid::CreateGrid) this process is automatic. If you are using a
2005 custom grid table (specified with wxGrid::SetTable) then you must
2006 override wxGridTableBase::InsertCols() in your derived table class.
2009 The position which the first newly inserted column will have.
2011 The number of columns to insert.
2015 @true if the columns were successfully inserted, @false if an error
2016 occurred (most likely the table couldn't be updated).
2018 bool InsertCols(int pos
= 0, int numCols
= 1, bool updateLabels
= true);
2021 Inserts one or more new rows into a grid with the first new row at the
2024 Notice that you must implement wxGridTableBase::InsertRows() if you use
2025 a grid with a custom table, please see InsertCols() for more
2029 The position which the first newly inserted row will have.
2031 The number of rows to insert.
2035 @true if the rows were successfully inserted, @false if an error
2036 occurred (most likely the table couldn't be updated).
2038 bool InsertRows(int pos
= 0, int numRows
= 1, bool updateLabels
= true);
2041 Returns @true if the in-place edit control is currently enabled.
2043 bool IsCellEditControlEnabled() const;
2046 Returns @true if the current cell is read-only.
2048 @see SetReadOnly(), IsReadOnly()
2050 bool IsCurrentCellReadOnly() const;
2053 Returns @false if the whole grid has been set as read-only or @true
2056 See EnableEditing() for more information about controlling the editing
2057 status of grid cells.
2059 bool IsEditable() const;
2063 Is this cell currently selected?
2065 bool IsInSelection(int row
, int col
) const;
2066 bool IsInSelection(const wxGridCellCoords
& coords
) const;
2070 Returns @true if the cell at the specified location can't be edited.
2072 @see SetReadOnly(), IsCurrentCellReadOnly()
2074 bool IsReadOnly(int row
, int col
) const;
2077 Returns @true if there are currently any selected cells, rows, columns
2080 bool IsSelection() const;
2084 Returns @true if a cell is either wholly or at least partially visible
2087 By default, the cell must be entirely visible for this function to
2088 return true but if @a wholeCellVisible is @false, the function returns
2089 @true even if the cell is only partially visible.
2091 bool IsVisible(int row
, int col
, bool wholeCellVisible
= true) const;
2092 bool IsVisible(const wxGridCellCoords
& coords
,
2093 bool wholeCellVisible
= true) const;
2098 Brings the specified cell into the visible grid cell area with minimal
2101 Does nothing if the cell is already visible.
2103 void MakeCellVisible(int row
, int col
);
2104 void MakeCellVisible(const wxGridCellCoords
& coords
);
2108 Moves the grid cursor down by one row.
2110 If a block of cells was previously selected it will expand if the
2111 argument is @true or be cleared if the argument is @false.
2113 bool MoveCursorDown(bool expandSelection
);
2116 Moves the grid cursor down in the current column such that it skips to
2117 the beginning or end of a block of non-empty cells.
2119 If a block of cells was previously selected it will expand if the
2120 argument is @true or be cleared if the argument is @false.
2122 bool MoveCursorDownBlock(bool expandSelection
);
2125 Moves the grid cursor left by one column.
2127 If a block of cells was previously selected it will expand if the
2128 argument is @true or be cleared if the argument is @false.
2130 bool MoveCursorLeft(bool expandSelection
);
2133 Moves the grid cursor left in the current row such that it skips to the
2134 beginning or end of a block of non-empty cells.
2136 If a block of cells was previously selected it will expand if the
2137 argument is @true or be cleared if the argument is @false.
2139 bool MoveCursorLeftBlock(bool expandSelection
);
2142 Moves the grid cursor right by one column.
2144 If a block of cells was previously selected it will expand if the
2145 argument is @true or be cleared if the argument is @false.
2147 bool MoveCursorRight(bool expandSelection
);
2150 Moves the grid cursor right in the current row such that it skips to
2151 the beginning or end of a block of non-empty cells.
2153 If a block of cells was previously selected it will expand if the
2154 argument is @true or be cleared if the argument is @false.
2156 bool MoveCursorRightBlock(bool expandSelection
);
2159 Moves the grid cursor up by one row.
2161 If a block of cells was previously selected it will expand if the
2162 argument is @true or be cleared if the argument is @false.
2164 bool MoveCursorUp(bool expandSelection
);
2167 Moves the grid cursor up in the current column such that it skips to
2168 the beginning or end of a block of non-empty cells.
2170 If a block of cells was previously selected it will expand if the
2171 argument is @true or be cleared if the argument is @false.
2173 bool MoveCursorUpBlock(bool expandSelection
);
2176 Moves the grid cursor down by some number of rows so that the previous
2177 bottom visible row becomes the top visible row.
2179 bool MovePageDown();
2182 Moves the grid cursor up by some number of rows so that the previous
2183 top visible row becomes the bottom visible row.
2188 Register a new data type.
2190 The data types allow to naturally associate specific renderers and
2191 editors to the cells containing values of the given type. For example,
2192 the grid automatically registers a data type with the name @c
2193 wxGRID_VALUE_STRING which uses wxGridCellStringRenderer and
2194 wxGridCellTextEditor as its renderer and editor respectively -- this is
2195 the data type used by all the cells of the default wxGridStringTable,
2196 so this renderer and editor are used by default for all grid cells.
2198 However if a custom table returns @c wxGRID_VALUE_BOOL from its
2199 wxGridTableBase::GetTypeName() method, then wxGridCellBoolRenderer and
2200 wxGridCellBoolEditor are used for it because the grid also registers a
2201 boolean data type with this name.
2203 And as this mechanism is completely generic, you may register your own
2204 data types using your own custom renderers and editors. Just remember
2205 that the table must identify a cell as being of the given type for them
2206 to be used for this cell.
2209 Name of the new type. May be any string, but if the type name is
2210 the same as the name of an already registered type, including one
2211 of the standard ones (which are @c wxGRID_VALUE_STRING, @c
2212 wxGRID_VALUE_BOOL, @c wxGRID_VALUE_NUMBER, @c wxGRID_VALUE_FLOAT
2213 and @c wxGRID_VALUE_CHOICE), then the new registration information
2214 replaces the previously used renderer and editor.
2216 The renderer to use for the cells of this type. Its ownership is
2217 taken by the grid, i.e. it will call DecRef() on this pointer when
2218 it doesn't need it any longer.
2220 The editor to use for the cells of this type. Its ownership is also
2223 void RegisterDataType(const wxString
& typeName
,
2224 wxGridCellRenderer
* renderer
,
2225 wxGridCellEditor
* editor
);
2228 Sets the value of the current grid cell to the current in-place edit
2231 This is called automatically when the grid cursor moves from the
2232 current cell to a new cell. It is also a good idea to call this
2233 function when closing a grid since any edits to the final cell location
2234 will not be saved otherwise.
2236 void SaveEditControlValue();
2239 Selects all cells in the grid.
2245 Selects a rectangular block of cells.
2247 If @a addToSelected is @false then any existing selection will be
2248 deselected; if @true the column will be added to the existing
2251 void SelectBlock(int topRow
, int leftCol
, int bottomRow
, int rightCol
,
2252 bool addToSelected
= false);
2253 void SelectBlock(const wxGridCellCoords
& topLeft
,
2254 const wxGridCellCoords
& bottomRight
,
2255 bool addToSelected
= false);
2259 Selects the specified column.
2261 If @a addToSelected is @false then any existing selection will be
2262 deselected; if @true the column will be added to the existing
2265 This method won't select anything if the current selection mode is
2268 void SelectCol(int col
, bool addToSelected
= false);
2271 Selects the specified row.
2273 If @a addToSelected is @false then any existing selection will be
2274 deselected; if @true the row will be added to the existing selection.
2276 This method won't select anything if the current selection mode is
2277 wxGridSelectColumns.
2279 void SelectRow(int row
, bool addToSelected
= false);
2283 Sets the horizontal and vertical alignment for grid cell text at the
2286 Horizontal alignment should be one of @c wxALIGN_LEFT, @c
2287 wxALIGN_CENTRE or @c wxALIGN_RIGHT.
2289 Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
2290 or @c wxALIGN_BOTTOM.
2292 void SetCellAlignment(int row
, int col
, int horiz
, int vert
);
2293 void SetCellAlignment(int align
, int row
, int col
);
2298 Set the background colour for the given cell or all cells by default.
2300 void SetCellBackgroundColour(int row
, int col
, const wxColour
& colour
);
2304 Sets the editor for the grid cell at the specified location.
2306 The grid will take ownership of the pointer.
2308 See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
2309 for more information about cell editors and renderers.
2311 void SetCellEditor(int row
, int col
, wxGridCellEditor
* editor
);
2314 Sets the font for text in the grid cell at the specified location.
2316 void SetCellFont(int row
, int col
, const wxFont
& font
);
2319 Sets the renderer for the grid cell at the specified location.
2321 The grid will take ownership of the pointer.
2323 See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
2324 for more information about cell editors and renderers.
2326 void SetCellRenderer(int row
, int col
, wxGridCellRenderer
* renderer
);
2330 Sets the text colour for the given cell or all cells by default.
2332 void SetCellTextColour(int row
, int col
, const wxColour
& colour
);
2333 void SetCellTextColour(const wxColour
& val
, int row
, int col
);
2334 void SetCellTextColour(const wxColour
& colour
);
2339 Sets the string value for the cell at the specified location.
2341 For simple applications where a grid object automatically uses a
2342 default grid table of string values you use this function together with
2343 GetCellValue() to access cell values. For more complex applications
2344 where you have derived your own grid table class that contains various
2345 data types (e.g. numeric, boolean or user-defined custom types) then
2346 you only use this function for those cells that contain string values.
2347 The last form is for backward compatibility only.
2349 See wxGridTableBase::CanSetValueAs and the @ref overview_grid
2350 "wxGrid overview" for more information.
2352 void SetCellValue(int row
, int col
, const wxString
& s
);
2353 void SetCellValue(const wxGridCellCoords
& coords
, const wxString
& s
);
2354 void SetCellValue(const wxString
& val
, int row
, int col
);
2358 Sets the cell attributes for all cells in the specified column.
2360 For more information about controlling grid cell attributes see the
2361 wxGridCellAttr cell attribute class and the @ref overview_grid "wxGrid overview".
2363 void SetColAttr(int col
, wxGridCellAttr
* attr
);
2366 Sets the specified column to display boolean values.
2368 @see SetColFormatCustom()
2370 void SetColFormatBool(int col
);
2373 Sets the specified column to display data in a custom format.
2375 This method provides an alternative to defining a custom grid table
2376 which would return @a typeName from its GetTypeName() method for the
2377 cells in this column: while it doesn't really change the type of the
2378 cells in this column, it does associate the renderer and editor used
2379 for the cells of the specified type with them.
2381 See the @ref overview_grid "wxGrid overview" for more
2382 information on working with custom data types.
2384 void SetColFormatCustom(int col
, const wxString
& typeName
);
2387 Sets the specified column to display floating point values with the
2388 given width and precision.
2390 @see SetColFormatCustom()
2392 void SetColFormatFloat(int col
, int width
= -1, int precision
= -1);
2395 Sets the specified column to display integer values.
2397 @see SetColFormatCustom()
2399 void SetColFormatNumber(int col
);
2402 Sets the horizontal and vertical alignment of column label text.
2404 Horizontal alignment should be one of @c wxALIGN_LEFT, @c
2405 wxALIGN_CENTRE or @c wxALIGN_RIGHT.
2406 Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
2407 or @c wxALIGN_BOTTOM.
2409 void SetColLabelAlignment(int horiz
, int vert
);
2412 Sets the height of the column labels.
2414 If @a height equals to @c wxGRID_AUTOSIZE then height is calculated
2415 automatically so that no label is truncated. Note that this could be
2416 slow for a large table.
2418 void SetColLabelSize(int height
);
2421 Set the value for the given column label.
2423 If you are using a custom grid table you must override
2424 wxGridTableBase::SetColLabelValue for this to have any effect.
2426 void SetColLabelValue(int col
, const wxString
& value
);
2429 Sets the minimal width to which the user can resize columns.
2431 @see GetColMinimalAcceptableWidth()
2433 void SetColMinimalAcceptableWidth(int width
);
2436 Sets the minimal width for the specified column.
2438 It is usually best to call this method during grid creation as calling
2439 it later will not resize the column to the given minimal width even if
2440 it is currently narrower than it.
2442 @a width must be greater than the minimal acceptable column width as
2443 returned by GetColMinimalAcceptableWidth().
2445 void SetColMinimalWidth(int col
, int width
);
2448 Sets the position of the specified column.
2450 void SetColPos(int colID
, int newPos
);
2453 Sets the width of the specified column.
2455 Notice that this function does not refresh the grid, you need to call
2456 ForceRefresh() to make the changes take effect immediately.
2461 The new column width in pixels or a negative value to fit the
2462 column width to its label width.
2464 void SetColSize(int col
, int width
);
2467 Sets the default horizontal and vertical alignment for grid cell text.
2469 Horizontal alignment should be one of @c wxALIGN_LEFT, @c
2470 wxALIGN_CENTRE or @c wxALIGN_RIGHT.
2471 Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
2472 or @c wxALIGN_BOTTOM.
2474 void SetDefaultCellAlignment(int horiz
, int vert
);
2477 Sets the default background colour for grid cells.
2479 void SetDefaultCellBackgroundColour(const wxColour
& colour
);
2482 Sets the default font to be used for grid cell text.
2484 void SetDefaultCellFont(const wxFont
& font
);
2487 Sets the current default colour for grid cell text.
2489 void SetDefaultCellTextColour(const wxColour
& colour
);
2492 Sets the default width for columns in the grid.
2494 This will only affect columns subsequently added to the grid unless
2495 @a resizeExistingCols is @true.
2497 If @a width is less than GetColMinimalAcceptableWidth(), then the
2498 minimal acceptable width is used instead of it.
2500 void SetDefaultColSize(int width
, bool resizeExistingCols
= false);
2503 Sets the default editor for grid cells.
2505 The grid will take ownership of the pointer.
2507 See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
2508 for more information about cell editors and renderers.
2510 void SetDefaultEditor(wxGridCellEditor
* editor
);
2513 Sets the default renderer for grid cells.
2515 The grid will take ownership of the pointer.
2517 See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
2518 for more information about cell editors and renderers.
2520 void SetDefaultRenderer(wxGridCellRenderer
* renderer
);
2523 Sets the default height for rows in the grid.
2525 This will only affect rows subsequently added to the grid unless
2526 @a resizeExistingRows is @true.
2528 If @a height is less than GetRowMinimalAcceptableHeight(), then the
2529 minimal acceptable heihgt is used instead of it.
2531 void SetDefaultRowSize(int height
, bool resizeExistingRows
= false);
2535 Set the grid cursor to the specified cell.
2537 The grid cursor indicates the current cell and can be moved by the user
2538 using the arrow keys or the mouse.
2540 Calling this function generates a wxEVT_GRID_SELECT_CELL event and if
2541 the event handler vetoes this event, the cursor is not moved.
2543 This function doesn't make the target call visible, use GoToCell() to
2546 void SetGridCursor(int row
, int col
);
2547 void SetGridCursor(const wxGridCellCoords
& coords
);
2551 Sets the colour used to draw grid lines.
2553 void SetGridLineColour(const wxColour
& colour
);
2556 Sets the background colour for row and column labels.
2558 void SetLabelBackgroundColour(const wxColour
& colour
);
2561 Sets the font for row and column labels.
2563 void SetLabelFont(const wxFont
& font
);
2566 Sets the colour for row and column label text.
2568 void SetLabelTextColour(const wxColour
& colour
);
2571 Sets the extra margins used around the grid area.
2573 A grid may occupy more space than needed for its data display and
2574 this function allows to set how big this extra space is
2576 void SetMargins(int extraWidth
, int extraHeight
);
2579 Makes the cell at the specified location read-only or editable.
2583 void SetReadOnly(int row
, int col
, bool isReadOnly
= true);
2586 Sets the cell attributes for all cells in the specified row.
2588 The grid takes ownership of the attribute pointer.
2590 See the wxGridCellAttr class for more information about controlling
2593 void SetRowAttr(int row
, wxGridCellAttr
* attr
);
2596 Sets the horizontal and vertical alignment of row label text.
2598 Horizontal alignment should be one of @c wxALIGN_LEFT, @c
2599 wxALIGN_CENTRE or @c wxALIGN_RIGHT.
2600 Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
2601 or @c wxALIGN_BOTTOM.
2603 void SetRowLabelAlignment(int horiz
, int vert
);
2606 Sets the width of the row labels.
2608 If @a width equals @c wxGRID_AUTOSIZE then width is calculated
2609 automatically so that no label is truncated. Note that this could be
2610 slow for a large table.
2612 void SetRowLabelSize(int width
);
2615 Sets the value for the given row label.
2617 If you are using a derived grid table you must override
2618 wxGridTableBase::SetRowLabelValue for this to have any effect.
2620 void SetRowLabelValue(int row
, const wxString
& value
);
2623 Sets the minimal row height used by default.
2625 See SetColMinimalAcceptableWidth() for more information.
2627 void SetRowMinimalAcceptableHeight(int height
);
2630 Sets the minimal height for the specified row.
2632 See SetColMinimalWidth() for more information.
2634 void SetRowMinimalHeight(int row
, int height
);
2637 Sets the height of the specified row.
2639 See SetColSize() for more information.
2641 void SetRowSize(int row
, int height
);
2644 Sets the number of pixels per horizontal scroll increment.
2648 @see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
2650 void SetScrollLineX(int x
);
2653 Sets the number of pixels per vertical scroll increment.
2657 @see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
2659 void SetScrollLineY(int y
);
2662 Set the colour to be used for drawing the selection background.
2664 void SetSelectionBackground(const wxColour
& c
);
2667 Set the colour to be used for drawing the selection foreground.
2669 void SetSelectionForeground(const wxColour
& c
);
2672 Set the selection behaviour of the grid.
2674 The existing selection is converted to conform to the new mode if
2675 possible and discarded otherwise (e.g. any individual selected cells
2676 are deselected if the new mode allows only the selection of the entire
2679 void SetSelectionMode(wxGridSelectionModes selmode
);
2682 Passes a pointer to a custom grid table to be used by the grid.
2684 This should be called after the grid constructor and before using the
2685 grid object. If @a takeOwnership is set to @true then the table will be
2686 deleted by the wxGrid destructor.
2688 Use this function instead of CreateGrid() when your application
2689 involves complex or non-string data or data sets that are too large to
2690 fit wholly in memory.
2692 bool SetTable(wxGridTableBase
* table
,
2693 bool takeOwnership
= false,
2694 wxGridSelectionModes selmode
= wxGridSelectCells
);
2697 Call this in order to make the column labels use a native look by using
2698 wxRenderer::DrawHeaderButton internally.
2700 There is no equivalent method for drawing row columns as there is not
2701 native look for that. This option is useful when using wxGrid for
2702 displaying tables and not as a spread-sheet.
2704 void SetUseNativeColLabels(bool native
= true);
2707 Displays the in-place cell edit control for the current cell.
2709 void ShowCellEditControl();
2712 Returns the column at the given pixel position.
2715 The x position to evaluate.
2717 If @true, rather than returning wxNOT_FOUND, it returns either the
2718 first or last column depending on whether x is too far to the left
2719 or right respectively.
2721 The column index or wxNOT_FOUND.
2723 int XToCol(int x
, bool clipToMinMax
= false) const;
2726 Returns the column whose right hand edge is close to the given logical
2729 If no column edge is near to this position @c wxNOT_FOUND is returned.
2731 int XToEdgeOfCol(int x
) const;
2735 Translates logical pixel coordinates to the grid cell coordinates.
2737 Notice that this function expects logical coordinates on input so if
2738 you use this function in a mouse event handler you need to translate
2739 the mouse position, which is expressed in device coordinates, to
2742 @see XToCol(), YToRow()
2745 // XYToCell(int, int, wxGridCellCoords&) overload is intentionally
2746 // undocumented, using it is ugly and non-const reference parameters are
2747 // not used in wxWidgets API
2749 wxGridCellCoords
XYToCell(int x
, int y
) const;
2750 wxGridCellCoords
XYToCell(const wxPoint
& pos
) const;
2755 Returns the row whose bottom edge is close to the given logical y
2758 If no row edge is near to this position @c wxNOT_FOUND is returned.
2760 int YToEdgeOfRow(int y
) const;
2763 Returns the grid row that corresponds to the logical y coordinate.
2765 Returns @c wxNOT_FOUND if there is no row at the y position.
2767 int YToRow(int y
, bool clipToMinMax
= false) const;
2771 Returns @true if this grid has support for cell attributes.
2773 The grid supports attributes if it has the associated table which, in
2774 turn, has attributes support, i.e. wxGridTableBase::CanHaveAttributes()
2777 bool CanHaveAttributes() const;
2780 Get the minimal width of the given column/row.
2782 The value returned by this function may be different than that returned
2783 by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
2784 called for this column.
2786 int GetColMinimalWidth(int col
) const;
2789 Returns the coordinate of the right border specified column.
2791 int GetColRight(int col
) const;
2794 Returns the coordinate of the left border specified column.
2796 int GetColLeft(int col
) const;
2799 Returns the minimal size for the given column.
2801 The value returned by this function may be different than that returned
2802 by GetRowMinimalAcceptableHeight() if SetRowMinimalHeight() had been
2803 called for this row.
2805 int GetRowMinimalHeight(int col
) const;
2811 @class wxGridUpdateLocker
2813 This small class can be used to prevent wxGrid from redrawing during its
2814 lifetime by calling wxGrid::BeginBatch() in its constructor and
2815 wxGrid::EndBatch() in its destructor. It is typically used in a function
2816 performing several operations with a grid which would otherwise result in
2817 flicker. For example:
2822 m_grid = new wxGrid(this, ...);
2824 wxGridUpdateLocker noUpdates(m_grid);
2825 m_grid-AppendColumn();
2826 // ... many other operations with m_grid ...
2829 // destructor called, grid refreshed
2833 Using this class is easier and safer than calling wxGrid::BeginBatch() and
2834 wxGrid::EndBatch() because you don't risk missing the call the latter (due
2835 to an exception for example).
2840 class wxGridUpdateLocker
2844 Creates an object preventing the updates of the specified @a grid. The
2845 parameter could be @NULL in which case nothing is done. If @a grid is
2846 non-@NULL then the grid must exist for longer than this
2847 wxGridUpdateLocker object itself.
2849 The default constructor could be followed by a call to Create() to set
2850 the grid object later.
2852 wxGridUpdateLocker(wxGrid
* grid
= NULL
);
2855 Destructor reenables updates for the grid this object is associated
2858 ~wxGridUpdateLocker();
2861 This method can be called if the object had been constructed using the
2862 default constructor. It must not be called more than once.
2864 void Create(wxGrid
* grid
);
2872 This event class contains information about various grid events.
2874 @beginEventTable{wxGridEvent}
2875 @event{EVT_GRID_CELL_CHANGE(func)}
2876 The user changed the data in a cell. Processes a
2877 @c wxEVT_GRID_CELL_CHANGE event type.
2878 @event{EVT_GRID_CELL_LEFT_CLICK(func)}
2879 The user clicked a cell with the left mouse button. Processes a
2880 @c wxEVT_GRID_CELL_LEFT_CLICK event type.
2881 @event{EVT_GRID_CELL_LEFT_DCLICK(func)}
2882 The user double-clicked a cell with the left mouse button. Processes a
2883 @c wxEVT_GRID_CELL_LEFT_DCLICK event type.
2884 @event{EVT_GRID_CELL_RIGHT_CLICK(func)}
2885 The user clicked a cell with the right mouse button. Processes a
2886 @c wxEVT_GRID_CELL_RIGHT_CLICK event type.
2887 @event{EVT_GRID_CELL_RIGHT_DCLICK(func)}
2888 The user double-clicked a cell with the right mouse button. Processes a
2889 @c wxEVT_GRID_CELL_RIGHT_DCLICK event type.
2890 @event{EVT_GRID_EDITOR_HIDDEN(func)}
2891 The editor for a cell was hidden. Processes a
2892 @c wxEVT_GRID_EDITOR_HIDDEN event type.
2893 @event{EVT_GRID_EDITOR_SHOWN(func)}
2894 The editor for a cell was shown. Processes a
2895 @c wxEVT_GRID_EDITOR_SHOWN event type.
2896 @event{EVT_GRID_LABEL_LEFT_CLICK(func)}
2897 The user clicked a label with the left mouse button. Processes a
2898 @c wxEVT_GRID_LABEL_LEFT_CLICK event type.
2899 @event{EVT_GRID_LABEL_LEFT_DCLICK(func)}
2900 The user double-clicked a label with the left mouse button. Processes a
2901 @c wxEVT_GRID_LABEL_LEFT_DCLICK event type.
2902 @event{EVT_GRID_LABEL_RIGHT_CLICK(func)}
2903 The user clicked a label with the right mouse button. Processes a
2904 @c wxEVT_GRID_LABEL_RIGHT_CLICK event type.
2905 @event{EVT_GRID_LABEL_RIGHT_DCLICK(func)}
2906 The user double-clicked a label with the right mouse button. Processes
2907 a @c wxEVT_GRID_LABEL_RIGHT_DCLICK event type.
2908 @event{EVT_GRID_SELECT_CELL(func)}
2909 The user moved to, and selected a cell. Processes a
2910 @c wxEVT_GRID_SELECT_CELL event type.
2911 @event{EVT_GRID_CMD_CELL_CHANGE(id, func)}
2912 The user changed the data in a cell; variant taking a window
2913 identifier. Processes a @c wxEVT_GRID_CELL_CHANGE event type.
2914 @event{EVT_GRID_CMD_CELL_LEFT_CLICK(id, func)}
2915 The user clicked a cell with the left mouse button; variant taking a
2916 window identifier. Processes a @c wxEVT_GRID_CELL_LEFT_CLICK event
2918 @event{EVT_GRID_CMD_CELL_LEFT_DCLICK(id, func)}
2919 The user double-clicked a cell with the left mouse button; variant
2920 taking a window identifier. Processes a @c wxEVT_GRID_CELL_LEFT_DCLICK
2922 @event{EVT_GRID_CMD_CELL_RIGHT_CLICK(id, func)}
2923 The user clicked a cell with the right mouse button; variant taking a
2924 window identifier. Processes a @c wxEVT_GRID_CELL_RIGHT_CLICK event
2926 @event{EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, func)}
2927 The user double-clicked a cell with the right mouse button; variant
2928 taking a window identifier. Processes a @c wxEVT_GRID_CELL_RIGHT_DCLICK
2930 @event{EVT_GRID_CMD_EDITOR_HIDDEN(id, func)}
2931 The editor for a cell was hidden; variant taking a window identifier.
2932 Processes a @c wxEVT_GRID_EDITOR_HIDDEN event type.
2933 @event{EVT_GRID_CMD_EDITOR_SHOWN(id, func)}
2934 The editor for a cell was shown; variant taking a window identifier.
2935 Processes a @c wxEVT_GRID_EDITOR_SHOWN event type.
2936 @event{EVT_GRID_CMD_LABEL_LEFT_CLICK(id, func)}
2937 The user clicked a label with the left mouse button; variant taking a
2938 window identifier. Processes a @c wxEVT_GRID_LABEL_LEFT_CLICK event
2940 @event{EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, func)}
2941 The user double-clicked a label with the left mouse button; variant
2942 taking a window identifier. Processes a @c wxEVT_GRID_LABEL_LEFT_DCLICK
2944 @event{EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, func)}
2945 The user clicked a label with the right mouse button; variant taking a
2946 window identifier. Processes a @c wxEVT_GRID_LABEL_RIGHT_CLICK event
2948 @event{EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, func)}
2949 The user double-clicked a label with the right mouse button; variant
2950 taking a window identifier. Processes a
2951 @c wxEVT_GRID_LABEL_RIGHT_DCLICK event type.
2952 @event{EVT_GRID_CMD_SELECT_CELL(id, func)}
2953 The user moved to, and selected a cell; variant taking a window
2954 identifier. Processes a @c wxEVT_GRID_SELECT_CELL event type.
2960 class wxGridEvent
: public wxNotifyEvent
2964 Default constructor.
2968 Constructor for initializing all event attributes.
2970 wxGridEvent(int id
, wxEventType type
, wxObject
* obj
,
2971 int row
= -1, int col
= -1, int x
= -1, int y
= -1,
2972 bool sel
= true, bool control
= false, bool shift
= false,
2973 bool alt
= false, bool meta
= false);
2976 Returns @true if the Alt key was down at the time of the event.
2978 bool AltDown() const;
2981 Returns @true if the Control key was down at the time of the event.
2983 bool ControlDown() const;
2986 Column at which the event occurred.
2988 virtual int GetCol();
2991 Position in pixels at which the event occurred.
2993 wxPoint
GetPosition();
2996 Row at which the event occurred.
2998 virtual int GetRow();
3001 Returns @true if the Meta key was down at the time of the event.
3003 bool MetaDown() const;
3006 Returns @true if the user is selecting grid cells, or @false if
3012 Returns @true if the Shift key was down at the time of the event.
3014 bool ShiftDown() const;
3020 @class wxGridSizeEvent
3022 This event class contains information about a row/column resize event.
3024 @beginEventTable{wxGridSizeEvent}
3025 @event{EVT_GRID_COL_SIZE(func)}
3026 The user resized a column by dragging it. Processes a
3027 @c wxEVT_GRID_COL_SIZE event type.
3028 @event{EVT_GRID_ROW_SIZE(func)}
3029 The user resized a row by dragging it. Processes a
3030 @c wxEVT_GRID_ROW_SIZE event type.
3031 @event{EVT_GRID_CMD_COL_SIZE(id, func)}
3032 The user resized a column by dragging it; variant taking a window
3033 identifier. Processes a @c wxEVT_GRID_COL_SIZE event type.
3034 @event{EVT_GRID_CMD_ROW_SIZE(id, func)}
3035 The user resized a row by dragging it; variant taking a window
3036 identifier. Processes a @c wxEVT_GRID_ROW_SIZE event type.
3042 class wxGridSizeEvent
: public wxNotifyEvent
3046 Default constructor.
3050 Constructor for initializing all event attributes.
3052 wxGridSizeEvent(int id
, wxEventType type
, wxObject
* obj
,
3053 int rowOrCol
= -1, int x
= -1, int y
= -1,
3054 bool control
= false, bool shift
= false,
3055 bool alt
= false, bool meta
= false);
3058 Returns @true if the Alt key was down at the time of the event.
3060 bool AltDown() const;
3063 Returns @true if the Control key was down at the time of the event.
3065 bool ControlDown() const;
3068 Position in pixels at which the event occurred.
3070 wxPoint
GetPosition();
3073 Row or column at that was resized.
3078 Returns @true if the Meta key was down at the time of the event.
3080 bool MetaDown() const;
3083 Returns @true if the Shift key was down at the time of the event.
3085 bool ShiftDown() const;
3091 @class wxGridRangeSelectEvent
3093 @beginEventTable{wxGridRangeSelectEvent}
3094 @event{EVT_GRID_RANGE_SELECT(func)}
3095 The user selected a group of contiguous cells. Processes a
3096 @c wxEVT_GRID_RANGE_SELECT event type.
3097 @event{EVT_GRID_CMD_RANGE_SELECT(id, func)}
3098 The user selected a group of contiguous cells; variant taking a window
3099 identifier. Processes a @c wxEVT_GRID_RANGE_SELECT event type.
3105 class wxGridRangeSelectEvent
: public wxNotifyEvent
3109 Default constructor.
3111 wxGridRangeSelectEvent();
3113 Constructor for initializing all event attributes.
3115 wxGridRangeSelectEvent(int id
, wxEventType type
,
3117 const wxGridCellCoords
& topLeft
,
3118 const wxGridCellCoords
& bottomRight
,
3119 bool sel
= true, bool control
= false,
3120 bool shift
= false, bool alt
= false,
3124 Returns @true if the Alt key was down at the time of the event.
3126 bool AltDown() const;
3129 Returns @true if the Control key was down at the time of the event.
3131 bool ControlDown() const;
3134 Top left corner of the rectangular area that was (de)selected.
3136 wxGridCellCoords
GetBottomRightCoords();
3139 Bottom row of the rectangular area that was (de)selected.
3144 Left column of the rectangular area that was (de)selected.
3149 Right column of the rectangular area that was (de)selected.
3154 Top left corner of the rectangular area that was (de)selected.
3156 wxGridCellCoords
GetTopLeftCoords();
3159 Top row of the rectangular area that was (de)selected.
3164 Returns @true if the Meta key was down at the time of the event.
3166 bool MetaDown() const;
3169 Returns @true if the area was selected, @false otherwise.
3174 Returns @true if the Shift key was down at the time of the event.
3176 bool ShiftDown() const;
3182 @class wxGridEditorCreatedEvent
3184 @beginEventTable{wxGridEditorCreatedEvent}
3185 @event{EVT_GRID_EDITOR_CREATED(func)}
3186 The editor for a cell was created. Processes a
3187 @c wxEVT_GRID_EDITOR_CREATED event type.
3188 @event{EVT_GRID_CMD_EDITOR_CREATED(id, func)}
3189 The editor for a cell was created; variant taking a window identifier.
3190 Processes a @c wxEVT_GRID_EDITOR_CREATED event type.
3196 class wxGridEditorCreatedEvent
: public wxCommandEvent
3200 Default constructor.
3202 wxGridEditorCreatedEvent();
3204 Constructor for initializing all event attributes.
3206 wxGridEditorCreatedEvent(int id
, wxEventType type
, wxObject
* obj
,
3207 int row
, int col
, wxControl
* ctrl
);
3210 Returns the column at which the event occurred.
3215 Returns the edit control.
3217 wxControl
* GetControl();
3220 Returns the row at which the event occurred.
3225 Sets the column at which the event occurred.
3227 void SetCol(int col
);
3230 Sets the edit control.
3232 void SetControl(wxControl
* ctrl
);
3235 Sets the row at which the event occurred.
3237 void SetRow(int row
);