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.

imgIDecoderObserver

IID:876f14ee-f27c-41cd-b6fb-9efda3ebc7b5
Inherits From:imgIContainerObserver

ImgIDecoderObserver interface

This interface is used both for observing imgIDecoder objects and for observing imgIRequest objects. In the former case, aRequest is always null. XXXldb The two functions should probably be split.


Methods

[noscript] void onDataAvailable ( imgIRequest request , gfxIImageFrame frame , nsIntRect rect ) void onStartContainer ( imgIRequest request , imgIContainer container ) void onStartDecode ( imgIRequest request ) void onStartFrame ( imgIRequest request , gfxIImageFrame frame ) void onStartRequest ( imgIRequest request ) void onStopContainer ( imgIRequest request , imgIContainer container ) void onStopDecode ( imgIRequest request , nsresult status , PRUnichar* statusArg ) void onStopFrame ( imgIRequest request , gfxIImageFrame frame ) void onStopRequest ( imgIRequest request , PRBool isLastPart )

void onDataAvailable ( imgIRequest request , gfxIImageFrame frame , nsIntRect rect )

Called when some part of the frame has new data in it

Arguments:
request
frame
rect

void onStartContainer ( imgIRequest request , imgIContainer container )

Called once the image has been inited and therefore has a width and height

Arguments:
request
container

void onStartDecode ( imgIRequest request )

Called as soon as the image begins getting decoded

Arguments:
request

void onStartFrame ( imgIRequest request , gfxIImageFrame frame )

Called when each frame is created

Arguments:
request
frame

void onStartRequest ( imgIRequest request )

Called at the same time that nsIRequestObserver::onStartRequest would be (used only for observers of imgIRequest objects, which are nsIRequests, not imgIDecoder objects)

Unlike nsIRequestObserver::onStartRequest, this can be called synchronously.

Arguments:
request

void onStopContainer ( imgIRequest request , imgIContainer container )

Probably not needed. called right before onStopDecode

Arguments:
request
container

void onStopDecode ( imgIRequest request , nsresult status , PRUnichar* statusArg )

Called when the decoder is dying off

Arguments:
request
status
statusArg

void onStopFrame ( imgIRequest request , gfxIImageFrame frame )

Called when a frame is finished decoding

Arguments:
request
frame

void onStopRequest ( imgIRequest request , PRBool isLastPart )

Called at the same time that nsIRequestObserver::onStopRequest would be (used only for observers of imgIRequest objects, which are nsIRequests, not imgIDecoder objects)

Unlike nsIRequestObserver::onStartRequest, this can be called synchronously.

Arguments:
request
isLastPart

References

This interface is the type of the following properties:

imgIRequest.decoderObserver

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

imgILoader.loadImage, imgILoader.loadImageWithChannel, imgIRequest.clone, nsIImageLoadingContent.addObserver, nsIImageLoadingContent.removeObserver

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com