Merge lp:~jjed/unity/tooltips-redux into lp:unity

[Jjed]

Add a 1s delay between hovering on a launcher icon and showing its tooltip.
Further tooltips before clicking or unhovering launcher will appear instantly.

== Problem

There is currently no delay between hovering on a Launcher icon and displaying its tooltip.

This proposal supercedes the (long defunct) lp:~j-johan-edwards/unity/tooltip-delay/ merge proposal.

== Fix implementation

I've removed the ability of `LauncherIcon` to prompt its own tooltip display. Instead, a new object `TooltipManager`
(notified of events by a monitor's `Launcher`) controls launcher tooltip logic according to a `_hover_timer` which resets on mouse movement. A `LauncherIcon` may refuse to display based on its local condition (eg if it is the BFB and active, or being dragged).

Clicking an icon causes its tooltip to disappear, and the `_hover_clock` to be "locked" until the mouse moves to another icon. This behavior feels right to me (as otherwise tooltips appear while you hover over an app you just clicked, waiting for it to open) but I'm open to changing it.

Tooltip delay is 1s per lp:#687956. Let me know if the design has changed.

== Testing

There are three new autopilot tests in `test_tooltips`. Dash tooltip behavior is further tested in `test_icon_behavior`.

`autopilot run unity.tests.launcher` passes. I have only one monitor.

== Old feedback

I'm using `assertTrue` in my tooltips test because the behavior tested is time-specific, and `assertThat(.... Eventually(Equals(bool))` doesn't distinguish between instantaneous and delayed tooltip display. Maybe there's some other way...?

[Stephen M. Webb (bregma)]

(1) Please fix the copyright dates in the new source files.
(2) Please do not prepend an underscore wart to indicate a member variable: the Unity style is to use appended underscore warts.
(3) You need to add a commit message to this MP.

Other than that, this seems OK.

review: Needs Fixing

[Jjed (jjed)]

I believe that should fix them. Thanks for the quick review!

review: Needs Resubmitting

[Andrea Azzarone (azzar1)]

+#define NULL_ICON (AbstractLauncherIcon::Ptr)nullptr

Don't do this please :)

314 +void TooltipManager::StopTimer() {
315 + hover_timer_.reset(new glib::Timeout(TOOLTIPS_SHOW_TIMEOUT_LENGTH));
316 +}

Is this the right way to stop the timeout?

Also I think you can unit test the new class ;)

[Jjed (jjed)]

> Don't do this please :)

Okay, removed.

> Is this the right way to stop the timeout?

It seems to be (you can `grep -R "reset(new glib::Timeout" to see similar uses). `hover_timer_->Remove() would also stop it, but then I'd just need add the same line afterwards to set a new timeout.

> Also I think you can unit test the new class

Okay, added. There's not much to test, as the modules only interaction with the outside world is calling `icon_->ShowTooltip()` and `icon_->HideTooltip()`. Tell me if there are any other test cases you'd like to see.

[Marco Trevisan (Treviño) (3v1n0)]

324 +void TooltipManager::StopTimer() {
325 + hover_timer_.reset(new glib::Timeout(TOOLTIPS_SHOW_TIMEOUT_LENGTH));
326 +}

Please just call hover_timer_.reset();

Then when you need to start it again, reset it to a new one.

[Andrea Azzarone (azzar1)]

> > Don't do this please :)
>
> Okay, removed.
>
> > Is this the right way to stop the timeout?
>
> It seems to be (you can `grep -R "reset(new glib::Timeout" to see similar
> uses). `hover_timer_->Remove() would also stop it, but then I'd just need add
> the same line afterwards to set a new timeout.

hover_timer_->reset() should just work.

>
> > Also I think you can unit test the new class
>
> Okay, added. There's not much to test, as the modules only interaction with
> the outside world is calling `icon_->ShowTooltip()` and
> `icon_->HideTooltip()`. Tell me if there are any other test cases you'd like
> to see.

[Jjed (jjed)]

Okay, that works (and does fewer glib::Timeout allocations too).

[Marco Trevisan (Treviño) (3v1n0)]

81 + SetIconUnderMouse((AbstractLauncherIcon::Ptr)nullptr);

Please pass an empty icon PTR to the function as it expects:
SetIconUnderMouse(AbstractLauncherIcon::Ptr());

245 + : show_tooltips_(false)
246 + , hovered_(false)
247 + , icon_(nullptr)
248 + , icon_clicked_(false)

This is pure style, but we use 2-spaces to indent initialization list, also you don't need to initialize the icon_ at all.

366 +class TooltipManager : public sigc::trackable

You don't need sigc::trackable, but you probably want this to be non-copyable instead.

371 + void SetHover(bool on_launcher);

What about a nux::Property<bool> for this?

258 + if (show_tooltips_) {

Please add a space after the if statements (so that the brace is on the new line)

539 + tm.SetIcon((AbstractLauncherIcon::Ptr)icon);

Pass to it an icon ptr: tm.SetIcon(AbstractLauncherIcon::Ptr(icon));

[Jjed (jjed)]

Okay, changed most of that.

> 371 + void SetHover(bool on_launcher);
>
> What about a nux::Property<bool> for this?

I don't think that makes sense, given that `hover_` is private and the TooltipMannager doesn't need any internal hooks for when it changes. LauncherHoverMachine already has a signal for changing hover-state as well.

[Marco Trevisan (Treviño) (3v1n0)]

Cool, this is fine now..

Stephen, are you ok now with removing the "Needs fixing" flag? :)

review: Approve

[Stephen M. Webb (bregma)]

Looks good.

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

[Adolfo Jayme Barrientos (fitojb)]

As Launcher icons don't visually change at all when hovered with the mouse, Unity again feels so sluggish/unresponsive, that I have to wonder if it has freezed. I reported that as bug 1152390.

=== modified file 'launcher/AbstractLauncherIcon.h'
--- launcher/AbstractLauncherIcon.h	2013-02-22 10:55:18 +0000
+++ launcher/AbstractLauncherIcon.h	2013-03-05 21:56:20 +0000
@@ -135,6 +135,7 @@
   nux::Property<Position> position;
   nux::Property<bool> removed;
 
+  virtual void ShowTooltip() = 0;
   virtual void HideTooltip() = 0;
 
   virtual void    SetShortcut(guint64 shortcut) = 0;
 
=== modified file 'launcher/CMakeLists.txt'
--- launcher/CMakeLists.txt	2012-12-19 20:53:12 +0000
+++ launcher/CMakeLists.txt	2013-03-05 21:56:20 +0000
@@ -57,6 +57,7 @@
      SoftwareCenterLauncherIcon.cpp
      SpacerLauncherIcon.cpp
      Tooltip.cpp
+     TooltipManager.cpp
      TrashLauncherIcon.cpp
      VolumeImp.cpp
      VolumeLauncherIcon.cpp
 
=== modified file 'launcher/Launcher.cpp'
--- launcher/Launcher.cpp	2013-03-05 15:59:56 +0000
+++ launcher/Launcher.cpp	2013-03-05 21:56:20 +0000
@@ -286,6 +286,21 @@
   _hide_machine.SetQuirk(LauncherHideMachine::MOUSE_OVER_LAUNCHER, over_launcher);
   _hide_machine.SetQuirk(LauncherHideMachine::REVEAL_PRESSURE_PASS, false);
   _hover_machine.SetQuirk(LauncherHoverMachine::MOUSE_OVER_LAUNCHER, over_launcher);
+  tooltip_manager_.SetHover(over_launcher);
+}
+
+void Launcher::SetIconUnderMouse(AbstractLauncherIcon::Ptr const& icon)
+{
+  if (_icon_under_mouse == icon)
+    return;
+
+  if (_icon_under_mouse)
+    _icon_under_mouse->mouse_leave.emit(monitor);
+  if (icon)
+    icon->mouse_enter.emit(monitor);
+
+  _icon_under_mouse = icon;
+  tooltip_manager_.SetIcon(icon);
 }
 
 bool Launcher::MouseBeyondDragThreshold() const
@@ -1603,8 +1618,7 @@
   if (icon->needs_redraw_connection.connected())
     icon->needs_redraw_connection.disconnect();
 
-  if (icon == _icon_under_mouse)
-    _icon_under_mouse = nullptr;
+  SetIconUnderMouse(AbstractLauncherIcon::Ptr());
   if (icon == _icon_mouse_down)
     _icon_mouse_down = nullptr;
   if (icon == _drag_icon)
@@ -1923,11 +1937,7 @@
   // if we are still waiting…
   if (GetActionState() == ACTION_NONE)
   {
-    if (_icon_under_mouse)
-    {
-      _icon_under_mouse->mouse_leave.emit(monitor);
-      _icon_under_mouse = nullptr;
-    }
+    SetIconUnderMouse(AbstractLauncherIcon::Ptr());
     _initial_drag_animation = true;
     StartIconDragRequest(x, y);
   }
@@ -2166,11 +2176,7 @@
       GetActionState() == ACTION_NONE)
     return;
 
-  if (_icon_under_mouse)
-  {
-    _icon_under_mouse->mouse_leave.emit(monitor);
-    _icon_under_mouse = nullptr;
-  }
+  SetIconUnderMouse(AbstractLauncherIcon::Ptr());
 
   if (GetActionState() == ACTION_NONE)
   {
@@ -2222,6 +2228,7 @@
 void Launcher::RecvMouseMove(int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags)
 {
   SetMousePosition(x, y);
+  tooltip_manager_.MouseMoved();
 
   if (!_hidden)
     UpdateChangeInMousePosition(dx, dy);
@@ -2370,18 +2377,7 @@
     launcher_icon = MouseIconIntersection(_mouse_position.x, _mouse_position.y);
   }
 
-
-  if (_icon_under_mouse && (_icon_under_mouse != launcher_icon))
-  {
-    _icon_under_mouse->mouse_leave.emit(monitor);
-    _icon_under_mouse = nullptr;
-  }
-
-  if (launcher_icon && (_icon_under_mouse != launcher_icon))
-  {
-    launcher_icon->mouse_enter.emit(monitor);
-    _icon_under_mouse = launcher_icon;
-  }
+  SetIconUnderMouse(launcher_icon);
 }
 
 void Launcher::MouseDownLogic(int x, int y, unsigned long button_flags, unsigned long key_flags)
@@ -2396,6 +2392,7 @@
     sources_.AddTimeout(START_DRAGICON_DURATION, cb_func, START_DRAGICON_TIMEOUT);
 
     launcher_icon->mouse_down.emit(nux::GetEventButton(button_flags), monitor, key_flags);
+    tooltip_manager_.IconClicked();
   }
 }
 
 
=== modified file 'launcher/Launcher.h'
--- launcher/Launcher.h	2013-03-05 14:30:46 +0000
+++ launcher/Launcher.h	2013-03-05 21:56:20 +0000
@@ -42,6 +42,7 @@
 #include "unity-shared/MockableBaseWindow.h"
 #include "unity-shared/UBusWrapper.h"
 #include "SoftwareCenterLauncherIcon.h"
+#include "TooltipManager.h"
 
 #ifdef USE_X11
 # include "PointerBarrier.h"
@@ -223,6 +224,7 @@
   bool OnScrollTimeout();
 
   void SetMousePosition(int x, int y);
+  void SetIconUnderMouse(AbstractLauncherIcon::Ptr const& icon);
 
   void SetStateMouseOverLauncher(bool over_launcher);
 
@@ -389,6 +391,7 @@
   nux::ObjectPtr<LauncherDragWindow> _drag_window;
   LauncherHideMachine _hide_machine;
   LauncherHoverMachine _hover_machine;
+  TooltipManager tooltip_manager_;
 
   unity::DndData _dnd_data;
   nux::DndAction _drag_action;
 
=== modified file 'launcher/LauncherIcon.cpp'
--- launcher/LauncherIcon.cpp	2013-02-22 10:55:18 +0000
+++ launcher/LauncherIcon.cpp	2013-03-05 21:56:20 +0000
@@ -528,23 +528,12 @@
 LauncherIcon::RecvMouseEnter(int monitor)
 {
   _last_monitor = monitor;
-  if (QuicklistManager::Default()->Current())
-  {
-    // A quicklist is active
-    return;
-  }
-
-  ShowTooltip();
 }
 
 void LauncherIcon::RecvMouseLeave(int monitor)
 {
   _last_monitor = -1;
   _allow_quicklist_to_show = true;
-
-  if (_tooltip)
-    _tooltip->ShowWindow(false);
-  tooltip_visible.emit(nux::ObjectPtr<nux::View>(nullptr));
 }
 
 bool LauncherIcon::OpenQuicklist(bool select_first_item, int monitor)
 
=== modified file 'launcher/MockLauncherIcon.h'
--- launcher/MockLauncherIcon.h	2012-11-28 22:00:12 +0000
+++ launcher/MockLauncherIcon.h	2013-03-05 21:56:20 +0000
@@ -68,6 +68,7 @@
     , type_(type)
     , sort_priority_(DefaultPriority(type))
     , remote_uri_("fake")
+    , is_tooltip_visible_(false)
   {
     tooltip_text = "Mock Icon";
     position = Position::FLOATING;
@@ -80,7 +81,9 @@
 
   void AddProperties(GVariantBuilder* builder) {}
 
-  void HideTooltip() {}
+  void ShowTooltip() { is_tooltip_visible_ = true; }
+  void HideTooltip() { is_tooltip_visible_ = false; }
+  bool IsTooltipVisible() { return is_tooltip_visible_; }
 
   void    SetShortcut(guint64 shortcut) {}
 
@@ -366,6 +369,7 @@
   timespec quirk_times_[unsigned(Quirk::LAST)];
   std::map<int, nux::Point3> center_;
   std::string remote_uri_;
+  bool is_tooltip_visible_;
 };
 
 }
 
=== added file 'launcher/TooltipManager.cpp'
--- launcher/TooltipManager.cpp	1970-01-01 00:00:00 +0000
+++ launcher/TooltipManager.cpp	2013-03-05 21:56:20 +0000
@@ -0,0 +1,126 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * 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.
+ *
+ * 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/>.
+ *
+ * Authored by: Jacob Edwards <[e-mail]>
+ */
+
+#include "TooltipManager.h"
+
+namespace unity
+{
+namespace launcher
+{
+
+namespace
+{
+const unsigned int TOOLTIPS_SHOW_TIMEOUT_LENGTH = 1000;
+}
+
+TooltipManager::TooltipManager()
+  : show_tooltips_(false)
+  , hovered_(false)
+  , timer_locked_(false)
+{}
+
+void TooltipManager::SetIcon(AbstractLauncherIcon::Ptr const& newIcon)
+{ 
+  if (icon_ == newIcon)
+    return;
+
+  // Unlock hover timer, in case the previous icon had no valid tooltip
+  timer_locked_ = false;
+ 
+  if (show_tooltips_)
+  {
+    // Show new tooltip, get rid of the old olne
+    if (icon_)
+      icon_->HideTooltip();
+    if (newIcon)
+      newIcon->ShowTooltip();
+  }
+  else if (!newIcon)
+  {
+    // Stop the hover timer for null launcher space
+    StopTimer();
+  }
+  else
+  { 
+    AbstractLauncherIcon::IconType type = newIcon->GetIconType();
+    if ((type == AbstractLauncherIcon::IconType::HOME ||
+         type == AbstractLauncherIcon::IconType::HUD) &&
+         newIcon->GetQuirk(AbstractLauncherIcon::Quirk::ACTIVE))
+    {
+      // Lock the hover timer for no valid tooltip cases
+      timer_locked_ = true;
+      StopTimer();
+    }
+  }
+
+  icon_ = newIcon;
+}
+
+void TooltipManager::SetHover(bool on_launcher)
+{ 
+  if (hovered_ == on_launcher)
+    return;
+  hovered_ = on_launcher;
+
+  if (show_tooltips_ && !hovered_)
+  {
+    show_tooltips_ = false;
+    if (icon_)
+      icon_->HideTooltip();
+  }
+}
+
+void TooltipManager::MouseMoved()
+{
+  if (!icon_ || show_tooltips_)
+    return;
+
+  ResetTimer();
+}
+
+void TooltipManager::IconClicked()
+{
+  StopTimer();
+  if (show_tooltips_ && icon_)
+    icon_->HideTooltip();
+
+  show_tooltips_ = false;
+  timer_locked_ = true;
+}
+
+void TooltipManager::ResetTimer()
+{
+  if (timer_locked_)
+    return;
+
+  hover_timer_.reset(new glib::Timeout(TOOLTIPS_SHOW_TIMEOUT_LENGTH));
+  hover_timer_->Run([&] () {
+    show_tooltips_ = true;
+    icon_->ShowTooltip();
+    return false;
+  });
+}
+
+void TooltipManager::StopTimer()
+{
+  hover_timer_.reset();
+}
+
+} // namespace launcher
+} // namespace unity
 
=== added file 'launcher/TooltipManager.h'
--- launcher/TooltipManager.h	1970-01-01 00:00:00 +0000
+++ launcher/TooltipManager.h	2013-03-05 21:56:20 +0000
@@ -0,0 +1,57 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * 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.
+ *
+ * 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/>.
+ *
+ * Authored by: Jacob Edwards <[e-mail]>
+ */
+
+#ifndef TOOLTIPMANAGER
+#define TOOLTIPMANAGER
+
+#include <boost/noncopyable.hpp>
+#include <UnityCore/GLibSource.h>
+
+#include "AbstractLauncherIcon.h"
+
+namespace unity
+{
+namespace launcher
+{
+
+class TooltipManager : public boost::noncopyable
+{
+public:
+  TooltipManager();
+
+  void SetHover(bool on_launcher);
+  void SetIcon(AbstractLauncherIcon::Ptr const& newIcon);
+  void MouseMoved();
+  void IconClicked();
+
+private:
+  void ResetTimer();
+  void StopTimer();
+
+  bool                      show_tooltips_;
+  bool                      hovered_;
+  AbstractLauncherIcon::Ptr icon_;
+  glib::Source::UniquePtr   hover_timer_;
+  bool                      timer_locked_;
+};
+
+} // namespace launcher
+} // namespace unity 
+
+#endif
 
=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2013-03-05 03:21:11 +0000
+++ tests/CMakeLists.txt	2013-03-05 21:56:20 +0000
@@ -250,6 +250,7 @@
                  test_texture_cache.cpp
                  test_text_input.cpp
                  test_thumbnail_generator.cpp
+                 test_tooltip_manager.cpp
                  test_trash_launcher_icon.cpp
                  test_launcher_minimize_speed.cpp
                  test_unity_settings.cpp
 
=== added file 'tests/autopilot/unity/tests/launcher/test_tooltips.py'
--- tests/autopilot/unity/tests/launcher/test_tooltips.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/unity/tests/launcher/test_tooltips.py	2013-03-05 21:56:20 +0000
@@ -0,0 +1,87 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+# Authors: Jacob Edwards
+#
+# 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 autopilot.matchers import Eventually
+from testtools.matchers import Equals
+from time import sleep
+
+from unity.tests.launcher import LauncherTestCase, _make_scenarios
+
+class LauncherTooltipTests(LauncherTestCase):
+    """Tests whether tooltips display only at appropriate times."""
+
+    def setUp(self):
+        super(LauncherTooltipTests, self).setUp()
+        self.set_unity_option('launcher_hide_mode', 0)
+        self.launcher_instance.move_mouse_to_right_of_launcher()
+        self.icons = self.unity.launcher.model.get_launcher_icons(visible_only=True)
+
+    def test_launcher_tooltip_show(self):
+        """Tests whether icon tooltips delay showing themselves and,
+        once shown, whether subsequent icons show them instantly."""
+        for i in self.icons:
+            tooltip = i.get_tooltip()
+            if not tooltip:
+                continue
+            self.assertThat(tooltip.active, Eventually(Equals(False)))
+
+        # only reveal tooltips after short wait
+        self.assertEqual(self.get_reveal_behavior(self.icons[0]), self.DELAYED)
+
+        # subsequent tooltips reveal instantly, but hide on exit
+        a, b = 0, 1
+        while b < len(self.icons):
+            self.mouse.move(self.icons[b].center_x, self.icons[b].center_y)
+            self.assertTrue(self.icons[b].get_tooltip().active)
+            self.assertFalse(self.icons[a].get_tooltip().active)
+            a, b = a + 1, b + 1
+        b -= 1
+
+        # leaving launcher clears tooltips, and instant reveal
+        self.launcher_instance.move_mouse_to_right_of_launcher()
+        self.assertEqual(self.get_reveal_behavior(self.icons[b]), self.DELAYED)
+
+    def test_launcher_tooltip_disabling(self):
+        """Tests whether clicking on an icon hides its tooltip."""
+        bfb, other = self.icons[0], self.icons[1]
+        self.assertEqual(self.get_reveal_behavior(bfb), self.DELAYED)
+
+        # clicking icon hides its launcher until further input
+        self.mouse.click()
+        self.assertEqual(self.get_reveal_behavior(bfb), self.NEVER)
+        self.mouse.click()
+
+        # normal behavior resumes on moving away from icon
+        self.assertEqual(self.get_reveal_behavior(other), self.DELAYED)
+        self.assertEqual(self.get_reveal_behavior(bfb), self.INSTANT)
+
+    def test_launcher_bfb_tooltip_when_open(self):
+        """Tests whether hovering over the active BFB starts a tooltip timer"""
+        self.unity.dash.ensure_visible()
+        self.addCleanup(self.unity.dash.ensure_hidden)
+        bfb, other = self.icons[0], self.icons[1]
+
+        # hovering an open dash's BFB does not show a tooltip ...
+        self.assertEqual(self.get_reveal_behavior(bfb), self.NEVER)
+
+        # ... nor did it timeout instant tooltips for other icons
+        self.assertEqual(self.get_reveal_behavior(other), self.DELAYED)
+
+    # Tooltip reveal types
+    (INSTANT, DELAYED, NEVER) = range(3)
+
+    def get_reveal_behavior(self, icon):
+        self.mouse.move(icon.center_x, icon.center_y)
+        tooltip = icon.get_tooltip()
+        if tooltip and tooltip.active:
+            return self.INSTANT
+        sleep(1.2)
+        tooltip = icon.get_tooltip()
+        if tooltip and tooltip.active:
+            return self.DELAYED
+        return self.NEVER
 
=== added file 'tests/test_tooltip_manager.cpp'
--- tests/test_tooltip_manager.cpp	1970-01-01 00:00:00 +0000
+++ tests/test_tooltip_manager.cpp	2013-03-05 21:56:20 +0000
@@ -0,0 +1,54 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 2013 Canonical Ltd
+ *
+ * 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.
+ *
+ * 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/>.
+ *
+ * Authored by: Jacob Edwards <[e-mail]>
+ */
+
+#include <gtest/gtest.h>
+using namespace testing;
+
+#include "launcher/TooltipManager.h"
+#include "launcher/MockLauncherIcon.h"
+#include "test_utils.h"
+
+namespace unity
+{
+namespace launcher
+{
+
+namespace
+{
+
+TEST(TestTooltipManager, TestHideAndShowTooltip)
+{
+  // Makes sure that TooltipManager calls icon->ShowTooltip() when the mouse
+  // hovers it, and icon->HideTooltip() after the mouse dehovers it.
+  TooltipManager tm;
+  MockLauncherIcon* icon = new MockLauncherIcon();
+
+  tm.SetIcon(AbstractLauncherIcon::Ptr(icon));
+  tm.MouseMoved();
+  Utils::WaitForTimeoutMSec(1050);
+
+  EXPECT_TRUE(icon->IsTooltipVisible());
+  tm.SetIcon(AbstractLauncherIcon::Ptr());
+  EXPECT_FALSE(icon->IsTooltipVisible());
+}
+
+}
+
+} // launcher
+} // unity