Back to index

lightning-sunbird  0.9+nobinonly
nsIDownloadProgressListener.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Blake Ross <blaker@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 /* A minimally extended progress listener used by download manager
00040  * to update its default UI.  This is implemented in nsDownloadProgressListener.js.
00041  * See nsIWebProgressListener for documentation, and use its constants.  This isn't
00042  * too pretty, but the alternative is having this extend nsIWebProgressListener and
00043  * adding an |item| attribute, which would mean a separate nsIDownloadProgressListener
00044  * for every nsIDownloadItem, which is a waste...
00045  */
00046 
00047 #include "nsISupports.idl"
00048 
00049 interface nsIWebProgress;
00050 interface nsIRequest;
00051 interface nsIURI;
00052 interface nsIDownload;
00053 interface nsIDOMDocument;
00054 
00055 [scriptable, uuid(c7e22278-53a7-49d9-999f-0e7861738b50)]
00056 interface nsIDownloadProgressListener : nsISupports {
00057 
00063   attribute nsIDOMDocument document;
00064 
00065   void onStateChange(in nsIWebProgress aWebProgress,
00066                      in nsIRequest aRequest,
00067                      in unsigned long aStateFlags,
00068                      in nsresult aStatus,
00069                      in nsIDownload aDownload);
00070 
00071   void onProgressChange(in nsIWebProgress aWebProgress,
00072                         in nsIRequest aRequest,
00073                         in long long aCurSelfProgress,
00074                         in long long aMaxSelfProgress,
00075                         in long long aCurTotalProgress,
00076                         in long long aMaxTotalProgress,
00077                         in nsIDownload aDownload);
00078 
00079   void onStatusChange(in nsIWebProgress aWebProgress,
00080                       in nsIRequest aRequest,
00081                       in nsresult aStatus,
00082                       in wstring aMessage,
00083                       in nsIDownload aDownload);
00084 
00085   void onLocationChange(in nsIWebProgress aWebProgress,
00086                         in nsIRequest aRequest,
00087                         in nsIURI aLocation,
00088                         in nsIDownload aDownload);
00089 
00090   void onSecurityChange(in nsIWebProgress aWebProgress,
00091                         in nsIRequest aRequest,
00092                         in unsigned long aState,
00093                         in nsIDownload aDownload);
00094 
00095 };