wxGridCellEditor - Functions for wxGridCellEditor class
Please see following description for synopsis
wxGridCellEditor(3) Erlang Module Definition wxGridCellEditor(3)
NAME
wxGridCellEditor - Functions for wxGridCellEditor class
DESCRIPTION
This class is responsible for providing and manipulating the in-place
edit controls for the grid. Instances of wxGridCellEditor (actually,
instances of derived classes since it is an abstract class) can be
associated with the cell attributes for individual cells, rows, col-
umns, or even for the entire grid.
Normally wxGridCellEditor shows some UI control allowing the user to
edit the cell, but starting with wxWidgets 3.1.4 it's also possible to
define "activatable" cell editors, that change the value of the cell
directly when it's activated (typically by pressing Space key or click-
ing on it), see TryActivate() (not implemented in wx) method. Note that
when implementing an editor which is always activatable, i.e. never
shows any in-place editor, it is more convenient to derive its class
from wxGridCellActivatableEditor (not implemented in wx) than from
wxGridCellEditor itself.
See: wxGridCellAutoWrapStringEditor (not implemented in wx), wxGrid-
CellBoolEditor, wxGridCellChoiceEditor, wxGridCellEnumEditor (not
implemented in wx), wxGridCellFloatEditor, wxGridCellNumberEditor,
wxGridCellTextEditor, wxGridCellDateEditor (not implemented in wx)
wxWidgets docs: wxGridCellEditor
DATA TYPES
wxGridCellEditor() = wx:wx_object()
EXPORTS
create(This, Parent, Id, EvtHandler) -> ok
Types:
This = wxGridCellEditor()
Parent = wxWindow:wxWindow()
Id = integer()
EvtHandler = wxEvtHandler:wxEvtHandler()
Creates the actual edit control.
isCreated(This) -> boolean()
Types:
This = wxGridCellEditor()
Returns true if the edit control has been created.
setSize(This, Rect) -> ok
Types:
This = wxGridCellEditor()
Rect =
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}
Size and position the edit control.
show(This, Show) -> ok
Types:
This = wxGridCellEditor()
Show = boolean()
show(This, Show, Options :: [Option]) -> ok
Types:
This = wxGridCellEditor()
Show = boolean()
Option = {attr, wxGridCellAttr:wxGridCellAttr()}
Show or hide the edit control, use the specified attributes to
set colours/fonts for it.
reset(This) -> ok
Types:
This = wxGridCellEditor()
Reset the value in the control back to its starting value.
startingKey(This, Event) -> ok
Types:
This = wxGridCellEditor()
Event = wxKeyEvent:wxKeyEvent()
If the editor is enabled by pressing keys on the grid, this will
be called to let the editor do something about that first key if
desired.
startingClick(This) -> ok
Types:
This = wxGridCellEditor()
If the editor is enabled by clicking on the cell, this method
will be called.
handleReturn(This, Event) -> ok
Types:
This = wxGridCellEditor()
Event = wxKeyEvent:wxKeyEvent()
Some types of controls on some platforms may need some help with
the Return key.
wxWidgets team. wx 2.1.1 wxGridCellEditor(3)