Merge lp:~thumper/unity/lock-out-hud into lp:unity

[Tim Penhey]

Adapt the HUD visuals to look nice with a locked out launcher.

Changes the behaviour of the HUD/Launcher interaction in HideMode: Never

= The Problem =
See: https://bugs.launchpad.net/ayatana-design/+bug/921506

= The Fix =
Modify the Launcher to accept a new LauncherIcon that will listen to a UBUS message dictating its icon

= Testing =
Manual test included, lock-out behaviour is not included in out AP tests so ensuring a valid AP test seems non trivial at this point, requires an AP test module that can modify compiz options

See http://people.canonical.com/~tim/hud.ogv

[Tim Penhey (thumper)]

Actually adding an autopilot test for this is trivial.

What we can do is to run the HUD AP tests with the launcher in each state, locked out and auto-hide. We already do something like this for launchers for each monitor. I'll tackle the HUD tests with thomi tomorrow.

[Didier Roche-Tolomelli (didrocks)]

we want that for this release isn't it? can someone review it and merge it with the manual test if anyone has the AP test for it?

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

This has some conflicts with trunk, also you're using some lambda functions to connect to sigc::signal's, but in that case you need to disconnect from them in destructor or use a sigc::mem_fun instead (this doesn't apply to the ubus callback functions, of course).

Plus, I'm not sure if that's wanted, but if enabling the launcher's audohide feature, when closing the HUD, the launcher reveals and then closes again.

42 + if (!g_strcmp0(overlay_identity, "hud"))

Why not using overlay_identity.Str() == "hud" ?

 launcher_width.changed.connect([this] (int new_width) { Relayout(); });

I guess you can just pass [&] and please follow what said above. Even if the hud view shouldn't be destroyed, I guess it's better to stay safe.

review: Needs Fixing

[Tim Penhey (thumper)]

As well as the launcher popping out when you close the hud, if you do the following:
  press Alt
  press Super

You get the dash with a hidden launcher.

Also, you get a peaking icon when you start the hud with a hidden launcher.

I'm fixing these now. I have a branch that fixes everything so far except making sure the icon saturation is right at the right time.

[Tim Penhey (thumper)]

Also worth noting I guess, this branch doesn't fix the bug around the icon size for the hud when you don't have a fixed launcher.

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

Interactions look good to me now.

We should add AP tests to check also that the launcher status change only as it should when using the HUD...

review: Approve

[Gord Allott (gordallott)]

+1, but technically I'm reviewing the changes Tim made to my code. I also give my code +1 but i may be bias :)

review: Approve

[Tim Penhey (thumper)]

On 21/03/12 23:07, Gord Allott wrote:
> Review: Approve
>
> +1, but technically I'm reviewing the changes Tim made to my code. I also give my code +1 but i may be bias :)

I approved of Gord's work, and extended. So we should have this covered :)

[Gord Allott (gordallott)]

Mr Cimitan is happy with the design, so approving

review: Approve

[Andrea Cimitan (cimi)]

I am fine with the design as a first iteration, two stuffs I noticed and I ask to fix for 12.04:
1) animation of bfb->icon when launcher is on (maybe designers need to provide a desired solution)
2) there's a duplicated separator line between the hud rectangle and the launcher http://i.imgur.com/xgV0L.png
3) the hud icon is using two different tiles when the launcher is on (bfb-like) and the launcher is hidden (normal tile)

[Andrea Cimitan (cimi)]

three stuffs, of course I can count. welcome back from holiday cimi.

[Andrea Cimitan (cimi)]

updated screenshot of issue 2) http://i.imgur.com/zYxJ8.png

[Didier Roche-Tolomelli (didrocks)]

I reverted the branch in trunk, see bug #961169

=== modified file 'manual-tests/Hud.txt'
--- manual-tests/Hud.txt	2012-03-20 14:00:00 +0000
+++ manual-tests/Hud.txt	2012-03-21 04:27:19 +0000
@@ -56,6 +56,20 @@
   After pressing escape in step three, the text "test" should be removed from the hud search
   After step four, the hud should dismiss itself and not be present.
 
+Hud Reveal Behaviour
+---------
+This test ensures that the hud behaves correctly with a locked out launcher
+
+#. Ensure the launchers hide mode is set to "Never"
+#. Tap Alt
+
+Outcome
+  The Launcher should stick be locked out.
+  The Launcher icons should be desaturated.
+  The top most Launcher icon should be an icon related the the focused window
+  The BFB should not be present
+
+
 Hud Sending Undo
 ----------------
 This test ensure that the undo action is properly handle in a text editor.

=== modified file 'plugins/unityshell/src/BFBLauncherIcon.cpp'
--- plugins/unityshell/src/BFBLauncherIcon.cpp	2012-03-20 10:18:20 +0000
+++ plugins/unityshell/src/BFBLauncherIcon.cpp	2012-03-21 04:27:19 +0000
@@ -32,9 +32,10 @@
 
 UBusManager BFBLauncherIcon::ubus_manager_;
 
-BFBLauncherIcon::BFBLauncherIcon()
+BFBLauncherIcon::BFBLauncherIcon(LauncherHideMode hide_mode)
  : SimpleLauncherIcon()
  , reader_(dash::LensDirectoryReader::GetDefault())
+ , launcher_hide_mode_(hide_mode)
 {
   tooltip_text = _("Dash Home");
   icon_name = PKGDATADIR"/launcher_bfb.png";
@@ -45,6 +46,31 @@
   background_color_ = nux::color::White;
 
   mouse_enter.connect([&](int m) { ubus_manager_.SendMessage(UBUS_DASH_ABOUT_TO_SHOW, NULL); });
+  ubus_manager_.RegisterInterest(UBUS_OVERLAY_SHOWN, sigc::bind(sigc::mem_fun(this, &BFBLauncherIcon::OnOverlayShown), true));
+  ubus_manager_.RegisterInterest(UBUS_OVERLAY_HIDDEN, sigc::bind(sigc::mem_fun(this, &BFBLauncherIcon::OnOverlayShown), false));
+}
+
+void BFBLauncherIcon::SetHideMode(LauncherHideMode hide_mode)
+{
+  launcher_hide_mode_ = hide_mode;
+}
+
+void BFBLauncherIcon::OnOverlayShown(GVariant *data, bool visible)
+{
+  unity::glib::String overlay_identity;
+  gboolean can_maximise = FALSE;
+  gint32 overlay_monitor = 0;
+  g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING,
+                &overlay_identity, &can_maximise, &overlay_monitor);
+
+
+  // If the hud is open, we hide the BFB iff we have a locked launcher
+  if (!g_strcmp0(overlay_identity, "hud") &&
+      launcher_hide_mode_ == LAUNCHER_HIDE_NEVER)
+  {
+    SetQuirk(QUIRK_VISIBLE, !visible);
+    EmitNeedsRedraw();
+  }
 }
 
 nux::Color BFBLauncherIcon::BackgroundColor()

=== modified file 'plugins/unityshell/src/BFBLauncherIcon.h'
--- plugins/unityshell/src/BFBLauncherIcon.h	2012-02-22 08:53:20 +0000
+++ plugins/unityshell/src/BFBLauncherIcon.h	2012-03-21 04:27:19 +0000
@@ -24,6 +24,7 @@
 
 #include <UnityCore/FilesystemLenses.h>
 
+#include "LauncherOptions.h"
 #include "UBusWrapper.h"
 
 namespace unity
@@ -35,23 +36,26 @@
 {
 
 public:
-  BFBLauncherIcon();
+  BFBLauncherIcon(LauncherHideMode hide_mode);
 
   virtual nux::Color BackgroundColor();
   virtual nux::Color GlowColor();
 
   void ActivateLauncherIcon(ActionArg arg);
+  void SetHideMode(LauncherHideMode hide_mode);
 
 protected:
   std::list<DbusmenuMenuitem*> GetMenus();
   std::string GetName() const;
 
 private:
+  void OnOverlayShown(GVariant *data, bool visible);
   static void OnMenuitemActivated(DbusmenuMenuitem* item, int time, gchar* lens);
 
   static unity::UBusManager ubus_manager_;
   nux::Color background_color_;
   dash::LensDirectoryReader::Ptr reader_;
+  LauncherHideMode launcher_hide_mode_;
 };
 
 }

=== modified file 'plugins/unityshell/src/HudController.cpp'
--- plugins/unityshell/src/HudController.cpp	2012-03-20 10:27:41 +0000
+++ plugins/unityshell/src/HudController.cpp	2012-03-21 04:27:19 +0000
@@ -39,7 +39,7 @@
 }
 
 Controller::Controller()
-  : launcher_width(66)
+  : launcher_width(65)
   , hud_service_("com.canonical.hud", "/com/canonical/hud")
   , window_(nullptr)
   , visible_(false)
@@ -47,6 +47,7 @@
   , timeline_id_(0)
   , last_opacity_(0.0f)
   , start_time_(0)
+  , launcher_is_locked_out_(false)
   , view_(nullptr)
 {
   LOG_DEBUG(logger) << "hud startup";
@@ -69,6 +70,8 @@
     }
   });
 
+  launcher_width.changed.connect([this] (int new_width) { Relayout(); });
+
   PluginAdapter::Default()->compiz_screen_ungrabbed.connect(sigc::mem_fun(this, &Controller::OnScreenUngrabbed));
 
   hud_service_.queries_updated.connect(sigc::mem_fun(this, &Controller::OnQueriesFinished));
@@ -154,17 +157,23 @@
 
 nux::Geometry Controller::GetIdealWindowGeometry()
 {
-   UScreen *uscreen = UScreen::GetDefault();
-   int primary_monitor = uscreen->GetMonitorWithMouse();
-   auto monitor_geo = uscreen->GetMonitorGeometry(primary_monitor);
+  UScreen *uscreen = UScreen::GetDefault();
+  int primary_monitor = uscreen->GetMonitorWithMouse();
+  auto monitor_geo = uscreen->GetMonitorGeometry(primary_monitor);
 
-   // We want to cover as much of the screen as possible to grab any mouse events outside
-   // of our window
-   panel::Style &panel_style = panel::Style::Instance();
-   return nux::Geometry (monitor_geo.x,
-                         monitor_geo.y + panel_style.panel_height,
-                         monitor_geo.width,
-                         monitor_geo.height - panel_style.panel_height);
+  // We want to cover as much of the screen as possible to grab any mouse events outside
+  // of our window
+  panel::Style &panel_style = panel::Style::Instance();
+  nux::Geometry geo(monitor_geo.x,
+                       monitor_geo.y + panel_style.panel_height,
+                       monitor_geo.width,
+                       monitor_geo.height - panel_style.panel_height);
+  if (launcher_is_locked_out_)
+  {
+    geo.x += launcher_width;
+    geo.width -= launcher_width;
+  }
+  return geo;
 }
 
 void Controller::Relayout(GdkScreen*screen)
@@ -224,6 +233,16 @@
   return visible_;
 }
 
+void Controller::SetLauncherIsLockedOut(bool launcher_is_locked_out)
+{
+  launcher_is_locked_out_ = launcher_is_locked_out;
+  if (launcher_is_locked_out_)
+    view_->SetHideIcon(IconHideState::HIDE);
+  else
+    view_->SetHideIcon(IconHideState::SHOW);
+  Relayout();
+}
+
 void Controller::ShowHud()
 {
   PluginAdapter* adaptor = PluginAdapter::Default();
@@ -248,6 +267,7 @@
   focused_app_icon_ = view_icon.Str();
 
   LOG_DEBUG(logger) << "Taking application icon: " << focused_app_icon_;
+  ubus.SendMessage(UBUS_HUD_ICON_CHANGED, g_variant_new_string(focused_app_icon_.c_str())); 
   view_->SetIcon(focused_app_icon_);
 
   window_->ShowWindow(true);
@@ -275,6 +295,7 @@
   nux::GetWindowCompositor().SetKeyFocusArea(view_->default_focus());
   window_->SetEnterFocusInputArea(view_->default_focus());
 }
+
 void Controller::HideHud(bool restore)
 {
   LOG_DEBUG (logger) << "hiding the hud";
@@ -398,6 +419,7 @@
 {
   LOG_DEBUG(logger) << "Selected query, " << query->formatted_text;
   view_->SetIcon(query->icon_name);
+  ubus.SendMessage(UBUS_HUD_ICON_CHANGED, g_variant_new_string(query->icon_name.c_str()));
 }
 
 
@@ -416,6 +438,7 @@
 
   LOG_DEBUG(logger) << "setting icon to - " << icon_name;
   view_->SetIcon(icon_name);
+  ubus.SendMessage(UBUS_HUD_ICON_CHANGED, g_variant_new_string(icon_name.c_str()));
 }
 
 // Introspectable

=== modified file 'plugins/unityshell/src/HudController.h'
--- plugins/unityshell/src/HudController.h	2012-02-13 04:21:04 +0000
+++ plugins/unityshell/src/HudController.h	2012-03-21 04:27:19 +0000
@@ -54,6 +54,8 @@
   void ShowHud();
   void HideHud(bool restore_focus = true);
   bool IsVisible();
+  void SetLauncherIsLockedOut(bool launcher_is_locked_out);
+
 protected:
   std::string GetName() const;
   void AddProperties(GVariantBuilder* builder);
@@ -99,6 +101,8 @@
   guint timeline_id_;
   float last_opacity_;
   gint64 start_time_;
+ 
+  bool launcher_is_locked_out_;
 
   View* view_;
   guint ensure_id_;

=== added file 'plugins/unityshell/src/HudLauncherIcon.cpp'
--- plugins/unityshell/src/HudLauncherIcon.cpp	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/HudLauncherIcon.cpp	2012-03-21 04:27:19 +0000
@@ -0,0 +1,125 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 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 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: Gordon Allott <[e-mail]>
+ */
+
+#include "HudLauncherIcon.h"
+#include "Launcher.h"
+#include "UnityCore/GLibWrapper.h"
+#include <NuxCore/Logger.h>
+
+#include "UBusMessages.h"
+
+#include <glib/gi18n-lib.h>
+
+namespace unity
+{
+namespace launcher
+{
+
+namespace
+{
+nux::logging::Logger logger("unity.launcher.hudlaunchericon");
+}
+
+UBusManager HudLauncherIcon::ubus_manager_;
+
+HudLauncherIcon::HudLauncherIcon(LauncherHideMode hide_mode)
+ : SimpleLauncherIcon()
+ , launcher_hide_mode_(hide_mode)
+{
+  tooltip_text = _("HUD");
+  icon_name = PKGDATADIR"/launcher_bfb.png";
+  SetQuirk(QUIRK_VISIBLE, false);
+  SetQuirk(QUIRK_RUNNING, false);
+  SetQuirk(QUIRK_ACTIVE, true);
+  SetIconType(TYPE_HOME);
+
+  background_color_ = nux::color::White;
+
+  ubus_manager_.RegisterInterest(UBUS_HUD_ICON_CHANGED, [&](GVariant *data)
+  {
+    std::string hud_icon_name;
+    const gchar* data_string = g_variant_get_string(data, NULL);
+    if (data_string)
+      hud_icon_name = data_string;
+    LOG_DEBUG(logger) << "Hud icon change: " << hud_icon_name;
+    if (!hud_icon_name.empty()
+        && hud_icon_name != icon_name())
+    {
+      icon_name = hud_icon_name;
+      EmitNeedsRedraw();
+    }
+  });
+
+  ubus_manager_.RegisterInterest(UBUS_OVERLAY_SHOWN, sigc::bind(sigc::mem_fun(this, &HudLauncherIcon::OnOverlayShown), true));
+  ubus_manager_.RegisterInterest(UBUS_OVERLAY_HIDDEN, sigc::bind(sigc::mem_fun(this, &HudLauncherIcon::OnOverlayShown), false));
+
+  mouse_enter.connect([&](int m) { ubus_manager_.SendMessage(UBUS_DASH_ABOUT_TO_SHOW, NULL); });
+}
+
+void HudLauncherIcon::SetHideMode(LauncherHideMode hide_mode)
+{
+  launcher_hide_mode_ = hide_mode;
+}
+
+void HudLauncherIcon::OnOverlayShown(GVariant* data, bool visible)
+{
+  unity::glib::String overlay_identity;
+  gboolean can_maximise = FALSE;
+  gint32 overlay_monitor = 0;
+  g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING,
+                &overlay_identity, &can_maximise, &overlay_monitor);
+
+  // If the hud is open, we show the HUD button iff we have a locked launcher
+  if (!g_strcmp0(overlay_identity, "hud") &&
+      launcher_hide_mode_ == LAUNCHER_HIDE_NEVER)
+  {
+    SetQuirk(QUIRK_VISIBLE, visible);
+    EmitNeedsRedraw();
+  }
+}
+
+nux::Color HudLauncherIcon::BackgroundColor()
+{
+  return background_color_;
+}
+
+nux::Color HudLauncherIcon::GlowColor()
+{
+  return background_color_;
+}
+
+void HudLauncherIcon::ActivateLauncherIcon(ActionArg arg)
+{
+  // wut? activate? noo we don't do that.
+}
+
+std::list<DbusmenuMenuitem*> HudLauncherIcon::GetMenus()
+{
+  std::list<DbusmenuMenuitem*> result;
+  return result;
+}
+
+std::string HudLauncherIcon::GetName() const
+{
+  return "HudLauncherIcon";
+}
+
+} // namespace launcher
+} // namespace unity
+

=== added file 'plugins/unityshell/src/HudLauncherIcon.h'
--- plugins/unityshell/src/HudLauncherIcon.h	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/HudLauncherIcon.h	2012-03-21 04:27:19 +0000
@@ -0,0 +1,60 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright (C) 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 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: Gordon Allott <[e-mail]>
+ */
+
+#ifndef UNITYSHELL_HUDLAUNCHERICON_H
+#define UNITYSHELL_HUDLAUNCHERICON_H
+
+#include "SimpleLauncherIcon.h"
+
+#include "LauncherOptions.h"
+#include "UBusWrapper.h"
+
+namespace unity
+{
+namespace launcher
+{
+
+class HudLauncherIcon : public SimpleLauncherIcon
+{
+
+public:
+  HudLauncherIcon(LauncherHideMode hide_mode);
+
+  virtual nux::Color BackgroundColor();
+  virtual nux::Color GlowColor();
+
+  void ActivateLauncherIcon(ActionArg arg);
+  void SetHideMode(LauncherHideMode hide_mode);
+
+protected:
+  std::list<DbusmenuMenuitem*> GetMenus();
+  std::string GetName() const;
+
+private:
+  void OnOverlayShown(GVariant *data, bool visible);
+
+  static unity::UBusManager ubus_manager_;
+  nux::Color background_color_;
+  LauncherHideMode launcher_hide_mode_;
+};
+
+}
+}
+
+#endif // UNITYSHELL_HUDLAUNCHERICON_H

=== modified file 'plugins/unityshell/src/HudView.cpp'
--- plugins/unityshell/src/HudView.cpp	2012-03-20 15:15:18 +0000
+++ plugins/unityshell/src/HudView.cpp	2012-03-21 04:27:19 +0000
@@ -64,10 +64,11 @@
   , current_height_(0)
   , timeline_need_more_draw_(false)
   , selected_button_(0)
+  , icon_state_(IconHideState::SHOW)
   , activated_signal_sent_(false)
 {
   renderer_.SetOwner(this);
-  renderer_.need_redraw.connect([this] () { 
+  renderer_.need_redraw.connect([this] () {
     QueueDraw();
   });
 
@@ -79,7 +80,7 @@
   SetupViews();
   search_bar_->key_down.connect (sigc::mem_fun (this, &View::OnKeyDown));
 
-  search_bar_->activated.connect ([&]() 
+  search_bar_->activated.connect ([&]()
   {
     if (!activated_signal_sent_)
       search_activated.emit(search_bar_->search_string);
@@ -115,12 +116,12 @@
         {
           (*it)->fake_focused = false;
         }
-      }      
+      }
     }
   });
 
   mouse_down.connect(sigc::mem_fun(this, &View::OnMouseButtonDown));
-  
+
   Relayout();
 }
 
@@ -143,25 +144,25 @@
    float progress = (diff - pause_before_grow_length) / grow_anim_length;
    int last_height = last_known_height_;
    int new_height = 0;
-   
+
    if (last_height < target_height)
    {
      // grow
      new_height = last_height + ((target_height - last_height) * progress);
    }
-   else 
+   else
    {
      //shrink
      new_height = last_height - ((last_height - target_height) * progress);
    }
-   
+
    LOG_DEBUG(logger) << "resizing to " << target_height << " (" << new_height << ")"
                      << "View height: " << GetGeometry().height;
    current_height_ = new_height;
   }
-  
-  QueueDraw();  
-  
+
+  QueueDraw();
+
   if (diff > grow_anim_length + pause_before_grow_length)
   {
     // ensure we are at our final location and update last known height
@@ -187,7 +188,6 @@
   layout_->SetMinimumWidth(content_geo_.width);
   layout_->SetMaximumWidth(content_geo_.width);
   layout_->SetMaximumHeight(content_geo_.height);
-  //layout_->SetMinMaxSize(content_geo_.width, content_geo_.height);
 
   QueueDraw();
 }
@@ -203,7 +203,7 @@
       // already started, just reset the last known height
       last_known_height_ = current_height_;
     }
-   
+
     timeline_need_more_draw_ = true;
     start_time_ = g_get_monotonic_time();
     QueueDraw();
@@ -276,17 +276,38 @@
   QueueDraw();
 }
 
+void View::SetHideIcon(IconHideState hide_icon)
+{
+  LOG_DEBUG(logger) << "Hide icon called";
+  if (hide_icon == icon_state_)
+    return;
+
+  icon_state_ = hide_icon;
+
+  if (icon_state_ == IconHideState::HIDE)
+    layout_->RemoveChildObject(dynamic_cast<nux::Area*>(icon_layout_.GetPointer()));
+  else
+    layout_->AddLayout(icon_layout_.GetPointer(), 0, nux::MINOR_POSITION_TOP, nux::MINOR_SIZE_MATCHCONTENT, 100.0f, nux::LayoutPosition::NUX_LAYOUT_BEGIN);
+
+  Relayout();
+}
+
 // Gives us the width and height of the contents that will give us the best "fit",
 // which means that the icons/views will not have uneccessary padding, everything will
 // look tight
 nux::Geometry View::GetBestFitGeometry(nux::Geometry const& for_geo)
 {
-  //FIXME - remove magic values, replace with scalable text depending on DPI 
+  //FIXME - remove magic values, replace with scalable text depending on DPI
   // requires smarter font settings really...
   int width, height = 0;
   width = 1024;
   height = 276;
-  
+
+  if (icon_state_ == IconHideState::HIDE)
+  {
+    width -= icon_layout_->GetGeometry().width;
+  }
+
   LOG_DEBUG (logger) << "best fit is, " << width << ", " << height;
 
   return nux::Geometry(0, 0, width, height);
@@ -321,16 +342,16 @@
 
 void View::SetupViews()
 {
-  nux::VLayout* super_layout = new nux::VLayout(); 
+  nux::VLayout* super_layout = new nux::VLayout();
   layout_ = new nux::HLayout();
-  { 
+  {
     // fill icon layout with icon
     icon_ = new Icon("", icon_size, true);
-    nux::Layout* icon_layout = new nux::VLayout();
+    icon_layout_ = new nux::VLayout();
     {
-      icon_layout->SetVerticalExternalMargin(icon_vertical_margin);
-      icon_layout->AddView(icon_.GetPointer(), 0, nux::MINOR_POSITION_LEFT, nux::MINOR_SIZE_FULL);
-      layout_->AddLayout(icon_layout, 0, nux::MINOR_POSITION_TOP, nux::MINOR_SIZE_MATCHCONTENT);
+      icon_layout_->SetVerticalExternalMargin(icon_vertical_margin);
+      icon_layout_->AddView(icon_.GetPointer(), 0, nux::MINOR_POSITION_LEFT, nux::MINOR_SIZE_FULL);
+      layout_->AddLayout(icon_layout_.GetPointer(), 0, nux::MINOR_POSITION_TOP, nux::MINOR_SIZE_MATCHCONTENT);
     }
 
     // add padding to layout between icon and content
@@ -338,11 +359,11 @@
                                             spacing_between_icon_and_content,
                                             spacing_between_icon_and_content,
                                             spacing_between_icon_and_content), 0);
-    
+
     // fill the content layout
     content_layout_ = new nux::VLayout();
     {
-      // add the top spacing 
+      // add the top spacing
       content_layout_->AddLayout(new nux::SpaceLayout(top_spacing,top_spacing,top_spacing,top_spacing), 0);
 
       // add the search bar to the composite
@@ -352,7 +373,7 @@
       search_bar_->search_changed.connect(sigc::mem_fun(this, &View::OnSearchChanged));
       AddChild(search_bar_.GetPointer());
       content_layout_->AddView(search_bar_.GetPointer(), 0, nux::MINOR_POSITION_LEFT);
-     
+
       button_views_ = new nux::VLayout();
       button_views_->SetMaximumWidth(content_width);
 
@@ -365,7 +386,7 @@
 
     layout_->AddLayout(content_layout_.GetPointer(), 1, nux::MINOR_POSITION_TOP);
   }
-  
+
   super_layout->AddLayout(layout_.GetPointer(), 0);
   SetLayout(super_layout);
 }
@@ -422,7 +443,7 @@
   draw_content_geo.height = current_height_;
 
   renderer_.DrawInner(gfx_context, draw_content_geo, absolute_window_geometry_, window_geometry_);
- 
+
   gfx_context.PushClippingRectangle(draw_content_geo);
   if (IsFullRedraw())
   {
@@ -440,7 +461,7 @@
 
   if (timeline_need_more_draw_ && !timeline_id_)
   {
-    timeline_id_ = g_timeout_add(0, [] (gpointer data) -> gboolean 
+    timeline_id_ = g_timeout_add(0, [] (gpointer data) -> gboolean
     {
       View *self = static_cast<View*>(data);
       self->QueueDraw();

=== modified file 'plugins/unityshell/src/HudView.h'
--- plugins/unityshell/src/HudView.h	2012-03-16 22:09:15 +0000
+++ plugins/unityshell/src/HudView.h	2012-03-21 04:27:19 +0000
@@ -44,6 +44,12 @@
 namespace hud
 {
 
+enum IconHideState
+{
+  HIDE,
+  SHOW
+};
+
 class View : public nux::View, public unity::debug::Introspectable
 {
   NUX_DECLARE_OBJECT_TYPE(HudView, nux::View);
@@ -59,7 +65,8 @@
 
   void SetQueries(Hud::Queries queries);
   void SetIcon(std::string icon_name);
-  
+  void SetHideIcon(IconHideState hide_icon);
+
   void AboutToShow();
   void AboutToHide();
 
@@ -100,10 +107,11 @@
   nux::ObjectPtr<nux::Layout> content_layout_;
   nux::ObjectPtr<nux::VLayout> button_views_;
   std::list<HudButton::Ptr> buttons_;
-  
+
   //FIXME - replace with dash search bar once modifications to dash search bar land
   SearchBar::Ptr search_bar_;
   Icon::Ptr icon_;
+  nux::ObjectPtr<nux::Layout> icon_layout_;
   bool visible_;
 
   Hud::Queries queries_;
@@ -118,6 +126,7 @@
   int current_height_;
   bool timeline_need_more_draw_;
   int selected_button_;
+  IconHideState icon_state_;
   bool activated_signal_sent_;
 };
 

=== modified file 'plugins/unityshell/src/Launcher.cpp'
--- plugins/unityshell/src/Launcher.cpp	2012-03-20 10:27:41 +0000
+++ plugins/unityshell/src/Launcher.cpp	2012-03-21 04:27:19 +0000
@@ -145,8 +145,8 @@
   , _collection_window(NULL)
   , _background_color(nux::color::DimGray)
   , _dash_is_open(false)
+  , _hud_is_open(false)
 {
-
   _parent = parent;
   _active_quicklist = nullptr;
 
@@ -909,7 +909,7 @@
     arg.saturation = 0.0;
   }
 
-  if (_dash_is_open)
+  if (IsOverlayOpen())
     arg.active_arrow = icon->GetIconType() == AbstractLauncherIcon::TYPE_HOME;
   else
     arg.active_arrow = icon->GetQuirk(AbstractLauncherIcon::QUIRK_ACTIVE);
@@ -1319,20 +1319,22 @@
   g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING,
                 &overlay_identity, &can_maximise, &overlay_monitor);
 
-
-  if (!g_strcmp0(overlay_identity, "dash"))
+  std::string identity = overlay_identity.Str();
+  if (overlay_monitor == monitor)
   {
-    if (overlay_monitor == monitor)
+    if (identity == "dash")
     {
-      LauncherModel::iterator it;
-
       _dash_is_open = true;
-      bg_effect_helper_.enabled = true;
       _hide_machine->SetQuirk(LauncherHideMachine::PLACES_VISIBLE, true);
       _hover_machine->SetQuirk(LauncherHoverMachine::PLACES_VISIBLE, true);
+    }
+    if (identity == "hud")
+    {
+      _hud_is_open = true;
+    }
 
-      DesaturateIcons();
-    }
+    bg_effect_helper_.enabled = true;
+    DesaturateIcons();
   }
 }
 
@@ -1345,26 +1347,37 @@
   g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING,
                 &overlay_identity, &can_maximise, &overlay_monitor);
 
-  if (!g_strcmp0(overlay_identity, "dash"))
+  std::string identity = overlay_identity.Str();
+  if (overlay_monitor == monitor)
   {
-    if (!_dash_is_open)
-      return;
-
-    LauncherModel::iterator it;
-
-    _dash_is_open = false;
-    bg_effect_helper_.enabled = false;
-    _hide_machine->SetQuirk(LauncherHideMachine::PLACES_VISIBLE, false);
-    _hover_machine->SetQuirk(LauncherHoverMachine::PLACES_VISIBLE, false);
-
-    // as the leave event is no more received when the place is opened
-    // FIXME: remove when we change the mouse grab strategy in nux
-    nux::Point pt = nux::GetWindowCompositor().GetMousePosition();
-
-    SetStateMouseOverLauncher(GetAbsoluteGeometry().IsInside(pt));
-
-    SaturateIcons();
+    if (identity == "dash")
+    {
+      _hide_machine->SetQuirk(LauncherHideMachine::PLACES_VISIBLE, false);
+      _hover_machine->SetQuirk(LauncherHoverMachine::PLACES_VISIBLE, false);
+      _dash_is_open = false;
+    }
+    else if (identity == "hud")
+    {
+      _hud_is_open = false;
+    }
+
+    // If they are both now shut, then disable the effect helper and saturate the icons.
+    if (!_dash_is_open and !_hud_is_open)
+    {
+      bg_effect_helper_.enabled = false;
+      SaturateIcons();
+    }
   }
+
+  // as the leave event is no more received when the place is opened
+  // FIXME: remove when we change the mouse grab strategy in nux
+  nux::Point pt = nux::GetWindowCompositor().GetMousePosition();
+  SetStateMouseOverLauncher(GetAbsoluteGeometry().IsInside(pt));
+}
+
+bool Launcher::IsOverlayOpen() const
+{
+  return _dash_is_open || _hud_is_open;
 }
 
 void Launcher::OnActionDone(GVariant* data)
@@ -1451,7 +1464,7 @@
   self->_collection_window->PushToBack();
   self->_collection_window->EnableInputWindow(false, "DNDCollectionWindow");
 
-  if (self->_dash_is_open && !self->_hovered)
+  if (self->IsOverlayOpen() && !self->_hovered)
     self->DesaturateIcons();
 
   self->DndReset();
@@ -1634,7 +1647,7 @@
     TimeUtil::SetTimeStruct(&_times[TIME_LEAVE], &_times[TIME_ENTER], ANIM_DURATION);
   }
 
-  if (_dash_is_open && !_hide_machine->GetQuirk(LauncherHideMachine::EXTERNAL_DND_ACTIVE))
+  if (IsOverlayOpen() && !_hide_machine->GetQuirk(LauncherHideMachine::EXTERNAL_DND_ACTIVE))
   {
     if (hovered && !_hover_machine->GetQuirk(LauncherHoverMachine::SHORTCUT_KEYS_VISIBLE))
       SaturateIcons();
@@ -1883,7 +1896,7 @@
                         pressure_color);
   }
 
-  if (_dash_is_open)
+  if (IsOverlayOpen())
   {
     if (BackgroundEffectHelper::blur_type != unity::BLUR_NONE && (bkg_box.x + bkg_box.width > 0))
     {
@@ -1984,7 +1997,7 @@
     icon_renderer->RenderIcon(GfxContext, *rev_it, bkg_box, base);
   }
 
-  if (!_dash_is_open)
+  if (!IsOverlayOpen())
   {
     const double right_line_opacity = 0.15f * launcher_alpha;
 
@@ -2604,7 +2617,7 @@
 
   _hide_machine->SetQuirk(LauncherHideMachine::EXTERNAL_DND_ACTIVE, true);
 
-  if (_dash_is_open)
+  if (IsOverlayOpen())
     SaturateIcons();
 
   for (auto it : _dnd_data.Uris())
@@ -2730,7 +2743,7 @@
 
   SetMousePosition(x - parent->GetGeometry().x, y - parent->GetGeometry().y);
 
-  if (!_dash_is_open && _mouse_position.x == 0 && _mouse_position.y <= (_parent->GetGeometry().height - _icon_size - 2 * _space_between_icons) && !_drag_edge_touching)
+  if (!IsOverlayOpen() && _mouse_position.x == 0 && _mouse_position.y <= (_parent->GetGeometry().height - _icon_size - 2 * _space_between_icons) && !_drag_edge_touching)
   {
     if (_dnd_hovered_icon)
         _dnd_hovered_icon->SendDndLeave();

=== modified file 'plugins/unityshell/src/Launcher.h'
--- plugins/unityshell/src/Launcher.h	2012-03-13 02:07:54 +0000
+++ plugins/unityshell/src/Launcher.h	2012-03-21 04:27:19 +0000
@@ -268,6 +268,7 @@
 
   void OnOverlayHidden(GVariant* data);
   void OnOverlayShown(GVariant* data);
+  bool IsOverlayOpen() const;
 
   void DesaturateIcons();
   void SaturateIcons();
@@ -406,6 +407,7 @@
   BaseTexturePtr launcher_sheen_;
   BaseTexturePtr launcher_pressure_effect_;
   bool _dash_is_open;
+  bool _hud_is_open;
 
   ui::AbstractIconRenderer::Ptr icon_renderer;
   BackgroundEffectHelper bg_effect_helper_;

=== modified file 'plugins/unityshell/src/LauncherController.cpp'
--- plugins/unityshell/src/LauncherController.cpp	2012-03-20 02:13:17 +0000
+++ plugins/unityshell/src/LauncherController.cpp	2012-03-21 04:27:19 +0000
@@ -32,6 +32,7 @@
 #include "DeviceLauncherIcon.h"
 #include "DeviceLauncherSection.h"
 #include "FavoriteStore.h"
+#include "HudLauncherIcon.h"
 #include "Launcher.h"
 #include "LauncherController.h"
 #include "LauncherEntryRemote.h"
@@ -228,7 +229,18 @@
   FavoriteStore::GetDefault().favorite_removed.connect(sigc::mem_fun(this, &Impl::OnFavoriteStoreFavoriteRemoved));
   FavoriteStore::GetDefault().reordered.connect(sigc::mem_fun(this, &Impl::OnFavoriteStoreReordered));
 
-  RegisterIcon(AbstractLauncherIcon::Ptr(new BFBLauncherIcon()));
+  LauncherHideMode hide_mode = parent_->options()->hide_mode;
+  BFBLauncherIcon* bfb = new BFBLauncherIcon(hide_mode);
+  parent_->options()->hide_mode.changed.connect([bfb](LauncherHideMode mode) {
+      bfb->SetHideMode(mode);
+    });
+  RegisterIcon(AbstractLauncherIcon::Ptr(bfb));
+
+  HudLauncherIcon* hud = new HudLauncherIcon(hide_mode);
+  parent_->options()->hide_mode.changed.connect([hud](LauncherHideMode mode) {
+      hud->SetHideMode(mode);
+    });
+  RegisterIcon(AbstractLauncherIcon::Ptr(hud));
   desktop_icon_ = AbstractLauncherIcon::Ptr(new DesktopLauncherIcon());
 
   uscreen->changed.connect(sigc::mem_fun(this, &Controller::Impl::OnScreenChanged));

=== modified file 'plugins/unityshell/src/LauncherHideMachine.cpp'
--- plugins/unityshell/src/LauncherHideMachine.cpp	2012-02-08 16:43:47 +0000
+++ plugins/unityshell/src/LauncherHideMachine.cpp	2012-03-21 04:27:19 +0000
@@ -134,19 +134,19 @@
 {
   bool should_hide;
 
-  // early check to see if we are locking to hidden
+  if (_mode == HIDE_NEVER)
+  {
+    SetShouldHide(false, skip_delay);
+    return;
+  }
+  
+  // early check to see if we are locking to hidden - but only if we are in non HIDE_NEVER
   if (GetQuirk(LOCK_HIDE))
   {
     SetShouldHide(true, true);
     return;
   }
 
-  if (_mode == HIDE_NEVER)
-  {
-    SetShouldHide(false, skip_delay);
-    return;
-  }
-
   do
   {
     // first we check the condition where external DND is active and the push off has happened

=== modified file 'plugins/unityshell/src/LauncherOptions.h'
--- plugins/unityshell/src/LauncherOptions.h	2012-03-13 02:43:20 +0000
+++ plugins/unityshell/src/LauncherOptions.h	2012-03-21 04:27:19 +0000
@@ -33,42 +33,42 @@
 namespace launcher
 {
 
-typedef enum
+enum LauncherHideMode
 {
   LAUNCHER_HIDE_NEVER,
   LAUNCHER_HIDE_AUTOHIDE,
-} LauncherHideMode;
+};
 
-typedef enum
+enum LaunchAnimation
 {
   LAUNCH_ANIMATION_NONE,
   LAUNCH_ANIMATION_PULSE,
   LAUNCH_ANIMATION_BLINK,
-} LaunchAnimation;
+};
 
-typedef enum
+enum UrgentAnimation
 {
   URGENT_ANIMATION_NONE,
   URGENT_ANIMATION_PULSE,
   URGENT_ANIMATION_WIGGLE,
-} UrgentAnimation;
+};
 
-typedef enum
+enum AutoHideAnimation
 {
   FADE_OR_SLIDE,
   SLIDE_ONLY,
   FADE_ONLY,
   FADE_AND_SLIDE,
-} AutoHideAnimation;
+};
 
-typedef enum
+enum BacklightMode
 {
   BACKLIGHT_ALWAYS_ON,
   BACKLIGHT_NORMAL,
   BACKLIGHT_ALWAYS_OFF,
   BACKLIGHT_EDGE_TOGGLE,
   BACKLIGHT_NORMAL_EDGE_TOGGLE
-} BacklightMode;
+};
 
 enum RevealTrigger
 {

=== modified file 'plugins/unityshell/src/UBusMessages.h'
--- plugins/unityshell/src/UBusMessages.h	2012-02-07 07:42:12 +0000
+++ plugins/unityshell/src/UBusMessages.h	2012-03-21 04:27:19 +0000
@@ -64,6 +64,9 @@
 // Signal to force the launcher into locked mode, (b)
 #define UBUS_LAUNCHER_LOCK_HIDE "LAUNCHER_LOCK_HIDE"
 
+// Signal to emit changes to the launcher hide mode behaviour (b), true = locked out, false = unlocked
+#define UBUS_LAUNCHER_HIDE_MODE_CHANGE "LAUNCHER_HIDE_MODE_CHANGE"
+
 // Signal sent when a quicklist is shown.
 #define UBUS_QUICKLIST_SHOWN "QUICKLIST_SHOWN"
 
@@ -78,6 +81,8 @@
 // FIXME - fix the nux focus api so we don't need this
 #define UBUS_RESULT_VIEW_KEYNAV_CHANGED "RESULT_VIEW_KEYNAV_CHANGED"
 
+// Sends a string datatype containing the new icon name
+#define UBUS_HUD_ICON_CHANGED "HUD_ICON_CHANGED"
 #define UBUS_HUD_CLOSE_REQUEST "HUD_CLOSE_REQUEST"
 
 // Signals sent when the switcher is shown, hidden or changes selection

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-03-20 15:37:36 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-03-21 04:27:19 +0000
@@ -2521,8 +2521,11 @@
       break;
     }
     case UnityshellOptions::LauncherHideMode:
+    {
       launcher_options->hide_mode = (unity::launcher::LauncherHideMode) optionGetLauncherHideMode();
+      hud_controller_->SetLauncherIsLockedOut(launcher_options->hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
       break;
+    }
     case UnityshellOptions::BacklightMode:
       launcher_options->backlight_mode = (unity::launcher::BacklightMode) optionGetBacklightMode();
       break;
@@ -2754,6 +2757,8 @@
 
   /* Setup Hud */
   hud_controller_.reset(new hud::Controller());
+  auto hide_mode = (unity::launcher::LauncherHideMode) optionGetLauncherHideMode();
+  hud_controller_->SetLauncherIsLockedOut(hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
   AddChild(hud_controller_.get());
   LOG_INFO(logger) << "initLauncher-hud " << timer.ElapsedSeconds() << "s";
   

=== modified file 'tests/autopilot/autopilot/tests/test_hud.py'
--- tests/autopilot/autopilot/tests/test_hud.py	2012-03-20 15:15:18 +0000
+++ tests/autopilot/autopilot/tests/test_hud.py	2012-03-21 04:27:19 +0000
@@ -15,8 +15,15 @@
 
 class HudTests(AutopilotTestCase):
 
+    scenarios = [
+        ('Launcher never hide', {'launcher_hide_mode': 0}),
+        ('Launcher autohide', {'launcher_hide_mode': 1}),
+        ]
+
     def setUp(self):
         super(HudTests, self).setUp()
+        self.set_unity_option('launcher_hide_mode', self.launcher_hide_mode)
+        sleep(0.5)
         self.hud = self.get_hud_controller()
 
     def tearDown(self):
@@ -54,12 +61,16 @@
     def test_check_a_values(self):
         self.reveal_hud()
         self.keyboard.type('a')
+        # Give the HUD a second to get values.
+        sleep(1)
         self.assertThat(self.hud.num_buttons, Equals(5))
         self.assertThat(self.hud.selected_button, Equals(1))
 
     def test_up_down_arrows(self):
         self.reveal_hud()
         self.keyboard.type('a')
+        # Give the HUD a second to get values.
+        sleep(1)
         self.keyboard.press_and_release('Down')
         self.assertThat(self.hud.selected_button, Equals(2))
         self.keyboard.press_and_release('Down')