Merge lp:~azzar1/unity/fix-978030 into lp:unity

[Andrea Azzarone]

Disable the bfb/hudlaunchericon tooltip when the dash/hud is open.

== Problem ==
Dash - search field is hidden by tooltips

== Fix ==
Disable the bfb/hudlaunchericon tooltip when the dash/hud is open.
Hide a launcher icon tooltip as soon as the dash/hud is shown.

== Test ==
2 AP tests added. The tooltip class is empty for the moment.

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

Code and tests look good, please include a small test also for the HudLauncherIcon ;)

review: Approve

=== modified file 'plugins/unityshell/src/AbstractLauncherIcon.h'
--- plugins/unityshell/src/AbstractLauncherIcon.h	2012-04-25 00:32:14 +0000
+++ plugins/unityshell/src/AbstractLauncherIcon.h	2012-04-27 10:33:25 +0000
@@ -119,6 +119,7 @@
   virtual ~AbstractLauncherIcon() {}
 
   nux::Property<std::string> tooltip_text;
+  nux::Property<bool> tooltip_enabled;
 
   virtual void HideTooltip() = 0;
 
 
=== modified file 'plugins/unityshell/src/BFBLauncherIcon.cpp'
--- plugins/unityshell/src/BFBLauncherIcon.cpp	2012-04-19 22:46:07 +0000
+++ plugins/unityshell/src/BFBLauncherIcon.cpp	2012-04-27 10:33:25 +0000
@@ -65,6 +65,7 @@
 
   if (overlay_identity.Str() == "dash" && IsVisibleOnMonitor(overlay_monitor))
   {
+    tooltip_enabled = !visible;
     SetQuirk(QUIRK_ACTIVE, visible);
     EmitNeedsRedraw();
   }
 
=== modified file 'plugins/unityshell/src/HudLauncherIcon.cpp'
--- plugins/unityshell/src/HudLauncherIcon.cpp	2012-04-24 13:22:42 +0000
+++ plugins/unityshell/src/HudLauncherIcon.cpp	2012-04-27 10:33:25 +0000
@@ -101,6 +101,7 @@
     SetMonitor(overlay_monitor);
     SetQuirk(QUIRK_VISIBLE, visible);
     SetQuirk(QUIRK_ACTIVE, visible);
+    tooltip_enabled = !visible;
     EmitNeedsRedraw();
   }
 }
 
=== modified file 'plugins/unityshell/src/Launcher.cpp'
--- plugins/unityshell/src/Launcher.cpp	2012-04-24 22:21:03 +0000
+++ plugins/unityshell/src/Launcher.cpp	2012-04-27 10:33:25 +0000
@@ -1340,7 +1340,7 @@
   gint32 overlay_monitor = 0;
   g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING,
                 &overlay_identity, &can_maximise, &overlay_monitor);
-  std::string identity = overlay_identity.Str();
+  std::string identity(overlay_identity.Str());
 
   LOG_DEBUG(logger) << "Overlay shown: " << identity
                     << ", " << (can_maximise ? "can maximise" : "can't maximise")
@@ -1366,6 +1366,9 @@
       LOG_DEBUG(logger) << "Desaturate on monitor " << monitor();
       DesaturateIcons();
     }
+
+    if (_icon_under_mouse)
+      _icon_under_mouse->HideTooltip();
   }
   EnsureAnimation();
 }
 
=== modified file 'plugins/unityshell/src/LauncherIcon.cpp'
--- plugins/unityshell/src/LauncherIcon.cpp	2012-04-24 18:09:33 +0000
+++ plugins/unityshell/src/LauncherIcon.cpp	2012-04-27 10:33:25 +0000
@@ -99,6 +99,9 @@
   for (int i = 0; i < max_num_monitors; ++i)
     _is_visible_on_monitor[i] = true;
 
+  tooltip_enabled = true;
+  tooltip_enabled.changed.connect(sigc::mem_fun(this, &LauncherIcon::OnTooltipEnabledChanged));
+
   tooltip_text.SetSetterFunction(sigc::mem_fun(this, &LauncherIcon::SetTooltipText));
   tooltip_text = "blank";
 
@@ -481,6 +484,12 @@
   return result;
 }
 
+void LauncherIcon::OnTooltipEnabledChanged(bool value)
+{
+  if (!value)
+    HideTooltip();
+}
+
 void
 LauncherIcon::SetShortcut(guint64 shortcut)
 {
@@ -499,7 +508,7 @@
 void
 LauncherIcon::ShowTooltip()
 {
-  if (_quicklist && _quicklist->IsVisible())
+  if (!tooltip_enabled || (_quicklist && _quicklist->IsVisible()))
     return;
 
   int tip_x = 100;
 
=== modified file 'plugins/unityshell/src/LauncherIcon.h'
--- plugins/unityshell/src/LauncherIcon.h	2012-04-24 22:21:03 +0000
+++ plugins/unityshell/src/LauncherIcon.h	2012-04-27 10:33:25 +0000
@@ -324,6 +324,8 @@
   void LoadTooltip();
   void LoadQuicklist();
 
+  void OnTooltipEnabledChanged(bool value);
+
   bool              _remote_urgent;
   float             _present_urgency;
   float             _progress;
 
=== modified file 'tests/autopilot/autopilot/emulators/unity/icons.py'
--- tests/autopilot/autopilot/emulators/unity/icons.py	2012-04-24 13:14:52 +0000
+++ tests/autopilot/autopilot/emulators/unity/icons.py	2012-04-27 10:33:25 +0000
@@ -9,6 +9,7 @@
 
 from autopilot.emulators.unity import UnityIntrospectionObject
 from autopilot.emulators.unity.quicklist import Quicklist
+from autopilot.emulators.unity.tooltip import ToolTip
 
 class SimpleLauncherIcon(UnityIntrospectionObject):
     """Holds information about a simple launcher icon.
@@ -33,6 +34,16 @@
         matches = self.get_children_by_type(Quicklist)
         return matches[0] if matches else None
 
+    def get_tooltip(self):
+        """Get the tooltip for this launcher icon.
+
+        This may return None, if there is no tooltip associated with this
+        launcher icon.
+
+        """
+        matches = self.get_children_by_type(ToolTip)
+        return matches[0] if matches else None
+
     def is_on_monitor(self, monitor):
         """Returns True if the icon is available in the defined monitor"""
         if monitor >= 0 and monitor < len(self.monitors_visibility):
 
=== added file 'tests/autopilot/autopilot/emulators/unity/tooltip.py'
--- tests/autopilot/autopilot/emulators/unity/tooltip.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/autopilot/emulators/unity/tooltip.py	2012-04-27 10:33:25 +0000
@@ -0,0 +1,20 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2012 Canonical
+# Author: Andrea Azzarone
+#
+# 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 time import sleep
+
+from autopilot.emulators.unity import UnityIntrospectionObject
+
+
+logger = logging.getLogger(__name__)
+
+
+class ToolTip(UnityIntrospectionObject):
+    """Represents a tooltip."""
 
=== modified file 'tests/autopilot/autopilot/tests/test_launcher.py'
--- tests/autopilot/autopilot/tests/test_launcher.py	2012-04-26 06:44:00 +0000
+++ tests/autopilot/autopilot/tests/test_launcher.py	2012-04-27 10:33:25 +0000
@@ -717,3 +717,31 @@
         x_fin, y_fin = self.mouse.position()
         # The launcher should have held the mouse a little bit
         self.assertThat(x_fin, LessThan(x + width * 1.5))
+
+
+class LauncherTooltipTests(AutopilotTestCase):
+    """Test the launcher tooltips"""
+
+    def setUp(self):
+        super(LauncherTooltipTests, self).setUp()
+        self.set_unity_option('launcher_hide_mode', 0)
+
+    def test_bfb_tooltip_disappear_when_dash_is_opened(self):
+         """Tests that the bfb tooltip disappear when the dash is opened."""
+         bfb = self.launcher.model.get_bfb_icon()
+         self.mouse.move(bfb.center_x, bfb.center_y)
+
+         self.dash.ensure_visible()
+         self.addCleanup(self.dash.ensure_hidden)
+
+         self.assertThat(bfb.get_tooltip().active, Eventually(Equals(False)))
+
+    def test_bfb_tooltip_is_disabled_when_dash_is_open(self):
+         """Tests the that bfb tooltip is disabled when the dash is open."""
+         self.dash.ensure_visible()
+         self.addCleanup(self.dash.ensure_hidden)
+
+         bfb = self.launcher.model.get_bfb_icon()
+         self.mouse.move(bfb.center_x, bfb.center_y)
+
+         self.assertThat(bfb.get_tooltip().active, Eventually(Equals(False)))