This component implements the following interfaces:


PRInt32 nsIDocShellTreeItem.typeChrome = 0
PRInt32 nsIDocShellTreeItem.typeContent = 1
PRInt32 nsIDocShellTreeItem.typeContentWrapper = 2
PRInt32 nsIDocShellTreeItem.typeChromeWrapper = 3
PRInt32 nsIDocShellTreeItem.typeAll = 2147483647
PRInt32 nsIScrollable.ScrollOrientation_X = 1
PRInt32 nsIScrollable.ScrollOrientation_Y = 2
PRInt32 nsIScrollable.Scrollbar_Auto = 1
PRInt32 nsIScrollable.Scrollbar_Never = 2
PRInt32 nsIScrollable.Scrollbar_Always = 3
PRUint32 nsIWebBrowserPersist.PERSIST_FLAGS_NONE = 0
PRUint32 nsIWebBrowserPersist.PERSIST_FLAGS_FROM_CACHE = 1
PRUint32 nsIWebBrowserPersist.PERSIST_FLAGS_BYPASS_CACHE = 2
PRUint32 nsIWebBrowserPersist.PERSIST_FLAGS_NO_CONVERSION = 16
PRUint32 nsIWebBrowserPersist.PERSIST_FLAGS_DONT_FIXUP_LINKS = 512
Automatically cleanup after a failed or cancelled operation, deleting all created files and directories. This flag does nothing for failed upload operations to remote servers.
Let the WebBrowserPersist decide whether the incoming data is encoded and whether it needs to go through a content converter e.g. to decompress it.
PRUint32 nsIWebBrowserPersist.PERSIST_STATE_READY = 1
PRUint32 nsIWebBrowserPersist.PERSIST_STATE_SAVING = 2
PRUint32 nsIWebBrowserPersist.PERSIST_STATE_FINISHED = 3
For plaintext output. Convert html to plaintext that looks like the html. Implies wrap (except inside <pre>), since html wraps. HTML output: always do prettyprinting, ignoring existing formatting.
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_FORMATTED = 2
Output without formatting or wrapping the content. This flag may be used to preserve the original formatting as much as possible.
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_RAW = 4
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_BODY_ONLY = 8
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_PREFORMATTED = 16
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_WRAP = 32
For plaintext output. Output for format flowed (RFC 2646). This is used when converting to text for mail sending. This differs just slightly but in an important way from normal formatted, and that is that lines are space stuffed. This can't (correctly) be done later.
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_FORMAT_FLOWED = 64
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_ABSOLUTE_LINKS = 128
Attempt to encode entities standardized at W3C (HTML, MathML, etc). This is a catch-all flag for documents with mixed contents. Beware of interoperability issues. See below for other flags which might likely do what you want.
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_ENCODE_W3C_ENTITIES = 256
Output with carriage return line breaks. May also be combined with ENCODE_FLAGS_LF_LINEBREAKS and if neither is specified, the platform default format is used.
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_CR_LINEBREAKS = 512
Output with linefeed line breaks. May also be combined with ENCODE_FLAGS_CR_LINEBREAKS and if neither is specified, the platform default format is used.
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_LF_LINEBREAKS = 1024
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_NOSCRIPT_CONTENT = 2048
PRUint32 nsIWebBrowserPersist.ENCODE_FLAGS_NOFRAMES_CONTENT = 4096
Encode basic entities, e.g. output   instead of character code 0xa0. The basic set is just   & < > " for interoperability with older products that don't support α and friends.
Encode Latin1 entities. This includes the basic set and accented letters between 128 and 255.
Encode HTML4 entities. This includes the basic set, accented letters, greek letters and certain special markup symbols.
Boolean. Enables/disables plugin support for this browser.

PRUint32 nsIWebBrowserSetup.SETUP_ALLOW_PLUGINS = 1
Boolean. Enables/disables Javascript support for this browser.

PRUint32 nsIWebBrowserSetup.SETUP_ALLOW_JAVASCRIPT = 2
Boolean. Enables/disables meta redirect support for this browser. Meta redirect timers will be ignored if this option is disabled.

Boolean. Enables/disables subframes within the browser

PRUint32 nsIWebBrowserSetup.SETUP_ALLOW_SUBFRAMES = 4
Boolean. Enables/disables image loading for this browser window. If you disable the images, load a page, then enable the images, the page will *not* automatically load the images for the previously loaded page. This flag controls the state of a webBrowser at load time and does not automatically re-load a page when the state is toggled. Reloading must be done by hand, or by walking through the DOM tree and re-setting the src attributes.

PRUint32 nsIWebBrowserSetup.SETUP_ALLOW_IMAGES = 5
Boolean. Enables/disables whether the document as a whole gets focus before traversing the document's content, or after traversing its content.

NOTE: this property is obsolete and now has no effect

Boolean. Enables/disables the use of global history in the browser. Visited URLs will not be recorded in the global history when it is disabled.

PRUint32 nsIWebBrowserSetup.SETUP_USE_GLOBAL_HISTORY = 256
Boolean. A value of PR_TRUE makes the browser a chrome wrapper. Default is PR_FALSE.

PRUint32 nsIWebBrowserSetup.SETUP_IS_CHROME_WRAPPER = 7
This flags defines the range of bits that may be specified.
PRUint32 nsIWebNavigation.LOAD_FLAGS_MASK = 65535
This is the default value for the load flags parameter.
PRUint32 nsIWebNavigation.LOAD_FLAGS_NONE = 0
This flag specifies that the load should have the semantics of an HTML Meta-refresh tag (i.e., that the cache should be bypassed). This flag is only applicable to loadURI. XXX the meaning of this flag is poorly defined. XXX no one uses this, so we should probably deprecate and remove it.
PRUint32 nsIWebNavigation.LOAD_FLAGS_IS_REFRESH = 16
This flag specifies that the load should have the semantics of a link click. This flag is only applicable to loadURI. XXX the meaning of this flag is poorly defined.
PRUint32 nsIWebNavigation.LOAD_FLAGS_IS_LINK = 32
This flag specifies that history should not be updated. This flag is only applicable to loadURI.
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_HISTORY = 64
This flag specifies that any existing history entry should be replaced. This flag is only applicable to loadURI.
PRUint32 nsIWebNavigation.LOAD_FLAGS_REPLACE_HISTORY = 128
This flag specifies that the local web cache should be bypassed, but an intermediate proxy cache could still be used to satisfy the load.
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_CACHE = 256
This flag specifies that any intermediate proxy caches should be bypassed (i.e., that the content should be loaded from the origin server).
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_PROXY = 512
This flag specifies that a reload was triggered as a result of detecting an incorrect character encoding while parsing a previously loaded document.
PRUint32 nsIWebNavigation.LOAD_FLAGS_CHARSET_CHANGE = 1024
If this flag is set, Stop() will be called before the load starts and will stop both content and network activity (the default is to only stop network activity). Effectively, this passes the STOP_CONTENT flag to Stop(), in addition to the STOP_NETWORK flag.
PRUint32 nsIWebNavigation.LOAD_FLAGS_STOP_CONTENT = 2048
A hint this load was prompted by an external program: take care!
PRUint32 nsIWebNavigation.LOAD_FLAGS_FROM_EXTERNAL = 4096
This flag specifies that all network activity should be stopped. This includes both active network loads and pending META-refreshes.
PRUint32 nsIWebNavigation.STOP_NETWORK = 1
This flag specifies that all content activity should be stopped. This includes animated images, plugins and pending Javascript timeouts.
PRUint32 nsIWebNavigation.STOP_CONTENT = 2
This flag specifies that all activity should be stopped.
PRUint32 nsIWebNavigation.STOP_ALL = 3
State Transition Flags

These flags indicate the various states that requests may transition through as they are being loaded. These flags are mutually exclusive.

For any given request, onStateChange is called once with the STATE_START flag, zero or more times with the STATE_TRANSFERRING flag or once with the STATE_REDIRECTING flag, and then finally once with the STATE_STOP flag. NOTE: For document requests, a second STATE_STOP is generated (see the description of STATE_IS_WINDOW for more details).

STATE_START This flag indicates the start of a request. This flag is set when a request is initiated. The request is complete when onStateChange is called for the same request with the STATE_STOP flag set.

STATE_REDIRECTING This flag indicates that a request is being redirected. The request passed to onStateChange is the request that is being redirected. When a redirect occurs, a new request is generated automatically to process the new request. Expect a corresponding STATE_START event for the new request, and a STATE_STOP for the redirected request.

STATE_TRANSFERRING This flag indicates that data for a request is being transferred to an end consumer. This flag indicates that the request has been targeted, and that the user may start seeing content corresponding to the request.

STATE_NEGOTIATING This flag is not used.

STATE_STOP This flag indicates the completion of a request. The aStatus parameter to onStateChange indicates the final status of the request.

PRUint32 nsIWebProgressListener.STATE_START = 1
PRUint32 nsIWebProgressListener.STATE_REDIRECTING = 2
PRUint32 nsIWebProgressListener.STATE_TRANSFERRING = 4
PRUint32 nsIWebProgressListener.STATE_NEGOTIATING = 8
PRUint32 nsIWebProgressListener.STATE_STOP = 16
State Type Flags

These flags further describe the entity for which the state transition is occuring. These flags are NOT mutually exclusive (i.e., an onStateChange event may indicate some combination of these flags).

STATE_IS_REQUEST This flag indicates that the state transition is for a request, which includes but is not limited to document requests. (See below for a description of document requests.) Other types of requests, such as requests for inline content (e.g., images and stylesheets) are considered normal requests.

STATE_IS_DOCUMENT This flag indicates that the state transition is for a document request. This flag is set in addition to STATE_IS_REQUEST. A document request supports the nsIChannel interface and its loadFlags attribute includes the nsIChannel::LOAD_DOCUMENT_URI flag.

A document request does not complete until all requests associated with the loading of its corresponding document have completed. This includes other document requests (e.g., corresponding to HTML iframe elements). The document corresponding to a document request is available via the DOMWindow attribute of onStateChange's aWebProgress parameter.

STATE_IS_NETWORK This flag indicates that the state transition corresponds to the start or stop of activity in the indicated nsIWebProgress instance. This flag is accompanied by either STATE_START or STATE_STOP, and it may be combined with other State Type Flags.

Unlike STATE_IS_WINDOW, this flag is only set when activity within the nsIWebProgress instance being observed starts or stops. If activity only occurs in a child nsIWebProgress instance, then this flag will be set to indicate the start and stop of that activity.

For example, in the case of navigation within a single frame of a HTML frameset, a nsIWebProgressListener instance attached to the nsIWebProgress of the frameset window will receive onStateChange calls with the STATE_IS_NETWORK flag set to indicate the start and stop of said navigation. In other words, an observer of an outer window can determine when activity, that may be constrained to a child window or set of child windows, starts and stops.

STATE_IS_WINDOW This flag indicates that the state transition corresponds to the start or stop of activity in the indicated nsIWebProgress instance. This flag is accompanied by either STATE_START or STATE_STOP, and it may be combined with other State Type Flags.

This flag is similar to STATE_IS_DOCUMENT. However, when a document request completes, two onStateChange calls with STATE_STOP are generated. The document request is passed as aRequest to both calls. The first has STATE_IS_REQUEST and STATE_IS_DOCUMENT set, and the second has the STATE_IS_WINDOW flag set (and possibly the STATE_IS_NETWORK flag set as well -- see above for a description of when the STATE_IS_NETWORK flag may be set). This second STATE_STOP event may be useful as a way to partition the work that occurs when a document request completes.

PRUint32 nsIWebProgressListener.STATE_IS_REQUEST = 65536
PRUint32 nsIWebProgressListener.STATE_IS_DOCUMENT = 131072
PRUint32 nsIWebProgressListener.STATE_IS_NETWORK = 262144
PRUint32 nsIWebProgressListener.STATE_IS_WINDOW = 524288
State Modifier Flags

These flags further describe the transition which is occuring. These flags are NOT mutually exclusive (i.e., an onStateChange event may indicate some combination of these flags).

STATE_RESTORING This flag indicates that the state transition corresponds to the start or stop of activity for restoring a previously-rendered presentation. As such, there is no actual network activity associated with this request, and any modifications made to the document or presentation when it was originally loaded will still be present.

PRUint32 nsIWebProgressListener.STATE_RESTORING = 16777216
State Security Flags

These flags describe the security state reported by a call to the onSecurityChange method. These flags are mutually exclusive.

STATE_IS_INSECURE This flag indicates that the data corresponding to the request was received over an insecure channel.

STATE_IS_BROKEN This flag indicates an unknown security state. This may mean that the request is being loaded as part of a page in which some content was received over an insecure channel.

STATE_IS_SECURE This flag indicates that the data corresponding to the request was received over a secure channel. The degree of security is expressed by STATE_SECURE_HIGH, STATE_SECURE_MED, or STATE_SECURE_LOW.

PRUint32 nsIWebProgressListener.STATE_IS_INSECURE = 4
PRUint32 nsIWebProgressListener.STATE_IS_BROKEN = 1
PRUint32 nsIWebProgressListener.STATE_IS_SECURE = 2
Security Strength Flags

These flags describe the security strength and accompany STATE_IS_SECURE in a call to the onSecurityChange method. These flags are mutually exclusive.

These flags are not meant to provide a precise description of data transfer security. These are instead intended as a rough indicator that may be used to, for example, color code a security indicator or otherwise provide basic data transfer security feedback to the user.

STATE_SECURE_HIGH This flag indicates a high degree of security.

STATE_SECURE_MED This flag indicates a medium degree of security.

STATE_SECURE_LOW This flag indicates a low degree of security.

PRUint32 nsIWebProgressListener.STATE_SECURE_HIGH = 262144
PRUint32 nsIWebProgressListener.STATE_SECURE_MED = 65536
PRUint32 nsIWebProgressListener.STATE_SECURE_LOW = 131072


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 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

PRInt32 nsIDocShellTreeItem.childOffset

nsIWebBrowserChrome nsIWebBrowser.containerWindow

The chrome object associated with the browser instance. The embedder must create one chrome object for each browser object that is instantiated. The embedder must associate the two by setting this property to point to the chrome object before creating the browser window via the browser's nsIBaseWindow interface.

The chrome object must also implement nsIEmbeddingSiteWindow.

The chrome may optionally implement nsIInterfaceRequestor, nsIWebBrowserChromeFocus, nsIContextMenuListener and nsITooltipListener to receive additional notifications from the browser object.

The chrome object may optionally implement nsIWebProgressListener instead of explicitly calling addWebBrowserListener and removeWebBrowserListener to register a progress listener object. If the implementation does this, it must also implement nsIWeakReference.

readonly nsIDOMWindow nsIWebBrowser.contentDOMWindow

The top-level DOM window. The embedder may walk the entire DOM starting from this value.

readonly PRUint32 nsIWebBrowserPersist.currentState

Current state of the persister object.

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.

PRBool nsIBaseWindow.enabled

nsIDOMElement nsIWebBrowserFocus.focusedElement

The currently focused nsDOMElement when the browser is active, or the last focused nsDOMElement when the browser is inactive.

nsIDOMWindow nsIWebBrowserFocus.focusedWindow

The currently focused nsDOMWindow when the browser is active, or the last focused nsDOMWindow when the browser is inactive.

PRInt32 nsIDocShellTreeItem.itemType

readonly nsIWidget nsIBaseWindow.mainWidget

PRUnichar* nsIDocShellTreeItem.name

readonly nsIDocShellTreeItem nsIDocShellTreeItem.parent

nativeWindow nsIBaseWindow.parentNativeWindow

nsIURIContentListener nsIWebBrowser.parentURIContentListener

URI content listener parent. The embedder may set this property to their own implementation if they intend to override or prevent how certain kinds of content are loaded.

nsIWidget nsIBaseWindow.parentWidget

PRUint32 nsIWebBrowserPersist.persistFlags

Flags governing how data is fetched and saved from the network. It is best to set this value explicitly unless you are prepared to accept the default values.

nsIWebProgressListener nsIWebBrowserPersist.progressListener

Callback listener for progress notifications. The object that the embbedder supplies may also implement nsIInterfaceRequestor and be prepared to return nsIAuthPrompt or other interfaces that may be required to download data.

readonly nsIURI nsIWebNavigation.referringURI

The referring URI for the currently loaded URI or null.

readonly PRUint32 nsIWebBrowserPersist.result

Value indicating the success or failure of the persist operation.

readonly nsIDocShellTreeItem nsIDocShellTreeItem.rootTreeItem

readonly nsIDocShellTreeItem nsIDocShellTreeItem.sameTypeParent

readonly nsIDocShellTreeItem nsIDocShellTreeItem.sameTypeRootTreeItem

nsISHistory nsIWebNavigation.sessionHistory

The session history object used by this web navigation instance.

PRUnichar* nsIBaseWindow.title

readonly nsIDocShellTreeOwner nsIDocShellTreeItem.treeOwner

PRBool nsIBaseWindow.visibility


nsIWebBrowserFocus void activate ( )
nsIWebBrowser void addWebBrowserListener ( nsIWeakReference listener , nsIIDRef IID )
nsICancelable void cancel ( nsresult reason )
nsIWebBrowserPersist void cancelSave ( )
nsIBaseWindow void create ( )
nsIWebBrowserFocus void deactivate ( )
nsIBaseWindow void destroy ( )
nsIDocShellTreeItem nsIDocShellTreeItem findItemWithName ( PRUnichar* name , nsISupports requestor , nsIDocShellTreeItem originalRequestor )
nsIScrollable PRInt32 getCurScrollPos ( PRInt32 scrollOrientation )
nsIScrollable PRInt32 getDefaultScrollbarPreferences ( PRInt32 scrollOrientation )
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 )
nsIBaseWindow void getSize ( out PRInt32 cx , out PRInt32 cy )
nsISupportsWeakReference nsIWeakReference GetWeakReference ( )
nsIWebNavigation void goBack ( )
nsIWebNavigation void goForward ( )
nsIWebNavigation void gotoIndex ( PRInt32 index )
nsIBaseWindow [noscript] void initWindow ( nativeWindow parentNativeWindow , nsIWidget parentWidget , PRInt32 x , PRInt32 y , PRInt32 cx , PRInt32 cy )
nsIWebNavigation void loadURI ( PRUnichar* URI , PRUint32 loadFlags , nsIURI referrer , nsIInputStream postData , nsIInputStream headers )
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 )
nsIWebNavigation void reload ( PRUint32 reloadFlags )
nsIWebBrowser void removeWebBrowserListener ( nsIWeakReference listener , nsIIDRef IID )
nsIBaseWindow void repaint ( PRBool force )
nsIWebBrowserPersist void saveChannel ( nsIChannel channel , nsISupports file )
nsIWebBrowserPersist void saveDocument ( nsIDOMDocument document , nsISupports file , nsISupports dataPath , char* outputContentType , PRUint32 encodingFlags , PRUint32 wrapColumn )
nsIWebBrowserPersist void saveURI ( nsIURI URI , nsISupports cacheKey , nsIURI referrer , nsIInputStream postData , char* extraHeaders , nsISupports file )
nsITextScroll void scrollByLines ( PRInt32 numLines )
nsITextScroll void scrollByPages ( PRInt32 numPages )
nsIScrollable void setCurScrollPos ( PRInt32 scrollOrientation , PRInt32 curPos )
nsIScrollable void setCurScrollPosEx ( PRInt32 curHorizontalPos , PRInt32 curVerticalPos )
nsIScrollable void setDefaultScrollbarPreferences ( PRInt32 scrollOrientation , PRInt32 scrollbarPref )
nsIBaseWindow void setFocus ( )
nsIWebBrowserFocus void setFocusAtFirstElement ( )
nsIWebBrowserFocus void setFocusAtLastElement ( )
nsIBaseWindow void setPosition ( PRInt32 x , PRInt32 y )
nsIBaseWindow void setPositionAndSize ( PRInt32 x , PRInt32 y , PRInt32 cx , PRInt32 cy , PRBool fRepaint )
nsIWebBrowserSetup void setProperty ( PRUint32 id , PRUint32 value )
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 )
nsIWebNavigation void stop ( PRUint32 stopFlags )

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com