Add ExpandableBase

matplotlib · OceanWolf · Feb 21, 2015 · Feb 22, 2015 · Feb 25, 2015 · Feb 26, 2015
commit ee76451e457f3d35b9d4d060e460837d4abdbb0e
diff --git a/examples/user_interfaces/gui_elements.py b/examples/user_interfaces/gui_elements.py
@@ -22,7 +22,7 @@
 topbar = manager.backend.Toolbar(tool_mgr)
 
 # Add it to the figure window, we can place it north, east, west and south
-manager.window.add_element(topbar, False, 'north')
+manager.window.add_element(topbar, 'north')
 
 # Remove some tools from the main toolbar and add them to the
 # new sidebar
@@ -39,7 +39,7 @@
 sidebar = manager.backend.Toolbar(tool_mgr)
 
 # add the sidebar to the new window
-win.add_element(sidebar, False, 'west')
+win.add_element(sidebar, 'west')
 
 # Add some tools to the new sidebar
 for tool in ('home', 'back', 'forward', 'zoom', 'pan'):

diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1656,7 +1656,61 @@ def __init__(self, name, canvas, key, x=0, y=0, guiEvent=None):
         self.key = key
 
 
-class FigureCanvasBase(object):
+class ExpandableBase(object):
+    """
+    Base class for GUI elements that can expand to fill the area given to them
+    by the encapsulating container (e.g. the main window).
+
+    At the moment this class does not do anything apart from mark such classes,
+    but this may well change at a later date, PRs welcome.
+    """
+    pass
+
+class FlowBase(object):
+    """
+    Base mixin class for all GUI elements that can flow, aka laid out in
+    different directions.
+
+    The MPL window class deals with the manipulation of this mixin, so users
+    don't actually need to interact with this class.
+
+    Classes the implement this class must override the _update_flow method.
+    """
+    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):
+        """
+        The direction of flow, one of the strings in `flow_type`.
+        """
+        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):
+        """
+        Classes that extend FlowBase must override this method.
+        You can use the internal property self._flow whereby
+        flow_types[self._flow] gives the current flow.
+        """
+        raise NotImplementedError
+
+class FigureCanvasBase(ExpandableBase):
     """
     The canvas the figure renders into.
 
@@ -2717,7 +2771,7 @@ def set_window_title(self, title):
         """
         pass
 
-    def add_element(self, element, expand, place):
+    def add_element(self, element, place):
         """ Adds a gui widget to the window.
         This has no effect for non-GUI backends and properties only apply
         to those backends that support them, or have a suitable workaround.
@@ -2726,9 +2780,6 @@ def add_element(self, element, expand, place):
         ----------
         element : A gui element.
             The element to add to the window
-        expand : bool
-            Whether the element should auto expand to fill as much space within
-            the window as possible.
         place : string
             The location to place the element, either compass points north,
             east, south, west, or center.
@@ -3479,51 +3530,6 @@ def remove_toolitem(self, name):
         raise NotImplementedError
 
 
-class FlowBase(object):
-    """
-    Base mixin class for all GUI elements that can flow, aka laid out in
-    different directions.
-
-    The MPL window class deals with the manipulation of this mixin, so users
-    don't actually need to interact with this class.
-
-    Classes the implement this class must override the _update_flow method.
-    """
-    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):
-        """
-        The direction of flow, one of the strings in `flow_type`.
-        """
-        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):
-        """
-        Classes that extend FlowBase must override this method.
-        You can use the internal property self._flow whereby
-        flow_types[self._flow] gives the current flow.
-        """
-        raise NotImplementedError
-
-
 class ToolbarBase(ToolContainerBase, FlowBase):
     pass
 

diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -87,7 +87,7 @@ def __init__(self, figure, num, **kwargs):
         w = int(self.figure.bbox.width)
         h = int(self.figure.bbox.height)
 
-        self.window.add_element(self.figure.canvas, True, 'center')
+        self.window.add_element(self.figure.canvas, 'center')
 
         self.toolmanager = ToolManager(self.figure)
         self.toolbar = self._get_toolbar()
@@ -96,10 +96,10 @@ def __init__(self, figure, num, **kwargs):
         if self.toolbar:
             tools.add_tools_to_container(self.toolbar)
             self.statusbar = self._backend.Statusbar(self.toolmanager)
-            h += self.window.add_element(self.statusbar, False, 'south')
+            h += self.window.add_element(self.statusbar, 'south')
 
         if self.toolbar is not None:
-            h += self.window.add_element(self.toolbar, False, 'south')
+            h += self.window.add_element(self.toolbar, 'south')
 
         self.window.set_default_size(w, h)
         self._full_screen_flag = False

diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -30,7 +30,7 @@ def fn_name(): return sys._getframe(1).f_code.co_name
 from matplotlib._pylab_helpers import Gcf
 from matplotlib.backend_bases import (RendererBase, GraphicsContextBase,
      FigureManagerBase, FigureCanvasBase, NavigationToolbar2, cursors,
-     TimerBase, WindowBase, MainLoopBase)
+     TimerBase, WindowBase, MainLoopBase, ExpandableBase)
 from matplotlib.backend_bases import ShowBase, ToolbarBase, StatusbarBase
 from matplotlib.backend_managers import ToolManager
 from matplotlib import backend_tools
@@ -426,7 +426,7 @@ def _setup_box(self, name, orientation, grow, parent):
             self._layout[parent].pack_start(self._layout[name], grow, grow, 0)
         self._layout[name].show()
 
-    def add_element(self, element, expand, place):
+    def add_element(self, element, place):
         element.show()
 
         # Get the flow of the element (the opposite of the container)
@@ -440,6 +440,9 @@ def add_element(self, element, expand, place):
         except AttributeError:
             pass
 
+        # Determine if this element should fill all the space given to it
+        expand = isinstance(element, ExpandableBase)
+
         if place in ['north', 'west', 'center']:
             self._layout[place].pack_start(element, expand, expand, 0)
             self._layout[place].pack_start(separator, False, False, 0)