Merge lp:~3v1n0/unity/bfb-quicklist-does-not-close-dash into lp:unity

[Marco Trevisan (Treviño)]

QuicklistMenuitem, BFBLauncherIcon: don't close the Dash when clicking on BFB quicklist items

Add a new property to the quicklist menu items to define if it should close or not the overlay when clicked.

Added unit tests.

[Tim Penhey (thumper)]

looks good

review: Approve

=== modified file 'launcher/BFBLauncherIcon.cpp'
--- launcher/BFBLauncherIcon.cpp	2012-08-02 11:30:02 +0000
+++ launcher/BFBLauncherIcon.cpp	2012-08-13 16:20:26 +0000
@@ -119,6 +119,7 @@
   dbusmenu_menuitem_property_set(menu_item, DBUSMENU_MENUITEM_PROP_LABEL, _("Dash Home"));
   dbusmenu_menuitem_property_set_bool(menu_item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
   dbusmenu_menuitem_property_set_bool(menu_item, DBUSMENU_MENUITEM_PROP_VISIBLE, true);
+  dbusmenu_menuitem_property_set_bool(menu_item, QuicklistMenuItem::OVERLAY_MENU_ITEM_PROPERTY, true);
 
   g_signal_connect(menu_item,
                    DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
@@ -138,6 +139,7 @@
     dbusmenu_menuitem_property_set(menu_item, DBUSMENU_MENUITEM_PROP_LABEL, lens->name);
     dbusmenu_menuitem_property_set_bool(menu_item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
     dbusmenu_menuitem_property_set_bool(menu_item, DBUSMENU_MENUITEM_PROP_VISIBLE, true);
+    dbusmenu_menuitem_property_set_bool(menu_item, QuicklistMenuItem::OVERLAY_MENU_ITEM_PROPERTY, true);
 
     g_signal_connect(menu_item,
                      DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
 
=== modified file 'launcher/BamfLauncherIcon.cpp'
--- launcher/BamfLauncherIcon.cpp	2012-08-02 11:30:02 +0000
+++ launcher/BamfLauncherIcon.cpp	2012-08-13 16:20:26 +0000
@@ -977,7 +977,7 @@
       if (dbusmenu_menuitem_property_get_bool(item, DBUSMENU_MENUITEM_PROP_VISIBLE))
       {
         first_separator_needed = true;
-        dbusmenu_menuitem_property_set_bool(item, "unity-use-markup", FALSE);
+        dbusmenu_menuitem_property_set_bool(item, QuicklistMenuItem::MARKUP_ENABLED_PROPERTY, FALSE);
 
         result.push_back(item);
       }
@@ -1039,7 +1039,7 @@
                                         DBUSMENU_MENUITEM_PROP_ENABLED,
                                         true);
     dbusmenu_menuitem_property_set_bool(item,
-                                        "unity-use-markup",
+                                        QuicklistMenuItem::MARKUP_ENABLED_PROPERTY,
                                         true);
 
     _gsignals.Add(new glib::Signal<void, DbusmenuMenuitem*, int>(item, DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
 
=== modified file 'launcher/QuicklistMenuItem.cpp'
--- launcher/QuicklistMenuItem.cpp	2012-08-13 16:20:26 +0000
+++ launcher/QuicklistMenuItem.cpp	2012-08-13 16:20:26 +0000
@@ -28,6 +28,8 @@
 
 namespace unity
 {
+const char* QuicklistMenuItem::MARKUP_ENABLED_PROPERTY = "unity-use-markup";
+const char* QuicklistMenuItem::OVERLAY_MENU_ITEM_PROPERTY = "unity-overlay-item";
 
 NUX_IMPLEMENT_OBJECT_TYPE(QuicklistMenuItem);
 
@@ -127,12 +129,16 @@
 
 void QuicklistMenuItem::Activate() const
 {
-  if (!_menu_item)
+  if (!_menu_item || !GetSelectable())
     return;
 
   dbusmenu_menuitem_handle_event(_menu_item, "clicked", nullptr, 0);
-  UBusManager manager;
-  manager.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
+
+  if (!IsOverlayQuicklist())
+  {
+    UBusManager manager;
+    manager.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
+  }
 }
 
 void QuicklistMenuItem::Select(bool select)
@@ -333,7 +339,7 @@
 {
   if (IsMarkupEnabled() != enabled)
   {
-    dbusmenu_menuitem_property_set_bool(_menu_item, "unity-use-markup", enabled);
+    dbusmenu_menuitem_property_set_bool(_menu_item, MARKUP_ENABLED_PROPERTY, enabled);
 
     _text = "";
     InitializeText();
@@ -345,10 +351,19 @@
   if (!_menu_item)
     return false;
 
-  gboolean markup = dbusmenu_menuitem_property_get_bool(_menu_item, "unity-use-markup");
+  gboolean markup = dbusmenu_menuitem_property_get_bool(_menu_item, MARKUP_ENABLED_PROPERTY);
   return (markup != FALSE);
 }
 
+bool QuicklistMenuItem::IsOverlayQuicklist() const
+{
+  if (!_menu_item)
+    return false;
+
+  gboolean overlay = dbusmenu_menuitem_property_get_bool(_menu_item, OVERLAY_MENU_ITEM_PROPERTY);
+  return (overlay != FALSE);
+}
+
 unsigned QuicklistMenuItem::GetCairoSurfaceWidth() const
 {
   if (!_normalTexture[0])
 
=== modified file 'launcher/QuicklistMenuItem.h'
--- launcher/QuicklistMenuItem.h	2012-08-13 16:20:26 +0000
+++ launcher/QuicklistMenuItem.h	2012-08-13 16:20:26 +0000
@@ -61,6 +61,7 @@
 
   void EnableLabelMarkup(bool enabled);
   bool IsMarkupEnabled() const;
+  bool IsOverlayQuicklist() const;
 
   void Activate() const;
 
@@ -79,6 +80,9 @@
   sigc::signal<void, QuicklistMenuItem*, int, int> sigMouseClick;
   sigc::signal<void, QuicklistMenuItem*, int, int> sigMouseDrag;
 
+  static const char* MARKUP_ENABLED_PROPERTY;
+  static const char* OVERLAY_MENU_ITEM_PROPERTY;
+
 protected:
   // Introspection
   std::string GetName() const;
 
=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2012-08-13 16:20:26 +0000
+++ tests/CMakeLists.txt	2012-08-13 16:20:26 +0000
@@ -200,6 +200,7 @@
   add_executable(test-gtest
                  test_main.cpp
                  test_bamflaunchericon.cpp
+                 test_bfb_launcher_icon.cpp
                  test_dashview_impl.cpp
                  test_edge_barrier_controller.cpp
                  test_launcher.cpp
 
=== added file 'tests/test_bfb_launcher_icon.cpp'
--- tests/test_bfb_launcher_icon.cpp	1970-01-01 00:00:00 +0000
+++ tests/test_bfb_launcher_icon.cpp	2012-08-13 16:20:26 +0000
@@ -0,0 +1,54 @@
+/*
+ * Copyright 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 warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY 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
+ * version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Marco Trevisan (Treviño) <[e-mail]>
+ */
+
+#include <gmock/gmock.h>
+
+#include "BFBLauncherIcon.h"
+
+using namespace unity;
+using namespace unity::launcher;
+
+namespace
+{
+
+class MockBFBLauncherIcon : public BFBLauncherIcon
+{
+public:
+  MockBFBLauncherIcon()
+    : BFBLauncherIcon(LauncherHideMode::LAUNCHER_HIDE_NEVER)
+  {}
+
+  std::list<DbusmenuMenuitem*> GetMenus()
+  {
+    return BFBLauncherIcon::GetMenus();
+  }
+};
+
+TEST(TestBFBLauncherIcon, OverlayMenus)
+{
+  MockBFBLauncherIcon bfb;
+
+  for (auto menu_item : bfb.GetMenus())
+  {
+    bool overlay_item = dbusmenu_menuitem_property_get_bool(menu_item, QuicklistMenuItem::OVERLAY_MENU_ITEM_PROPERTY);
+    ASSERT_TRUE(overlay_item);
+  }
+}
+
+}
 
=== modified file 'tests/test_quicklist_menu_item.cpp'
--- tests/test_quicklist_menu_item.cpp	2012-08-13 16:20:26 +0000
+++ tests/test_quicklist_menu_item.cpp	2012-08-13 16:20:26 +0000
@@ -20,12 +20,16 @@
 
 #include <gmock/gmock.h>
 #include <libdbusmenu-glib/client.h>
+#include <UnityCore/GLibSignal.h>
 
 #include "QuicklistMenuItem.h"
 #include "QuicklistMenuItemCheckmark.h"
 #include "QuicklistMenuItemLabel.h"
 #include "QuicklistMenuItemRadio.h"
 #include "QuicklistMenuItemSeparator.h"
+#include "unity-shared/UBusWrapper.h"
+#include "unity-shared/UBusMessages.h"
+#include "test_utils.h"
 
 using namespace unity;
 using namespace testing;
@@ -64,7 +68,7 @@
 {
   dbusmenu_menuitem_property_set(item, DBUSMENU_MENUITEM_PROP_LABEL, "A Label");
   dbusmenu_menuitem_property_set_bool(item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
-  dbusmenu_menuitem_property_set_bool(item, "unity-use-markup", true);
+  dbusmenu_menuitem_property_set_bool(item, QuicklistMenuItem::MARKUP_ENABLED_PROPERTY, true);
 
   nux::ObjectPtr<QuicklistMenuItemLabel> qlitem(new QuicklistMenuItemLabel(item));
 
@@ -104,4 +108,70 @@
   EXPECT_FALSE(qlitem->GetSelectable());
 }
 
+TEST_F(TestQuicklistMenuItem, OverlayMenuitem)
+{
+  dbusmenu_menuitem_property_set(item, DBUSMENU_MENUITEM_PROP_LABEL, "Label");
+  dbusmenu_menuitem_property_set_bool(item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
+
+  nux::ObjectPtr<QuicklistMenuItemLabel> qlitem(new QuicklistMenuItemLabel(item));
+
+  EXPECT_FALSE(qlitem->IsOverlayQuicklist());
+
+  dbusmenu_menuitem_property_set_bool(item, QuicklistMenuItem::OVERLAY_MENU_ITEM_PROPERTY, true);
+  EXPECT_TRUE(qlitem->IsOverlayQuicklist());
+}
+
+TEST_F(TestQuicklistMenuItem, ItemActivate)
+{
+  dbusmenu_menuitem_property_set(item, DBUSMENU_MENUITEM_PROP_LABEL, "Label");
+  dbusmenu_menuitem_property_set_bool(item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
+
+  nux::ObjectPtr<QuicklistMenuItemLabel> qlitem(new QuicklistMenuItemLabel(item));
+
+  bool item_activated = false;
+  glib::Signal<void, DbusmenuMenuitem*, int> signal(item, DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
+  [&] (DbusmenuMenuitem* menu_item, int time) {
+    EXPECT_EQ(menu_item, item);
+    item_activated = true;
+  });
+
+  qlitem->Activate();
+  EXPECT_TRUE(item_activated);
+}
+
+TEST_F(TestQuicklistMenuItem, ItemActivateClosesDash)
+{
+  dbusmenu_menuitem_property_set(item, DBUSMENU_MENUITEM_PROP_LABEL, "Label");
+  dbusmenu_menuitem_property_set_bool(item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
+
+  nux::ObjectPtr<QuicklistMenuItemLabel> qlitem(new QuicklistMenuItemLabel(item));
+
+  bool closes_dash = false;
+  UBusManager manager;
+  manager.RegisterInterest(UBUS_PLACE_VIEW_CLOSE_REQUEST, [&] (GVariant*) { closes_dash = true; });
+
+  qlitem->Activate();
+  Utils::WaitUntil(closes_dash);
+
+  EXPECT_TRUE(closes_dash);
+}
+
+TEST_F(TestQuicklistMenuItem, OverlayItemActivateDoesNotCloseDash)
+{
+  dbusmenu_menuitem_property_set(item, DBUSMENU_MENUITEM_PROP_LABEL, "Label");
+  dbusmenu_menuitem_property_set_bool(item, DBUSMENU_MENUITEM_PROP_ENABLED, true);
+  dbusmenu_menuitem_property_set_bool(item, QuicklistMenuItem::OVERLAY_MENU_ITEM_PROPERTY, true);
+
+  nux::ObjectPtr<QuicklistMenuItemLabel> qlitem(new QuicklistMenuItemLabel(item));
+
+  bool closes_dash = false;
+  UBusManager manager;
+  manager.RegisterInterest(UBUS_PLACE_VIEW_CLOSE_REQUEST, [&] (GVariant*) { closes_dash = true; });
+
+  qlitem->Activate();
+  Utils::WaitForTimeoutMSec(100);
+
+  EXPECT_FALSE(closes_dash);
+}
+
 }