1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Blake Ross <blaker@netscape.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 /* A minimally extended progress listener used by download manager
40 * to update its default UI. This is implemented in nsDownloadProgressListener.js.
41 * See nsIWebProgressListener for documentation, and use its constants. This isn't
42 * too pretty, but the alternative is having this extend nsIWebProgressListener and
43 * adding an |item| attribute, which would mean a separate nsIDownloadProgressListener
44 * for every nsIDownloadItem, which is a waste...
45 */
46
47 #include "nsISupports.idl"
48
49 interface nsIWebProgress;
50 interface nsIRequest;
51 interface nsIURI;
52 interface nsIDownload;
53 interface nsIDOMDocument;
54
55 [scriptable, uuid(7acb07ea-cac2-4c15-a3ad-23aaa789ed51)]
56 interface nsIDownloadProgressListener : nsISupports {
57
58 /**
59 * document
60 * The document of the download manager frontend.
61 */
62
63 attribute nsIDOMDocument document;
64
65 /**
66 * Dispatched whenever the state of the download changes.
67 *
68 * @param aState The previous download sate.
69 * @param aDownload The download object.
70 * @see nsIDownloadManager for download states.
71 */
72 void onDownloadStateChange(in short aState, in nsIDownload aDownload);
73
74 void onStateChange(in nsIWebProgress aWebProgress,
75 in nsIRequest aRequest,
76 in unsigned long aStateFlags,
77 in nsresult aStatus,
78 in nsIDownload aDownload);
79
80 void onProgressChange(in nsIWebProgress aWebProgress,
81 in nsIRequest aRequest,
82 in long long aCurSelfProgress,
83 in long long aMaxSelfProgress,
84 in long long aCurTotalProgress,
85 in long long aMaxTotalProgress,
86 in nsIDownload aDownload);
87
88 void onSecurityChange(in nsIWebProgress aWebProgress,
89 in nsIRequest aRequest,
90 in unsigned long aState,
91 in nsIDownload aDownload);
92
93 };