dom/public/idl/sidebar/nsIWebContentHandlerRegistrar.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Web Content Handler Interface
  17  *
  18  * The Initial Developer of the Original Code is Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Ben Goodger <beng@google.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIDOMWindow;
  42
  43 /**
  44  * nsIWebContentHandlerRegistrar
  45  *
  46  * Applications wishing to use web content handlers need to implement this
  47  * interface. Typically they will prompt the user to confirm adding an entry
  48  * to the local list.
  49  *
  50  * The component must have the contract id defined below so that nsNavigator
  51  * can invoke it.
  52  */
  53
  54 [scriptable, uuid(e6a75410-c93e-42bf-84ca-a5c3ec34a2f1)]
  55 interface nsIWebContentHandlerRegistrar : nsISupports
  56 {
  57   /**
  58    * See documentation in nsIDOMClientInformation.idl
  59    * The additional contentWindow param for both methods represents the dom
  60    * content window from which the method has been called.
  61    */
  62    void registerContentHandler(in DOMString mimeType,
  63                                in DOMString uri,
  64                                in DOMString title,
  65                                in nsIDOMWindow contentWindow);
  66    void registerProtocolHandler(in DOMString protocol,
  67                                 in DOMString uri,
  68                                 in DOMString title,
  69                                 in nsIDOMWindow contentWindow);
  70 };
  71
  72 %{ C++
  73
  74 #define NS_WEBCONTENTHANDLERREGISTRAR_CONTRACTID "@mozilla.org/embeddor.implemented/web-content-handler-registrar;1"
  75 %}