1ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Use of this source code is governed by a BSD-style license that can be 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// found in the LICENSE file. 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#ifndef CHROME_BROWSER_UI_COCOA_CONSTRAINED_WINDOW_MAC_H_ 621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#define CHROME_BROWSER_UI_COCOA_CONSTRAINED_WINDOW_MAC_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#import <Cocoa/Cocoa.h> 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 11dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "content/browser/tab_contents/constrained_window.h" 12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/basictypes.h" 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/logging.h" 15ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "base/memory/scoped_nsobject.h" 16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch@class BrowserWindowController; 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch@class GTMWindowSheetController; 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch@class NSView; 20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch@class NSWindow; 21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass TabContents; 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Base class for constrained dialog delegates. Never inherit from this 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// directly. 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ConstrainedWindowMacDelegate { 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 27dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen ConstrainedWindowMacDelegate() : is_sheet_open_(false) {} 28dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen virtual ~ConstrainedWindowMacDelegate() {} 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Tells the delegate to either delete itself or set up a task to delete 31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // itself later. Note that you MUST close the sheet belonging to your delegate 32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // in this method. 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void DeleteDelegate() = 0; 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Called by the tab controller, you do not need to do anything yourself 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // with this method. 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void RunSheet(GTMWindowSheetController* sheetController, 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch NSView* view) = 0; 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch protected: 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true if this delegate's sheet is currently showing. 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool is_sheet_open() { return is_sheet_open_; } 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool is_sheet_open_; 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void set_sheet_open(bool is_open) { is_sheet_open_ = is_open; } 46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch friend class ConstrainedWindowMac; 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 48c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Subclass this for a dialog delegate that displays a system sheet such as 50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// an NSAlert, an open or save file panel, etc. 51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ConstrainedWindowMacDelegateSystemSheet 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch : public ConstrainedWindowMacDelegate { 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 54dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen ConstrainedWindowMacDelegateSystemSheet(id delegate, SEL didEndSelector); 55dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen virtual ~ConstrainedWindowMacDelegateSystemSheet(); 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch protected: 58dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen void set_sheet(id sheet); 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch id sheet() { return systemSheet_; } 60c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 613345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Returns an NSArray to be passed as parameters to GTMWindowSheetController. 623345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Array's contents should be the arguments passed to the system sheet's 633345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // beginSheetForWindow:... method. The window argument must be [NSNull null]. 643345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // 653345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // The default implementation returns 663345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // [null window, delegate, didEndSelector, null contextInfo] 673345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Subclasses may override this if they show a system sheet which takes 683345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // different parameters. 693345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick virtual NSArray* GetSheetParameters(id delegate, SEL didEndSelector); 703345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void RunSheet(GTMWindowSheetController* sheetController, 73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch NSView* view); 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_nsobject<id> systemSheet_; 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_nsobject<id> delegate_; 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch SEL didEndSelector_; 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 79c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Subclass this for a dialog delegate that displays a custom sheet, e.g. loaded 80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// from a nib file. 81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ConstrainedWindowMacDelegateCustomSheet 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch : public ConstrainedWindowMacDelegate { 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 84dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen ConstrainedWindowMacDelegateCustomSheet(); 85dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen ConstrainedWindowMacDelegateCustomSheet(id delegate, SEL didEndSelector); 86dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen ~ConstrainedWindowMacDelegateCustomSheet(); 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 88c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch protected: 89c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // For when you need to delay initalization after the constructor call. 90dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen void init(NSWindow* sheet, id delegate, SEL didEndSelector); 91dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen void set_sheet(NSWindow* sheet); 92c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch NSWindow* sheet() { return customSheet_; } 93c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 94c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 95c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void RunSheet(GTMWindowSheetController* sheetController, 96c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch NSView* view); 97c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_nsobject<NSWindow> customSheet_; 98c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_nsobject<id> delegate_; 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch SEL didEndSelector_; 100c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 101c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 102c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Constrained window implementation for the Mac port. A constrained window 103c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// is a per-tab sheet on OS X. 104c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 105c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Constrained windows work slightly differently on OS X than on the other 106c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// platforms: 107c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 1. A constrained window is bound to both a tab and window on OS X. 108c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 2. The delegate is responsible for closing the sheet again when it is 109c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// deleted. 110c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ConstrainedWindowMac : public ConstrainedWindow { 111c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 112c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual ~ConstrainedWindowMac(); 113c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 114c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Overridden from ConstrainedWindow: 115c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void ShowConstrainedWindow(); 116c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void CloseConstrainedWindow(); 117c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 118c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns the TabContents that constrains this Constrained Window. 119c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch TabContents* owner() const { return owner_; } 120c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 121c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns the window's delegate. 122c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstrainedWindowMacDelegate* delegate() { return delegate_; } 123c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 124c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Makes the constrained window visible, if it is not yet visible. 125c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void Realize(BrowserWindowController* controller); 126c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 127c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 128c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch friend class ConstrainedWindow; 129c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 130c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstrainedWindowMac(TabContents* owner, 131c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstrainedWindowMacDelegate* delegate); 132c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 133c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The TabContents that owns and constrains this ConstrainedWindow. 134c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch TabContents* owner_; 135c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 136c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Delegate that provides the contents of this constrained window. 137c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstrainedWindowMacDelegate* delegate_; 138c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 139c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Controller of the window that contains this sheet. 140c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch BrowserWindowController* controller_; 141c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 142c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Stores if |ShowConstrainedWindow()| was called. 143c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool should_be_visible_; 144c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 145c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch DISALLOW_COPY_AND_ASSIGN(ConstrainedWindowMac); 146c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 147c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 14821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#endif // CHROME_BROWSER_UI_COCOA_CONSTRAINED_WINDOW_MAC_H_ 149c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 150