wxGridCellBoolEditor — wx v2.4.2

Search documentation of wx

# 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

## Types

wxGridCellBoolEditor()

## Functions

destroy(This)

Destroys the object.

isTrueValue(Value)

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

new()

Default constructor.

useStringValues()
useStringValues(Options)

This method allows you to customize the values returned by `wxGridCellNumberEditor:getValue/1` for the cell using this editor.

# Types

Link to this type

# wxGridCellBoolEditor()

View Source

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

# Functions

Link to this function

# destroy(This)

View Source

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

Destroys the object.

Link to this function

# isTrueValue(Value)

View Source

    -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`).

Link to this function

# new()

View Source

    -spec new() -> wxGridCellBoolEditor().

Default constructor.

Link to this function

# useStringValues()

View Source

    -spec useStringValues() -> ok.

Link to this function

# useStringValues(Options)

View Source

    -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.