Back to index

lightning-sunbird  0.9+nobinonly
nsIPrintProgress.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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  *   Jean-Francois Ducarroz <ducarroz@netscape.com>
00024  *   Rod Spears <rods@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or 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 #include "nsISupports.idl"
00040 #include "nsIWebProgressListener.idl"
00041 
00042 interface nsIDOMWindowInternal;
00043 interface nsIObserver;
00044 interface nsIPrompt;
00045 
00046 [scriptable, uuid(7E46BC35-FB7D-4b45-AB35-82FD61015380)]
00047 interface nsIPrintProgress: nsIWebProgressListener {
00048 
00049   /* Open the progress dialog
00050      you can specify parameters through an xpcom object
00051   */
00052   void openProgressDialog(in nsIDOMWindowInternal parent, 
00053                           in string dialogURL, 
00054                           in nsISupports parameters, 
00055                           in nsIObserver openDialogObserver,
00056                           out boolean notifyOnOpen);
00057   
00058   /* Close the progress dialog */
00059   void closeProgressDialog(in boolean forceClose);
00060   
00061   /* Register a Web Progress Listener */
00062   void registerListener(in nsIWebProgressListener listener);
00063 
00064   /* Unregister a Web Progress Listener */
00065   void unregisterListener(in nsIWebProgressListener listener);
00066   
00067   /* This method is called after the dialog that shows the progress has been shown 
00068   */
00069   void doneIniting();
00070   
00071   /* Retrive the prompter, needed to display modal dialog on top of progress dialog */
00072   nsIPrompt getPrompter();
00073 
00074   /* Indicated if the user asked to cancel the current process */
00075   attribute boolean processCanceledByUser;
00076 };
00077 
00078