michael@0: /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0:  *
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 "domstubs.idl"
michael@0: #include "nsIDocShellTreeItem.idl"
michael@0: 
michael@0: %{ C++
michael@0: #include "js/TypeDecls.h"
michael@0: class nsPresContext;
michael@0: class nsIPresShell;
michael@0: %}
michael@0: 
michael@0: /**
michael@0:  * The nsIDocShell interface.
michael@0:  */
michael@0: 
michael@0: [ptr] native nsPresContext(nsPresContext);
michael@0: [ptr] native nsIPresShell(nsIPresShell);
michael@0: 
michael@0: interface nsIURI;
michael@0: interface nsIChannel;
michael@0: interface nsIContentViewer;
michael@0: interface nsIURIContentListener;
michael@0: interface nsIDOMEventTarget;
michael@0: interface nsIDocShellLoadInfo;
michael@0: interface nsIEditor;
michael@0: interface nsIWebNavigation;
michael@0: interface nsISimpleEnumerator;
michael@0: interface nsIInputStream;
michael@0: interface nsIRequest;
michael@0: interface nsISHEntry;
michael@0: interface nsILayoutHistoryState;
michael@0: interface nsISecureBrowserUI;
michael@0: interface nsIScriptGlobalObject;
michael@0: interface nsIDOMStorage;
michael@0: interface nsIPrincipal;
michael@0: interface nsIWebBrowserPrint;
michael@0: interface nsIVariant;
michael@0: interface nsIPrivacyTransitionObserver;
michael@0: interface nsIReflowObserver;
michael@0: interface nsIScrollObserver;
michael@0: 
michael@0: typedef unsigned long nsLoadFlags;
michael@0: 
michael@0: [scriptable, builtinclass, uuid(e46d924d-c20f-4add-8cf5-1e1c817b2181)]
michael@0: interface nsIDocShell : nsIDocShellTreeItem
michael@0: {
michael@0:   /**
michael@0:    * Loads a given URI.  This will give priority to loading the requested URI
michael@0:    * in the object implementing	this interface.  If it can't be loaded here
michael@0:    * however, the URL dispatcher will go through its normal process of content
michael@0:    * loading.
michael@0:    *
michael@0:    * @param uri        - The URI to load.
michael@0:    * @param loadInfo   - This is the extended load info for this load.  This
michael@0:    *                     most often will be null, but if you need to do 
michael@0:    *                     additional setup for this load you can get a loadInfo
michael@0:    *                     object by calling createLoadInfo.  Once you have this
michael@0:    *                     object you can set the needed properties on it and
michael@0:    *                     then pass it to loadURI.
michael@0:    * @param aLoadFlags - Flags to modify load behaviour. Flags are defined in
michael@0:    *                     nsIWebNavigation.  Note that using flags outside
michael@0:    *                     LOAD_FLAGS_MASK is only allowed if passing in a
michael@0:    *                     non-null loadInfo.  And even some of those might not
michael@0:    *                     be allowed.  Use at your own risk.
michael@0:    */
michael@0:   [noscript]void loadURI(in nsIURI uri,
michael@0:                          in nsIDocShellLoadInfo loadInfo,
michael@0:                          in unsigned long aLoadFlags,
michael@0:                          in boolean firstParty);
michael@0: 
michael@0:   /**
michael@0:    * Loads a given stream. This will give priority to loading the requested
michael@0:    * stream in the object implementing this interface. If it can't be loaded
michael@0:    * here however, the URL dispatched will go through its normal process of
michael@0:    * content loading.
michael@0:    *
michael@0:    * @param aStream         - The input stream that provides access to the data
michael@0:    *                          to be loaded.  This must be a blocking, threadsafe
michael@0:    *                          stream implementation.
michael@0:    * @param aURI            - The URI representing the stream, or null.
michael@0:    * @param aContentType    - The type (MIME) of data being loaded (empty if unknown).
michael@0:    * @param aContentCharset - The charset of the data being loaded (empty if unknown).
michael@0:    * @param aLoadInfo       - This is the extended load info for this load.  This
michael@0:    *                          most often will be null, but if you need to do 
michael@0:    *                          additional setup for this load you can get a
michael@0:    *                          loadInfo object by calling createLoadInfo.  Once
michael@0:    *                          you have this object you can set the needed 
michael@0:    *                          properties on it and then pass it to loadStream.
michael@0:    */
michael@0:   [noscript]void loadStream(in nsIInputStream aStream,
michael@0:                             in nsIURI aURI,
michael@0:                             in ACString aContentType,
michael@0:                             in ACString aContentCharset,
michael@0:                             in nsIDocShellLoadInfo aLoadInfo);
michael@0: 
michael@0:   const long INTERNAL_LOAD_FLAGS_NONE                    = 0x0;
michael@0:   const long INTERNAL_LOAD_FLAGS_INHERIT_OWNER           = 0x1;
michael@0:   const long INTERNAL_LOAD_FLAGS_DONT_SEND_REFERRER      = 0x2;
michael@0:   const long INTERNAL_LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP = 0x4;
michael@0: 
michael@0:   // This flag marks the first load in this object
michael@0:   // @see nsIWebNavigation::LOAD_FLAGS_FIRST_LOAD
michael@0:   const long INTERNAL_LOAD_FLAGS_FIRST_LOAD              = 0x8;
michael@0: 
michael@0:   const long INTERNAL_LOAD_FLAGS_BYPASS_CLASSIFIER       = 0x10;
michael@0:   const long INTERNAL_LOAD_FLAGS_FORCE_ALLOW_COOKIES     = 0x20;
michael@0: 
michael@0:   // Whether the load should be treated as srcdoc load, rather than a URI one.
michael@0:   const long INTERNAL_LOAD_FLAGS_IS_SRCDOC               = 0x40;
michael@0: 
michael@0:   const long INTERNAL_LOAD_FLAGS_FIXUP_SCHEME_TYPOS      = 0x80;
michael@0: 
michael@0:   /**
michael@0:    * Loads the given URI.  This method is identical to loadURI(...) except
michael@0:    * that its parameter list is broken out instead of being packaged inside
michael@0:    * of an nsIDocShellLoadInfo object...
michael@0:    *
michael@0:    * @param aURI            - The URI to load.
michael@0:    * @param aReferrer       - Referring URI
michael@0:    * @param aOwner          - Owner (security principal) 
michael@0:    * @param aInheritOwner   - Flag indicating whether the owner of the current
michael@0:    *                          document should be inherited if aOwner is null.
michael@0:    * @param aStopActiveDoc  - Flag indicating whether loading the current
michael@0:    *                          document should be stopped.
michael@0:    * @param aWindowTarget   - Window target for the load.
michael@0:    * @param aTypeHint       - A hint as to the content-type of the resulting
michael@0:    *                          data.  May be null or empty if no hint.
michael@0:    * @param aFileName       - Non-null when the link should be downloaded as
michael@0:                               the given filename.
michael@0:    * @param aPostDataStream - Post data stream (if POSTing)
michael@0:    * @param aHeadersStream  - Stream containing "extra" request headers...
michael@0:    * @param aLoadFlags      - Flags to modify load behaviour. Flags are defined
michael@0:    *                          in nsIWebNavigation.
michael@0:    * @param aSHEntry        - Active Session History entry (if loading from SH)
michael@0:    * @param aSrcdoc           When INTERNAL_LOAD_FLAGS_IS_SRCDOC is set, the
michael@0:    *                          contents of this parameter will be loaded instead
michael@0:    *                          of aURI.
michael@0:    * @param aSourceDocShell - The source browsing context for the navigation.
michael@0:    * @param aBaseURI        - The base URI to be used for the load.  Set in
michael@0:    *                          srcdoc loads as it cannot otherwise be inferred
michael@0:    *                          in certain situations such as view-source.
michael@0:    */
michael@0:   [noscript]void internalLoad(in nsIURI aURI,
michael@0:                               in nsIURI aReferrer,
michael@0:                               in nsISupports aOwner,
michael@0:                               in uint32_t aFlags,
michael@0:                               in wstring aWindowTarget,
michael@0:                               in string aTypeHint,
michael@0:                               in AString aFileName,
michael@0:                               in nsIInputStream aPostDataStream,
michael@0:                               in nsIInputStream aHeadersStream,
michael@0:                               in unsigned long aLoadFlags,
michael@0:                               in nsISHEntry aSHEntry,
michael@0:                               in boolean firstParty,
michael@0:                               in AString aSrcdoc,
michael@0:                               in nsIDocShell aSourceDocShell,
michael@0:                               in nsIURI aBaseURI,
michael@0:                               out nsIDocShell aDocShell,
michael@0:                               out nsIRequest aRequest);
michael@0: 
michael@0:   /**
michael@0:    * Do either a history.pushState() or history.replaceState() operation,
michael@0:    * depending on the value of aReplace.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   void addState(in jsval aData, in DOMString aTitle,
michael@0:                 in DOMString aURL, in boolean aReplace);
michael@0: 
michael@0:   /**
michael@0:    * Creates a DocShellLoadInfo object that you can manipulate and then pass
michael@0:    * to loadURI.
michael@0:    */
michael@0:   void createLoadInfo(out nsIDocShellLoadInfo loadInfo);
michael@0: 
michael@0:   /**
michael@0:    * Reset state to a new content model within the current document and the document
michael@0:    * viewer.  Called by the document before initiating an out of band document.write().
michael@0:    */
michael@0:   void prepareForNewContentModel();
michael@0: 
michael@0:   /**
michael@0:    * For editors and suchlike who wish to change the URI associated with the
michael@0:    * document. Note if you want to get the current URI, use the read-only
michael@0:    * property on nsIWebNavigation.
michael@0:    */ 
michael@0:   void setCurrentURI(in nsIURI aURI);
michael@0: 
michael@0:   /**
michael@0:    * Notify the associated content viewer and all child docshells that they are
michael@0:    * about to be hidden.  If |isUnload| is true, then the document is being
michael@0:    * unloaded as well.
michael@0:    *
michael@0:    * @param isUnload if true, fire the unload event in addition to the pagehide
michael@0:    *                 event.
michael@0:    */
michael@0:   [noscript] void firePageHideNotification(in boolean isUnload);
michael@0: 
michael@0:   /**
michael@0:    * Presentation context for the currently loaded document.  This may be null.
michael@0:    */
michael@0:   [noscript] readonly attribute nsPresContext presContext;
michael@0: 
michael@0:   /**
michael@0:    * Presentation shell for the currently loaded document.  This may be null.
michael@0:    */
michael@0:   [noscript,notxpcom] nsIPresShell GetPresShell();
michael@0: 
michael@0:   /**
michael@0:    * Presentation shell for the oldest document, if this docshell is
michael@0:    * currently transitioning between documents.
michael@0:    */
michael@0:   [noscript] readonly attribute nsIPresShell eldestPresShell;
michael@0: 
michael@0:   /**
michael@0:    * Content Viewer that is currently loaded for this DocShell.  This may
michael@0:    * change as the underlying content changes.
michael@0:    */
michael@0:   readonly attribute nsIContentViewer contentViewer;
michael@0: 
michael@0:   /**
michael@0:    * This attribute allows chrome to tie in to handle DOM events that may
michael@0:    * be of interest to chrome.
michael@0:    */
michael@0:   attribute nsIDOMEventTarget chromeEventHandler;
michael@0: 
michael@0:   /**
michael@0:    * Whether to allow plugin execution
michael@0:    */
michael@0:   attribute boolean allowPlugins;
michael@0: 
michael@0:   /**
michael@0:    * Whether to allow Javascript execution
michael@0:    */
michael@0:   attribute boolean allowJavascript;
michael@0: 
michael@0:   /**
michael@0:    * Attribute stating if refresh based redirects can be allowed
michael@0:    */
michael@0:   attribute  boolean allowMetaRedirects;
michael@0: 
michael@0:   /**
michael@0:    * Attribute stating if it should allow subframes (framesets/iframes) or not
michael@0:    */
michael@0:   attribute boolean allowSubframes;
michael@0: 
michael@0:   /**
michael@0:    * Attribute stating whether or not images should be loaded.
michael@0:    */
michael@0:   attribute boolean allowImages;
michael@0: 
michael@0:   /**
michael@0:    * Attribute stating whether or not media (audio/video) should be loaded.
michael@0:    */
michael@0:   [infallible] attribute boolean allowMedia;
michael@0: 
michael@0:   /**
michael@0:    * Attribute that determines whether DNS prefetch is allowed for this subtree
michael@0:    * of the docshell tree.  Defaults to true.  Setting this will make it take
michael@0:    * effect starting with the next document loaded in the docshell.
michael@0:    */
michael@0:   attribute boolean allowDNSPrefetch;
michael@0: 
michael@0:   /**
michael@0:    * Attribute that determines whether window control (move/resize) is allowed.
michael@0:    */
michael@0:   attribute boolean allowWindowControl;
michael@0: 
michael@0:   /**
michael@0:    * True if the docshell allows its content to be handled by a content listener
michael@0:    * other than the docshell itself, including the external helper app service,
michael@0:    * and false otherwise.  Defaults to true.
michael@0:    */
michael@0:   [infallible] attribute boolean allowContentRetargeting;
michael@0: 
michael@0:   /**
michael@0:    * Get an enumerator over this docShell and its children.
michael@0:    *
michael@0:    * @param aItemType  - Only include docShells of this type, or if typeAll,
michael@0:    *                     include all child shells.
michael@0:    *                     Uses types from nsIDocShellTreeItem.
michael@0:    * @param aDirection - Whether to enumerate forwards or backwards.
michael@0:    */
michael@0: 
michael@0:   const long ENUMERATE_FORWARDS  = 0;
michael@0:   const long ENUMERATE_BACKWARDS = 1;
michael@0: 
michael@0:   nsISimpleEnumerator getDocShellEnumerator(in long aItemType,
michael@0:                                             in long aDirection);
michael@0: 
michael@0:   /**
michael@0:    * The type of application that created this window
michael@0:    */
michael@0:   const unsigned long APP_TYPE_UNKNOWN  = 0;
michael@0:   const unsigned long APP_TYPE_MAIL     = 1;
michael@0:   const unsigned long APP_TYPE_EDITOR   = 2;
michael@0: 
michael@0:   attribute unsigned long appType;
michael@0: 
michael@0:   /**
michael@0:    * certain dochshells (like the message pane)
michael@0:    * should not throw up auth dialogs
michael@0:    * because it can act as a password trojan
michael@0:    */
michael@0:   attribute boolean allowAuth;
michael@0: 
michael@0:   /**
michael@0:    * Set/Get the document scale factor.  When setting this attribute, a
michael@0:    * NS_ERROR_NOT_IMPLEMENTED error may be returned by implementations
michael@0:    * not supporting zoom.  Implementations not supporting zoom should return
michael@0:    * 1.0 all the time for the Get operation.  1.0 by the way is the default
michael@0:    * of zoom.  This means 100% of normal scaling or in other words normal size
michael@0:    * no zoom. 
michael@0:    */
michael@0:   attribute float zoom;
michael@0: 
michael@0:   /*
michael@0:    * The size, in CSS pixels, of the horizontal margins for the <body> of an
michael@0:    * HTML document in this docshel; used to implement the marginwidth attribute
michael@0:    * on HTML <frame>/<iframe> elements.  A value smaller than zero indicates
michael@0:    * that the attribute was not set.
michael@0:    */
michael@0:   attribute long marginWidth;
michael@0: 
michael@0:   /*
michael@0:    * The size, in CSS pixels, of the vertical margins for the <body> of an HTML
michael@0:    * document in this docshel; used to implement the marginheight attribute on
michael@0:    * HTML <frame>/<iframe> elements.  A value smaller than zero indicates that
michael@0:    * the attribute was not set.
michael@0:    */
michael@0:   attribute long marginHeight;
michael@0: 
michael@0:   /*
michael@0:    * Tells the docshell to offer focus to its tree owner.
michael@0:    * This is currently only necessary for embedding chrome.
michael@0:    */
michael@0:   void tabToTreeOwner(in boolean forward,
michael@0:                       out boolean tookFocus);
michael@0: 
michael@0:   /**
michael@0:    * Current busy state for DocShell
michael@0:    */
michael@0:   const unsigned long BUSY_FLAGS_NONE             = 0;
michael@0:   const unsigned long BUSY_FLAGS_BUSY             = 1;
michael@0:   const unsigned long BUSY_FLAGS_BEFORE_PAGE_LOAD = 2;
michael@0:   const unsigned long BUSY_FLAGS_PAGE_LOADING     = 4;
michael@0: 
michael@0:   /**
michael@0:    * Load commands for the document 
michael@0:    */
michael@0:   const unsigned long LOAD_CMD_NORMAL  = 0x1;   // Normal load
michael@0:   const unsigned long LOAD_CMD_RELOAD  = 0x2;   // Reload
michael@0:   const unsigned long LOAD_CMD_HISTORY = 0x4;   // Load from history
michael@0:   const unsigned long LOAD_CMD_PUSHSTATE = 0x8; // History.pushState()
michael@0: 
michael@0:   readonly attribute unsigned long busyFlags;
michael@0: 
michael@0:   /* 
michael@0:    * attribute to access the loadtype  for the document
michael@0:    */
michael@0:   attribute unsigned long  loadType;
michael@0: 
michael@0:   /*
michael@0:    * Default load flags (as defined in nsIRequest) that will be set on all
michael@0:    * requests made by this docShell and propagated to all child docShells and
michael@0:    * to nsILoadGroup::defaultLoadFlags for the docShell's loadGroup.
michael@0:    * Default is no flags.  Once set, only future requests initiated by the
michael@0:    * docShell are affected, so in general, these flags should be set before
michael@0:    * the docShell loads any content.
michael@0:    */
michael@0:   attribute nsLoadFlags defaultLoadFlags;
michael@0: 
michael@0:   /*
michael@0:    * returns true if the docshell is being destroyed, false otherwise
michael@0:    */
michael@0:   boolean isBeingDestroyed();
michael@0: 
michael@0:   /*
michael@0:    * Returns true if the docshell is currently executing the onLoad Handler
michael@0:    */
michael@0:   readonly attribute boolean isExecutingOnLoadHandler;
michael@0: 
michael@0:   attribute nsILayoutHistoryState layoutHistoryState;
michael@0: 
michael@0:   readonly attribute boolean shouldSaveLayoutState;
michael@0: 
michael@0:   /**
michael@0:    * The SecureBrowserUI object for this docshell.  This is set by XUL
michael@0:    * <browser> or nsWebBrowser for their root docshell.
michael@0:    */
michael@0:   attribute nsISecureBrowserUI securityUI;
michael@0: 
michael@0:   /**
michael@0:    * Cancel the XPCOM timers for each meta-refresh URI in this docshell,
michael@0:    * and this docshell's children, recursively. The meta-refresh timers can be
michael@0:    * restarted using resumeRefreshURIs().  If the timers are already suspended,
michael@0:    * this has no effect.
michael@0:    */
michael@0:   void suspendRefreshURIs();
michael@0: 
michael@0:   /**
michael@0:    * Restart the XPCOM timers for each meta-refresh URI in this docshell,
michael@0:    * and this docshell's children, recursively.  If the timers are already
michael@0:    * running, this has no effect.
michael@0:    */
michael@0:   void resumeRefreshURIs();
michael@0: 
michael@0:   /**
michael@0:    * Begin firing WebProgressListener notifications for restoring a page
michael@0:    * presentation. |viewer| is the content viewer whose document we are
michael@0:    * starting to load.  If null, it defaults to the docshell's current content
michael@0:    * viewer, creating one if necessary.  |top| should be true for the toplevel
michael@0:    * docshell that is being restored; it will be set to false when this method
michael@0:    * is called for child docshells.  This method will post an event to
michael@0:    * complete the simulated load after returning to the event loop.
michael@0:    */
michael@0:   void beginRestore(in nsIContentViewer viewer, in boolean top);
michael@0: 
michael@0:   /**
michael@0:    * Finish firing WebProgressListener notifications and DOM events for
michael@0:    * restoring a page presentation.  This should only be called via
michael@0:    * beginRestore().
michael@0:    */
michael@0:   void finishRestore();
michael@0: 
michael@0:   /* Track whether we're currently restoring a document presentation. */
michael@0:   readonly attribute boolean restoringDocument;
michael@0: 
michael@0:   /* attribute to access whether error pages are enabled */
michael@0:   attribute boolean useErrorPages;
michael@0: 
michael@0:   /**
michael@0:    * Display a load error in a frame while keeping that frame's currentURI
michael@0:    * pointing correctly to the page where the error ocurred, rather than to
michael@0:    * the error document page. You must provide either the aURI or aURL parameter.
michael@0:    *
michael@0:    * @param  aError         The error code to be displayed
michael@0:    * @param  aURI           nsIURI of the page where the error happened
michael@0:    * @param  aURL           wstring of the page where the error happened
michael@0:    * @param  aFailedChannel The channel related to this error
michael@0:    */
michael@0:   void displayLoadError(in nsresult aError,
michael@0:                         in nsIURI aURI,
michael@0:                         in wstring aURL,
michael@0:                         [optional] in nsIChannel aFailedChannel);
michael@0: 
michael@0: 
michael@0:   /**
michael@0:    * Keeps track of the previous SHTransaction index and the current
michael@0:    * SHTransaction index at the time that the doc shell begins to load.
michael@0:    * Used for ContentViewer eviction.
michael@0:    */
michael@0:   readonly attribute long previousTransIndex;
michael@0:   readonly attribute long loadedTransIndex;
michael@0: 
michael@0:   /**
michael@0:    * Notification that entries have been removed from the beginning of a
michael@0:    * nsSHistory which has this as its rootDocShell.
michael@0:    *
michael@0:    * @param numEntries - The number of entries removed
michael@0:    */
michael@0:   void historyPurged(in long numEntries);
michael@0: 
michael@0:   /*
michael@0:    * @deprecated, use nsIDocShell.QueryInterface(nsIDOMStorageManager) instead.
michael@0:    *
michael@0:    * Retrieves the WebApps session storage object for the supplied principal.
michael@0:    *
michael@0:    * @param principal returns a storage for this principal
michael@0:    * @param documentURI new storage will be created with reference to this
michael@0:    *                    document.documentURI that will appear in storage event
michael@0:    * @param create If true and a session storage object doesn't
michael@0:    *               already exist, a new one will be created.
michael@0:    */
michael@0:   nsIDOMStorage getSessionStorageForPrincipal(in nsIPrincipal principal,
michael@0:                                               in DOMString documentURI,
michael@0:                                               in boolean create);
michael@0: 
michael@0:   /*
michael@0:    * @deprecated, use nsIDocShell.QueryInterface(nsIDOMStorageManager) instead.
michael@0:    *
michael@0:    * Add a WebApps session storage object to the docshell.
michael@0:    *
michael@0:    * @param principal the principal the storage object is associated with
michael@0:    * @param storage the storage object to add
michael@0:    */
michael@0:   void addSessionStorage(in nsIPrincipal principal, in nsIDOMStorage storage);
michael@0: 
michael@0:   /**
michael@0:    * Gets the channel for the currently loaded document, if any. 
michael@0:    * For a new document load, this will be the channel of the previous document
michael@0:    * until after OnLocationChange fires.
michael@0:    */
michael@0:   readonly attribute nsIChannel currentDocumentChannel;
michael@0: 
michael@0:   /**
michael@0:    * Set the offset of this child in its container.
michael@0:    */
michael@0:   [noscript] void setChildOffset(in unsigned long offset);
michael@0: 
michael@0:   /**
michael@0:    * Find out whether the docshell is currently in the middle of a page
michael@0:    * transition. This is set just before the pagehide/unload events fire.
michael@0:    */
michael@0:   readonly attribute boolean isInUnload;
michael@0: 
michael@0:   /**
michael@0:    * Find out if the currently loaded document came from a suspicious channel
michael@0:    * (such as a JAR channel where the server-returned content type isn't a
michael@0:    * known JAR type).
michael@0:    */
michael@0:   readonly attribute boolean channelIsUnsafe;
michael@0: 
michael@0:   /**
michael@0:    * This attribute determines whether Mixed Active Content is loaded on the
michael@0:    * document. When it is true, mixed active content was not blocked and has
michael@0:    * loaded (or is about to load) on the page. When it is false, mixed active content
michael@0:    * has not loaded on the page, either because there was no mixed active content
michael@0:    * requests on the page or such requests were blocked by nsMixedContentBlocker.
michael@0:    * This boolean is set to true in nsMixedContentBlocker if Mixed Active Content
michael@0:    * is allowed (either explicitly on the page by the user or when the about:config
michael@0:    * setting security.mixed_content.block_active_content is set to false).
michael@0:    */
michael@0:   [infallible] readonly attribute boolean hasMixedActiveContentLoaded;
michael@0: 
michael@0:    /**
michael@0:    * This attribute determines whether a document has Mixed Active Content
michael@0:    * that has been blocked from loading. When it is true, there is definitely
michael@0:    * mixed active content on a page that has been blocked by
michael@0:    * nsMixedContentBlocker.  When it is false, there may or may not be mixed
michael@0:    * active content on a page, but if there is, it will load. Note that if the
michael@0:    * about:config setting security.mixed_content.block_active_content is set
michael@0:    * false, this boolean will be false, since blocking active content has been
michael@0:    * disabled.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean hasMixedActiveContentBlocked;
michael@0: 
michael@0:   /**
michael@0:    * This attribute determines whether Mixed Display Content is loaded on the
michael@0:    * document. When it is true, mixed display content was not blocked and has
michael@0:    * loaded (or is about to load) on the page. Similar behavior to
michael@0:    * hasMixedActiveContentLoaded.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean hasMixedDisplayContentLoaded;
michael@0: 
michael@0:    /**
michael@0:    * This attribute determines whether a document has Mixed Display Content
michael@0:    * that has been blocked from loading. Similar behavior to
michael@0:    * hasMixedActiveContentBlocked.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean hasMixedDisplayContentBlocked;
michael@0: 
michael@0:   /**
michael@0:    * Disconnects this docshell's editor from its window, and stores the
michael@0:    * editor data in the open document's session history entry.  This
michael@0:    * should be called only during page transitions.
michael@0:    */
michael@0:   [noscript, notxpcom] void DetachEditorFromWindow();
michael@0: 
michael@0:   /**
michael@0:    * If true, this browser is not visible in the traditional sense, but
michael@0:    * is actively being rendered to the screen (ex. painted on a canvas)
michael@0:    * and should be treated accordingly.
michael@0:    **/
michael@0:   attribute boolean isOffScreenBrowser;    
michael@0: 
michael@0:   /**
michael@0:    * If the current content viewer isn't initialized for print preview,
michael@0:    * it is replaced with one which is and to which an about:blank document
michael@0:    * is loaded.
michael@0:    */
michael@0:   readonly attribute nsIWebBrowserPrint printPreview;
michael@0: 
michael@0:   /**
michael@0:    * Whether this docshell can execute scripts based on its hierarchy.
michael@0:    * The rule of thumb here is that we disable js if this docshell or any
michael@0:    * of its parents disallow scripting.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean canExecuteScripts;
michael@0: 
michael@0:   /**
michael@0:    * Sets whether a docshell is active. An active docshell is one that is
michael@0:    * visible, and thus is not a good candidate for certain optimizations
michael@0:    * like image frame discarding. Docshells are active unless told otherwise.
michael@0:    */
michael@0:   attribute boolean isActive;
michael@0: 
michael@0:   /**
michael@0:    * The ID of the docshell in the session history.
michael@0:    */
michael@0:   readonly attribute unsigned long long historyID;
michael@0: 
michael@0:   /**
michael@0:    * Sets whether a docshell is an app tab. An app tab docshell may behave
michael@0:    * differently than a non-app tab docshell in some cases, such as when
michael@0:    * handling link clicks. Docshells are not app tabs unless told otherwise.
michael@0:    */
michael@0:   attribute boolean isAppTab;
michael@0: 
michael@0:   /**
michael@0:    * Create a new about:blank document and content viewer.
michael@0:    * @param aPrincipal the principal to use for the new document.
michael@0:    */
michael@0:   void createAboutBlankContentViewer(in nsIPrincipal aPrincipal);
michael@0: 
michael@0:   /**
michael@0:    * Upon getting, returns the canonical encoding label of the document
michael@0:    * currently loaded into this docshell.
michael@0:    *
michael@0:    * Upon setting, sets forcedCharset for compatibility with legacy callers.
michael@0:    */
michael@0:   attribute ACString charset;
michael@0: 
michael@0:   /**
michael@0:    * Called when the user chose an encoding override from the character
michael@0:    * encoding menu. Separate from the setter for the charset property to avoid
michael@0:    * extensions adding noise to the data.
michael@0:    */
michael@0:   void gatherCharsetMenuTelemetry();
michael@0: 
michael@0:   /**
michael@0:    * The charset forced by the user.
michael@0:    */
michael@0:   attribute ACString forcedCharset;
michael@0: 
michael@0:   /**
michael@0:    * In a child docshell, this is the charset of the parent docshell
michael@0:    */
michael@0:   [noscript, notxpcom, nostdcall] void setParentCharset(
michael@0:     in ACString parentCharset,
michael@0:     in int32_t parentCharsetSource,
michael@0:     in nsIPrincipal parentCharsetPrincipal);
michael@0:   [noscript, notxpcom, nostdcall] void getParentCharset(
michael@0:     out ACString parentCharset,
michael@0:     out int32_t parentCharsetSource,
michael@0:     out nsIPrincipal parentCharsetPrincipal);
michael@0: 
michael@0:   /**
michael@0:    * Add an observer to the list of parties to be notified when this docshell's
michael@0:    * private browsing status is changed. |obs| must support weak references.
michael@0:    */
michael@0:   void addWeakPrivacyTransitionObserver(in nsIPrivacyTransitionObserver obs);
michael@0: 
michael@0:   /**
michael@0:    * Add an observer to the list of parties to be notified when reflows are
michael@0:    * occurring. |obs| must support weak references.
michael@0:    */
michael@0:   void addWeakReflowObserver(in nsIReflowObserver obs);
michael@0: 
michael@0:   /**
michael@0:    * Remove an observer from the list of parties to be notified about reflows.
michael@0:    */
michael@0:   void removeWeakReflowObserver(in nsIReflowObserver obs);
michael@0: 
michael@0:   /**
michael@0:    * Notify all attached observers that a reflow has just occurred.
michael@0:    *
michael@0:    * @param interruptible if true, the reflow was interruptible.
michael@0:    * @param start         timestamp when reflow started, in milliseconds since
michael@0:    *                      navigationStart (accurate to 1/1000 of a ms)
michael@0:    * @param end           timestamp when reflow ended, in milliseconds since
michael@0:    *                      navigationStart (accurate to 1/1000 of a ms)
michael@0:    */
michael@0:   [noscript] void notifyReflowObservers(in bool interruptible,
michael@0:                                         in DOMHighResTimeStamp start,
michael@0:                                         in DOMHighResTimeStamp end);
michael@0: 
michael@0:   /**
michael@0:    * Add an observer to the list of parties to be notified when scroll position
michael@0:    * of some elements is changed.
michael@0:    */
michael@0:   [noscript] void addWeakScrollObserver(in nsIScrollObserver obs);
michael@0: 
michael@0:   /**
michael@0:    * Add an observer to the list of parties to be notified when scroll position
michael@0:    * of some elements is changed.
michael@0:    */
michael@0:   [noscript] void removeWeakScrollObserver(in nsIScrollObserver obs);
michael@0: 
michael@0:   /**
michael@0:    * Notify all attached observers that the scroll position of some element
michael@0:    * has changed.
michael@0:    */
michael@0:   [noscript] void notifyScrollObservers();
michael@0: 
michael@0:   /**
michael@0:    * Returns true if this docshell corresponds to an <iframe mozbrowser>.
michael@0:    * (<iframe mozapp mozbrowser> is not considered a browser.)
michael@0:    */
michael@0:   [infallible] readonly attribute boolean isBrowserElement;
michael@0: 
michael@0:   /**
michael@0:    * Returns true iff the docshell corresponds to an <iframe mozapp>.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean isApp;
michael@0: 
michael@0:   /**
michael@0:    * Returns isBrowserElement || isApp.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean isBrowserOrApp;
michael@0: 
michael@0:   /**
michael@0:    * Returns true if this docshell corresponds to an <iframe mozbrowser> or if
michael@0:    * the docshell is contained in an <iframe mozbrowser>.  (<iframe mozapp
michael@0:    * mozbrowser> does not count as a browser.)
michael@0:    *
michael@0:    * Our notion here of "contained in" means: Walk up the docshell hierarchy in
michael@0:    * this process until we hit an <iframe mozapp> or <iframe mozbrowser> (or
michael@0:    * until the hierarchy ends).  Return true iff the docshell we stopped on has
michael@0:    * isBrowserElement == true.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean isInBrowserElement;
michael@0: 
michael@0:   /**
michael@0:    * Returns true if this docshell corresponds to an <iframe mozbrowser> or
michael@0:    * <iframe mozap>, or if this docshell is contained in an <iframe mozbrowser>
michael@0:    * or <iframe mozapp>.
michael@0:    *
michael@0:    * To compute this value, we walk up the docshell hierarchy.  If we encounter
michael@0:    * a docshell with isBrowserElement or isApp before we hit the end of the
michael@0:    * hierarchy, we return true.  Otherwise, we return false.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean isInBrowserOrApp;
michael@0: 
michael@0:    /**
michael@0:     * Indicate that this docshell corresponds to an app with the given app id.
michael@0:     *
michael@0:     * You may pass NO_APP_ID or UNKNOWN_APP_ID for containingAppId.  If you
michael@0:     * pass NO_APP_ID, then this docshell will return NO_APP_ID for appId.  If
michael@0:     * you pass UNKNOWN_APP_ID, then this docshell will search its hiearchy for
michael@0:     * an app frame and use that frame's appId.
michael@0:     *
michael@0:     * You can call this method more than once, but there's no guarantee that
michael@0:     * other components will update their view of the world if you change a
michael@0:     * docshell's app id, so tread lightly.
michael@0:     *
michael@0:     * If you call this method after calling setIsBrowserInsideApp, this
michael@0:     * docshell will forget the fact that it was a browser.
michael@0:     */
michael@0:    void setIsApp(in unsigned long ownAppId);
michael@0: 
michael@0:    /**
michael@0:     * Indicate that this docshell corresponds to a browser inside an app with
michael@0:     * the given ID.  As with setIsApp, you may pass NO_APP_ID or
michael@0:     * UNKNOWN_APP_ID.
michael@0:     *
michael@0:     * As with setIsApp, you may call this more than once, but it's kind of a
michael@0:     * hack, so be careful.
michael@0:     */
michael@0:    void setIsBrowserInsideApp(in unsigned long containingAppId);
michael@0: 
michael@0:   /**
michael@0:    * Returns the id of the app associated with this docshell.  If this docshell
michael@0:    * is an <iframe mozbrowser> inside an <iframe mozapp>, we return the app's
michael@0:    * appId.
michael@0:    *
michael@0:    * We compute this value by walking up the docshell hierarchy until we find a
michael@0:    * docshell on which setIsApp(x) or setIsBrowserInsideApp(x) was called
michael@0:    * (ignoring those docshells where x == UNKNOWN_APP_ID).  We return the app
michael@0:    * id x.
michael@0:    *
michael@0:    * If we don't find a docshell with an associated app id in our hierarchy, we
michael@0:    * return NO_APP_ID.  We never return UNKNOWN_APP_ID.
michael@0:    *
michael@0:    * Notice that a docshell may have an associated app even if it returns true
michael@0:    * for isBrowserElement!
michael@0:    */
michael@0:   [infallible] readonly attribute unsigned long appId;
michael@0: 
michael@0:   /**
michael@0:    * Return the manifest URL of the app associated with this docshell.
michael@0:    *
michael@0:    * If there is no associated app in our hierarchy, we return empty string.
michael@0:    */
michael@0:   readonly attribute DOMString appManifestURL;
michael@0: 
michael@0:   /**
michael@0:    * Like nsIDocShellTreeItem::GetSameTypeParent, except this ignores <iframe
michael@0:    * mozbrowser> and <iframe mozapp> boundaries.
michael@0:    */
michael@0:   nsIDocShell getSameTypeParentIgnoreBrowserAndAppBoundaries();
michael@0: 
michael@0:   /** 
michael@0:    * True iff asynchronous panning and zooming is enabled for this
michael@0:    * docshell.
michael@0:    */
michael@0:   readonly attribute bool asyncPanZoomEnabled;
michael@0: 
michael@0:   /**
michael@0:    * The sandbox flags on the docshell. These reflect the value of the sandbox
michael@0:    * attribute of the associated IFRAME or CSP-protectable content, if
michael@0:    * existent. See the HTML5 spec for more details.
michael@0:    * These flags on the docshell reflect the current state of the sandbox
michael@0:    * attribute, which is modifiable. They are only used when loading new
michael@0:    * content, sandbox flags are also immutably set on the document when it is
michael@0:    * loaded.
michael@0:    * The sandbox flags of a document depend on the sandbox flags on its
michael@0:    * docshell and of its parent document, if any.
michael@0:    * See nsSandboxFlags.h for the possible flags.
michael@0:    */
michael@0:   attribute unsigned long sandboxFlags;
michael@0: 
michael@0:   /**
michael@0:    * When a new browsing context is opened by a sandboxed document, it needs to
michael@0:    * keep track of the browsing context that opened it, so that it can be
michael@0:    * navigated by it.  This is the "one permitted sandboxed navigator".
michael@0:    */
michael@0:   attribute nsIDocShell onePermittedSandboxedNavigator;
michael@0: 
michael@0:   /**
michael@0:    * Returns true if we are sandboxed from aTargetDocShell.
michael@0:    * aTargetDocShell - the browsing context we are attempting to navigate.
michael@0:    */
michael@0:   [noscript,notxpcom,nostdcall] bool isSandboxedFrom(in nsIDocShell aTargetDocShell);
michael@0: 
michael@0:   /**
michael@0:    * This member variable determines whether a document has Mixed Active Content that
michael@0:    * was initially blocked from loading, but the user has choosen to override the
michael@0:    * block and allow the content to load. mMixedContentChannel is set to the document's
michael@0:    * channel when the user allows mixed content. The nsMixedContentBlocker content policy
michael@0:    * checks if the document's root channel matches the mMixedContentChannel.  If it matches,
michael@0:    * then Mixed Content is loaded.  If it does match, mixed content is blocked.
michael@0:    *
michael@0:    * A match implies that there is definitely mixed active content on a page that was
michael@0:    * initially blocked by nsMixedContentBlocker and then allowed and loaded by the user.
michael@0:    * A miss imples that IF there is mixed active content on the page AND it was
michael@0:    * blocked by nsMixedContentBlocker.cpp, the user has not choosen to override
michael@0:    * the block. Note that if the about:config setting
michael@0:    * security.mixed_content.block_active_content is set to false, this boolean
michael@0:    * will be false, mMixedContentChannel will remain null since blocking active content has
michael@0:    * been disabled and hence mMixedContentChannel will never be set.
michael@0:    */
michael@0:   attribute nsIChannel mixedContentChannel;
michael@0: 
michael@0:   /**
michael@0:    * Checks whether the channel associated with the root docShell is equal to
michael@0:    * mMixedContentChannel. If they are the same, allowMixedContent is set to true.
michael@0:    * Checks if the root document has a secure connection. If it is, sets 
michael@0:    * rootHasSecureConnection to true. If the docShell is the root doc shell, 
michael@0:    * isRootDocShell is set to true. 
michael@0:    */
michael@0:   void GetAllowMixedContentAndConnectionData(out boolean rootHasSecureConnection, out boolean allowMixedContent, out boolean isRootDocShell);
michael@0: 
michael@0: 
michael@0:   /**
michael@0:    * Are plugins allowed in the current document loaded in this docshell ?
michael@0:    * (if there is one). This depends on whether plugins are allowed by this
michael@0:    * docshell itself or if the document is sandboxed and hence plugins should
michael@0:    * not be allowed.
michael@0:    */
michael@0:   [noscript, notxpcom] bool pluginsAllowedInCurrentDoc();
michael@0:   
michael@0: 
michael@0:   /**
michael@0:    * Attribute that determines whether fullscreen is allowed to be entered for
michael@0:    * this subtree of the docshell tree. This is true when all iframes containing
michael@0:    * this docshell have their "allowfullscreen" attribute set to "true".
michael@0:    * fullscreenAllowed is only writable at content boundaries, where it is used
michael@0:    * to propagate the value of the cross process parent's iframe's
michael@0:    * "allowfullscreen" attribute to the child process. Setting
michael@0:    * fullscreenAllowed on docshells which aren't content boundaries throws an
michael@0:    * exception.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean fullscreenAllowed;
michael@0:   
michael@0:   void setFullscreenAllowed(in boolean allowed);
michael@0: 
michael@0:   [noscript, infallible] attribute boolean affectPrivateSessionLifetime;
michael@0: 
michael@0:   /**
michael@0:    * Indicates whether the UI may enable the character encoding menu. The UI
michael@0:    * must disable the menu when this property is false.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean mayEnableCharacterEncodingMenu;
michael@0: 
michael@0:            attribute  nsIEditor editor;
michael@0:   readonly attribute  boolean   editable;             /* this docShell is editable */
michael@0:   readonly attribute  boolean   hasEditingSession;    /* this docShell has an editing session */
michael@0:     
michael@0:   /**
michael@0:    * Make this docShell editable, setting a flag that causes
michael@0:    * an editor to get created, either immediately, or after
michael@0:    * a url has been loaded.
michael@0:    *      @param  inWaitForUriLoad    true to wait for a URI before
michael@0:    *                                  creating the editor.
michael@0:    */     
michael@0:   void makeEditable(in boolean inWaitForUriLoad);
michael@0: 
michael@0:   /**
michael@0:    * Get the SHEntry associated with a child docshell
michael@0:    */
michael@0:   nsISHEntry getChildSHEntry(in long aChildOffset);
michael@0: 
michael@0:   /**
michael@0:    * Add a Child SHEntry for a frameset page, given the child's loadtype.
michael@0:    * If aCloneChildren is true, then aCloneReference's children will be
michael@0:    * cloned onto aHistoryEntry.
michael@0:    */
michael@0:   void addChildSHEntry(in nsISHEntry aCloneReference,
michael@0:                        in nsISHEntry aHistoryEntry,
michael@0:                        in long aChildOffset,
michael@0:                        in unsigned long aLoadType,
michael@0:                        in boolean aCloneChilden);
michael@0: 
michael@0:   /**
michael@0:    * Whether this docshell should save entries in global history.
michael@0:    */
michael@0:   attribute boolean useGlobalHistory;
michael@0: 
michael@0:   /**
michael@0:    * Removes nsISHEntry objects related to this docshell from session history.
michael@0:    * Use this only with subdocuments, like iframes.
michael@0:    */
michael@0:   void removeFromSessionHistory();
michael@0: 
michael@0:   /**
michael@0:    * Set when an iframe/frame is added dynamically.
michael@0:    */
michael@0:   attribute boolean createdDynamically;
michael@0: 
michael@0:   /**
michael@0:    * Returns false for mLSHE, true for mOSHE
michael@0:    */
michael@0:   boolean getCurrentSHEntry(out nsISHEntry aEntry);
michael@0: 
michael@0:   /**
michael@0:     * Cherry picked parts of nsIController.
michael@0:     * They are here, because we want to call these functions
michael@0:     * from JS.
michael@0:     */
michael@0:   boolean isCommandEnabled(in string command);
michael@0:   void doCommand(in string command);
michael@0: 
michael@0:   /**
michael@0:    * Invisible DocShell are dummy construct to simulate DOM windows
michael@0:    * without any actual visual representation. They have to be marked
michael@0:    * at construction time, to avoid any painting activity.
michael@0:    */
michael@0:   [noscript, notxpcom] bool IsInvisible();
michael@0:   [noscript, notxpcom] void SetInvisible(in bool aIsInvisibleDochsell);
michael@0: 
michael@0: /**
michael@0:  * Get the script global for the document in this docshell.
michael@0: */
michael@0:   [noscript,notxpcom,nostdcall] nsIScriptGlobalObject GetScriptGlobalObject();
michael@0: 
michael@0:   /**
michael@0:    * If deviceSizeIsPageSize is set to true, device-width/height media queries
michael@0:    * will be calculated from the page size, not the device size.
michael@0:    *
michael@0:    * Used by the Responsive Design View and B2G Simulator.
michael@0:    *
michael@0:    * Default is False.
michael@0:    * Default value can be overriden with
michael@0:    * docshell.device_size_is_page_size pref.
michael@0:    */
michael@0:   [infallible] attribute boolean deviceSizeIsPageSize;
michael@0: };