wxMouseEvent - Functions for wxMouseEvent class
Please see following description for synopsis
wxMouseEvent(3) Erlang Module Definition wxMouseEvent(3)
NAME
wxMouseEvent - Functions for wxMouseEvent class
DESCRIPTION
This event class contains information about the events generated by the
mouse: they include mouse buttons press and release events and mouse
move events.
All mouse events involving the buttons use wxMOUSE_BTN_LEFT for the
left mouse button, wxMOUSE_BTN_MIDDLE for the middle one and
wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
buttons, the wxMOUSE_BTN_AUX1 and wxMOUSE_BTN_AUX2 events can also be
generated. Note that not all mice have even a middle button so a porta-
ble application should avoid relying on the events from it (but the
right button click can be emulated using the left mouse button with the
control key under Mac platforms with a single button mouse).
For the wxEVT_ENTER_WINDOW and wxEVT_LEAVE_WINDOW events purposes, the
mouse is considered to be inside the window if it is in the window
client area and not inside one of its children. In other words, the
parent window receives wxEVT_LEAVE_WINDOW event not only when the mouse
leaves the window entirely but also when it enters one of its children.
The position associated with a mouse event is expressed in the window
coordinates of the window which generated the event, you can use wxWin-
dow:clientToScreen/3 to convert it to screen coordinates and possibly
call wxWindow:screenToClient/2 next to convert it to window coordinates
of another window.
Note: Note the difference between methods like leftDown/1 and the
inherited leftIsDown/1: the former returns true when the event corre-
sponds to the left mouse button click while the latter returns true if
the left mouse button is currently being pressed. For example, when the
user is dragging the mouse you can use leftIsDown/1 to test whether the
left mouse button is (still) depressed. Also, by convention, if left-
Down/1 returns true, leftIsDown/1 will also return true in wxWidgets
whatever the underlying GUI behaviour is (which is platform-dependent).
The same applies, of course, to other mouse buttons as well.
See: wxKeyEvent
This class is derived (and can use functions) from: wxEvent
wxWidgets docs: wxMouseEvent
EVENTS
Use wxEvtHandler:connect/3 with wxMouseEventType to subscribe to events
of this type.
DATA TYPES
wxMouseEvent() = wx:wx_object()
wxMouse() =
#wxMouse{type = wxMouseEvent:wxMouseEventType(),
x = integer(),
y = integer(),
leftDown = boolean(),
middleDown = boolean(),
rightDown = boolean(),
controlDown = boolean(),
shiftDown = boolean(),
altDown = boolean(),
metaDown = boolean(),
wheelRotation = integer(),
wheelDelta = integer(),
linesPerAction = integer()}
wxMouseEventType() =
left_down | left_up | middle_down | middle_up | right_down |
right_up | motion | enter_window | leave_window |
left_dclick | middle_dclick | right_dclick | mousewheel |
aux1_down | aux1_up | aux1_dclick | aux2_down | aux2_up |
aux2_dclick
EXPORTS
altDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the Alt key is pressed.
Notice that wxKeyEvent:getModifiers/1 should usually be used
instead of this one.
button(This, But) -> boolean()
Types:
This = wxMouseEvent()
But = wx:wx_enum()
Returns true if the event was generated by the specified button.
See: wxMouseState::ButtoinIsDown()
buttonDClick(This) -> boolean()
Types:
This = wxMouseEvent()
buttonDClick(This, Options :: [Option]) -> boolean()
Types:
This = wxMouseEvent()
Option = {but, wx:wx_enum()}
If the argument is omitted, this returns true if the event was a
mouse double click event.
Otherwise the argument specifies which double click event was
generated (see button/2 for the possible values).
buttonDown(This) -> boolean()
Types:
This = wxMouseEvent()
buttonDown(This, Options :: [Option]) -> boolean()
Types:
This = wxMouseEvent()
Option = {but, wx:wx_enum()}
If the argument is omitted, this returns true if the event was a
mouse button down event.
Otherwise the argument specifies which button-down event was
generated (see button/2 for the possible values).
buttonUp(This) -> boolean()
Types:
This = wxMouseEvent()
buttonUp(This, Options :: [Option]) -> boolean()
Types:
This = wxMouseEvent()
Option = {but, wx:wx_enum()}
If the argument is omitted, this returns true if the event was a
mouse button up event.
Otherwise the argument specifies which button-up event was gen-
erated (see button/2 for the possible values).
cmdDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the key used for command accelerators is
pressed.
Same as controlDown/1. Deprecated.
Notice that wxKeyEvent:getModifiers/1 should usually be used
instead of this one.
controlDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the Control key or Apple/Command key under macOS
is pressed.
This function doesn't distinguish between right and left control
keys.
Notice that wxKeyEvent:getModifiers/1 should usually be used
instead of this one.
dragging(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if this was a dragging event (motion while a button
is depressed).
See: moving/1
entering(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the mouse was entering the window.
See: leaving/1
getButton(This) -> integer()
Types:
This = wxMouseEvent()
Returns the mouse button which generated this event or
wxMOUSE_BTN_NONE if no button is involved (for mouse move, enter
or leave event, for example).
Otherwise wxMOUSE_BTN_LEFT is returned for the left button down,
up and double click events, wxMOUSE_BTN_MIDDLE and
wxMOUSE_BTN_RIGHT for the same events for the middle and the
right buttons respectively.
getPosition(This) -> {X :: integer(), Y :: integer()}
Types:
This = wxMouseEvent()
Returns the physical mouse position.
getLogicalPosition(This, Dc) -> {X :: integer(), Y :: integer()}
Types:
This = wxMouseEvent()
Dc = wxDC:wxDC()
Returns the logical mouse position in pixels (i.e. translated
according to the translation set for the DC, which usually indi-
cates that the window has been scrolled).
getLinesPerAction(This) -> integer()
Types:
This = wxMouseEvent()
Returns the configured number of lines (or whatever) to be
scrolled per wheel action.
Default value under most platforms is three.
See: GetColumnsPerAction() (not implemented in wx)
getWheelRotation(This) -> integer()
Types:
This = wxMouseEvent()
Get wheel rotation, positive or negative indicates direction of
rotation.
Current devices all send an event when rotation is at least
+/-WheelDelta, but finer resolution devices can be created in
the future.
Because of this you shouldn't assume that one event is equal to
1 line, but you should be able to either do partial line
scrolling or wait until several events accumulate before
scrolling.
getWheelDelta(This) -> integer()
Types:
This = wxMouseEvent()
Get wheel delta, normally 120.
This is the threshold for action to be taken, and one such
action (for example, scrolling one increment) should occur for
each delta.
getX(This) -> integer()
Types:
This = wxMouseEvent()
Returns X coordinate of the physical mouse event position.
getY(This) -> integer()
Types:
This = wxMouseEvent()
Returns Y coordinate of the physical mouse event position.
isButton(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the event was a mouse button event (not neces-
sarily a button down event - that may be tested using button-
Down/2).
isPageScroll(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the system has been setup to do page scrolling
with the mouse wheel instead of line scrolling.
leaving(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the mouse was leaving the window.
See: entering/1
leftDClick(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the event was a left double click.
leftDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the left mouse button changed to down.
leftIsDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the left mouse button is currently down.
leftUp(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the left mouse button changed to up.
metaDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the Meta key was down at the time of the event.
middleDClick(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the event was a middle double click.
middleDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the middle mouse button changed to down.
middleIsDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the middle mouse button is currently down.
middleUp(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the middle mouse button changed to up.
moving(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if this was a motion event and no mouse buttons
were pressed.
If any mouse button is held pressed, then this method returns
false and dragging/1 returns true.
rightDClick(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the event was a right double click.
rightDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the right mouse button changed to down.
rightIsDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the right mouse button is currently down.
rightUp(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the right mouse button changed to up.
shiftDown(This) -> boolean()
Types:
This = wxMouseEvent()
Returns true if the Shift key is pressed.
This function doesn't distinguish between right and left shift
keys.
Notice that wxKeyEvent:getModifiers/1 should usually be used
instead of this one.
getWheelAxis(This) -> wx:wx_enum()
Types:
This = wxMouseEvent()
Gets the axis the wheel operation concerns.
Usually the mouse wheel is used to scroll vertically so
wxMOUSE_WHEEL_VERTICAL is returned but some mice (and most
trackpads) also allow to use the wheel to scroll horizontally in
which case wxMOUSE_WHEEL_HORIZONTAL is returned.
Notice that before wxWidgets 2.9.4 this method returned int.
wxWidgets team. wx 2.1.1 wxMouseEvent(3)