Merge lp:~mk-fraggod/screenkey/screenkey into lp:screenkey

[Mike Kazantsev]

Use RGBA palette and cairo to create semi-transparent (0.7) background if compositing for the screen is enabled, as per bug #1159855.

[Pablo SEMINARIO (pabluk)]

Good work, thanks Mike

review: Approve

[lp:~mk-fraggod/screenkey/screenkey]

53. By Mike Kazantsev on 2013-05-05

Make opacity value configurable in preferences dialog

54. By Mike Kazantsev on 2013-05-05

Cleanup of leftover debug logging line, simplier options init

Unmerged revisions

54. By Mike Kazantsev on 2013-05-05

Cleanup of leftover debug logging line, simplier options init

53. By Mike Kazantsev on 2013-05-05

Make opacity value configurable in preferences dialog

52. By Mike Kazantsev on 2013-05-04

Add support for transparency under compositing window managers.

For non-compositing wm's, XShape can be used, but not implemented here.

=== modified file 'Screenkey/screenkey.py'
--- Screenkey/screenkey.py	2012-02-14 20:16:23 +0000
+++ Screenkey/screenkey.py	2013-05-05 12:09:26 +0000
@@ -18,6 +18,7 @@
 import gtk
 import gobject
 import glib
+import cairo
 import pango
 import pickle
 from threading import Timer
@@ -62,14 +63,18 @@
         self.timer = None
         self.logger = logger
 
+        default_options = {
+            'timeout': 2.5,
+            'position': POS_BOTTOM,
+            'size': SIZE_MEDIUM,
+            'opacity': 0.7,
+            'mode': MODE_NORMAL,
+            }
+
         self.options = self.load_state()
-        if not self.options:
-            self.options = {
-                'timeout': 2.5,
-                'position': POS_BOTTOM,
-                'size': SIZE_MEDIUM,
-                'mode': MODE_NORMAL,
-                }
+        for key, value in default_options.items():
+            if key not in self.options:
+                self.options[key] = value
 
         if not nodetach:
             self.logger.debug("Detach from the parent.")
@@ -83,9 +88,9 @@
         self.set_property('accept-focus', False)
         self.set_property('focus-on-map', False)
         self.set_position(gtk.WIN_POS_CENTER)
-        bgcolor = gtk.gdk.color_parse("black")
-        self.modify_bg(gtk.STATE_NORMAL, bgcolor)
-        self.set_opacity(0.7)
+
+        self.bgcolor = gtk.gdk.color_parse("black")
+        self.modify_bg(gtk.STATE_NORMAL, self.bgcolor)
 
         gobject.signal_new("text-changed", gtk.Label, 
                         gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE, ())
@@ -96,6 +101,15 @@
         self.label.show()
         self.add(self.label)
 
+        self.compositing = self.is_composited()
+        if self.compositing:
+            # Use cairo and rgba palette
+            self.set_app_paintable(True)
+            self.connect("screen_changed", self.on_screen_changed)
+            self.connect("expose_event", self.on_expose)
+            self.set_screen_colormap()
+            # XShape extension can be used otherwise, not implemented yet
+
         self.screen_width = gtk.gdk.screen_width()   
         self.screen_height = gtk.gdk.screen_height() 
         self.set_window_size(self.options['size'])
@@ -159,13 +173,14 @@
 
         self.connect("delete-event", self.quit)
 
+
     def quit(self, widget, data=None):
         self.listenkbd.stop()
         gtk.main_quit()
 
     def load_state(self):
         """Load stored options"""
-        options = None
+        options = {}
         try:
             f = open(self.STATE_FILE, 'r')
             try:
@@ -190,6 +205,29 @@
         except IOError:
             self.logger.debug("Cannot open %s." % self.STATE_FILE)
 
+    def set_screen_colormap(self):
+        screen = self.get_screen()
+        rgba = screen.get_rgba_colormap()
+        if rgba is None:
+            self.set_colormap(screen.get_rgb_colormap())
+            self.compositing = False
+        else:
+            self.set_colormap(rgba)
+            self.compositing = True
+
+    def set_opacity(self, setting, region=None):
+        ctx = self.window.cairo_create()
+        if region:
+            ctx.region(region)
+        else:
+            ctx.paint()
+        ctx.set_operator(cairo.OPERATOR_SOURCE)
+        ctx.set_source_rgba(self.bgcolor.red_float,
+                            self.bgcolor.green_float,
+                            self.bgcolor.blue_float,
+                            setting)
+        ctx.fill()
+
     def set_window_size(self, setting):
         """Set window and label size."""
         window_width = self.screen_width
@@ -264,6 +302,16 @@
             self.logger.debug("Screenkey disabled.")
             self.listenkbd.stop()
 
+    def on_screen_changed(self, widget, from_screen):
+        # Used only with compositing
+        self.set_screen_colormap()
+
+    def on_expose(self, widget, event):
+        # Used only with compositing
+        if not self.compositing:
+            return
+        self.set_opacity(self.options['opacity'], gtk.gdk.region_rectangle(event.area))
+
     def on_preferences_dialog(self, widget, data=None):
         prefs = gtk.Dialog(APP_NAME, None, 
                     gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT, 
@@ -280,6 +328,10 @@
                 self.set_window_size(self.options['size'])
                 self.logger.debug("Window size changed.")
 
+        def on_sb_opacity_changed(widget, data=None):
+            self.options['opacity'] = widget.get_value() / 100.0
+            self.logger.debug("Opacity value changed.")
+
         def on_cbox_modes_changed(widget, data=None):
             index = widget.get_active()
             if index >= 0:
@@ -321,7 +373,7 @@
         frm_time.add(hbox_time)
         frm_time.show_all()
 
-        frm_aspect = gtk.Frame(_("<b>Aspect</b>"))
+        frm_aspect = gtk.Frame(_("<b>Display</b>"))
         frm_aspect.set_border_width(4)
         frm_aspect.get_label_widget().set_use_markup(True)
         frm_aspect.set_shadow_type(gtk.SHADOW_NONE)
@@ -357,8 +409,29 @@
         hbox2_aspect.pack_start(cbox_sizes, expand=False, 
                                 fill=False, padding=4)
 
+        hbox3_aspect = gtk.HBox()
+
+        lbl_opacity1 = gtk.Label(_("Opacity"))
+        lbl_opacity2 = gtk.Label(_("%"))
+
+        sb_opacity = gtk.SpinButton(digits=1)
+        sb_opacity.set_increments(10, 25)
+        sb_opacity.set_range(0, 100)
+        sb_opacity.set_numeric(True)
+        sb_opacity.set_update_policy(gtk.UPDATE_IF_VALID)
+        sb_opacity.set_value(self.options['opacity'] * 100)
+        sb_opacity.connect("value-changed", on_sb_opacity_changed)
+
+        hbox3_aspect.pack_start(lbl_opacity1, expand=False,
+                                fill=False, padding=6)
+        hbox3_aspect.pack_start(sb_opacity, expand=False,
+                                fill=False, padding=4)
+        hbox3_aspect.pack_start(lbl_opacity2, expand=False,
+                                fill=False, padding=4)
+
         vbox_aspect.pack_start(hbox1_aspect)
         vbox_aspect.pack_start(hbox2_aspect)
+        vbox_aspect.pack_start(hbox3_aspect)
         frm_aspect.add(vbox_aspect)
 
         frm_kbd = gtk.Frame(_("<b>Keys</b>"))