@mozilla.org/webshell;1
This component implements the following interfaces:
- nsIBaseWindow
- nsIClipboardCommands
- nsIContentViewerContainer
- nsIDocCharset
- nsIDocShell
- nsIDocShellHistory
- nsIDocShellTreeItem
- nsIDocShellTreeNode
- nsIEditorDocShell
- nsIInterfaceRequestor
- nsIRefreshURI
- nsIScriptGlobalObjectOwner
- nsIScrollable
- nsISupports
- nsISupportsWeakReference
- nsITextScroll
- nsIWebNavigation
- nsIWebPageDescriptor
- nsIWebProgressListener
Constants
Properties
PRBool nsIDocShell.allowAuth
Certain dochshells (like the message pane) should not throw up auth dialogs because it can act as a password trojan
PRBool nsIDocShell.allowImages
Attribute stating whether or not images should be loaded.
PRBool nsIDocShell.allowJavascript
Whether to allow Javascript execution
PRBool nsIDocShell.allowMetaRedirects
Attribute stating if refresh based redirects can be allowed
PRBool nsIDocShell.allowPlugins
Whether to allow plugin execution
PRBool nsIDocShell.allowSubframes
Attribute stating if it should allow subframes (framesets/iframes) or not
PRUint32 nsIDocShell.appType
PRBool nsIBaseWindow.blurSuppression
Set blurSuppression to true to suppress handling of blur events. set it false to re-enable them. query it to determine whether blur events are suppressed. The implementation should allow for blur events to be suppressed multiple times.
readonly PRUint32 nsIDocShell.busyFlags
readonly PRBool nsIWebNavigation.canGoBack
Indicates if the object can go back. If true this indicates that there is back session history available for navigation.
readonly PRBool nsIWebNavigation.canGoForward
Indicates if the object can go forward. If true this indicates that there is forward session history available for navigation
PRBool nsIDocShell.canvasHasFocus
readonly PRBool nsIDocShell.channelIsUnsafe
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).
char* nsIDocCharset.charset
Get/sets the encoding (converter) used to read the document. Get returns the encoding used. Set forces (overrides) the encoding. After forcing the charset the embedding application will need to cause the data to be reparsed in order to update the DOM / display.
A force also sets the fallback encoding for this frame.
readonly PRInt32 nsIDocShellTreeNode.childCount
nsIDOMEventTarget nsIDocShell.chromeEventHandler
This attribute allows chrome to tie in to handle DOM events that may be of interest to chrome.
readonly nsIContentViewer nsIDocShell.contentViewer
Content Viewer that is currently loaded for this DocShell. This may change as the underlying content changes.
readonly nsISupports nsIWebPageDescriptor.currentDescriptor
Retrieves the page descriptor for the curent document.
readonly nsIChannel nsIDocShell.currentDocumentChannel
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 nsIURI nsIWebNavigation.currentURI
The currently loaded URI or null.
readonly nsIDOMDocument nsIWebNavigation.document
Retrieves the current DOM document for the frame, or lazily creates a blank document if there is none. This attribute never returns null except for unexpected error situations.
nsIDocumentCharsetInfo nsIDocShell.documentCharsetInfo
The document charset info. This is used by a load to determine priorities for charset detection etc.
readonly PRBool nsIEditorDocShell.editable
nsIEditor nsIEditorDocShell.editor
readonly nsIPresShell nsIDocShell.eldestPresShell
Presentation shell for the oldest document, if this docshell is currently transitioning between documents.
PRBool nsIBaseWindow.enabled
readonly PRBool nsIEditorDocShell.hasEditingSession
PRBool nsIDocShell.hasFocus
readonly PRBool nsIDocShell.isExecutingOnLoadHandler
readonly PRBool nsIDocShell.isInUnload
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)
PRInt32 nsIDocShellTreeItem.itemType
nsILayoutHistoryState nsIDocShell.layoutHistoryState
readonly PRInt32 nsIDocShell.loadedTransIndex
PRUint32 nsIDocShell.loadType
readonly nsIWidget nsIBaseWindow.mainWidget
PRInt32 nsIDocShell.marginHeight
PRInt32 nsIDocShell.marginWidth
PRUnichar* nsIDocShellTreeItem.name
The nsIDocShellTreeItem supplies the methods that are required of any item that wishes to be able to live within the docshell tree either as a middle node or a leaf.
readonly nsIDocShellTreeItem nsIDocShellTreeItem.parent
nativeWindow nsIBaseWindow.parentNativeWindow
nsIWidget nsIBaseWindow.parentWidget
readonly nsPresContext* nsIDocShell.presContext
Presentation context for the currently loaded document. This may be null.
readonly nsIPresShell nsIDocShell.presShell
Presentation shell for the currently loaded document. This may be null.
readonly PRInt32 nsIDocShell.previousTransIndex
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.
readonly nsIURI nsIWebNavigation.referringURI
The referring URI for the currently loaded URI or null.
readonly PRBool nsIRefreshURI.refreshPending
True when there are pending refreshes, false otherwise.
readonly PRBool nsIDocShell.restoringDocument
readonly nsIDocShellTreeItem nsIDocShellTreeItem.rootTreeItem
readonly nsIDocShellTreeItem nsIDocShellTreeItem.sameTypeParent
readonly nsIDocShellTreeItem nsIDocShellTreeItem.sameTypeRootTreeItem
nsISecureBrowserUI nsIDocShell.securityUI
The SecureBrowserUI object for this docshell. This is set by XUL
nsISHistory nsIWebNavigation.sessionHistory
The session history object used by this web navigation instance.
readonly PRBool nsIDocShell.shouldSaveLayoutState
PRUnichar* nsIBaseWindow.title
readonly nsIDocShellTreeOwner nsIDocShellTreeItem.treeOwner
PRBool nsIDocShell.useErrorPages
PRBool nsIDocShellHistory.useGlobalHistory
PRBool nsIBaseWindow.visibility
float nsIDocShell.zoom
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.
Methods
| Interface | Method |
|---|---|
| nsIDocShellTreeNode |
void addChild ( nsIDocShellTreeItem child )
|
| nsIDocShellHistory |
void addChildSHEntry ( nsISHEntry cloneReference , nsISHEntry historyEntry , PRInt32 childOffset )
|
| nsIDocShell |
void addSessionStorage ( ACString domain , nsIDOMStorage storage )
|
| nsIDocShell |
void beginRestore ( nsIContentViewer viewer , PRBool top )
|
| nsIRefreshURI |
void cancelRefreshURITimers ( )
|
| nsIClipboardCommands |
PRBool canCopyImageContents ( )
|
| nsIClipboardCommands |
PRBool canCopyImageLocation ( )
|
| nsIClipboardCommands |
PRBool canCopyLinkLocation ( )
|
| nsIClipboardCommands |
PRBool canCopySelection ( )
|
| nsIClipboardCommands |
PRBool canCutSelection ( )
|
| nsIClipboardCommands |
PRBool canPaste ( )
|
| nsIClipboardCommands |
void copyImageContents ( )
|
| nsIClipboardCommands |
void copyImageLocation ( )
|
| nsIClipboardCommands |
void copyLinkLocation ( )
|
| nsIClipboardCommands |
void copySelection ( )
|
| nsIBaseWindow |
void create ( )
|
| nsIDocShell |
void createLoadInfo ( out nsIDocShellLoadInfo loadInfo )
|
| nsIClipboardCommands |
void cutSelection ( )
|
| nsIBaseWindow |
void destroy ( )
|
| nsIContentViewerContainer |
void embed ( nsIContentViewer docViewer , char* command , nsISupports extraInfo )
|
| nsIDocShellTreeNode |
nsIDocShellTreeItem findChildWithName ( PRUnichar* name , PRBool recurse , PRBool sameType , nsIDocShellTreeItem requestor , nsIDocShellTreeItem originalRequestor )
|
| nsIDocShellTreeItem |
nsIDocShellTreeItem findItemWithName ( PRUnichar* name , nsISupports requestor , nsIDocShellTreeItem originalRequestor )
|
| nsIDocShell |
void finishRestore ( )
|
| nsIDocShell |
[noscript] void firePageHideNotification ( PRBool isUnload )
|
| nsIRefreshURI |
void forceRefreshURI ( nsIURI URI , PRInt32 millis , PRBool metaRefresh )
|
| nsIDocShellTreeNode |
nsIDocShellTreeItem getChildAt ( PRInt32 index )
|
| nsIDocShellHistory |
nsISHEntry getChildSHEntry ( PRInt32 childOffset )
|
| nsIScrollable |
PRInt32 getCurScrollPos ( PRInt32 scrollOrientation )
|
| nsIScrollable |
PRInt32 getDefaultScrollbarPreferences ( PRInt32 scrollOrientation )
|
| nsIDocShell |
nsISimpleEnumerator getDocShellEnumerator ( PRInt32 itemType , PRInt32 direction )
|
| nsIInterfaceRequestor |
void getInterface ( nsIIDRef uuid , out nsQIResult* result )
|
| nsIBaseWindow |
void getPosition ( out PRInt32 x , out PRInt32 y )
|
| nsIBaseWindow |
void getPositionAndSize ( out PRInt32 x , out PRInt32 y , out PRInt32 cx , out PRInt32 cy )
|
| nsIScrollable |
void getScrollbarVisibility ( out PRBool verticalVisible , out PRBool horizontalVisible )
|
| nsIScrollable |
void getScrollRange ( PRInt32 scrollOrientation , out PRInt32 minPos , out PRInt32 maxPos )
|
| nsIDocShell |
nsIDOMStorage getSessionStorageForURI ( nsIURI uri )
|
| nsIBaseWindow |
void getSize ( out PRInt32 cx , out PRInt32 cy )
|
| nsISupportsWeakReference |
nsIWeakReference GetWeakReference ( )
|
| nsIWebNavigation |
void goBack ( )
|
| nsIWebNavigation |
void goForward ( )
|
| nsIWebNavigation |
void gotoIndex ( PRInt32 index )
|
| nsIDocShell |
void historyPurged ( PRInt32 numEntries )
|
| nsIBaseWindow |
[noscript] void initWindow ( nativeWindow parentNativeWindow , nsIWidget parentWidget , PRInt32 x , PRInt32 y , PRInt32 cx , PRInt32 cy )
|
| nsIDocShell |
[noscript] void internalLoad ( nsIURI URI , nsIURI referrer , nsISupports owner , PRUint32 flags , PRUnichar* windowTarget , char* typeHint , nsIInputStream postDataStream , nsIInputStream headersStream , PRUint32 loadFlags , nsISHEntry SHEntry , PRBool firstParty , out nsIDocShell docShell , out nsIRequest request )
|
| nsIDocShell |
PRBool isBeingDestroyed ( )
|
| nsIWebPageDescriptor |
void loadPage ( nsISupports pageDescriptor , PRUint32 displayType )
|
| nsIDocShell |
[noscript] void loadStream ( nsIInputStream stream , nsIURI URI , ACString contentType , ACString contentCharset , nsIDocShellLoadInfo loadInfo )
|
| nsIWebNavigation |
void loadURI ( PRUnichar* URI , PRUint32 loadFlags , nsIURI referrer , nsIInputStream postData , nsIInputStream headers )
|
| nsIEditorDocShell |
void makeEditable ( PRBool inWaitForUriLoad )
|
| nsIDocShellTreeItem |
PRBool nameEquals ( PRUnichar* name )
|
| nsIWebProgressListener |
void onLocationChange ( nsIWebProgress webProgress , nsIRequest request , nsIURI location )
|
| nsIWebProgressListener |
void onProgressChange ( nsIWebProgress webProgress , nsIRequest request , PRInt32 curSelfProgress , PRInt32 maxSelfProgress , PRInt32 curTotalProgress , PRInt32 maxTotalProgress )
|
| nsIWebProgressListener |
void onSecurityChange ( nsIWebProgress webProgress , nsIRequest request , PRUint32 state )
|
| nsIWebProgressListener |
void onStateChange ( nsIWebProgress webProgress , nsIRequest request , PRUint32 stateFlags , nsresult status )
|
| nsIWebProgressListener |
void onStatusChange ( nsIWebProgress webProgress , nsIRequest request , nsresult status , PRUnichar* message )
|
| nsIClipboardCommands |
void paste ( )
|
| nsIDocShell |
void prepareForNewContentModel ( )
|
| nsIRefreshURI |
void refreshURI ( nsIURI URI , PRInt32 millis , PRBool repeat , PRBool metaRefresh )
|
| nsIWebNavigation |
void reload ( PRUint32 reloadFlags )
|
| nsIDocShellTreeNode |
void removeChild ( nsIDocShellTreeItem child )
|
| nsIBaseWindow |
void repaint ( PRBool force )
|
| nsIDocShell |
void resumeRefreshURIs ( )
|
| nsITextScroll |
void scrollByLines ( PRInt32 numLines )
|
| nsITextScroll |
void scrollByPages ( PRInt32 numPages )
|
| nsIClipboardCommands |
void selectAll ( )
|
| nsIClipboardCommands |
void selectNone ( )
|
| nsIDocShell |
[noscript] void setChildOffset ( PRUint32 offset )
|
| nsIDocShell |
void setCurrentURI ( nsIURI URI )
|
| nsIScrollable |
void setCurScrollPos ( PRInt32 scrollOrientation , PRInt32 curPos )
|
| nsIScrollable |
void setCurScrollPosEx ( PRInt32 curHorizontalPos , PRInt32 curVerticalPos )
|
| nsIScrollable |
void setDefaultScrollbarPreferences ( PRInt32 scrollOrientation , PRInt32 scrollbarPref )
|
| nsIBaseWindow |
void setFocus ( )
|
| nsIContentViewerContainer |
void setIsPrinting ( PRBool isPrinting )
|
| nsIBaseWindow |
void setPosition ( PRInt32 x , PRInt32 y )
|
| nsIBaseWindow |
void setPositionAndSize ( PRInt32 x , PRInt32 y , PRInt32 cx , PRInt32 cy , PRBool fRepaint )
|
| nsIScrollable |
void setScrollRange ( PRInt32 scrollOrientation , PRInt32 minPos , PRInt32 maxPos )
|
| nsIScrollable |
void setScrollRangeEx ( PRInt32 minHorizontalPos , PRInt32 maxHorizontalPos , PRInt32 minVerticalPos , PRInt32 maxVerticalPos )
|
| nsIBaseWindow |
void setSize ( PRInt32 cx , PRInt32 cy , PRBool fRepaint )
|
| nsIDocShellTreeItem |
[noscript] void setTreeOwner ( nsIDocShellTreeOwner treeOwner )
|
| nsIRefreshURI |
void setupRefreshURI ( nsIChannel channel )
|
| nsIRefreshURI |
void setupRefreshURIFromHeader ( nsIURI baseURI , ACString header )
|
| nsIWebNavigation |
void stop ( PRUint32 stopFlags )
|
| nsIDocShell |
void suspendRefreshURIs ( )
|
| nsIDocShell |
void tabToTreeOwner ( PRBool forward , out PRBool tookFocus )
|
Reference documentation is generated from Mozilla's source.
