Phoenix Logo

phoenix_title wx.grid.GridCellBoolEditor

Grid cell editor for boolean data.


class_hierarchy Class Hierarchy

Inheritance diagram for class GridCellBoolEditor:


method_summary Methods Summary

__init__ Default constructor.
EndEdit End editing the cell.
IsTrueValue Returns True if the given value is equal to the string representation of the truth value we currently use (see UseStringValues ).
UseStringValues This method allows you to customize the values returned by GetValue for the cell using this editor.

api Class API



class wx.grid.GridCellBoolEditor(GridCellEditor)

Possible constructors:

GridCellBoolEditor()

Grid cell editor for boolean data.


Methods



__init__(self)

Default constructor.



EndEdit(self, row, col, grid, oldval)

End editing the cell.

This function must check if the current value of the editing cell is valid and different from the original value in its string form. If not then simply return None. If it has changed then this method should save the new value so that ApplyEdit can apply it later and the string representation of the new value should be returned.

Notice that this method shoiuld not modify the grid as the change could still be vetoed.



static IsTrueValue(value)

Returns True if the given value is equal to the string representation of the truth value we currently use (see UseStringValues ).

Parameters:value (string) –
Return type:bool


static UseStringValues(valueTrue="1", valueFalse="")

This method allows you to customize the values returned by GetValue for the cell using this editor.

By default, the default values of the arguments are used, i.e. "1" is returned if the cell is checked and an empty string otherwise.

Parameters:
  • valueTrue (string) –
  • valueFalse (string) –