Make the gtk download shelf autoclose on mouse out.

chrome/browser/ui/gtk/download_shelf_gtk.cc

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/ui/gtk/download_shelf_gtk.h"
 
 #include <string>
 
 #include "chrome/browser/download/download_item.h"
 #include "chrome/browser/download/download_item_model.h"
 #include "chrome/browser/download/download_util.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/gtk/browser_window_gtk.h"
 #include "chrome/browser/ui/gtk/custom_button.h"
 #include "chrome/browser/ui/gtk/download_item_gtk.h"
 #include "chrome/browser/ui/gtk/gtk_chrome_link_button.h"
 #include "chrome/browser/ui/gtk/gtk_chrome_shrinkable_hbox.h"
 #include "chrome/browser/ui/gtk/gtk_theme_provider.h"
 #include "chrome/browser/ui/gtk/gtk_util.h"
 #include "chrome/common/notification_service.h"
 #include "gfx/gtk_util.h"
+#include "gfx/insets.h"
+#include "gfx/point.h"
+#include "gfx/rect.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 
 namespace {
 
 // The height of the download items.
 const int kDownloadItemHeight = download_util::kSmallProgressIconSize;
 
 // Padding between the download widgets.
 const int kDownloadItemPadding = 10;
 
 // Padding between the top/bottom of the download widgets and the edge of the
 // shelf.
 const int kTopBottomPadding = 4;
 
 // Padding between the left side of the shelf and the first download item.
 const int kLeftPadding = 2;
 
 // Padding between the right side of the shelf and the close button.
 const int kRightPadding = 10;
 
 // Speed of the shelf show/hide animation.
 const int kShelfAnimationDurationMs = 120;
 
+// The time between when the user mouses out of the download shelf zone and
+// when the shelf closes (when auto-close is enabled).
+const int kAutoCloseDelayMs = 300;
+
+// The area to the top of the shelf that is considered part of its "zone".
+const int kShelfAuraSize = 40;
+
 }  // namespace
 
 DownloadShelfGtk::DownloadShelfGtk(Browser* browser, GtkWidget* parent)
     : browser_(browser),
       is_showing_(false),
-      theme_provider_(GtkThemeProvider::GetFrom(browser->profile())) {
+      theme_provider_(GtkThemeProvider::GetFrom(browser->profile())),
+      close_on_mouse_out_(false),
+      mouse_in_shelf_(false),
+      auto_close_factory_(this) {

[sky, 2011/01/31 17:14:04]

Do we only use the ALLOW_THIS_IN... macro on windows?

[Evan Stade, 2011/01/31 18:59:49]

yep

   // Logically, the shelf is a vbox that contains two children: a one pixel
   // tall event box, which serves as the top border, and an hbox, which holds
   // the download items and other shelf widgets (close button, show-all-
   // downloads link).
   // To make things pretty, we have to add a few more widgets. To get padding
   // right, we stick the hbox in an alignment. We put that alignment in an
   // event box so we can color the background.
 
   // Create the top border.
   top_border_ = gtk_event_box_new();
@@ skipping 78 matching lines @@
 }
 
 DownloadShelfGtk::~DownloadShelfGtk() {
   for (std::vector<DownloadItemGtk*>::iterator iter = download_items_.begin();
        iter != download_items_.end(); ++iter) {
     delete *iter;
   }
 
   shelf_.Destroy();
   items_hbox_.Destroy();
 }

[sky, 2011/01/31 17:14:04]

Do you need SetCloseOnMouseOut(false) ?
Otherwise if close_on_mouse_out_ is true won't the MessageLoop still have this
DownloadShelfGtk as an observer?

[Evan Stade, 2011/01/31 18:59:49]

I suppose I do

 
 void DownloadShelfGtk::AddDownload(BaseDownloadItemModel* download_model_) {
   download_items_.push_back(new DownloadItemGtk(this, download_model_));
   Show();
 }
 
 bool DownloadShelfGtk::IsShowing() const {
   return slide_widget_->IsShowing();
 }
 
 bool DownloadShelfGtk::IsClosing() const {
   return slide_widget_->IsClosing();
 }
 
 void DownloadShelfGtk::Show() {
   slide_widget_->Open();
   browser_->UpdateDownloadShelfVisibility(true);
+  CancelAutoClose();
 }
 
 void DownloadShelfGtk::Close() {
   // When we are closing, we can vertically overlap the render view. Make sure
   // we are on top.
   gdk_window_raise(shelf_.get()->window);
   slide_widget_->Close();
   browser_->UpdateDownloadShelfVisibility(false);
+  SetCloseOnMouseOut(false);
 }
 
 Browser* DownloadShelfGtk::browser() const {
   return browser_;
 }
 
 void DownloadShelfGtk::Closed() {
   // When the close animation is complete, remove all completed downloads.
   size_t i = 0;
   while (i < download_items_.size()) {
     DownloadItem* download = download_items_[i]->get_download();
     bool is_transfer_done = download->state() == DownloadItem::COMPLETE ||
                             download->state() == DownloadItem::CANCELLED;
     if (is_transfer_done &&
         download->safety_state() != DownloadItem::DANGEROUS) {
       RemoveDownloadItem(download_items_[i]);
     } else {
+      // We set all remaining items as "opened", so that the shelf will auto-
+      // close in the future without the user clicking on them.
+      download->set_opened(true);
       ++i;
     }
   }
 }
 
 void DownloadShelfGtk::Observe(NotificationType type,
                                const NotificationSource& source,
                                const NotificationDetails& details) {
   if (type == NotificationType::BROWSER_THEME_CHANGED) {
     GdkColor color = theme_provider_->GetGdkColor(
@@ skipping 34 matching lines @@
 void DownloadShelfGtk::RemoveDownloadItem(DownloadItemGtk* download_item) {
   DCHECK(download_item);
   std::vector<DownloadItemGtk*>::iterator i =
       find(download_items_.begin(), download_items_.end(), download_item);
   DCHECK(i != download_items_.end());
   download_items_.erase(i);
   delete download_item;
   if (download_items_.empty()) {
     slide_widget_->CloseWithoutAnimation();
     browser_->UpdateDownloadShelfVisibility(false);
+  } else {
+    AutoCloseIfPossible();
   }
 }
 
 GtkWidget* DownloadShelfGtk::GetHBox() const {
   return items_hbox_.get();
 }
 
 void DownloadShelfGtk::MaybeShowMoreDownloadItems() {
   // Show all existing download items. It'll trigger "size-allocate" signal,
   // which will hide download items that don't have enough space to show.
   gtk_widget_show_all(items_hbox_.get());
 }
 
 void DownloadShelfGtk::OnButtonClick(GtkWidget* button) {
   if (button == close_button_->widget()) {
     Close();
   } else {
     // The link button was clicked.
     browser_->ShowDownloadsTab();
   }
 }
+
+void DownloadShelfGtk::AutoCloseIfPossible() {
+  for (std::vector<DownloadItemGtk*>::iterator iter = download_items_.begin();
+       iter != download_items_.end(); ++iter) {
+    if (!(*iter)->get_download()->opened())
+      return;
+  }
+
+  SetCloseOnMouseOut(true);
+}
+
+void DownloadShelfGtk::CancelAutoClose() {
+  SetCloseOnMouseOut(false);
+  auto_close_factory_.RevokeAll();
+}
+
+void DownloadShelfGtk::ItemOpened() {
+  AutoCloseIfPossible();
+}
+
+void DownloadShelfGtk::SetCloseOnMouseOut(bool close) {
+  if (close_on_mouse_out_ == close)
+    return;
+
+  close_on_mouse_out_ = close;
+  mouse_in_shelf_ = close;
+  if (close)
+    MessageLoopForUI::current()->AddObserver(this);
+  else
+    MessageLoopForUI::current()->RemoveObserver(this);
+}
+
+void DownloadShelfGtk::WillProcessEvent(GdkEvent* event) {
+}
+
+void DownloadShelfGtk::DidProcessEvent(GdkEvent* event) {
+  gfx::Point cursor_screen_coords;
+
+  switch (event->type) {
+    case GDK_MOTION_NOTIFY:
+      cursor_screen_coords =
+          gfx::Point(event->motion.x_root, event->motion.y_root);
+      break;
+    case GDK_LEAVE_NOTIFY:
+      cursor_screen_coords =
+          gfx::Point(event->crossing.x_root, event->crossing.y_root);
+      break;
+    default:
+      return;
+  }
+
+  bool mouse_in_shelf = IsCursorInShelfZone(cursor_screen_coords);
+  if (mouse_in_shelf == mouse_in_shelf_)
+    return;
+  mouse_in_shelf_ = mouse_in_shelf;
+
+  if (mouse_in_shelf)
+    MouseEnteredShelf();
+  else
+    MouseLeftShelf();
+}
+
+bool DownloadShelfGtk::IsCursorInShelfZone(
+    const gfx::Point& cursor_screen_coords) {
+  gfx::Rect bounds(gtk_util::GetWidgetScreenPosition(shelf_.get()),
+                   gfx::Size(shelf_.get()->allocation.width,
+                             shelf_.get()->allocation.height));
+
+  // Negative insets expand the rectangle. We only expand the top.
+  bounds.Inset(gfx::Insets(-kShelfAuraSize, 0, 0, 0));
+
+  return bounds.Contains(cursor_screen_coords);
+}
+
+void DownloadShelfGtk::MouseLeftShelf() {
+  DCHECK(close_on_mouse_out_);
+
+  MessageLoop::current()->PostDelayedTask(
+      FROM_HERE,
+      auto_close_factory_.NewRunnableMethod(&DownloadShelfGtk::Close),
+      kAutoCloseDelayMs);
+}
+
+void DownloadShelfGtk::MouseEnteredShelf() {
+  auto_close_factory_.RevokeAll();
+}