Skip to content

Check pressed mouse buttons in pan/zoom drag handlers.#29066

Merged
QuLogic merged 1 commit intomatplotlib:mainfrom
anntzer:cbpz
Nov 15, 2024
Merged

Check pressed mouse buttons in pan/zoom drag handlers.#29066
QuLogic merged 1 commit intomatplotlib:mainfrom
anntzer:cbpz

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented Nov 4, 2024

Sometimes, the mouse_release_event ending a pan/zoom can be lost, if it occurs while the canvas does not have focus (a typical case is when a context menu is implemented on top of the canvas, see example below); this can result in rather confusing behavior as the pan/zoom continues which no mouse button is pressed. To fix this, always check that the correct button is still pressed in the motion_notify_event handlers.

To test, use e.g.

from matplotlib import pyplot as plt
from matplotlib.backends.qt_compat import QtWidgets

def on_button_press(event):
    if event.button != 3:  # Right-click.
        return
    menu = QtWidgets.QMenu()
    menu.addAction("Some menu action", lambda: None)
    menu.exec(event.guiEvent.globalPosition().toPoint())

fig = plt.figure()
fig.canvas.mpl_connect("button_press_event", on_button_press)
fig.add_subplot()
plt.show()

enter pan/zoom mode, right-click to open the context menu, exit the menu, and continue moving the mouse.

Followup to #28453 (and the original motivation for it).

PR summary

PR checklist

Comment thread lib/matplotlib/backend_bases.py Outdated

def drag_pan(self, event):
"""Callback for dragging in pan/zoom mode."""
if self._pan_info.button not in event.buttons:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be an exact match? I believe the action should terminate as soon as any button is pressed or released.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I don't really mind either way.

@anntzer anntzer changed the title Check pressed mouse buttons in pan/zoom drag haandlers. Check pressed mouse buttons in pan/zoom drag handlers. Nov 4, 2024
@timhoffm timhoffm added this to the v3.11.0 milestone Nov 4, 2024
@QuLogic QuLogic self-requested a review November 9, 2024 10:57
Copy link
Copy Markdown
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the test failures appear relevant.

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Nov 12, 2024

Indeed, should be fixed now (synthetic events in tests needed some adjustment).

Sometimes, the mouse_release_event ending a pan/zoom can be lost, if it
occurs while the canvas does not have focus (a typical case is when a
context menu is implemented on top of the canvas, see example below);
this can result in rather confusing behavior as the pan/zoom continues
which no mouse button is pressed.  To fix this, always check that the
correct button is still pressed in the motion_notify_event handlers.

To test, use e.g.
```
from matplotlib import pyplot as plt
from matplotlib.backends.qt_compat import QtWidgets

def on_button_press(event):
    if event.button != 3:  # Right-click.
        return
    menu = QtWidgets.QMenu()
    menu.addAction("Some menu action", lambda: None)
    menu.exec(event.guiEvent.globalPosition().toPoint())

fig = plt.figure()
fig.canvas.mpl_connect("button_press_event", on_button_press)
fig.add_subplot()
plt.show()
```
enter pan/zoom mode, right-click to open the context menu, exit the
menu, and continue moving the mouse.
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.

3 participants