Mac: the return of the tab-modal-sheets patch.

chrome/browser/tab_contents/tab_contents.h

 // Copyright (c) 2009 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.
 
 #ifndef CHROME_BROWSER_TAB_CONTENTS_TAB_CONTENTS_H_
 #define CHROME_BROWSER_TAB_CONTENTS_TAB_CONTENTS_H_
 
 #include "build/build_config.h"
 
 #include <map>
@@ skipping 328 matching lines @@
   // heap-allocated pointer is owned by the caller.
   virtual TabContents* Clone();
 
   // Shows the page info.
   void ShowPageInfo(const GURL& url,
                     const NavigationEntry::SSLStatus& ssl,
                     bool show_history);
 
   // Window management ---------------------------------------------------------
 
-  // Create a new window constrained to this TabContents' clip and visibility.
-  // The window is initialized by using the supplied delegate to obtain basic
-  // window characteristics, and the supplied view for the content. The window
-  // is sized according to the preferred size of the content_view, and centered
-  // within the contents.
-  ConstrainedWindow* CreateConstrainedDialog(
-      ConstrainedWindowDelegate* delegate);
-
   // Adds a new tab or window with the given already-created contents
   void AddNewContents(TabContents* new_contents,
                       WindowOpenDisposition disposition,
                       const gfx::Rect& initial_pos,
                       bool user_gesture,
                       const GURL& creator_url);
 
   // Closes all constrained windows that represent web popups that have not yet
   // been activated by the user and are as such auto-positioned in the bottom
   // right of the screen. This is a quick way for users to "clean up" a flurry
   // of unwanted popups.
   void CloseAllSuppressedPopups();
 
   // Execute code in this tab.
   void ExecuteCode(int request_id, const std::string& extension_id,
                    bool is_js_code, const std::string& code_string,
                    bool all_frames);
 
   // Called when the blocked popup notification is shown or hidden.
   virtual void PopupNotificationVisibilityChanged(bool visible);
 
-  // Returns the number of constrained windows in this tab.  Used by tests.
+  // Create a new window constrained to this TabContents' clip and visibility.
+  // The window is initialized by using the supplied delegate to obtain basic
+  // window characteristics, and the supplied view for the content. On Windows
+  // and Linux, the window is sized according to the preferred size of the
+  // content_view and centered within the contents; on Mac, it is attached as a
+  // panel at the top of the tab contents area.
+  ConstrainedWindow* CreateConstrainedDialog(
+      ConstrainedWindowDelegate* delegate);
+
+  // Determines if a constrained dialog can be created.
+  // TODO(viettrungluu): Can there ever be more than one constrained dialog? (On
+  // Mac and on Linux, no. Possibly yes on Windows.)
+  bool CanCreateConstrainedDialog() { return !constrained_window_count(); }
+
+  // Returns the number of constrained windows in this tab. Used by tests and
+  // internally.
   size_t constrained_window_count() { return child_windows_.size(); }
 
+  // Needed below.
+  // TODO(viettrungluu): Make this private.
   typedef std::vector<ConstrainedWindow*> ConstrainedWindowList;
 
-  // Return an iterator for the first constrained window in this tab contents.
+  // Return iterators for the first and past-the-last constrained window in this
+  // tab contents.
+  // TODO(viettrungluu): Remove these or at least make them private. These are
+  // currently only used by (the Objective-C, Mac class) |TabStripController|
+  // (in cocoa/tab_strip_controller.mm). There must be a cleaner way to provide
+  // this functionality. Please resist using these.
   ConstrainedWindowList::iterator constrained_window_begin()
-  { return child_windows_.begin(); }
-
-  // Return an iterator for the last constrained window in this tab contents.
+      { return child_windows_.begin(); }
   ConstrainedWindowList::iterator constrained_window_end()
-  { return child_windows_.end(); }
+      { return child_windows_.end(); }
 
   // Views and focus -----------------------------------------------------------
   // TODO(brettw): Most of these should be removed and the caller should call
   // the view directly.
 
   // Returns the actual window that is focused when this TabContents is shown.
   gfx::NativeView GetContentNativeView() const;
 
   // Returns the NativeView associated with this TabContents. Outside of
   // automation in the context of the UI, this is required to be implemented.
@@ skipping 307 matching lines @@
   void set_blocked_popup_container(BlockedPopupContainer* container) {
     DCHECK(blocked_popups_ == NULL);
     blocked_popups_ = container;
   }
 
   // Called by derived classes to indicate that we're no longer waiting for a
   // response. This won't actually update the throbber, but it will get picked
   // up at the next animation step if the throbber is going.
   void SetNotWaitingForResponse() { waiting_for_response_ = false; }
 
-  ConstrainedWindowList child_windows_;
-
   // Expires InfoBars that need to be expired, according to the state carried
   // in |details|, in response to a new NavigationEntry being committed (the
   // user navigated to another page).
   void ExpireInfoBars(
       const NavigationController::LoadCommittedDetails& details);
 
   // Returns the DOMUI for the current state of the tab. This will either be
   // the pending DOMUI, the committed DOMUI, or NULL.
   DOMUI* GetDOMUIForCurrentState();
 
@@ skipping 56 matching lines @@
 
   // Helper functions for sending notifications.
   void NotifySwapped();
   void NotifyConnected();
   void NotifyDisconnected();
 
   // If params has a searchable form, this tries to create a new keyword.
   void GenerateKeywordIfNecessary(
       const ViewHostMsg_FrameNavigate_Params& params);
 
+  // Used to notify child constrained windows that something will take place
+  // (e.g., navigation).
+  void NotifyChildrenOfPendingEvent(ConstrainedWindow::Event event);
+
   // RenderViewHostDelegate ----------------------------------------------------
 
   // RenderViewHostDelegate::BrowserIntegration implementation.
   virtual void OnUserGesture();
   virtual void OnFindReply(int request_id,
                            int number_of_matches,
                            const gfx::Rect& selection_rect,
                            int active_match_ordinal,
                            bool final_update);
   virtual void GoToEntryAtOffset(int offset);
@@ skipping 264 matching lines @@
 
   // Data for shelves and stuff ------------------------------------------------
 
   // ConstrainedWindow with additional methods for managing blocked
   // popups.
   BlockedPopupContainer* blocked_popups_;
 
   // Delegates for InfoBars associated with this TabContents.
   std::vector<InfoBarDelegate*> infobar_delegates_;
 
+  // Data for constrained windows ----------------------------------------------
+
+  // List of constrained windows. Note: Currently, Mac and Linux only support a
+  // single constrained child window; conceivably, this could change in the
+  // future.
+  ConstrainedWindowList child_windows_;
+
   // Data for find in page -----------------------------------------------------
 
   // TODO(brettw) this should be separated into a helper class.
 
   // Each time a search request comes in we assign it an id before passing it
   // over the IPC so that when the results come in we can evaluate whether we
   // still care about the results of the search (in some cases we don't because
   // the user has issued a new search).
   static int find_request_id_counter_;
 
@@ skipping 90 matching lines @@
 
   // Used to retrieve the language of the current page.
   scoped_refptr<CLDHelper> cld_helper_;
 
   // ---------------------------------------------------------------------------
 
   DISALLOW_COPY_AND_ASSIGN(TabContents);
 };
 
 #endif  // CHROME_BROWSER_TAB_CONTENTS_TAB_CONTENTS_H_