Merge lp:~jamalta/unity/683261-autohide-quicklist into lp:unity

[Jamal Fanaian]

Created QuicklistManager which is now responsible for handling Hiding and Showing a QuicklistView. Launcher uses QuicklistManager to figure out whether a QuicklistView is currently open before autohiding.

[Jason Smith (jassmith)]

+2

review: Approve

=== modified file 'src/Launcher.cpp'
--- src/Launcher.cpp	2010-12-09 13:30:37 +0000
+++ src/Launcher.cpp	2010-12-09 20:57:22 +0000
@@ -35,6 +35,7 @@
 #include "Launcher.h"
 #include "LauncherIcon.h"
 #include "LauncherModel.h"
+#include "QuicklistManager.h"
 #include "QuicklistView.h"
 
 #define ANIM_DURATION_SHORT 125
@@ -190,6 +191,9 @@
     OnMouseMove.connect(sigc::mem_fun(this, &Launcher::RecvMouseMove));
     OnMouseWheel.connect(sigc::mem_fun(this, &Launcher::RecvMouseWheel));
 
+    QuicklistManager::Default ()->quicklist_opened.connect (sigc::mem_fun(this, &Launcher::RecvQuicklistOpened));
+    QuicklistManager::Default ()->quicklist_closed.connect (sigc::mem_fun(this, &Launcher::RecvQuicklistClosed));
+
     m_ActiveTooltipIcon = NULL;
     m_ActiveMenuIcon = NULL;
 
@@ -843,7 +847,7 @@
 void
 Launcher::EnsureHiddenState ()
 {
-  if (!_mouse_inside_trigger && !_mouse_inside_launcher && _window_over_launcher)
+  if (!_mouse_inside_trigger && !_mouse_inside_launcher && _window_over_launcher && !QuicklistManager::Default ()->Current())
     SetHidden (true);
   else
     SetHidden (false);
@@ -1615,6 +1619,20 @@
 {
 }
 
+void Launcher::RecvQuicklistOpened (QuicklistView *quicklist)
+{
+  EventLogic ();
+  EnsureAnimation ();
+}
+
+void Launcher::RecvQuicklistClosed (QuicklistView *quicklist)
+{
+  SetupAutohideTimer ();
+
+  EventLogic ();
+  EnsureAnimation ();
+}
+
 void Launcher::EventLogic ()
 {
   if (_launcher_action_state == ACTION_DRAG_LAUNCHER)
@@ -1954,20 +1972,3 @@
 //     glEnd();
 }
 
-void Launcher::SetActiveQuicklist (QuicklistView *quicklist)
-{
-  // Assert: _active_quicklist should be 0
-  _active_quicklist = quicklist;
-}
-
-QuicklistView *Launcher::GetActiveQuicklist ()
-{
-  return _active_quicklist;
-}
-
-void Launcher::CancelActiveQuicklist (QuicklistView *quicklist)
-{
-  if (_active_quicklist == quicklist)
-    _active_quicklist = 0;
-}
-
 
=== modified file 'src/Launcher.h'
--- src/Launcher.h	2010-12-07 16:05:52 +0000
+++ src/Launcher.h	2010-12-09 20:57:22 +0000
@@ -73,12 +73,8 @@
     virtual void RecvMouseMove(int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags);
     virtual void RecvMouseWheel(int x, int y, int wheel_delta, unsigned long button_flags, unsigned long key_flags);
 
-    //! Called by LauncherIcon to signal that a Quicklist is becoming active.
-    void SetActiveQuicklist (QuicklistView *quicklist);
-    //! Get the active qicklist
-    QuicklistView *GetActiveQuicklist ();
-    //! Called by LauncherIcon to signal that a Quicklist is becoming unactive.
-    void CancelActiveQuicklist (QuicklistView *quicklist);
+    virtual void RecvQuicklistOpened (QuicklistView *quicklist);
+    virtual void RecvQuicklistClosed (QuicklistView *quicklist);
 
 protected:
     // Introspectable methods
 
=== modified file 'src/LauncherIcon.cpp'
--- src/LauncherIcon.cpp	2010-12-07 23:19:18 +0000
+++ src/LauncherIcon.cpp	2010-12-09 20:57:22 +0000
@@ -31,6 +31,7 @@
 #include "LauncherIcon.h"
 #include "Launcher.h"
 
+#include "QuicklistManager.h"
 #include "QuicklistMenuItem.h"
 #include "QuicklistMenuItemLabel.h"
 #include "QuicklistMenuItemSeparator.h"
@@ -66,9 +67,9 @@
   _sort_priority = 0;
 
   _quicklist = new QuicklistView ();
-  _quicklist->sigVisible.connect (sigc::mem_fun (this, &LauncherIcon::RecvShowQuicklist));
-  _quicklist->sigHidden.connect (sigc::mem_fun (this, &LauncherIcon::RecvHideQuicklist));
   _quicklist_is_initialized = false;
+
+  QuicklistManager::Default ()->RegisterQuicklist (_quicklist);
   
   // Add to introspection
   AddChild (_quicklist);
@@ -292,7 +293,7 @@
 void
 LauncherIcon::RecvMouseEnter ()
 {
-  if (_launcher->GetActiveQuicklist ())
+  if (QuicklistManager::Default ()->Current ())
   {
     // A quicklist is active
     return;
@@ -318,24 +319,21 @@
 {
   if (button == 3)
   {
-    if (_launcher->GetActiveQuicklist () == _quicklist)
-    {
-      // this quicklist is already active
-      return;
-    }
-    
-    if (_launcher->GetActiveQuicklist ())
-    {
+    if (QuicklistManager::Default ()->Current ())
+    {
+      // We probably should let QuicklistManager deal with this case...
+      QuicklistManager::Default ()->HideQuicklist (QuicklistManager::Default ()->Current());
+
       // Hide the active quicklist. This will prevent it from Ungrabing the pointer in 
       // QuicklistView::RecvMouseDownOutsideOfQuicklist or void QuicklistView::RecvMouseClick.
       // So the new quicklist that is about to be set as active will keep the grab of the pointer.
       // Also disable theinput window.
-      _launcher->GetActiveQuicklist ()->EnableInputWindow (false);
-      _launcher->GetActiveQuicklist ()->CaptureMouseDownAnyWhereElse (false);
+      //QuicklistManager::Default ()->Current ()->EnableInputWindow (false);
+      //QuicklistManager::Default ()->Current ()->CaptureMouseDownAnyWhereElse (false);
       // This call must be last, because after, _launcher->GetActiveQuicklist () will return Null.
       // the launcher listen to the sigHidden signal emitted by the BaseWindow when it becomes invisible
       // and it set the active window to Null.
-      _launcher->GetActiveQuicklist ()->ShowWindow (false);
+      //QuicklistManager::Default ()->Current ()->ShowWindow (false);
     }
     
     _tooltip->ShowWindow (false);
@@ -378,14 +376,8 @@
     
     int tip_x = _launcher->GetBaseWidth () + 1; //icon_x + icon_w;
     int tip_y = _center.y;
-    _quicklist->ShowQuicklistWithTipAt (tip_x, tip_y);
-
-    _quicklist->EnableInputWindow (true, 1);
-    _quicklist->GrabPointer ();
-
+    QuicklistManager::Default ()->ShowQuicklist (_quicklist, tip_x, tip_y);
     nux::GetWindowCompositor ().SetAlwaysOnFrontWindow (_quicklist);
-
-    _quicklist->NeedRedraw ();
   }
 }
 
@@ -398,16 +390,6 @@
   }
 }
 
-void LauncherIcon::RecvShowQuicklist (nux::BaseWindow *quicklist)
-{
-  _launcher->SetActiveQuicklist (_quicklist);
-}
-
-void LauncherIcon::RecvHideQuicklist (nux::BaseWindow *quicklist)
-{
-  _launcher->CancelActiveQuicklist (_quicklist);
-}
-
 void LauncherIcon::HideTooltip ()
 {
   _tooltip->ShowWindow (false);
@@ -437,7 +419,7 @@
   int tip_y = _center.y;
     
   if (_quicklist->IsVisible ())
-    _quicklist->ShowQuicklistWithTipAt (tip_x, tip_y);
+    QuicklistManager::Default ()->ShowQuicklist (_quicklist, tip_x, tip_y);
   else if (_tooltip->IsVisible ())
     _tooltip->ShowTooltipWithTipAt (tip_x, tip_y);
     
 
=== modified file 'src/LauncherIcon.h'
--- src/LauncherIcon.h	2010-12-07 23:19:18 +0000
+++ src/LauncherIcon.h	2010-12-09 20:57:22 +0000
@@ -80,9 +80,6 @@
     void RecvMouseDown (int button);
     void RecvMouseUp (int button);
     
-    void RecvShowQuicklist (nux::BaseWindow *quicklist);
-    void RecvHideQuicklist (nux::BaseWindow *quicklist);
-    
     void HideTooltip ();
     
     void        SetCenter (nux::Point3 center);
 
=== added file 'src/QuicklistManager.cpp'
--- src/QuicklistManager.cpp	1970-01-01 00:00:00 +0000
+++ src/QuicklistManager.cpp	2010-12-09 20:57:22 +0000
@@ -0,0 +1,109 @@
+/*
+ * Copyright (C) 2010 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: Jamal Fanaian <[e-mail]>
+ */
+
+#include "Nux/Nux.h"
+#include "Nux/BaseWindow.h"
+#include "Nux/VLayout.h"
+#include "Nux/WindowCompositor.h"
+#include "QuicklistView.h"
+#include "QuicklistManager.h"
+
+QuicklistManager * QuicklistManager::_default = 0;
+
+/* static */
+QuicklistManager *QuicklistManager::Default ()
+{
+  if (!_default)
+    _default = new QuicklistManager ();
+  return _default;
+}
+
+QuicklistManager::QuicklistManager ()
+{
+  _current_quicklist = 0;
+}
+
+QuicklistManager::~QuicklistManager ()
+{
+}
+
+QuicklistView *QuicklistManager::Current ()
+{
+  return _current_quicklist;
+}
+
+void QuicklistManager::RegisterQuicklist (QuicklistView *quicklist)
+{
+  std::list<QuicklistView*>::iterator it;
+
+  if (std::find (_quicklist_list.begin(), _quicklist_list.end(), quicklist) != _quicklist_list.end()) {
+    // quicklist has already been registered
+    g_warning ("Attempted to register a quicklist that was previously registered");
+    return;
+  }
+
+  _quicklist_list.push_back (quicklist);
+
+  quicklist->sigVisible.connect (sigc::mem_fun (this, &QuicklistManager::RecvShowQuicklist));
+  quicklist->sigHidden.connect (sigc::mem_fun (this, &QuicklistManager::RecvHideQuicklist));
+}
+
+void QuicklistManager::ShowQuicklist (QuicklistView *quicklist, int tip_x, 
+                                      int tip_y, bool hide_existing_if_open)
+{
+  if (_current_quicklist == quicklist) 
+  {
+    // this quicklist is already active
+    // do we want to still redraw in case the position has changed?
+    return;
+  }
+
+  if (hide_existing_if_open && _current_quicklist)
+  {
+    HideQuicklist (_current_quicklist);
+  }
+
+  quicklist->ShowQuicklistWithTipAt (tip_x, tip_y);
+}
+
+void QuicklistManager::HideQuicklist (QuicklistView *quicklist)
+{
+  quicklist->Hide();
+}
+
+void QuicklistManager::RecvShowQuicklist (nux::BaseWindow *window)
+{
+  QuicklistView *quicklist = (QuicklistView*) window;
+
+  _current_quicklist = quicklist;
+
+  quicklist_opened.emit (quicklist);
+}
+
+void QuicklistManager::RecvHideQuicklist (nux::BaseWindow *window)
+{
+  QuicklistView *quicklist = (QuicklistView*) window;
+
+  if (_current_quicklist == quicklist) 
+  { 
+    _current_quicklist = 0;
+  }
+
+  quicklist_closed.emit (quicklist);
+}
+
 
=== added file 'src/QuicklistManager.h'
--- src/QuicklistManager.h	1970-01-01 00:00:00 +0000
+++ src/QuicklistManager.h	2010-12-09 20:57:22 +0000
@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2010 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: Jamal Fanaian <[e-mail]>
+ */
+
+#ifndef QUICKLISTMANAGER_H
+#define QUICKLISTMANAGER_H
+
+class QuicklistManager : public sigc::trackable
+{
+public:
+  static QuicklistManager *Default ();
+
+  QuicklistManager ();
+
+  ~QuicklistManager ();
+
+  QuicklistView *Current ();
+
+  void RegisterQuicklist (QuicklistView *quicklist);
+  void ShowQuicklist (QuicklistView *quicklist, int tip_x, int tip_y, bool hide_existing_if_open = true);
+  void HideQuicklist (QuicklistView *quicklist);
+
+  void RecvShowQuicklist (nux::BaseWindow *window);
+  void RecvHideQuicklist (nux::BaseWindow *window);
+
+  sigc::signal<void, QuicklistView*> quicklist_opened;
+  sigc::signal<void, QuicklistView*> quicklist_closed;
+
+private:
+  static QuicklistManager *_default;
+
+  std::list<QuicklistView*> _quicklist_list;
+  QuicklistView *_current_quicklist;
+
+};
+
+#endif
+
 
=== modified file 'src/QuicklistView.cpp'
--- src/QuicklistView.cpp	2010-12-09 10:55:58 +0000
+++ src/QuicklistView.cpp	2010-12-09 20:57:22 +0000
@@ -151,7 +151,7 @@
   SetBaseX (x);
   SetBaseY (y);
   
-  ShowWindow (true);
+  Show ();
 }
 
 void QuicklistView::ShowWindow (bool b, bool start_modal)
@@ -159,6 +159,31 @@
   BaseWindow::ShowWindow (b, start_modal);
 }
 
+void QuicklistView::Show ()
+{
+  if (!IsVisible())
+  {
+    // FIXME: ShowWindow shouldn't need to be called first
+    ShowWindow (true);
+    EnableInputWindow (true, 1);
+    GrabPointer ();
+    NeedRedraw ();
+  }
+}
+
+void QuicklistView::Hide ()
+{
+  if (IsVisible() && !_enable_quicklist_for_testing)
+  {
+    CancelItemsPrelightStatus ();
+    CaptureMouseDownAnyWhereElse (false);
+    ForceStopFocus (1, 1);
+    UnGrabPointer ();
+    EnableInputWindow (false);
+    ShowWindow (false);
+  }
+}
+
 long QuicklistView::ProcessEvent (nux::IEvent& ievent, long TraverseInfo, long ProcessEventInfo)
 {
   long ret = TraverseInfo;
@@ -198,36 +223,14 @@
     else
     {
       _mouse_down = false;
-      if (IsVisible ())
-      {
-        if (!_enable_quicklist_for_testing)
-        {
-          CancelItemsPrelightStatus ();
-          CaptureMouseDownAnyWhereElse (false);
-          ForceStopFocus (1, 1);
-          UnGrabPointer ();
-          EnableInputWindow (false);
-          ShowWindow (false);
-        }
-      }
+      Hide ();
       return nux::eMouseEventSolved;
     }
   }
   else if ((ievent.e_event == nux::NUX_MOUSE_RELEASED) && _mouse_down)
   {
     _mouse_down = false;
-    if (IsVisible ())
-    {
-      if (!_enable_quicklist_for_testing)
-      {
-        CancelItemsPrelightStatus ();
-        CaptureMouseDownAnyWhereElse (false);
-        ForceStopFocus (1, 1);
-        UnGrabPointer ();
-        EnableInputWindow (false);
-        ShowWindow (false);
-      }
-    }
+    Hide ();
     return nux::eMouseEventSolved;
   }
 
@@ -418,15 +421,7 @@
     // Check if the mouse was released over an item and emit the signal
     CheckAndEmitItemSignal (x + item->GetBaseX (), y + item->GetBaseY ());
 
-    if (!_enable_quicklist_for_testing)
-    {
-      CancelItemsPrelightStatus ();
-      CaptureMouseDownAnyWhereElse (false);
-      ForceStopFocus (1, 1);
-      UnGrabPointer ();
-      EnableInputWindow (false);
-      ShowWindow (false);
-    }
+    Hide ();
   }
 }
 
@@ -474,17 +469,9 @@
   {
     // Check if the mouse was released over an item and emit the signal
     CheckAndEmitItemSignal (x + item->GetBaseX (), y + item->GetBaseY ());
-
-    if (!_enable_quicklist_for_testing)
-    {
-      CancelItemsPrelightStatus ();
-      CaptureMouseDownAnyWhereElse (false);
-      ForceStopFocus (1, 1);
-      UnGrabPointer ();
-      EnableInputWindow (false);
-      ShowWindow (false);
-    }
-  }
+    
+    Hide ();
+  }  
 }
 
 void QuicklistView::CancelItemsPrelightStatus ()
@@ -570,15 +557,7 @@
 {
   if (IsVisible ())
   {
-    if (!_enable_quicklist_for_testing)
-    {
-      CancelItemsPrelightStatus ();
-      CaptureMouseDownAnyWhereElse (false);
-      ForceStopFocus (1, 1);
-      UnGrabPointer ();
-      EnableInputWindow (false);
-      ShowWindow (false);
-    }
+    Hide ();
   }
 }
 
@@ -594,18 +573,7 @@
   
 void QuicklistView::RecvMouseDownOutsideOfQuicklist (int x, int y, unsigned long button_flags, unsigned long key_flags)
 {
-  if (IsVisible ())
-  {
-    if (!_enable_quicklist_for_testing)
-    {
-      CancelItemsPrelightStatus ();
-      CaptureMouseDownAnyWhereElse (false);
-      ForceStopFocus (1, 1);
-      UnGrabPointer ();
-      EnableInputWindow (false);
-      ShowWindow (false);
-    }
-  }
+  Hide ();
 }
 
 void QuicklistView::RemoveAllMenuItem ()
 
=== modified file 'src/QuicklistView.h'
--- src/QuicklistView.h	2010-12-09 10:55:58 +0000
+++ src/QuicklistView.h	2010-12-09 20:57:22 +0000
@@ -80,6 +80,9 @@
 
   void ShowQuicklistWithTipAt (int anchor_tip_x, int anchor_tip_y);
   virtual void ShowWindow (bool b, bool StartModal = false);
+
+  void Show ();
+  void Hide ();
   
   int GetNumItems ();
   QuicklistMenuItem* GetNthItems (int index);