matplotlib · tacaswell · Feb 21, 2015 · Feb 22, 2015 · Feb 25, 2015 · Feb 26, 2015
diff --git a/.travis.yml b/.travis.yml
@@ -47,6 +47,7 @@ env:
     - PYTEST_ARGS="-rawR --maxfail=1 --timeout=300 --durations=25 --cov-report= --cov=lib -n $NPROC"
     - PYTHON_ARGS=
     - DELETE_FONT_CACHE=
+    - USENEWTOOLMANAGER=false
 
 matrix:
   include:
@@ -59,7 +60,7 @@ matrix:
     - python: 3.5
       env: BUILD_DOCS=true
     - python: 3.6
-      env: DELETE_FONT_CACHE=1 INSTALL_PEP8=pytest-pep8 RUN_PEP8=--pep8 PANDAS=pandas
+      env: DELETE_FONT_CACHE=1 INSTALL_PEP8=pytest-pep8 RUN_PEP8=--pep8 PANDAS=pandas USENEWTOOLMANAGER=true
     - python: "nightly"
       env: PRE=--pre
     - os: osx
@@ -181,6 +182,9 @@ before_script:
       export DISPLAY=:99.0
       sh -e /etc/init.d/xvfb start
     fi
+    if [[ $USENEWTOOLMANAGER == true ]]; then
+      cp .travis/toolmgr_matplotlibrc matplotlibrc
+    fi
 
 script: ci/travis/test_script.sh
 

diff --git a/.travis/toolmgr_matplotlibrc b/.travis/toolmgr_matplotlibrc
@@ -0,0 +1 @@
+toolbar : toolmanager
diff --git a/doc/devel/MEP/MEP27.rst b/doc/devel/MEP/MEP27.rst
@@ -8,14 +8,16 @@
 
 Status
 ======
-**Discussion**
+**Progress**
 
 Branches and Pull requests
 ==========================
 Main PR (including GTK3):
+
 + https://github.com/matplotlib/matplotlib/pull/4143
 
 Backend specific branch diffs:
+
 + https://github.com/OceanWolf/matplotlib/compare/backend-refactor...OceanWolf:backend-refactor-tkagg
 + https://github.com/OceanWolf/matplotlib/compare/backend-refactor...OceanWolf:backend-refactor-qt
 + https://github.com/OceanWolf/matplotlib/compare/backend-refactor...backend-refactor-wx
@@ -79,15 +81,12 @@ The description of this MEP gives us most of the solution:
 1. To remove the windowing aspect out of ``FigureManagerBase`` letting
    it simply wrap this new class along with the other backend classes.
    Create a new ``WindowBase`` class that can handle this
-   functionality, with pass-through methods (:arrow_right:) to
+   functionality, with pass-through methods (->) to
    ``WindowBase``.  Classes that subclass ``WindowBase`` should also
    subclass the GUI specific window class to ensure backward
    compatibility (``manager.window == manager.window``).
 2. Refactor the mainloop of ``ShowBase`` into ``MainLoopBase``, which
-   encapsulates the end of the loop as well.  We give an instance of
-   ``MainLoop`` to ``FigureManager`` as a key unlock the exit method
-   (requiring all keys returned before the loop can die).  Note this
-   opens the possibility for multiple backends to run concurrently.
+   encapsulates the end of the loop as well.
 3. Now that ``FigureManagerBase`` has no backend specifics in it, to
    rename it to ``FigureManager``, and move to a new file
    ``backend_managers.py`` noting that:
@@ -103,30 +102,30 @@ The description of this MEP gives us most of the solution:
 |FigureManagerBase(canvas, num)        |FigureManager(figure, num)    |``WindowBase(title)``|Notes                           |
 |                                      |                              |                     |                                |
 +======================================+==============================+=====================+================================+
-|show                                  |                              |show                 |                                |
+|show                                  |->                            |show                 |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
 |destroy                               |calls destroy on all          |destroy              |                                |
 |                                      |components                    |                     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
 |full_screen_toggle                    |handles logic                 |set_fullscreen       |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|resize                                |                              |resize               |                                |
+|resize                                |->                            |resize               |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|key_press                             |key_press                     |                     |                                |
+|key_press                             |key_press                     |X                    |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|show_popup                            |show_poup                     |                     |Not used anywhere in mpl, and   |
+|show_popup                            |X                             |X                    |Not used anywhere in mpl, and   |
 |                                      |                              |                     |does nothing.                   |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|get_window_title                      |                              |get_window_title     |                                |
+|get_window_title                      |->                            |get_window_title     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|set_window_title                      |                              |set_window_title     |                                |
+|set_window_title                      |->                            |set_window_title     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|                                      |_get_toolbar                  |                     |A common method to all          |
+|X                                     |_get_toolbar                  |X                    |A common method to all          |
 |                                      |                              |                     |subclasses of FigureManagerBase |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|                                      |                              |set_default_size     |                                |
+|X                                     |X                             |set_default_size     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|                                      |                              |add_element_to_window|                                |
+|X                                     |X                             |add_element          |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
 
 
@@ -135,14 +134,14 @@ The description of this MEP gives us most of the solution:
 +==========+============+=============+
 |mainloop  |begin       |             |
 +----------+------------+-------------+
-|          |end         |Gets called  |
+|X         |end         |Gets called  |
 |          |            |automagically|
 |          |            |when no more |
 |          |            |instances of |
 |          |            |the subclass |
 |          |            |exist        |
 +----------+------------+-------------+
-|__call__  |            |Method moved |
+|__call__  |X           |Method moved |
 |          |            |to           |
 |          |            |Gcf.show_all |
 +----------+------------+-------------+
@@ -191,6 +190,8 @@ in the same manner as everything else.
 |                         |                         |window, so this also     |
 |                         |                         |breaks BC.               |
 +-------------------------+-------------------------+-------------------------+
+|WebAgg                   |canvas                   |                         |
++-------------------------+-------------------------+-------------------------+
 
 
 Alternatives

diff --git a/examples/user_interfaces/gui_elements.py b/examples/user_interfaces/gui_elements.py
@@ -0,0 +1,51 @@
+'''This example demonstrates how to:
+* Create new toolbars
+* Create new windows
+Using `matplotlib.backend_managers.ToolManager`,
+`matplotlib.backend_bases.WindowBase` and
+`matplotlib.backend_bases.ToolContainerBase`
+'''
+
+from __future__ import print_function
+import matplotlib
+matplotlib.use('GTK3Cairo')
+matplotlib.rcParams['toolbar'] = 'toolmanager'
+import matplotlib.pyplot as plt
+
+fig = plt.figure()
+
+# Shortcuts to FigureManager and ToolManager
+manager = fig.canvas.manager
+tool_mgr = manager.toolmanager
+
+# Create a new toolbar
+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, 'north')
+
+# Remove some tools from the main toolbar and add them to the
+# new sidebar
+for tool in ('home', 'back', 'forward'):
+    manager.toolbar.remove_toolitem(tool)
+    topbar.add_tool(tool, None)
+
+plt.plot([1, 2, 3])
+
+# Add a new window
+win = manager.backend.Window('Extra tools')
+
+# create a sidebar for the new window
+sidebar = manager.backend.Toolbar(tool_mgr)
+
+# add the sidebar to the new window
+win.add_element(sidebar, '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()
+
+plt.show()
diff --git a/examples/user_interfaces/toolmanager_sgskip.py b/examples/user_interfaces/toolmanager_sgskip.py
@@ -81,7 +81,7 @@ def set_lines_visibility(self, state):
 
 # Add the custom tools that we created
 fig.canvas.manager.toolmanager.add_tool('List', ListTools)
-fig.canvas.manager.toolmanager.add_tool('Show', GroupHideTool, gid='mygroup')
+fig.canvas.manager.toolmanager.add_tool('Hide', GroupHideTool, gid='mygroup')
 
 
 # Add an existing tool to new group `foo`.
@@ -93,6 +93,6 @@ def set_lines_visibility(self, state):
 
 # To add a custom tool to the toolbar at specific location inside
 # the navigation group
-fig.canvas.manager.toolbar.add_tool('Show', 'navigation', 1)
+fig.canvas.manager.toolbar.add_tool('Hide', 'navigation', 1)
 
 plt.show()
diff --git a/lib/matplotlib/_pylab_helpers.py b/lib/matplotlib/_pylab_helpers.py
@@ -9,6 +9,8 @@
 import gc
 import atexit
 
+from matplotlib import is_interactive
+
 
 def error_msg(msg):
     print(msg, file=sys.stderr)
@@ -35,6 +37,16 @@ class Gcf(object):
     _activeQue = []
     figs = {}
 
+    @classmethod
+    def add_figure_manager(cls, manager):
+        cls.figs[manager.num] = manager
+        try:  # TODO remove once all backends converted to use the new manager.
+            manager.mpl_connect('window_destroy_event', cls.destroy_cbk)
+        except:
+            pass
+
+        cls.set_active(manager)
+
     @classmethod
     def get_fig_manager(cls, num):
         """
@@ -46,6 +58,46 @@ def get_fig_manager(cls, num):
             cls.set_active(manager)
         return manager
 
+    @classmethod
+    def show_all(cls, block=None):
+        """
+        Show all figures.  If *block* is not None, then
+        it is a boolean that overrides all other factors
+        determining whether show blocks by calling mainloop().
+        The other factors are:
+        it does not block if run inside ipython's "%pylab" mode
+        it does not block in interactive mode.
+        """
+
+        managers = cls.get_all_fig_managers()
+        if not managers:
+            return
+
+        # treat the first manager as proto-typical of all
+        m0 = managers[0]
+
+        if block is None:
+            # webagg always needs to block because tornado is
+            # not integrated into the REPL
+            block = (not is_interactive()) or m0.backend_name == 'webagg'
+
+        for manager in managers:
+            manager.show()
+
+        if block:
+            ml = m0.backend.MainLoop()
+            counter = {'open_windows': len(managers)}
+
+            def on_window_close(ev):
+                counter['open_windows'] -= 1
+                if counter['open_windows'] < 1:
+                    ml.end()
+
+            for manager in managers:
+                manager.mpl_connect('window_destroy_event', on_window_close)
+
+            ml.begin()
+
     @classmethod
     def destroy(cls, num):
         """
@@ -68,7 +120,7 @@ def destroy(cls, num):
                 cls._activeQue.append(f)
 
         del cls.figs[num]
-        manager.destroy()
+        manager.destroy()  # Unneeded with MEP27 remove later
         gc.collect(1)
 
     @classmethod
@@ -137,7 +189,6 @@ def set_active(cls, manager):
             if m != manager:
                 cls._activeQue.append(m)
         cls._activeQue.append(manager)
-        cls.figs[manager.num] = manager
 
     @classmethod
     def draw_all(cls, force=False):
@@ -149,4 +200,8 @@ def draw_all(cls, force=False):
             if force or f_mgr.canvas.figure.stale:
                 f_mgr.canvas.draw_idle()
 
+    @classmethod
+    def destroy_cbk(cls, event):
+        cls.destroy(event.figure_manager.num)
+
 atexit.register(Gcf.destroy_all)