netwerk/protocol/about/public/nsIAboutModule.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIURI;
  41 interface nsIChannel;
  42
  43 [scriptable, uuid(9575693c-60d9-4332-b6b8-6c29289339cb)]
  44 interface nsIAboutModule : nsISupports
  45 {
  46     /**
  47      * Constructs a new channel for the about protocol module.
  48      *
  49      * @param aURI the uri of the new channel
  50      */
  51     nsIChannel newChannel(in nsIURI aURI);
  52
  53     /**
  54      * A flag that indicates whether a URI is safe for untrusted
  55      * content.  If it is, web pages and so forth will be allowed to
  56      * link to this about: URI.  Otherwise, only chrome will be able
  57      * to link to it.
  58      */
  59     const unsigned long URI_SAFE_FOR_UNTRUSTED_CONTENT = (1 << 0);
  60
  61     /**
  62      * A flag that indicates whether script should be enabled for the
  63      * given about: URI even if it's disabled in general.
  64      */
  65     const unsigned long ALLOW_SCRIPT = (1 << 1);
  66
  67     /**
  68      * A method to get the flags that apply to a given about: URI.  The URI
  69      * passed in is guaranteed to be one of the URIs that this module
  70      * registered to deal with.
  71      */
  72     unsigned long getURIFlags(in nsIURI aURI);
  73 };
  74
  75 %{C++
  76
  77 #define NS_ABOUT_MODULE_CONTRACTID        "@mozilla.org/network/protocol/about;1"
  78 #define NS_ABOUT_MODULE_CONTRACTID_PREFIX NS_ABOUT_MODULE_CONTRACTID "?what="
  79 #define NS_ABOUT_MODULE_CONTRACTID_LENGTH 49      // nsCRT::strlen(NS_ABOUT_MODULE_CONTRACTID_PREFIX)
  80
  81 %}