/gecko_api/include/nsEmbedCID.h

  1/* ***** BEGIN LICENSE BLOCK *****
  2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3 *
  4 * The contents of this file are subject to the Mozilla Public License Version
  5 * 1.1 (the "License"); you may not use this file except in compliance with
  6 * the License. You may obtain a copy of the License at
  7 * http://www.mozilla.org/MPL/
  8 *
  9 * Software distributed under the License is distributed on an "AS IS" basis,
 10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11 * for the specific language governing rights and limitations under the
 12 * License.
 13 *
 14 * The Original Code is Mozilla.org code.
 15 *
 16 * The Initial Developer of the Original Code is
 17 * Boris Zbarsky <bzbarsky@mit.edu>.
 18 * Portions created by the Initial Developer are Copyright (C) 2005
 19 * the Initial Developer. All Rights Reserved.
 20 *
 21 * Contributor(s):
 22 *
 23 * Alternatively, the contents of this file may be used under the terms of
 24 * either the GNU General Public License Version 2 or later (the "GPL"), or
 25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 26 * in which case the provisions of the GPL or the LGPL are applicable instead
 27 * of those above. If you wish to allow use of your version of this file only
 28 * under the terms of either the GPL or the LGPL, and not to allow others to
 29 * use your version of this file under the terms of the MPL, indicate your
 30 * decision by deleting the provisions above and replace them with the notice
 31 * and other provisions required by the GPL or the LGPL. If you do not delete
 32 * the provisions above, a recipient may use your version of this file under
 33 * the terms of any one of the MPL, the GPL or the LGPL.
 34 *
 35 * ***** END LICENSE BLOCK ***** */
 36
 37#ifndef NSEMBEDCID_H
 38#define NSEMBEDCID_H
 39
 40/**
 41 * @file
 42 * @brief List of, and documentation for, frozen Gecko embedding contracts.
 43 */
 44
 45/**
 46 * Web Browser ContractID
 47 *   Creating an instance of this ContractID (via createInstanceByContractID)
 48 *   is the basic way to instantiate a Gecko browser.
 49 *
 50 * This contract implements the following interfaces:
 51 * nsIWebBrowser
 52 * nsIWebBrowserSetup
 53 * nsIInterfaceRequestor
 54 *
 55 * @note This contract does not guarantee implementation of any other
 56 * interfaces and does not guarantee ability to get any particular
 57 * interfaces via the nsIInterfaceRequestor implementation.
 58 */
 59#define NS_WEBBROWSER_CONTRACTID \
 60  "@mozilla.org/embedding/browser/nsWebBrowser;1"
 61
 62/**
 63 * Prompt Service ContractID
 64 *   The prompt service (which can be gotten by calling getServiceByContractID
 65 *   on this ContractID) is the way to pose various prompts, alerts,
 66 *   and confirmation dialogs to the user.
 67 * 
 68 * This contract implements the following interfaces:
 69 * nsIPromptService
 70 * nsIPromptService2 (optional)
 71 *
 72 * Embedders may override this ContractID with their own implementation if they
 73 * want more control over the way prompts, alerts, and confirmation dialogs are
 74 * presented to the user.
 75 */
 76#define NS_PROMPTSERVICE_CONTRACTID \
 77 "@mozilla.org/embedcomp/prompt-service;1"
 78
 79/**
 80 * Non Blocking Alert Service ContractID
 81 *   This service is for posing non blocking alerts to the user.
 82 *
 83 * This contract implements the following interfaces:
 84 * nsINonBlockingAlertService
 85 *
 86 * Embedders may override this ContractID with their own implementation.
 87 */
 88#define NS_NONBLOCKINGALERTSERVICE_CONTRACTID \
 89 "@mozilla.org/embedcomp/nbalert-service;1"
 90
 91/**
 92 * This contract ID should be implemented by password managers to be able to
 93 * override the standard implementation of nsIAuthPrompt2. It will be used as
 94 * a service.
 95 *
 96 * This contract implements the following interfaces:
 97 * nsIPromptFactory
 98 */
 99#define NS_PWMGR_AUTHPROMPTFACTORY \
100 "@mozilla.org/passwordmanager/authpromptfactory;1"
101
102#endif // NSEMBEDCID_H