Public Member Functions

imgILoader Interface Reference

imgILoader interface More...

import "imgILoader.idl";

List of all members.

Public Member Functions

imgIRequest loadImage (in nsIURI aURI, in nsIURI aInitialDocumentURL, in nsIURI aReferrerURI, in nsILoadGroup aLoadGroup, in imgIDecoderObserver aObserver, in nsISupports aCX, in nsLoadFlags aLoadFlags, in nsISupports cacheKey, in imgIRequest aRequest)
 Start the load and decode of an image.
imgIRequest loadImageWithChannel (in nsIChannel aChannel, in imgIDecoderObserver aObserver, in nsISupports cx, out nsIStreamListener aListener)
 Start the load and decode of an image.
boolean supportImageWithMimeType (in string mimeType)
 Checks if a decoder for the an image with the given mime type is available.

Detailed Description

imgILoader interface

Author:
Stuart Parmenter <pavlov@netscape.com>
Version:
0.3
See also:
imagelib2

Member Function Documentation

imgIRequest imgILoader::loadImage ( in nsIURI  aURI,
in nsIURI  aInitialDocumentURL,
in nsIURI  aReferrerURI,
in nsILoadGroup  aLoadGroup,
in imgIDecoderObserver  aObserver,
in nsISupports  aCX,
in nsLoadFlags  aLoadFlags,
in nsISupports  cacheKey,
in imgIRequest  aRequest 
)

Start the load and decode of an image.

Parameters:
aURI the URI to load
aInitialDocumentURI the URI that 'initiated' the load -- used for 3rd party cookie blocking
aReferrerURI the 'referring' URI
aLoadGroup Loadgroup to put the image load into
aObserver the observer (may be null)
aCX some random data
aLoadFlags Load flags for the request
aCacheKey cache key to use for a load if the original image came from a request that had post data
aRequest A newly created, unused imgIRequest object or NULL for one to be created for you.

libpr0n does NOT keep a strong ref to the observer; this prevents reference cycles. This means that callers of loadImage should make sure to Cancel() the resulting request before the observer goes away.

imgIRequest imgILoader::loadImageWithChannel ( in nsIChannel  aChannel,
in imgIDecoderObserver  aObserver,
in nsISupports  cx,
out nsIStreamListener  aListener 
)

Start the load and decode of an image.

Parameters:
aChannel the channel to load the image from. This must already be opened before ths method is called, and there must have been no OnDataAvailable calls for it yet.
aObserver the observer (may be null)
cx some random data
aListener [out] A listener that should receive the data. Can be null, in which case imagelib has found a cached image and is not interested in the data. The caller needs not cancel the channel in this case.

libpr0n does NOT keep a strong ref to the observer; this prevents reference cycles. This means that callers of loadImageWithChannel should make sure to Cancel() the resulting request before the observer goes away.

boolean imgILoader::supportImageWithMimeType ( in string  mimeType  ) 

Checks if a decoder for the an image with the given mime type is available.

Parameters:
mimeType The type to find a decoder for
Returns:
true if a decoder is available, false otherwise

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