Public Member Functions | Public Attributes

imgIRequest Interface Reference

imgIRequest interface More...

import "imgIRequest.idl";

Inheritance diagram for imgIRequest:
Collaboration diagram for imgIRequest:

List of all members.

Public Member Functions

imgIRequest clone (in imgIDecoderObserver aObserver)
 Clone this request; the returned request will have aObserver as the observer.
void cancelAndForgetObserver (in nsresult aStatus)
 Cancels this request as in nsIRequest::Cancel(); further, also nulls out decoderObserver so it gets no further notifications from us.
void requestDecode ()
 Requests a decode for the image.
void lockImage ()
 Locks an image.
void unlockImage ()
 Unlocks an image.
imgIRequest getStaticRequest ()
 If this request is for an animated image, the method creates a new request which contains the current frame of the image.

Public Attributes

readonly attribute imgIContainer image
 the image container...
readonly attribute unsigned long imageStatus
 Status flags of the STATUS_* variety.
readonly attribute nsIURI URI
 The URI the image load was started with.
readonly attribute
imgIDecoderObserver 
decoderObserver
readonly attribute string mimeType
readonly attribute nsIPrincipal imagePrincipal
 The principal gotten from the channel the image was loaded from.
statusflags

Bits set in the return value from imageStatus

Meanings:

STATUS_NONE: Nothing to report.

STATUS_SIZE_AVAILABLE: We received enough image data from the network or filesystem that we know the width and height of the image, and have thus called SetSize() on the container.

STATUS_LOAD_PARTIAL: Used internally by imgRequest to flag that a request is being cancelled as a result of a failure of a proxy holder and not an internal failure. At least I think that's what it does. Regardless, there's no reason for this flag to be public, and it should either go away or become a private state flag within imgRequest. Don't rely on it.

STATUS_LOAD_COMPLETE: The data has been fully loaded to memory, but not necessarily fully decoded.

STATUS_ERROR: An error occured loading the image.

STATUS_FRAME_COMPLETE: The first frame has been completely decoded.

STATUS_DECODE_COMPLETE: The whole image has been decoded.

const long STATUS_NONE = 0x0
const long STATUS_SIZE_AVAILABLE = 0x1
const long STATUS_LOAD_PARTIAL = 0x2
const long STATUS_LOAD_COMPLETE = 0x4
const long STATUS_ERROR = 0x8
const long STATUS_FRAME_COMPLETE = 0x10
const long STATUS_DECODE_COMPLETE = 0x20

Detailed Description

imgIRequest interface

Author:
Stuart Parmenter <stuart@mozilla.com>
Version:
0.1
See also:
imagelib2

Member Function Documentation

void imgIRequest::cancelAndForgetObserver ( in nsresult  aStatus  ) 

Cancels this request as in nsIRequest::Cancel(); further, also nulls out decoderObserver so it gets no further notifications from us.

NOTE: You should not use this in any new code; instead, use cancel(). Note that cancel() is asynchronous, which means that some time after you call it, the listener/observer will get an OnStopRequest(). This means that, if you're the observer, you can't call cancel() from your destructor.

imgIRequest imgIRequest::clone ( in imgIDecoderObserver  aObserver  ) 

Clone this request; the returned request will have aObserver as the observer.

aObserver will be notified synchronously (before the clone() call returns) with all the notifications that have already been dispatched for this image load.

imgIRequest imgIRequest::getStaticRequest (  ) 

If this request is for an animated image, the method creates a new request which contains the current frame of the image.

Otherwise returns the same request.

void imgIRequest::lockImage (  ) 

Locks an image.

If the image does not exist yet, locks it once it becomes available. The lock persists for the lifetime of the imgIRequest (until unlockImage is called) even if the underlying image changes.

If you don't call unlockImage() by the time this imgIRequest goes away, it will be called for you automatically.

See also:
imgIContainer::lockImage for documentation of the underlying call.
void imgIRequest::requestDecode (  ) 

Requests a decode for the image.

imgIContainer has a requestDecode() method, but callers may want to request a decode before the container has necessarily been instantiated. Calling requestDecode() on the imgIRequest simply forwards along the request if the container already exists, or calls it once it gets OnStartContainer if the container does not yet exist.

void imgIRequest::unlockImage (  ) 

Unlocks an image.

See also:
imgIContainer::unlockImage for documentation of the underlying call.

Member Data Documentation

readonly attribute imgIContainer imgIRequest::image

the image container...

Returns:
the image object associated with the request.
Attention:
NEED DOCS

The principal gotten from the channel the image was loaded from.

readonly attribute unsigned long imgIRequest::imageStatus

Status flags of the STATUS_* variety.

readonly attribute string imgIRequest::mimeType
const long imgIRequest::STATUS_ERROR = 0x8
const long imgIRequest::STATUS_NONE = 0x0
readonly attribute nsIURI imgIRequest::URI

The URI the image load was started with.

Note that this might not be the actual URI for the image (e.g. if HTTP redirects happened during the load).


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