added modifier key support to the tk backend (i.e. ctrl+key). Additional support will need to be added for qt, gtk and wx backends.

Phil Elson · pelson · commit 3bbbd0a27a56 · 2012-06-24T20:22:19.000+01:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1400,7 +1400,7 @@ class KeyEvent(LocationEvent):
     attributes, the following attributes are defined:
 
     *key*
-        the key pressed: None, chr(range(255), shift, win, or control
+        the key pressed: None, chr(range(255)), shift, win, or control
 
     This interface may change slightly when better support for
     modifier keys is included.
@@ -2296,10 +2296,10 @@ def key_press_handler(event, canvas, toolbar=None):
     if event.key in fullscreen_keys:
         canvas.manager.full_screen_toggle()
 
-    # quit the figure (defaut key 'q')
+    # quit the figure (defaut key 'ctrl+w')
     if event.key in quit_keys:
         Gcf.destroy_fig(canvas.figure)
-   
+       
     if toolbar is not None:
         # home or reset mnemonic  (default key 'h', 'home' and 'r')
         if event.key in home_keys:
diff --git a/lib/matplotlib/backends/backend_tkagg.py b/lib/matplotlib/backends/backend_tkagg.py
@@ -399,13 +399,24 @@ def _get_key(self, event):
         val = event.keysym_num
         if val in self.keyvald:
             key = self.keyvald[val]
-        elif val<256:
+        elif val < 256:
             key = chr(val)
         else:
             key = None
+        
+        # add modifier keys to the key string. Bit details originate from 
+        # http://effbot.org/tkinterbook/tkinter-events-and-bindings.htm
+        # BIT_SHIFT = 0x001; BIT_CAPSLOCK = 0x002; BIT_CONTROL = 0x004; 
+        # BIT_LEFT_ALT = 0x008; BIT_NUMLOCK = 0x010; BIT_RIGHT_ALT = 0x080; 
+        # BIT_MB_1 = 0x100; BIT_MB_2 = 0x200; BIT_MB_3 = 0x400;
+        if key is not None:
+            # note, shift is not added to the keys as this is already accounted for
+            for bitmask, prefix in [(2, 'ctrl'), (3, 'alt')]:
+                if event.state & (1 << bitmask): 
+                    key = '{}+{}'.format(prefix, key)
+                     
         return key
 
-
     def key_press(self, event):
         key = self._get_key(event)
         FigureCanvasBase.key_press_event(self, key, guiEvent=event)
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -575,14 +575,14 @@ def __call__(self, s):
                                                     # recommend about 20000 to
                                                     # enable. Experimental.
     # key-mappings
-    'keymap.fullscreen' : ['f', validate_stringlist],
+    '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.pan' : ['p', validate_stringlist],
     'keymap.zoom' : ['o', validate_stringlist],
-    'keymap.save' : ['s', validate_stringlist],
-    'keymap.quit' : ['q', validate_stringlist],
+    'keymap.save' : [('s', 'ctrl+s'), validate_stringlist],
+    'keymap.quit' : [('ctrl+w', 'escape'), validate_stringlist],
     'keymap.grid' : ['g', validate_stringlist],
     'keymap.yscale' : ['l', validate_stringlist],
     'keymap.xscale' : [['k', 'L'], validate_stringlist],
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -410,7 +410,7 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
 #keymap.pan : p                      # pan mnemonic
 #keymap.zoom : o                     # zoom mnemonic
 #keymap.save : s                     # saving current figure
-#keymap.quit : q                     # close the current figure
+#keymap.quit : ctrl+w                # close the current figure
 #keymap.grid : g                     # switching on/off a grid in current axes
 #keymap.yscale : l                   # toggle scaling of y-axes ('log'/'linear')
 #keymap.xscale : L, k                # toggle scaling of x-axes ('log'/'linear')
