Deprecate macos close handler.

anntzer · anntzer · commit 7f163ca746d8 · 2022-07-21T23:37:55.000+02:00
This is similar to the `_widgetclosed` handler in qt and the `_on_close`
handler in wx.
diff --git a/doc/api/next_api_changes/deprecations/23464-AL.rst b/doc/api/next_api_changes/deprecations/23464-AL.rst
@@ -0,0 +1,2 @@
+``FigureManagerMac.close`` is deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/lib/matplotlib/backends/backend_macosx.py b/lib/matplotlib/backends/backend_macosx.py
@@ -158,10 +158,14 @@ def __init__(self, canvas, num):
             self.show()
             self.canvas.draw_idle()
 
-    def close(self):
+    def _close_button_pressed(self):
         Gcf.destroy(self)
         self.canvas.flush_events()
 
+    @_api.deprecated("3.6")
+    def close(self):
+        return self._close_button_pressed()
+
     def show(self):
         if not self._shown:
             self._show()
diff --git a/src/_macosx.m b/src/_macosx.m
@@ -1132,7 +1132,7 @@ - (NSRect)constrainFrameRect:(NSRect)rect toScreen:(NSScreen*)screen
 
 - (BOOL)closeButtonPressed
 {
-    gil_call_method(manager, "close");
+    gil_call_method(manager, "_close_button_pressed");
     return YES;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+``FigureManagerMac.close`` is deprecated
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
Original file line number	Diff line number	Diff line change
`@@ -1132,7 +1132,7 @@ - (NSRect)constrainFrameRect:(NSRect)rect toScreen:(NSScreen*)screen`
`1132`	`1132`
`1133`	`1133`	`- (BOOL)closeButtonPressed`
`1134`	`1134`	`{`
`1135`		`- gil_call_method(manager, "close");`
	`1135`	`+ gil_call_method(manager, "_close_button_pressed");`
`1136`	`1136`	`return YES;`
`1137`	`1137`	`}`
`1138`	`1138`