michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef mozilla_BrowserElementHelpers_h
michael@0: #define mozilla_BrowserElementHelpers_h
michael@0: 
michael@0: #include "nsAString.h"
michael@0: #include "mozilla/gfx/Point.h"
michael@0: #include "mozilla/gfx/Rect.h"
michael@0: #include "Units.h"
michael@0: #include "mozilla/dom/Element.h"
michael@0: 
michael@0: class nsIDOMWindow;
michael@0: class nsIURI;
michael@0: 
michael@0: namespace mozilla {
michael@0: 
michael@0: namespace dom {
michael@0: class TabParent;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * BrowserElementParent implements a portion of the parent-process side of
michael@0:  * <iframe mozbrowser>.
michael@0:  *
michael@0:  * Most of the parent-process side of <iframe mozbrowser> is implemented in
michael@0:  * BrowserElementParent.js.  This file implements the few parts of this
michael@0:  * functionality which must be written in C++.
michael@0:  *
michael@0:  * We don't communicate with the JS code that lives in BrowserElementParent.js;
michael@0:  * the JS and C++ parts are completely separate.
michael@0:  */
michael@0: class BrowserElementParent
michael@0: {
michael@0: public:
michael@0: 
michael@0:   /**
michael@0:    * Possible results from a window.open call.
michael@0:    * ADDED     - The frame was added to a document (i.e. handled by the embedder).
michael@0:    * IGNORED   - The frame was not added to a document and the embedder didn't
michael@0:    *             call preventDefault() to prevent the platform from handling the call.
michael@0:    * CANCELLED - The frame was not added to a document, but the embedder still
michael@0:    *             called preventDefault() to prevent the platform from handling the call.
michael@0:    */
michael@0: 
michael@0:   enum OpenWindowResult {
michael@0:     OPEN_WINDOW_ADDED,
michael@0:     OPEN_WINDOW_IGNORED,
michael@0:     OPEN_WINDOW_CANCELLED
michael@0:   };
michael@0: 
michael@0:   /**
michael@0:    * Handle a window.open call from an out-of-process <iframe mozbrowser>.
michael@0:    *
michael@0:    * window.open inside <iframe mozbrowser> doesn't actually open a new
michael@0:    * top-level window.  Instead, the "embedder" (the document which contains
michael@0:    * the <iframe mozbrowser> whose content called window.open) gets the
michael@0:    * opportunity to place a new <iframe mozbrowser> in the DOM somewhere.  This
michael@0:    * new "popup" iframe acts as the opened window.
michael@0:    *
michael@0:    * This method proceeds in three steps.
michael@0:    *
michael@0:    * 1) We fire a mozbrowseropenwindow CustomEvent on the opener
michael@0:    *    iframe element.  This event's detail is an instance of
michael@0:    *    OpenWindowEventDetail.
michael@0:    *
michael@0:    * 2) The embedder (the document which contains the opener iframe) can accept
michael@0:    *    the window.open request by inserting event.detail.frameElement (an iframe
michael@0:    *    element) into the DOM somewhere.
michael@0:    *
michael@0:    * 3) If the embedder accepted the window.open request, we return true and
michael@0:    *    set aPopupTabParent's frame element to event.detail.frameElement.
michael@0:    *    Otherwise, we return false.
michael@0:    *
michael@0:    * @param aURL the URL the new window should load.  The empty string is
michael@0:    *             allowed.
michael@0:    * @param aOpenerTabParent the TabParent whose TabChild called window.open.
michael@0:    * @param aPopupTabParent the TabParent inside which the opened window will
michael@0:    *                        live.
michael@0:    * @return an OpenWindowresult that describes whether the embedder added the
michael@0:    *         frame to a document and whether it called preventDefault to prevent
michael@0:    *         the platform from handling the open request.
michael@0:    */
michael@0:   static OpenWindowResult
michael@0:   OpenWindowOOP(dom::TabParent* aOpenerTabParent,
michael@0:                 dom::TabParent* aPopupTabParent,
michael@0:                 const nsAString& aURL,
michael@0:                 const nsAString& aName,
michael@0:                 const nsAString& aFeatures);
michael@0: 
michael@0:   /**
michael@0:    * Handle a window.open call from an in-process <iframe mozbrowser>.
michael@0:    *
michael@0:    * (These parameter types are silly, but they match what our caller has in
michael@0:    * hand.  Feel free to add an override, if they are inconvenient to you.)
michael@0:    *
michael@0:    * @param aURI the URI the new window should load.  May be null.
michael@0:    * @return an OpenWindowResult that describes whether the browser added the
michael@0:    *         frame to a document or whether they called preventDefault to prevent
michael@0:    *         the platform from handling the open request
michael@0:    */
michael@0:   static OpenWindowResult
michael@0:   OpenWindowInProcess(nsIDOMWindow* aOpenerWindow,
michael@0:                       nsIURI* aURI,
michael@0:                       const nsAString& aName,
michael@0:                       const nsACString& aFeatures,
michael@0:                       nsIDOMWindow** aReturnWindow);
michael@0: 
michael@0:   /**
michael@0:    * Fire a mozbrowserasyncscroll CustomEvent on the given TabParent's frame element.
michael@0:    * This event's detail is an AsyncScrollEventDetail dictionary.
michael@0:    *
michael@0:    * @param aContentRect: The portion of the page which is currently visible
michael@0:    *                      onscreen in CSS pixels.
michael@0:    *
michael@0:    * @param aContentSize: The content width/height in CSS pixels.
michael@0:    *
michael@0:    * aContentRect.top + aContentRect.height may be larger than aContentSize.height.
michael@0:    * This indicates that the content is over-scrolled, which occurs when the
michael@0:    * page "rubber-bands" after being scrolled all the way to the bottom.
michael@0:    * Similarly, aContentRect.left + aContentRect.width may be greater than
michael@0:    * contentSize.width, and both left and top may be negative.
michael@0:    */
michael@0:   static bool
michael@0:   DispatchAsyncScrollEvent(dom::TabParent* aTabParent,
michael@0:                            const CSSRect& aContentRect,
michael@0:                            const CSSSize& aContentSize);
michael@0: 
michael@0: private:
michael@0:   static OpenWindowResult
michael@0:   DispatchOpenWindowEvent(dom::Element* aOpenerFrameElement,
michael@0:                           dom::Element* aPopupFrameElement,
michael@0:                           const nsAString& aURL,
michael@0:                           const nsAString& aName,
michael@0:                           const nsAString& aFeatures);
michael@0: };
michael@0: 
michael@0: } // namespace mozilla
michael@0: 
michael@0: #endif