View Source wxGridCellBoolEditor (wx v2.4.2)
Functions for wxGridCellBoolEditor class
Grid cell editor for boolean data.
See: wxGridCellEditor
, wxGridCellAutoWrapStringEditor
(not implemented in
wx), wxGridCellChoiceEditor
, wxGridCellEnumEditor
(not implemented in wx),
wxGridCellFloatEditor
, wxGridCellNumberEditor
, wxGridCellTextEditor
,
wxGridCellDateEditor
(not implemented in wx)
This class is derived (and can use functions) from: wxGridCellEditor
wxWidgets docs: wxGridCellBoolEditor
Summary
Functions
Destroys the object.
Returns true if the given value
is equal to the string representation of the
truth value we currently use (see useStringValues/1
).
Default constructor.
This method allows you to customize the values returned by
wxGridCellNumberEditor:getValue/1
for the cell using this editor.
Types
-type wxGridCellBoolEditor() :: wx:wx_object().
Functions
-spec destroy(This :: wxGridCellBoolEditor()) -> ok.
Destroys the object.
-spec isTrueValue(Value) -> boolean() when Value :: unicode:chardata().
Returns true if the given value
is equal to the string representation of the
truth value we currently use (see useStringValues/1
).
-spec new() -> wxGridCellBoolEditor().
Default constructor.
-spec useStringValues() -> ok.
-spec useStringValues([Option]) -> ok when Option :: {valueTrue, unicode:chardata()} | {valueFalse, unicode:chardata()}.
This method allows you to customize the values returned by
wxGridCellNumberEditor:getValue/1
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.