1wxMouseEvent(3) Erlang Module Definition wxMouseEvent(3)
2
6 wxMouseEvent - Functions for wxMouseEvent class
7
9 This event class contains information about the events generated by the
10 mouse: they include mouse buttons press and release events and mouse
11 move events.
12 All mouse events involving the buttons use wxMOUSE_BTN_LEFT for the
14 left mouse button, wxMOUSE_BTN_MIDDLE for the middle one and wx‐
15 MOUSE_BTN_RIGHT for the right one. And if the system supports more but‐
16 tons, the wxMOUSE_BTN_AUX1 and wxMOUSE_BTN_AUX2 events can also be gen‐
17 erated. Note that not all mice have even a middle button so a portable
18 application should avoid relying on the events from it (but the right
19 button click can be emulated using the left mouse button with the con‐
20 trol key under Mac platforms with a single button mouse).
21 For the wxEVT_ENTER_WINDOW and wxEVT_LEAVE_WINDOW events purposes, the
23 mouse is considered to be inside the window if it is in the window
24 client area and not inside one of its children. In other words, the
25 parent window receives wxEVT_LEAVE_WINDOW event not only when the mouse
26 leaves the window entirely but also when it enters one of its children.
27 The position associated with a mouse event is expressed in the window
29 coordinates of the window which generated the event, you can use wxWin‐
30 dow:clientToScreen/3 to convert it to screen coordinates and possibly
31 call wxWindow:screenToClient/2 next to convert it to window coordinates
32 of another window.
33 Note: Note the difference between methods like leftDown/1 and the in‐
35 herited leftIsDown/1: the former returns true when the event corre‐
36 sponds to the left mouse button click while the latter returns true if
37 the left mouse button is currently being pressed. For example, when the
38 user is dragging the mouse you can use leftIsDown/1 to test whether the
39 left mouse button is (still) depressed. Also, by convention, if left‐
40 Down/1 returns true, leftIsDown/1 will also return true in wxWidgets
41 whatever the underlying GUI behaviour is (which is platform-dependent).
42 The same applies, of course, to other mouse buttons as well.
43 See: wxKeyEvent
45 This class is derived (and can use functions) from: wxEvent
47 wxWidgets docs: wxMouseEvent
49
51 Use wxEvtHandler:connect/3 with wxMouseEventType to subscribe to events
52 of this type.
53
55 wxMouseEvent() = wx:wx_object()
56 wxMouse() =
58 #wxMouse{type = wxMouseEvent:wxMouseEventType(),
59 x = integer(),
60 y = integer(),
61 leftDown = boolean(),
62 middleDown = boolean(),
63 rightDown = boolean(),
64 controlDown = boolean(),
65 shiftDown = boolean(),
66 altDown = boolean(),
67 metaDown = boolean(),
68 wheelRotation = integer(),
69 wheelDelta = integer(),
70 linesPerAction = integer()}
71 wxMouseEventType() =
73 left_down | left_up | middle_down | middle_up | right_down |
74 right_up | motion | enter_window | leave_window |
75 left_dclick | middle_dclick | right_dclick | mousewheel |
76 aux1_down | aux1_up | aux1_dclick | aux2_down | aux2_up |
77 aux2_dclick
78
80 altDown(This) -> boolean()
81 Types:
83 This = wxMouseEvent()
85 Returns true if the Alt key is pressed.
87 Notice that wxKeyEvent:getModifiers/1 should usually be used in‐
89 stead of this one.
90 button(This, But) -> boolean()
92 Types:
94 This = wxMouseEvent()
96 But = wx:wx_enum()
97 Returns true if the event was generated by the specified button.
99 See: wxMouseState::ButtoinIsDown()
101 buttonDClick(This) -> boolean()
103 Types:
105 This = wxMouseEvent()
107 buttonDClick(This, Options :: [Option]) -> boolean()
109 Types:
111 This = wxMouseEvent()
113 Option = {but, wx:wx_enum()}
114 If the argument is omitted, this returns true if the event was a
116 mouse double click event.
117 Otherwise the argument specifies which double click event was
119 generated (see button/2 for the possible values).
120 buttonDown(This) -> boolean()
122 Types:
124 This = wxMouseEvent()
126 buttonDown(This, Options :: [Option]) -> boolean()
128 Types:
130 This = wxMouseEvent()
132 Option = {but, wx:wx_enum()}
133 If the argument is omitted, this returns true if the event was a
135 mouse button down event.
136 Otherwise the argument specifies which button-down event was
138 generated (see button/2 for the possible values).
139 buttonUp(This) -> boolean()
141 Types:
143 This = wxMouseEvent()
145 buttonUp(This, Options :: [Option]) -> boolean()
147 Types:
149 This = wxMouseEvent()
151 Option = {but, wx:wx_enum()}
152 If the argument is omitted, this returns true if the event was a
154 mouse button up event.
155 Otherwise the argument specifies which button-up event was gen‐
157 erated (see button/2 for the possible values).
158 cmdDown(This) -> boolean()
160 Types:
162 This = wxMouseEvent()
164 Returns true if the key used for command accelerators is
166 pressed.
167 Same as controlDown/1. Deprecated.
169 Notice that wxKeyEvent:getModifiers/1 should usually be used in‐
171 stead of this one.
172 controlDown(This) -> boolean()
174 Types:
176 This = wxMouseEvent()
178 Returns true if the Control key or Apple/Command key under macOS
180 is pressed.
181 This function doesn't distinguish between right and left control
183 keys.
184 Notice that wxKeyEvent:getModifiers/1 should usually be used in‐
186 stead of this one.
187 dragging(This) -> boolean()
189 Types:
191 This = wxMouseEvent()
193 Returns true if this was a dragging event (motion while a button
195 is depressed).
196 See: moving/1
198 entering(This) -> boolean()
200 Types:
202 This = wxMouseEvent()
204 Returns true if the mouse was entering the window.
206 See: leaving/1
208 getButton(This) -> integer()
210 Types:
212 This = wxMouseEvent()
214 Returns the mouse button which generated this event or wx‐
216 MOUSE_BTN_NONE if no button is involved (for mouse move, enter
217 or leave event, for example).
218 Otherwise wxMOUSE_BTN_LEFT is returned for the left button down,
220 up and double click events, wxMOUSE_BTN_MIDDLE and wx‐
221 MOUSE_BTN_RIGHT for the same events for the middle and the right
222 buttons respectively.
223 getPosition(This) -> {X :: integer(), Y :: integer()}
225 Types:
227 This = wxMouseEvent()
229 Returns the physical mouse position.
231 getLogicalPosition(This, Dc) -> {X :: integer(), Y :: integer()}
233 Types:
235 This = wxMouseEvent()
237 Dc = wxDC:wxDC()
238 Returns the logical mouse position in pixels (i.e. translated
240 according to the translation set for the DC, which usually indi‐
241 cates that the window has been scrolled).
242 getLinesPerAction(This) -> integer()
244 Types:
246 This = wxMouseEvent()
248 Returns the configured number of lines (or whatever) to be
250 scrolled per wheel action.
251 Default value under most platforms is three.
253 See: GetColumnsPerAction() (not implemented in wx)
255 getWheelRotation(This) -> integer()
257 Types:
259 This = wxMouseEvent()
261 Get wheel rotation, positive or negative indicates direction of
263 rotation.
264 Current devices all send an event when rotation is at least
266 +/-WheelDelta, but finer resolution devices can be created in
267 the future.
268 Because of this you shouldn't assume that one event is equal to
270 1 line, but you should be able to either do partial line
271 scrolling or wait until several events accumulate before
272 scrolling.
273 getWheelDelta(This) -> integer()
275 Types:
277 This = wxMouseEvent()
279 Get wheel delta, normally 120.
281 This is the threshold for action to be taken, and one such ac‐
283 tion (for example, scrolling one increment) should occur for
284 each delta.
285 getX(This) -> integer()
287 Types:
289 This = wxMouseEvent()
291 Returns X coordinate of the physical mouse event position.
293 getY(This) -> integer()
295 Types:
297 This = wxMouseEvent()
299 Returns Y coordinate of the physical mouse event position.
301 isButton(This) -> boolean()
303 Types:
305 This = wxMouseEvent()
307 Returns true if the event was a mouse button event (not neces‐
309 sarily a button down event - that may be tested using button‐
310 Down/2).
311 isPageScroll(This) -> boolean()
313 Types:
315 This = wxMouseEvent()
317 Returns true if the system has been setup to do page scrolling
319 with the mouse wheel instead of line scrolling.
320 leaving(This) -> boolean()
322 Types:
324 This = wxMouseEvent()
326 Returns true if the mouse was leaving the window.
328 See: entering/1
330 leftDClick(This) -> boolean()
332 Types:
334 This = wxMouseEvent()
336 Returns true if the event was a left double click.
338 leftDown(This) -> boolean()
340 Types:
342 This = wxMouseEvent()
344 Returns true if the left mouse button changed to down.
346 leftIsDown(This) -> boolean()
348 Types:
350 This = wxMouseEvent()
352 Returns true if the left mouse button is currently down.
354 leftUp(This) -> boolean()
356 Types:
358 This = wxMouseEvent()
360 Returns true if the left mouse button changed to up.
362 metaDown(This) -> boolean()
364 Types:
366 This = wxMouseEvent()
368 Returns true if the Meta key was down at the time of the event.
370 middleDClick(This) -> boolean()
372 Types:
374 This = wxMouseEvent()
376 Returns true if the event was a middle double click.
378 middleDown(This) -> boolean()
380 Types:
382 This = wxMouseEvent()
384 Returns true if the middle mouse button changed to down.
386 middleIsDown(This) -> boolean()
388 Types:
390 This = wxMouseEvent()
392 Returns true if the middle mouse button is currently down.
394 middleUp(This) -> boolean()
396 Types:
398 This = wxMouseEvent()
400 Returns true if the middle mouse button changed to up.
402 moving(This) -> boolean()
404 Types:
406 This = wxMouseEvent()
408 Returns true if this was a motion event and no mouse buttons
410 were pressed.
411 If any mouse button is held pressed, then this method returns
413 false and dragging/1 returns true.
414 rightDClick(This) -> boolean()
416 Types:
418 This = wxMouseEvent()
420 Returns true if the event was a right double click.
422 rightDown(This) -> boolean()
424 Types:
426 This = wxMouseEvent()
428 Returns true if the right mouse button changed to down.
430 rightIsDown(This) -> boolean()
432 Types:
434 This = wxMouseEvent()
436 Returns true if the right mouse button is currently down.
438 rightUp(This) -> boolean()
440 Types:
442 This = wxMouseEvent()
444 Returns true if the right mouse button changed to up.
446 shiftDown(This) -> boolean()
448 Types:
450 This = wxMouseEvent()
452 Returns true if the Shift key is pressed.
454 This function doesn't distinguish between right and left shift
456 keys.
457 Notice that wxKeyEvent:getModifiers/1 should usually be used in‐
459 stead of this one.
460 getWheelAxis(This) -> wx:wx_enum()
462 Types:
464 This = wxMouseEvent()
466 Gets the axis the wheel operation concerns.
468 Usually the mouse wheel is used to scroll vertically so wx‐
470 MOUSE_WHEEL_VERTICAL is returned but some mice (and most track‐
471 pads) also allow to use the wheel to scroll horizontally in
472 which case wxMOUSE_WHEEL_HORIZONTAL is returned.
473 Notice that before wxWidgets 2.9.4 this method returned int.
475 aux1DClick(This) -> boolean()
477 Types:
479 This = wxMouseEvent()
481 Returns true if the event was a first extra button double click.
483 aux1Down(This) -> boolean()
485 Types:
487 This = wxMouseEvent()
489 Returns true if the first extra button mouse button changed to
491 down.
492 aux1Up(This) -> boolean()
494 Types:
496 This = wxMouseEvent()
498 Returns true if the first extra button mouse button changed to
500 up.
501 aux2DClick(This) -> boolean()
503 Types:
505 This = wxMouseEvent()
507 Returns true if the event was a second extra button double
509 click.
510 aux2Down(This) -> boolean()
512 Types:
514 This = wxMouseEvent()
516 Returns true if the second extra button mouse button changed to
518 down.
519 aux2Up(This) -> boolean()
521 Types:
523 This = wxMouseEvent()
525 Returns true if the second extra button mouse button changed to
527 up.
528wxWidgets team. wx 2.2.1 wxMouseEvent(3)