Rework how bookmark bar folder menus and submenus are layed out when scrollin...

chrome/browser/ui/cocoa/bookmarks/bookmark_bar_folder_controller.h

 // 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.
 
+#ifndef CHROME_BROWSER_UI_COCOA_BOOKMARKS_BOOKMARK_BAR_FOLDER_CONTROLLER_H_
+#define CHROME_BROWSER_UI_COCOA_BOOKMARKS_BOOKMARK_BAR_FOLDER_CONTROLLER_H_
+#pragma once
+
 #import <Cocoa/Cocoa.h>
 
 #include "base/scoped_nsobject.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_button.h"
 
 @class BookmarkBarController;
 @class BookmarkBarFolderView;
 @class BookmarkFolderTarget;
 @class BookmarkBarFolderHoverState;
+@class BookmarkBarFolderWindow;
+@class BookmarkBarFolderWindowContentView;
 
 // A controller for the pop-up windows from bookmark folder buttons
 // which look sort of like menus.
 @interface BookmarkBarFolderController :
     NSWindowController<BookmarkButtonDelegate,
                        BookmarkButtonControllerProtocol> {
  @private
   // The button whose click opened us.
   scoped_nsobject<BookmarkButton> parentButton_;
 
@@ skipping 29 matching lines @@
 
   // The main bar controller from whence we or a parent sprang.
   BookmarkBarController* barController_;  // WEAK: It owns us.
 
   // Our buttons.  We do not have buttons for nested folders.
   scoped_nsobject<NSMutableArray> buttons_;
 
   // The scroll view that contains our main button view (below).
   IBOutlet NSScrollView* scrollView_;
 
-  // Are we scrollable?  If no, the full contents of the folder are
-  // always visible.
-  BOOL scrollable_;
+  // The view defining the visible area in which we draw our content.
+  IBOutlet BookmarkBarFolderWindowContentView* visibleView_;
 
-  BOOL scrollUpArrowShown_;
-  BOOL scrollDownArrowShown_;
+  // The main view of this window (where the buttons go) within the scroller.
+  IBOutlet BookmarkBarFolderView* folderView_;
+
+  // A window used to show the shadow behind the main window when it is
+  // scrollable.
+  IBOutlet BookmarkBarFolderWindow* shadowWindow_;

[John Grabowski, 2011/01/06 23:30:18]

Why are you faking a shadow yourself instead of using an NSWindow shadow
property?  Or is it not possible to set that manually?

[mrossetti, 2011/01/08 01:45:38]

Added commentary to explain.

+
+  // The up and down scroll arrow views.

[John Grabowski, 2011/01/06 23:30:18]

Be clear that these views are not inside the scrollable area.

[mrossetti, 2011/01/08 01:45:38]

Added commentary.

+  IBOutlet NSView* scrollDownArrowView_;  // Positioned at the top.
+  IBOutlet NSView* scrollUpArrowView_;  // Positioned at the bottom.
 
   // YES if subfolders should grow to the right (the default).
   // Direction switches if we'd grow off the screen.
   BOOL subFolderGrowthToRight_;
 
-  // The main view of this window (where the buttons go).
-  IBOutlet BookmarkBarFolderView* mainView_;
-
   // Weak; we keep track to work around a
   // setShowsBorderOnlyWhileMouseInside bug.
   BookmarkButton* buttonThatMouseIsIn_;
 
   // The context menu for a bookmark button which represents an URL.
   IBOutlet NSMenu* buttonMenu_;
 
   // The context menu for a bookmark button which represents a folder.
   IBOutlet NSMenu* folderMenu_;
 
@@ skipping 11 matching lines @@
   // window closes the controller gets autoreleased).
   BookmarkBarFolderController* folderController_;
 
   // Implement basic menu scrolling through this tracking area.
   scoped_nsobject<NSTrackingArea> scrollTrackingArea_;
 
   // Timer to continue scrolling as needed.  We own the timer but
   // don't release it when done (we invalidate it).
   NSTimer* scrollTimer_;
 
+  // Precalculated left and right edge padding of buttons in a folder menu.

[John Grabowski, 2011/01/06 23:30:18]

Reading this quickly I wonder why these aren't constants.  Looks like they are,
but defined implicitly through other variables (e.g. button offset).  Is that
correct?

[mrossetti, 2011/01/08 01:45:38]

These are calculated from the nib layout and are not constant so that any future
nib adjustments can be accommodate without also touching the code. There's no
real reason I need both a left and right padding variable (at least at this
time) so I'm shrunk them down into a single 'padding_' for now.

+  CGFloat leftPadding_;
+  CGFloat rightPadding_;
+
   // Amount to scroll by on each timer fire.  Can be + or -.
   CGFloat verticalScrollDelta_;
 
   // We need to know the size of the vertical scrolling arrows so we
   // can obscure/unobscure them.
   CGFloat verticalScrollArrowHeight_;
 
   // Set to YES to prevent any node animations. Useful for unit testing so that
   // incomplete animations do not cause valgrind complaints.
   BOOL ignoreAnimations_;
@@ skipping 36 matching lines @@
 - (IBAction)openAllBookmarksNewWindow:(id)sender;
 - (IBAction)openBookmarkInIncognitoWindow:(id)sender;
 - (IBAction)openBookmarkInNewForegroundTab:(id)sender;
 - (IBAction)openBookmarkInNewWindow:(id)sender;
 
 @property (assign, nonatomic) BOOL subFolderGrowthToRight;
 
 @end
 
 @interface BookmarkBarFolderController(TestingAPI)
-- (NSView*)mainView;
 - (NSPoint)windowTopLeftForWidth:(int)windowWidth;
 - (NSArray*)buttons;
 - (BookmarkBarFolderController*)folderController;
 - (id)folderTarget;
 - (void)configureWindowLevel;
 - (void)performOneScroll:(CGFloat)delta;
 - (BookmarkButton*)buttonThatMouseIsIn;
 // Set to YES in order to prevent animations.
 - (void)setIgnoreAnimations:(BOOL)ignore;
 
-// Return YES if we can scroll up or down.
+// Return YES if the scroll-up or scroll-down arrows are showing.
 - (BOOL)canScrollUp;
 - (BOOL)canScrollDown;
-// Return YES if the scrollable_ flag has been set.
-- (BOOL)scrollable;
+- (CGFloat)verticalScrollArrowHeight;
+- (NSView*)visibleView;
+- (NSView*)scrollView;
+- (NSView*)folderView;
 
 - (BookmarkButton*)buttonForDroppingOnAtPoint:(NSPoint)point;
 @end
+
+#endif  // CHROME_BROWSER_UI_COCOA_BOOKMARKS_BOOKMARK_BAR_FOLDER_CONTROLLER_H_