keyboard: add an on-screen keyboard

https://bugzilla.gnome.org/show_bug.cgi?id=612662

data/org.gnome.shell.gschema.xml.in

@@ -53,6 +53,7 @@
     <child name="clock" schema="org.gnome.shell.clock"/>
     <child name="calendar" schema="org.gnome.shell.calendar"/>
     <child name="recorder" schema="org.gnome.shell.recorder"/>
+    <child name="keyboard" schema="org.gnome.shell.keyboard"/>
   </schema>
 
   <schema id="org.gnome.shell.calendar" path="/org/gnome/shell/calendar/"
@@ -66,6 +67,24 @@
       </key>
   </schema>
 
+  <schema id="org.gnome.shell.keyboard" path="/org/gnome/shell/keyboard/"
+          gettext-domain="@GETTEXT_PACKAGE@">
+    <key name="show-keyboard" type="b">
+      <default>false</default>
+      <_summary>Show the onscreen keyboard</_summary>
+      <_description>
+        If true, display onscreen keyboard.
+      </_description>
+    </key>
+    <key name="keyboard-type" type="s">
+      <default>'touch'</default>
+      <_summary>Which keyboard to use</_summary>
+      <_description>
+        The type of keyboard to use.
+      </_description>
+    </key>
+  </schema>
+
   <schema id="org.gnome.shell.clock" path="/org/gnome/shell/clock/"
           gettext-domain="@GETTEXT_PACKAGE@">
     <key name="show-seconds" type="b">

data/theme/gnome-shell.css

@@ -1849,3 +1849,58 @@ StTooltip StLabel {
 .magnifier-zoom-region.full-screen {
     border-width: 0px;
 }
+
+/* On-screen Keyboard */
+
+#keyboard {
+    background: rgba(0,0,0,0.8);
+}
+
+.keyboard-layout {
+    spacing: 10px;
+    padding: 10px;
+}
+
+.keyboard-row {
+    spacing: 15px;
+}
+
+.keyboard-key {
+    min-height: 30px;
+    min-width: 30px;
+    background-gradient-start: rgba(255,245,245,0.4);
+    background-gradient-end: rgba(105,105,105,0.1);
+    background-gradient-direction: vertical;
+    font-size: 14pt;
+    font-weight: bold;
+    border-radius: 10px;
+    border: 2px solid #a0a0a0;
+    color: white;
+}
+
+.keyboard-key:grayed {
+   color: #808080;
+   border-color: #808080;
+}
+
+.keyboard-key:checked,
+.keyboard-key:hover {
+    background: #303030;
+    border: 3px solid white;
+}
+
+.keyboard-key:active {
+    background: #808080;
+}
+
+.keyboard-subkeys {
+    color: white;
+    padding: 5px;
+    -arrow-border-radius: 10px;
+    -arrow-background-color: #090909;
+    -arrow-border-width: 2px;
+    -arrow-border-color: white;
+    -arrow-base: 20px;
+    -arrow-rise: 10px;
+    -boxpointer-gap: 5px;
+}

js/Makefile.am

@@ -30,6 +30,7 @@ nobase_dist_js_DATA = 	\
 	ui/environment.js	\
 	ui/extensionSystem.js	\
 	ui/iconGrid.js		\
+	ui/keyboard.js		\
 	ui/layout.js		\
 	ui/lightbox.js		\
 	ui/link.js		\

js/ui/keyboard.js

@@ -0,0 +1,532 @@
+/* -*- mode: js2; js2-basic-offset: 4; indent-tabs-mode: nil -*- */
+
+const Caribou = imports.gi.Caribou;
+const Clutter = imports.gi.Clutter;
+const DBus = imports.dbus;
+const Gdk = imports.gi.Gdk;
+const Gio = imports.gi.Gio;
+const GLib = imports.gi.GLib;
+const Lang = imports.lang;
+const Shell = imports.gi.Shell;
+const St = imports.gi.St;
+
+const BoxPointer = imports.ui.boxpointer;
+const Main = imports.ui.main;
+const MessageTray = imports.ui.messageTray;
+
+const KEYBOARD_SCHEMA = 'org.gnome.shell.keyboard';
+const SHOW_KEYBOARD = 'show-keyboard';
+const KEYBOARD_TYPE = 'keyboard-type';
+
+// Key constants taken from Antler
+// FIXME: ought to be moved into libcaribou
+const PRETTY_KEYS = {
+    'BackSpace': '\u232b',
+    'space': ' ',
+    'Return': '\u23ce',
+    'Caribou_Prefs': '\u2328',
+    'Caribou_ShiftUp': '\u2b06',
+    'Caribou_ShiftDown': '\u2b07',
+    'Caribou_Emoticons': '\u263a',
+    'Caribou_Symbols': '123',
+    'Caribou_Symbols_More': '{#*',
+    'Caribou_Alpha': 'Abc',
+    'Tab': 'Tab',
+    'Escape': 'Esc',
+    'Control_L': 'Ctrl',
+    'Alt_L': 'Alt'
+};
+
+const CaribouKeyboardIface = {
+    name: 'org.gnome.Caribou.Keyboard',
+    methods:    [ { name: 'Show',
+                    inSignature: 'u',
+                    outSignature: ''
+                  },
+                  { name: 'Hide',
+                    inSignature: 'u',
+                    outSignature: ''
+                  },
+                  { name: 'SetCursorLocation',
+                    inSignature: 'iiii',
+                    outSignature: ''
+                  },
+                  { name: 'SetEntryLocation',
+                    inSignature: 'iiii',
+                    outSignature: ''
+                  } ],
+    properties: [ { name: 'Name',
+                    signature: 's',
+                    access: 'read' } ]
+};
+
+function Key() {
+    this._init.apply(this, arguments);
+}
+
+Key.prototype = {
+    _init : function(key) {
+        this._key = key;
+
+        this.actor = this._makeKey();
+
+        this._extended_keys = this._key.get_extended_keys();
+        this._extended_keyboard = null;
+
+        if (this._key.name == "Control_L" || this._key.name == "Alt_L")
+            this._key.latch = true;
+
+        this._key.connect('key-pressed', Lang.bind(this, function ()
+                                                   { this.actor.checked = true }));
+        this._key.connect('key-released', Lang.bind(this, function ()
+                                                    { this.actor.checked = false; }));
+
+        if (this._extended_keys.length > 0) {
+            this._grabbed = false;
+            this._eventCaptureId = 0;
+            this._key.connect('notify::show-subkeys', Lang.bind(this, this._onShowSubkeysChanged));
+            this._boxPointer = new BoxPointer.BoxPointer(St.Side.BOTTOM,
+                                                         { x_fill: true,
+                                                           y_fill: true,
+                                                           x_align: St.Align.START });
+            // Adds style to existing keyboard style to avoid repetition
+            this._boxPointer.actor.add_style_class_name('keyboard-subkeys');
+            this._getExtendedKeys();
+            this.actor._extended_keys = this._extended_keyboard;
+            this._boxPointer.actor.hide();
+            Main.layoutManager.addChrome(this._boxPointer.actor, { visibleInFullscreen: true });
+        }
+    },
+
+    _makeKey: function () {
+        let label = this._key.name;
+
+        if (label.length > 1) {
+            let pretty = PRETTY_KEYS[label];
+            if (pretty)
+                label = pretty;
+            else
+                label = this._getUnichar(this._key);
+        }
+
+        label = GLib.markup_escape_text(label, -1);
+        let button = new St.Button ({ label: label,
+                                      style_class: 'keyboard-key' });
+
+        button.key_width = this._key.width;
+        button.connect('button-press-event', Lang.bind(this, function () { this._key.press(); }));
+        button.connect('button-release-event', Lang.bind(this, function () { this._key.release(); }));
+
+        return button;
+    },
+
+    _getUnichar: function(key) {
+        let keyval = key.keyval;
+        let unichar = Gdk.keyval_to_unicode(keyval);
+        if (unichar) {
+            return String.fromCharCode(unichar);
+        } else {
+            return key.name;
+        }
+    },
+
+    _getExtendedKeys: function () {
+        this._extended_keyboard = new St.BoxLayout({ style_class: 'keyboard-layout',
+                                                     vertical: false });
+        for (let i = 0; i < this._extended_keys.length; ++i) {
+            let extended_key = this._extended_keys[i];
+            let label = this._getUnichar(extended_key);
+            let key = new St.Button({ label: label, style_class: 'keyboard-key' });
+            key.extended_key = extended_key;
+            key.connect('button-press-event', Lang.bind(this, function () { extended_key.press(); }));
+            key.connect('button-release-event', Lang.bind(this, function () { extended_key.release(); }));
+            this._extended_keyboard.add(key);
+        }
+        this._boxPointer.bin.add_actor(this._extended_keyboard);
+    },
+
+    _onEventCapture: function (actor, event) {
+        let source = event.get_source();
+        let type = event.type();
+
+        if ((type == Clutter.EventType.BUTTON_PRESS ||
+             type == Clutter.EventType.BUTTON_RELEASE) &&
+            this._extended_keyboard.contains(source)) {
+            source.extended_key.press();
+            source.extended_key.release();
+            return false;
+        }
+        if (type == Clutter.EventType.BUTTON_PRESS) {
+            this._boxPointer.actor.hide();
+            this._ungrab();
+            return true;
+        }
+        return false;
+    },
+
+    _ungrab: function () {
+        global.stage.disconnect(this._eventCaptureId);
+        this._eventCaptureId = 0;
+        this._grabbed = false;
+        Main.popModal(this.actor);
+    },
+
+    _onShowSubkeysChanged: function () {
+        if (this._key.show_subkeys) {
+            this.actor.fake_release();
+            this._boxPointer.actor.raise_top();
+            this._boxPointer.setPosition(this.actor, 0.5);
+            this._boxPointer.show(true);
+            this.actor.set_hover(false);
+            if (!this._grabbed) {
+                 Main.pushModal(this.actor);
+                 this._eventCaptureId = global.stage.connect('captured-event', Lang.bind(this, this._onEventCapture));
+                 this._grabbed = true;
+            }
+            this._key.release();
+        } else {
+            if (this._grabbed)
+                this._ungrab();
+            this._boxPointer.hide(true);
+        }
+    }
+};
+
+function Keyboard() {
+    this._init.apply(this, arguments);
+}
+
+Keyboard.prototype = {
+    _init: function () {
+        DBus.session.exportObject('/org/gnome/Caribou/Keyboard', this);
+        DBus.session.acquire_name('org.gnome.Caribou.Keyboard', 0, null, null);
+
+        this._timestamp = global.get_current_time();
+        this.actor = new St.BoxLayout({ name: 'keyboard', vertical: true, reactive: true });
+        Main.layoutManager.keyboardBox.add_actor(this.actor);
+        Main.layoutManager.trackChrome(this.actor);
+        Main.layoutManager.connect('monitors-changed', Lang.bind(this, this._redraw));
+
+        this._keyboardSettings = new Gio.Settings({ schema: KEYBOARD_SCHEMA });
+        this._keyboardSettings.connect('changed', Lang.bind(this, this._settingsChanged));
+        this._settingsChanged();
+    },
+
+    init: function () {
+        if (this._enableKeyboard)
+            this._redraw();
+    },
+
+    _settingsChanged: function () {
+        this._enableKeyboard = this._keyboardSettings.get_boolean(SHOW_KEYBOARD);
+        if (!this._enableKeyboard && !this._keyboard)
+            return;
+        if (this._enableKeyboard && this._keyboard &&
+            this._keyboard.keyboard_type == this._keyboardSettings.get_string(KEYBOARD_TYPE))
+            return;
+
+        if (this._keyboard)
+            this._destroyKeyboard();
+        if (this._enableKeyboard)
+            this._setupKeyboard();
+        else
+            Main.layoutManager.hideKeyboard(true);
+    },
+
+    _destroyKeyboard: function() {
+        if (this._keyboardNotifyId)
+            this._keyboard.disconnect(this._keyboardNotifyId);
+        if (this._focusNotifyId)
+            global.stage.disconnect(this._focusNotifyId);
+        this._keyboard = null;
+        this.actor.destroy_children();
+
+        this._destroySource();
+    },
+
+    _setupKeyboard: function() {
+        this._keyboard = new Caribou.KeyboardModel({ keyboard_type: this._keyboardSettings.get_string(KEYBOARD_TYPE) });
+        this._groups = {};
+        this._current_page = null;
+
+        // Initialize keyboard key measurements
+        this._numOfHorizKeys = 0;
+        this._numOfVertKeys = 0;
+
+        this._addKeys();
+
+        this._keyboardNotifyId = this._keyboard.connect('notify::active-group', Lang.bind(this, this._onGroupChanged));
+        this._focusNotifyId = global.stage.connect('notify::key-focus', Lang.bind(this, this._onKeyFocusChanged));
+        this._createSource();
+    },
+
+    _onKeyFocusChanged: function () {
+        let focus = global.stage.key_focus;
+
+        if (focus == global.stage || focus == null)
+            return;
+
+        if (focus instanceof Clutter.Text)
+            this.show();
+        else {
+            if (focus._extended_keys == null)
+                this.hide();
+        }
+    },
+
+    _addKeys: function () {
+        let groups = this._keyboard.get_groups();
+        for (let i = 0; i < groups.length; ++i) {
+             let gname = groups[i];
+             let group = this._keyboard.get_group(gname);
+             group.connect('notify::active-level', Lang.bind(this, this._onLevelChanged));
+             let layers = {};
+             let levels = group.get_levels();
+             for (let j = 0; j < levels.length; ++j) {
+                 let lname = levels[j];
+                 let level = group.get_level(lname);
+                 let layout = new St.BoxLayout({ style_class: 'keyboard-layout',
+                                                 vertical: true });
+                 this._loadRows(level, layout);
+                 layers[lname] = layout;
+                 this.actor.add(layout, { x_fill: false });
+
+                 layout.hide();
+             }
+             this._groups[gname] = layers;
+        }
+
+        this._setActiveLayer();
+    },
+
+    _getTrayIcon: function () {
+        let trayButton = new St.Button ({ label: "tray", style_class: 'keyboard-key' });
+        trayButton.key_width = 1;
+        trayButton.connect('button-press-event', Lang.bind(this, function () {
+            Main.messageTray.toggle();
+        }));
+
+        Main.overview.connect('showing', Lang.bind(this, function () {
+            trayButton.reactive = false;
+            trayButton.add_style_pseudo_class('grayed');
+        }));
+        Main.overview.connect('hiding', Lang.bind(this, function () {
+            trayButton.reactive = true;
+            trayButton.remove_style_pseudo_class('grayed');
+        }));
+
+        return trayButton;
+    },
+
+    _addRows : function (keys, layout) {
+        let keyboard_row = new St.BoxLayout();
+        for (let i = 0; i < keys.length; ++i) {
+            let children = keys[i].get_children();
+            let right_box = new St.BoxLayout({ style_class: 'keyboard-row' });
+            let left_box = new St.BoxLayout({ style_class: 'keyboard-row' });
+            for (let j = 0; j < children.length; ++j) {
+                if (this._numOfHorizKeys == 0)
+                    this._numOfHorizKeys = children.length;
+                let key = children[j];
+                let button = new Key(key);
+
+                if (key.align == 'right')
+                    right_box.add(button.actor);
+                else
+                    left_box.add(button.actor);
+                if (key.name == "Caribou_Prefs") {
+                    key.connect('key-released', Lang.bind(this, this.hide));
+
+                    // Add new key for hiding message tray
+                    right_box.add(this._getTrayIcon());
+                }
+            }
+            keyboard_row.add(left_box, { expand: true, x_fill: false, x_align: St.Align.START });
+            keyboard_row.add(right_box, { expand: true, x_fill: false, x_align: St.Align.END });
+        }
+        layout.add(keyboard_row);
+    },
+
+    _loadRows : function (level, layout) {
+        let rows = level.get_rows();
+        for (let i = 0; i < rows.length; ++i) {
+            let row = rows[i];
+            if (this._numOfVertKeys == 0)
+                this._numOfVertKeys = rows.length;
+            this._addRows(row.get_columns(), layout);
+        }
+
+    },
+
+    _redraw: function () {
+        let monitor = Main.layoutManager.bottomMonitor;
+        let maxHeight = monitor.height / 3;
+        this.actor.width = monitor.width;
+
+        let layout = this._current_page;
+        let verticalSpacing = layout.get_theme_node().get_length('spacing');
+        let padding = layout.get_theme_node().get_length('padding');
+
+        let box = layout.get_children()[0].get_children()[0];
+        let horizontalSpacing = box.get_theme_node().get_length('spacing');
+        let allHorizontalSpacing = (this._numOfHorizKeys - 1) * horizontalSpacing;
+        let keyWidth = Math.floor((this.actor.width - allHorizontalSpacing - 2 * padding) / this._numOfHorizKeys);
+
+        let allVerticalSpacing = (this._numOfVertKeys - 1) * verticalSpacing;
+        let keyHeight = Math.floor((maxHeight - allVerticalSpacing - 2 * padding) / this._numOfVertKeys);
+
+        let keySize = Math.min(keyWidth, keyHeight);
+        this.actor.height = keySize * this._numOfVertKeys + allVerticalSpacing + 2 * padding;
+
+        let rows = this._current_page.get_children();
+        for (let i = 0; i < rows.length; ++i) {
+            let keyboard_row = rows[i];
+            let boxes = keyboard_row.get_children();
+            for (let j = 0; j < boxes.length; ++j) {
+                let keys = boxes[j].get_children();
+                for (let k = 0; k < keys.length; ++k) {
+                    let child = keys[k];
+                    child.width = keySize * child.key_width;
+                    child.height = keySize;
+                    if (child._extended_keys) {
+                        let extended_keys = child._extended_keys.get_children();
+                        for (let n = 0; n < extended_keys.length; ++n) {
+                            let extended_key = extended_keys[n];
+                            extended_key.width = keySize;
+                            extended_key.height = keySize;
+                        }
+                    }
+                }
+            }
+        }
+    },
+
+    _onLevelChanged: function () {
+        this._setActiveLayer();
+        this._redraw();
+    },
+
+    _onGroupChanged: function () {
+        this._setActiveLayer();
+        this._redraw();
+    },
+
+    _setActiveLayer: function () {
+        let active_group_name = this._keyboard.active_group;
+        let active_group = this._keyboard.get_group(active_group_name);
+        let active_level = active_group.active_level;
+        let layers = this._groups[active_group_name];
+
+        if (this._current_page != null) {
+            this._current_page.hide();
+        }
+
+        this._current_page = layers[active_level];
+        this._current_page.show();
+    },
+
+    _createSource: function () {
+        if (this._source == null) {
+            this._source = new KeyboardSource(this);
+            this._source.setTransient(true);
+            Main.messageTray.add(this._source);
+        }
+    },
+
+    _destroySource: function () {
+        if (this._source) {
+            this._source.destroy();
+            this._source = null;
+        }
+    },
+
+    show: function () {
+        this._redraw();
+
+        Main.layoutManager.showKeyboard();
+        this._destroySource();
+    },
+
+    hide: function () {
+        Main.layoutManager.hideKeyboard();
+        this._createSource();
+    },
+
+    _moveTemporarily: function () {
+        let currentWindow = global.screen.get_display().focus_window;
+        let rect = currentWindow.get_outer_rect();
+
+        let newX = rect.x;
+        let newY = 3 * this.actor.height / 2;
+        currentWindow.move_frame(true, newX, newY);
+    },
+
+    _setLocation: function (x, y) {
+        if (y >= 2 * this.actor.height)
+            this._moveTemporarily();
+    },
+
+    // D-Bus methods
+    Show: function(timestamp) {
+        if (timestamp - this._timestamp < 0)
+            return;
+
+        this._timestamp = timestamp;
+        this.show();
+    },
+
+    Hide: function(timestamp) {
+        if (timestamp - this._timestamp < 0)
+            return;
+
+        this._timestamp = timestamp;
+        this.hide();
+    },
+
+    SetCursorLocation: function(x, y, w, h) {
+        this._setLocation(x, y);
+    },
+
+    SetEntryLocation: function(x, y, w, h) {
+        this._setLocation(x, y);
+    },
+
+    get Name() {
+        return 'gnome-shell';
+    }
+};
+DBus.conformExport(Keyboard.prototype, CaribouKeyboardIface);
+
+function KeyboardSource() {
+    this._init.apply(this, arguments);
+}
+
+KeyboardSource.prototype = {
+    __proto__: MessageTray.Source.prototype,
+
+    _init: function(keyboard) {
+        this._keyboard = keyboard;
+        MessageTray.Source.prototype._init.call(this, _("Keyboard"));
+
+        this._setSummaryIcon(this.createNotificationIcon());
+    },
+
+    createNotificationIcon: function() {
+        return new St.Icon({ icon_name: 'input-keyboard',
+                             icon_type: St.IconType.SYMBOLIC,
+                             icon_size: this.ICON_SIZE });
+    },
+
+     handleSummaryClick: function() {
+        let event = Clutter.get_current_event();
+        if (event.type() != Clutter.EventType.BUTTON_RELEASE)
+            return false;
+
+        this.open();
+        return true;
+    },
+
+    open: function() {
+        this._keyboard.show();
+    }
+};

js/ui/layout.js

@@ -14,8 +14,8 @@ const ScreenSaver = imports.misc.screenSaver;
 const Tweener = imports.ui.tweener;
 
 const HOT_CORNER_ACTIVATION_TIMEOUT = 0.5;
-
 const STARTUP_ANIMATION_TIME = 0.2;
+const KEYBOARD_ANIMATION_TIME = 0.5;
 
 function LayoutManager() {
     this._init.apply(this, arguments);
@@ -40,10 +40,20 @@ LayoutManager.prototype = {
         this.panelBox.connect('allocation-changed',
                               Lang.bind(this, this._updatePanelBarriers));
 
+        // bottomBox contains the tray and keyboard (which move
+        // together, since the tray slides up from the top of the
+        // keyboard when the keyboard is visible).
+        this._bottomBox = new St.BoxLayout({ name: 'bottomBox',
+                                             vertical: true });
+        this.addChrome(this._bottomBox, { visibleInFullscreen: true });
+
         this.trayBox = new St.BoxLayout({ name: 'trayBox' }); 
         this.trayBox.connect('allocation-changed',
                              Lang.bind(this, this._updateTrayBarrier));
-        this.addChrome(this.trayBox, { visibleInFullscreen: true });
+        this._bottomBox.add_actor(this.trayBox);
+
+        this.keyboardBox = new St.BoxLayout({ name: 'keyboardBox' });
+        this._bottomBox.add_actor(this.keyboardBox);
 
         global.screen.connect('monitors-changed',
                               Lang.bind(this, this._monitorsChanged));
@@ -143,9 +153,18 @@ LayoutManager.prototype = {
         this.panelBox.set_position(this.primaryMonitor.x, this.primaryMonitor.y);
         this.panelBox.set_size(this.primaryMonitor.width, -1);
 
-        this.trayBox.set_position(this.bottomMonitor.x,
+        this._bottomBox.set_position(this.bottomMonitor.x,
-                                  this.bottomMonitor.y + this.bottomMonitor.height);
+                                     this.bottomMonitor.y + this.bottomMonitor.height);
-        this.trayBox.set_size(this.bottomMonitor.width, -1);
+        this._bottomBox.set_size(this.bottomMonitor.width, -1);
+
+        this.trayBox.width = this.bottomMonitor.width;
+
+        // Set trayBox's clip to show things above it, but not below
+        // it (so it's not visible behind the keyboard). The exact
+        // height of the clip doesn't matter, as long as it's taller
+        // than any Notification.actor.
+        this.trayBox.set_clip(0, -this.bottomMonitor.height,
+                              this.bottomMonitor.width, this.bottomMonitor.height);
     },
 
     _updatePanelBarriers: function() {
@@ -239,6 +258,42 @@ LayoutManager.prototype = {
                          });
     },
 
+    showKeyboard: function () {
+        Main.messageTray.hide();
+        Tweener.addTween(this._bottomBox,
+                         { anchor_y: this._bottomBox.height,
+                           time: KEYBOARD_ANIMATION_TIME,
+                           transition: 'easeOutQuad',
+                           onComplete: this._showKeyboardComplete,
+                           onCompleteScope: this
+                         });
+    },
+
+    _showKeyboardComplete: function() {
+        // Poke Chrome to update the input shape; it doesn't notice
+        // anchor point changes
+        this._chrome.updateRegions();
+
+        this._bottomBox.connect('notify::height', Lang.bind(this, function () {
+            this._bottomBoxAnchor = this._bottomBox.height;
+        }));
+    },
+
+    hideKeyboard: function (immediate) {
+        Main.messageTray.hide();
+        Tweener.addTween(this._bottomBox,
+                         { anchor_y: 0,
+                           time: immediate ? 0 : KEYBOARD_ANIMATION_TIME,
+                           transition: 'easeOutQuad',
+                           onComplete: this._showKeyboardComplete,
+                           onCompleteScope: this
+                         });
+    },
+
+    _hideKeyboardComplete: function() {
+        this._chrome.updateRegions();
+    },
+
     // addChrome:
     // @actor: an actor to add to the chrome layer
     // @params: (optional) additional params
@@ -690,7 +745,7 @@ Chrome.prototype = {
 
     _queueUpdateRegions: function() {
         if (!this._updateRegionIdle)
-            this._updateRegionIdle = Mainloop.idle_add(Lang.bind(this, this._updateRegions),
+            this._updateRegionIdle = Mainloop.idle_add(Lang.bind(this, this.updateRegions),
                                                        Meta.PRIORITY_BEFORE_REDRAW);
     },
 
@@ -759,10 +814,13 @@ Chrome.prototype = {
         }
     },
 
-    _updateRegions: function() {
+    updateRegions: function() {
         let rects = [], struts = [], i;
 
-        delete this._updateRegionIdle;
+        if (this._updateRegionIdle) {
+            Mainloop.source_remove(this._updateRegionIdle);
+            delete this._updateRegionIdle;
+        }
 
         for (i = 0; i < this._trackedActors.length; i++) {
             let actorData = this._trackedActors[i];

js/ui/main.js

@@ -19,6 +19,7 @@ const EndSessionDialog = imports.ui.endSessionDialog;
 const PolkitAuthenticationAgent = imports.ui.polkitAuthenticationAgent;
 const Environment = imports.ui.environment;
 const ExtensionSystem = imports.ui.extensionSystem;
+const Keyboard = imports.ui.keyboard;
 const MessageTray = imports.ui.messageTray;
 const Overview = imports.ui.overview;
 const Panel = imports.ui.panel;
@@ -63,6 +64,7 @@ let uiGroup = null;
 let magnifier = null;
 let xdndHandler = null;
 let statusIconDispatcher = null;
+let keyboard = null;
 let layoutManager = null;
 let networkAgent = null;
 let _errorLogStack = [];
@@ -142,6 +144,7 @@ function start() {
     panel = new Panel.Panel();
     wm = new WindowManager.WindowManager();
     messageTray = new MessageTray.MessageTray();
+    keyboard = new Keyboard.Keyboard();
     notificationDaemon = new NotificationDaemon.NotificationDaemon();
     windowAttentionHandler = new WindowAttentionHandler.WindowAttentionHandler();
     telepathyClient = new TelepathyClient.Client();
@@ -150,6 +153,7 @@ function start() {
     networkAgent = new NetworkAgent.NetworkAgent();
 
     layoutManager.init();
+    keyboard.init();
     overview.init();
     statusIconDispatcher.start(messageTray.actor);
     panel.startStatusArea();

js/ui/messageTray.js

@@ -269,7 +269,7 @@ FocusGrabber.prototype = {
         let source = event.get_source();
         switch (event.type()) {
             case Clutter.EventType.BUTTON_PRESS:
-                if (!this.actor.contains(source))
+                if (!this.actor.contains(source) && !Main.keyboard.actor.contains(source))
                     this.emit('button-pressed', source);
                 break;
             case Clutter.EventType.KEY_PRESS:
@@ -1314,6 +1314,7 @@ MessageTray.prototype = {
 
         this._trayState = State.HIDDEN;
         this._locked = false;
+        this._traySummoned = false;
         this._useLongerTrayLeftTimeout = false;
         this._trayLeftTimeoutId = 0;
         this._pointerInTray = false;
@@ -1524,6 +1525,18 @@ MessageTray.prototype = {
         this._updateState();
     },
 
+    toggle: function() {
+        this._traySummoned = !this._traySummoned;
+        this._updateState();
+    },
+
+    hide: function() {
+        this._traySummoned = false;
+        this.actor.set_hover(false);
+        this._summary.set_hover(false);
+        this._updateState();
+    },
+
     _onNotify: function(source, notification) {
         if (this._summaryBoxPointerItem && this._summaryBoxPointerItem.source == source) {
             if (this._summaryBoxPointerState == State.HIDING)
@@ -1831,7 +1844,7 @@ MessageTray.prototype = {
         }
 
         // Summary
-        let summarySummoned = this._pointerInSummary || this._overviewVisible;
+        let summarySummoned = this._pointerInSummary || this._overviewVisible ||  this._traySummoned;
         let summaryPinned = this._summaryTimeoutId != 0 || this._pointerInTray || summarySummoned || this._locked;
         let summaryHovered = this._pointerInTray || this._pointerInSummary;
         let summaryVisibleWithNoHover = (this._overviewVisible || this._locked) && !summaryHovered;

tools/build/gnome-shell.modules

@@ -318,6 +318,7 @@
         <dep package="gobject-introspection"/>
         <dep package="mutter"/>
         <dep package="gjs"/>
+        <dep package="caribou"/>
         <dep package="dconf"/>
         <dep package="gconf"/>
         <dep package="glib"/>
@@ -422,6 +423,12 @@
 
   <autotools id="caribou">
     <branch repo="git.gnome.org" module="caribou"/>
+    <dependencies>
+      <dep package="gtk3"/>
+      <dep package="clutter"/>
+      <dep package="libxklavier"/>
+      <dep package="vala"/>
+    </dependencies>
   </autotools>
 
 </moduleset>