michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0:  * vim: ft=cpp tw=78 sw=2 et ts=2 sts=2 cin
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: #include "nsISupports.idl"
michael@0: 
michael@0: interface nsIDOMWindow;
michael@0: interface nsIDOMElement;
michael@0: 
michael@0: /**
michael@0:  * An nsILoadContext represents the context of a load.  This interface
michael@0:  * can be queried for various information about where the load is
michael@0:  * happening.
michael@0:  */
michael@0: [scriptable, uuid(852ed1f0-8ec0-11e3-baa8-0800200c9a66)]
michael@0: interface nsILoadContext : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * associatedWindow is the window with which the load is associated, if any.
michael@0:    * Note that the load may be triggered by a document which is different from
michael@0:    * the document in associatedWindow, and in fact the source of the load need
michael@0:    * not be same-origin with the document in associatedWindow.  This attribute
michael@0:    * may be null if there is no associated window.
michael@0:    */
michael@0:   readonly attribute nsIDOMWindow associatedWindow;
michael@0: 
michael@0:   /**
michael@0:    * topWindow is the top window which is of same type as associatedWindow.
michael@0:    * This is equivalent to associatedWindow.top, but is provided here as a
michael@0:    * convenience.  All the same caveats as associatedWindow of apply, of
michael@0:    * course.  This attribute may be null if there is no associated window.
michael@0:    */
michael@0:   readonly attribute nsIDOMWindow topWindow;
michael@0: 
michael@0:   /**
michael@0:    * topFrameElement is the <iframe> or <frame> element which contains the
michael@0:    * topWindow with which the load is associated.
michael@0:    *
michael@0:    * Note that we may have a topFrameElement even when we don't have an
michael@0:    * associatedWindow, if the topFrameElement's content lives out of process.
michael@0:    */
michael@0:   readonly attribute nsIDOMElement topFrameElement;
michael@0: 
michael@0:   /**
michael@0:    * Check whether the load is happening in a particular type of application.
michael@0:    *
michael@0:    * @param an application type.  For now, the constants to be passed here are
michael@0:    *        the nsIDocShell APP_TYPE_* constants.
michael@0:    *
michael@0:    * @return whether there is some ancestor of the associatedWindow that is of
michael@0:    *         the given app type.
michael@0:    */
michael@0:   boolean isAppOfType(in unsigned long appType);
michael@0: 
michael@0:   /**
michael@0:    * True if the load context is content (as opposed to chrome).  This is
michael@0:    * determined based on the type of window the load is performed in, NOT based
michael@0:    * on any URIs that might be around.
michael@0:    */
michael@0:   readonly attribute boolean isContent;
michael@0: 
michael@0:   /*
michael@0:    * Attribute that determines if private browsing should be used.
michael@0:    */
michael@0:   attribute boolean usePrivateBrowsing;
michael@0: 
michael@0:   /**
michael@0:    * Attribute that determines if remote (out-of-process) tabs should be used.
michael@0:    */
michael@0:   readonly attribute boolean useRemoteTabs;
michael@0: 
michael@0: %{C++
michael@0:   /**
michael@0:    * De-XPCOMed getter to make call-sites cleaner.
michael@0:    */
michael@0:   bool UsePrivateBrowsing() {
michael@0:     bool usingPB;
michael@0:     GetUsePrivateBrowsing(&usingPB);
michael@0:     return usingPB;
michael@0:   }
michael@0: 
michael@0:   bool UseRemoteTabs() {
michael@0:     bool usingRT;
michael@0:     GetUseRemoteTabs(&usingRT);
michael@0:     return usingRT;
michael@0:   }
michael@0: %}
michael@0: 
michael@0:   /**
michael@0:    * Set the private browsing state of the load context, meant to be used internally.
michael@0:    */
michael@0:   [noscript] void SetPrivateBrowsing(in boolean aInPrivateBrowsing);
michael@0: 
michael@0:   /**
michael@0:    * Set the remote tabs state of the load context, meant to be used internally.
michael@0:    */
michael@0:   [noscript] void SetRemoteTabs(in boolean aUseRemoteTabs);
michael@0: 
michael@0:   /**
michael@0:    * Returns true iff the load is occurring inside a browser element.
michael@0:    */
michael@0:   readonly attribute boolean isInBrowserElement;
michael@0: 
michael@0:   /**
michael@0:    * Returns the app id of the app the load is occurring is in. Returns
michael@0:    * nsIScriptSecurityManager::NO_APP_ID if the load is not part of an app.
michael@0:    */
michael@0:   readonly attribute unsigned long appId;
michael@0: 
michael@0: };