Merge lp:~brandontschaefer/unity/lp.1101310-window-buttons-fix into lp:unity

[Brandon Schaefer]

Created a class OverlayWindowButtons which will sit in the DashView/HudView
  to handle mouse events for the window buttons.
TODO: We need to refactor the PanelMenuView to extract window button logic
  (dealing with overlays).

=== Problem ===

When the launcher icons were resized the dash view would take up that extra space. The problem with this is the panel height is part of the dash view. So part of the window buttons are under the dash view which means no mouse events get to them. Meaning they no longer work :).

=== Fix ===

So to start, we can't fix this by telling the dash view to ignore the panel because the preview needs to draw over them. This means the dash view must be over the panel.

So the new fix, is to have the DashView/HudView hold the OverlayWindowButtons, which can now tell it to the area that is under the mouse. Making the buttons work again (yay!).

=== Test ===

There is an AP test

[Andrea Azzarone (azzar1)]

346 +const int MAIN_LEFT_PADDING = 4;
347 +const int MENUBAR_PADDING = 4;

Put them in an unnamed namespace (or just declare them static, but static is so C :)

387 +nux::Area* OverlayWindowButtons::FindAreaUnderMouse(nux::Point const& mouse_position,
388 + nux::NuxEventType event_type)

Please fix the indentation here.

[Andrea Azzarone (azzar1)]

LGTM now.

review: Approve

[Thomi Richards (thomir-deactivatedaccount)]

review: Approve (quality)

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

It's ok for fixing the issue... I'm waiting for the next branch that will cleanup the WindowButtons having an abstract form to share the logic and different implementations for Panel and Overlays ;)

=== modified file 'dash/CMakeLists.txt'
--- dash/CMakeLists.txt	2012-12-19 20:53:12 +0000
+++ dash/CMakeLists.txt	2013-01-29 01:28:23 +0000
@@ -56,4 +56,4 @@
 # Standalone variant
 #
 add_executable (dash StandaloneDash.cpp)
-target_link_libraries (dash dash-lib unity-shared)
+target_link_libraries (dash dash-lib unity-shared unity-shared-standalone)

=== modified file 'dash/DashView.cpp'
--- dash/DashView.cpp	2013-01-15 21:53:55 +0000
+++ dash/DashView.cpp	2013-01-29 01:28:23 +0000
@@ -20,6 +20,7 @@
 
 #include "DashView.h"
 #include "DashViewPrivate.h"
+#include "FilterExpanderLabel.h"
 
 #include <math.h>
 
@@ -31,13 +32,12 @@
 #include <UnityCore/GLibWrapper.h>
 #include <UnityCore/RadioOptionFilter.h>
 
-#include "FilterExpanderLabel.h"
 #include "unity-shared/DashStyle.h"
 #include "unity-shared/KeyboardUtil.h"
-#include "unity-shared/UnitySettings.h"
-#include "unity-shared/UBusMessages.h"
 #include "unity-shared/PreviewStyle.h"
 #include "unity-shared/PanelStyle.h"
+#include "unity-shared/UBusMessages.h"
+#include "unity-shared/UnitySettings.h"
 
 namespace unity
 {
@@ -126,6 +126,7 @@
   , animate_split_value_(0.0)
   , animate_preview_container_value_(0.0)
   , animate_preview_value_(0.0)
+  , overlay_window_buttons_(new OverlayWindowButtons())
 {
   renderer_.SetOwner(this);
   renderer_.need_redraw.connect([this] () {
@@ -493,6 +494,8 @@
     ClosePreview();
   }
 
+  overlay_window_buttons_->Show();
+
   renderer_.AboutToShow();
 }
 
@@ -520,6 +523,8 @@
   {
     ClosePreview();
   }
+
+  overlay_window_buttons_->Hide();
 }
 
 void DashView::SetupViews()
@@ -728,6 +733,8 @@
     nux::GetPainter().PopBackgroundStack();
   }
 
+  overlay_window_buttons_->QueueDraw();
+
   graphics_engine.PopClippingRectangle();
 
   renderer_.DrawInnerCleanup(graphics_engine, content_geo_, renderer_geo_abs, renderer_geo);
@@ -1089,11 +1096,6 @@
     geo.width += style.GetDashRightTileWidth();
     geo.height += style.GetDashBottomTileHeight();
   }
-
-  if (!geo.IsPointInside(x, y))
-  {
-    ubus_manager_.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
-  }
 }
 
 void DashView::OnActivateRequest(GVariant* args)
@@ -1518,6 +1520,7 @@
   wrapper.add("right-border-width", style.GetDashRightTileWidth());
   wrapper.add("bottom-border-height", style.GetDashBottomTileHeight());
   wrapper.add("preview_displaying", preview_displaying_);
+  wrapper.add("dash_maximized", style.always_maximised());
 }
 
 nux::Area* DashView::KeyNavIteration(nux::KeyNavDirection direction)
@@ -1719,7 +1722,12 @@
 nux::Area* DashView::FindAreaUnderMouse(const nux::Point& mouse_position, nux::NuxEventType event_type)
 {
   nux::Area* view = nullptr;
-  if (preview_displaying_)
+
+  if (overlay_window_buttons_->GetGeometry().IsInside(mouse_position))
+  {
+    return overlay_window_buttons_->FindAreaUnderMouse(mouse_position, event_type);
+  }
+  else if (preview_displaying_)
   {
     nux::Point newpos = mouse_position;
     view = dynamic_cast<nux::Area*>(preview_container_.GetPointer())->FindAreaUnderMouse(newpos, event_type);

=== modified file 'dash/DashView.h'
--- dash/DashView.h	2012-12-17 09:28:31 +0000
+++ dash/DashView.h	2013-01-29 01:28:23 +0000
@@ -28,17 +28,20 @@
 #include <UnityCore/HomeLens.h>
 #include <UnityCore/GLibSource.h>
 
-#include "unity-shared/BackgroundEffectHelper.h"
-#include "unity-shared/SearchBar.h"
-#include "unity-shared/Introspectable.h"
-#include "unity-shared/BGHash.h"
 #include "LensBar.h"
 #include "LensView.h"
-#include "unity-shared/UBusWrapper.h"
-#include "unity-shared/OverlayRenderer.h"
-#include "UnityCore/Preview.h"
 #include "previews/PreviewContainer.h"
 #include "PreviewStateMachine.h"
+#include "UnityCore/Preview.h"
+
+#include "unity-shared/BackgroundEffectHelper.h"
+#include "unity-shared/BGHash.h"
+#include "unity-shared/Introspectable.h"
+#include "unity-shared/OverlayRenderer.h"
+#include "unity-shared/SearchBar.h"
+#include "unity-shared/UBusWrapper.h"
+#include "unity-shared/OverlayWindowButtons.h"
+
 
 namespace na = nux::animation;
 
@@ -185,6 +188,8 @@
 
   std::unique_ptr<na::AnimateValue<float>> preview_animation_;
   float animate_preview_value_;
+
+  nux::ObjectPtr<OverlayWindowButtons> overlay_window_buttons_;
 };
 
 

=== modified file 'hud/CMakeLists.txt'
--- hud/CMakeLists.txt	2012-12-19 20:53:12 +0000
+++ hud/CMakeLists.txt	2013-01-29 01:28:23 +0000
@@ -34,4 +34,4 @@
 # Standalone variant
 #
 add_executable (hud StandaloneHud.cpp)
-target_link_libraries (hud hud-lib unity-shared)
+target_link_libraries (hud hud-lib unity-shared unity-shared-standalone)

=== modified file 'hud/HudView.cpp'
--- hud/HudView.cpp	2013-01-09 13:17:04 +0000
+++ hud/HudView.cpp	2013-01-29 01:28:23 +0000
@@ -67,6 +67,7 @@
   , selected_button_(0)
   , show_embedded_icon_(true)
   , keyboard_stole_focus_(false)
+  , overlay_window_buttons_(new OverlayWindowButtons())
 {
   renderer_.SetOwner(this);
   renderer_.need_redraw.connect([this] () {
@@ -345,12 +346,14 @@
 void View::AboutToShow()
 {
   visible_ = true;
+  overlay_window_buttons_->Show();
   renderer_.AboutToShow();
 }
 
 void View::AboutToHide()
 {
   visible_ = false;
+  overlay_window_buttons_->Hide();
   renderer_.AboutToHide();
 }
 
@@ -484,6 +487,9 @@
   {
     GetLayout()->ProcessDraw(gfx_context, force_draw);
   }
+
+  overlay_window_buttons_->QueueDraw();
+
   gfx_context.PopClippingRectangle();
 
   renderer_.DrawInnerCleanup(gfx_context, draw_content_geo, GetAbsoluteGeometry(), GetGeometry());

=== modified file 'hud/HudView.h'
--- hud/HudView.h	2012-11-28 14:23:01 +0000
+++ hud/HudView.h	2013-01-29 01:28:23 +0000
@@ -29,6 +29,7 @@
 #include "HudButton.h"
 #include "HudAbstractView.h"
 #include "unity-shared/OverlayRenderer.h"
+#include "unity-shared/OverlayWindowButtons.h"
 #include "unity-shared/SearchBar.h"
 #include "unity-shared/UBusWrapper.h"
 
@@ -121,6 +122,8 @@
   bool show_embedded_icon_;
   bool activated_signal_sent_;
   bool keyboard_stole_focus_;
+
+  nux::ObjectPtr<OverlayWindowButtons> overlay_window_buttons_;
 };
 
 

=== modified file 'panel/CMakeLists.txt'
--- panel/CMakeLists.txt	2012-12-19 20:53:12 +0000
+++ panel/CMakeLists.txt	2013-01-29 01:28:23 +0000
@@ -24,7 +24,6 @@
      PanelTitlebarGrabAreaView.cpp
      PanelTray.cpp
      PanelView.cpp
-     WindowButtons.cpp
      )
 
 add_library (panel-lib STATIC ${PANEL_SOURCES})

=== modified file 'panel/PanelMenuView.cpp'
--- panel/PanelMenuView.cpp	2013-01-09 14:16:07 +0000
+++ panel/PanelMenuView.cpp	2013-01-29 01:28:23 +0000
@@ -356,8 +356,9 @@
   WindowManager& wm = WindowManager::Default();
   bool screen_grabbed = (wm.IsExpoActive() || wm.IsScaleActive());
 
+  // TODO: We need to refactor this code to extract the window button logic
   if (overlay_showing_)
-    return true;
+    return false;
 
   if (we_control_active_ && is_maximized_ && !screen_grabbed &&
       !launcher_keynav_ && !switcher_showing_)

=== modified file 'panel/PanelMenuView.h'
--- panel/PanelMenuView.h	2012-12-12 18:07:08 +0000
+++ panel/PanelMenuView.h	2013-01-29 01:28:23 +0000
@@ -28,7 +28,7 @@
 
 #include "PanelIndicatorsView.h"
 #include "unity-shared/StaticCairoText.h"
-#include "WindowButtons.h"
+#include "unity-shared/WindowButtons.h"
 #include "PanelTitlebarGrabAreaView.h"
 #include "unity-shared/UBusWrapper.h"
 

=== modified file 'panel/PanelView.cpp'
--- panel/PanelView.cpp	2012-12-17 19:35:34 +0000
+++ panel/PanelView.cpp	2013-01-29 01:28:23 +0000
@@ -636,7 +636,8 @@
     tracked_pointer_pos_ = {-1, -1};
   }
 
-  ubus_manager_.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
+  if (overlay_is_open_)
+    ubus_manager_.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
 }
 
 void PanelView::OnEntryShowMenu(std::string const& entry_id, unsigned xid,

=== modified file 'tests/autopilot/unity/tests/test_panel.py'
--- tests/autopilot/unity/tests/test_panel.py	2013-01-25 09:49:47 +0000
+++ tests/autopilot/unity/tests/test_panel.py	2013-01-29 01:28:23 +0000
@@ -298,6 +298,22 @@
         self.assertThat(self.panel.window_buttons_shown, Eventually(Equals(True)))
         self.assertWinButtonsInOverlayMode(True)
 
+    def test_window_buttons_work_in_dash_after_launcher_resize(self):
+        """When the launcher icons are resized, the window
+        buttons must still work in the dash."""
+
+        self.set_unity_option("icon_size", 25)
+        self.dash.ensure_visible()
+        self.addCleanup(self.dash.ensure_hidden)
+
+        desired_max = not self.dash.view.dash_maximized
+        if desired_max:
+            self.panel.window_buttons.maximize.mouse_click()
+        else:
+            self.panel.window_buttons.unmaximize.mouse_click()
+
+        self.assertThat(self.dash.view.dash_maximized, Eventually(Equals(desired_max)))
+
     def test_window_buttons_show_with_hud(self):
         """Window buttons must be shown when the HUD is open."""
         self.hud.ensure_visible()

=== modified file 'tests/test_hud_view.cpp'
--- tests/test_hud_view.cpp	2012-06-04 23:03:32 +0000
+++ tests/test_hud_view.cpp	2013-01-29 01:28:23 +0000
@@ -30,6 +30,7 @@
 
 #include "hud/HudView.h"
 #include "unity-shared/DashStyle.h"
+#include "unity-shared/PanelStyle.h"
 #include "unity-shared/UnitySettings.h"
 using namespace unity;
 
@@ -40,6 +41,7 @@
 {
   Settings unity_settings;
   dash::Style dash_style;
+  panel::Style panel_style;
   nux::ObjectPtr<hud::View> view(new hud::View());
 
   hud::Hud::Queries queries;

=== modified file 'tests/test_window_buttons.cpp'
--- tests/test_window_buttons.cpp	2012-12-14 17:19:44 +0000
+++ tests/test_window_buttons.cpp	2013-01-29 01:28:23 +0000
@@ -24,8 +24,8 @@
 #include "PanelStyle.h"
 #include "StandaloneWindowManager.h"
 #include "UnitySettings.h"
-#include "WindowButtons.h"
-#include "WindowButtonPriv.h"
+#include "unity-shared/WindowButtons.h"
+#include "unity-shared/WindowButtonPriv.h"
 
 namespace unity
 {

=== modified file 'unity-shared/CMakeLists.txt'
--- unity-shared/CMakeLists.txt	2012-12-19 20:53:12 +0000
+++ unity-shared/CMakeLists.txt	2013-01-29 01:28:23 +0000
@@ -39,6 +39,7 @@
      LayoutSystem.cpp
      LineSeparator.cpp
      OverlayRenderer.cpp
+     OverlayWindowButtons.cpp
      PanelStyle.cpp
      PlacesVScrollBar.cpp
      PlacesOverlayVScrollBar.cpp
@@ -61,6 +62,7 @@
      UnityWindowView.cpp
      UserThumbnailProvider.cpp
      VScrollBarOverlayWindow.cpp
+     WindowButtons.cpp
      WindowManager.cpp
      XPathQueryPart.cpp
 )

=== added file 'unity-shared/OverlayWindowButtons.cpp'
--- unity-shared/OverlayWindowButtons.cpp	1970-01-01 00:00:00 +0000
+++ unity-shared/OverlayWindowButtons.cpp	2013-01-29 01:28:23 +0000
@@ -0,0 +1,81 @@
+/*
+ * 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: Brandon Schaefer <[e-mail]>
+ *
+ */
+
+#include "OverlayWindowButtons.h"
+#include "PanelStyle.h"
+#include "UScreen.h"
+
+namespace
+{
+  const int MAIN_LEFT_PADDING = 4;
+  const int MENUBAR_PADDING = 4;
+}
+
+namespace unity
+{
+
+NUX_IMPLEMENT_OBJECT_TYPE(OverlayWindowButtons);
+
+OverlayWindowButtons::OverlayWindowButtons()
+  : nux::BaseWindow("OverlayWindowButtons")
+  , window_buttons_(new WindowButtons())
+{
+  UpdateGeometry();
+  SetBackgroundColor(nux::color::Transparent);
+}
+
+void OverlayWindowButtons::UpdateGeometry()
+{
+  int monitor = unity::UScreen::GetDefault()->GetMonitorWithMouse();
+  nux::Geometry const& geo = unity::UScreen::GetDefault()->GetMonitorGeometry(monitor);
+
+  SetX(geo.x + MAIN_LEFT_PADDING);
+  SetY(geo.y + MENUBAR_PADDING);
+  SetHeight(panel::Style::Instance().panel_height);
+
+  window_buttons_->monitor = monitor;
+}
+
+void OverlayWindowButtons::Show()
+{
+  UpdateGeometry();
+  ShowWindow(true);
+  PushToFront();
+  QueueDraw();
+}
+
+void OverlayWindowButtons::Hide()
+{
+  ShowWindow(false);
+  PushToBack();
+  QueueDraw();
+}
+
+nux::Area* OverlayWindowButtons::FindAreaUnderMouse(nux::Point const& mouse_position,
+                                                    nux::NuxEventType event_type)
+{
+  return window_buttons_->FindAreaUnderMouse(mouse_position, event_type);
+}
+
+void OverlayWindowButtons::Draw(nux::GraphicsEngine& gfx_context, bool force_draw)
+{
+  window_buttons_->ProcessDraw(gfx_context, true);
+}
+
+} // namespace unity

=== added file 'unity-shared/OverlayWindowButtons.h'
--- unity-shared/OverlayWindowButtons.h	1970-01-01 00:00:00 +0000
+++ unity-shared/OverlayWindowButtons.h	2013-01-29 01:28:23 +0000
@@ -0,0 +1,54 @@
+/*
+ * 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: Brandon Schaefer <[e-mail]>
+ *
+ */
+
+#ifndef OVERLAY_WINDOW_BUTTONS
+#define OVERLAY_WINDOW_BUTTONS
+
+#include "Nux/Nux.h"
+#include "Nux/BaseWindow.h"
+
+#include "WindowButtons.h"
+
+namespace unity
+{
+
+class OverlayWindowButtons : public nux::BaseWindow
+{
+  NUX_DECLARE_OBJECT_TYPE(OverlayWindowButtons, nux::BaseWindow);
+public:
+  OverlayWindowButtons();
+
+  void Show();
+  void Hide();
+
+  nux::Area* FindAreaUnderMouse(nux::Point const& mouse_position,
+                                nux::NuxEventType event_type);
+
+protected:
+  void Draw(nux::GraphicsEngine& gfx_context, bool force_draw);
+
+private:
+  void UpdateGeometry();
+
+  nux::ObjectPtr<WindowButtons> window_buttons_;
+};
+
+} // namespace unity
+
+#endif // OVERLAY_WINDOW_BUTTONS

=== renamed file 'panel/WindowButtonPriv.h' => 'unity-shared/WindowButtonPriv.h'
=== renamed file 'panel/WindowButtons.cpp' => 'unity-shared/WindowButtons.cpp'
=== renamed file 'panel/WindowButtons.h' => 'unity-shared/WindowButtons.h'