1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
|
// Copyright (c) 2012 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/ui/cocoa/toolbar/toolbar_controller.h"
#include <algorithm>
#include "base/mac/bundle_locations.h"
#include "base/mac/foundation_util.h"
#include "base/mac/mac_util.h"
#include "base/mac/sdk_forward_declarations.h"
#include "base/macros.h"
#include "base/memory/singleton.h"
#include "base/strings/string_util.h"
#include "base/strings/sys_string_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "chrome/app/chrome_command_ids.h"
#include "chrome/browser/autocomplete/autocomplete_classifier_factory.h"
#include "chrome/browser/chrome_notification_types.h"
#include "chrome/browser/command_observer.h"
#include "chrome/browser/command_updater.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/recovery/recovery_install_global_error_factory.h"
#include "chrome/browser/search/search.h"
#include "chrome/browser/sync/sync_global_error_factory.h"
#include "chrome/browser/themes/theme_service.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_commands.h"
#include "chrome/browser/ui/browser_window.h"
#import "chrome/browser/ui/cocoa/app_menu/app_menu_controller.h"
#import "chrome/browser/ui/cocoa/background_gradient_view.h"
#include "chrome/browser/ui/cocoa/drag_util.h"
#import "chrome/browser/ui/cocoa/extensions/browser_action_button.h"
#import "chrome/browser/ui/cocoa/extensions/browser_actions_container_view.h"
#import "chrome/browser/ui/cocoa/extensions/browser_actions_controller.h"
#import "chrome/browser/ui/cocoa/gradient_button_cell.h"
#import "chrome/browser/ui/cocoa/image_button_cell.h"
#import "chrome/browser/ui/cocoa/l10n_util.h"
#import "chrome/browser/ui/cocoa/location_bar/autocomplete_text_field_editor.h"
#import "chrome/browser/ui/cocoa/location_bar/location_bar_decoration.h"
#import "chrome/browser/ui/cocoa/location_bar/location_bar_view_mac.h"
#import "chrome/browser/ui/cocoa/location_bar/star_decoration.h"
#import "chrome/browser/ui/cocoa/menu_button.h"
#import "chrome/browser/ui/cocoa/toolbar/app_toolbar_button.h"
#import "chrome/browser/ui/cocoa/toolbar/app_toolbar_button_cell.h"
#import "chrome/browser/ui/cocoa/toolbar/back_forward_menu_controller.h"
#import "chrome/browser/ui/cocoa/toolbar/reload_button_cocoa.h"
#import "chrome/browser/ui/cocoa/toolbar/toolbar_button_cocoa.h"
#import "chrome/browser/ui/cocoa/toolbar/toolbar_view_cocoa.h"
#import "chrome/browser/ui/cocoa/view_id_util.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/browser/ui/toolbar/app_menu_icon_controller.h"
#include "chrome/browser/ui/toolbar/app_menu_model.h"
#include "chrome/common/pref_names.h"
#include "chrome/grit/chromium_strings.h"
#include "chrome/grit/generated_resources.h"
#include "chrome/grit/theme_resources.h"
#include "components/metrics/proto/omnibox_event.pb.h"
#include "components/omnibox/browser/autocomplete_classifier.h"
#include "components/omnibox/browser/autocomplete_match.h"
#include "components/omnibox/browser/omnibox_edit_model.h"
#include "components/omnibox/browser/omnibox_view.h"
#include "components/prefs/pref_service.h"
#include "components/search_engines/template_url_service.h"
#include "components/strings/grit/components_strings.h"
#include "components/url_formatter/url_fixer.h"
#include "content/public/browser/web_contents.h"
#import "ui/base/cocoa/menu_controller.h"
#import "ui/base/cocoa/nsview_additions.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/l10n/l10n_util_mac.h"
#include "ui/base/material_design/material_design_controller.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/image/image.h"
using content::OpenURLParams;
using content::Referrer;
using content::WebContents;
namespace {
// Duration of the toolbar animation.
const NSTimeInterval kToolBarAnimationDuration = 0.12;
// The height of the location bar.
const CGFloat kLocationBarHeight = 28;
// The padding between the top of the toolbar and the top of the
// location bar.
const CGFloat kLocationBarPadding = 2;
// The padding between elements and the edges of the toolbar.
const CGFloat kElementPadding = 4;
// Toolbar buttons are 24x24 and centered in a 28x28 space, so there is a 2pt-
// wide inset.
const CGFloat kButtonInset = 2;
// The y-offset of the browser actions container from the location bar.
const CGFloat kContainerYOffset = 2;
// The minimum width of the location bar in pixels.
const CGFloat kMinimumLocationBarWidth = 100.0;
} // namespace
@interface ToolbarController()
@property(assign, nonatomic) Browser* browser;
// Height of the location bar. Used for animating the toolbar in and out when
// the location bar is displayed stand-alone for bookmark apps.
+ (CGFloat)locationBarHeight;
// Return the amount of horizontal padding that the app menu should have on
// each side.
+ (CGFloat)appMenuPadding;
- (void)cleanUp;
- (void)addAccessibilityDescriptions;
- (void)initCommandStatus:(CommandUpdater*)commands;
- (void)prefChanged:(const std::string&)prefName;
- (ToolbarView*)toolbarView;
// Height of the toolbar in pixels when the bookmark bar is closed.
- (CGFloat)baseToolbarHeight;
- (void)toolbarFrameChanged;
- (void)showLocationBarOnly;
- (void)pinLocationBarBeforeBrowserActionsContainerAndAnimate:(BOOL)animate;
- (void)maintainMinimumLocationBarWidth;
- (void)adjustBrowserActionsContainerForNewWindow:(NSNotification*)notification;
- (void)browserActionsContainerDragged:(NSNotification*)notification;
- (void)browserActionsVisibilityChanged:(NSNotification*)notification;
- (void)browserActionsContainerWillAnimate:(NSNotification*)notification;
- (void)adjustLocationSizeBy:(CGFloat)dX animate:(BOOL)animate;
- (void)updateAppMenuButtonSeverity:(AppMenuIconController::Severity)severity
iconType:(AppMenuIconController::IconType)iconType
animate:(BOOL)animate;
@end
namespace ToolbarControllerInternal {
// A C++ bridge class that handles listening for updates to commands and
// passing them back to ToolbarController. ToolbarController will create one of
// these bridges, pass them to CommandUpdater::AddCommandObserver, and then wait
// for update notifications, delivered via
// -enabledStateChangedForCommand:enabled:.
class CommandObserverBridge : public CommandObserver {
public:
explicit CommandObserverBridge(ToolbarController* observer)
: observer_(observer) {
DCHECK(observer_);
}
protected:
// Overridden from CommandObserver
void EnabledStateChangedForCommand(int command, bool enabled) override {
[observer_ enabledStateChangedForCommand:command enabled:enabled];
}
private:
ToolbarController* observer_; // weak, owns me
DISALLOW_COPY_AND_ASSIGN(CommandObserverBridge);
};
// A class registered for C++ notifications. This is used to detect changes in
// preferences and upgrade available notifications. Bridges the notification
// back to the ToolbarController.
class NotificationBridge : public AppMenuIconController::Delegate {
public:
explicit NotificationBridge(ToolbarController* controller)
: controller_(controller),
app_menu_icon_controller_([controller browser]->profile(), this) {}
~NotificationBridge() override {}
void UpdateSeverity() { app_menu_icon_controller_.UpdateDelegate(); }
void UpdateSeverity(AppMenuIconController::IconType type,
AppMenuIconController::Severity severity,
bool animate) override {
[controller_ updateAppMenuButtonSeverity:severity
iconType:type
animate:animate];
}
void OnPreferenceChanged(const std::string& pref_name) {
[controller_ prefChanged:pref_name];
}
private:
ToolbarController* controller_; // weak, owns us
AppMenuIconController app_menu_icon_controller_;
DISALLOW_COPY_AND_ASSIGN(NotificationBridge);
};
} // namespace ToolbarControllerInternal
@implementation ToolbarController
@synthesize browser = browser_;
+ (CGFloat)locationBarHeight {
return kLocationBarHeight;
}
+ (CGFloat)appMenuPadding {
return kElementPadding;
}
+ (CGFloat)materialDesignButtonInset {
return kButtonInset;
}
- (id)initWithCommands:(CommandUpdater*)commands
profile:(Profile*)profile
browser:(Browser*)browser
resizeDelegate:(id<ViewResizer>)resizeDelegate {
DCHECK(commands && profile);
if ((self = [super initWithNibName:@"Toolbar"
bundle:base::mac::FrameworkBundle()])) {
commands_ = commands;
profile_ = profile;
browser_ = browser;
hasToolbar_ = YES;
hasLocationBar_ = YES;
// Register for notifications about state changes for the toolbar buttons
commandObserver_.reset(
new ToolbarControllerInternal::CommandObserverBridge(self));
commands->AddCommandObserver(IDC_BACK, commandObserver_.get());
commands->AddCommandObserver(IDC_FORWARD, commandObserver_.get());
commands->AddCommandObserver(IDC_RELOAD, commandObserver_.get());
commands->AddCommandObserver(IDC_HOME, commandObserver_.get());
commands->AddCommandObserver(IDC_BOOKMARK_PAGE, commandObserver_.get());
// NOTE: Don't remove the command observers. ToolbarController is
// autoreleased at about the same time as the CommandUpdater (owned by the
// Browser), so |commands_| may not be valid any more.
[[self toolbarView] setResizeDelegate:resizeDelegate];
// Start global error services now so we badge the menu correctly.
SyncGlobalErrorFactory::GetForProfile(profile);
RecoveryInstallGlobalErrorFactory::GetForProfile(profile);
}
return self;
}
// Called after the view is done loading and the outlets have been hooked up.
// Now we can hook up bridges that rely on UI objects such as the location bar
// and button state. -viewDidLoad is the recommended way to do this in 10.10
// SDK. When running on 10.10 or above -awakeFromNib still works but for some
// reason is not guaranteed to be called (http://crbug.com/526276), so implement
// both.
- (void)awakeFromNib {
[self viewDidLoad];
}
- (void)viewDidLoad {
// When linking and running on 10.10+, both -awakeFromNib and -viewDidLoad may
// be called, don't initialize twice.
if (locationBarView_) {
DCHECK(base::mac::IsAtLeastOS10_10());
return;
}
BOOL isRTL = cocoa_l10n_util::ShouldDoExperimentalRTLLayout();
NSAutoresizingMaskOptions leadingButtonMask =
isRTL ? NSViewMinXMargin | NSViewMinYMargin
: NSViewMaxXMargin | NSViewMinYMargin;
NSAutoresizingMaskOptions trailingButtonMask =
isRTL ? NSViewMaxXMargin | NSViewMinYMargin
: NSViewMinXMargin | NSViewMinYMargin;
// Make Material Design layout adjustments to the NIB items.
ToolbarView* toolbarView = [self toolbarView];
NSRect toolbarBounds = [toolbarView bounds];
NSSize toolbarButtonSize = [ToolbarButton toolbarButtonSize];
// Set the toolbar height.
NSRect frame = [toolbarView frame];
frame.size.height = [self baseToolbarHeight];
[toolbarView setFrame:frame];
NSArray* leadingButtons =
@[ backButton_, forwardButton_, reloadButton_, homeButton_ ];
const CGFloat xStart = kElementPadding + kButtonInset;
const CGFloat xOffset = toolbarButtonSize.width + kButtonInset * 2;
const CGFloat yPosition =
NSMaxY(toolbarBounds) - kElementPadding - toolbarButtonSize.height;
for (NSUInteger i = 0; i < [leadingButtons count]; i++) {
NSButton* button = leadingButtons[i];
NSRect buttonFrame = [button frame];
buttonFrame.size = toolbarButtonSize;
buttonFrame.origin.y = yPosition;
const CGFloat xPosition = xStart + i * xOffset;
buttonFrame.origin.x =
isRTL ? NSWidth(frame) - toolbarButtonSize.width - xPosition
: xPosition;
[button setFrame:buttonFrame];
[button setAutoresizingMask:leadingButtonMask];
}
// Replace the app button from the nib with an AppToolbarButton instance for
// Material Design.
AppToolbarButton* newMenuButton =
[[[AppToolbarButton alloc] initWithFrame:[appMenuButton_ frame]]
autorelease];
[newMenuButton setAutoresizingMask:[appMenuButton_ autoresizingMask]];
[[appMenuButton_ superview] addSubview:newMenuButton];
[appMenuButton_ removeFromSuperview];
appMenuButton_ = newMenuButton;
// Adjust the menu button's position.
NSRect menuButtonFrame = [appMenuButton_ frame];
if (isRTL) {
menuButtonFrame.origin.x = [ToolbarController appMenuPadding];
} else {
CGFloat menuButtonFrameMaxX =
NSMaxX(toolbarBounds) - [ToolbarController appMenuPadding];
menuButtonFrame.origin.x =
menuButtonFrameMaxX - kButtonInset - toolbarButtonSize.width;
}
menuButtonFrame.origin.y = yPosition;
menuButtonFrame.size = toolbarButtonSize;
[appMenuButton_ setFrame:menuButtonFrame];
[appMenuButton_ setAutoresizingMask:trailingButtonMask];
// Adjust the size and location on the location bar to take up the
// space between the reload and menu buttons.
NSRect locationBarFrame = [locationBar_ frame];
locationBarFrame.origin.x = isRTL
? NSMaxX(menuButtonFrame) + kButtonInset
: NSMaxX([homeButton_ frame]) + kButtonInset;
if (![homeButton_ isHidden] && !isRTL) {
// Ensure proper spacing between the home button and location bar
locationBarFrame.origin.x += kElementPadding;
}
locationBarFrame.origin.y =
NSMaxY(toolbarBounds) - kLocationBarPadding - kLocationBarHeight;
CGFloat rightEdge = 0;
if (isRTL) {
rightEdge = NSMinX([homeButton_ frame]) - kButtonInset;
if (![homeButton_ isHidden])
rightEdge -= kElementPadding;
} else {
rightEdge = NSMinX(menuButtonFrame);
}
locationBarFrame.size.width = rightEdge - NSMinX(locationBarFrame);
locationBarFrame.size.height = kLocationBarHeight;
[locationBar_ setFrame:locationBarFrame];
// Correctly position the extension buttons' container view.
NSRect containerFrame = [browserActionsContainerView_ frame];
containerFrame.size.width += kButtonInset;
containerFrame.origin.y = locationBarFrame.origin.y + kContainerYOffset;
containerFrame.size.height = toolbarButtonSize.height;
if (cocoa_l10n_util::ShouldDoExperimentalRTLLayout())
containerFrame.origin.x = NSMinX(locationBarFrame);
[browserActionsContainerView_ setFrame:containerFrame];
[browserActionsContainerView_ setAutoresizingMask:trailingButtonMask];
notificationBridge_.reset(
new ToolbarControllerInternal::NotificationBridge(self));
notificationBridge_->UpdateSeverity();
[appMenuButton_ setOpenMenuOnClick:YES];
[backButton_ setOpenMenuOnRightClick:YES];
[forwardButton_ setOpenMenuOnRightClick:YES];
[backButton_ setHandleMiddleClick:YES];
[forwardButton_ setHandleMiddleClick:YES];
[reloadButton_ setHandleMiddleClick:YES];
[homeButton_ setHandleMiddleClick:YES];
[self initCommandStatus:commands_];
[reloadButton_ setCommandUpdater:commands_];
locationBarView_.reset(new LocationBarViewMac(locationBar_, commands_,
profile_, browser_));
[locationBar_ setFont:[NSFont systemFontOfSize:14]];
// Add the location bar's accessibility views as direct subviews of the
// toolbar. They are logical children of the location bar, but the location
// bar's actual Cocoa control is an NSCell, so it cannot have child views.
// The |locationBarView_| is responsible for positioning the accessibility
// views.
std::vector<NSView*> accessibility_views =
locationBarView_->GetDecorationAccessibilityViews();
for (const auto& view : accessibility_views) {
[[self toolbarView] addSubview:view
positioned:NSWindowAbove
relativeTo:locationBar_];
}
// Register pref observers for the optional home and page/options buttons
// and then add them to the toolbar based on those prefs.
PrefService* prefs = profile_->GetPrefs();
showHomeButton_.Init(
prefs::kShowHomeButton, prefs,
base::Bind(
&ToolbarControllerInternal::NotificationBridge::OnPreferenceChanged,
base::Unretained(notificationBridge_.get())));
[self showOptionalHomeButton];
[self installAppMenu];
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:NO];
// Create the controllers for the back/forward menus.
backMenuController_.reset([[BackForwardMenuController alloc]
initWithBrowser:browser_
modelType:BACK_FORWARD_MENU_TYPE_BACK
button:backButton_]);
forwardMenuController_.reset([[BackForwardMenuController alloc]
initWithBrowser:browser_
modelType:BACK_FORWARD_MENU_TYPE_FORWARD
button:forwardButton_]);
trackingArea_.reset(
[[CrTrackingArea alloc] initWithRect:NSZeroRect // Ignored
options:NSTrackingMouseMoved |
NSTrackingInVisibleRect |
NSTrackingMouseEnteredAndExited |
NSTrackingActiveAlways
owner:self
userInfo:nil]);
NSView* parentView = [self view];
[parentView addTrackingArea:trackingArea_.get()];
// If the user has any Browser Actions installed, the container view for them
// may have to be resized depending on the width of the toolbar frame.
[parentView setPostsFrameChangedNotifications:YES];
[[NSNotificationCenter defaultCenter]
addObserver:self
selector:@selector(toolbarFrameChanged)
name:NSViewFrameDidChangeNotification
object:parentView];
// Set ViewIDs for toolbar elements which don't have their dedicated class.
// ViewIDs of |toolbarView|, |reloadButton_|, |locationBar_| and
// |browserActionsContainerView_| are handled by themselves.
view_id_util::SetID(backButton_, VIEW_ID_BACK_BUTTON);
view_id_util::SetID(forwardButton_, VIEW_ID_FORWARD_BUTTON);
view_id_util::SetID(homeButton_, VIEW_ID_HOME_BUTTON);
view_id_util::SetID(appMenuButton_, VIEW_ID_APP_MENU);
[self addAccessibilityDescriptions];
}
- (void)dealloc {
[self cleanUp];
[super dealloc];
}
- (void)browserWillBeDestroyed {
// Clear resize delegate so it doesn't get called during stopAnimation, and
// stop any in-flight animation.
[[self toolbarView] setResizeDelegate:nil];
[[self toolbarView] stopAnimation];
// Pass this call onto other reference counted objects.
[backMenuController_ browserWillBeDestroyed];
[forwardMenuController_ browserWillBeDestroyed];
[browserActionsController_ browserWillBeDestroyed];
[appMenuController_ browserWillBeDestroyed];
[self cleanUp];
}
- (void)cleanUp {
// Unset ViewIDs of toolbar elements.
// ViewIDs of |toolbarView|, |reloadButton_|, |locationBar_| and
// |browserActionsContainerView_| are handled by themselves.
view_id_util::UnsetID(backButton_);
view_id_util::UnsetID(forwardButton_);
view_id_util::UnsetID(homeButton_);
view_id_util::UnsetID(appMenuButton_);
// Make sure any code in the base class which assumes [self view] is
// the "parent" view continues to work.
hasToolbar_ = YES;
hasLocationBar_ = YES;
[[NSNotificationCenter defaultCenter] removeObserver:self];
if (trackingArea_.get()) {
[[self view] removeTrackingArea:trackingArea_.get()];
[trackingArea_.get() clearOwner];
trackingArea_.reset();
}
// Destroy owned objects that hold a weak Browser*.
locationBarView_.reset();
browser_ = nullptr;
}
- (void)addAccessibilityDescriptions {
// Set accessibility descriptions. http://openradar.appspot.com/7496255
NSString* description = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_BACK);
[[backButton_ cell]
accessibilitySetOverrideValue:description
forAttribute:NSAccessibilityDescriptionAttribute];
NSString* helpTag = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_TOOLTIP_BACK);
[[backButton_ cell]
accessibilitySetOverrideValue:helpTag
forAttribute:NSAccessibilityHelpAttribute];
description = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_FORWARD);
[[forwardButton_ cell]
accessibilitySetOverrideValue:description
forAttribute:NSAccessibilityDescriptionAttribute];
helpTag = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_TOOLTIP_FORWARD);
[[forwardButton_ cell]
accessibilitySetOverrideValue:helpTag
forAttribute:NSAccessibilityHelpAttribute];
description = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_RELOAD);
[[reloadButton_ cell]
accessibilitySetOverrideValue:description
forAttribute:NSAccessibilityDescriptionAttribute];
description = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_HOME);
[[homeButton_ cell]
accessibilitySetOverrideValue:description
forAttribute:NSAccessibilityDescriptionAttribute];
description = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_LOCATION);
[[locationBar_ cell]
accessibilitySetOverrideValue:description
forAttribute:NSAccessibilityDescriptionAttribute];
description = l10n_util::GetNSStringWithFixup(IDS_ACCNAME_APP);
[[appMenuButton_ cell]
accessibilitySetOverrideValue:description
forAttribute:NSAccessibilityDescriptionAttribute];
}
- (void)mouseExited:(NSEvent*)theEvent {
[[hoveredButton_ cell] setIsMouseInside:NO];
[hoveredButton_ release];
hoveredButton_ = nil;
}
- (NSButton*)hoverButtonForEvent:(NSEvent*)theEvent {
NSButton* targetView = (NSButton*)[[self view]
hitTest:[theEvent locationInWindow]];
// Only interpret the view as a hoverButton_ if it's both button and has a
// button cell that cares. GradientButtonCell derived cells care.
if (([targetView isKindOfClass:[NSButton class]]) &&
([[targetView cell]
respondsToSelector:@selector(setIsMouseInside:)]))
return targetView;
return nil;
}
- (void)mouseMoved:(NSEvent*)theEvent {
NSButton* targetView = [self hoverButtonForEvent:theEvent];
if (hoveredButton_ != targetView) {
[[hoveredButton_ cell] setIsMouseInside:NO];
[[targetView cell] setIsMouseInside:YES];
[hoveredButton_ release];
hoveredButton_ = [targetView retain];
}
}
- (void)mouseEntered:(NSEvent*)event {
[self mouseMoved:event];
}
- (LocationBarViewMac*)locationBarBridge {
return locationBarView_.get();
}
- (void)locationBarWasAddedToWindow {
// Allow the |locationBarView_| to update itself to match the browser window
// theme.
locationBarView_->OnAddedToWindow();
}
- (void)focusLocationBar:(BOOL)selectAll {
if (locationBarView_.get()) {
locationBarView_->FocusLocation(selectAll ? true : false);
}
}
// Called when the state for a command changes to |enabled|. Update the
// corresponding UI element.
- (void)enabledStateChangedForCommand:(int)command enabled:(bool)enabled {
NSButton* button = nil;
switch (command) {
case IDC_BACK:
button = backButton_;
break;
case IDC_FORWARD:
button = forwardButton_;
break;
case IDC_HOME:
button = homeButton_;
break;
}
[button setEnabled:enabled];
}
// Init the enabled state of the buttons on the toolbar to match the state in
// the controller.
- (void)initCommandStatus:(CommandUpdater*)commands {
[backButton_ setEnabled:commands->IsCommandEnabled(IDC_BACK) ? YES : NO];
[forwardButton_
setEnabled:commands->IsCommandEnabled(IDC_FORWARD) ? YES : NO];
[reloadButton_ setEnabled:YES];
[homeButton_ setEnabled:commands->IsCommandEnabled(IDC_HOME) ? YES : NO];
}
- (void)updateToolbarWithContents:(WebContents*)tab {
locationBarView_->Update(tab);
[locationBar_ updateMouseTracking];
if (browserActionsController_.get()) {
[browserActionsController_ update];
}
BOOL needReloadMenu = chrome::IsDebuggerAttachedToCurrentTab(browser_);
[reloadButton_ setMenuEnabled:needReloadMenu];
}
- (void)resetTabState:(WebContents*)tab {
locationBarView_->ResetTabState(tab);
}
- (void)setStarredState:(BOOL)isStarred {
locationBarView_->SetStarred(isStarred);
}
- (void)setTranslateIconLit:(BOOL)on {
locationBarView_->SetTranslateIconLit(on);
}
- (void)zoomChangedForActiveTab:(BOOL)canShowBubble {
locationBarView_->ZoomChangedForActiveTab(
canShowBubble && ![appMenuController_ isMenuOpen]);
}
- (void)setIsLoading:(BOOL)isLoading force:(BOOL)force {
[reloadButton_ setIsLoading:isLoading force:force];
}
- (void)setHasToolbar:(BOOL)toolbar hasLocationBar:(BOOL)locBar {
[self view]; // Force nib loading.
hasToolbar_ = toolbar;
// If there's a toolbar, there must be a location bar.
DCHECK((toolbar && locBar) || !toolbar);
hasLocationBar_ = toolbar ? YES : locBar;
// Decide whether to hide/show based on whether there's a location bar.
[[self view] setHidden:!hasLocationBar_];
// Make location bar not editable when in a pop-up or an app window.
locationBarView_->SetEditable(toolbar);
// If necessary, resize the location bar and hide the toolbar icons to display
// the toolbar with only the location bar inside it.
if (!hasToolbar_ && hasLocationBar_)
[self showLocationBarOnly];
}
// (Private) Returns the backdrop to the toolbar as a ToolbarView.
- (ToolbarView*)toolbarView{
return base::mac::ObjCCastStrict<ToolbarView>([self view]);
}
- (id)customFieldEditorForObject:(id)obj {
if (obj == locationBar_) {
// Lazily construct Field editor, Cocoa UI code always runs on the
// same thread, so there shoudn't be a race condition here.
if (autocompleteTextFieldEditor_.get() == nil) {
autocompleteTextFieldEditor_.reset(
[[AutocompleteTextFieldEditor alloc] init]);
}
// This needs to be called every time, otherwise notifications
// aren't sent correctly.
DCHECK(autocompleteTextFieldEditor_.get());
[autocompleteTextFieldEditor_.get() setFieldEditor:YES];
return autocompleteTextFieldEditor_.get();
}
return nil;
}
// Returns an array of views, ordered leading to trailing.
- (NSArray*)toolbarViews {
return @[
backButton_, forwardButton_, reloadButton_, homeButton_, locationBar_,
browserActionsContainerView_, appMenuButton_
];
}
// Show or hide the home button based on the pref.
- (void)showOptionalHomeButton {
// Ignore this message if only showing the URL bar.
if (!hasToolbar_)
return;
BOOL hide = showHomeButton_.GetValue() ? NO : YES;
if (hide == [homeButton_ isHidden])
return; // Nothing to do, view state matches pref state.
// Always shift the text field by the width of the home button minus one pixel
// since the frame edges of each button are right on top of each other. When
// hiding the button, reverse the direction of the movement (to the left).
CGFloat moveX = [homeButton_ frame].size.width;
// Ensure proper spacing between the home button and the location bar.
moveX += kElementPadding;
if (hide)
moveX *= -1; // Reverse the direction of the move.
CGRect locationBarFrame = [locationBar_ frame];
locationBarFrame.size.width -= moveX;
if (!cocoa_l10n_util::ShouldDoExperimentalRTLLayout())
locationBarFrame.origin.x += moveX;
[locationBar_ setFrame:locationBarFrame];
[homeButton_ setHidden:hide];
}
// Install the app menu buttons. Calling this repeatedly is inexpensive so it
// can be done every time the buttons are shown.
- (void)installAppMenu {
if (appMenuController_.get())
return;
appMenuController_.reset(
[[AppMenuController alloc] initWithBrowser:browser_]);
[appMenuController_ setUseWithPopUpButtonCell:YES];
[appMenuButton_ setAttachedMenu:[appMenuController_ menu]];
}
- (void)updateAppMenuButtonSeverity:(AppMenuIconController::Severity)severity
iconType:(AppMenuIconController::IconType)iconType
animate:(BOOL)animate {
AppToolbarButton* appMenuButton =
base::mac::ObjCCastStrict<AppToolbarButton>(appMenuButton_);
[appMenuButton setSeverity:severity iconType:iconType shouldAnimate:animate];
}
- (void)prefChanged:(const std::string&)prefName {
if (prefName == prefs::kShowHomeButton) {
[self showOptionalHomeButton];
}
}
- (void)createBrowserActionButtons {
if (!browserActionsController_.get()) {
browserActionsController_.reset([[BrowserActionsController alloc]
initWithBrowser:browser_
containerView:browserActionsContainerView_
mainController:nil]);
[[NSNotificationCenter defaultCenter]
addObserver:self
selector:@selector(browserActionsContainerDragged:)
name:kBrowserActionGrippyDraggingNotification
object:browserActionsContainerView_];
[[NSNotificationCenter defaultCenter]
addObserver:self
selector:@selector(browserActionsVisibilityChanged:)
name:kBrowserActionVisibilityChangedNotification
object:browserActionsController_];
[[NSNotificationCenter defaultCenter]
addObserver:self
selector:@selector(browserActionsContainerWillAnimate:)
name:kBrowserActionsContainerWillAnimate
object:browserActionsContainerView_];
[[NSNotificationCenter defaultCenter]
addObserver:self
selector:@selector(adjustBrowserActionsContainerForNewWindow:)
name:NSWindowDidBecomeKeyNotification
object:[[self view] window]];
}
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:NO];
}
- (void)updateVisibility:(BOOL)visible withAnimation:(BOOL)animate {
CGFloat newHeight = visible ? [ToolbarController locationBarHeight] : 0;
// Perform the animation, which will cause the BrowserWindowController to
// resize this view in the browser layout as required.
if (animate) {
[[self toolbarView] animateToNewHeight:newHeight
duration:kToolBarAnimationDuration];
} else {
[[self toolbarView] setHeight:newHeight];
}
}
- (void)adjustBrowserActionsContainerForNewWindow:
(NSNotification*)notification {
[self toolbarFrameChanged];
[[NSNotificationCenter defaultCenter]
removeObserver:self
name:NSWindowDidBecomeKeyNotification
object:[[self view] window]];
}
- (void)browserActionsContainerDragged:(NSNotification*)notification {
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:NO];
}
- (void)browserActionsVisibilityChanged:(NSNotification*)notification {
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:NO];
}
- (void)browserActionsContainerWillAnimate:(NSNotification*)notification {
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:YES];
}
- (void)pinLocationBarBeforeBrowserActionsContainerAndAnimate:(BOOL)animate {
CGFloat delta = 0.0;
if (cocoa_l10n_util::ShouldDoExperimentalRTLLayout()) {
CGFloat leftEdge = NSMinX([locationBar_ frame]);
if ([browserActionsContainerView_ isHidden]) {
delta = leftEdge - NSMaxX([appMenuButton_ frame]) +
[ToolbarController appMenuPadding] + kButtonInset;
} else {
delta = leftEdge -
NSMaxX([browserActionsContainerView_ animationEndFrame]) +
kButtonInset;
}
} else {
CGFloat rightEdge = NSMaxX([locationBar_ frame]);
if ([browserActionsContainerView_ isHidden]) {
delta = NSMinX([appMenuButton_ frame]) -
[ToolbarController appMenuPadding] - kButtonInset - rightEdge;
} else {
delta = NSMinX([browserActionsContainerView_ animationEndFrame]) -
kButtonInset - rightEdge;
}
}
[self adjustLocationSizeBy:delta animate:animate];
}
- (void)maintainMinimumLocationBarWidth {
CGFloat locationBarWidth = NSWidth([locationBar_ frame]);
locationBarAtMinSize_ = locationBarWidth <= kMinimumLocationBarWidth;
if (locationBarAtMinSize_) {
CGFloat dX = kMinimumLocationBarWidth - locationBarWidth;
[self adjustLocationSizeBy:dX animate:NO];
}
}
- (void)toolbarFrameChanged {
// Do nothing if the frame changes but no Browser Action Controller is
// present.
if (!browserActionsController_.get())
return;
if ([browserActionsContainerView_ isAnimating]) {
// If the browser actions container is animating, we need to stop it first,
// because the frame it's animating for could be incorrect with the new
// bounds (if, for instance, the bookmark bar was added).
// This will advance to the end of the animation, so we also need to adjust
// it afterwards.
[browserActionsContainerView_ stopAnimation];
NSRect containerFrame = [browserActionsContainerView_ frame];
containerFrame.origin.y = [locationBar_ frame].origin.y + kContainerYOffset;
[browserActionsContainerView_ setFrame:containerFrame];
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:NO];
}
[self maintainMinimumLocationBarWidth];
if (locationBarAtMinSize_) {
// Once the grippy is pinned, leave it until it is explicity un-pinned.
[browserActionsContainerView_ setGrippyPinned:YES];
NSRect containerFrame = [browserActionsContainerView_ frame];
// Determine how much the container needs to move in case it's overlapping
// with the location bar.
if (cocoa_l10n_util::ShouldDoExperimentalRTLLayout()) {
CGFloat dX = NSMaxX(containerFrame) - NSMinX([locationBar_ frame]);
containerFrame.size.width -= dX;
} else {
CGFloat dX = NSMaxX([locationBar_ frame]) - containerFrame.origin.x;
containerFrame = NSOffsetRect(containerFrame, dX, 0);
containerFrame.size.width -= dX;
}
[browserActionsContainerView_ setFrame:containerFrame];
} else if (!locationBarAtMinSize_ &&
[browserActionsContainerView_ grippyPinned]) {
// Expand out the container until it hits the saved size, then unpin the
// grippy.
// Add 0.1 pixel so that it doesn't hit the minimum width codepath above.
CGFloat dX = NSWidth([locationBar_ frame]) -
(kMinimumLocationBarWidth + 0.1);
NSRect containerFrame = [browserActionsContainerView_ frame];
if (!cocoa_l10n_util::ShouldDoExperimentalRTLLayout())
containerFrame = NSOffsetRect(containerFrame, -dX, 0);
containerFrame.size.width += dX;
CGFloat savedContainerWidth =
[browserActionsController_ preferredSize].width();
if (NSWidth(containerFrame) >= savedContainerWidth) {
if (!cocoa_l10n_util::ShouldDoExperimentalRTLLayout()) {
containerFrame = NSOffsetRect(
containerFrame, NSWidth(containerFrame) - savedContainerWidth, 0);
}
containerFrame.size.width = savedContainerWidth;
[browserActionsContainerView_ setGrippyPinned:NO];
}
[browserActionsContainerView_ setFrame:containerFrame];
[self pinLocationBarBeforeBrowserActionsContainerAndAnimate:NO];
}
}
// Hide the back, forward, reload, home, and app menu buttons of the toolbar.
// This allows the location bar to occupy the entire width. There is no way to
// undo this operation, and once it is called, no other programmatic changes
// to the toolbar or location bar width should be made. This message is
// invalid if the toolbar is shown or the location bar is hidden.
- (void)showLocationBarOnly {
// -showLocationBarOnly is only ever called once, shortly after
// initialization, so the regular buttons should all be visible.
DCHECK(!hasToolbar_ && hasLocationBar_);
DCHECK(![backButton_ isHidden]);
// Ensure the location bar fills the toolbar.
NSRect toolbarFrame = [[self view] frame];
toolbarFrame.size.height = [ToolbarController locationBarHeight];
[[self view] setFrame:toolbarFrame];
[locationBar_ setFrame:NSMakeRect(0, 0, NSWidth([[self view] frame]),
[ToolbarController locationBarHeight])];
[backButton_ setHidden:YES];
[forwardButton_ setHidden:YES];
[reloadButton_ setHidden:YES];
[appMenuButton_ setHidden:YES];
[homeButton_ setHidden:YES];
[browserActionsContainerView_ setHidden:YES];
}
- (void)adjustLocationSizeBy:(CGFloat)dX animate:(BOOL)animate {
NSRect locationFrame = [locationBar_ frame];
CGFloat location_bar_flex = NSWidth(locationFrame) - kMinimumLocationBarWidth;
[browserActionsController_
setMaxWidth:NSWidth(browserActionsContainerView_.frame) +
location_bar_flex];
[locationBar_ stopAnimation];
if (dX == 0)
return;
// Ensure that the location bar is in its proper place.
locationFrame.size.width += dX;
if (cocoa_l10n_util::ShouldDoExperimentalRTLLayout())
locationFrame.origin.x -= dX;
if (animate)
[locationBar_ animateToFrame:locationFrame];
else
[locationBar_ setFrame:locationFrame];
}
- (NSPoint)bookmarkBubblePoint {
if (locationBarView_->IsStarEnabled())
return locationBarView_->GetBubblePointForDecoration(
locationBarView_->star_decoration());
return [self appMenuBubblePoint];
}
- (NSPoint)saveCreditCardBubblePoint {
return locationBarView_->GetSaveCreditCardBubblePoint();
}
- (NSPoint)appMenuBubblePoint {
NSRect frame = appMenuButton_.frame;
NSPoint point;
if (ui::MaterialDesignController::IsSecondaryUiMaterial()) {
// Use the bottom right for MD-style anchoring (no arrow).
point = NSMakePoint(NSMaxX(frame), NSMinY(frame));
} else {
// Grab bottom middle of hotdogs.
point = NSMakePoint(NSMidX(frame), NSMinY(frame));
// Inset to account for the whitespace around the hotdogs.
point.y += app_menu_controller::kAppMenuBubblePointOffsetY;
}
return [self.view convertPoint:point toView:nil];
}
- (CGFloat)baseToolbarHeight {
// Height of the toolbar in pixels when the bookmark bar is closed.
const CGFloat kBaseToolbarHeightNormal = 37;
return kBaseToolbarHeightNormal;
}
- (CGFloat)desiredHeightForCompression:(CGFloat)compressByHeight {
// With no toolbar, just ignore the compression.
if (!hasToolbar_)
return NSHeight([locationBar_ frame]);
return [self baseToolbarHeight] - compressByHeight;
}
- (void)setDividerOpacity:(CGFloat)opacity {
ToolbarView* toolbarView = [self toolbarView];
[toolbarView setShowsDivider:(opacity > 0 ? YES : NO)];
[toolbarView setDividerOpacity:opacity];
[toolbarView setNeedsDisplay:YES];
}
- (BrowserActionsController*)browserActionsController {
return browserActionsController_.get();
}
- (NSView*)appMenuButton {
return appMenuButton_;
}
- (AppMenuController*)appMenuController {
return appMenuController_.get();
}
- (BOOL)isLocationBarFocused {
OmniboxEditModel* model = locationBarView_->GetOmniboxView()->model();
return model->has_focus();
}
// (URLDropTargetController protocol)
- (void)dropURLs:(NSArray*)urls inView:(NSView*)view at:(NSPoint)point {
// TODO(viettrungluu): This code is more or less copied from the code in
// |TabStripController|. I'll refactor this soon to make it common and expand
// its capabilities (e.g., allow text DnD).
if ([urls count] < 1) {
NOTREACHED();
return;
}
for (NSUInteger index = 0; index < [urls count]; index++) {
// Refactor this code.
// https://crbug.com/665261.
GURL url = url_formatter::FixupURL(
base::SysNSStringToUTF8([urls objectAtIndex:index]), std::string());
// If the URL isn't valid, don't bother.
if (!url.is_valid())
continue;
// Security: Sanitize text to prevent self-XSS.
if (url.SchemeIs(url::kJavaScriptScheme))
continue;
WindowOpenDisposition disposition;
if (index == 0)
disposition = WindowOpenDisposition::CURRENT_TAB;
else
disposition = WindowOpenDisposition::NEW_FOREGROUND_TAB;
OpenURLParams params(url, Referrer(), disposition,
ui::PAGE_TRANSITION_TYPED, false);
browser_->tab_strip_model()->GetActiveWebContents()->OpenURL(params);
}
}
// (URLDropTargetController protocol)
- (void)dropText:(NSString*)text inView:(NSView*)view at:(NSPoint)point {
// TODO(viettrungluu): This code is more or less copied from the code in
// |TabStripController|. I'll refactor this soon to make it common and expand
// its capabilities (e.g., allow text DnD).
// If the input is plain text, classify the input and make the URL.
AutocompleteMatch match;
AutocompleteClassifierFactory::GetForProfile(browser_->profile())->Classify(
base::SysNSStringToUTF16(text), false, false,
metrics::OmniboxEventProto::BLANK, &match, NULL);
GURL url(match.destination_url);
// Security: Block JavaScript to prevent self-XSS.
if (url.SchemeIs(url::kJavaScriptScheme))
return;
OpenURLParams params(url, Referrer(), WindowOpenDisposition::CURRENT_TAB,
ui::PAGE_TRANSITION_TYPED, false);
browser_->tab_strip_model()->GetActiveWebContents()->OpenURL(params);
}
// (URLDropTargetController protocol)
- (void)indicateDropURLsInView:(NSView*)view at:(NSPoint)point {
// Do nothing.
}
// (URLDropTargetController protocol)
- (void)hideDropURLsIndicatorInView:(NSView*)view {
// Do nothing.
}
// (URLDropTargetController protocol)
- (BOOL)isUnsupportedDropData:(id<NSDraggingInfo>)info {
return drag_util::IsUnsupportedDropData(profile_, info);
}
@end
|