8000 Support forward/backward mouse buttons by timhoffm · Pull Request #12904 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Support forward/backward mouse buttons #12904

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.

Sign up for GitHub

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
Feb 22, 2019
Merged

Support forward/backward mouse buttons #12904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/users/next_whats_new/2019-02-17-TH.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Support for forward/backward mouse buttons
``````````````````````````````````````````

Figure managers now support a ``button_press`` event for mouse buttons, similar
to the ``key_press`` events. This allows binding actions to mouse buttons (see
`.MouseButton`).

The first application of this mechanism is support of forward/backward mouse
buttons in figures created with the Qt5 backend.
37 changes: 35 additions & 2 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1367,6 +1367,8 @@ class MouseButton(IntEnum):
LEFT = 1
MIDDLE = 2
RIGHT = 3
BACK = 8
FORWARD = 9


class MouseEvent(LocationEvent):
Expand Down Expand Up @@ -2386,6 +2388,18 @@ def _get_uniform_gridstate(ticks):
a.set_navigate(i == n)


def button_press_handler(event, canvas, toolbar=None):
Copy link
Member

Choose a reason for hiding this comment

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

mouse_event_handler?

Uh oh!

There was an error while loading. Please reload this page.
"""
The default Matplotlib button actions for extra mouse buttons.
"""
if toolbar is not None:
button_name = str(MouseButton(event.button))
if button_name in rcParams['keymap.back']:
toolbar.back()
elif button_name in rcParams['keymap.forward']:
toolbar.forward()


class NonGuiException(Exception):
pass

Expand All @@ -2403,22 +2417,34 @@ class FigureManagerBase(object):
The figure number

key_press_handler_id : int
The default key handler cid, when using the toolmanager. Can be used
to disable default key press handling ::
The default key handler cid, when using the toolmanager.
To disable the default key press handling use::

figure.canvas.mpl_disconnect(
figure.canvas.manager.key_press_handler_id)

button_press_handler_id : int
The default mouse button handler cid, when using the toolmanager.
To disable the default button press handling use::

figure.canvas.mpl_disconnect(
figure.canvas.manager.button_press_handler_id)

"""
def __init__(self, canvas, num):
self.canvas = canvas
canvas.manager = self # store a pointer to parent
self.num = num

self.key_press_handler_id = None
self.button_press_handler_id = None
if rcParams['toolbar'] != 'toolmanager':
self.key_press_handler_id = self.canvas.mpl_connect(
'key_press_event',
self.key_press)
self.button_press_handler_id = self.canvas.mpl_connect(
'button_press_event',
self.button_press)

self.toolmanager = None
self.toolbar = None
Expand Down Expand Up @@ -2455,6 +2481,13 @@ def key_press(self, event):
if rcParams['toolbar'] != 'toolmanager':
key_press_handler(event, self.canvas, self.canvas.toolbar)

def button_press(self, event):
"""
The default Matplotlib button actions for extra mouse buttons.
"""
if rcParams['toolbar'] != 'toolmanager':
button_press_handler(event, self.canvas, self.canvas.toolbar)

def get_window_title(self):
"""Get the title text of the window containing the figure.

Expand Down
12 changes: 6 additions & 6 deletions lib/matplotlib/backends/backend_qt5.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from matplotlib._pylab_helpers import Gcf
from matplotlib.backend_bases import (
_Backend, FigureCanvasBase, FigureManagerBase, NavigationToolbar2,
TimerBase, cursors, ToolContainerBase, StatusbarBase)
TimerBase, cursors, ToolContainerBase, StatusbarBase, MouseButton)
import matplotlib.backends.qt_editor.figureoptions as figureoptions
from matplotlib.backends.qt_editor.formsubplottool import UiSubplotTool
from matplotlib.backend_managers import ToolManager
Expand Down Expand Up @@ -213,11 +213,11 @@ def _timer_stop(self):
class FigureCanvasQT(QtWidgets.QWidget, FigureCanvasBase):

# map Qt button codes to MouseEvent's ones:
buttond = {QtCore.Qt.LeftButton: 1,
QtCore.Qt.MidButton: 2,
QtCore.Qt.RightButton: 3,
# QtCore.Qt.XButton1: None,
# QtCore.Qt.XButton2: None,
buttond = {QtCore.Qt.LeftButton: MouseButton.LEFT,
QtCore.Qt.MidButton: MouseButton.MIDDLE,
QtCore.Qt.RightButton: MouseButton.RIGHT,
QtCore.Qt.XButton1: MouseButton.BACK,
QtCore.Qt.XButton2: MouseButton.FORWARD,
Copy link
Member Author

Choose a reason for hiding this comment

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

Note: Using XButton1 instead of BackButton to keep compatibility with Qt 4.8
http://doc.qt.io/archives/qt-4.8/qt.html#MouseButton-enum

}

@_allow_super_init
Expand Down
6 changes: 4 additions & 2 deletions lib/matplotlib/rcsetup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1425,8 +1425,10 @@ def _validate_linestyle(ls):
# key-mappings (multi-character mappings should be a list/tuple)
'keymap.fullscreen': [['f', 'ctrl+f'], validate_stringlist],
'keymap.home': [['h', 'r', 'home'], validate_stringlist],
'keymap.back': [['left', 'c', 'backspace'], validate_stringlist],
'keymap.forward': [['right', 'v'], validate_stringlist],
'keymap.back': [['left', 'c', 'backspace', 'MouseButton.BACK'],
validate_stringlist],
'keymap.forward': [['right', 'v', 'MouseButton.FORWARD'],
validate_stringlist],
'keymap.pan': [['p'], validate_stringlist],
'keymap.zoom': [['o'], validate_stringlist],
'keymap.save': [['s', 'ctrl+s'], validate_stringlist],
Expand Down
4 changes: 2 additions & 2 deletions matplotlibrc.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,8 +583,8 @@
## Leave the field(s) empty if you don't need a key-map. (i.e., fullscreen : '')
#keymap.fullscreen : f, ctrl+f ## toggling
#keymap.home : h, r, home ## home or reset mnemonic
#keymap.back : left, c, backspace ## forward / backward keys to enable
#keymap.forward : right, v ## left handed quick navigation
#keymap.back : left, c, backspace, MouseButton.BACK ## forward / backward keys
#keymap.forward : right, v, MouseButton.FORWARD ## for quick navigation
#keymap.pan : p ## pan mnemonic
#keymap.zoom : o ## zoom mnemonic
#keymap.save : s, ctrl+s ## saving current figure
Expand Down
0