Merge lp:~3v1n0/unity/shortcut-hint-escaping into lp:unity

[Marco Trevisan (Treviño)]

Add support to hide the shortcut hint view by Escape key.

I've made some work to handle the Escape keypress events for both the Launcher
Switcher and the Shortcut hint view, using this policy:
 - If the Launcher switcher is active, Escape terminates it
 - If the Shortcut hint is active, Escape terminates it
 - If both are active, the first Escape terminates the Super+Tab,
   the second one will hide the shortcut hint.

Added autopilot support for the Shortcut hint controller, and a first bunch of tests.

[Thomi Richards (thomir-deactivatedaccount)]

Tests look good to me!

review: Approve

[Andrea Azzarone (azzar1)]

Code looks good to me

review: Approve

=== modified file 'manual-tests/SuperTab.txt'
--- manual-tests/SuperTab.txt	2012-02-29 16:58:59 +0000
+++ manual-tests/SuperTab.txt	2012-03-06 02:02:19 +0000
@@ -22,29 +22,6 @@
   neeeded.
 
 
-Super Tab switcher interaction with Shortcut Hint
--------------------------------------------------
-This test shows the interaction between the shortcut hint overlay and the
-Super+Tab switcher.
-
-#. Start with a clean screen
-#. Press Super to make the shortcuts-overlay to show
-#. Then press Tab to initiate the Super+Tab launcher switcher
-
-Outcome:
-  The Super+Tab switcher is initialized, and the shortcut hint overlay is still
-  showing. Pressing also Shift to reverse the switcher direction doesn't hide
-  the overlay, that will be hidden once Super is released.
-
-#. Start with a clean screen
-#. Press Super+Tab quickly to make the launcher switcher to initialize without
-   making the shortcut overlay to show.
-
-Outcome:
-  Super+Tab switcher is initialized and the shortcut hint overlay is not shown
-  even keeping only super pressed until releasing it and pressing it again.
-
-
 Escaping from Super Tab switcher
 --------------------------------
 This test shows how to escape from the Super+Tab switcher.

=== modified file 'plugins/unityshell/src/ShortcutController.cpp'
--- plugins/unityshell/src/ShortcutController.cpp	2012-02-07 07:42:12 +0000
+++ plugins/unityshell/src/ShortcutController.cpp	2012-03-06 02:02:19 +0000
@@ -28,6 +28,7 @@
 namespace
 {
 const unsigned int SUPER_TAP_DURATION = 650;
+const unsigned int FADE_DURATION = 100;
 } // anonymouse namespace;
   
 Controller::Controller(std::list<AbstractHint*>& hints)
@@ -35,8 +36,8 @@
   , visible_(false)
   , enabled_(true)
   , show_timer_(0)
-  , fade_in_animator_(100)
-  , fade_out_animator_(100)
+  , fade_in_animator_(FADE_DURATION)
+  , fade_out_animator_(FADE_DURATION)
 {
   bg_color_ = nux::Color(0.0, 0.0, 0.0, 0.5);
 
@@ -185,16 +186,18 @@
     
   visible_ = false;
 
+  if (show_timer_)
+  {
+    g_source_remove(show_timer_);
+    show_timer_ = 0;
+  }
+
   if (view_window_)
   {
     view_->SetupBackground(false);
     fade_in_animator_.Stop();
     fade_out_animator_.Start(1.0 - view_window_->GetOpacity());
   }
-
-  if (show_timer_)
-    g_source_remove(show_timer_);
-  show_timer_ = 0;
 }
 
 bool Controller::Visible()
@@ -212,5 +215,21 @@
   enabled_ = enabled;
 }
 
+std::string Controller::GetName() const
+{
+  return "ShortcutController";
+}
+
+void Controller::AddProperties(GVariantBuilder* builder)
+{
+  unity::variant::BuilderWrapper(builder)
+  .add(workarea_)
+  .add("timeout_duration", SUPER_TAP_DURATION + FADE_DURATION)
+  .add("enabled", IsEnabled())
+  .add("about_to_show", (Visible() && !fade_out_animator_.IsRunning() && view_window_->GetOpacity() != 1.0f))
+  .add("about_to_hide", (Visible() && !fade_in_animator_.IsRunning() && view_window_->GetOpacity() != 1.0f))
+  .add("visible", (Visible() && view_window_ && view_window_->GetOpacity() == 1.0f));
+}
+
 } // namespace shortcut
 } // namespace unity

=== modified file 'plugins/unityshell/src/ShortcutController.h'
--- plugins/unityshell/src/ShortcutController.h	2012-01-15 14:58:57 +0000
+++ plugins/unityshell/src/ShortcutController.h	2012-03-06 02:02:19 +0000
@@ -25,8 +25,10 @@
 #include <Nux/BaseWindow.h>
 #include <Nux/HLayout.h>
 #include <NuxCore/Color.h>
+#include <UnityCore/Variant.h>
 
 #include "Animator.h"
+#include "Introspectable.h"
 #include "ShortcutModel.h"
 #include "ShortcutView.h"
 #include "UBusWrapper.h"
@@ -36,7 +38,7 @@
 namespace shortcut
 {
 
-class Controller
+class Controller : public debug::Introspectable
 {
 public:
   typedef std::shared_ptr<Controller> Ptr;
@@ -55,6 +57,10 @@
   void SetWorkspace(nux::Geometry const& geo);
   void SetEnabled(bool enabled);
 
+protected:
+  std::string GetName() const;
+  void AddProperties(GVariantBuilder* builder);
+
 private:
   // Private Methods
   void ConstructView();

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-03-04 23:58:44 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-03-06 02:02:19 +0000
@@ -866,22 +866,24 @@
               geo.height);
 }
 
-void UnityScreen::EnableCancelAction(bool enabled, int modifiers)
+void UnityScreen::EnableCancelAction(CancelActionTarget target, bool enabled, int modifiers)
 {
   if (enabled)
   {
-    /* Create a new keybinding for the Escape key and the current modifiers */
+    /* Create a new keybinding for the Escape key and the current modifiers,
+     * compiz will take of the ref-counting of the repeated actions */
     CompAction::KeyBinding binding(9, modifiers);
 
-    _escape_action = CompActionPtr(new CompAction());
-    _escape_action->setKey(binding);
+    CompActionPtr &escape_action = _escape_actions[target];
+    escape_action = CompActionPtr(new CompAction());
+    escape_action->setKey(binding);
 
-    screen->addAction(_escape_action.get());
+    screen->addAction(escape_action.get());
   }
-  else if (!enabled && _escape_action.get())
+  else if (!enabled && _escape_actions[target].get())
   {
-    screen->removeAction(_escape_action.get());
-    _escape_action = nullptr;
+    screen->removeAction(_escape_actions[target].get());
+    _escape_actions.erase(target);
   }
 }
 
@@ -1333,7 +1335,7 @@
       if (super_keypressed_)
       {
         launcher_controller_->KeyNavTerminate(false);
-        EnableCancelAction(false);
+        EnableCancelAction(CancelActionTarget::LAUNCHER_SWITCHER, false);
       }
       break;
     case KeyPress:
@@ -1347,17 +1349,23 @@
         // we should just say "key_string[1] = 0" because that is the only
         // thing that could possibly make sense here.
         key_string[result] = 0;
-        if (super_keypressed_ && key_sym != XK_Escape)
+        if (super_keypressed_)
         {
-          g_idle_add([] (gpointer data) -> gboolean {
-            auto self = static_cast<UnityScreen*>(data);
-            if (!self->launcher_controller_->KeyNavIsActive())
-            {
-              self->shortcut_controller_->SetEnabled(false);
-              self->shortcut_controller_->Hide();
-            }
-            return FALSE;
-          }, this);
+          if (key_sym != XK_Escape || (key_sym == XK_Escape && !launcher_controller_->KeyNavIsActive()))
+          {
+            /* We need an idle to postpone this action, after the current event
+             * has been processed */
+            g_idle_add([] (gpointer data) -> gboolean {
+              auto self = static_cast<UnityScreen*>(data);
+              if (!self->launcher_controller_->KeyNavIsActive())
+              {
+                self->shortcut_controller_->SetEnabled(false);
+                self->shortcut_controller_->Hide();
+                self->EnableCancelAction(CancelActionTarget::SHORTCUT_HINT, false);
+              }
+              return FALSE;
+            }, this);
+          }
 
           skip_other_plugins = launcher_controller_->HandleLauncherKeyEvent(screen->dpy(), key_sym, event->xkey.keycode, event->xkey.state, key_string);
           if (!skip_other_plugins)
@@ -1366,7 +1374,7 @@
           if (skip_other_plugins && launcher_controller_->KeyNavIsActive())
           {
             launcher_controller_->KeyNavTerminate(false);
-            EnableCancelAction(false);
+            EnableCancelAction(CancelActionTarget::LAUNCHER_SWITCHER, false);
           }
         }
       }
@@ -1507,7 +1515,10 @@
     }
 
     if (last_geo.x > monitor_geo.x and last_geo.y > monitor_geo.y)
+    {
+      EnableCancelAction(CancelActionTarget::SHORTCUT_HINT, true, action->key().modifiers());
       shortcut_controller_->Show();
+    }
    }
 
   return true;
@@ -1521,14 +1532,15 @@
     return false;
 
   bool was_tap = state & CompAction::StateTermTapped;
-
   super_keypressed_ = false;
   launcher_controller_->KeyNavTerminate(true);
   launcher_controller_->HandleLauncherKeyRelease(was_tap);
-  EnableCancelAction(false);
+  EnableCancelAction(CancelActionTarget::LAUNCHER_SWITCHER, false);
 
   shortcut_controller_->SetEnabled(enable_shortcut_overlay_);
   shortcut_controller_->Hide();
+  EnableCancelAction(CancelActionTarget::SHORTCUT_HINT, false);
+
   action->setState (action->state() & (unsigned)~(CompAction::StateTermKey));
   return true;
 }
@@ -1743,7 +1755,7 @@
   if (!launcher_controller_->KeyNavIsActive())
   {
     launcher_controller_->KeyNavActivate();
-    EnableCancelAction(true, action->key().modifiers());
+    EnableCancelAction(CancelActionTarget::LAUNCHER_SWITCHER, true, action->key().modifiers());
   }
   else
   {
@@ -1764,7 +1776,7 @@
   bool accept_state = (state & CompAction::StateCancel) == 0;
   launcher_controller_->KeyNavTerminate(accept_state);
 
-  EnableCancelAction(false);
+  EnableCancelAction(CancelActionTarget::LAUNCHER_SWITCHER, false);
   action->setState (action->state() & (unsigned)~(CompAction::StateTermKey));
   return true;
 }
@@ -2637,6 +2649,7 @@
   // Setup Shortcut Hint
   InitHints();
   shortcut_controller_.reset(new shortcut::Controller(hints_));
+  AddChild(shortcut_controller_.get());
 
   AddChild(dash_controller_.get());
 

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2012-02-22 09:28:47 +0000
+++ plugins/unityshell/src/unityshell.h	2012-03-06 02:02:19 +0000
@@ -236,13 +236,19 @@
   void AddProperties(GVariantBuilder* builder);
 
 private:
+  enum CancelActionTarget
+  {
+    LAUNCHER_SWITCHER,
+    SHORTCUT_HINT
+  };
+
   void initAltTabNextWindow ();
 
   void SendExecuteCommand();
 
   void EnsureSuperKeybindings();
   void CreateSuperNewAction(char shortcut, impl::ActionModifiers flag);
-  void EnableCancelAction(bool enabled, int modifiers = 0);
+  void EnableCancelAction(CancelActionTarget target, bool enabled, int modifiers = 0);
 
   static gboolean initPluginActions(gpointer data);
   void initLauncher();
@@ -294,7 +300,7 @@
   typedef std::vector<CompActionPtr> ShortcutActions;
   ShortcutActions _shortcut_actions;
   bool            super_keypressed_;
-  CompActionPtr   _escape_action;
+  std::map<CancelActionTarget, CompActionPtr> _escape_actions;
 
   /* keyboard-nav mode */
   CompWindow* newFocusedWindow;

=== modified file 'tests/autopilot/autopilot/emulators/X11.py'
--- tests/autopilot/autopilot/emulators/X11.py	2012-03-01 20:16:50 +0000
+++ tests/autopilot/autopilot/emulators/X11.py	2012-03-06 02:02:19 +0000
@@ -323,6 +323,9 @@
         """Get the number of monitors attached to the PC."""
         return self._default_screen.get_n_monitors()
 
+    def get_primary_monitor(self):
+        return self._default_screen.get_primary_monitor()
+
     def get_screen_width(self):
         return self._default_screen.get_width()
 

=== added file 'tests/autopilot/autopilot/emulators/unity/shortcut_hint.py'
--- tests/autopilot/autopilot/emulators/unity/shortcut_hint.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/autopilot/emulators/unity/shortcut_hint.py	2012-03-06 02:02:19 +0000
@@ -0,0 +1,44 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2012 Canonical
+# Author: Marco Trevisan (Treviño)
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+
+import logging
+
+from autopilot.keybindings import KeybindingsHelper
+from autopilot.emulators.unity import UnityIntrospectionObject
+
+
+logger = logging.getLogger(__name__)
+
+
+class ShortcutController(UnityIntrospectionObject, KeybindingsHelper):
+    """ShortcutController proxy class."""
+
+    def show(self):
+        logger.debug("Revealing shortcut hint with keyboard.")
+        self.keybinding_hold("shortcuthint/reveal")
+
+    def hide(self):
+        logger.debug("Un-revealing shortcut hint with keyboard.")
+        self.keybinding_release("shortcuthint/reveal")
+
+    def cancel(self):
+        logger.debug("Hide the shortcut hint with keyboard, without releasing the reveal key.")
+        self.keybinding("shortcuthint/cancel")
+
+    def get_geometry(self):
+        return (self.x, self.y, self.width, self.height)
+
+    def get_show_timeout(self):
+        return self.timeout_duration / 1000.0
+
+    def is_enabled(self):
+        return bool(self.enabled)
+
+    def is_visible(self):
+        return bool(self.visible)

=== modified file 'tests/autopilot/autopilot/keybindings.py'
--- tests/autopilot/autopilot/keybindings.py	2012-03-04 10:18:08 +0000
+++ tests/autopilot/autopilot/keybindings.py	2012-03-06 02:02:19 +0000
@@ -68,6 +68,9 @@
     "switcher/reveal_details": "Alt+`",
     "switcher/reveal_all": ("unityshell", "alt_tab_forward_all"),
     "switcher/cancel": "Escape",
+    # Shortcut Hint:
+    "shortcuthint/reveal": ('unityshell', 'show_launcher'),
+    "shortcuthint/cancel": "Escape",
     # These are in compiz as 'Alt+Right' and 'Alt+Left', but the fact that it
     # lists the Alt key won't work for us, so I'm defining them manually.
     "switcher/next": "Tab",
@@ -85,6 +88,9 @@
     "workspace/move_down": ("wall", "down_key"),
     # Window management
     "window/minimize": ("core", "minimize_window_key"),
+    # expo plugin:
+    "expo/start": ("expo", "expo_key"),
+    "expo/cancel": "Escape",
 }
 
 

=== modified file 'tests/autopilot/autopilot/tests/test_launcher.py'
--- tests/autopilot/autopilot/tests/test_launcher.py	2012-03-04 23:12:19 +0000
+++ tests/autopilot/autopilot/tests/test_launcher.py	2012-03-06 02:02:19 +0000
@@ -69,6 +69,19 @@
         sleep(.5)
         self.assertThat(self.launcher.key_nav_is_active, Equals(False))
 
+    def test_launcher_switcher_escape_works(self):
+        """Test that ending the launcher switcher actually works."""
+        sleep(.5)
+        launcher_instance = self.get_launcher()
+        launcher_instance.start_switcher()
+        self.addCleanup(launcher_instance.end_switcher, True)
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active(), Equals(True))
+        sleep(.25)
+        self.keyboard.press_and_release("Escape")
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active(), Equals(False))
+
     def test_launcher_switcher_next_works(self):
         """Moving to the next launcher item while switcher is activated must work."""
         sleep(.5)

=== added file 'tests/autopilot/autopilot/tests/test_shortcut_hint.py'
--- tests/autopilot/autopilot/tests/test_shortcut_hint.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/autopilot/tests/test_shortcut_hint.py	2012-03-06 02:02:19 +0000
@@ -0,0 +1,322 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2012 Canonical
+# Authors: Marco Trevisan (Treviño)
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+from testtools.matchers import Equals
+from time import sleep
+
+from autopilot.tests import AutopilotTestCase
+from autopilot.emulators.unity.shortcut_hint import ShortcutController
+from autopilot.emulators.X11 import ScreenGeometry
+
+
+class BaseShortcutHintTests(AutopilotTestCase):
+    """Base class for the shortcut hint tests"""
+
+    def setUp(self):
+        super(BaseShortcutHintTests, self).setUp()
+
+        self.DEFAULT_WIDTH = 970;
+        self.DEFAULT_HEIGHT = 680;
+
+        self.shortcut_hint = self.get_shortcut_controller()
+        self.set_unity_option('shortcut_overlay', True)
+        self.skip_if_monitor_too_small()
+        sleep(1)
+
+    def skip_if_monitor_too_small(self):
+        screen = ScreenGeometry();
+        monitor = screen.get_primary_monitor()
+        monitor_geo = screen.get_monitor_geometry(monitor);
+        monitor_w = monitor_geo[2];
+        monitor_h = monitor_geo[3];
+        launcher_width = self.launcher.get_launcher_for_monitor(monitor).geometry[2];
+        panel_height = 24 # TODO get it from panel
+
+        if ((monitor_w - launcher_width) <= self.DEFAULT_WIDTH or
+            (monitor_h - panel_height) <= self.DEFAULT_HEIGHT):
+            self.skipTest("This test requires a bigger screen, to show the ShortcutHint")
+
+    def get_shortcut_controller(self):
+        controllers = ShortcutController.get_all_instances()
+        self.assertThat(len(controllers), Equals(1))
+        return controllers[0]
+
+    def get_launcher(self):
+        # We could parameterise this so all tests run on both monitors (if MM is
+        # set up), but I think it's fine to just always use monitor primary monitor:
+        screen = ScreenGeometry();
+        monitor = screen.get_primary_monitor()
+        return self.launcher.get_launcher_for_monitor(monitor)
+
+
+class ShortcutHintTests(BaseShortcutHintTests):
+    """Test the shortcuthint."""
+
+    def test_shortcut_hint_reveal(self):
+        """Test that the shortcut hint is shown."""
+        sleep(.5)
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+        sleep(2)
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+    def test_shortcut_hint_reveal_timeout(self):
+        """Test that the shortcut hint is shown when it should."""
+        sleep(.5)
+        timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(timeout/2.0)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+        sleep(timeout/2.0)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+    def test_shortcut_hint_unreveal(self):
+        """Test that the shortcut hint is hidden when it should."""
+        sleep(.5)
+        self.shortcut_hint.show()
+        sleep(self.shortcut_hint.get_show_timeout())
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+        sleep(.25)
+
+        self.shortcut_hint.hide()
+        sleep(.25)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+    def test_shortcut_hint_cancel(self):
+        """Test that the shortcut hint is shown when requested."""
+        sleep(.5)
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+        sleep(self.shortcut_hint.get_show_timeout())
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+        sleep(.25)
+
+        self.shortcut_hint.cancel()
+        sleep(.25)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+        sleep(self.shortcut_hint.get_show_timeout())
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+    def test_shortcut_hint_geometries(self):
+        """Test that the shortcut hint has the wanted geometries."""
+        sleep(.5)
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+        sleep(self.shortcut_hint.get_show_timeout())
+
+        (x, y, w, h) = self.shortcut_hint.get_geometry()
+        self.assertThat(w, Equals(self.DEFAULT_WIDTH))
+        self.assertThat(h, Equals(self.DEFAULT_HEIGHT))
+
+
+class ShortcutHintInteractionsTests(BaseShortcutHintTests):
+    """Test the shortcuthint interactions with other Unity parts."""
+
+    def test_shortcut_hint_hide_using_unity_shortcuts(self):
+        """Test that the shortcut hints is hidden pressing unity shortcuts."""
+        sleep(.5)
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+        sleep(self.shortcut_hint.get_show_timeout())
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+        self.keybinding_tap("expo/start")
+        self.addCleanup(self.keybinding, "expo/cancel")
+        sleep(.25)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+        sleep(.25)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+    def test_launcher_switcher_next_doesnt_show_shortcut_hint(self):
+        """Moving forward in launcher switcher must not show the shortcut hint."""
+        sleep(.5)
+        switcher_timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(switcher_timeout * 0.2)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+        self.keybinding("launcher/switcher/next")
+        sleep(.25)
+
+        self.keybinding("launcher/switcher/next")
+        self.addCleanup(self.keyboard.press_and_release, "Escape")
+        sleep(switcher_timeout * 2)
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+    def test_launcher_switcher_prev_doesnt_show_shortcut_hint(self):
+        """Moving backward in launcher switcher must not show the shortcut hint."""
+        sleep(.5)
+        switcher_timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(switcher_timeout * 0.2)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+        self.keybinding("launcher/switcher/next")
+        self.addCleanup(self.keyboard.press_and_release, "Escape")
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active, Equals(True))
+
+        self.keybinding("launcher/switcher/next")
+        sleep(.25)
+
+        self.keybinding("launcher/switcher/prev")
+        sleep(switcher_timeout)
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+    def test_launcher_switcher_next_keeps_shortcut_hint(self):
+        """Moving forward in launcher switcher after the shortcut hint has been
+        shown must keep the shortcuts there.
+
+        """
+        sleep(.5)
+        show_timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(show_timeout)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+        launcher = self.g()
+        launcher.start_switcher()
+        self.addCleanup(launcher.end_switcher, True)
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active, Equals(True))
+
+        launcher.switcher_next()
+        sleep(.25)
+        launcher.switcher_next()
+        sleep(show_timeout)
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+    def test_launcher_switcher_prev_keeps_shortcut_hint(self):
+        """Moving backward in launcher switcher after the shortcut hint has been
+        shown must keep the shortcuts there.
+
+        """
+        sleep(.5)
+        show_timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(show_timeout)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+        launcher = self.get_launcher()
+        launcher.start_switcher()
+        self.addCleanup(launcher.end_switcher, True)
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active, Equals(True))
+
+        launcher.switcher_prev()
+        sleep(.25)
+        launcher.switcher_prev()
+        sleep(show_timeout)
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+    def test_launcher_switcher_cancel_doesnt_hide_shortcut_hint(self):
+        """Cancelling the launcher switcher (by Escape) should not hide the
+        shortcut hint view.
+
+        """
+        sleep(.5)
+        show_timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(show_timeout)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+        launcher = self.get_launcher()
+        launcher.start_switcher()
+        self.addCleanup(launcher.end_switcher, True)
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active, Equals(True))
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+        launcher.switcher_next()
+        sleep(.25)
+        self.keyboard.press_and_release("Escape")
+        sleep(.25)
+
+        self.assertThat(self.launcher.key_nav_is_active, Equals(False))
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+        sleep(.5)
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+    def test_launcher_switcher_and_shortcut_hint_escaping(self):
+        """Cancelling the launcher switcher (by Escape) should not hide the
+        shortcut hint view, an extra keypress is needed.
+
+        """
+        sleep(.5)
+        show_timeout = self.shortcut_hint.get_show_timeout()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+
+        sleep(show_timeout)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+        launcher = self.get_launcher()
+        launcher.start_switcher()
+        self.addCleanup(launcher.end_switcher, True)
+        sleep(.25)
+        self.assertThat(self.launcher.key_nav_is_active(), Equals(True))
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+
+        launcher.switcher_next()
+        sleep(.25)
+        self.keyboard.press_and_release("Escape")
+        sleep(.25)
+
+        self.assertThat(self.launcher.key_nav_is_active(), Equals(False))
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+        sleep(.25)
+
+        self.shortcut_hint.cancel()
+        sleep(.25)
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(False))
+
+    def test_launcher_icons_hints_show_with_shortcut_hint(self):
+        """When the shortcut hint is shown also the launcer's icons hints should
+        be shown.
+
+        """
+        launcher = self.get_launcher()
+        self.shortcut_hint.show()
+        self.addCleanup(self.shortcut_hint.hide)
+        sleep(self.shortcut_hint.get_show_timeout())
+
+
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))
+        self.assertThat(launcher.are_shortcuts_showing(), Equals(True))
+
+    def test_shortcut_hint_shows_with_launcher_icons_hints(self):
+        """When the launcher icons hints are shown also the shortcut hint should
+        be shown.
+
+        """
+        launcher = self.get_launcher()
+        launcher.keyboard_reveal_launcher()
+        self.addCleanup(launcher.keyboard_unreveal_launcher)
+        sleep(1)
+
+        self.assertThat(launcher.are_shortcuts_showing(), Equals(True))
+        self.assertThat(self.shortcut_hint.is_visible(), Equals(True))