embedding/components/windowwatcher/public/nsINonBlockingAlertService.idl

   1 /* -*- Mode: IDL; tab-width: 2; 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  * YAMASHITA Makoto <makotoy@ms.u-tokyo.ac.jp>.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 interface nsIDOMWindow;
  40
  41 /**
  42  * This is the interface to the embeddable non-blocking alert
  43  * service.  A non-blocking alert is a less serious informative alert
  44  * that does not need to block the program's execution to get the
  45  * user's response.
  46  *
  47  * The way to present the alert is left to the implementations.  It
  48  * may be a dialog separate from the parent window, or a window-modal
  49  * sheet (as the ones in Mac OS X) attached to the parent.
  50  */
  51 [scriptable, uuid(E800EF97-AE37-46B7-A46C-31FBE79657EA)]
  52 interface nsINonBlockingAlertService : nsISupports {
  53   /**
  54    * This shows a non-blocking alert with the specified title and
  55    * message text. This function requires a valid parent window with
  56    * which the alert is associated.
  57    *
  58    * @param aParent
  59    *        The parent window. This must not be null.
  60    * @param aDialogTitle
  61    *        Text to appear in the title of the alert.
  62    * @param aText
  63    *        Text to appear in the body of the alert.
  64    */
  65   void showNonBlockingAlert(in nsIDOMWindow aParent,
  66                             in wstring aDialogTitle, in wstring aText);
  67 };