Add an option to draw an image on the window

Author: Vulcalien

terminatorlib/config.py

@@ -99,6 +99,8 @@
             'always_on_top'         : False,
             'hide_on_lose_focus'    : False,
             'sticky'                : False,
+            'window_background_type' : 'transparent',
+            'window_background_image' : '',
             'use_custom_url_handler': False,
             'custom_url_handler'    : '',
             'disable_real_transparency' : False,
@@ -565,7 +567,7 @@ def defaults_to_configspec(self):
 
             keytype = '%s(default=%s)' % (keytype, value)
 
-            if key == 'custom_url_handler':
+            if key in ('custom_url_handler', 'window_background_image'):
                 keytype = 'string(default="")'
 
             section[key] = keytype

terminatorlib/terminal.py

@@ -191,11 +191,9 @@ def set_background_image(self,image):
         try: 
             bg_pixbuf = GdkPixbuf.Pixbuf.new_from_file(image)
             self.background_image = Gdk.cairo_surface_create_from_pixbuf(bg_pixbuf, 1, None)
-            self.vte.set_clear_background(False)
             self.vte.connect("draw", self.background_draw)
         except Exception as e:
             self.background_image = None
-            self.vte.set_clear_background(True)
             err('error loading background image: %s, %s' % (type(e).__name__,e))
 
     def get_vte(self):
@@ -720,6 +718,8 @@ def reconfigure(self, _widget=None):
             self.bgcolor = Gdk.RGBA()
             self.bgcolor.parse(self.config['background_color'])
 
+        self.vte.set_clear_background(False)
+
         if self.config['background_type'] in ('transparent', 'image'):
             self.bgcolor.alpha = self.config['background_darkness']
         else:

terminatorlib/window.py

@@ -6,7 +6,7 @@
 import time
 import uuid
 import gi
-from gi.repository import GObject
+from gi.repository import GObject, GdkPixbuf, cairo
 from gi.repository import Gtk, Gdk
 
 from .util import dbg, err, make_uuid, display_manager
@@ -155,6 +155,8 @@ def apply_config(self):
         skiptaskbar = self.config['hide_from_taskbar']
         alwaysontop = self.config['always_on_top']
         sticky = self.config['sticky']
+        background_type = self.config['window_background_type']
+        background_image_path = self.config['window_background_image']
 
         if options:
             if options.maximise:
@@ -178,6 +180,11 @@ def apply_config(self):
         else:
             self.set_iconified(hidden)
 
+        if background_type == 'image' and background_image_path != '':
+            self.set_background_image(background_image_path)
+        else:
+            self.background_image = None
+
     def apply_icon(self, requested_icon):
         """Set the window icon"""
         icon_theme = Gtk.IconTheme.get_default()
@@ -392,6 +399,16 @@ def set_real_transparency(self, value=True):
             visual = screen.get_rgba_visual()
             if visual:
                 self.set_visual(visual)
+
+    def set_background_image(self, image):
+        try:
+            bg_pixbuf = GdkPixbuf.Pixbuf.new_from_file(image)
+            self.background_image = Gdk.cairo_surface_create_from_pixbuf(bg_pixbuf, 1, None)
+            self.connect("draw", self.background_draw)
+        except Exception as e:
+            self.background_image = None
+            err('error loading background image: %s, %s' % (type(e).__name__,e))
+
 
     def show(self, startup=False):
         """Undo the startup show request if started in hidden mode"""
@@ -968,6 +985,24 @@ def create_layout(self, layout):
         if 'last_active_window' in layout and layout['last_active_window'] == 'True':
             self.terminator.last_active_window = self.uuid
 
+
+    def background_draw(self, window, cr):
+        if self.background_image is None:
+            return False
+
+        # save cairo context
+        cr.save()
+        # draw background image
+        rect = window.get_allocation()
+        xratio = float(rect.width) / float(self.background_image.get_width())
+        yratio = float(rect.height) / float(self.background_image.get_height())
+        cr.scale(xratio, yratio)
+        cr.set_source_surface(self.background_image)
+        cr.get_source().set_filter(cairo.Filter.FAST)
+        cr.paint()
+        # restore cairo context
+        cr.restore()
+
 class WindowTitle(object):
     """Class to handle the setting of the window title"""