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 #import <Cocoa/Cocoa.h> 6 7 #include "base/memory/scoped_ptr.h" 8 9 @class InfoBubbleView; 10 class TabStripModelObserverBridge; 11 12 // Base class for bubble controllers. Manages a xib that contains an 13 // InfoBubbleWindow which contains an InfoBubbleView. Contains code to close 14 // the bubble window on clicks outside of the window, and the like. 15 // To use this class: 16 // 1. Create a new xib that contains a window. Change the window's class to 17 // InfoBubbleWindow. Give it a child view that autosizes to the window's full 18 // size, give it class InfoBubbleView. Make the controller the window's 19 // delegate. 20 // 2. Create a subclass of BaseBubbleController. 21 // 3. Change the xib's File Owner to your subclass. 22 // 4. Hook up the File Owner's |bubble_| to the InfoBubbleView in the xib. 23 @interface BaseBubbleController : NSWindowController<NSWindowDelegate> { 24 @private 25 NSWindow* parentWindow_; // weak 26 NSPoint anchor_; 27 // Offset of the anchor point relative to the parent window's upper-left-hand 28 // corner. Used to ensure that if the parent window is resized with the bubble 29 // remaining visible, the bubble continues to be anchored correctly. 30 NSPoint anchorOffset_; 31 32 IBOutlet InfoBubbleView* bubble_; // to set arrow position 33 // Bridge for tab change notifications. 34 scoped_ptr<TabStripModelObserverBridge> tabStripObserverBridge_; 35 36 // Non-nil only on 10.7+. Both weak, owned by AppKit. 37 // A local event tap that will dismiss the bubble when a click is delivered 38 // outside the window. This is needed because the window shares first 39 // responder with its parent. 40 id eventTap_; 41 // A notification observer that gets triggered when any window resigns key. 42 id resignationObserver_; 43 // The controlled window should be the key window when it's opened. True by 44 // default. 45 BOOL shouldOpenAsKeyWindow_; 46 // The bubble window should close if it (or its parent) resigns key status. 47 BOOL shouldCloseOnResignKey_; 48 } 49 50 @property(nonatomic, readonly) NSWindow* parentWindow; 51 // The point in base screen coordinates at which the bubble should open and the 52 // arrow tip points. 53 @property(nonatomic, assign) NSPoint anchorPoint; 54 @property(nonatomic, readonly) InfoBubbleView* bubble; 55 @property(nonatomic, assign) BOOL shouldOpenAsKeyWindow; 56 // Controls if the bubble auto-closes if the user clicks outside the bubble. 57 @property(nonatomic, assign) BOOL shouldCloseOnResignKey; 58 59 // Creates a bubble. |nibPath| is just the basename, e.g. @"FirstRunBubble". 60 // |anchoredAt| is in screen space. You need to call -showWindow: to make the 61 // bubble visible. It will autorelease itself when the user dismisses the 62 // bubble. 63 // This is the designated initializer. 64 - (id)initWithWindowNibPath:(NSString*)nibPath 65 parentWindow:(NSWindow*)parentWindow 66 anchoredAt:(NSPoint)anchoredAt; 67 68 69 // Creates a bubble. |nibPath| is just the basename, e.g. @"FirstRunBubble". 70 // |view| must be in a window. The bubble will point at |offset| relative to 71 // |view|'s lower left corner. You need to call -showWindow: to make the 72 // bubble visible. It will autorelease itself when the user dismisses the 73 // bubble. 74 - (id)initWithWindowNibPath:(NSString*)nibPath 75 relativeToView:(NSView*)view 76 offset:(NSPoint)offset; 77 78 79 // For subclasses that do not load from a XIB, this will simply set the instance 80 // variables appropriately. This will also replace the |-[self window]|'s 81 // contentView with an instance of InfoBubbleView. 82 - (id)initWithWindow:(NSWindow*)theWindow 83 parentWindow:(NSWindow*)parentWindow 84 anchoredAt:(NSPoint)anchoredAt; 85 86 // Creates an autoreleased horizontal separator view with a given frame. The 87 // height of the frame is ignored. 88 - (NSBox*)horizontalSeparatorWithFrame:(NSRect)frame; 89 90 // Creates an autoreleased vertical separator view with a given frame. The 91 // width of frame is ignored. 92 - (NSBox*)verticalSeparatorWithFrame:(NSRect)frame; 93 94 95 @end 96 97 // Methods for use by subclasses. 98 @interface BaseBubbleController (Protected) 99 // Registers event taps *after* the window is shown so that the bubble is 100 // dismissed when it resigns key. This only needs to be called if 101 // |-showWindow:| is overriden and does not call super. Noop on OSes <10.7. 102 - (void)registerKeyStateEventTap; 103 @end 104
