wxGridCellBoolEditor (wx v2.5.4)

Copy Markdown View Source

Grid cell editor for boolean data.

See:

This class is derived, and can use functions, from:

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

wxGridCellBoolEditor()

-type wxGridCellBoolEditor() :: wx:wx_object().

Functions

destroy(This :: wxGridCellBoolEditor()) -> ok

Destroys the object

isTrueValue(Value :: unicode:chardata()) -> boolean()

Returns true if the given value is equal to the string representation of the truth value we currently use (see useStringValues/1).

new() -> Result

Types

Result = wxGridCellBoolEditor()

Default constructor.

useStringValues() ≡ useStringValues([])

useStringValues(Options :: [Option]) -> ok

Types

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.