Warn in the docs that MouseEvent.key can be wrong. #16892
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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