embedding/nsEmbedCID.h
author Gregory Szorc <gps@mozilla.com>
Fri, 03 Jun 2016 21:20:59 +0000
branchMOBILE440b9_2016011419_RELBRANCH
changeset 324664 b211cae3fc82de2cdc9a429a04b6c0af23c32968
parent 222303 0edaea0894c3fabb49a020f5c5f45ab0d1d213f7
permissions -rw-r--r--
Bug 1249802 - Close old branch MOBILE440b9_2016011419_RELBRANCH

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef NSEMBEDCID_H
#define NSEMBEDCID_H

/**
 * @file
 * @brief List of, and documentation for, frozen Gecko embedding contracts.
 */

/**
 * Web Browser ContractID
 *   Creating an instance of this ContractID (via createInstanceByContractID)
 *   is the basic way to instantiate a Gecko browser.
 *
 * This contract implements the following interfaces:
 * nsIWebBrowser
 * nsIWebBrowserSetup
 * nsIInterfaceRequestor
 *
 * @note This contract does not guarantee implementation of any other
 * interfaces and does not guarantee ability to get any particular
 * interfaces via the nsIInterfaceRequestor implementation.
 */
#define NS_WEBBROWSER_CONTRACTID \
  "@mozilla.org/embedding/browser/nsWebBrowser;1"

/**
 * Prompt Service ContractID
 *   The prompt service (which can be gotten by calling getServiceByContractID
 *   on this ContractID) is the way to pose various prompts, alerts,
 *   and confirmation dialogs to the user.
 * 
 * This contract implements the following interfaces:
 * nsIPromptService
 * nsIPromptService2 (optional)
 *
 * Embedders may override this ContractID with their own implementation if they
 * want more control over the way prompts, alerts, and confirmation dialogs are
 * presented to the user.
 */
#define NS_PROMPTSERVICE_CONTRACTID \
 "@mozilla.org/embedcomp/prompt-service;1"

/**
 * This contract ID should be implemented by password managers to be able to
 * override the standard implementation of nsIAuthPrompt2. It will be used as
 * a service.
 *
 * This contract implements the following interfaces:
 * nsIPromptFactory
 */
#define NS_PWMGR_AUTHPROMPTFACTORY \
 "@mozilla.org/passwordmanager/authpromptfactory;1"

#endif // NSEMBEDCID_H