1 /** -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 *
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is mozilla.org code.
17 *
18 * The Initial Developer of the Original Code is
19 * Netscape Communications Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 2001
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 * Stuart Parmenter <pavlov@netscape.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40 #include "imgIContainerObserver.idl"
41
42 interface imgIRequest;
43 interface imgIContainer;
44 interface gfxIImageFrame;
45
46 %{C++
47 #include "nsRect.h"
48 %}
49
50 /**
51 * imgIDecoderObserver interface
52 *
53 * This interface is used both for observing imgIDecoder objects and for
54 * observing imgIRequest objects. In the former case, aRequest is
55 * always null.
56 * XXXldb The two functions should probably be split.
57 *
58 * @author Stuart Parmenter <pavlov@netscape.com>
59 * @version 0.1
60 * @see imagelib2
61 */
62 [scriptable, uuid(876f14ee-f27c-41cd-b6fb-9efda3ebc7b5)]
63 interface imgIDecoderObserver : imgIContainerObserver
64 {
65 /**
66 * called at the same time that nsIRequestObserver::onStartRequest would be
67 * (used only for observers of imgIRequest objects, which are nsIRequests,
68 * not imgIDecoder objects)
69 *
70 * Unlike nsIRequestObserver::onStartRequest, this can be called
71 * synchronously.
72 */
73 void onStartRequest(in imgIRequest aRequest);
74
75 /**
76 * called as soon as the image begins getting decoded
77 */
78 void onStartDecode(in imgIRequest aRequest);
79
80 /**
81 * called once the image has been inited and therefore has a width and height
82 */
83 void onStartContainer(in imgIRequest aRequest, in imgIContainer aContainer);
84
85 /**
86 * called when each frame is created
87 */
88 void onStartFrame(in imgIRequest aRequest, in gfxIImageFrame aFrame);
89
90 /**
91 * called when some part of the frame has new data in it
92 */
93 [noscript] void onDataAvailable(in imgIRequest aRequest, in gfxIImageFrame aFrame, [const] in nsIntRect aRect);
94
95 /**
96 * called when a frame is finished decoding
97 */
98 void onStopFrame(in imgIRequest aRequest, in gfxIImageFrame aFrame);
99
100 /**
101 * probably not needed. called right before onStopDecode
102 */
103 void onStopContainer(in imgIRequest aRequest, in imgIContainer aContainer);
104
105 /**
106 * called when the decoder is dying off
107 */
108 void onStopDecode(in imgIRequest aRequest, in nsresult status,
109 in wstring statusArg);
110
111 /**
112 * called at the same time that nsIRequestObserver::onStopRequest would be
113 * (used only for observers of imgIRequest objects, which are nsIRequests,
114 * not imgIDecoder objects)
115 *
116 * Unlike nsIRequestObserver::onStartRequest, this can be called
117 * synchronously.
118 */
119 void onStopRequest(in imgIRequest aRequest, in boolean aIsLastPart);
120
121 };