[Mac] Makes the download shelf auto-close after the user opens all downloads...

chrome/browser/cocoa/download_shelf_controller.mm

 // Copyright (c) 2010 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.
 
 #import "chrome/browser/cocoa/download_shelf_controller.h"
 
 #include "app/l10n_util.h"
 #include "app/resource_bundle.h"
 #include "base/mac_util.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/browser/browser.h"
 #import "chrome/browser/cocoa/animatable_view.h"
 #include "chrome/browser/cocoa/browser_window_cocoa.h"
 #import "chrome/browser/cocoa/browser_window_controller.h"
 #include "chrome/browser/cocoa/download_item_controller.h"
 #include "chrome/browser/cocoa/download_shelf_mac.h"
 #import "chrome/browser/cocoa/download_shelf_view.h"
 #import "chrome/browser/cocoa/hyperlink_button_cell.h"
 #include "chrome/browser/download/download_item.h"
 #include "chrome/browser/download/download_manager.h"
 #include "chrome/browser/profile.h"
 #include "chrome/browser/themes/browser_theme_provider.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #import "third_party/GTM/AppKit/GTMNSAnimation+Duration.h"
 
+// Download shelf autoclose behavior:
+//
+// The download shelf autocloses if all of:

[Nico, 2010/12/12 22:03:19]

"if all this is true:"

+// 1) An item on the shelf has just been opened.
+// 2) All remaining items on the shelf have been opened in the past.
+// 3) The mouse leaves the shelf and remains off the shelf for 5 seconds.
+//
+// If the mouse re-enters the shelf within the 5 second grace period, the
+// autoclose is canceled.  An autoclose can only be scheduled in response to a
+// shelf item being opened or removed.  If an item is opened and then the
+// resulting autoclose is canceled, subsequent mouse exited events will NOT
+// trigger an autoclose.
+//
+// If the shelf is manually closed while a download is still in progress, that
+// download is marked as "opened" for these purposes.  If the shelf is later
+// reopened, these previously-in-progress download will not block autoclose,
+// even if that download was never actually clicked on and opened.

[Nico, 2010/09/28 18:12:29]

Is there some way to have this logic (and this comment) in the model code
instead of in all the different view code?

[rohitrao (ping after 24h), 2010/09/28 19:12:59]

I don't think there's a suitable cross-platform class that can handle this. 
Unless I'm mistaken, the view code holds the list of download items, since
there's no C++ shelf object.

[Nico, 2010/09/29 15:52:46]

Should there be one?

+
 namespace {
 
 // Max number of download views we'll contain. Any time a view is added and
 // we already have this many download views, one is removed.
 const size_t kMaxDownloadItemCount = 16;
 
 // Horizontal padding between two download items.
 const int kDownloadItemPadding = 0;
 
 // Duration for the open-new-leftmost-item animation, in seconds.
 const NSTimeInterval kDownloadItemOpenDuration = 0.8;
 
 // Duration for download shelf closing animation, in seconds.
 const NSTimeInterval kDownloadShelfCloseDuration = 0.12;
 
+// Amount of time between when the mouse is moved off the shelf and the shelf is
+// autoclosed, in seconds.
+const NSTimeInterval kAutoCloseDelay = 5;

[Nico, 2010/12/12 22:03:19]

kAutoCloseDelaySeconds

+
 }  // namespace
 
 @interface DownloadShelfController(Private)
 - (void)showDownloadShelf:(BOOL)enable;
 - (void)layoutItems:(BOOL)skipFirst;
 - (void)closed;
+- (BOOL)canAutoClose;
 
 - (void)updateTheme;
 - (void)themeDidChangeNotification:(NSNotification*)notification;
 - (void)viewFrameDidChange:(NSNotification*)notification;
+
+- (void)installTrackingArea;
+- (void)cancelAutoCloseAndRemoveTrackingArea;
 @end
 
 
 @implementation DownloadShelfController
 
 - (id)initWithBrowser:(Browser*)browser
        resizeDelegate:(id<ViewResizer>)resizeDelegate {
   if ((self = [super initWithNibName:@"DownloadShelf"
                               bundle:mac_util::MainAppBundle()])) {
     resizeDelegate_ = resizeDelegate;
@@ skipping 31 matching lines @@
                       object:[self view]];
 
   ResourceBundle& rb = ResourceBundle::GetSharedInstance();
   NSImage* favicon = rb.GetNSImageNamed(IDR_DOWNLOADS_FAVICON);
   DCHECK(favicon);
   [image_ setImage:favicon];
 }
 
 - (void)dealloc {
   [[NSNotificationCenter defaultCenter] removeObserver:self];
+  [self cancelAutoCloseAndRemoveTrackingArea];
 
   // The controllers will unregister themselves as observers when they are
   // deallocated. No need to do that here.
   [super dealloc];
 }
 
 // Called after the current theme has changed.
 - (void)themeDidChangeNotification:(NSNotification*)notification {
   [self updateTheme];
 }
@@ skipping 53 matching lines @@
 
   [downloadItemControllers_ removeObject:download];
 
   [self layoutItems];
 
   // Check to see if we have any downloads remaining and if not, hide the shelf.
   if (![downloadItemControllers_ count])
     [self showDownloadShelf:NO];
 }
 
+- (void)downloadWasOpened:(DownloadItemController*)item_controller {
+  // This should only be called on the main thead.
+  DCHECK([NSThread isMainThread]);
+
+  if ([self canAutoClose])
+    [self installTrackingArea];
+}
+
 // We need to explicitly release our download controllers here since they need
 // to remove themselves as observers before the remaining shutdown happens.
 - (void)exiting {
   [[self animatableView] stopAnimation];
+  [self cancelAutoCloseAndRemoveTrackingArea];
   downloadItemControllers_.reset();
 }
 
 // Show or hide the bar based on the value of |enable|. Handles animating the
 // resize of the content view.
 - (void)showDownloadShelf:(BOOL)enable {
   if ([self isVisible] == enable)
     return;
 
   if ([[self view] window])
@@ skipping 19 matching lines @@
 
 - (BOOL)isVisible {
   return barIsVisible_;
 }
 
 - (void)show:(id)sender {
   [self showDownloadShelf:YES];
 }
 
 - (void)hide:(id)sender {
+  [self cancelAutoCloseAndRemoveTrackingArea];
+
   // If |sender| isn't nil, then we're being closed from the UI by the user and
   // we need to tell our shelf implementation to close. Otherwise, we're being
   // closed programmatically by our shelf implementation.
   if (sender)
     bridge_->Close();
   else
     [self showDownloadShelf:NO];
 }
 
 - (void)animationDidEnd:(NSAnimation*)animation {
@@ skipping 19 matching lines @@
     skipFirst = NO;
   }
 }
 
 - (void)layoutItems {
   [self layoutItems:NO];
 }
 
 - (void)addDownloadItem:(BaseDownloadItemModel*)model {
   DCHECK([NSThread isMainThread]);
+  [self cancelAutoCloseAndRemoveTrackingArea];
+
   // Insert new item at the left.
   scoped_nsobject<DownloadItemController> controller(
       [[DownloadItemController alloc] initWithModel:model shelf:self]);
 
   // Adding at index 0 in NSMutableArrays is O(1).
   [downloadItemControllers_ insertObject:controller.get() atIndex:0];
 
   [itemContainerView_ addSubview:[controller view]];
 
   // The controller is in charge of removing itself as an observer in its
@@ skipping 37 matching lines @@
   // laying out the items, so that the longer animation duration we set up above
   // is not overwritten.
   [self layoutItems:YES];
 }
 
 - (void)closed {
   NSUInteger i = 0;
   while (i < [downloadItemControllers_ count]) {
     DownloadItemController* itemController =
         [downloadItemControllers_ objectAtIndex:i];
+    DownloadItem* download = [itemController download];
     bool isTransferDone =
-        [itemController download]->state() == DownloadItem::COMPLETE ||
-        [itemController download]->state() == DownloadItem::CANCELLED;
+        download->state() == DownloadItem::COMPLETE ||
+        download->state() == DownloadItem::CANCELLED;
     if (isTransferDone &&
-        [itemController download]->safety_state() != DownloadItem::DANGEROUS) {
+        download->safety_state() != DownloadItem::DANGEROUS) {
       [self remove:itemController];
     } else {
+      // Treat the item as opened when we close. This way if we get shown again
+      // the user need not open this item for the shelf to auto-close.
+      download->set_opened(true);
       ++i;
     }
   }
 }
 
+- (void)mouseEntered:(NSEvent*)event {
+  // If the mouse re-enters the download shelf, cancel the auto-close.  Further
+  // mouse exits should not trigger autoclose, so also remove the tracking area.
+  [self cancelAutoCloseAndRemoveTrackingArea];
+}
+
+- (void)mouseExited:(NSEvent*)event {
+  // Cancel any previous hide requests, just to be safe.
+  [NSObject cancelPreviousPerformRequestsWithTarget:self
+                                           selector:@selector(hide:)
+                                             object:self];
+
+  // Schedule an autoclose after a delay.  If the mouse is moved back into the
+  // view, or if an item is added to the shelf, the timer will be canceled.
+  [self performSelector:@selector(hide:)
+             withObject:self
+             afterDelay:kAutoCloseDelay];
+}
+
+- (BOOL)canAutoClose {
+  for (NSUInteger i = 0; i < [downloadItemControllers_ count]; ++i) {
+    DownloadItemController* itemController =
+        [downloadItemControllers_ objectAtIndex:i];
+    if (![itemController download]->opened())
+      return NO;
+  }
+  return YES;
+}
+
+- (void)installTrackingArea {
+  // Install the tracking area to listen for mouseExited messages and trigger
+  // the shelf autoclose.
+  if (trackingArea_.get())
+    return;
+
+  trackingArea_.reset([[NSTrackingArea alloc]
+                        initWithRect:[[self view] bounds]
+                             options:NSTrackingMouseEnteredAndExited |
+                                     NSTrackingActiveAlways
+                               owner:self
+                            userInfo:nil]);
+  [[self view] addTrackingArea:trackingArea_];
+}
+
+- (void)cancelAutoCloseAndRemoveTrackingArea {
+  [NSObject cancelPreviousPerformRequestsWithTarget:self
+                                           selector:@selector(hide:)
+                                             object:self];
+
+  if (trackingArea_.get()) {
+    [[self view] removeTrackingArea:trackingArea_];
+    trackingArea_.reset(nil);
+  }
+}
+
 @end