Deprecate event processing wrapper methods on FigureManagerBase.

anntzer · anntzer · commit 6df4d2db0536 · 2020-11-25T23:22:05.000+01:00
Calling the standard handlers (`key_press_handler`,
`button_press_handler`) directly is just fine.  If someone wants to
simulate a key or button event they should pass the event to the
CallbackRegistry (as noted in the API changes note) so that things also
work when using toolmanager.
diff --git a/doc/api/next_api_changes/deprecations/19008-AL.rst b/doc/api/next_api_changes/deprecations/19008-AL.rst
@@ -0,0 +1,5 @@
+``FigureManagerBase.key_press`` and ``button_press``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These methods, which incorrectly did nothing when using ``toolmanager``, are
+deprecated in favor of directly passing the event to the `.CallbackRegistry`
+via ``self.canvas.callbacks.process(event.name, event)``.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2714,11 +2714,9 @@ def __init__(self, canvas, num):
         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)
+                'key_press_event', key_press_handler)
             self.button_press_handler_id = self.canvas.mpl_connect(
-                'button_press_event',
-                self.button_press)
+                'button_press_event', button_press_handler)
 
         self.toolmanager = (ToolManager(canvas.figure)
                             if mpl.rcParams['toolbar'] == 'toolmanager'
@@ -2758,6 +2756,8 @@ def full_screen_toggle(self):
     def resize(self, w, h):
         """For GUI backends, resize the window (in pixels)."""
 
+    @_api.deprecated(
+        "3.4", alternative="self.canvas.callbacks.process(event.name, event)")
     def key_press(self, event):
         """
         Implement the default Matplotlib key bindings defined at
@@ -2766,6 +2766,8 @@ def key_press(self, event):
         if rcParams['toolbar'] != 'toolmanager':
             key_press_handler(event)
 
+    @_api.deprecated(
+        "3.4", alternative="self.canvas.callbacks.process(event.name, event)")
     def button_press(self, event):
         """The default Matplotlib button actions for extra mouse buttons."""
         if rcParams['toolbar'] != 'toolmanager':
