Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIWebProgress Interface Reference

The nsIWebProgress interface is used to add or remove nsIWebProgressListener instances to observe the loading of asynchronous requests (usually in the context of a DOM window). More...

import "nsIWebProgress.idl";

Inheritance diagram for nsIWebProgress:
Inheritance graph
[legend]
Collaboration diagram for nsIWebProgress:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void addProgressListener (in nsIWebProgressListener aListener, in unsigned long aNotifyMask)
 Registers a listener to receive web progress events.
void removeProgressListener (in nsIWebProgressListener aListener)
 Removes a previously registered listener of progress events.

Public Attributes

const unsigned long NOTIFY_STATE_REQUEST = 0x00000001
 The following flags may be combined to form the aNotifyMask parameter for the addProgressListener method.
const unsigned long NOTIFY_STATE_DOCUMENT = 0x00000002
const unsigned long NOTIFY_STATE_NETWORK = 0x00000004
const unsigned long NOTIFY_STATE_WINDOW = 0x00000008
const unsigned long NOTIFY_STATE_ALL = 0x0000000f
const unsigned long NOTIFY_PROGRESS = 0x00000010
 These flags indicate the other events to observe, corresponding to the other four methods defined on nsIWebProgressListener.
const unsigned long NOTIFY_STATUS = 0x00000020
const unsigned long NOTIFY_SECURITY = 0x00000040
const unsigned long NOTIFY_LOCATION = 0x00000080
const unsigned long NOTIFY_ALL = 0x000000ff
 This flag enables all notifications.
readonly attribute nsIDOMWindow DOMWindow
 The DOM window associated with this nsIWebProgress instance.
readonly attribute PRBool isLoadingDocument
 Indicates whether or not a document is currently being loaded in the context of this nsIWebProgress instance.

Detailed Description

The nsIWebProgress interface is used to add or remove nsIWebProgressListener instances to observe the loading of asynchronous requests (usually in the context of a DOM window).

nsIWebProgress instances may be arranged in a parent-child configuration, corresponding to the parent-child configuration of their respective DOM windows. However, in some cases a nsIWebProgress instance may not have an associated DOM window. The parent-child relationship of nsIWebProgress instances is not made explicit by this interface, but the relationship may exist in some implementations.

A nsIWebProgressListener instance receives notifications for the nsIWebProgress instance to which it added itself, and it may also receive notifications from any nsIWebProgress instances that are children of that nsIWebProgress instance.

FROZEN

Definition at line 66 of file nsIWebProgress.idl.


Member Function Documentation

void nsIWebProgress::addProgressListener ( in nsIWebProgressListener  aListener,
in unsigned long  aNotifyMask 
)

Registers a listener to receive web progress events.

Parameters:
aListenerThe listener interface to be called when a progress event occurs. This object must also implement nsISupportsWeakReference.
aNotifyMaskThe types of notifications to receive.
Exceptions:
NS_ERROR_INVALID_ARGIndicates that aListener was either null or that it does not support weak references.
NS_ERROR_FAILUREIndicates that aListener was already registered.

Removes a previously registered listener of progress events.

Parameters:
aListenerThe listener interface previously registered with a call to addProgressListener.
Exceptions:
NS_ERROR_FAILUREIndicates that aListener was not registered.

Member Data Documentation

The DOM window associated with this nsIWebProgress instance.

Exceptions:
NS_ERROR_FAILUREIndicates that there is no associated DOM window.

Definition at line 165 of file nsIWebProgress.idl.

Indicates whether or not a document is currently being loaded in the context of this nsIWebProgress instance.

Definition at line 171 of file nsIWebProgress.idl.

const unsigned long nsIWebProgress::NOTIFY_ALL = 0x000000ff

This flag enables all notifications.

Definition at line 127 of file nsIWebProgress.idl.

Definition at line 122 of file nsIWebProgress.idl.

These flags indicate the other events to observe, corresponding to the other four methods defined on nsIWebProgressListener.

NOTIFY_PROGRESS Receive onProgressChange events.

NOTIFY_STATUS Receive onStatusChange events.

NOTIFY_SECURITY Receive onSecurityChange events.

NOTIFY_LOCATION Receive onLocationChange events.

Definition at line 119 of file nsIWebProgress.idl.

Definition at line 121 of file nsIWebProgress.idl.

Definition at line 101 of file nsIWebProgress.idl.

Definition at line 98 of file nsIWebProgress.idl.

Definition at line 99 of file nsIWebProgress.idl.

The following flags may be combined to form the aNotifyMask parameter for the addProgressListener method.

They limit the set of events that are delivered to an nsIWebProgressListener instance. These flags indicate the state transistions to observe, corresponding to nsIWebProgressListener::onStateChange.

NOTIFY_STATE_REQUEST Only receive the onStateChange event if the aStateFlags parameter includes nsIWebProgressListener::STATE_IS_REQUEST.

NOTIFY_STATE_DOCUMENT Only receive the onStateChange event if the aStateFlags parameter includes nsIWebProgressListener::STATE_IS_DOCUMENT.

NOTIFY_STATE_NETWORK Only receive the onStateChange event if the aStateFlags parameter includes nsIWebProgressListener::STATE_IS_NETWORK.

NOTIFY_STATE_WINDOW Only receive the onStateChange event if the aStateFlags parameter includes nsIWebProgressListener::STATE_IS_WINDOW.

NOTIFY_STATE_ALL Receive all onStateChange events.

Definition at line 97 of file nsIWebProgress.idl.

Definition at line 100 of file nsIWebProgress.idl.

const unsigned long nsIWebProgress::NOTIFY_STATUS = 0x00000020

Definition at line 120 of file nsIWebProgress.idl.


The documentation for this interface was generated from the following file: