Moved event firing to source, i.e. to the trigger method. Now one must override the _trigger method instead.

Author: OceanWolf

lib/matplotlib/backend_bases.py

@@ -3512,7 +3512,6 @@ def trigger_tool(self, name, sender=None, canvasevent=None, data=None):
         # Important!!!
         # This is where the Tool object gets triggered
         tool.trigger(sender, canvasevent, data)
-        tool.trigger_event(sender, canvasevent, data)
 
     def _key_press(self, event):
         if event.key is None or self.keypresslock.locked():

lib/matplotlib/backend_tools.py

@@ -13,6 +13,7 @@
 
 from matplotlib import rcParams
 from matplotlib._pylab_helpers import Gcf
+from matplotlib import docstring
 import matplotlib.cbook as cbook
 from weakref import WeakKeyDictionary
 import numpy as np
@@ -74,6 +75,7 @@ def __init__(self, navigation, name):
         self._callbacks = cbook.CallbackRegistry()
         self.set_figure(navigation.canvas.figure)
 
+    @docstring.dedent_interpd
     def trigger(self, sender, event, data=None):
         """Called when this tool gets used
 
@@ -89,7 +91,13 @@ def trigger(self, sender, event, data=None):
         data: object
             Extra data
         """
+        self._trigger(sender, event, data)
+        self.trigger_event(sender, event, data)
 
+    def _trigger(self, *args, **kwargs):
+        """ Tools should Override this method, not trigger.
+        %(trigger)s
+        """
         pass
 
     def set_figure(self, figure):
@@ -155,7 +163,7 @@ def __init__(self, *args, **kwargs):
         ToolBase.__init__(self, *args, **kwargs)
         self._toggled = False
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         """Calls `enable` or `disable` based on `toggled` value"""
         if self._toggled:
             self.disable(event)
@@ -284,7 +292,7 @@ def send_message(self, event):
 
 class RubberbandBase(ToolBase):
     """Draw and remove rubberband"""
-    def trigger(self, sender, event, data):
+    def _trigger(self, sender, event, data):
         """Call `draw_rubberband` or `remove_rubberband` based on data"""
         if not self.figure.canvas.widgetlock.available(sender):
             return
@@ -314,7 +322,7 @@ class ToolQuit(ToolBase):
     description = 'Quit the figure'
     keymap = rcParams['keymap.quit']
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         Gcf.destroy_fig(self.figure)
 
 
@@ -324,7 +332,7 @@ class ToolEnableAllNavigation(ToolBase):
     description = 'Enables all axes navigation'
     keymap = rcParams['keymap.all_axes']
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         if event.inaxes is None:
             return
 
@@ -340,7 +348,7 @@ class ToolEnableNavigation(ToolBase):
     description = 'Enables one axes navigation'
     keymap = (1, 2, 3, 4, 5, 6, 7, 8, 9)
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         if event.inaxes is None:
             return
 
@@ -359,10 +367,10 @@ class ToolGrid(ToolToggleBase):
     description = 'Toogle Grid'
     keymap = rcParams['keymap.grid']
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         if event.inaxes is None:
             return
-        ToolToggleBase.trigger(self, sender, event, data)
+        ToolToggleBase._trigger(self, sender, event, data)
 
     def enable(self, event):
         event.inaxes.grid(True)
@@ -389,10 +397,10 @@ def disable(self, event):
 class AxisScaleBase(ToolToggleBase):
     """Base Tool to toggle between linear and logarithmic"""
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         if event.inaxes is None:
             return
-        ToolToggleBase.trigger(self, sender, event, data)
+        ToolToggleBase._trigger(self, sender, event, data)
 
     def enable(self, event):
         self.set_scale(event.inaxes, 'log')
@@ -537,7 +545,7 @@ class ViewsPositionsBase(ToolBase):
 
     _on_trigger = None
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         self.navigation.get_tool('viewpos').add_figure()
         getattr(self.navigation.get_tool('viewpos'), self._on_trigger)()
         self.navigation.get_tool('viewpos').update_view()
@@ -614,9 +622,9 @@ def disable(self, event):
         self.figure.canvas.mpl_disconnect(self._idRelease)
         self.figure.canvas.mpl_disconnect(self._idScroll)
 
-    def trigger(self, sender, event, data=None):
+    def _trigger(self, sender, event, data=None):
         self.navigation.get_tool('viewpos').add_figure()
-        ToolToggleBase.trigger(self, sender, event, data)
+        ToolToggleBase._trigger(self, sender, event, data)
 
     def scroll_zoom(self, event):
         # https://gist.github.com/tacaswell/3144287