wx.grid.GridCellEditor¶

This class is responsible for providing and manipulating the in-place edit controls for the grid.

Instances of wx.grid.GridCellEditor (actually, instances of derived classes since it is an abstract class) can be associated with the cell attributes for individual cells, rows, columns, or even for the entire grid.

Normally wx.grid.GridCellEditor shows some UI control allowing the user to edit the cell, but starting with wxWidgets 3.1.4 it’s also possible to define “activatable” cell editors, that change the value of the cell directly when it’s activated (typically by pressing Space key or clicking on it), see TryActivate method. Note that when implementing an editor which is always activatable, i.e. never shows any in-place editor, it is more convenient to derive its class from wx.grid.GridCellActivatableEditor than from wx.grid.GridCellEditor itself.

Class Hierarchy¶

Inheritance diagram for class GridCellEditor:

Known Subclasses¶

wx.grid.GridCellActivatableEditor, wx.grid.GridCellBoolEditor, wx.grid.GridCellChoiceEditor, wx.grid.GridCellDateEditor, wx.grid.GridCellTextEditor

Methods Summary¶

`__init__`	Default constructor.
`ApplyEdit`	Effectively save the changes in the grid.
`BeginEdit`	Fetch the value from the table and prepare the edit control to begin editing.
`Clone`	Create a new object which is the copy of this one.
`Create`	Creates the actual edit control.
`Destroy`	Final cleanup.
`DoActivate`	Function which must be overridden for “activatable” editors.
`EndEdit`	End editing the cell.
`GetControl`	Get the wx.Control used by this editor.
`GetValue`	Returns the value currently in the editor control.
`GetWindow`	Get the edit window used by this editor.
`HandleReturn`	Some types of controls on some platforms may need some help with the Return key.
`IsAcceptedKey`	Return `True` to allow the given key to start editing: the base class version only checks that the event has no modifiers.
`IsCreated`	Returns `True` if the edit control has been created.
`PaintBackground`	Draws the part of the cell not occupied by the control: the base class version just fills it with background colour from the attribute.
`Reset`	Reset the value in the control back to its starting value.
`SetControl`	Set the wx.Control that will be used by this cell editor for editing the value.
`SetSize`	Size and position the edit control.
`SetWindow`	Set the wx.Window that will be used by this cell editor for editing the value.
`Show`	Show or hide the edit control, use the specified attributes to set colours/fonts for it.
`StartingClick`	If the editor is enabled by clicking on the cell, this method will be called.
`StartingKey`	If the editor is enabled by pressing keys on the grid, this will be called to let the editor do something about that first key if desired.
`TryActivate`	Function allowing to create an “activatable” editor.
`~wxGridCellEditor`	The destructor is private because only `DecRef` can delete us.

Properties Summary¶

`Control`	See `GetControl` and `SetControl`
`Value`	See `GetValue`
`Window`	See `GetWindow` and `SetWindow`

Class API¶

class wx.grid.GridCellEditor(SharedClientDataContainer, RefCounter)¶

Possible constructors:

GridCellEditor() -> None

This class is responsible for providing and manipulating the in-place edit controls for the grid.

Methods¶

__init__(self)¶

Default constructor.

Return type:: None

ApplyEdit(self, row, col, grid)¶

Effectively save the changes in the grid.

This function should save the value of the control in the grid. It is called only after EndEdit returns True.

Parameters:

row (int)
col (int)
grid (wx.grid.Grid)

Return type:

None

BeginEdit(self, row, col, grid)¶

Fetch the value from the table and prepare the edit control to begin editing.

This function should save the original value of the grid cell at the given row and col and show the control allowing the user to change it.