Deprecate now unused NavigationToolbar2.set_cursor.

QuLogic · QuLogic · commit 6e3f43f13f1e · 2021-07-12T17:56:30.000-04:00
diff --git a/doc/api/next_api_changes/deprecations/20620-ES.rst b/doc/api/next_api_changes/deprecations/20620-ES.rst
@@ -0,0 +1,4 @@
+``NavigationToolbar2.set_cursor``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Instead, use the `.FigureCanvasBase.set_cursor` method on the canvas (available
+as the ``canvas`` attribute on the toolbar or the Figure.)
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2882,9 +2882,6 @@ class NavigationToolbar2:
       :meth:`save_figure`
          save the current figure
 
-      :meth:`set_cursor`
-         if you want the pointer icon to change
-
       :meth:`draw_rubberband` (optional)
          draw the zoom to rect "rubberband" rectangle
 
@@ -3248,6 +3245,7 @@ def save_figure(self, *args):
         """Save the current figure."""
         raise NotImplementedError
 
+    @_api.deprecated("3.5", alternative="canvas.set_cursor")
     def set_cursor(self, cursor):
         """
         Set the current cursor to one of the :class:`Cursors` enums values.
@@ -3257,6 +3255,7 @@ def set_cursor(self, cursor):
         called e.g. before a long-running task during which the GUI is not
         updated.
         """
+        self.canvas.set_cursor(cursor)
 
     def update(self):
         """Reset the axes stack."""
