dynamically finding the backend preferred format for button images

fariza · fariza · commit ad63b35ea756 · 2017-11-18T17:40:50.000-05:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3266,14 +3266,29 @@ 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.btn_image_extension(),
+            os.path.join(basedir, image) + self.btn_image_extension()]
+
+        for fname in possible_images:
+            if os.path.isfile(fname):
+                return fname
+
+    def btn_image_extension(self):
+        """
+        Get the preferred image extension
+
+        Return
+        ======
+        str: Image extension
+        """
+        raise NotImplementedError
+
 
     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
@@ -786,6 +786,9 @@ def _add_separator(self):
         self._toolarea.pack_start(sep, False, True, 0)
         sep.show_all()
 
+    def btn_image_extension(self):
+        return '.png'
+
 
 class StatusbarGTK3(StatusbarBase, Gtk.Statusbar):
     def __init__(self, *args, **kwargs):
diff --git a/lib/matplotlib/backends/backend_tkagg.py b/lib/matplotlib/backends/backend_tkagg.py
@@ -935,6 +935,9 @@ def remove_toolitem(self, name):
             toolitem.pack_forget()
         del self._toolitems[name]
 
+    def btn_image_extension(self):
+        return '.gif'
+
 
 class StatusbarTk(StatusbarBase, Tk.Frame):
     def __init__(self, window, *args, **kwargs):
