Improve flow handling and make it a lot more generic

OceanWolf · OceanWolf · commit 8e6e25245eb0 · 2016-08-04T01:37:31.000+02:00
diff --git a/examples/user_interfaces/gui_elements.py b/examples/user_interfaces/gui_elements.py
@@ -20,7 +20,8 @@
 
 # Create a new toolbar
 topbar = manager.backend.Toolbar(tool_mgr)
-# The options are north, east, west and south
+
+# Add it to the figure window, we can place it north, east, west and south
 manager.window.add_element(topbar, False, 'north')
 
 # Remove some tools from the main toolbar and add them to the
@@ -33,17 +34,17 @@
 
 # Add a new window
 win = manager.backend.Window('Extra tools')
+
 # create a sidebar for the new window
 sidebar = manager.backend.Toolbar(tool_mgr)
-# set the direction of the sidebar
-# the options are horizontal and vertical
-sidebar.set_flow('vertical')
+
 # add the sidebar to the new window
 win.add_element(sidebar, False, 'west')
 
 # Add some tools to the new sidebar
 for tool in ('home', 'back', 'forward', 'zoom', 'pan'):
     sidebar.add_tool(tool, None)
+
 # show the new window
 win.show()
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3479,6 +3479,38 @@ def remove_toolitem(self, name):
         raise NotImplementedError
 
 
+class FlowBase(object):
+    flow_types = ['horizontal', 'vertical']
+
+    def __init__(self, flow='horizontal', flow_locked=False, **kwargs):
+        super(FlowBase, self).__init__(**kwargs)
+        self.flow_locked = flow_locked
+        self.flow = flow
+
+    @property
+    def flow(self):
+        return FlowBase.flow_types[self._flow]
+
+    @flow.setter
+    def flow(self, flow):
+        if self.flow_locked:
+            return
+
+        try:
+            self._flow = FlowBase.flow_types.index(flow)
+        except ValueError:
+            raise ValueError('Flow (%s), not in list  %s' % (flow, FlowBase.flow_types))
+
+        self._update_flow()
+
+    def _update_flow(self):
+        raise NotImplementedError
+
+
+class ToolbarBase(ToolContainerBase, FlowBase):
+    pass
+
+
 class StatusbarBase(object):
     """Base class for the statusbar"""
     def __init__(self, toolmanager, **kwargs):
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -31,8 +31,7 @@ def fn_name(): return sys._getframe(1).f_code.co_name
 from matplotlib.backend_bases import (RendererBase, GraphicsContextBase,
      FigureManagerBase, FigureCanvasBase, NavigationToolbar2, cursors,
      TimerBase, WindowBase, MainLoopBase)
-from matplotlib.backend_bases import (ShowBase, ToolContainerBase,
-                                      StatusbarBase)
+from matplotlib.backend_bases import ShowBase, ToolbarBase, StatusbarBase
 from matplotlib.backend_managers import ToolManager
 from matplotlib import backend_tools
 
@@ -387,7 +386,6 @@ def stop_event_loop(self):
 
 
 _flow = [Gtk.Orientation.HORIZONTAL, Gtk.Orientation.VERTICAL]
-flow_types = ['horizontal', 'vertical']
 
 
 class WindowGTK3(WindowBase, Gtk.Window):
@@ -431,9 +429,17 @@ def _setup_box(self, name, orientation, grow, parent):
     def add_element(self, element, expand, place):
         element.show()
 
-        flow = _flow[not _flow.index(self._layout[place].get_orientation())]
+        # Get the flow of the element (the opposite of the container)
+        flow_index = not _flow.index(self._layout[place].get_orientation())
+        flow = _flow[flow_index]
         separator = Gtk.Separator(orientation=flow)
         separator.show()
+
+        try:
+            element.flow = element.flow_types[flow_index]
+        except AttributeError:
+            pass
+
         if place in ['north', 'west', 'center']:
             self._layout[place].pack_start(element, expand, expand, 0)
             self._layout[place].pack_start(separator, False, False, 0)
@@ -827,11 +833,10 @@ def draw_rubberband(self, x0, y0, x1, y1):
         self.ctx.stroke()
 
 
-class ToolbarGTK3(ToolContainerBase, Gtk.Box):
-    def __init__(self, toolmanager, flow='horizontal', **kwargs):
-        super(ToolbarGTK3, self).__init__(toolmanager=toolmanager, **kwargs)
+class ToolbarGTK3(ToolbarBase, Gtk.Box):
+    def __init__(self, toolmanager, **kwargs):
         self._toolarea = Gtk.Box()
-        self.set_flow(flow)
+        super(ToolbarGTK3, self).__init__(toolmanager=toolmanager, **kwargs)
 
         self.pack_start(self._toolarea, False, False, 0)
         self._toolarea.show_all()
@@ -894,11 +899,7 @@ def remove_toolitem(self, name):
                     self._groups[group].remove(toolitem)
         del self._toolitems[name]
 
-    def set_flow(self, flow):
-        try:
-            self._flow = flow_types.index(flow)
-        except ValueError:
-            raise ValueError('Flow (%s), not in list  %s' % (flow, flow_types))
+    def _update_flow(self):
         self.set_property("orientation", _flow[not self._flow])
         self._toolarea.set_property('orientation', _flow[self._flow])
         for item in self._toolarea:
