Make FigureManagerWx more consistent with other backends.

anntzer · anntzer · commit 49a1be669262 · 2021-06-03T19:44:05.000+02:00
diff --git a/doc/api/next_api_changes/2018-01-12-AL.rst b/doc/api/next_api_changes/2018-01-12-AL.rst
@@ -0,0 +1,13 @@
+Changes to the wx backend
+`````````````````````````
+
+- `FigureFrameWx` no longer attaches a `FigureManagerWx`
+  to the figure.  Instead, the `FigureManagerWx` is
+  now created by `backend_wx.new_figure_manager` or
+  `backend_wx.new_figure_manager_given_figure`, consistently with the
+  other backends.  Accordingly, the ``FigureFrameWx.figmgr`` attribute
+  and ``FigureFrameWx.get_figure_manager`` method are deprecated (use the
+  cross-backend ``figure.canvas.manager`` instead).
+- The *frame* argument and attribute of `FigureManagerWx` are deprecated, for
+  consistency with other backends.  The :attr:`FigureManagerWx.window`
+  attribute is now always set to the canvas' parent.
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -921,6 +921,16 @@ def _get_toolbar(self):
     def get_canvas(self, fig):
         return FigureCanvasWx(self, -1, fig)
 
+    @cbook.deprecated("3.5", alternative="frame.canvas.manager or "
+                      "FigureManagerWx(frame.canvas, num)")
+    @property
+    def figmgr(self):
+        if self.canvas.manager is None:
+            FigureManagerWx(self.canvas, self.num, self)  # Sets canvas.manager
+        return self.canvas.manager
+
+    @cbook.deprecated("3.5", alternative="frame.canvas.manager or "
+                      "FigureManagerWx(frame.canvas, num)")
     def get_figure_manager(self):
         _log.debug("%s - get_figure_manager()", type(self))
         return self.figmgr
@@ -966,22 +976,21 @@ class FigureManagerWx(FigureManagerBase):
 
     Attributes
     ----------
-    canvas : `FigureCanvas`
-        a FigureCanvasWx(wx.Panel) instance
+    canvas : FigureCanvasWx
     window : wxFrame
-        a wxFrame instance - wxpython.org/Phoenix/docs/html/Frame.html
     """
 
-    def __init__(self, canvas, num, frame):
+    @_api.delete_parameter("3.5", "frame")
+    def __init__(self, canvas, num, frame=None):
         _log.debug("%s - __init__()", type(self))
-        self.frame = self.window = frame
+        self.frame = self.window = canvas.GetParent()
         self._initializing = True
         super().__init__(canvas, num)
         self._initializing = False
 
     @property
     def toolbar(self):
-        return self.frame.GetToolBar()
+        return self.window.GetToolBar()
 
     @toolbar.setter
     def toolbar(self, value):
@@ -992,23 +1001,23 @@ def toolbar(self, value):
 
     def show(self):
         # docstring inherited
-        self.frame.Show()
+        self.window.Show()
         self.canvas.draw()
         if mpl.rcParams['figure.raise_window']:
-            self.frame.Raise()
+            self.window.Raise()
 
     def destroy(self, *args):
         # docstring inherited
         _log.debug("%s - destroy()", type(self))
-        frame = self.frame
+        frame = self.window
         if frame:  # Else, may have been already deleted, e.g. when closing.
             # As this can be called from non-GUI thread from plt.close use
             # wx.CallAfter to ensure thread safety.
             wx.CallAfter(frame.Close)
 
     def full_screen_toggle(self):
         # docstring inherited
-        self.frame.ShowFullScreen(not self.frame.IsFullScreen())
+        self.window.ShowFullScreen(not self.window.IsFullScreen())
 
     def get_window_title(self):
         # docstring inherited
@@ -1388,11 +1397,11 @@ def new_figure_manager(cls, num, *args, **kwargs):
     @classmethod
     def new_figure_manager_given_figure(cls, num, figure):
         frame = cls._frame_class(num, figure)
-        figmgr = frame.get_figure_manager()
+        manager = FigureManagerWx(figure.canvas, num)
         if mpl.is_interactive():
-            figmgr.frame.Show()
+            frame.Show()
             figure.canvas.draw_idle()
-        return figmgr
+        return manager
 
     @staticmethod
     def mainloop():
