wx.grid.GridCellEditor

Inheritance diagram for wx.grid.GridCellEditor:

Description

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.

See also

wx.grid.GridCellTextEditor, wx.grid.GridCellFloatEditor, wx.grid.GridCellBoolEditor, wx.grid.GridCellNumberEditor, wx.grid.GridCellChoiceEditor

Known Subclasses

wx.grid.GridCellAutoWrapStringEditor, wx.grid.GridCellBoolEditor, wx.grid.GridCellChoiceEditor, wx.grid.GridCellEnumEditor, wx.grid.GridCellFloatEditor, wx.grid.GridCellNumberEditor, wx.grid.GridCellTextEditor, wx.grid.PyGridCellEditor

Methods Summary

• __init__
• BeginEdit
• Clone
• Create
• Destroy
• EndEdit
• GetCellAttr
• GetControl
• HandleReturn
• IsAcceptedKey
• IsCreated
• PaintBackground
• Reset
• SetCellAttr
• SetControl
• SetSize
• Show
• StartingClick
• StartingKey

Properties Summary

• CellAttr
• Control

Class API

Methods

__init__()

No docstrings available for this method.

---

BeginEdit(row, col, grid)

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

Parameters:

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

---

Clone()

Create a new object which is the copy of this one.

Returns:

wx.grid.GridCellEditor

---

Create(parent, id, evtHandler)

Creates the actual edit control.

Parameters:

• parent (wx.Window)
• id (int)
• evtHandler (wx.EvtHandler)

---

Destroy()

Final cleanup.

---

EndEdit(row, col, grid)

Complete the editing of the current cell.

Returns True if the value has changed. If necessary, the control may be destroyed.

Parameters:

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

Returns:

bool

---

GetCellAttr()

No docstrings available for this method.

---

GetControl()

No docstrings available for this method.

---

HandleReturn(event)

Some types of controls on some platforms may need some help with the Return key.

Parameters:

• event (wx.KeyEvent)

---

IsAcceptedKey(event)

Parameters:

• event (wx.KeyEvent)

Returns:

bool

---

IsCreated()

Returns:

bool

---

PaintBackground(rectCell, attr)

Draws the part of the cell not occupied by the control: the base class version just fills it with background colour from the attribute.

Parameters:

• rectCell (wx.Rect)
• attr (wx.grid.GridCellAttr)

---

Reset()

Reset the value in the control back to its starting value.

---

SetCellAttr(attr)

Parameters:

• attr (wx.grid.GridCellAttr)

---

SetControl(control)

Parameters:

• control (wx.Control)

---

SetSize(rect)

Size and position the edit control.

Parameters:

• rect (wx.Rect)

---

Show(show, attr=None)

Show or hide the edit control, use the specified attributes to set colours/fonts for it.

Parameters:

• show (bool)
• attr (wx.grid.GridCellAttr)

---

StartingClick()

If the editor is enabled by clicking on the cell, this method will be called.

---

StartingKey(event)

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.

Parameters:

• event (wx.KeyEvent)

---

Properties

CellAttr

See GetCellAttr and SetCellAttr

Control

See GetControl and SetControl