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

NAME

6       wxMouseEvent - See external documentation: wxMouseEvent.
7

DESCRIPTION

9       See external documentation: wxMouseEvent.
10
11         Use wxEvtHandler:connect/3 with EventType::
12           left_down,  left_up,  middle_down, middle_up, right_down, right_up,
13           motion,  enter_window,  leave_window,  left_dclick,  middle_dclick,
14           right_dclick, mousewheel
15
16       See also the message variant #wxMouse{} event record type.
17
18       This class is derived (and can use functions) from:
19       wxEvent
20

DATA TYPES

22         wxMouseEvent():
23
24
25           An  object  reference,  The  representation  is internal and can be
26           changed without notice. It can't be used for comparsion  stored  on
27           disc or distributed for use on other nodes.
28

EXPORTS

30       altDown(This) -> boolean()
31
32              Types:
33
34                 This = wxMouseEvent()
35
36              See external documentation.
37
38       button(This, But) -> boolean()
39
40              Types:
41
42                 This = wxMouseEvent()
43                 But = integer()
44
45              See external documentation.
46
47       buttonDClick(This) -> boolean()
48
49              Types:
50
51                 This = wxMouseEvent()
52
53              Equivalent to buttonDClick(This, []).
54
55       buttonDClick(This, Options::[Option]) -> boolean()
56
57              Types:
58
59                 This = wxMouseEvent()
60                 Option = {but, integer()}
61
62              See external documentation.
63
64       buttonDown(This) -> boolean()
65
66              Types:
67
68                 This = wxMouseEvent()
69
70              Equivalent to buttonDown(This, []).
71
72       buttonDown(This, Options::[Option]) -> boolean()
73
74              Types:
75
76                 This = wxMouseEvent()
77                 Option = {but, integer()}
78
79              See external documentation.
80
81       buttonUp(This) -> boolean()
82
83              Types:
84
85                 This = wxMouseEvent()
86
87              Equivalent to buttonUp(This, []).
88
89       buttonUp(This, Options::[Option]) -> boolean()
90
91              Types:
92
93                 This = wxMouseEvent()
94                 Option = {but, integer()}
95
96              See external documentation.
97
98       cmdDown(This) -> boolean()
99
100              Types:
101
102                 This = wxMouseEvent()
103
104              See external documentation.
105
106       controlDown(This) -> boolean()
107
108              Types:
109
110                 This = wxMouseEvent()
111
112              See external documentation.
113
114       dragging(This) -> boolean()
115
116              Types:
117
118                 This = wxMouseEvent()
119
120              See external documentation.
121
122       entering(This) -> boolean()
123
124              Types:
125
126                 This = wxMouseEvent()
127
128              See external documentation.
129
130       getButton(This) -> integer()
131
132              Types:
133
134                 This = wxMouseEvent()
135
136              See external documentation.
137
138       getPosition(This) -> {X::integer(), Y::integer()}
139
140              Types:
141
142                 This = wxMouseEvent()
143
144              See external documentation.
145
146       getLogicalPosition(This, Dc) -> {X::integer(), Y::integer()}
147
148              Types:
149
150                 This = wxMouseEvent()
151                 Dc = wxDC:wxDC()
152
153              See external documentation.
154
155       getLinesPerAction(This) -> integer()
156
157              Types:
158
159                 This = wxMouseEvent()
160
161              See external documentation.
162
163       getWheelRotation(This) -> integer()
164
165              Types:
166
167                 This = wxMouseEvent()
168
169              See external documentation.
170
171       getWheelDelta(This) -> integer()
172
173              Types:
174
175                 This = wxMouseEvent()
176
177              See external documentation.
178
179       getX(This) -> integer()
180
181              Types:
182
183                 This = wxMouseEvent()
184
185              See external documentation.
186
187       getY(This) -> integer()
188
189              Types:
190
191                 This = wxMouseEvent()
192
193              See external documentation.
194
195       isButton(This) -> boolean()
196
197              Types:
198
199                 This = wxMouseEvent()
200
201              See external documentation.
202
203       isPageScroll(This) -> boolean()
204
205              Types:
206
207                 This = wxMouseEvent()
208
209              See external documentation.
210
211       leaving(This) -> boolean()
212
213              Types:
214
215                 This = wxMouseEvent()
216
217              See external documentation.
218
219       leftDClick(This) -> boolean()
220
221              Types:
222
223                 This = wxMouseEvent()
224
225              See external documentation.
226
227       leftDown(This) -> boolean()
228
229              Types:
230
231                 This = wxMouseEvent()
232
233              See external documentation.
234
235       leftIsDown(This) -> boolean()
236
237              Types:
238
239                 This = wxMouseEvent()
240
241              See external documentation.
242
243       leftUp(This) -> boolean()
244
245              Types:
246
247                 This = wxMouseEvent()
248
249              See external documentation.
250
251       metaDown(This) -> boolean()
252
253              Types:
254
255                 This = wxMouseEvent()
256
257              See external documentation.
258
259       middleDClick(This) -> boolean()
260
261              Types:
262
263                 This = wxMouseEvent()
264
265              See external documentation.
266
267       middleDown(This) -> boolean()
268
269              Types:
270
271                 This = wxMouseEvent()
272
273              See external documentation.
274
275       middleIsDown(This) -> boolean()
276
277              Types:
278
279                 This = wxMouseEvent()
280
281              See external documentation.
282
283       middleUp(This) -> boolean()
284
285              Types:
286
287                 This = wxMouseEvent()
288
289              See external documentation.
290
291       moving(This) -> boolean()
292
293              Types:
294
295                 This = wxMouseEvent()
296
297              See external documentation.
298
299       rightDClick(This) -> boolean()
300
301              Types:
302
303                 This = wxMouseEvent()
304
305              See external documentation.
306
307       rightDown(This) -> boolean()
308
309              Types:
310
311                 This = wxMouseEvent()
312
313              See external documentation.
314
315       rightIsDown(This) -> boolean()
316
317              Types:
318
319                 This = wxMouseEvent()
320
321              See external documentation.
322
323       rightUp(This) -> boolean()
324
325              Types:
326
327                 This = wxMouseEvent()
328
329              See external documentation.
330
331       shiftDown(This) -> boolean()
332
333              Types:
334
335                 This = wxMouseEvent()
336
337              See external documentation.
338
339       getWheelAxis(This) -> wx:wx_enum()
340
341              Types:
342
343                 This = wxMouseEvent()
344
345              See external documentation.
346              Res = ?wxMOUSE_WHEEL_VERTICAL | ?wxMOUSE_WHEEL_HORIZONTAL
347

AUTHORS

349       <>
350
351
352
353                                   wx 1.9.3                    wxMouseEvent(3)