mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-30 05:35:31 +00:00
101 lines
4.0 KiB
Plaintext
101 lines
4.0 KiB
Plaintext
/* -*- Mode: C++; 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
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2000
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Stuart Parmenter <pavlov@netscape.com>
|
|
*
|
|
* 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 nsIURL;
|
|
|
|
[scriptable, uuid(C3C28D92-A17F-43DF-976D-4EEAE6F995FC)]
|
|
interface nsISound : nsISupports
|
|
{
|
|
void play(in nsIURL aURL);
|
|
/**
|
|
* for playing system sounds
|
|
*
|
|
* NS_SYSSOUND_* params are obsolete. The new events will not be supported by
|
|
* this method. You should use playEventSound method instaed.
|
|
*/
|
|
void playSystemSound(in AString soundAlias);
|
|
void beep();
|
|
|
|
/**
|
|
* Not strictly necessary, but avoids delay before first sound.
|
|
* The various methods on nsISound call Init() if they need to.
|
|
*/
|
|
void init();
|
|
|
|
/**
|
|
* In some situations, playEventSound will be called. Then, each
|
|
* implementations will play a system sound for the event if it's necessary.
|
|
*
|
|
* NOTE: Don't change these values because they are used in
|
|
* nsPIPromptService.idl. So, if they are changed, that makes big impact for
|
|
* the embedders.
|
|
*/
|
|
const unsigned long EVENT_NEW_MAIL_RECEIVED = 0;
|
|
const unsigned long EVENT_ALERT_DIALOG_OPEN = 1;
|
|
const unsigned long EVENT_CONFIRM_DIALOG_OPEN = 2;
|
|
const unsigned long EVENT_PROMPT_DIALOG_OPEN = 3;
|
|
const unsigned long EVENT_SELECT_DIALOG_OPEN = 4;
|
|
const unsigned long EVENT_MENU_EXECUTE = 5;
|
|
const unsigned long EVENT_MENU_POPUP = 6;
|
|
const unsigned long EVENT_EDITOR_MAX_LEN = 7;
|
|
void playEventSound(in unsigned long aEventId);
|
|
};
|
|
|
|
%{C++
|
|
|
|
/**
|
|
* NS_SYSSOUND_* can be used for playSystemSound but they are obsolete.
|
|
* Use nsISound::playEventSound instead.
|
|
*/
|
|
#define NS_SYSSOUND_PREFIX NS_LITERAL_STRING("_moz_")
|
|
#define NS_SYSSOUND_MAIL_BEEP NS_LITERAL_STRING("_moz_mailbeep")
|
|
#define NS_SYSSOUND_ALERT_DIALOG NS_LITERAL_STRING("_moz_alertdialog")
|
|
#define NS_SYSSOUND_CONFIRM_DIALOG NS_LITERAL_STRING("_moz_confirmdialog")
|
|
#define NS_SYSSOUND_PROMPT_DIALOG NS_LITERAL_STRING("_moz_promptdialog")
|
|
#define NS_SYSSOUND_SELECT_DIALOG NS_LITERAL_STRING("_moz_selectdialog")
|
|
#define NS_SYSSOUND_MENU_EXECUTE NS_LITERAL_STRING("_moz_menucommand")
|
|
#define NS_SYSSOUND_MENU_POPUP NS_LITERAL_STRING("_moz_menupopup")
|
|
|
|
#define NS_IsMozAliasSound(aSoundAlias) \
|
|
StringBeginsWith(aSoundAlias, NS_SYSSOUND_PREFIX)
|
|
|
|
%}
|