Merge pull request #1093 from pelson/ability_to_disable_key_handling

efiring · efiring · commit b68440f6808b · 2012-08-15T14:43:20.000-07:00
Exposed the callback id for the default key press handler so that it can be easily diabled. Fixes #215.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2413,7 +2413,17 @@ def __init__(self, canvas, num):
         canvas.manager = self  # store a pointer to parent
         self.num = num
 
-        self.canvas.mpl_connect('key_press_event', self.key_press)
+        self.key_press_handler_id = self.canvas.mpl_connect('key_press_event',
+                                                            self.key_press)
+        """
+        The returned id from connecting the default key handler via :meth:`FigureCanvasBase.mpl_connnect`.
+        
+        To disable default key press handling::
+        
+            manager, canvas = figure.canvas.manager, figure.canvas
+            canvas.mpl_disconnect(manager.key_press_handler_id)
+            
+        """
 
     def destroy(self):
         pass
