layout/printing/nsIPrintProgress.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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  *   Jean-Francois Ducarroz <ducarroz@netscape.com>
  24  *   Rod Spears <rods@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or 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 #include "nsISupports.idl"
  40 #include "nsIWebProgressListener.idl"
  41
  42 interface nsIDOMWindowInternal;
  43 interface nsIObserver;
  44 interface nsIPrompt;
  45
  46 [scriptable, uuid(7E46BC35-FB7D-4b45-AB35-82FD61015380)]
  47 interface nsIPrintProgress: nsIWebProgressListener {
  48
  49   /* Open the progress dialog
  50      you can specify parameters through an xpcom object
  51   */
  52   void openProgressDialog(in nsIDOMWindowInternal parent,
  53                           in string dialogURL,
  54                           in nsISupports parameters,
  55                           in nsIObserver openDialogObserver,
  56                           out boolean notifyOnOpen);
  57
  58   /* Close the progress dialog */
  59   void closeProgressDialog(in boolean forceClose);
  60
  61   /* Register a Web Progress Listener */
  62   void registerListener(in nsIWebProgressListener listener);
  63
  64   /* Unregister a Web Progress Listener */
  65   void unregisterListener(in nsIWebProgressListener listener);
  66
  67   /* This method is called after the dialog that shows the progress has been shown
  68   */
  69   void doneIniting();
  70
  71   /* Retrieve the prompter, needed to display modal dialog on top of progress dialog */
  72   nsIPrompt getPrompter();
  73
  74   /* Indicated if the user asked to cancel the current process */
  75   attribute boolean processCanceledByUser;
  76 };
  77
  78