blob: ea244d97722b2d64a5b9140e4e68b981b53b87c8 [file] [log] [blame]
// Copyright 2014 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 "ui/views/cocoa/native_widget_mac_nswindow.h"
#include "base/mac/foundation_util.h"
#import "base/mac/sdk_forward_declarations.h"
#import "ui/base/cocoa/user_interface_item_command_handler.h"
#import "ui/views/cocoa/bridged_native_widget.h"
#import "ui/views/cocoa/views_nswindow_delegate.h"
#import "ui/views/cocoa/window_touch_bar_delegate.h"
#include "ui/views/controls/menu/menu_controller.h"
#include "ui/views/widget/native_widget_mac.h"
#include "ui/views/widget/widget_delegate.h"
@interface NSWindow (Private)
+ (Class)frameViewClassForStyleMask:(NSWindowStyleMask)windowStyle;
- (BOOL)hasKeyAppearance;
- (long long)_resizeDirectionForMouseLocation:(CGPoint)location;
// Available in later point releases of 10.10. On 10.11+, use the public
// -performWindowDragWithEvent: instead.
- (void)beginWindowDragWithEvent:(NSEvent*)event;
@interface NativeWidgetMacNSWindow ()
- (ViewsNSWindowDelegate*)viewsNSWindowDelegate;
- (views::Widget*)viewsWidget;
- (BOOL)hasViewsMenuActive;
- (id)rootAccessibilityObject;
// Private API on NSWindow, determines whether the title is drawn on the title
// bar. The title is still visible in menus, Expose, etc.
- (BOOL)_isTitleHidden;
// Use this category to implement mouseDown: on multiple frame view classes
// with different superclasses.
@interface NSView (CRFrameViewAdditions)
- (void)cr_mouseDownOnFrameView:(NSEvent*)event;
@implementation NSView (CRFrameViewAdditions)
// If a mouseDown: falls through to the frame view, turn it into a window drag.
- (void)cr_mouseDownOnFrameView:(NSEvent*)event {
if ([self.window _resizeDirectionForMouseLocation:event.locationInWindow] !=
if (@available(macOS 10.11, *))
[self.window performWindowDragWithEvent:event];
else if ([self.window
[self.window beginWindowDragWithEvent:event];
@implementation NativeWidgetMacNSWindowTitledFrame
- (void)mouseDown:(NSEvent*)event {
[self cr_mouseDownOnFrameView:event];
[super mouseDown:event];
- (BOOL)usesCustomDrawing {
return NO;
@implementation NativeWidgetMacNSWindowBorderlessFrame
- (void)mouseDown:(NSEvent*)event {
[self cr_mouseDownOnFrameView:event];
[super mouseDown:event];
- (BOOL)usesCustomDrawing {
return NO;
@implementation NativeWidgetMacNSWindow {
base::scoped_nsobject<CommandDispatcher> commandDispatcher_;
base::scoped_nsprotocol<id<UserInterfaceItemCommandHandler>> commandHandler_;
id<WindowTouchBarDelegate> touchBarDelegate_; // Weak.
- (instancetype)initWithContentRect:(NSRect)contentRect
defer:(BOOL)deferCreation {
if ((self = [super initWithContentRect:contentRect
defer:deferCreation])) {
commandDispatcher_.reset([[CommandDispatcher alloc] initWithOwner:self]);
return self;
// This override doesn't do anything, but keeping it helps diagnose lifetime
// issues in crash stacktraces by inserting a symbol on NativeWidgetMacNSWindow.
- (void)dealloc {
[super dealloc];
// Public methods.
- (void)setCommandDispatcherDelegate:(id<CommandDispatcherDelegate>)delegate {
[commandDispatcher_ setDelegate:delegate];
- (void)sheetDidEnd:(NSWindow*)sheet
contextInfo:(void*)contextInfo {
// Note BridgedNativeWidget may have cleared [self delegate], in which case
// this will no-op. This indirection is necessary to handle AppKit invoking
// this selector via a posted task. See
[[self viewsNSWindowDelegate] sheetDidEnd:sheet
- (void)setWindowTouchBarDelegate:(id<WindowTouchBarDelegate>)delegate {
touchBarDelegate_ = delegate;
// Private methods.
- (ViewsNSWindowDelegate*)viewsNSWindowDelegate {
return base::mac::ObjCCastStrict<ViewsNSWindowDelegate>([self delegate]);
- (views::Widget*)viewsWidget {
return [[self viewsNSWindowDelegate] nativeWidgetMac]->GetWidget();
- (BOOL)hasViewsMenuActive {
views::MenuController* menuController =
return menuController && menuController->owner() == [self viewsWidget];
- (id)rootAccessibilityObject {
views::Widget* widget = [self viewsWidget];
return widget ? widget->GetRootView()->GetNativeViewAccessible() : nil;
// NSWindow overrides.
+ (Class)frameViewClassForStyleMask:(NSWindowStyleMask)windowStyle {
if (windowStyle & NSWindowStyleMaskTitled) {
if (Class customFrame = [NativeWidgetMacNSWindowTitledFrame class])
return customFrame;
} else if (Class customFrame =
[NativeWidgetMacNSWindowBorderlessFrame class]) {
return customFrame;
return [super frameViewClassForStyleMask:windowStyle];
- (BOOL)_isTitleHidden {
if (![self delegate])
return NO;
return ![self viewsWidget]->widget_delegate()->ShouldShowWindowTitle();
// The base implementation returns YES if the window's frame view is a custom
// class, which causes undesirable changes in behavior. AppKit NSWindow
// subclasses are known to override it and return NO.
- (BOOL)_usesCustomDrawing {
return NO;
// Ignore [super canBecome{Key,Main}Window]. The default is NO for windows with
// NSBorderlessWindowMask, which is not the desired behavior.
// Note these can be called via -[NSWindow close] while the widget is being torn
// down, so check for a delegate.
- (BOOL)canBecomeKeyWindow {
return [self delegate] && [self viewsWidget]->CanActivate();
- (BOOL)canBecomeMainWindow {
if (![self delegate])
return NO;
// Dialogs and bubbles shouldn't take large shadows away from their parent.
views::Widget* widget = [self viewsWidget];
return widget->CanActivate() &&
// Lets the traffic light buttons on the parent window keep their active state.
- (BOOL)hasKeyAppearance {
if ([self delegate] && [self viewsWidget]->IsAlwaysRenderAsActive())
return YES;
return [super hasKeyAppearance];
// Override sendEvent to intercept window drag events and allow key events to be
// forwarded to a toolkit-views menu while it is active, and while still
// allowing any native subview to retain firstResponder status.
- (void)sendEvent:(NSEvent*)event {
// Let CommandDispatcher check if this is a redispatched event.
if ([commandDispatcher_ preSendEvent:event])
NSEventType type = [event type];
if ((type != NSKeyDown && type != NSKeyUp) || ![self hasViewsMenuActive]) {
[super sendEvent:event];
// Send to the menu, after converting the event into an action message using
// the content view.
if (type == NSKeyDown)
[[self contentView] keyDown:event];
[[self contentView] keyUp:event];
// Override window order functions to intercept other visibility changes. This
// is needed in addition to the -[NSWindow display] override because Cocoa
// hardly ever calls display, and reports -[NSWindow isVisible] incorrectly
// when ordering in a window for the first time.
- (void)orderWindow:(NSWindowOrderingMode)orderingMode
relativeTo:(NSInteger)otherWindowNumber {
[super orderWindow:orderingMode relativeTo:otherWindowNumber];
[[self viewsNSWindowDelegate] onWindowOrderChanged:nil];
// NSResponder implementation.
- (BOOL)performKeyEquivalent:(NSEvent*)event {
return [commandDispatcher_ performKeyEquivalent:event];
- (void)cursorUpdate:(NSEvent*)theEvent {
// The cursor provided by the delegate should only be applied within the
// content area. This is because we rely on the contentView to track the
// mouse cursor and forward cursorUpdate: messages up the responder chain.
// The cursorUpdate: isn't handled in BridgedContentView because views-style
// SetCapture() conflicts with the way tracking events are processed for
// the view during a drag. Since the NSWindow is still in the responder chain
// overriding cursorUpdate: here handles both cases.
if (!NSPointInRect([theEvent locationInWindow], [[self contentView] frame])) {
[super cursorUpdate:theEvent];
NSCursor* cursor = [[self viewsNSWindowDelegate] cursor];
if (cursor)
[cursor set];
[super cursorUpdate:theEvent];
- (NSTouchBar*)makeTouchBar API_AVAILABLE(macos(10.12.2)) {
return touchBarDelegate_ ? [touchBarDelegate_ makeTouchBar] : nil;
// CommandDispatchingWindow implementation.
- (void)setCommandHandler:(id<UserInterfaceItemCommandHandler>)commandHandler {
commandHandler_.reset([commandHandler retain]);
- (CommandDispatcher*)commandDispatcher {
return commandDispatcher_.get();
- (BOOL)defaultPerformKeyEquivalent:(NSEvent*)event {
return [super performKeyEquivalent:event];
- (BOOL)defaultValidateUserInterfaceItem:
(id<NSValidatedUserInterfaceItem>)item {
return [super validateUserInterfaceItem:item];
- (void)commandDispatch:(id)sender {
[commandDispatcher_ dispatch:sender forHandler:commandHandler_];
- (void)commandDispatchUsingKeyModifiers:(id)sender {
[commandDispatcher_ dispatchUsingKeyModifiers:sender
// NSWindow overrides (NSUserInterfaceItemValidations implementation)
- (BOOL)validateUserInterfaceItem:(id<NSValidatedUserInterfaceItem>)item {
return [commandDispatcher_ validateUserInterfaceItem:item
// NSWindow overrides (NSAccessibility informal protocol implementation).
- (id)accessibilityFocusedUIElement {
if (![self delegate])
return [super accessibilityFocusedUIElement];
// The SDK documents this as "The deepest descendant of the accessibility
// hierarchy that has the focus" and says "if a child element does not have
// the focus, either return self or, if available, invoke the superclass's
// implementation."
// The behavior of NSWindow is usually to return null, except when the window
// is first shown, when it returns self. But in the second case, we can
// provide richer a11y information by reporting the views::RootView instead.
// Additionally, if we don't do this, VoiceOver reads out the partial a11y
// properties on the NSWindow and repeats them when focusing an item in the
// RootView's a11y group. See
views::Widget* widget = [self viewsWidget];
id superFocus = [super accessibilityFocusedUIElement];
if (!widget || superFocus != self)
return superFocus;
return widget->GetRootView()->GetNativeViewAccessible();
- (id)accessibilityAttributeValue:(NSString*)attribute {
// Check when NSWindow is asked for its title to provide the title given by
// the views::RootView (and WidgetDelegate::GetAccessibleWindowTitle()). For
// all other attributes, use what NSWindow provides by default since diverging
// from NSWindow's behavior can easily break VoiceOver integration.
if (![attribute isEqualToString:NSAccessibilityTitleAttribute])
return [super accessibilityAttributeValue:attribute];
id viewsValue =
[[self rootAccessibilityObject] accessibilityAttributeValue:attribute];
return viewsValue ? viewsValue
: [super accessibilityAttributeValue:attribute];