tool group position

matplotlib · WeatherGod · Apr 9, 2015 · Jan 23, 2014 · Jan 23, 2014 · Jan 24, 2014
commit e2804ea17361934a693a6ed964f96c8caaf39c64
diff --git a/examples/user_interfaces/navigation.py b/examples/user_interfaces/navigation.py
@@ -1,13 +1,21 @@
+'''This example demonstrates how the `matplotlib.backend_bases.NavigationBase`
+class allows to:
+* Modify the Toolbar
+* Add tools
+* Remove tools
+'''
+
+
+from __future__ import print_function
 import matplotlib
 matplotlib.use('GTK3Cairo')
-# matplotlib.use('TkAGG')
 matplotlib.rcParams['toolbar'] = 'navigation'
 import matplotlib.pyplot as plt
 from matplotlib.backend_tools import ToolBase
 
 
-# Create a simple tool to list all the tools
 class ListTools(ToolBase):
+    '''List all the tools controlled by `Navigation`'''
     # keyboard shortcut
     keymap = 'm'
     description = 'List Tools'
@@ -34,9 +42,9 @@ def trigger(self, *args, **kwargs):
             print("{0:12} {1:45}").format(group, active)
 
 
-# A simple example of copy canvas
 # ref: at https://github.com/matplotlib/matplotlib/issues/1987
 class CopyToolGTK3(ToolBase):
+    '''Copy canvas to clipboard'''
     keymap = 'ctrl+c'
     description = 'Copy canvas'
 
@@ -54,10 +62,16 @@ def trigger(self, *args, **kwargs):
 
 # Add the custom tools that we created
 fig.canvas.manager.navigation.add_tool('List', ListTools)
-if matplotlib.rcParams['backend'] == 'GTK3Cairo':
-    fig.canvas.manager.navigation.add_tool('copy', CopyToolGTK3)
+fig.canvas.manager.navigation.add_tool('copy', CopyToolGTK3)
+
+# Add an existing tool to new group `foo`.
+# It can be added as many times as we want
 fig.canvas.manager.toolbar.add_tool('zoom', 'foo')
-# Uncomment to remove the forward button
-# fig.canvas.manager.navigation.remove_tool('forward')
+
+# Remove the forward button
+fig.canvas.manager.navigation.remove_tool('forward')
+
+# To add a custom tool to the toolbar at specific location
+fig.canvas.manager.toolbar.add_tool('List', 'navigation', 1)
 
 plt.show()
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -771,14 +771,16 @@ def __init__(self, navigation):
         Gtk.Box.__init__(self)
         self.set_property("orientation", Gtk.Orientation.VERTICAL)
 
-        self._toolbar = Gtk.Toolbar()
-        self._toolbar.set_style(Gtk.ToolbarStyle.ICONS)
-        self.pack_start(self._toolbar, False, False, 0)
-        self._toolbar.show_all()
+        self._toolarea = Gtk.Box()
+        self._toolarea.set_property('orientation', Gtk.Orientation.HORIZONTAL)
+        self.pack_start(self._toolarea, False, False, 0)
+        self._toolarea.show_all()
+        self._groups = {}
         self._toolitems = {}
 
     def add_toolitem(self, name, group, position, image_file, description,
                      toggle):
+
         if toggle:
             tbutton = Gtk.ToggleToolButton()
         else:
@@ -792,14 +794,25 @@ def add_toolitem(self, name, group, position, image_file, description,
 
         if position is None:
             position = -1
-        # TODO implement groups positions
-        self._toolbar.insert(tbutton, -1)
+
+        self._add_button(tbutton, group, position)
         signal = tbutton.connect('clicked', self._call_tool, name)
         tbutton.set_tooltip_text(description)
         tbutton.show_all()
         self._toolitems.setdefault(name, [])
         self._toolitems[name].append((tbutton, signal))
 
+    def _add_button(self, button, group, position):
+        if group not in self._groups:
+            if self._groups:
+                self._add_separator()
+            toolbar = Gtk.Toolbar()
+            toolbar.set_style(Gtk.ToolbarStyle.ICONS)
+            self._toolarea.pack_start(toolbar, False, False, 0)
+            toolbar.show_all()
+            self._groups[group] = toolbar
+        self._groups[group].insert(button, position)
+
     def _call_tool(self, btn, name):
         self.trigger_tool(name)
 
@@ -815,15 +828,18 @@ def remove_toolitem(self, name):
         if name not in self._toolitems:
             self.navigation.message_event('%s Not in toolbar' % name, self)
             return
-        for toolitem, _signal in self._toolitems[name]:
-            self._toolbar.remove(toolitem)
+
+        for group in self._groups:
+            for toolitem, _signal in self._toolitems[name]:
+                if toolitem in self._groups[group]:
+                    self._groups[group].remove(toolitem)
         del self._toolitems[name]
 
-    def add_separator(self, pos=-1):
-        toolitem = Gtk.SeparatorToolItem()
-        self._toolbar.insert(toolitem, pos)
-        toolitem.show()
-        return toolitem
+    def _add_separator(self):
+        sep = Gtk.Separator()
+        sep.set_property("orientation", Gtk.Orientation.VERTICAL)
+        self._toolarea.pack_start(sep, False, True, 0)
+        sep.show_all()
 
 
 class StatusbarGTK3(StatusbarBase, Gtk.Statusbar):