Deprecate FigureCanvasBase.idle_event.

The corresponding event had been deprecated since 1.5.
SirJohnFranklin · Apr 9, 2017 · fd59a34 · fd59a34
1 parent e24f127
commit fd59a34
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 37 deletions.
diff --git a/examples/event_handling/idle_and_timeout.py b/examples/event_handling/idle_and_timeout.py
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1354,6 +1354,7 @@ def __init__(self, name, canvas, guiEvent=None):
         self.guiEvent = guiEvent
 
 
+@cbook.deprecated("2.1")
 class IdleEvent(Event):
     """
     An event triggered by the GUI backend when it is idle -- useful
@@ -1952,6 +1953,7 @@ def enter_notify_event(self, guiEvent=None, xy=None):
         event = Event('figure_enter_event', self, guiEvent)
         self.callbacks.process('figure_enter_event', event)
 
+    @cbook.deprecated("2.1")
     def idle_event(self, guiEvent=None):
         """Called when GUI is idle."""
         s = 'idle_event'