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 IBOutlet InfoBubbleView* bubble_; // to set arrow position 28 // Bridge for tab change notifications. 29 scoped_ptr<TabStripModelObserverBridge> tabStripObserverBridge_; 30 31 // Non-nil only on 10.7+. Both weak, owned by AppKit. 32 // A local event tap that will dismiss the bubble when a click is delivered 33 // outside the window. This is needed because the window shares first 34 // responder with its parent. 35 id eventTap_; 36 // A notification observer that gets triggered when any window resigns key. 37 id resignationObserver_; 38 // The controlled window should be the key window when it's opened. True by 39 // default. 40 bool shouldOpenAsKeyWindow_; 41 } 42 43 @property(nonatomic, readonly) NSWindow* parentWindow; 44 // The point in base screen coordinates at which the bubble should open and the 45 // arrow tip points. 46 @property(nonatomic, assign) NSPoint anchorPoint; 47 @property(nonatomic, readonly) InfoBubbleView* bubble; 48 @property(nonatomic, assign) bool shouldOpenAsKeyWindow; 49 50 // Creates a bubble. |nibPath| is just the basename, e.g. @"FirstRunBubble". 51 // |anchoredAt| is in screen space. You need to call -showWindow: to make the 52 // bubble visible. It will autorelease itself when the user dismisses the 53 // bubble. 54 // This is the designated initializer. 55 - (id)initWithWindowNibPath:(NSString*)nibPath 56 parentWindow:(NSWindow*)parentWindow 57 anchoredAt:(NSPoint)anchoredAt; 58 59 60 // Creates a bubble. |nibPath| is just the basename, e.g. @"FirstRunBubble". 61 // |view| must be in a window. The bubble will point at |offset| relative to 62 // |view|'s lower left corner. You need to call -showWindow: to make the 63 // bubble visible. It will autorelease itself when the user dismisses the 64 // bubble. 65 - (id)initWithWindowNibPath:(NSString*)nibPath 66 relativeToView:(NSView*)view 67 offset:(NSPoint)offset; 68 69 70 // For subclasses that do not load from a XIB, this will simply set the instance 71 // variables appropriately. This will also replace the |-[self window]|'s 72 // contentView with an instance of InfoBubbleView. 73 - (id)initWithWindow:(NSWindow*)theWindow 74 parentWindow:(NSWindow*)parentWindow 75 anchoredAt:(NSPoint)anchoredAt; 76 77 // Creates an autoreleased separator view with a given frame. The height of the 78 // frame is ignored. 79 - (NSBox*)separatorWithFrame:(NSRect)frame; 80 81 @end 82 83 // Methods for use by subclasses. 84 @interface BaseBubbleController (Protected) 85 // Registers event taps *after* the window is shown so that the bubble is 86 // dismissed when it resigns key. This only needs to be called if 87 // |-showWindow:| is overriden and does not call super. Noop on OSes <10.7. 88 - (void)registerKeyStateEventTap; 89 @end 90
