Merge pull request #9811 from fariza/button-prefered-extension

dstansby · web-flow · commit ba4142a91203 · 2017-11-25T12:05:58.000Z
dynamically finding the backend preferred format for button images
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3218,6 +3218,13 @@ class ToolContainerBase(object):
         The tools with which this `ToolContainer` wants to communicate.
     """
 
+    _icon_extension = '.png'
+    """
+    Toolcontainer button icon image format extension
+
+    **String**: Image extension
+    """
+
     def __init__(self, toolmanager):
         self.toolmanager = toolmanager
         self.toolmanager.toolmanager_connect('tool_removed_event',
@@ -3262,14 +3269,19 @@ def _remove_tool_cbk(self, event):
 
     def _get_image_filename(self, image):
         """Find the image based on its name."""
-        # TODO: better search for images, they are not always in the
-        # datapath
+        if not image:
+            return None
+
         basedir = os.path.join(rcParams['datapath'], 'images')
-        if image is not None:
-            fname = os.path.join(basedir, image)
-        else:
-            fname = None
-        return fname
+        possible_images = (
+            image,
+            image + self._icon_extension,
+            os.path.join(basedir, image),
+            os.path.join(basedir, image) + self._icon_extension)
+
+        for fname in possible_images:
+            if os.path.isfile(fname):
+                return fname
 
     def trigger_tool(self, name):
         """
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -724,7 +724,7 @@ class ToolHome(ViewsPositionsBase):
     """Restore the original view lim"""
 
     description = 'Reset original view'
-    image = 'home.png'
+    image = 'home'
     default_keymap = rcParams['keymap.home']
     _on_trigger = 'home'
 
@@ -733,7 +733,7 @@ class ToolBack(ViewsPositionsBase):
     """Move back up the view lim stack"""
 
     description = 'Back to previous view'
-    image = 'back.png'
+    image = 'back'
     default_keymap = rcParams['keymap.back']
     _on_trigger = 'back'
 
@@ -742,7 +742,7 @@ class ToolForward(ViewsPositionsBase):
     """Move forward in the view lim stack"""
 
     description = 'Forward to next view'
-    image = 'forward.png'
+    image = 'forward'
     default_keymap = rcParams['keymap.forward']
     _on_trigger = 'forward'
 
@@ -751,14 +751,14 @@ class ConfigureSubplotsBase(ToolBase):
     """Base tool for the configuration of subplots"""
 
     description = 'Configure subplots'
-    image = 'subplots.png'
+    image = 'subplots'
 
 
 class SaveFigureBase(ToolBase):
     """Base tool for figure saving"""
 
     description = 'Save the figure'
-    image = 'filesave.png'
+    image = 'filesave'
     default_keymap = rcParams['keymap.save']
 
 
@@ -830,7 +830,7 @@ class ToolZoom(ZoomPanBase):
     """Zoom to rectangle"""
 
     description = 'Zoom to rectangle'
-    image = 'zoom_to_rect.png'
+    image = 'zoom_to_rect'
     default_keymap = rcParams['keymap.zoom']
     cursor = cursors.SELECT_REGION
     radio_group = 'default'
@@ -957,7 +957,7 @@ class ToolPan(ZoomPanBase):
 
     default_keymap = rcParams['keymap.pan']
     description = 'Pan axes with left mouse, zoom with right'
-    image = 'move.png'
+    image = 'move'
     cursor = cursors.MOVE
     radio_group = 'default'
 
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -716,6 +716,7 @@ def draw_rubberband(self, x0, y0, x1, y1):
 
 
 class ToolbarGTK3(ToolContainerBase, Gtk.Box):
+    _icon_extension = '.png'
     def __init__(self, toolmanager):
         ToolContainerBase.__init__(self, toolmanager)
         Gtk.Box.__init__(self)
diff --git a/lib/matplotlib/backends/backend_tkagg.py b/lib/matplotlib/backends/backend_tkagg.py
@@ -868,6 +868,7 @@ def set_cursor(self, cursor):
 
 
 class ToolbarTk(ToolContainerBase, Tk.Frame):
+    _icon_extension = '.gif'
     def __init__(self, toolmanager, window):
         ToolContainerBase.__init__(self, toolmanager)
         xmin, xmax = self.toolmanager.canvas.figure.bbox.intervalx
