Remove deprecated parts of the toolbar.

QuLogic · QuLogic · commit b6d3d984d8e1 · 2021-04-08T15:21:45.000-04:00
diff --git a/doc/api/next_api_changes/removals/19898-ES.rst b/doc/api/next_api_changes/removals/19898-ES.rst
@@ -0,0 +1,29 @@
+NavigationToolbar2._init_toolbar
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Overriding this method to initialize third-party toolbars is no longer
+supported. Instead, the toolbar should be initialized in the ``__init__``
+method of the subclass (which should call the base-class' ``__init__`` as
+appropriate).
+
+NavigationToolbar2.press and .release
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These methods were called when pressing or releasing a mouse button, but *only*
+when an interactive pan or zoom was occurring (contrary to what the docs
+stated). They are no longer called; if you write a backend which needs to
+customize such events, please directly override
+``press_pan``/``press_zoom``/``release_pan``/``release_zoom`` instead.
+
+NavigationToolbar2QT.parent and .basedir
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These attributes have been removed. In order to access the parent window, use
+``toolbar.canvas.parent()`` or ``toolbar.parent()``. The base directory to the
+icons is ``os.path.join(mpl.get_data_path(), "images")``.
+
+NavigationToolbar2QT.ctx
+~~~~~~~~~~~~~~~~~~~~~~~~
+This attribute has been removed.
+
+NavigationToolbar2Wx attributes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``prevZoomRect``, ``retinaFix``, ``savedRetinaImage``, ``wxoverlay``,
+``zoomAxes``, ``zoomStartX``, and ``zoomStartY`` attributes have been removed.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2944,14 +2944,6 @@ def __init__(self, canvas):
         # This cursor will be set after the initial draw.
         self._lastCursor = cursors.POINTER
 
-        init = _api.deprecate_method_override(
-            __class__._init_toolbar, self, allow_empty=True, since="3.3",
-            addendum="Please fully initialize the toolbar in your subclass' "
-            "__init__; a fully empty _init_toolbar implementation may be kept "
-            "for compatibility with earlier versions of Matplotlib.")
-        if init:
-            init()
-
         self._id_press = self.canvas.mpl_connect(
             'button_press_event', self._zoom_pan_handler)
         self._id_release = self.canvas.mpl_connect(
@@ -3013,29 +3005,6 @@ def forward(self, *args):
         self.set_history_buttons()
         self._update_view()
 
-    @_api.deprecated("3.3", alternative="__init__")
-    def _init_toolbar(self):
-        """
-        This is where you actually build the GUI widgets (called by
-        __init__).  The icons ``home.xpm``, ``back.xpm``, ``forward.xpm``,
-        ``hand.xpm``, ``zoom_to_rect.xpm`` and ``filesave.xpm`` are standard
-        across backends (there are ppm versions in CVS also).
-
-        You just need to set the callbacks
-
-        home         : self.home
-        back         : self.back
-        forward      : self.forward
-        hand         : self.pan
-        zoom_to_rect : self.zoom
-        filesave     : self.save_figure
-
-        You only need to define the last one - the others are in the base
-        class implementation.
-
-        """
-        raise NotImplementedError
-
     def _update_cursor(self, event):
         """
         Update the cursor after a mouse move event or a tool (de)activation.
@@ -3118,14 +3087,6 @@ def _zoom_pan_handler(self, event):
             elif event.name == "button_release_event":
                 self.release_zoom(event)
 
-    @_api.deprecated("3.3")
-    def press(self, event):
-        """Called whenever a mouse button is pressed."""
-
-    @_api.deprecated("3.3")
-    def release(self, event):
-        """Callback for mouse button release."""
-
     def pan(self, *args):
         """
         Toggle the pan/zoom tool.
@@ -3161,12 +3122,6 @@ def press_pan(self, event):
         id_drag = self.canvas.mpl_connect("motion_notify_event", self.drag_pan)
         self._pan_info = self._PanInfo(
             button=event.button, axes=axes, cid=id_drag)
-        press = _api.deprecate_method_override(
-            __class__.press, self, since="3.3", message="Calling an "
-            "overridden press() at pan start is deprecated since %(since)s "
-            "and will be removed %(removal)s; override press_pan() instead.")
-        if press is not None:
-            press(event)
 
     def drag_pan(self, event):
         """Callback for dragging in pan/zoom mode."""
@@ -3185,12 +3140,6 @@ def release_pan(self, event):
             'motion_notify_event', self.mouse_move)
         for ax in self._pan_info.axes:
             ax.end_pan()
-        release = _api.deprecate_method_override(
-            __class__.press, self, since="3.3", message="Calling an "
-            "overridden release() at pan stop is deprecated since %(since)s "
-            "and will be removed %(removal)s; override release_pan() instead.")
-        if release is not None:
-            release(event)
         self._draw()
         self._pan_info = None
         self.push_current()
@@ -3225,12 +3174,6 @@ def press_zoom(self, event):
         self._zoom_info = self._ZoomInfo(
             direction="in" if event.button == 1 else "out",
             start_xy=(event.x, event.y), axes=axes, cid=id_zoom)
-        press = _api.deprecate_method_override(
-            __class__.press, self, since="3.3", message="Calling an "
-            "overridden press() at zoom start is deprecated since %(since)s "
-            "and will be removed %(removal)s; override press_zoom() instead.")
-        if press is not None:
-            press(event)
 
     def drag_zoom(self, event):
         """Callback for dragging in zoom mode."""
@@ -3261,13 +3204,6 @@ def release_zoom(self, event):
                 or (abs(event.y - start_y) < 5 and event.key != "x")):
             self._draw()
             self._zoom_info = None
-            release = _api.deprecate_method_override(
-                __class__.press, self, since="3.3", message="Calling an "
-                "overridden release() at zoom stop is deprecated since "
-                "%(since)s and will be removed %(removal)s; override "
-                "release_zoom() instead.")
-            if release is not None:
-                release(event)
             return
 
         for i, ax in enumerate(self._zoom_info.axes):
@@ -3285,14 +3221,6 @@ def release_zoom(self, event):
         self._zoom_info = None
         self.push_current()
 
-        release = _api.deprecate_method_override(
-            __class__.release, self, since="3.3", message="Calling an "
-            "overridden release() at zoom stop is deprecated since %(since)s "
-            "and will be removed %(removal)s; override release_zoom() "
-            "instead.")
-        if release is not None:
-            release(event)
-
     def push_current(self):
         """Push the current view limits and position onto the stack."""
         self._nav_stack.push(
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -443,9 +443,6 @@ def resize(self, width, height):
 
 
 class NavigationToolbar2GTK3(NavigationToolbar2, Gtk.Toolbar):
-    ctx = _api.deprecated("3.3")(property(
-        lambda self: self.canvas.get_property("window").cairo_create()))
-
     def __init__(self, canvas, window):
         self.win = window
         GObject.GObject.__init__(self)
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -651,22 +651,6 @@ def __init__(self, canvas, parent, coordinates=True):
 
         NavigationToolbar2.__init__(self, canvas)
 
-    @_api.deprecated("3.3", alternative="self.canvas.parent()")
-    @property
-    def parent(self):
-        return self.canvas.parent()
-
-    @_api.deprecated("3.3", alternative="self.canvas.setParent()")
-    @parent.setter
-    def parent(self, value):
-        pass
-
-    @_api.deprecated(
-        "3.3", alternative="os.path.join(mpl.get_data_path(), 'images')")
-    @property
-    def basedir(self):
-        return str(cbook._get_data_path('images'))
-
     def _icon(self, name):
         """
         Construct a `.QIcon` from an image file *name*, including the extension
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -1110,21 +1110,6 @@ def __init__(self, canvas, coordinates=True):
 
         NavigationToolbar2.__init__(self, canvas)
 
-        self._prevZoomRect = None
-        # for now, use alternate zoom-rectangle drawing on all
-        # Macs. N.B. In future versions of wx it may be possible to
-        # detect Retina displays with window.GetContentScaleFactor()
-        # and/or dc.GetContentScaleFactor()
-        self._retinaFix = 'wxMac' in wx.PlatformInfo
-
-    prevZoomRect = _api.deprecate_privatize_attribute("3.3")
-    retinaFix = _api.deprecate_privatize_attribute("3.3")
-    savedRetinaImage = _api.deprecate_privatize_attribute("3.3")
-    wxoverlay = _api.deprecate_privatize_attribute("3.3")
-    zoomAxes = _api.deprecate_privatize_attribute("3.3")
-    zoomStartX = _api.deprecate_privatize_attribute("3.3")
-    zoomStartY = _api.deprecate_privatize_attribute("3.3")
-
     @staticmethod
     def _icon(name):
         """
@@ -1198,35 +1183,6 @@ def set_cursor(self, cursor):
         self.canvas.SetCursor(cursor)
         self.canvas.Update()
 
-    def press_zoom(self, event):
-        super().press_zoom(event)
-        if self.mode.name == 'ZOOM':
-            if not self._retinaFix:
-                self._wxoverlay = wx.Overlay()
-            else:
-                if event.inaxes is not None:
-                    self._savedRetinaImage = self.canvas.copy_from_bbox(
-                        event.inaxes.bbox)
-                    self._zoomStartX = event.xdata
-                    self._zoomStartY = event.ydata
-                    self._zoomAxes = event.inaxes
-
-    def release_zoom(self, event):
-        super().release_zoom(event)
-        if self.mode.name == 'ZOOM':
-            # When the mouse is released we reset the overlay and it
-            # restores the former content to the window.
-            if not self._retinaFix:
-                self._wxoverlay.Reset()
-                del self._wxoverlay
-            else:
-                del self._savedRetinaImage
-                if self._prevZoomRect:
-                    self._prevZoomRect.pop(0).remove()
-                    self._prevZoomRect = None
-                if self._zoomAxes:
-                    self._zoomAxes = None
-
     def draw_rubberband(self, event, x0, y0, x1, y1):
         height = self.canvas.figure.bbox.height
         self.canvas._rubberband_rect = (x0, height - y0, x1, height - y1)
