wxMouseEvent(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

🎀 NAME 🎀

wxMouseEvent(3) — Erlang Module Definition, and it's giving mouse lore 💖

wxMouseEvent is the event class that contains all the info about the events generated by the mouse: it holds the mouse buttons press and release events, and also the mouse move events. That's the whole assignment, bestie, and it ate. ✨

🦋 DESCRIPTION 🦋

Okay so first thing, the button names, because you need these memorized:

Every single mouse event that involves buttons uses wxMOUSE_BTN_LEFT for the left mouse button, wxMOUSE_BTN_MIDDLE for the middle one, and wxMOUSE_BTN_RIGHT for the right one. Periodt. 💅

And if your system supports more buttons, then the wxMOUSE_BTN_AUX1 and wxMOUSE_BTN_AUX2 events can also be generated. 🌈

⚠️ But listen — not all mice even have a middle button, so if you want your app to be portable, please don't go relying on the events from it. Lowkey setting yourself up. The one exception vibes: the right button click can be emulated using the left mouse button with the control key, under Mac platforms that have a single button mouse. Iykyk. 🍓

Now, for the wxEVT_ENTER_WINDOW and wxEVT_LEAVE_WINDOW events — the way this works is: the mouse counts as being inside the window if it's in the window client area and not inside one of its children. In other words, the parent window receives a wxEVT_LEAVE_WINDOW event not only when the mouse leaves the window entirely, but also when it enters one of its children. Not me getting emotionally attached to the parent window's abandonment issues 😭

The position that comes with a mouse event is expressed in the window coordinates of the window which generated the event. If you want it as screen coordinates, you can use wxWindow:clientToScreen/3 to convert it — and then possibly call wxWindow:screenToClient/2 next to convert it to the window coordinates of another window. ✨ Cute little round trip, honestly.

🌟 Note: observe the difference between methods like leftDown/1 and the inherited leftIsDown/1. Here's the tea: - leftDown/1 returns true when the event corresponds to the left mouse button click - leftIsDown/1 returns true if the left mouse button is currently being pressed So 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 leftDown/1 returns true, then leftIsDown/1 will also return true in wxWidgets, whatever the underlying GUI behaviour is (which is platform-dependent, obviously). And the same applies, of course, to the other mouse buttons as well. No crumbs left. 👑

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. Go off. 🔥

🌸 DATA TYPES 🌸

wxMouse() :: #wxMouse{}.

wxMouseEvent() :: wx:wx_object().

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.

Look at that whole lineup, iconic. 🌟

...and there's more, bestie, hold on — part 2 is coming 💜

💖 FUNCTIONS 💖

okay bestie, this is the main character section 🎀 every single one of these takes This (aka your wxMouseEvent()) and spills a lil truth about what the mouse just did. no skips, no gatekeeping, we're covering all of them. periodt. 💅

✨ altDown ✨

       altDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the Alt key is pressed. 🦋

Bestie, real talk: wxKeyEvent:getModifiers/1 should usually be used instead of this one. 👑

✨ aux1DClick ✨

       aux1DClick(This) -> boolean() when This :: wxMouseEvent().

Returns true if the event was a first extra button double click. 🖱️💖

✨ aux1Down ✨

       aux1Down(This) -> boolean() when This :: wxMouseEvent().

Returns true if the first extra button mouse button changed to down. 👇✨

✨ aux1Up ✨

       aux1Up(This) -> boolean() when This :: wxMouseEvent().

Returns true if the first extra button mouse button changed to up. 👆💫

✨ aux2DClick ✨

       aux2DClick(This) -> boolean() when This :: wxMouseEvent().

Returns true if the event was a second extra button double click. 🖱️🖱️🌸

✨ aux2Down ✨

       aux2Down(This) -> boolean() when This :: wxMouseEvent().

Returns true if the second extra button mouse button changed to down. 👇🎀

✨ aux2Up ✨

       aux2Up(This) -> boolean() when This :: wxMouseEvent().

Returns true if the second extra button mouse button changed to up. 👆🦋

✨ button ✨

       button(This, But) -> boolean()
                       when This :: wxMouseEvent(), But :: wx:wx_enum().

Returns true if the event was generated by the specified button. no cap, it's checking exactly which button you mean. 🎯

✨ buttonDClick ✨

       buttonDClick(This, [Option]) -> boolean()
                             when
                                 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 ✨

       buttonDown(This, [Option]) -> boolean()
                           when
                               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 ✨

       buttonUp(This, [Option]) -> boolean()
                         when
                             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 generated (see button/2 for the possible values). ✨

✨ cmdDown ✨

       cmdDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the key used for command accelerators is pressed. ⌘

Same as controlDown/1. Deprecated. 💀 (she's retired bestie, do not build your whole personality on her)

Notice that wxKeyEvent:getModifiers/1 should usually be used instead of this one. 👑

✨ controlDown ✨

       controlDown(This) -> boolean() when 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 ✨

       dragging(This) -> boolean() when This :: wxMouseEvent().

Returns true if this was a dragging event (motion while a button is depressed). 🖐️💫

See: moving/1

✨ entering ✨

       entering(This) -> boolean() when This :: wxMouseEvent().

Returns true if the mouse was entering the window. 🚪✨

See: leaving/1

✨ getButton ✨

       getButton(This) -> integer() when 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. 👑💅

✨ getLinesPerAction ✨

       getLinesPerAction(This) -> integer() when This :: wxMouseEvent().

Returns the configured number of lines (or whatever) to be scrolled per wheel action. 🎡

Default value under most platforms is three. 3️⃣

✨ getLogicalPosition ✨

       getLogicalPosition(This, Dc) -> {X :: integer(), Y :: integer()}
                                   when
                                       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 indicates that the window has been scrolled). 🗺️✨

✨ getPosition ✨

       getPosition(This) -> {X :: integer(), Y :: integer()}
                            when This :: wxMouseEvent().

Returns the physical mouse position. 📍

✨ getWheelAxis ✨

       getWheelAxis(This) -> wx:wx_enum() when 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. 💀

✨ getWheelDelta ✨

       getWheelDelta(This) -> integer() when 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. 1️⃣2️⃣0️⃣

✨ getWheelRotation ✨

       getWheelRotation(This) -> integer() when 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. 🧠✨

✨ getX ✨

       getX(This) -> integer() when This :: wxMouseEvent().

Returns X coordinate of the physical mouse event position. ➡️

✨ getY ✨

       getY(This) -> integer() when This :: wxMouseEvent().

Returns Y coordinate of the physical mouse event position. ⬇️

✨ isButton ✨

       isButton(This) -> boolean() when This :: wxMouseEvent().

Returns true if the event was a mouse button event (not necessarily a button down event - that may be tested using buttonDown/2). 🖱️

✨ isPageScroll ✨

       isPageScroll(This) -> boolean() when This :: wxMouseEvent().

Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling. 📜✨

✨ leaving ✨

       leaving(This) -> boolean() when This :: wxMouseEvent().

Returns true if the mouse was leaving the window. 🚪👋

See: entering/1

✨ leftDClick ✨

       leftDClick(This) -> boolean() when This :: wxMouseEvent().

Returns true if the event was a left double click. 🖱️💥

✨ leftDown ✨

       leftDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the left mouse button changed to down. 👇

✨ leftIsDown ✨

       leftIsDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the left mouse button is currently down. 🫳

✨ leftUp ✨

       leftUp(This) -> boolean() when This :: wxMouseEvent().

Returns true if the left mouse button changed to up. 👆

✨ metaDown ✨

       metaDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the Meta key was down at the time of the event. 🪄

✨ middleDClick ✨

       middleDClick(This) -> boolean() when This :: wxMouseEvent().

Returns true if the event was a middle double click. 🖱️💥

✨ middleDown ✨

       middleDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the middle mouse button changed to down. 👇

✨ middleIsDown ✨

       middleIsDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the middle mouse button is currently down. 🫳

✨ middleUp ✨

       middleUp(This) -> boolean() when This :: wxMouseEvent().

Returns true if the middle mouse button changed to up. 👆

✨ moving ✨

       moving(This) -> boolean() when 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 ✨

       rightDClick(This) -> boolean() when This :: wxMouseEvent().

Returns true if the event was a right double click. 🖱️💥

✨ rightDown ✨

       rightDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the right mouse button changed to down. 👇

✨ rightIsDown ✨

       rightIsDown(This) -> boolean() when This :: wxMouseEvent().

Returns true if the right mouse button is currently down. 🫳

✨ rightUp ✨

       rightUp(This) -> boolean() when This :: wxMouseEvent().

Returns true if the right mouse button changed to up. 👆

✨ shiftDown ✨

       shiftDown(This) -> boolean() when 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. 💜

and that's the whole function roster, bestie — every single one accounted for, nothing ghosted, no cap. 🫶

this iconic little page was served up by Ericsson AB, rocking version wx 2.6, and it's literally called wxMouseEvent(3) — mwah 💋✨

📦 where this page comes from