Merge pull request #21591 from anntzer/tfs

timhoffm · web-flow · commit 2ee31d254f2d · 2021-11-20T21:32:37.000+01:00
Make ToolFullScreen a Tool, not a ToolToggle.
diff --git a/doc/api/next_api_changes/removals/21591-AL.rst b/doc/api/next_api_changes/removals/21591-AL.rst
@@ -0,0 +1,6 @@
+``backend_tools.ToolFullScreen`` now inherits from ``ToolBase``, not from ``ToolToggleBase``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`.ToolFullScreen` can only switch between the non-fullscreen
+and fullscreen states, but not unconditionally put the window in a given state;
+hence the ``enable`` and ``disable`` methods were misleadingly named.  Thus,
+the `.ToolToggleBase`-related API (``enable``, ``disable``, etc.) was removed.
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -428,16 +428,13 @@ def trigger(self, sender, event, data=None):
             mpl.backend_bases.key_press_handler(event, self.figure.canvas)
 
 
-class ToolFullScreen(ToolToggleBase):
+class ToolFullScreen(ToolBase):
     """Tool to toggle full screen."""
 
     description = 'Toggle fullscreen mode'
     default_keymap = mpl.rcParams['keymap.fullscreen']
 
-    def enable(self, event):
-        self.figure.canvas.manager.full_screen_toggle()
-
-    def disable(self, event):
+    def trigger(self, sender, event, data=None):
         self.figure.canvas.manager.full_screen_toggle()
 
 
