Back to index

lightning-sunbird  0.9+nobinonly
nsIProgressDialog.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Bill Law    law@netscape.com
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsIDownload.idl"
00041 
00042 interface nsIDOMWindow;
00043 interface nsIObserver;
00044 
00045 /* nsIProgressDialog
00046  *
00047  * These objects are used to display progress notifications to the user.
00048  * They are displayed while files are being saved to disk, for example.
00049  * 
00050  * Typical usage is to:
00051  *   1. Create an instance, via the component manager CreateInstance()
00052  *      method.
00053  *   2. Set appropriate attributes that control the display and behavior
00054  *      of the dialog.
00055  *   3. Open the dialog.
00056  *   4. Send progress notifications to the dialog, via it's 
00057  *      nsIWebProgressListener methods.
00058  *   5. Close the dialog when the operation completes, or when the user
00059  *      closes it manually.
00060  *   6. Release the instance.  The instance will be referenced by
00061  *      the dialog itself, so it won't get freed until the dialog closes.
00062  *      The dialog will keep the instance alive, so typically one does
00063  *      not need to hold a reference to it.
00064  */
00065 
00066 [scriptable, uuid(20e790a2-76c6-462d-851a-22ab6cbbe48b)]
00067 interface nsIProgressDialog : nsIDownload {
00074    void open( in nsIDOMWindow aParent );
00075    
00082    attribute PRBool cancelDownloadOnClose;
00083 
00091    attribute nsIObserver observer;
00092 
00097    attribute nsIDOMWindow dialog;
00098 };
00099 
00100