Lots of fixes

matplotlib · WeatherGod · Apr 9, 2015 · Jan 23, 2014 · Jan 23, 2014 · Jan 24, 2014
commit 9f2ee2b8cc5642fb79505a1da7bbf51a8dd9b43c
diff --git a/examples/user_interfaces/navigation.py b/examples/user_interfaces/navigation.py
@@ -56,7 +56,7 @@ def trigger(self, *args, **kwargs):
 fig.canvas.manager.navigation.add_tool('List', ListTools)
 if matplotlib.rcParams['backend'] == 'GTK3Cairo':
     fig.canvas.manager.navigation.add_tool('copy', CopyToolGTK3)
-
+fig.canvas.manager.toolbar.add_tool('zoom', 'foo')
 # Uncomment to remove the forward button
 # fig.canvas.manager.navigation.remove_tool('forward')
 

diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3413,7 +3413,7 @@ def add_tools(self, tools):
         for tool, name in tools:
             self.add_tool(name, tool)
 
-    def add_tool(self, name, tool):
+    def add_tool(self, name, tool, *args, **kwargs):
         """Add tool to `NavigationBase`
 
         Add a tool to the tools controlled by Navigation
@@ -3428,6 +3428,10 @@ def add_tool(self, name, tool):
             Name of the tool, treated as the ID, has to be unique
         tool : string or `matplotlib.backend_tools.ToolBase` derived class
             Reference to find the class of the Tool to be added
+
+        Notes
+        -----
+        args and kwargs get passed directly to the tools constructor.
         """
 
         tool_cls = self._get_cls_to_instantiate(tool)
@@ -3440,12 +3444,7 @@ def add_tool(self, name, tool):
                           'not added')
             return
 
-        if isinstance(tool_cls, type):
-            self._tools[name] = tool_cls(self, name)
-        else:
-            tool_cls.set_navigation(self)
-            tool.name = name
-            self._tools[name] = tool_cls
+        self._tools[name] = tool_cls(self, name, *args, **kwargs)
 
         if tool_cls.keymap is not None:
             self.set_tool_keymap(name, tool_cls.keymap)
@@ -3460,7 +3459,6 @@ def add_tool(self, name, tool):
                 self._toggled.setdefault(tool_cls.radio_group, None)
 
         self._tool_added_event(self._tools[name])
-
         return self._tools[name]
 
     def _tool_added_event(self, tool):
@@ -3583,7 +3581,7 @@ def get_tool(self, name):
         name : String, ToolBase
             Name of the tool, or the tool itself
         """
-        if isinstance(name, tools.ToolBase):
+        if isinstance(name, tools.ToolBase) and tool.name in self._tools:
             return name
         if name not in self._tools:
             warnings.warn("%s is not a tool controlled by Navigation" % name)
@@ -3612,15 +3610,12 @@ def _message_cbk(self, event):
         """Captures the 'tool_message_event' to set the message on the toolbar"""
         self.set_message(event.message)
 
-    def _tool_triggered_cbk(self, event):
+    def _tool_toggled_cbk(self, event):
         """Captures the 'tool-trigger-toolname
 
         This only gets used for toggled tools
         """
-        if event.sender is self:
-            return
-
-        self.toggle_toolitem(event.tool.name)
+        self.toggle_toolitem(event.tool.name, event.tool.toggled)
 
     def add_tools(self, tools):
         """ Add multiple tools to `Navigation`
@@ -3639,25 +3634,38 @@ def add_tools(self, tools):
             for position, tool in enumerate(grouptools):
                 self.add_tool(tool, group, position)
 
-    def add_tool(self, tool, group, position):
-        """Adds a tool to the toolbar"""
+    def add_tool(self, tool, group, position=-1, name=None, **kwargs):
+        """Adds a tool to the toolbar
+
+        Parameters
+        ----------
+        tool : string, tool
+            The name or the type of tool to add.
+        group : string
+            The name of the group to add this tool to.
+        position : int
+            the relative position within the group to place this tool.
+        name : string (optional)
+            If given, and the above fails, we use this to create a new tool of
+            type given by tool, and use this as the name of the tool.
+        """
         t = self.navigation.get_tool(tool)
         if t is None:
-            if isinstance(tool, (list, tuple)):
-                t = self.navigation.add_tool(tool[0], tool[1])
-            elif isinstance(tool, ToolBase):
-                t = self.navigation.add_tool(tool.name, tool)
-            else:
-                warning.warn('Cannot add tool %s'%tool)
-                return
+            if isinstance(tool, type):
+                tool = tool.__class__
+            if name is not None:
+                t = self.navigation.add_tool(name, tool, **kwargs)
+        if t is None:
+            warning.warn('Cannot add tool %s'%tool)
+            return
         tool = t
         image = self._get_image_filename(tool.image)
         toggle = getattr(tool, 'toggled', None) is not None
         self.add_toolitem(tool.name, group, position, image,
                                             tool.description, toggle)
         if toggle:
             self.navigation.nav_connect('tool_trigger_%s' % tool.name,
-                                        self._tool_triggered_cbk)
+                                        self._tool_toggled_cbk)
 
     def _remove_tool_cbk(self, event):
         """Captures the 'tool_removed_event' signal and removes the tool"""

diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -65,9 +65,6 @@ class ToolBase(object):
     def __init__(self, navigation, name):
         self._name = name
         self.figure = None
-        self.set_navigation(navigation)
-
-    def set_navigation(self, navigation):
         self.navigation = navigation
         self.set_figure(navigation.canvas.figure)
 

diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -767,7 +767,6 @@ def __init__(self, navigation):
         self.pack_start(self._toolbar, False, False, 0)
         self._toolbar.show_all()
         self._toolitems = {}
-        self._signals = {}
         self._setup_message_area()
 
     def _setup_message_area(self):
@@ -788,9 +787,6 @@ def _setup_message_area(self):
 
     def add_toolitem(self, name, group, position, image_file, description,
                      toggle):
-        if group is None:
-            return
-
         if toggle:
             tbutton = Gtk.ToggleToolButton()
         else:
@@ -809,29 +805,29 @@ def add_toolitem(self, name, group, position, image_file, description,
         signal = tbutton.connect('clicked', self._call_tool, name)
         tbutton.set_tooltip_text(description)
         tbutton.show_all()
-        self._toolitems[name] = tbutton
-        self._signals[name] = signal
+        self._toolitems.setdefault(name, [])
+        self._toolitems[name].append((tbutton, signal))
 
     def _call_tool(self, btn, name):
         self.trigger_tool(name)
 
     def set_message(self, s):
         self.message.set_label(s)
 
-    def toggle_toolitem(self, name):
+    def toggle_toolitem(self, name, toggled):
         if name not in self._toolitems:
             return
-
-        status = self._toolitems[name].get_active()
-        self._toolitems[name].handler_block(self._signals[name])
-        self._toolitems[name].set_active(not status)
-        self._toolitems[name].handler_unblock(self._signals[name])
+        for toolitem, signal in self._toolitems[name]:
+            toolitem.handler_block(signal)
+            toolitem.set_active(toggled)
+            toolitem.handler_unblock(signal)
 
     def remove_toolitem(self, name):
         if name not in self._toolitems:
             self.set_message('%s Not in toolbar' % name)
             return
-        self._toolbar.remove(self._toolitems[name])
+        for toolitem, signal in self._toolitems[name]:
+            self._toolbar.remove(toolitem)
         del self._toolitems[name]
 
     def add_separator(self, pos=-1):