Tested Tkinter and PySide keys on osx (10.7)

Author: pelson

lib/matplotlib/backends/backend_qt4.py

@@ -123,6 +123,7 @@ class FigureCanvasQT( QtGui.QWidget, FigureCanvasBase ):
     keyvald = { QtCore.Qt.Key_Control : 'control',
                 QtCore.Qt.Key_Shift : 'shift',
                 QtCore.Qt.Key_Alt : 'alt',
+                QtCore.Qt.Key_Meta : 'super',
                 QtCore.Qt.Key_Return : 'enter',
                 QtCore.Qt.Key_Left : 'left',
                 QtCore.Qt.Key_Up : 'up',
@@ -146,13 +147,37 @@ class FigureCanvasQT( QtGui.QWidget, FigureCanvasBase ):
                 QtCore.Qt.Key_PageUp : 'pageup',
                 QtCore.Qt.Key_PageDown : 'pagedown',
                }
+
+    # define the modifier keys which are to be collected on keyboard events.
+    # format is: [(modifier_flag, modifier_name, equivalent_key)
+    _modifier_keys = [
+                      (QtCore.Qt.MetaModifier, 'super', QtCore.Qt.Key_Meta),
+                      (QtCore.Qt.AltModifier, 'alt', QtCore.Qt.Key_Alt),
+                      (QtCore.Qt.ControlModifier, 'ctrl', QtCore.Qt.Key_Control) 
+                      ]
+    
+    if sys.platform == 'darwin':
+        # in OSX, the control and super (aka cmd/apple) keys are switched, so 
+        # switch them back.
+        keyvald.update({
+                        QtCore.Qt.Key_Control : 'super', # cmd/apple key
+                        QtCore.Qt.Key_Meta : 'control',
+                        })
+        
+        _modifier_keys = [
+                          (QtCore.Qt.ControlModifier, 'super', QtCore.Qt.Key_Control),
+                          (QtCore.Qt.AltModifier, 'alt', QtCore.Qt.Key_Alt),
+                          (QtCore.Qt.MetaModifier, 'ctrl', QtCore.Qt.Key_Meta),
+                         ]
+      
     # 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,
                }
+  
     def __init__( self, figure ):
         if DEBUG: print('FigureCanvasQt: ', figure)
         _create_qApp()
@@ -295,8 +320,7 @@ def _get_key( self, event ):
 
         if key is not None:
             # prepend the ctrl, alt, super keys if appropriate (sorted in that order) 
-            for modifier, Qt_key, prefix in [(QtCore.Qt.AltModifier, QtCore.Qt.Key_Alt, 'alt'),
-                                             (QtCore.Qt.ControlModifier, QtCore.Qt.Key_Control, 'ctrl')]:
+            for modifier, prefix, Qt_key in self._modifier_keys:
                 if event.key() != Qt_key and int(event.modifiers()) & modifier == modifier: 
                     key = '{}+{}'.format(prefix, key)
 
@@ -368,6 +392,14 @@ def __init__( self, canvas, num ):
         self.canvas.setFocusPolicy( QtCore.Qt.StrongFocus )
         self.canvas.setFocus()
 
+        if sys.platform == 'darwin':
+            # to make a qt window pop up on top on osx, osascript can be used
+            # this came from http://sourceforge.net/mailarchive/message.php?msg_id=23718545
+            cmd = ("""/usr/bin/osascript -e 'tell app "Finder" to set """ + \
+                    """frontmost of process "%s" to true'""") % \
+                    os.path.basename(sys.executable)
+            os.system(cmd)
+
         QtCore.QObject.connect( self.window, QtCore.SIGNAL( 'destroyed()' ),
                             self._widgetclosed )
         self.window._destroying = False
@@ -398,9 +430,9 @@ def __init__( self, canvas, num ):
         self.canvas.figure.show = lambda *args: self.window.show()
 
         def notify_axes_change( fig ):
-           # This will be called whenever the current axes is changed
-           if self.toolbar is not None:
-               self.toolbar.update()
+            # This will be called whenever the current axes is changed
+            if self.toolbar is not None:
+                self.toolbar.update()
         self.canvas.figure.add_axobserver( notify_axes_change )
 
     @QtCore.Slot()
@@ -409,10 +441,10 @@ def _show_message(self,s):
         self.window.statusBar().showMessage(s)
 
     def full_screen_toggle(self):
-       if self.window.isFullScreen():
-           self.window.showNormal()    
-       else:
-           self.window.showFullScreen()
+        if self.window.isFullScreen():
+            self.window.showNormal()    
+        else:
+            self.window.showFullScreen()
 
     def _widgetclosed( self ):
         if self.window._destroying: return

lib/matplotlib/backends/backend_tkagg.py

@@ -174,6 +174,17 @@ class FigureCanvasTkAgg(FigureCanvasAgg):
                65439 : 'dec',
                65421 : 'enter',
                }
+    
+    _keycode_lookup = {
+                       262145: 'control',
+                       524320: 'alt',
+                       524352: 'alt',
+                       1048584: 'super',
+                       1048592: 'super',
+                       131074: 'shift',
+                       131076: 'shift',
+                       }
+    """_keycode_lookup is used for badly mapped keys on apple keyboards."""
 
     def __init__(self, figure, master=None, resize_callback=None):
         FigureCanvasAgg.__init__(self, figure)
@@ -217,7 +228,15 @@ def filter_destroy(evt):
 
         self._master = master
         self._tkcanvas.focus_set()
-
+        
+        if sys.platform == 'darwin':
+            # to make a tkagg window pop up on top on osx, osascript can be used
+            # this came from http://sourceforge.net/mailarchive/message.php?msg_id=23718545
+            cmd = ("""/usr/bin/osascript -e 'tell app "Finder" to set """ + \
+                    """frontmost of process "%s" to true'""") % \
+                    os.path.basename(sys.executable)
+            os.system(cmd)
+            
     def resize(self, event):
         width, height = event.width, event.height
         if self._resize_callback is not None:
@@ -399,20 +418,30 @@ def _get_key(self, event):
         val = event.keysym_num
         if val in self.keyvald:
             key = self.keyvald[val]
+        elif val == 0 and sys.platform == 'darwin' and \
+                                        event.keycode in self._keycode_lookup:
+            key = self._keycode_lookup[event.keycode]
         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;
+        # In general, the modifier key is excluded from the modifier flag, 
+        # however this is not the case on "darwin", so double check that 
+        # we aren't adding repeat modifier flags to a modifier key.
+        modifiers = (3, 'alt', 'alt'), (2, 'ctrl', 'control'), 
+        if sys.platform == 'darwin':
+            modifiers = (3, 'super', 'super'), (4, 'alt', 'alt'), (2, 'ctrl', 'control'),
+        
         if key is not None:
             # note, shift is not added to the keys as this is already accounted for
-            for bitmask, prefix in [(3, 'alt'), (2, 'ctrl'), ]:
-                if event.state & (1 << bitmask): 
+            for bitmask, prefix, key_name in modifiers:
+                if event.state & (1 << bitmask) and key_name not in key: 
                     key = '{}+{}'.format(prefix, key)
 
         return key