Add MouseButton::{Back, Forward} to mouse input events on Wayland, X11, Windows, macOS and Web #2770

bbb651 · 2023-04-14T20:59:46Z

Fixes #1785. This is a breaking change because MouseButton isn't #[non_exhaustive],
it's supported on wayland, x11, windows, macos and web, all other platforms (orbital doesn't support these buttons at all, android and ios don't have mouse support in winit).

Tested on all platforms changed (currently tested on x11 (xwayland), needs testing on other platforms)
Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
Created or updated an example program if it would help users understand this functionality (I don't think it's necessary for this kind of change, it's fairly self explanatory)
Updated feature matrix, if new features were added or implemented

i509VCB

Tested with xev and the values for X11 appear to be correct.

src/platform_impl/linux/wayland/seat/pointer/handlers.rs

madsmtm

macOS impl looks simple enough, though I can't test it since I don't have a mouse with those buttons.

Maybe you could document the variants a bit more to describe what "forward" and "backward" mouse buttons actually mean (or link to a Wikipedia article or something), I suspect I'm not the only one that don't know how those actually look

CHANGELOG.md

bbb651 · 2023-04-16T22:09:55Z

macOS impl looks simple enough, though I can't test it since I don't have a mouse with those buttons.

Maybe you could document the variants a bit more to describe what "forward" and "backward" mouse buttons actually mean (or link to a Wikipedia article or something), I suspect I'm not the only one that don't know how those actually look

Looking more into it I think macOS doesn't officially support these buttons, I got them from this project which looking at it now it's a hack specifically to address this shortcoming.

I found this documentation page about possible mouse buttons:

Quartz supports up to 32 mouse buttons. The first three buttons are specified using these three constants. Additional buttons are specified in USB order using the integers 3 to 31.

The question now is if treating 3 and 4 as back and forward is a common enough convention that we should adopt it. After searching for way too long I found that at least chromium does it so it seems pretty sensible to support it. But yeah it definitely needs a comment explaining this and documentation for users that it's not guaranteed to work across all configurations. I will fix this and the changelog tomorrow.

kchibisov

let me know if you still want to work on that, otherwise I'll push it myself.

examples/mouse_buttons.rs

CHANGELOG.md

src/event.rs

daxpedda

LGTM except the nits.

src/platform_impl/web/web_sys/event.rs

daxpedda · 2023-06-02T18:55:11Z

@bbb651 ping me if you want me to take care of the web backend.

bbb651 · 2023-06-02T21:30:51Z

@daxpedda I'd appreciate it

kchibisov

Seems like your rebase went wrong.

CHANGELOG.md

examples/mouse_buttons.rs

src/platform_impl/linux/wayland/seat/pointer/handlers.rs

src/platform_impl/web/web_sys/event.rs

daxpedda

@bbb651 Web backend is done.
(only approving the Web backend here)

madsmtm

MacOS looks good now

msiglreith

Windows changes also fine

This is a breaking change because MouseButton isn't #[non_exhaustive], it's supported on wayland, x11, windows, macos and web, all other platforms (orbital doesn't support these buttons at all, android and ios don't have mouse support in winit).

…:{Back, Forward} This seems to be what [chromium does](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/ui/ozone/platform/wayland/host/wayland_pointer.cc).

Co-authored-by: daxpedda <daxpedda@gmail.com>

kchibisov · 2023-06-16T08:51:15Z

Thanks!

bbb651 requested review from msiglreith, madsmtm and kchibisov as code owners April 14, 2023 20:59

bbb651 mentioned this pull request Apr 14, 2023

Make mouse::Button::Other take u16 instead of u8 iced-rs/iced#1797

Merged

i509VCB reviewed Apr 15, 2023

View reviewed changes

src/platform_impl/linux/wayland/seat/pointer/handlers.rs Outdated Show resolved Hide resolved

madsmtm requested changes Apr 16, 2023

View reviewed changes

madsmtm reviewed Apr 16, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

bbb651 requested a review from madsmtm April 18, 2023 15:19

kchibisov added the C - waiting on maintainer A maintainer must review this code label May 20, 2023

kchibisov mentioned this pull request May 28, 2023

Fix Report other mouse buttons #4754 alacritty/alacritty#6957

Closed

kchibisov requested changes May 29, 2023

View reviewed changes

examples/mouse_buttons.rs Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

src/event.rs Outdated Show resolved Hide resolved

src/event.rs Outdated Show resolved Hide resolved

daxpedda requested changes May 30, 2023

View reviewed changes

src/platform_impl/web/web_sys/event.rs Outdated Show resolved Hide resolved

src/platform_impl/web/web_sys/event.rs Outdated Show resolved Hide resolved

daxpedda added DS - macos DS - windows DS - x11 DS - wayland DS - web labels May 30, 2023

bbb651 force-pushed the master branch from 39625b7 to 4fd99d6 Compare June 2, 2023 18:50

kchibisov requested changes Jun 3, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

examples/mouse_buttons.rs Outdated Show resolved Hide resolved

src/platform_impl/linux/wayland/seat/pointer/handlers.rs Outdated Show resolved Hide resolved

src/platform_impl/web/web_sys/event.rs Show resolved Hide resolved

daxpedda force-pushed the master branch from 81b103c to de0b8a6 Compare June 3, 2023 10:47

daxpedda approved these changes Jun 3, 2023

View reviewed changes

madsmtm approved these changes Jun 3, 2023

View reviewed changes

msiglreith approved these changes Jun 3, 2023

View reviewed changes

bbb651 added 4 commits June 15, 2023 21:05

Updated changelog for MouseButton::{Back, Forward}

786aaa1

Added mouse buttons example

8bdeb56

Wayland: Add BTN_SIDE and BTN_EXTRA to implementation of MouseButton:…

b789e99

…:{Back, Forward} This seems to be what [chromium does](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/ui/ozone/platform/wayland/host/wayland_pointer.cc).

bbb651 and others added 3 commits June 15, 2023 21:06

Improve documentation and changelog for MouseButton::{Forward, Back}

c4fc998

Link to W3C instead of editors draft in web mouse button handling

595e1e5

Co-authored-by: daxpedda <daxpedda@gmail.com>

Improve Back and Forward mouse button docs and comments

c8a0c3e

daxpedda force-pushed the master branch from de0b8a6 to adfe8f9 Compare June 15, 2023 19:15

daxpedda added 2 commits June 15, 2023 21:19

Implement Web backend

61f6cea

Address review

0cf60e1

daxpedda force-pushed the master branch from f52dff4 to 0cf60e1 Compare June 15, 2023 19:19

daxpedda requested a review from kchibisov June 15, 2023 19:30

kchibisov approved these changes Jun 16, 2023

View reviewed changes

kchibisov merged commit 4748890 into rust-windowing:master Jun 16, 2023
55 checks passed

VishnuSanal mentioned this pull request Mar 8, 2024

Fixes #4754: report other mouse buttons alacritty/alacritty#7773

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MouseButton::{Back, Forward} to mouse input events on Wayland, X11, Windows, macOS and Web #2770

Add MouseButton::{Back, Forward} to mouse input events on Wayland, X11, Windows, macOS and Web #2770

bbb651 commented Apr 14, 2023

i509VCB left a comment

madsmtm left a comment

bbb651 commented Apr 16, 2023

kchibisov left a comment

daxpedda left a comment

daxpedda commented Jun 2, 2023

bbb651 commented Jun 2, 2023 •

edited

kchibisov left a comment

daxpedda left a comment

madsmtm left a comment

msiglreith left a comment

kchibisov commented Jun 16, 2023

Add MouseButton::{Back, Forward} to mouse input events on Wayland, X11, Windows, macOS and Web #2770

Add MouseButton::{Back, Forward} to mouse input events on Wayland, X11, Windows, macOS and Web #2770

Conversation

bbb651 commented Apr 14, 2023

i509VCB left a comment

Choose a reason for hiding this comment

madsmtm left a comment

Choose a reason for hiding this comment

bbb651 commented Apr 16, 2023

kchibisov left a comment

Choose a reason for hiding this comment

daxpedda left a comment

Choose a reason for hiding this comment

daxpedda commented Jun 2, 2023

bbb651 commented Jun 2, 2023 • edited

kchibisov left a comment

Choose a reason for hiding this comment

daxpedda left a comment

Choose a reason for hiding this comment

madsmtm left a comment

Choose a reason for hiding this comment

msiglreith left a comment

Choose a reason for hiding this comment

kchibisov commented Jun 16, 2023

bbb651 commented Jun 2, 2023 •

edited