gecko/dom/public/idl/sidebar/nsIWebContentHandlerRegistrar.idl

76 lines
3.0 KiB
Plaintext
Executable File

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** 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 the Web Content Handler Interface
*
* The Initial Developer of the Original Code is Google Inc.
* Portions created by the Initial Developer are Copyright (C) 2006
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ben Goodger <beng@google.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 nsIDOMWindow;
/**
* nsIWebContentHandlerRegistrar
*
* Applications wishing to use web content handlers need to implement this
* interface. Typically they will prompt the user to confirm adding an entry
* to the local list.
*
* The component must have the contract id defined below so that nsNavigator
* can invoke it.
*/
[scriptable, uuid(e6a75410-c93e-42bf-84ca-a5c3ec34a2f1)]
interface nsIWebContentHandlerRegistrar : nsISupports
{
/**
* See documentation in nsIDOMClientInformation.idl
* The additional contentWindow param for both methods represents the dom
* content window from which the method has been called.
*/
void registerContentHandler(in DOMString mimeType,
in DOMString uri,
in DOMString title,
in nsIDOMWindow contentWindow);
void registerProtocolHandler(in DOMString protocol,
in DOMString uri,
in DOMString title,
in nsIDOMWindow contentWindow);
};
%{ C++
#define NS_WEBCONTENTHANDLERREGISTRAR_CONTRACTID "@mozilla.org/embeddor.implemented/web-content-handler-registrar;1"
%}