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

NAME

6       wxGridEvent - Functions for wxGridEvent class
7

DESCRIPTION

9       This event class contains information about various grid events.
10
11       Notice  that all grid event table macros are available in two versions:
12       EVT_GRID_XXX and EVT_GRID_CMD_XXX. The only difference between the  two
13       is  that the former doesn't allow to specify the grid window identifier
14       and so takes a single parameter, the event handler, but is not suitable
15       if  there  is  more than one grid control in the window where the event
16       table is used (as it would catch the events from all  the  grids).  The
17       version  with  CMD takes the id as first argument and the event handler
18       as the second one and so can be used with multiple grids as well.  Oth‐
19       erwise  there  are  no difference between the two and only the versions
20       without the id are documented below for brevity.
21
22       This class is derived (and can use functions) from:  wxNotifyEvent  wx‐
23       CommandEvent wxEvent
24
25       wxWidgets docs: wxGridEvent
26

EVENTS

28       Use  wxEvtHandler:connect/3 with wxGridEventType to subscribe to events
29       of this type.
30

DATA TYPES

32       wxGridEvent() = wx:wx_object()
33
34       wxGrid() =
35           #wxGrid{type = wxGridEvent:wxGridEventType(),
36                   row = integer(),
37                   col = integer(),
38                   pos = {X :: integer(), Y :: integer()},
39                   selecting = boolean(),
40                   control = boolean(),
41                   meta = boolean(),
42                   shift = boolean(),
43                   alt = boolean()}
44
45       wxGridEventType() =
46           grid_cell_left_click | grid_cell_right_click |
47           grid_cell_left_dclick | grid_cell_right_dclick |
48           grid_label_left_click | grid_label_right_click |
49           grid_label_left_dclick | grid_label_right_dclick |
50           grid_row_size | grid_col_size | grid_range_select |
51           grid_cell_changed | grid_select_cell | grid_editor_shown |
52           grid_editor_hidden | grid_editor_created |
53           grid_cell_begin_drag
54

EXPORTS

56       altDown(This) -> boolean()
57
58              Types:
59
60                 This = wxGridEvent()
61
62              Returns true if the Alt key was down at the time of the event.
63
64       controlDown(This) -> boolean()
65
66              Types:
67
68                 This = wxGridEvent()
69
70              Returns true if the Control key was down  at  the  time  of  the
71              event.
72
73       getCol(This) -> integer()
74
75              Types:
76
77                 This = wxGridEvent()
78
79              Column at which the event occurred.
80
81              Notice  that  for  a wxEVT_GRID_SELECT_CELL event this column is
82              the column of the newly selected cell while the  previously  se‐
83              lected cell can be retrieved using wxGrid:getGridCursorCol/1.
84
85       getPosition(This) -> {X :: integer(), Y :: integer()}
86
87              Types:
88
89                 This = wxGridEvent()
90
91              Position in pixels at which the event occurred.
92
93       getRow(This) -> integer()
94
95              Types:
96
97                 This = wxGridEvent()
98
99              Row at which the event occurred.
100
101              Notice  that  for a wxEVT_GRID_SELECT_CELL event this row is the
102              row of the newly selected cell  while  the  previously  selected
103              cell can be retrieved using wxGrid:getGridCursorRow/1.
104
105       metaDown(This) -> boolean()
106
107              Types:
108
109                 This = wxGridEvent()
110
111              Returns true if the Meta key was down at the time of the event.
112
113       selecting(This) -> boolean()
114
115              Types:
116
117                 This = wxGridEvent()
118
119              Returns  true  if  the user is selecting grid cells, or false if
120              deselecting.
121
122       shiftDown(This) -> boolean()
123
124              Types:
125
126                 This = wxGridEvent()
127
128              Returns true if the Shift key was down at the time of the event.
129
130
131
132wxWidgets team.                     wx 2.1                      wxGridEvent(3)