Mac: Animate the bookmark bar showing/hiding.

chrome/browser/cocoa/bookmark_bar_controller.h

 // Copyright (c) 2009 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.
 
 #ifndef CHROME_BROWSER_COCOA_BOOKMARK_BAR_CONTROLLER_H_
 #define CHROME_BROWSER_COCOA_BOOKMARK_BAR_CONTROLLER_H_
 
 #import <Cocoa/Cocoa.h>
 #include <map>
 
 #include "base/scoped_nsobject.h"
 #include "base/scoped_ptr.h"
 #include "chrome/browser/cocoa/bookmark_bar_bridge.h"
 #import "chrome/browser/cocoa/bookmark_bar_toolbar_view.h"
 #include "chrome/browser/cocoa/tab_strip_model_observer_bridge.h"
 #include "webkit/glue/window_open_disposition.h"
 
-@class BackgroundGradientView;
-@class BookmarkBarStateController;
+@class BookmarkBarController;
 class BookmarkModel;
 class BookmarkNode;
 @class BookmarkBarView;
 class Browser;
-@protocol ToolbarCompressable;
 class GURL;
 @class MenuButton;
 class Profile;
 class PrefService;
+class TabContents;
 @class ToolbarController;
 @protocol ViewResizer;
 
 namespace bookmarks {
 
 // Magic numbers from Cole
 const CGFloat kDefaultBookmarkWidth = 150.0;
 const CGFloat kBookmarkVerticalPadding = 2.0;
 const CGFloat kBookmarkHorizontalPadding = 1.0;
 
 const CGFloat kNoBookmarksHorizontalOffset = 5.0;
 const CGFloat kNoBookmarksVerticalOffset = 22.0;
 const CGFloat kNoBookmarksNTPVerticalOffset = 28.0;
 
-}  // namespace
+// States for the bookmark bar.
+enum VisualState {
+  kInvalidState  = 0,
+  kHiddenState   = 1,
+  kShowingState  = 2,
+  kDetachedState = 3,
+};
+
+}  // namespace bookmarks
+
+// The interface for the bookmark bar controller's delegate. Currently, the
+// delegate is the BWC and is responsible for ensuring that the toolbar is
+// displayed correctly (as specified by |-getDesiredToolbarHeightCompression|
+// and |-shouldToolbarShowDivider|) at the beginning and at the end of an
+// animation (or after a state change).
+@protocol BookmarkBarControllerDelegate
+
+// Sent when the state has changed (after any animation), but before the final
+// display update.
+- (void)bookmarkBar:(BookmarkBarController*)controller
+ didChangeFromState:(bookmarks::VisualState)oldState
+            toState:(bookmarks::VisualState)newState;
+
+// Sent before the animation begins.
+- (void)bookmarkBar:(BookmarkBarController*)controller
+willAnimateFromState:(bookmarks::VisualState)oldState
+            toState:(bookmarks::VisualState)newState;
+
+@end
 
 // A controller for the bookmark bar in the browser window. Handles showing
 // and hiding based on the preference in the given profile.
 @interface BookmarkBarController :
-  NSViewController<BookmarkBarToolbarViewController> {
+    NSViewController<BookmarkBarToolbarViewController> {
  @private
+  // The visual state of the bookmark bar. If an animation is running, this is
+  // set to the "destination" and |lastVisualState_| is set to the "original"
+  // state. This is set to |kInvalidState| on initialization (when the
+  // appropriate state is not yet known).
+  bookmarks::VisualState visualState_;
+
+  // The "original" state of the bookmark bar if an animation is running,
+  // otherwise it should be |kInvalidState|.
+  bookmarks::VisualState lastVisualState_;
+
   Browser* browser_;              // weak; owned by its window
   BookmarkModel* bookmarkModel_;  // weak; part of the profile owned by the
                                   // top-level Browser object.
 
   // Our initial view width, which is applied in awakeFromNib.
-  float initialWidth_;
+  CGFloat initialWidth_;
 
   // BookmarkNodes have a 64bit id.  NSMenuItems have a 32bit tag used
   // to represent the bookmark node they refer to.  This map provides
   // a mapping from one to the other, so we can properly identify the
   // node from the item.  When adding items in, we start with seedId_.
   int32 seedId_;
   std::map<int32,int64> menuTagMap_;
 
   // Our bookmark buttons, ordered from L-->R.
   scoped_nsobject<NSMutableArray> buttons_;
 
   // The folder image so we can use one copy for all buttons
   scoped_nsobject<NSImage> folderImage_;
 
   // The default image, so we can use one copy for all buttons.
   scoped_nsobject<NSImage> defaultImage_;
 
   // If the bar is disabled, we hide it and ignore show/hide commands.
   // Set when using fullscreen mode.
   BOOL barIsEnabled_;
 
   // Bridge from Chrome-style C++ notifications (e.g. derived from
   // BookmarkModelObserver)
   scoped_ptr<BookmarkBarBridge> bridge_;
 
-  // Delegate that is alerted about whether it should be compressed because
-  // it's right next to us.
-  id<ToolbarCompressable> compressDelegate_;  // weak
+  // Delegate that is informed about state changes in the bookmark bar.
+  id<BookmarkBarControllerDelegate> delegate_;  // weak
 
   // Delegate that can resize us.
   id<ViewResizer> resizeDelegate_;  // weak
 
-  // Lets us get TabSelectedAt notifications.
-  scoped_ptr<TabStripModelObserverBridge> tabObserver_;
-
   IBOutlet BookmarkBarView* buttonView_;
   IBOutlet MenuButton* offTheSideButton_;  // aka the chevron
   IBOutlet NSMenu* buttonContextMenu_;
 
   // "Other bookmarks" button on the right side.
   scoped_nsobject<NSButton> otherBookmarksButton_;
 }
 
+@property(readonly, nonatomic) bookmarks::VisualState visualState;
+@property(readonly, nonatomic) bookmarks::VisualState lastVisualState;
+@property(assign, nonatomic) id<BookmarkBarControllerDelegate> delegate;
+
 // Initializes the bookmark bar controller with the given browser
 // profile and delegates.
 - (id)initWithBrowser:(Browser*)browser
-         initialWidth:(float)initialWidth
-     compressDelegate:(id<ToolbarCompressable>)compressDelegate
+         initialWidth:(CGFloat)initialWidth
+             delegate:(id<BookmarkBarControllerDelegate>)delegate
        resizeDelegate:(id<ViewResizer>)resizeDelegate;
 
-// Returns the backdrop to the bookmark bar.
-- (BackgroundGradientView*)backgroundGradientView;
+// Updates the bookmark bar (from its current, possibly in-transition) state to
+// the one appropriate for the new conditions.
+- (void)updateAndShowNormalBar:(BOOL)showNormalBar
+               showDetachedBar:(BOOL)showDetachedBar
+                 withAnimation:(BOOL)animate;
 
-// Tell the bar to show itself if needed (e.g. if the kShowBookmarkBar
-// is set).  Called once after the controller is first created.
-- (void)showIfNeeded;
-
-// Update the visible state of the bookmark bar based on the current value of
-// -[BookmarkBarController isAlwaysVisible].
+// Update the visible state of the bookmark bar.
 - (void)updateVisibility;
 
 // Turn on or off the bookmark bar and prevent or reallow its
 // appearance.  On disable, toggle off if shown.  On enable, show only
 // if needed.  For fullscreen mode.
 - (void)setBookmarkBarEnabled:(BOOL)enabled;
 
-// Returns YES if the bookmarks bar is currently visible, either because the
-// user has asked for it to always be visible, or because the current tab is the
-// New Tab page.
+// Returns YES if the bookmarks bar is currently visible (as a normal toolbar or
+// as a detached bar on the NTP), NO otherwise.
 - (BOOL)isVisible;
 
-// Returns true if the bookmark bar needs to be shown currently because a tab
-// that requires it is selected. The bookmark bar will have a different
-// appearance when it is shown if isAlwaysVisible returns NO.
-- (BOOL)isNewTabPage;
+// Returns YES if an animation is currently running, NO otherwise.
+- (BOOL)isAnimationRunning;
 
-// Returns true if the bookmark bar is visible for all tabs. (This corresponds
-// to the user having selected "Always show the bookmark bar")
-- (BOOL)isAlwaysVisible;
+// Returns YES if the bookmarks bar is (to be) shown as part of the normal
+// toolbar, NO otherwise. This is exclusive of |-isShownAsDetachedBar|.
+- (BOOL)isShownAsToolbar;
+
+// Returns YES if the bookmarks bar is (to be) shown as a detached bar, NO
+// otherwise; required for the |BookmarkBarToolbarViewController| protocol. This
+// is exclusive of |-isShownAsToolbar|.
+- (BOOL)isShownAsDetachedBar;
+
+// Returns the amount by which the toolbar above should be compressed.
+- (CGFloat)getDesiredToolbarHeightCompression;
+
+// Returns whether or not the toolbar above should show the divider.
+- (BOOL)shouldToolbarShowDivider;
 
 // Returns true if at least one bookmark was added.
 - (BOOL)addURLs:(NSArray*)urls withTitles:(NSArray*)titles at:(NSPoint)point;
 
 // Actions for manipulating bookmarks.
 // From a button, ...
 - (IBAction)openBookmark:(id)sender;
 - (IBAction)openFolderMenuFromButton:(id)sender;
 // From a context menu over the button, ...
 - (IBAction)openBookmarkInNewForegroundTab:(id)sender;
@@ skipping 25 matching lines @@
 - (void)nodeRemoved:(BookmarkModel*)model
              parent:(const BookmarkNode*)oldParent index:(int)index;
 - (void)nodeChanged:(BookmarkModel*)model
                node:(const BookmarkNode*)node;
 - (void)nodeFavIconLoaded:(BookmarkModel*)model
                      node:(const BookmarkNode*)node;
 - (void)nodeChildrenReordered:(BookmarkModel*)model
                          node:(const BookmarkNode*)node;
 @end
 
-
 // These APIs should only be used by unit tests (or used internally).
 @interface BookmarkBarController(InternalOrTestingAPI)
 - (void)openURL:(GURL)url disposition:(WindowOpenDisposition)disposition;
 - (NSCell*)cellForBookmarkNode:(const BookmarkNode*)node;
 - (void)clearBookmarkBar;
 - (BookmarkBarView*)buttonView;
 - (NSArray*)buttons;
 - (NSRect)frameForBookmarkButtonFromCell:(NSCell*)cell xOffset:(int*)xOffset;
 - (void)checkForBookmarkButtonGrowth:(NSButton*)button;
 - (void)frameDidChange;
 - (BOOL)offTheSideButtonIsHidden;
 - (NSMenu *)menuForFolderNode:(const BookmarkNode*)node;
 - (int64)nodeIdFromMenuTag:(int32)tag;
 - (int32)menuTagFromNodeId:(int64)menuid;
 - (void)buildOffTheSideMenu;
 - (NSMenu*)offTheSideMenu;
 - (NSButton*)offTheSideButton;
 - (NSButton*)otherBookmarksButton;
 @end
 
 #endif  // CHROME_BROWSER_COCOA_BOOKMARK_BAR_CONTROLLER_H_