wx.grid.GridActivationResult

Represents the result of wx.grid.GridCellEditor.TryActivate .

Editors overriding wx.grid.GridCellEditor.TryActivate must use one of DoNothing, DoChange or DoEdit methods to return an object of this type corresponding to the desired action.

Added in version 4.1/wxWidgets-3.1.4.

Class Hierarchy

Inheritance diagram for class GridActivationResult:

Methods Summary

DoChange	Indicate that activating the cell is possible and would change its value to the given one.
DoEdit	Indicate that the editor control should be shown and the cell should be edited normally.
DoNothing	Indicate that nothing should be done and the cell shouldn’t be edited at all.

Class API

class wx.grid.GridActivationResult(object)

Represents the result of GridCellEditor.TryActivate().

Methods

static DoChange(newval)

Indicate that activating the cell is possible and would change its value to the given one.

This is the method to call for activatable editors, using it will result in changing the value of the cell to newval without showing the editor control at all.

Note that the change may still be vetoed by wxEVT_GRID_CELL_CHANGING handler.

Parameters:

newval (string)

Return type:

wx.grid.GridActivationResult

---

static DoEdit()

Indicate that the editor control should be shown and the cell should be edited normally.

This is the default return value of wx.grid.GridCellEditor.TryActivate .

Return type:

wx.grid.GridActivationResult

---

static DoNothing()

Indicate that nothing should be done and the cell shouldn’t be edited at all.

Note that this is different from DoEdit and may be useful when the value of the cell wouldn’t change if it were activated anyhow, e.g. because the key or mouse event carried by wx.grid.GridActivationSource would leave the cell value unchanged.

Return type:

wx.grid.GridActivationResult