added modifier key tracking in MouseEvents

jerryz123 · jerryz123 · commit 60eaf0d87109 · 2016-04-08T14:43:50.000-07:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1517,6 +1517,9 @@ class MouseEvent(LocationEvent):
     *step*
         number of scroll steps (positive for 'up', negative for 'down')
 
+    *modifiers*
+        modifier keys depressed when mouse event triggered
+
 
     Example usage::
 
@@ -1534,9 +1537,10 @@ def on_press(event):
     xdata = None     # x coord of mouse in data coords
     ydata = None     # y coord of mouse in data coords
     step = None      # scroll steps for scroll events
+    modifiers = None # depressed modifier keys
 
     def __init__(self, name, canvas, x, y, button=None, key=None,
-                 step=0, dblclick=False, guiEvent=None):
+                 step=0, dblclick=False, guiEvent=None, modifiers=None):
         """
         x, y in figure coords, 0,0 = bottom, left
         button pressed None, 1, 2, 3, 'up', 'down'
@@ -1546,6 +1550,7 @@ def __init__(self, name, canvas, x, y, button=None, key=None,
         self.key = key
         self.step = step
         self.dblclick = dblclick
+        self.modifiers = modifiers
 
     def __str__(self):
         return ("MPL MouseEvent: xy=(%d,%d) xydata=(%s,%s) button=%s " +
@@ -1886,7 +1891,7 @@ def scroll_event(self, x, y, step, guiEvent=None):
                                 step=step, guiEvent=guiEvent)
         self.callbacks.process(s, mouseevent)
 
-    def button_press_event(self, x, y, button, dblclick=False, guiEvent=None):
+    def button_press_event(self, x, y, button, dblclick=False, modifiers=None, guiEvent=None):
         """
         Backend derived classes should call this function on any mouse
         button press.  x,y are the canvas coords: 0,0 is lower, left.
@@ -1898,8 +1903,9 @@ def button_press_event(self, x, y, button, dblclick=False, guiEvent=None):
         """
         self._button = button
         s = 'button_press_event'
+
         mouseevent = MouseEvent(s, self, x, y, button, self._key,
-                                dblclick=dblclick, guiEvent=guiEvent)
+                                dblclick=dblclick, modifiers=modifiers, guiEvent=guiEvent)
         self.callbacks.process(s, mouseevent)
 
     def button_release_event(self, x, y, button, guiEvent=None):
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -254,8 +254,11 @@ def mousePressEvent(self, event):
         # flipy so y=0 is bottom of canvas
         y = self.figure.bbox.height - event.pos().y()
         button = self.buttond.get(event.button())
+        modifiers = "+".join([name for name, mod_key, qt_key in MODIFIER_KEYS
+                if (int(event.modifiers()) & mod_key) == mod_key])
         if button is not None:
             FigureCanvasBase.button_press_event(self, x, y, button,
+                                                modifiers=modifiers,
                                                 guiEvent=event)
         if DEBUG:
             print('button pressed:', event.button())
