Merge lp:~unity-2d-team/unity-2d/shortcut-hint-overlay into lp:unity-2d

[Lohith D Shivamurthy]

[launcher] Shortcut list should be shown while super key is held.

[Lohith D Shivamurthy (dyams)]

Further details:
The List of keys to be displayed and the layout of the overlay can be found in the bug description https://bugs.launchpad.net/unity-2d/+bug/855532
It is discussed with the design team, that certain keys having multiple values in gconf, like 'Switch workspaces' should only be displayed when the keys are symmetric.

[Albert Astals Cid (aacid)]

u2d.tr(description) won't work since the text of the description won't be extracted by the update-unity-2d-pot script, the same for the title. And since the won't be in the .po file they won't be translatable. You'll have to move the u2d.tr to were you have the actual "text" so the text is extracted.

review: Needs Fixing

[Florian Boucault (fboucault)]

Of course, we won't merge that until unity-2d-shell is merged into lp:unity-2d.

[Gerry Boland (gerboland)]

Please give credit to Tiago in the commit message, for working on the UI side of this MR.

[Michał Sawicz (saviq)]

Hey, this looks like it could go into lp:unity-2d with minor modifications, and will reduce the diff when we actually go to merging shell into trunk, could you please have a MR against lp:unity-2d for this?

review: Needs Information

[Michał Sawicz (saviq)]

> Hey, this looks like it could go into lp:unity-2d with minor modifications,
> and will reduce the diff when we actually go to merging shell into trunk,
> could you please have a MR against lp:unity-2d for this?

Actually that might not be worth it, since you don't have any fullscreen part of the UI with unity-2d, you'd have to hack up the dash to go fullscreen when the hint is supposed to show.

In that case I propose that we wait with merging this for the shell to be merged into trunk and then MR that change against trunk.

[Michał Sawicz (saviq)]

The overlay needs to have a blurred background, it's unreadable when you have a terminal window behind it.

Also, I wonder if the overlay should be input-shaped? Right now you can interact with windows behind the overlay, which makes sense, for it being just an overlay, but not sure that's the designed behavior.

review: Needs Fixing

[Gerry Boland (gerboland)]

Looks nice! Aside from above comments:
- along with blurred background, the sheen is also needed. See Background.qml
- background has unusual colour tint set. We don't have tinting just now, so should be removed.
- shell/Shell.qml - why remove "KeyNavigation.left: launcherLoader" ?
- in symmetricKey() and getShortcutKey(), GConfItem declared in Unity2D, no need to import QtQuick
- in your javascript, your notation is mixing camelCase and underscore_separator. Use camelCase please. Some spacing between arguments in the function calls would help readability too.
- symmetricKey deserves a comment to explain why it is there.
- can you check with design about using empty strings if no key is set? I think it looks confusing.
- I have a truncation for a long key combination: https://imgur.com/a/okLFf can you also check with design to see what to do?
- overlay needs to be positioned a little higher, see comparison image: https://imgur.com/xqAVf
- there are typos, and some EnglishUK spellings instead of US (see first screenshot again). Yes they're in the mockup, but check with design
- in "Switching" - the left/right cursor keys do not move focus in Metacity. Is this something that needs to be enabled, or should this listing be removed?
- Alt+Middle Mouse drag also doesn't work for me.
- Please use fontUtils.js to specify font sizes
- you have unrelated changes from tests/run-tests.rb & tests/shell/input_shaping.rb in the diff, please remove.
- recently we decided having authors names in text files was going to be a pain, so we removed them. Will you do the same?
- have you given any thought to accessibility? How will this work with Orca? Since focus is not stolen, what will Orca do? Will it be possible to have Orca read out these shortcuts in some way? Just something to think about.
- import Unity2d 1.0 /* required by GConfItem */ <- GConfItem requires Unity2D, not other way around
- qml (I know, Tiago's) could be cleaned up a little, with both x,y coordinates & anchors being used, lots of unnecessary margin:0 scattered about for example.

review: Needs Fixing

[Lohith D Shivamurthy (dyams)]

> The overlay needs to have a blurred background, it's unreadable when you have
> a terminal window behind it.
>
I checked with design and have done what they said.

> Also, I wonder if the overlay should be input-shaped? Right now you can
> interact with windows behind the overlay, which makes sense, for it being just
> an overlay, but not sure that's the designed behavior.
Yes you can interact with windows behind it.

[Lohith D Shivamurthy (dyams)]

> Looks nice! Aside from above comments:
> - along with blurred background, the sheen is also needed. See Background.qml
> - background has unusual colour tint set. We don't have tinting just now, so
> should be removed.
I checked with design, this is the conversation:
dyams rosie: should we need to have a background for overlay hint?
dyams rosie: if the overlay is displayed on a white background for ex: gedit window, the shortcuts are hardly visible
rosie dyams: there is a 35% #5e2750 layer and a -80% (-150% - 150%) brightness layer

> - shell/Shell.qml - why remove "KeyNavigation.left: launcherLoader" ?
The only difference i see in Shell.qml is
30 + Loader {
31 + id: shortcutHintLoader
32 + anchors.centerIn: parent
33 + }
34 +

> - in symmetricKey() and getShortcutKey(), GConfItem declared in Unity2D, no
> need to import QtQuick
Are you sure? FYI, i get this '[WARNING] ShortcutHint.qml:22:1: Item is not a type'
> - in your javascript, your notation is mixing camelCase and
> underscore_separator. Use camelCase please. Some spacing between arguments in
> the function calls would help readability too.
> - symmetricKey deserves a comment to explain why it is there.
Done.
> - can you check with design about using empty strings if no key is set? I
> think it looks confusing.
true, but its design decision.

> - I have a truncation for a long key combination: https://imgur.com/a/okLFf
> can you also check with design to see what to do?
Design changed a bit, I have updated the same.

> - overlay needs to be positioned a little higher, see comparison image:
> https://imgur.com/xqAVf
It is positioned to the center. I doubt we need to adjust it again.

> - there are typos, and some EnglishUK spellings instead of US (see first
> screenshot again). Yes they're in the mockup, but check with design
Done

> - in "Switching" - the left/right cursor keys do not move focus in Metacity.
> Is this something that needs to be enabled, or should this listing be removed?
No, It works

> - Alt+Middle Mouse drag also doesn't work for me.
No, It works

> - Please use fontUtils.js to specify font sizes
Done.

> - you have unrelated changes from tests/run-tests.rb &
> tests/shell/input_shaping.rb in the diff, please remove.
Is it? but they are not listed under the 'differences' here.

> - recently we decided having authors names in text files was going to be a
> pain, so we removed them. Will you do the same?
Done.

> - have you given any thought to accessibility? How will this work with Orca?
> Since focus is not stolen, what will Orca do? Will it be possible to have Orca
> read out these shortcuts in some way? Just something to think about.
No.

> - import Unity2d 1.0 /* required by GConfItem */ <- GConfItem requires
> Unity2D, not other way around
Yes I know.

> - qml (I know, Tiago's) could be cleaned up a little, with both x,y
> coordinates & anchors being used, lots of unnecessary margin:0 scattered about
> for example.
Done.

[Florian Boucault (fboucault)]

Please resubmit the MR against lp:unity-2d

[Florian Boucault (fboucault)]

Maybe I am out of line here but I don't see how the overlay belongs to the launcher.

review: Needs Fixing

[Florian Boucault (fboucault)]

No need to expose GConfItem through our plugin, just:

import gconf 1.0

review: Needs Fixing

[Florian Boucault (fboucault)]

The shortcut overlay needs a blurred background, per design

review: Needs Fixing

[Florian Boucault (fboucault)]

The borders are wrong, they look like a small image stretched

[Florian Boucault (fboucault)]

shell/launcher/LauncherLoader.qml refers to declarativeView.dashActive which should never be done from QML. Use Dash.qml's dash.active instead

review: Needs Fixing

[Florian Boucault (fboucault)]

shell/launcher/LauncherLoader.qml refers to shortcutHintLoader which is not defined anywhere in shell/launcher/LauncherLoader.qml; that is bad practice that breaks encapsulation (ie. shell/launcher/LauncherLoader.qml cannot be run on its own)

review: Needs Fixing

[Florian Boucault (fboucault)]

Why giving a different:
- file name: ShortcutHint.qml
- id: main
- and objectName: "shortcutHintOverlay"
to the same thing?

review: Needs Fixing

[Florian Boucault (fboucault)]

Why is it not part of the png for the border?

    Rectangle {
        id: totalArea
        color: Qt.lighter("#5e275023", -0.8)
        radius: 8
        smooth: true
        anchors.fill: parent
        anchors.margins: 10

Where is that color coming from?

[Florian Boucault (fboucault)]

Please use TextCustom and its fontSize property instead of Text.

review: Needs Fixing

[Florian Boucault (fboucault)]

Is the interface translatable? Did you act on Albert's comment:

"u2d.tr(description) won't work since the text of the description won't be extracted by the update-unity-2d-pot script, the same for the title. And since the won't be in the .po file they won't be translatable. You'll have to move the u2d.tr to were you have the actual "text" so the text is extracted."

review: Needs Fixing

[lp:~unity-2d-team/unity-2d/shortcut-hint-overlay]

965. By Lohith D Shivamurthy on 2012-02-13

Directly import gconf 0.1

966. By Lohith D Shivamurthy on 2012-02-13

keep object id same as objectname

967. By Lohith D Shivamurthy on 2012-02-13

Add a FIXME for i18n of display strings

968. By Lohith D Shivamurthy on 2012-02-13

Remove background color

969. By Lohith D Shivamurthy on 2012-02-13

Use TextCustom instead of Text element

970. By Lohith D Shivamurthy on 2012-02-13

Fix missing parent object

971. By Lohith D Shivamurthy on 2012-02-13

Apply blur background

972. By Lohith D Shivamurthy on 2012-02-13

Activate/Deactivate overlay in shell.qml

973. By Lohith D Shivamurthy on 2012-02-13

Deactivate the overlay on tapping launcher tile shortcuts

[Albert Astals Cid (aacid)]

I don't think having untranslatable strings is acceptable.

If we can't have
ListElement { defaultKey: "Super (Press)"; description: u2d.tr("Open Launcher, displays shortcuts."); gconfKey: "" }
because of that Qt bug i suggest we do this

Switch can to using
text: u2d.tr(description)
and then add somewhere in the file
    function dummyFunction() {
        u2d.tr("Open Launcher, displays shortcuts.")
        ...
        ...
    }
This way we trick po/update-unity-2d-pot to extract the descriptions into the .pot file and things are translatable again

review: Needs Fixing

[lp:~unity-2d-team/unity-2d/shortcut-hint-overlay]

974. By Lohith D Shivamurthy on 2012-02-14

Add a dummy function and call u2d.tr on all display strings

[Albert Astals Cid (aacid)]

I'm happy enough with the translation stuff, i'll let Florian decided if his other concerns are fixed

[Michał Sawicz (saviq)]

Wouldn't http://developer.qt.nokia.com/doc/qt-4.8/qml-item.html#data-prop be a good place to have those translation strings?

review: Needs Information

[lp:~unity-2d-team/unity-2d/shortcut-hint-overlay]

975. By Lohith D Shivamurthy on 2012-02-14

Improve background

976. By Lohith D Shivamurthy on 2012-02-14

Use workaround mentioned in the bugreport

977. By Lohith D Shivamurthy on 2012-02-15

Use regExp to replace case-insensitively

978. By Lohith D Shivamurthy on 2012-02-15

Replace Shft with Shift

979. By Lohith D Shivamurthy on 2012-02-15

Add missing file ModelElement.qml

980. By Lohith D Shivamurthy on 2012-02-15

merge

981. By Lohith D Shivamurthy on 2012-02-16

Remove extra field from ModelElement.qml

982. By Lohith D Shivamurthy on 2012-02-16

deactivate overlay when view looses focus

983. By Lohith D Shivamurthy on 2012-02-16

Apply black background with 70% opacity

984. By Tiago Salem Herrmann on 2012-03-19

merge trunk

985. By Tiago Salem Herrmann on 2012-03-19

onSuperKeyHeldChanged was moved to shellManager

986. By Tiago Salem Herrmann on 2012-03-20

remove debug

987. By Tiago Salem Herrmann on 2012-03-20

Force string object for the key. In some cases key is a object so replace() and substring fail

988. By Tiago Salem Herrmann on 2012-03-20

fix white spaces

989. By Tiago Salem Herrmann on 2012-03-20

ignore <Primary> string

990. By Tiago Salem Herrmann on 2012-03-21

merge trunk

991. By Tiago Salem Herrmann on 2012-03-21

add MultiMonitor support
Use the same trick as Dash to update the blurred background

992. By Gerry Boland on 2012-03-26

Replace 'KP_' with 'Num' in gconf string. Needed for Numpad keys

993. By Gerry Boland on 2012-03-26

QtQuick1.0 not needed to read gconf values

994. By Gerry Boland on 2012-03-26

Add basic RTL support

995. By Gerry Boland on 2012-03-29

[debian] Install shortcut overlay QML files

[Albert Astals Cid (aacid)]

The "Alt (Tap) shows HUD" is missing

review: Needs Fixing

[Albert Astals Cid (aacid)]

The focus is not returned to the previous app once the super key is released

review: Needs Fixing

[Albert Astals Cid (aacid)]

the onDashActiveChanged code for declarativeView is wrong and needs to be merged with the existing onDashActiveChanged for the shellManager

review: Needs Fixing

[Albert Astals Cid (aacid)]

Key descriptions (e.g. "Cursors Keys") need to be translatable

review: Needs Fixing

[Albert Astals Cid (aacid)]

symmetricKey also needs i18n work, it prepends "Cursors" in some cases

review: Needs Fixing

[Albert Astals Cid (aacid)]

Don't we need

install(DIRECTORY shortcutoverlay
    DESTINATION ${UNITY_2D_DIR}/shell
    )

in shell/CMakelists.txt?

review: Needs Fixing

Unmerged revisions

995. By Gerry Boland on 2012-03-29

[debian] Install shortcut overlay QML files

994. By Gerry Boland on 2012-03-26

Add basic RTL support

993. By Gerry Boland on 2012-03-26

QtQuick1.0 not needed to read gconf values

992. By Gerry Boland on 2012-03-26

Replace 'KP_' with 'Num' in gconf string. Needed for Numpad keys

991. By Tiago Salem Herrmann on 2012-03-21

add MultiMonitor support
Use the same trick as Dash to update the blurred background

990. By Tiago Salem Herrmann on 2012-03-21

merge trunk

989. By Tiago Salem Herrmann on 2012-03-20

ignore <Primary> string

988. By Tiago Salem Herrmann on 2012-03-20

fix white spaces

987. By Tiago Salem Herrmann on 2012-03-20

Force string object for the key. In some cases key is a object so replace() and substring fail

986. By Tiago Salem Herrmann on 2012-03-20

remove debug

=== modified file 'debian/unity-2d-shell.install.in'
--- debian/unity-2d-shell.install.in	2012-03-02 10:29:40 +0000
+++ debian/unity-2d-shell.install.in	2012-03-29 12:58:23 +0000
@@ -7,3 +7,4 @@
 @DEBIAN_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/unity-2d/shell/launcher
 @DEBIAN_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/unity-2d/shell/common
 @DEBIAN_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/unity-2d/shell/artwork
+@DEBIAN_INSTALL_PREFIX@/@CMAKE_INSTALL_DATADIR@/unity-2d/shell/shortcutoverlay
 
=== modified file 'shell/Shell.qml'
--- shell/Shell.qml	2012-03-20 14:50:42 +0000
+++ shell/Shell.qml	2012-03-29 12:58:23 +0000
@@ -108,6 +108,20 @@
 
         Behavior on x { NumberAnimation { id: launcherLoaderXAnimation; duration: 125 } }
 
+        Connections {
+            target: declarativeView
+            onDashActiveChanged: {
+                if (declarativeView.dashActive) {
+                    shortcutHintLoader.source = ""
+                    launcherLoader.visibilityController.beginForceVisible("dash")
+                }
+                else {
+                    launcherLoader.visibilityController.endForceVisible("dash")
+                    if (dashLoader.status == Loader.Ready) dashLoader.item.deactivateAllLenses()
+                }
+            }
+        }
+
         SpreadMonitor {
             id: spread
             onShownChanged: if (shown) {
@@ -153,6 +167,23 @@
                 }
             }
         }
+        onSuperKeyHeldChanged: {
+            shortcutHintLoader.source = ""
+            if(superKeyHeld && (shell.width > 1024 || shell.height > 768) &&
+                   declarativeView.screen.screen == shellManager.activeShellScreen) {
+                shortcutHintLoader.source = "shortcutoverlay/ShortcutHint.qml"
+                shortcutHintLoader.item.trigger()
+                if (dashLoader.item.active) {
+                    dashLoader.item.active = false
+                }
+            }
+        }
+    }
+
+    Loader {
+        id: shortcutHintLoader
+        anchors.centerIn: parent
+        onLoaded: { declarativeView.forceActivateWindow(); item.forceActiveFocus(); }
     }
 
     Connections {
@@ -171,6 +202,9 @@
                the shell doesn't react to activeFocus at all.
                See: https://bugreports.qt.nokia.com/browse/QTBUG-19688 */
             if (!declarativeView.focus && launcherLoader.activeFocus) shell.focus = true
+            if (!declarativeView.focus && shortcutHintLoader.status == Loader.Ready) {
+                shortcutHintLoader.source = ""
+            }
         }
     }
 
 
=== modified file 'shell/app/shellmanager.cpp'
--- shell/app/shellmanager.cpp	2012-03-16 11:03:24 +0000
+++ shell/app/shellmanager.cpp	2012-03-29 12:58:23 +0000
@@ -541,6 +541,17 @@
     }
 }
 
+int
+ShellManager::activeShellScreen() const
+{
+    ShellDeclarativeView * activeShell = d->activeShell(ShellManagerPrivate::ActiveShellLauncherRelatedUse);
+    if (activeShell) {
+        return activeShell->screen()->screen();
+    } else {
+        return -1;
+    }
+}
+
 /*------------------ Hotkeys Handling -----------------------*/
 
 void
 
=== modified file 'shell/app/shellmanager.h'
--- shell/app/shellmanager.h	2012-03-14 08:29:06 +0000
+++ shell/app/shellmanager.h	2012-03-29 12:58:23 +0000
@@ -44,6 +44,7 @@
     Q_PROPERTY(int hudScreen READ hudScreen NOTIFY hudScreenChanged)
     Q_PROPERTY(unsigned int lastFocusedWindow READ lastFocusedWindow NOTIFY lastFocusedWindowChanged)
 
+    Q_PROPERTY(int activeShellScreen READ activeShellScreen)
 public:
     enum DashMode {
         DesktopMode,
@@ -79,6 +80,8 @@
 
     int hudScreen() const;
 
+    int activeShellScreen() const;
+
     unsigned int lastFocusedWindow() const;
 
     void forceActivateShell(ShellDeclarativeView *shell);
 
=== added directory 'shell/shortcutoverlay'
=== added file 'shell/shortcutoverlay/ModelElement.qml'
--- shell/shortcutoverlay/ModelElement.qml	1970-01-01 00:00:00 +0000
+++ shell/shortcutoverlay/ModelElement.qml	2012-03-29 12:58:23 +0000
@@ -0,0 +1,26 @@
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 1.1
+
+QtObject {
+    property string sectionId
+    property string defaultKey
+    property string gconfKey
+    property string description
+}
 
=== added file 'shell/shortcutoverlay/ShortcutHint.qml'
--- shell/shortcutoverlay/ShortcutHint.qml	1970-01-01 00:00:00 +0000
+++ shell/shortcutoverlay/ShortcutHint.qml	2012-03-29 12:58:23 +0000
@@ -0,0 +1,243 @@
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import QtQuick 1.1
+import Effects 1.0
+import "../common"
+import "../common/utils.js" as Utils
+
+Item {
+    id: shortcutHintOverlay
+    objectName: "shortcutHintOverlay"
+    width: 950
+    height: 660
+    focus: true
+
+    Accessible.name: "Shortcut Hints"
+
+    LayoutMirroring.enabled: Utils.isRightToLeft()
+    LayoutMirroring.childrenInherit: true
+
+    property bool active: false
+    property bool activeTriggerHelper: true
+    property bool reallyActive: active && activeTriggerHelper
+    function trigger()
+    {
+        activeTriggerHelper = false
+        activeTriggerHelper = true
+    }
+
+    BorderImage {
+        id: border
+        smooth: true
+        anchors.fill: parent
+        border { left: 20; top: 20; right: 20; bottom: 20 }
+        source: "artwork/shortcut_hint_borders.png"
+        horizontalTileMode: BorderImage.Repeat
+        verticalTileMode: BorderImage.Repeat
+    }
+
+    /*  Note: ListElement: cannot use script for property value
+        So we can't use u2d.tr for display text directly.
+        Workaround for QML bug : https://bugreports.qt-project.org/browse/QTBUG-16289
+    */
+    property list<ModelElement> leftColumnModel: [
+        ModelElement { sectionId: "launcher"; description: u2d.tr("Launcher") },
+        ModelElement { sectionId: "dash"; description: u2d.tr("Dash") },
+        ModelElement { sectionId: "topBar"; description: u2d.tr("Top Bar") }
+    ]
+
+    property list<ModelElement> rightColumnModel: [
+        ModelElement { sectionId: "switching"; description: u2d.tr("Switching") },
+        ModelElement { sectionId: "workspaces"; description: u2d.tr("Workspaces") },
+        ModelElement { sectionId: "windows"; description: u2d.tr("Windows") }
+    ]
+
+    property list<ModelElement> launcherModel: [
+        ModelElement { defaultKey: "Super (Press)"; description: u2d.tr("Open Launcher, displays shortcuts."); gconfKey: "" },
+        ModelElement { defaultKey: "Alt + F1"; description: u2d.tr("Open Launcher keyboard navigation mode."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + Tab"; description: u2d.tr("Switch applications via Launcher."); gconfKey: ""},
+        ModelElement { defaultKey: "Super + 1 to 9"; description: u2d.tr("Same as clicking on a Launcher icon."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + Shift + 1 to 9"; description: u2d.tr("Open new window of the app."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + T"; description: u2d.tr("Open the Rubbish Bin."); gconfKey: "" }
+    ]
+
+    property list<ModelElement> dashModel: [
+        ModelElement { defaultKey: "Super (Tap)"; description: u2d.tr("Open the Dash home."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + A"; description: u2d.tr("Open the Dash App Lens."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + F"; description: u2d.tr("Open the Dash Files Lens."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + M"; description: u2d.tr("Open the Dash Files Music."); gconfKey: "" },
+        ModelElement { defaultKey: "Ctrl + Tab"; description: u2d.tr("Switches between Lenses."); gconfKey: "" },
+        ModelElement { defaultKey: "Cursors Keys"; description: u2d.tr("Moves the focus."); gconfKey: "" },
+        ModelElement { defaultKey: "Enter / Return"; description: u2d.tr("Open currently focused item."); gconfKey: "" },
+        ModelElement { defaultKey: "Alt + F2"; description: u2d.tr("'Run Command' mode."); gconfKey: "" }
+    ]
+
+    property list<ModelElement> topBarModel: [
+        ModelElement { defaultKey: "Alt"; description: u2d.tr("Reveals application menu."); gconfKey: "" },
+        ModelElement { defaultKey: "Alt + F10"; description: u2d.tr("Open the indicator menu."); gconfKey: "" },
+        ModelElement { defaultKey: "Cursor Left & Right"; description: u2d.tr("Moves focus between indicators."); gconfKey: ""  }
+    ]
+
+    property list<ModelElement> switchingModel: [
+        ModelElement { defaultKey: "Alt + Tab"; description: u2d.tr("Switch between applications."); gconfKey: "/apps/metacity/global_keybindings/switch_windows" },
+        ModelElement { defaultKey: "Alt + Grave"; description: u2d.tr("Switch windows of current application."); gconfKey: "/apps/metacity/global_keybindings/cycle_group" },
+        ModelElement { defaultKey: "Cursor Up"; description: u2d.tr("Close window switch, return to app switch."); gconfKey: "" },
+        ModelElement { defaultKey: "Cursor Left & Right"; description: u2d.tr("Moves the focus."); gconfKey: "" }
+    ]
+
+    property list<ModelElement> workspacesModel: [
+        ModelElement { defaultKey: "Super + S"; description: u2d.tr("Spread workspaces."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + Cursors"; description: u2d.tr("Switch workspaces."); gconfKey: "/apps/metacity/global_keybindings/;switch_to_workspace_down;switch_to_workspace_up;switch_to_workspace_left;switch_to_workspace_right" },
+        ModelElement { defaultKey: "Super + Alt + Cursors"; description: u2d.tr("Move focused window to other workspace."); gconfKey: "/apps/metacity/window_keybindings/;move_to_workspace_down;move_to_workspace_left;move_to_workspace_right;move_to_workspace_up" }
+    ]
+
+    property list<ModelElement> windowModel: [
+        ModelElement { defaultKey: "Super + W"; description: u2d.tr("Spreads all windows in the current workspace."); gconfKey: "" },
+        ModelElement { defaultKey: "Super + D"; description: u2d.tr("Minimizes all windows."); gconfKey: "/apps/metacity/global_keybindings/show_desktop" },
+        ModelElement { defaultKey: "Alt + Space"; description: u2d.tr("Opens window accessibility menu."); gconfKey: "/apps/metacity/window_keybindings/activate_window_menu" },
+        ModelElement { defaultKey: "Alt + F10"; description: u2d.tr("Maximizes or un-maximizes current window."); gconfKey: "/apps/metacity/window_keybindings/toggle_maximized" },
+        ModelElement { defaultKey: "Alt + F9"; description: u2d.tr("Minimizes current window."); gconfKey: "/apps/metacity/window_keybindings/minimize" },
+        ModelElement { defaultKey: "Alt + F8"; description: u2d.tr("Resizes current window."); gconfKey: "/apps/metacity/window_keybindings/begin_resize" },
+        ModelElement { defaultKey: "Alt + F4"; description: u2d.tr("Closes current window."); gconfKey: "/apps/metacity/window_keybindings/close" },
+        ModelElement { defaultKey: "Ctrl + Alt + Num"; description: u2d.tr("Places window in corresponding positions."); gconfKey: "/apps/metacity/window_keybindings/;move_to_corner_ne;move_to_corner_nw;move_to_corner_se;move_to_corner_sw;move_to_side_e;move_to_side_n;move_to_side_s;move_to_side_w" },
+        ModelElement { defaultKey: "Alt + Left Mouse Drag"; description: u2d.tr("Move window."); gconfKey: "" },
+        ModelElement { defaultKey: "Alt + Middle Mouse Drag"; description: u2d.tr("Resize window."); gconfKey: "" }
+    ]
+
+    Rectangle {
+        id: totalArea
+        color: "#00000000"
+        radius: 8
+        smooth: true
+        anchors.fill: parent
+        anchors.margins: 12
+        clip: true
+
+        Item {
+            anchors.fill: parent
+            clip: true
+
+            Image {
+                id: blurredBackground
+                effect: Blur {}
+                source: reallyActive ? "image://window/root" : ""
+                fillMode: Image.PreserveAspectCrop
+                cache: false
+                x: -blurredBackground.mapToItem(null, 0, 0).x-totalArea.anchors.leftMargin
+                y: -blurredBackground.mapToItem(null, 0, 0).y-totalArea.anchors.topMargin-declarativeView.screen.availableGeometry.y
+            }
+
+            Rectangle {
+                anchors.fill: parent
+                color: "#000000"
+                opacity: 0.70
+            }
+        }
+
+        Item {
+            id: headerArea
+            y: 0
+            height: 75
+            anchors.left: parent.left
+            anchors.right: parent.right
+            smooth: false
+
+            TextCustom {
+                id: title
+                x: 350
+                y: 25
+                text: u2d.tr("Keyboard Shortcuts")
+                anchors.bottom: parent.bottom
+                anchors.bottomMargin: 22
+                anchors.horizontalCenterOffset: 0
+                verticalAlignment: Text.AlignTop
+                anchors.horizontalCenter: parent.horizontalCenter
+                smooth: true
+                font.bold: true
+                horizontalAlignment: Text.AlignHCenter
+                fontSize: "x-large"
+            }
+        }
+
+        Item {
+            id: contentsArea
+            anchors.top: headerArea.bottom
+            anchors.right: parent.right
+            anchors.bottom: parent.bottom
+            anchors.left: parent.left
+            anchors.leftMargin: 20
+            anchors.rightMargin: 20
+
+            Rectangle {
+                id: topDivider
+                width: 200
+                height: 1
+                color: "#ffffff"
+                opacity: 0.2
+                smooth: true
+                anchors.left: parent.left
+                anchors.right: parent.right
+                anchors.top: parent.top
+            }
+
+            Item {
+                id: contentLeft
+                anchors.left: parent.left
+                anchors.right: contentCenter.left
+                anchors.top: topDivider.bottom
+                anchors.bottom: parent.bottom
+
+                Column {
+                    id: leftColumn
+                    Repeater {
+                        model: leftColumnModel
+                        ShortcutHintSection {}
+                    }
+                }
+            }
+
+            Item {
+                id: contentCenter
+                x: 438
+                width: 40
+                anchors.top: parent.top
+                anchors.bottom: parent.bottom
+                anchors.horizontalCenter: parent.horizontalCenter
+            }
+
+            Item {
+                id: contentRight
+                x: 445
+                y: 0
+                width: 445
+                anchors.left: contentCenter.right
+                anchors.right: parent.right
+                anchors.top: parent.top
+                anchors.bottom: parent.bottom
+
+                Column {
+                    id: rightColumn
+                    Repeater {
+                        model: rightColumnModel
+                        ShortcutHintSection {}
+                    }
+                }
+            }
+        }
+    }
+}
 
=== added file 'shell/shortcutoverlay/ShortcutHintSection.qml'
--- shell/shortcutoverlay/ShortcutHintSection.qml	1970-01-01 00:00:00 +0000
+++ shell/shortcutoverlay/ShortcutHintSection.qml	2012-03-29 12:58:23 +0000
@@ -0,0 +1,165 @@
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import QtQuick 1.0
+import "../common"
+
+Item {
+    id: shortcutHitSection
+    width: 430
+    height: list.height + sectionTitle.height + sectionTitle.y + bottomSpacing.height + divider.height
+
+    // It is decided by design, that certain keys having multiple values in gconf,
+    // like 'Switch workspaces' should only be displayed when the keys are symmetric.
+    function symmetricKey( gconfKey ) {
+        var gconfKeys = gconfKey.split(";");
+        var previousModifier = ""
+        var count = gconfKeys.length
+        var gconfKey_base = gconfKeys[0]
+        for (var i = 1; i < count; i++) {
+            var gconfItem = Qt.createQmlObject('import gconf 0.1; GConfItem {}', shortcutHintOverlay);
+            gconfItem.key = gconfKey_base+gconfKeys[i]
+            var gconfValue = String(gconfItem.value) 
+            var modifier = gconfValue.substring(0,gconfValue.lastIndexOf(">")+1)
+            var key = gconfValue.substring(gconfValue.lastIndexOf(">")+1)
+            if (previousModifier == "") {
+                previousModifier = gconfValue.substring(0,gconfValue.lastIndexOf(">")+1)
+                continue
+            } else {
+                if (modifier != previousModifier) {
+                    return ""
+                }
+            }
+        }
+
+        if (key.toLowerCase().indexOf("kp") == 0){
+            previousModifier = previousModifier + "Num"
+        } else {
+            previousModifier = previousModifier + "Cursors"
+        }
+
+        return previousModifier;
+    }
+
+    Component {
+        id: itemDelegate
+        Item {
+            anchors.right: parent.right
+            anchors.left: parent.left
+
+            function getShortcutKey() {
+                if (model.modelData.gconfKey === "") {
+                    return model.modelData.defaultKey;
+                }
+
+                var key = ""
+                // Check is symmetric
+                if (gconfKey.indexOf(";") != -1) {
+                    key = symmetricKey(gconfKey);
+                    if (key == "") {
+                        return ""
+                    }
+                } else {
+                    var gconfItem = Qt.createQmlObject('import gconf 0.1; GConfItem {}', shortcutHintOverlay);
+                    gconfItem.key = gconfKey
+                    key = gconfItem.value
+                }
+
+                key = String(key)
+                if (key === "") {
+                    return model.modelData.defaultKey
+                }
+
+                key = key.replace(new RegExp( "<Control>", 'gi' ), "Ctrl + ")
+                key = key.replace(new RegExp( "<Shift>", 'gi' ), "Shift + ")
+                key = key.replace(new RegExp( "<Primary>", 'gi' ), "")
+                key = key.replace(new RegExp( "<Alt>", 'gi' ), "Alt + ")
+                key = key.replace(new RegExp( "<Mod4>", 'gi' ), "Super + ")
+                key = key.replace(new RegExp( "<Super>", 'gi' ), "Super + ")
+                key = key.replace(new RegExp( "KP_", 'gi' ), "Num")
+                key = key.replace( /(^|\s)([a-z])/g , function(m,p1,p2){ return p1+p2.toUpperCase(); } );
+                return key
+            }
+
+            Item {
+                id: key
+                anchors.left: parent.left
+                anchors.leftMargin: 0
+                width: 150
+                TextCustom { id: keyText; text: getShortcutKey(); fontSize: "small" }
+            }
+
+            Item {
+                id: spacing
+                anchors.left: key.right
+                width: 10
+            }
+
+            Item {
+                id: value
+                width: 265
+                anchors.left: spacing.right
+                TextCustom { text: model.modelData.description; fontSize: "small" }
+            }
+        }
+    }
+
+    TextCustom {
+        id: sectionTitle
+        y: 27
+        text: model.modelData.description
+        anchors.left: parent.left
+        font.bold: true
+        fontSize: "large"
+    }
+
+    ListView {
+        id: list
+        model: {
+            if (sectionId == "launcher") return launcherModel
+            else if (sectionId == "dash") return dashModel
+            else if (sectionId == "topBar") return topBarModel
+            else if (sectionId == "switching") return switchingModel
+            else if (sectionId == "workspaces") return workspacesModel
+            else if (sectionId == "windows") return windowModel
+            else return ""
+        }
+        spacing: 18
+        anchors.left: parent.left
+        anchors.top: sectionTitle.bottom
+        anchors.topMargin: 14
+        height: (spacing * count) + anchors.topMargin
+        delegate: itemDelegate
+    }
+
+    Item {
+        id: bottomSpacing
+        height: 20
+    }
+
+    Rectangle {
+        id: divider
+        height: 1
+        color: "#ffffff"
+        smooth: true
+        anchors.top: shortcutHitSection.bottom
+        anchors.right: parent.right
+        anchors.left: parent.left
+        opacity: 0.2
+        visible: (index != 2)
+    }
+}
 
=== added directory 'shell/shortcutoverlay/artwork'
=== added file 'shell/shortcutoverlay/artwork/shortcut_hint_borders.png'
 Binary files shell/shortcutoverlay/artwork/shortcut_hint_borders.png	1970-01-01 00:00:00 +0000 and shell/shortcutoverlay/artwork/shortcut_hint_borders.png	2012-03-29 12:58:23 +0000 differ
=== added file 'tests/shell/shortcut-hint-overlay-tests.rb'
--- tests/shell/shortcut-hint-overlay-tests.rb	1970-01-01 00:00:00 +0000
+++ tests/shell/shortcut-hint-overlay-tests.rb	2012-03-29 12:58:23 +0000
@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+require '../run-tests.rb' unless $INIT_COMPLETED
+require 'xdo/xwindow'
+require 'xdo/keyboard'
+
+############################# Test Suite #############################
+context "Launcher Shortcut hint overlay Tests" do
+  # Run once at the beginning of this test suite
+  startup do
+    $SUT.execute_shell_command 'killall unity-2d-shell'
+    $SUT.execute_shell_command 'killall unity-2d-shell'
+
+    # Minimize all windows
+    XDo::XWindow.toggle_minimize_all
+  end
+
+  # Run once at the end of this test suite
+  shutdown do
+  end
+
+  # Run before each test case begins
+  setup do
+    # Execute the application
+    @app = $SUT.run( :name => UNITY_2D_SHELL,
+                     :arguments => "-testability",
+                     :sleeptime => 2 )
+    # Make certain application is ready for testing
+    verify{ @app.Launcher() }
+  end
+
+  # Run after each test case completes
+  teardown do
+    $SUT.execute_shell_command 'pkill -nf unity-2d-shell'
+  end
+
+  #####################################################################################
+  # Test cases
+    # Test case objectives:
+    #   * Check shortcut hint overlay display/close
+    # Pre-conditions
+    #   * None
+    # Test steps
+    #   * Hold super key
+    #   * Check the shortcut hint overlay is displayed
+    #   * Release super key
+    #   * Check that shortcut hint overlay is closed
+    # Post-conditions
+    #   * None
+    # References
+    #   * lp:#855532
+  test "Check shortcut hint overlay display/close" do
+    # Check the hint window is not displayed initially
+    verify_not(TIMEOUT, 'Shortcut hint overlay should be closed, but visible') {
+        @app.ShellDeclarativeView().ShortcutHint();
+    }
+
+    XDo::Keyboard.key_down('SUPER')
+    # Check the hint window is displayed when 'super' is pressed
+    verify(TIMEOUT, 'Shortcut hint overlay should be displayed, but it is not') {
+        @app.ShellDeclarativeView().ShortcutHint();
+    }
+
+    XDo::Keyboard.key_up('SUPER')
+    # Check the hint window is closed when 'super' is released
+    verify_not(TIMEOUT, 'Shortcut hint overlay should be closed, but visible') {
+        @app.ShellDeclarativeView().ShortcutHint();
+    }
+  end
+end