Merge lp:~brandontschaefer/unity/mouse-move-hud-buttons-focus into lp:unity

[Brandon Schaefer]

The mouse will now cause the HUD buttons to change selection.

=== Problem ===
Moving the mouse over a Hud button does not change its visual focus.

=== Fix ===
Using mouse_enter/leave/move to change the visual focus of the Hud button to follow the mouse.

=== Tests ===
AP tests

[Gord Allott (gordallott)]

seems okay to me, +1

review: Approve

[Tim Penhey (thumper)]

Approving dead code removal.

review: Approve

=== modified file 'hud/HudButton.cpp'
--- hud/HudButton.cpp	2012-08-06 15:39:20 +0000
+++ hud/HudButton.cpp	2012-09-04 18:17:20 +0000
@@ -75,6 +75,22 @@
   {
     QueueDraw();
   });
+
+  mouse_move.connect([&](int x, int y, int dx, int dy, unsigned int button, unsigned int key)
+  {
+    if (!fake_focused)
+      fake_focused = true;
+  });
+
+  mouse_enter.connect([&](int x, int y, unsigned int button, unsigned int key)
+  {
+    fake_focused = true;
+  });
+
+  mouse_leave.connect([&](int x, int y, unsigned int button, unsigned int key)
+  {
+    fake_focused = false;
+  });
 }
 
 void HudButton::InitTheme()
@@ -113,7 +129,6 @@
   return false;
 }
 
-
 long HudButton::ComputeContentSize()
 {
   long ret = nux::Button::ComputeContentSize();
@@ -207,6 +222,7 @@
     nux::StaticCairoText* text = new nux::StaticCairoText(item.first);
     text->SetTextColor(nux::Color(1.0f, 1.0f, 1.0f, item.second ? 1.0f : 0.5f));
     text->SetFont(button_font);
+    text->SetInputEventSensitivity(false);
     hlayout_->AddView(text, 0, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_FULL);
   }
 }

=== modified file 'hud/HudView.cpp'
--- hud/HudView.cpp	2012-08-20 14:26:14 +0000
+++ hud/HudView.cpp	2012-09-04 18:17:20 +0000
@@ -66,6 +66,7 @@
   , timeline_need_more_draw_(false)
   , selected_button_(0)
   , show_embedded_icon_(true)
+  , keyboard_stole_focus_(false)
 {
   renderer_.SetOwner(this);
   renderer_.need_redraw.connect([this] () {
@@ -251,6 +252,22 @@
       query_activated.emit(dynamic_cast<HudButton*>(view)->GetQuery());
     });
 
+    button->mouse_move.connect([&](int x, int y, int dx, int dy, unsigned long mouse_button, unsigned long special_key) {
+      if (keyboard_stole_focus_)
+      {
+        MouseStealsHudButtonFocus();
+        keyboard_stole_focus_ = false;
+      }
+    });
+
+    button->mouse_enter.connect([&](int x, int y, unsigned long mouse_button, unsigned long special_key) {
+      MouseStealsHudButtonFocus();
+    });
+
+    button->mouse_leave.connect([&](int x, int y, unsigned long mouse_button, unsigned long special_key) {
+      SelectLastFocusedButton();
+    });
+
     button->key_nav_focus_activate.connect([&](nux::Area* area) {
       query_activated.emit(dynamic_cast<HudButton*>(area)->GetQuery());
     });
@@ -484,6 +501,49 @@
   }
 }
 
+void View::MouseStealsHudButtonFocus()
+{
+  LoseSelectedButtonFocus();
+  FindNewSelectedButton();
+}
+
+void View::LoseSelectedButtonFocus()
+{
+  int button_index = 1;
+  for (auto it = buttons_.rbegin(); it != buttons_.rend(); ++it)
+  {
+    if (selected_button_ == button_index)
+      (*it)->fake_focused = false;
+    ++button_index;
+  }
+}
+
+void View::FindNewSelectedButton()
+{
+  int button_index = 1;
+  for (auto it = buttons_.rbegin(); it != buttons_.rend(); ++it)
+  {
+    if ((*it)->fake_focused)
+    {
+      query_selected.emit((*it)->GetQuery());
+      selected_button_ = button_index;
+      return;
+    }
+    ++button_index;
+  }
+}
+
+void View::SelectLastFocusedButton()
+{
+  int button_index = 1;
+  for (auto it = buttons_.rbegin(); it != buttons_.rend(); ++it)
+  {
+    if (button_index == selected_button_)
+      (*it)->fake_focused = true;
+    ++button_index;
+  }
+}
+
 // Keyboard navigation
 bool View::AcceptKeyNavFocus()
 {
@@ -656,12 +716,12 @@
                 (*next)->fake_focused = true;
                 query_selected.emit((*next)->GetQuery());
                 --selected_button_;
+                keyboard_stole_focus_ = true;
               }
               break;
             }
           }
         }
-
         if (event_type == nux::NUX_KEYDOWN && direction == nux::KEY_NAV_DOWN)
         {
           std::list<HudButton::Ptr>::reverse_iterator rit;
@@ -679,6 +739,7 @@
                 (*next)->fake_focused = true;
                 query_selected.emit((*next)->GetQuery());
                 ++selected_button_;
+                keyboard_stole_focus_ = true;
               }
               break;
             }

=== modified file 'hud/HudView.h'
--- hud/HudView.h	2012-07-04 02:37:23 +0000
+++ hud/HudView.h	2012-09-04 18:17:20 +0000
@@ -85,6 +85,11 @@
 
   void ProcessGrowShrink();
 
+  void MouseStealsHudButtonFocus();
+  void LoseSelectedButtonFocus();
+  void FindNewSelectedButton();
+  void SelectLastFocusedButton();
+
   std::string GetName() const;
   void AddProperties(GVariantBuilder* builder);
   IntrospectableList GetIntrospectableChildren();
@@ -116,6 +121,7 @@
   int selected_button_;
   bool show_embedded_icon_;
   bool activated_signal_sent_;
+  bool keyboard_stole_focus_;
 };
 
 

=== modified file 'tests/autopilot/unity/tests/test_hud.py'
--- tests/autopilot/unity/tests/test_hud.py	2012-08-27 14:45:44 +0000
+++ tests/autopilot/unity/tests/test_hud.py	2012-09-04 18:17:20 +0000
@@ -247,11 +247,11 @@
         self.mouse.click()
 
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
-        
+
     def test_hud_closes_click_after_text_removed(self):
         """Clicking outside of the hud after a search text has been entered and
         then removed from the searchbox will make it close."""
-        
+
         self.hud.ensure_visible()
         self.keyboard.type("Test")
         self.keyboard.press_and_release("Escape")
@@ -259,7 +259,7 @@
         (x,y,w,h) = self.hud.view.geometry
         self.mouse.move(w/2, h+50)
         self.mouse.click()
-        
+
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
 
     def test_alt_f4_close_hud(self):
@@ -276,49 +276,49 @@
         self.hud.ensure_visible()
         self.keyboard.press_and_release("Alt+F4")
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
-        
+
     def test_app_activate_on_enter(self):
         """Hud must close after activating a search item with Enter."""
-        self.hud.ensure_visible()   
-        
+        self.hud.ensure_visible()
+
         self.keyboard.type("Device > System Settings")
         self.assertThat(self.hud.search_string, Eventually(Equals("Device > System Settings")))
-        
+
         self.keyboard.press_and_release("Enter")
-        
+
         app_found = self.bamf.wait_until_application_is_running("gnome-control-center.desktop", 5)
         self.assertTrue(app_found)
         self.addCleanup(self.close_all_app,  "System Settings")
-        
+
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
-        
+
     def test_hud_closes_on_escape(self):
         """Hud must close on escape after searchbox is cleared"""
         self.hud.ensure_visible()
-        
+
         self.keyboard.type("ThisText")
         self.keyboard.press_and_release("Escape")
         self.keyboard.press_and_release("Escape")
-        
+
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
-    
+
     def test_hud_closes_on_escape_shrunk(self):
         """Hud must close when escape key is pressed"""
         self.hud.ensure_visible()
         self.keyboard.press_and_release("Escape")
-        
+
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
 
     def test_alt_arrow_keys_not_eaten(self):
         """Tests that Alt+ArrowKey events are correctly passed to the
         active window when Unity is not responding to them."""
-        
+
         self.start_app_window("Terminal")
-        
+
         #There's no easy way to read text from terminal, writing input
         #to a text file and then reading from there works.
         self.keyboard.type('echo "')
-        
+
         #Terminal is receiving input with Alt+Arrowkeys
         self.keyboard.press("Alt")
         self.keyboard.press_and_release("Up")
@@ -326,13 +326,13 @@
         self.keyboard.press_and_release("Right")
         self.keyboard.press_and_release("Left")
         self.keyboard.release("Alt")
-        
+
         self.keyboard.type('" > /tmp/ap_test_alt_keys')
         self.addCleanup(remove, '/tmp/ap_test_alt_keys')
         self.keyboard.press_and_release("Enter")
-        
+
         file_contents = open('/tmp/ap_test_alt_keys', 'r').read().strip()
-        
+
         self.assertThat(file_contents, Equals('ABCD'))
 
     def test_hud_closes_on_item_activated(self):
@@ -357,6 +357,41 @@
 
         self.assertThat(self.hud.visible, Eventually(Equals(False)))
 
+    def test_mouse_changes_selected_hud_button(self):
+        """This tests moves the mouse from the top of the screen to the bottom, this must
+           change the selected button from 1 to 5.
+        """
+
+        self.hud.ensure_visible()
+
+        self.keyboard.type("a")
+        (x,y,w,h) = self.hud.view.geometry
+
+        self.mouse.move(w/2, 0)
+        self.assertThat(self.hud.view.selected_button, Eventually(Equals(1)))
+
+        self.mouse.move(w/2, h)
+        self.assertThat(self.hud.view.selected_button, Eventually(Equals(5)))
+
+    def test_keyboard_steals_focus_from_mouse(self):
+        """This tests moves the mouse from the top of the screen to the bottom,
+           then it presses the keyboard up 5 times, this must change the selected button from 5 to 1.
+        """
+
+        self.hud.ensure_visible()
+
+        self.keyboard.type("a")
+        (x,y,w,h) = self.hud.view.geometry
+
+        self.mouse.move(w/2, 0)
+        self.mouse.move(w/2, h)
+        self.assertThat(self.hud.view.selected_button, Eventually(Equals(5)))
+
+        for i in range(5):
+          self.keyboard.press_and_release('Up')
+
+        self.assertThat(self.hud.view.selected_button, Eventually(Equals(1)))
+
 
 class HudLauncherInteractionsTests(HudTestsBase):