gecko/embedding/components/windowwatcher/public/nsINonBlockingAlertService.idl

68 lines
2.8 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* YAMASHITA Makoto <makotoy@ms.u-tokyo.ac.jp>.
* Portions created by the Initial Developer are Copyright (C) 2006
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIDOMWindow;
/**
* This is the interface to the embeddable non-blocking alert
* service. A non-blocking alert is a less serious informative alert
* that does not need to block the program's execution to get the
* user's response.
*
* The way to present the alert is left to the implementations. It
* may be a dialog separate from the parent window, or a window-modal
* sheet (as the ones in Mac OS X) attached to the parent.
*/
[scriptable, uuid(E800EF97-AE37-46B7-A46C-31FBE79657EA)]
interface nsINonBlockingAlertService : nsISupports {
/**
* This shows a non-blocking alert with the specified title and
* message text. This function requires a valid parent window with
* which the alert is associated.
*
* @param aParent
* The parent window. This must not be null.
* @param aDialogTitle
* Text to appear in the title of the alert.
* @param aText
* Text to appear in the body of the alert.
*/
void showNonBlockingAlert(in nsIDOMWindow aParent,
in wstring aDialogTitle, in wstring aText);
};