Skip to content

Warn in the docs that MouseEvent.key can be wrong. #16892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Mar 23, 2020

PR Summary

MouseEvent.key is just derived from the last key_press_event/key_release_event, so will be wrong e.g. if one presses a key while the canvas does not have focus, then move the mouse to the canvas and clicks.

In general I think it isn't possible to know what keys are pressed while a mouse even occurs; one can only have a list of modifiers (ctrl/alt/shift). There's a PR adding that at #6159 but it needs a bit of work, so let's document the limitation for now.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer anntzer added this to the v3.3.0 milestone Mar 23, 2020
@QuLogic QuLogic merged commit 7c400e9 into matplotlib:master Mar 24, 2020
@anntzer anntzer deleted the mouseevent-key branch March 24, 2020 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants