Make FigureManagerWx more consistent with other backends.

anntzer · anntzer · commit e14ba6747970 · 2019-01-10T20:27:23.000+01: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
@@ -1180,8 +1180,6 @@ def __init__(self, num, fig):
 
         self.canvas.SetMinSize((2, 2))
 
-        self.figmgr = FigureManagerWx(self.canvas, num, self)
-
         self.Bind(wx.EVT_CLOSE, self._onClose)
 
     def _get_toolbar(self, statbar):
@@ -1204,6 +1202,16 @@ def _get_toolmanager(self):
     def get_canvas(self, fig):
         return FigureCanvasWx(self, -1, fig)
 
+    @cbook.deprecated("3.1", alternative="frame.canvas.manager or "
+                      "FigureManagerWx(frame.canvas, num, frame)")
+    @property
+    def figmgr(self):
+        if self.canvas.manager is None:
+            FigureManagerWx(self.canvas, num, self)  # Assigns canvas.manager.
+        return self.canvas.manager
+
+    @cbook.deprecated("3.1", alternative="frame.canvas.manager or "
+                      "FigureManagerWx(frame.canvas, num, frame)")
     def get_figure_manager(self):
         DEBUG_MSG("get_figure_manager()", 1, self)
         return self.figmgr
@@ -1244,29 +1252,27 @@ 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):
-        DEBUG_MSG("__init__()", 1, self)
+    def __init__(self, canvas, num, frame=None):
+        if frame is not None:
+            cbook.warn_deprecated(
+                "3.1", name="frame", obj_type="argument",
+                addendum="Do not pass it anymore.")
         FigureManagerBase.__init__(self, canvas, num)
-        self.frame = frame
-        self.window = frame
-
-        self.toolmanager = getattr(frame, "toolmanager", None)
-        self.toolbar = frame.GetToolBar()
+        self.frame = self.window = canvas.GetParent()
+        self.toolmanager = getattr(self.frame, "toolmanager", None)
+        self.toolbar = self.frame.GetToolBar()
 
     def show(self):
-        self.frame.Show()
+        self.window.Show()
         self.canvas.draw()
 
     def destroy(self, *args):
         DEBUG_MSG("destroy()", 1, self)
-        self.frame.Destroy()
+        self.window.Destroy()
         wxapp = wx.GetApp()
         if wxapp:
             wxapp.Yield()
@@ -2066,11 +2072,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 matplotlib.is_interactive():
-            figmgr.frame.Show()
+            frame.Show()
             figure.canvas.draw_idle()
-        return figmgr
+        return manager
 
     @staticmethod
     def mainloop():
