1wxGridCellEditor(3)        Erlang Module Definition        wxGridCellEditor(3)
2
3
4

NAME

6       wxGridCellEditor - Functions for wxGridCellEditor class
7

DESCRIPTION

9       This  class  is responsible for providing and manipulating the in-place
10       edit controls for the grid. Instances  of  wxGridCellEditor  (actually,
11       instances  of derived classes since it is an abstract class) can be as‐
12       sociated with the cell attributes for individual cells, rows,  columns,
13       or even for the entire grid.
14
15       Normally  wxGridCellEditor  shows  some UI control allowing the user to
16       edit the cell, but starting with wxWidgets 3.1.4 it's also possible  to
17       define  "activatable"  cell  editors, that change the value of the cell
18       directly when it's activated (typically by pressing Space key or click‐
19       ing on it), see TryActivate() (not implemented in wx) method. Note that
20       when implementing an editor which is  always  activatable,  i.e.  never
21       shows  any  in-place  editor, it is more convenient to derive its class
22       from wxGridCellActivatableEditor (not implemented in wx) than from  wx‐
23       GridCellEditor itself.
24
25       See:  wxGridCellAutoWrapStringEditor  (not  implemented in wx), wxGrid‐
26       CellBoolEditor, wxGridCellChoiceEditor, wxGridCellEnumEditor  (not  im‐
27       plemented  in  wx),  wxGridCellFloatEditor, wxGridCellNumberEditor, wx‐
28       GridCellTextEditor, wxGridCellDateEditor (not implemented in wx)
29
30       wxWidgets docs: wxGridCellEditor
31

DATA TYPES

33       wxGridCellEditor() = wx:wx_object()
34

EXPORTS

36       create(This, Parent, Id, EvtHandler) -> ok
37
38              Types:
39
40                 This = wxGridCellEditor()
41                 Parent = wxWindow:wxWindow()
42                 Id = integer()
43                 EvtHandler = wxEvtHandler:wxEvtHandler()
44
45              Creates the actual edit control.
46
47       isCreated(This) -> boolean()
48
49              Types:
50
51                 This = wxGridCellEditor()
52
53              Returns true if the edit control has been created.
54
55       setSize(This, Rect) -> ok
56
57              Types:
58
59                 This = wxGridCellEditor()
60                 Rect =
61                     {X :: integer(),
62                      Y :: integer(),
63                      W :: integer(),
64                      H :: integer()}
65
66              Size and position the edit control.
67
68       show(This, Show) -> ok
69
70              Types:
71
72                 This = wxGridCellEditor()
73                 Show = boolean()
74
75       show(This, Show, Options :: [Option]) -> ok
76
77              Types:
78
79                 This = wxGridCellEditor()
80                 Show = boolean()
81                 Option = {attr, wxGridCellAttr:wxGridCellAttr()}
82
83              Show or hide the edit control, use the specified  attributes  to
84              set colours/fonts for it.
85
86       reset(This) -> ok
87
88              Types:
89
90                 This = wxGridCellEditor()
91
92              Reset the value in the control back to its starting value.
93
94       startingKey(This, Event) -> ok
95
96              Types:
97
98                 This = wxGridCellEditor()
99                 Event = wxKeyEvent:wxKeyEvent()
100
101              If the editor is enabled by pressing keys on the grid, this will
102              be called to let the editor do something about that first key if
103              desired.
104
105       startingClick(This) -> ok
106
107              Types:
108
109                 This = wxGridCellEditor()
110
111              If  the  editor  is enabled by clicking on the cell, this method
112              will be called.
113
114       handleReturn(This, Event) -> ok
115
116              Types:
117
118                 This = wxGridCellEditor()
119                 Event = wxKeyEvent:wxKeyEvent()
120
121              Some types of controls on some platforms may need some help with
122              the Return key.
123
124
125
126wxWidgets team.                    wx 2.3.1                wxGridCellEditor(3)