browser_window_controller.h revision 03b57e008b61dfcb1fbad3aea950ae0e001748b0
1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef CHROME_BROWSER_UI_COCOA_BROWSER_WINDOW_CONTROLLER_H_ 6#define CHROME_BROWSER_UI_COCOA_BROWSER_WINDOW_CONTROLLER_H_ 7 8// A class acting as the Objective-C controller for the Browser 9// object. Handles interactions between Cocoa and the cross-platform 10// code. Each window has a single toolbar and, by virtue of being a 11// TabWindowController, a tab strip along the top. 12 13#import <Cocoa/Cocoa.h> 14 15#include "base/mac/scoped_nsobject.h" 16#include "base/memory/scoped_ptr.h" 17#include "chrome/browser/translate/chrome_translate_client.h" 18#import "chrome/browser/ui/cocoa/bookmarks/bookmark_bar_controller.h" 19#import "chrome/browser/ui/cocoa/bookmarks/bookmark_bubble_controller.h" 20#import "chrome/browser/ui/cocoa/browser_command_executor.h" 21#import "chrome/browser/ui/cocoa/fullscreen_exit_bubble_controller.h" 22#import "chrome/browser/ui/cocoa/tabs/tab_strip_controller.h" 23#import "chrome/browser/ui/cocoa/tabs/tab_window_controller.h" 24#import "chrome/browser/ui/cocoa/themed_window.h" 25#import "chrome/browser/ui/cocoa/url_drop_target.h" 26#import "chrome/browser/ui/cocoa/view_resizer.h" 27#include "components/translate/core/common/translate_errors.h" 28#include "ui/base/accelerators/accelerator_manager.h" 29#include "ui/gfx/rect.h" 30 31@class AvatarBaseController; 32class Browser; 33class BrowserWindow; 34class BrowserWindowCocoa; 35@class DevToolsController; 36@class DownloadShelfController; 37class ExtensionKeybindingRegistryCocoa; 38@class FindBarCocoaController; 39@class FullscreenModeController; 40@class FullscreenWindow; 41@class InfoBarContainerController; 42class LocationBarViewMac; 43@class OverlayableContentsController; 44class PermissionBubbleCocoa; 45@class PresentationModeController; 46class StatusBubbleMac; 47@class TabStripController; 48@class TabStripView; 49@class ToolbarController; 50@class TranslateBubbleController; 51 52namespace content { 53class WebContents; 54} 55 56namespace extensions { 57class Command; 58} 59 60@interface BrowserWindowController : 61 TabWindowController<NSUserInterfaceValidations, 62 BookmarkBarControllerDelegate, 63 BrowserCommandExecutor, 64 ViewResizer, 65 TabStripControllerDelegate> { 66 @private 67 // The ordering of these members is important as it determines the order in 68 // which they are destroyed. |browser_| needs to be destroyed last as most of 69 // the other objects hold weak references to it or things it owns 70 // (tab/toolbar/bookmark models, profiles, etc). 71 scoped_ptr<Browser> browser_; 72 NSWindow* savedRegularWindow_; 73 scoped_ptr<BrowserWindowCocoa> windowShim_; 74 base::scoped_nsobject<ToolbarController> toolbarController_; 75 base::scoped_nsobject<TabStripController> tabStripController_; 76 base::scoped_nsobject<FindBarCocoaController> findBarCocoaController_; 77 base::scoped_nsobject<InfoBarContainerController> infoBarContainerController_; 78 base::scoped_nsobject<DownloadShelfController> downloadShelfController_; 79 base::scoped_nsobject<BookmarkBarController> bookmarkBarController_; 80 base::scoped_nsobject<DevToolsController> devToolsController_; 81 base::scoped_nsobject<OverlayableContentsController> 82 overlayableContentsController_; 83 base::scoped_nsobject<PresentationModeController> presentationModeController_; 84 base::scoped_nsobject<FullscreenModeController> fullscreenModeController_; 85 base::scoped_nsobject<FullscreenExitBubbleController> 86 fullscreenExitBubbleController_; 87 88 // Strong. StatusBubble is a special case of a strong reference that 89 // we don't wrap in a scoped_ptr because it is acting the same 90 // as an NSWindowController in that it wraps a window that must 91 // be shut down before our destructors are called. 92 StatusBubbleMac* statusBubble_; 93 94 BookmarkBubbleController* bookmarkBubbleController_; // Weak. 95 BOOL initializing_; // YES while we are currently in initWithBrowser: 96 BOOL ownsBrowser_; // Only ever NO when testing 97 98 TranslateBubbleController* translateBubbleController_; // Weak. 99 100 // The total amount by which we've grown the window up or down (to display a 101 // bookmark bar and/or download shelf), respectively; reset to 0 when moved 102 // away from the bottom/top or resized (or zoomed). 103 CGFloat windowTopGrowth_; 104 CGFloat windowBottomGrowth_; 105 106 // YES only if we're shrinking the window from an apparent zoomed state (which 107 // we'll only do if we grew it to the zoomed state); needed since we'll then 108 // restrict the amount of shrinking by the amounts specified above. Reset to 109 // NO on growth. 110 BOOL isShrinkingFromZoomed_; 111 112 // The view controller that manages the incognito badge or the multi-profile 113 // avatar button. Depending on whether the --new-profile-management flag is 114 // used, the multi-profile button can either be the avatar's icon badge or a 115 // button with the profile's name. If the flag is used, the button is always 116 // shown, otherwise the view will always be in the view hierarchy but will 117 // be hidden unless it's appropriate to show it (i.e. if there's more than 118 // one profile). 119 base::scoped_nsobject<AvatarBaseController> avatarButtonController_; 120 121 // Lazily created view which draws the background for the floating set of bars 122 // in presentation mode (for window types having a floating bar; it remains 123 // nil for those which don't). 124 base::scoped_nsobject<NSView> floatingBarBackingView_; 125 126 // The borderless window used in fullscreen mode when Cocoa's System 127 // Fullscreen API is not being used (or not available, before OS 10.7). 128 base::scoped_nsobject<NSWindow> fullscreenWindow_; 129 130 // The Cocoa implementation of the PermissionBubbleView. 131 scoped_ptr<PermissionBubbleCocoa> permissionBubbleCocoa_; 132 133 // True between |-windowWillEnterFullScreen:| and |-windowDidEnterFullScreen:| 134 // to indicate that the window is in the process of transitioning into 135 // fullscreen mode. 136 BOOL enteringFullscreen_; 137 138 // True between |-setPresentationMode:url:bubbleType:| and 139 // |-windowDidEnterFullScreen:| to indicate that the window is in the process 140 // of transitioning into fullscreen presentation mode. 141 BOOL enteringPresentationMode_; 142 143 // The size of the original (non-fullscreen) window. This is saved just 144 // before entering fullscreen mode and is only valid when |-isFullscreen| 145 // returns YES. 146 NSRect savedRegularWindowFrame_; 147 148 // The proportion of the floating bar which is shown (in presentation mode). 149 CGFloat floatingBarShownFraction_; 150 151 // Various UI elements/events may want to ensure that the floating bar is 152 // visible (in presentation mode), e.g., because of where the mouse is or 153 // where keyboard focus is. Whenever an object requires bar visibility, it has 154 // itself added to |barVisibilityLocks_|. When it no longer requires bar 155 // visibility, it has itself removed. 156 base::scoped_nsobject<NSMutableSet> barVisibilityLocks_; 157 158 // Bar visibility locks and releases only result (when appropriate) in changes 159 // in visible state when the following is |YES|. 160 BOOL barVisibilityUpdatesEnabled_; 161 162 // When going fullscreen for a tab, we need to store the URL and the 163 // fullscreen type, since we can't show the bubble until 164 // -windowDidEnterFullScreen: gets called. 165 GURL fullscreenUrl_; 166 FullscreenExitBubbleType fullscreenBubbleType_; 167 168 // The Extension Command Registry used to determine which keyboard events to 169 // handle. 170 scoped_ptr<ExtensionKeybindingRegistryCocoa> extension_keybinding_registry_; 171 172 // Whether the root view of the window is layer backed. 173 BOOL windowViewWantsLayer_; 174} 175 176// A convenience class method which gets the |BrowserWindowController| for a 177// given window. This method returns nil if no window in the chain has a BWC. 178+ (BrowserWindowController*)browserWindowControllerForWindow:(NSWindow*)window; 179 180// A convenience class method which gets the |BrowserWindowController| for a 181// given view. This is the controller for the window containing |view|, if it 182// is a BWC, or the first controller in the parent-window chain that is a 183// BWC. This method returns nil if no window in the chain has a BWC. 184+ (BrowserWindowController*)browserWindowControllerForView:(NSView*)view; 185 186// Helper method used to update the "Signin" menu item to reflect the current 187// signed in state. Class-level function as it's still required even when there 188// are no open browser windows. 189+ (void)updateSigninItem:(id)signinItem 190 shouldShow:(BOOL)showSigninMenuItem 191 currentProfile:(Profile*)profile; 192 193// Load the browser window nib and do any Cocoa-specific initialization. 194// Takes ownership of |browser|. 195- (id)initWithBrowser:(Browser*)browser; 196 197// Call to make the browser go away from other places in the cross-platform 198// code. 199- (void)destroyBrowser; 200 201// Ensure bounds for the window abide by the minimum window size. 202- (gfx::Rect)enforceMinWindowSize:(gfx::Rect)bounds; 203 204// Access the C++ bridge between the NSWindow and the rest of Chromium. 205- (BrowserWindow*)browserWindow; 206 207// Return a weak pointer to the toolbar controller. 208- (ToolbarController*)toolbarController; 209 210// Return a weak pointer to the tab strip controller. 211- (TabStripController*)tabStripController; 212 213// Return a weak pointer to the find bar controller. 214- (FindBarCocoaController*)findBarCocoaController; 215 216// Access the ObjC controller that contains the infobars. 217- (InfoBarContainerController*)infoBarContainerController; 218 219// Access the C++ bridge object representing the status bubble for the window. 220- (StatusBubbleMac*)statusBubble; 221 222// Access the C++ bridge object representing the location bar. 223- (LocationBarViewMac*)locationBarBridge; 224 225// Returns a weak pointer to the floating bar backing view; 226- (NSView*)floatingBarBackingView; 227 228// Returns a weak pointer to the overlayable contents controller. 229- (OverlayableContentsController*)overlayableContentsController; 230 231// Access the Profile object that backs this Browser. 232- (Profile*)profile; 233 234// Access the avatar button controller. 235- (AvatarBaseController*)avatarButtonController; 236 237// Forces the toolbar (and transitively the location bar) to update its current 238// state. If |tab| is non-NULL, we're switching (back?) to this tab and should 239// restore any previous location bar state (such as user editing) as well. 240- (void)updateToolbarWithContents:(content::WebContents*)tab; 241 242// Sets whether or not the current page in the frontmost tab is bookmarked. 243- (void)setStarredState:(BOOL)isStarred; 244 245// Sets whether or not the current page is translated. 246- (void)setCurrentPageIsTranslated:(BOOL)on; 247 248// Happens when the zoom level is changed in the active tab, the active tab is 249// changed, or a new browser window or tab is created. |canShowBubble| denotes 250// whether it would be appropriate to show a zoom bubble or not. 251- (void)zoomChangedForActiveTab:(BOOL)canShowBubble; 252 253// Return the rect, in WebKit coordinates (flipped), of the window's grow box 254// in the coordinate system of the content area of the currently selected tab. 255- (NSRect)selectedTabGrowBoxRect; 256 257// Called to tell the selected tab to update its loading state. 258// |force| is set if the update is due to changing tabs, as opposed to 259// the page-load finishing. See comment in reload_button.h. 260- (void)setIsLoading:(BOOL)isLoading force:(BOOL)force; 261 262// Brings this controller's window to the front. 263- (void)activate; 264 265// Make the location bar the first responder, if possible. 266- (void)focusLocationBar:(BOOL)selectAll; 267 268// Make the (currently-selected) tab contents the first responder, if possible. 269- (void)focusTabContents; 270 271// Returns the frame of the regular (non-fullscreened) window (even if the 272// window is currently in fullscreen mode). The frame is returned in Cocoa 273// coordinates (origin in bottom-left). 274- (NSRect)regularWindowFrame; 275 276// Whether or not to show the avatar, which is either the incognito guy or the 277// user's profile avatar. 278- (BOOL)shouldShowAvatar; 279 280// Whether or not to show the new avatar button used by --new-profile-maagement. 281- (BOOL)shouldUseNewAvatarButton; 282 283- (BOOL)isBookmarkBarVisible; 284 285// Returns YES if the bookmark bar is currently animating. 286- (BOOL)isBookmarkBarAnimating; 287 288- (BookmarkBarController*)bookmarkBarController; 289 290- (DevToolsController*)devToolsController; 291 292- (BOOL)isDownloadShelfVisible; 293 294// Lazily creates the download shelf in visible state if it doesn't exist yet. 295- (DownloadShelfController*)downloadShelf; 296 297// Retains the given FindBarCocoaController and adds its view to this 298// browser window. Must only be called once per 299// BrowserWindowController. 300- (void)addFindBar:(FindBarCocoaController*)findBarCocoaController; 301 302// The user changed the theme. 303- (void)userChangedTheme; 304 305// Executes the command in the context of the current browser. 306// |command| is an integer value containing one of the constants defined in the 307// "chrome/app/chrome_command_ids.h" file. 308- (void)executeCommand:(int)command; 309 310// Consults the Command Registry to see if this |event| needs to be handled as 311// an extension command and returns YES if so (NO otherwise). 312// Only extensions with the given |priority| are considered. 313- (BOOL)handledByExtensionCommand:(NSEvent*)event 314 priority:(ui::AcceleratorManager::HandlerPriority)priority; 315 316// Delegate method for the status bubble to query its base frame. 317- (NSRect)statusBubbleBaseFrame; 318 319// Show the bookmark bubble (e.g. user just clicked on the STAR) 320- (void)showBookmarkBubbleForURL:(const GURL&)url 321 alreadyBookmarked:(BOOL)alreadyBookmarked; 322 323// Show the translate bubble. 324- (void)showTranslateBubbleForWebContents:(content::WebContents*)contents 325 step:(translate::TranslateStep)step 326 errorType: 327 (translate::TranslateErrors::Type)errorType; 328 329// Shows or hides the docked web inspector depending on |contents|'s state. 330- (void)updateDevToolsForContents:(content::WebContents*)contents; 331 332// Gets the current theme provider. 333- (ui::ThemeProvider*)themeProvider; 334 335// Gets the window style. 336- (ThemedWindowStyle)themedWindowStyle; 337 338// Returns the position in the coordinates of the root view 339// ([[self contentView] superview]) that the top left of a theme image with 340// |alignment| should be painted at. If the window does not have a tab strip, 341// the offset for THEME_IMAGE_ALIGN_WITH_FRAME is always returned. The result of 342// this method can be used in conjunction with 343// [NSGraphicsContext cr_setPatternPhase:] to set the offset of pattern colors. 344- (NSPoint)themeImagePositionForAlignment:(ThemeImageAlignment)alignment; 345 346// Return the point to which a bubble window's arrow should point, in window 347// coordinates. 348- (NSPoint)bookmarkBubblePoint; 349 350// Called when the Add Search Engine dialog is closed. 351- (void)sheetDidEnd:(NSWindow*)sheet 352 returnCode:(NSInteger)code 353 context:(void*)context; 354 355// Executes the command registered by the extension that has the given id. 356- (void)executeExtensionCommand:(const std::string&)extension_id 357 command:(const extensions::Command&)command; 358 359// Activates the page action for the extension that has the given id. 360- (void)activatePageAction:(const std::string&)extension_id; 361 362// Activates the browser action for the extension that has the given id. 363- (void)activateBrowserAction:(const std::string&)extension_id; 364 365@end // @interface BrowserWindowController 366 367 368// Methods having to do with the window type (normal/popup/app, and whether the 369// window has various features; fullscreen and presentation mode methods are 370// separate). 371@interface BrowserWindowController(WindowType) 372 373// Determines whether this controller's window supports a given feature (i.e., 374// whether a given feature is or can be shown in the window). 375// TODO(viettrungluu): |feature| is really should be |Browser::Feature|, but I 376// don't want to include browser.h (and you can't forward declare enums). 377- (BOOL)supportsWindowFeature:(int)feature; 378 379// Called to check whether or not this window has a normal title bar (YES if it 380// does, NO otherwise). (E.g., normal browser windows do not, pop-ups do.) 381- (BOOL)hasTitleBar; 382 383// Called to check whether or not this window has a toolbar (YES if it does, NO 384// otherwise). (E.g., normal browser windows do, pop-ups do not.) 385- (BOOL)hasToolbar; 386 387// Called to check whether or not this window has a location bar (YES if it 388// does, NO otherwise). (E.g., normal browser windows do, pop-ups may or may 389// not.) 390- (BOOL)hasLocationBar; 391 392// Called to check whether or not this window can have bookmark bar (YES if it 393// does, NO otherwise). (E.g., normal browser windows may, pop-ups may not.) 394- (BOOL)supportsBookmarkBar; 395 396// Called to check if this controller's window is a tabbed window (e.g., not a 397// pop-up window). Returns YES if it is, NO otherwise. 398// Note: The |-has...| methods are usually preferred, so this method is largely 399// deprecated. 400- (BOOL)isTabbedWindow; 401 402@end // @interface BrowserWindowController(WindowType) 403 404 405// Methods having to do with fullscreen and presentation mode. 406@interface BrowserWindowController(Fullscreen) 407 408// Toggles fullscreen mode. Meant to be called by Lion windows when they enter 409// or exit Lion fullscreen mode. Must not be called on Snow Leopard or earlier. 410- (void)handleLionToggleFullscreen; 411 412// Enters (or exits) fullscreen mode. This method is safe to call on all OS 413// versions. 414- (void)enterFullscreen; 415- (void)exitFullscreen; 416 417// Updates the contents of the fullscreen exit bubble with |url| and 418// |bubbleType|. 419- (void)updateFullscreenExitBubbleURL:(const GURL&)url 420 bubbleType:(FullscreenExitBubbleType)bubbleType; 421 422// Returns fullscreen state: YES when the window is in fullscreen or is 423// animating into fullscreen. 424- (BOOL)isFullscreen; 425 426// Returns YES if the browser window is currently in fullscreen via the built-in 427// immersive mechanism. 428- (BOOL)isInImmersiveFullscreen; 429 430// Returns YES if the browser window is currently in fullscreen via the Cocoa 431// System Fullscreen API. 432- (BOOL)isInSystemFullscreen; 433 434// Enters (or exits) presentation mode. Also enters fullscreen mode if this 435// window is not already fullscreen. This method is safe to call on all OS 436// versions. 437- (void)enterPresentationModeForURL:(const GURL&)url 438 bubbleType:(FullscreenExitBubbleType)bubbleType; 439- (void)exitPresentationMode; 440 441// For simplified fullscreen: Enters fullscreen for a tab at a URL. The |url| 442// is guaranteed to be non-empty; see -enterFullscreen for the user-initiated 443// fullscreen mode. Called on Snow Leopard and Lion+. 444- (void)enterFullscreenForURL:(const GURL&)url 445 bubbleType:(FullscreenExitBubbleType)bubbleType; 446 447// Returns presentation mode state. This method is safe to call on all OS 448// versions. 449- (BOOL)inPresentationMode; 450 451// Resizes the fullscreen window to fit the screen it's currently on. Called by 452// the PresentationModeController when there is a change in monitor placement or 453// resolution. 454- (void)resizeFullscreenWindow; 455 456// Gets or sets the fraction of the floating bar (presentation mode overlay) 457// that is shown. 0 is completely hidden, 1 is fully shown. 458- (CGFloat)floatingBarShownFraction; 459- (void)setFloatingBarShownFraction:(CGFloat)fraction; 460 461// Query/lock/release the requirement that the tab strip/toolbar/attached 462// bookmark bar bar cluster is visible (e.g., when one of its elements has 463// focus). This is required for the floating bar in presentation mode, but 464// should also be called when not in presentation mode; see the comments for 465// |barVisibilityLocks_| for more details. Double locks/releases by the same 466// owner are ignored. If |animate:| is YES, then an animation may be performed, 467// possibly after a small delay if |delay:| is YES. If |animate:| is NO, 468// |delay:| will be ignored. In the case of multiple calls, later calls have 469// precedence with the rule that |animate:NO| has precedence over |animate:YES|, 470// and |delay:NO| has precedence over |delay:YES|. 471- (BOOL)isBarVisibilityLockedForOwner:(id)owner; 472- (void)lockBarVisibilityForOwner:(id)owner 473 withAnimation:(BOOL)animate 474 delay:(BOOL)delay; 475- (void)releaseBarVisibilityForOwner:(id)owner 476 withAnimation:(BOOL)animate 477 delay:(BOOL)delay; 478 479// Returns YES if any of the views in the floating bar currently has focus. 480- (BOOL)floatingBarHasFocus; 481 482@end // @interface BrowserWindowController(Fullscreen) 483 484 485// Methods which are either only for testing, or only public for testing. 486@interface BrowserWindowController (TestingAPI) 487 488// Put the incognito badge or multi-profile avatar on the browser and adjust the 489// tab strip accordingly. 490- (void)installAvatar; 491 492// Allows us to initWithBrowser withOUT taking ownership of the browser. 493- (id)initWithBrowser:(Browser*)browser takeOwnership:(BOOL)ownIt; 494 495// Adjusts the window height by the given amount. If the window spans from the 496// top of the current workspace to the bottom of the current workspace, the 497// height is not adjusted. If growing the window by the requested amount would 498// size the window to be taller than the current workspace, the window height is 499// capped to be equal to the height of the current workspace. If the window is 500// partially offscreen, its height is not adjusted at all. This function 501// prefers to grow the window down, but will grow up if needed. Calls to this 502// function should be followed by a call to |layoutSubviews|. 503// Returns if the window height was changed. 504- (BOOL)adjustWindowHeightBy:(CGFloat)deltaH; 505 506// Return an autoreleased NSWindow suitable for fullscreen use. 507- (NSWindow*)createFullscreenWindow; 508 509// Resets any saved state about window growth (due to showing the bookmark bar 510// or the download shelf), so that future shrinking will occur from the bottom. 511- (void)resetWindowGrowthState; 512 513// Computes by how far in each direction, horizontal and vertical, the 514// |source| rect doesn't fit into |target|. 515- (NSSize)overflowFrom:(NSRect)source 516 to:(NSRect)target; 517 518// The fullscreen exit bubble controller, or nil if the bubble isn't showing. 519- (FullscreenExitBubbleController*)fullscreenExitBubbleController; 520 521// Gets the rect, in window base coordinates, that the omnibox popup should be 522// positioned relative to. 523- (NSRect)omniboxPopupAnchorRect; 524 525// Force a layout of info bars. 526- (void)layoutInfoBars; 527 528@end // @interface BrowserWindowController (TestingAPI) 529 530 531#endif // CHROME_BROWSER_UI_COCOA_BROWSER_WINDOW_CONTROLLER_H_ 532