interface nsIDocShell : nsISupports
Get an enumerator over this docShell and its children. @param aItemType - Only include docShells of this type, or if typeAll, include all child shells. Uses types from nsIDocShellTreeItem. @param aDirection - Whether to enumerate forwards or backwards.
certain dochshells (like the message pane) should not throw up auth dialogs because it can act as a password trojan
Attribute that determines whether DNS prefetch is allowed for this subtree of the docshell tree. Defaults to true. Setting this will make it take effect starting with the next document loaded in the docshell.
Attribute stating if it should allow subframes (framesets/iframes) or not
Find out if the currently loaded document came from a suspicious channel (such as a JAR channel where the server-returned content type isn't a known JAR type).
This attribute allows chrome to tie in to handle DOM events that may be of interest to chrome.
attribute nsIDOMEventTarget chromeEventHandler
Content Viewer that is currently loaded for this DocShell. This may change as the underlying content changes.
readonly attribute nsIContentViewer contentViewer
Gets the channel for the currently loaded document, if any. For a new document load, this will be the channel of the previous document until after OnLocationChange fires.
readonly attribute nsIChannel currentDocumentChannel
The document charset info. This is used by a load to determine priorities for charset detection etc.
attribute nsIDocumentCharsetInfo documentCharsetInfo
Presentation shell for the oldest document, if this docshell is currently transitioning between documents.
Find out whether the docshell is currently in the middle of a page transition (after the onunload event has fired, but before the new document has been set up)
If true, this browser is not visible in the traditional sense, but is actively being rendered to the screen (ex. painted on a canvas) and should be treated accordingly.
Presentation context for the currently loaded document. This may be null.
Presentation shell for the currently loaded document. This may be null.
Keeps track of the previous SHTransaction index and the current SHTransaction index at the time that the doc shell begins to load. Used for ContentViewer eviction.
The SecureBrowserUI object for this docshell. This is set by XUL <browser> or nsWebBrowser for their root docshell.
attribute nsISecureBrowserUI securityUI
Set/Get the document scale factor. When setting this attribute, a NS_ERROR_NOT_IMPLEMENTED error may be returned by implementations not supporting zoom. Implementations not supporting zoom should return 1.0 all the time for the Get operation. 1.0 by the way is the default of zoom. This means 100% of normal scaling or in other words normal size no zoom.
Disconnects this docshell's editor from its window, and stores the editor data in the open document's session history entry. This should be called only during page transitions.
Begin firing WebProgressListener notifications for restoring a page presentation. |viewer| is the content viewer whose document we are starting to load. If null, it defaults to the docshell's current content viewer, creating one if necessary. |top| should be true for the toplevel docshell that is being restored; it will be set to false when this method is called for child docshells. This method will post an event to complete the simulated load after returning to the event loop.
void beginRestore(in nsIContentViewer viewer, in boolean top)
Creates a DocShellLoadInfo object that you can manipulate and then pass to loadURI.
void createLoadInfo(out nsIDocShellLoadInfo loadInfo)
Finish firing WebProgressListener notifications and DOM events for restoring a page presentation. This should only be called via beginRestore().
Notify the associated content viewer and all child docshells that they are about to be hidden. If |isUnload| is true, then the document is being unloaded as well. @param isUnload if true, fire the unload event in addition to the pagehide event.
nsISimpleEnumerator getDocShellEnumerator(in long aItemType, in long aDirection)
Notification that entries have been removed from the beginning of a nsSHistory which has this as its rootDocShell. @param numEntries - The number of entries removed
Loads the given URI. This method is identical to loadURI(...) except that its parameter list is broken out instead of being packaged inside of an nsIDocShellLoadInfo object... @param aURI - The URI to load. @param aReferrer - Referring URI @param aOwner - Owner (security principal) @param aInheritOwner - Flag indicating whether the owner of the current document should be inherited if aOwner is null. @param aStopActiveDoc - Flag indicating whether loading the current document should be stopped. @param aWindowTarget - Window target for the load. @param aTypeHint - A hint as to the content-type of the resulting data. May be null or empty if no hint. @param aPostDataStream - Post data stream (if POSTing) @param aHeadersStream - Stream containing "extra" request headers... @param aLoadFlags - Flags to modify load behaviour. Flags are defined in nsIWebNavigation. @param aSHEntry - Active Session History entry (if loading from SH)
[noscript] void internalLoad(in nsIURI aURI, in nsIURI aReferrer, in nsISupports aOwner, in PRUint32 aFlags, in wstring aWindowTarget, in string aTypeHint, in nsIInputStream aPostDataStream, in nsIInputStream aHeadersStream, in unsigned long aLoadFlags, in nsISHEntry aSHEntry, in boolean firstParty, out nsIDocShell aDocShell, out nsIRequest aRequest)
Loads a given stream. This will give priority to loading the requested stream in the object implementing this interface. If it can't be loaded here however, the URL dispatched will go through its normal process of content loading. @param aStream - The input stream that provides access to the data to be loaded. This must be a blocking, threadsafe stream implementation. @param aURI - The URI representing the stream, or null. @param aContentType - The type (MIME) of data being loaded (empty if unknown). @param aContentCharset - The charset of the data being loaded (empty if unknown). @param aLoadInfo - This is the extended load info for this load. This most often will be null, but if you need to do additional setup for this load you can get a loadInfo object by calling createLoadInfo. Once you have this object you can set the needed properties on it and then pass it to loadStream.
Loads a given URI. This will give priority to loading the requested URI in the object implementing this interface. If it can't be loaded here however, the URL dispatcher will go through its normal process of content loading. @param uri - The URI to load. @param loadInfo - This is the extended load info for this load. This most often will be null, but if you need to do additional setup for this load you can get a loadInfo object by calling createLoadInfo. Once you have this object you can set the needed properties on it and then pass it to loadURI. @param aLoadFlags - Flags to modify load behaviour. Flags are defined in nsIWebNavigation. Note that using flags outside LOAD_FLAGS_MASK is only allowed if passing in a non-null loadInfo. And even some of those might not be allowed. Use at your own risk.
Reset state to a new content model within the current document and the document viewer. Called by the document before initiating an out of band document.write().
Restart the XPCOM timers for each meta-refresh URI in this docshell, and this docshell's children, recursively. If the timers are already running, this has no effect.
Set the offset of this child in its container.
For editors and suchlike who wish to change the URI associated with the document. Note if you want to get the current URI, use the read-only property on nsIWebNavigation.
void setCurrentURI(in nsIURI aURI)
Cancel the XPCOM timers for each meta-refresh URI in this docshell, and this docshell's children, recursively. The meta-refresh timers can be restarted using resumeRefreshURIs(). If the timers are already suspended, this has no effect.