WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsILoadGroup

IID:3de0a31c-feaf-400f-9f1e-4ef71f8b20cc
Inherits From:nsIRequest

This interface is implemented by the following components:

Properties

readonly PRUint32 activeCount

Returns the count of "active" requests (ie. requests without the LOAD_BACKGROUND bit set).

nsIRequest defaultLoadRequest

Accesses the default load request for the group. Each time a number of requests are added to a group, the defaultLoadRequest may be set to indicate that all of the requests are related to a base request.

The load group inherits its load flags from the default load request. If the default load request is NULL, then the group's load flags are not changed.

nsIRequestObserver groupObserver

The group observer is notified when requests are added to and removed from this load group. The groupObserver is weak referenced.

nsIInterfaceRequestor notificationCallbacks

Notification callbacks for the load group.

readonly nsISimpleEnumerator requests

Returns the requests contained directly in this group. Enumerator element type: nsIRequest.

Methods

void addRequest ( nsIRequest request , nsISupports context ) void removeRequest ( nsIRequest request , nsISupports context , nsresult status )

void addRequest ( nsIRequest request , nsISupports context )

Adds a new request to the group. This will cause the default load flags to be applied to the request. If this is a foreground request then the groupObserver's onStartRequest will be called.

If the request is the default load request or if the default load request is null, then the load group will inherit its load flags from the request.

Arguments:
request
context

void removeRequest ( nsIRequest request , nsISupports context , nsresult status )

Removes a request from the group. If this is a foreground request then the groupObserver's onStopRequest will be called.

By the time this call ends, request will have been removed from the loadgroup, even if this function throws an exception.

Arguments:
request
context
status

References

This interface is the type of the following properties:

nsIDocumentLoader.loadGroup, nsIMsgMailNewsUrl.loadGroup, nsIRequest.loadGroup

This interface is passed as an argument to the following methods:

imgILoader.loadImage, nsIDocumentLoaderFactory.createBlankDocument, nsIDocumentLoaderFactory.createInstance

Reference documentation is generated from Mozilla's source.