chrome/nsIChromeRegistry.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 interface nsIURI;
  10
  11 [scriptable, uuid(249fb5ad-ae29-4e2c-a728-ba5cf464d188)]
  12 interface nsIChromeRegistry : nsISupports
  13 {
  14   const int32_t NONE = 0;
  15   const int32_t PARTIAL = 1;
  16   const int32_t FULL = 2;
  17
  18   /**
  19    * Resolve a chrome URL to an loadable URI using the information in the
  20    * registry. Does not modify aChromeURL.
  21    *
  22    * Chrome URLs are allowed to be specified in "shorthand", leaving the
  23    * "file" portion off. In that case, the URL is expanded to:
  24    *
  25    *   chrome://package/provider/package.ext
  26    *
  27    * where "ext" is:
  28    *
  29    *   "xul" for a "content" package,
  30    *   "css" for a "skin" package, and
  31    *   "dtd" for a "locale" package.
  32    *
  33    * @param aChromeURL the URL that is to be converted.
  34    */
  35   nsIURI convertChromeURL(in nsIURI aChromeURL);
  36
  37   /**
  38    * refresh the chrome list at runtime, looking for new packages/etc
  39    */
  40   void checkForNewChrome();
  41
  42   /**
  43    * returns whether XPCNativeWrappers are enabled for aURI.
  44    */
  45   [notxpcom] boolean wrappersEnabled(in nsIURI aURI);
  46 };
  47
  48 [scriptable, uuid(93251ddf-5e85-4172-ac2a-31780562974f)]
  49 interface nsIXULChromeRegistry : nsIChromeRegistry
  50 {
  51   // If the optional asBCP47 parameter is true, the locale code will be
  52   // converted to a BCP47 language tag; in particular, this means that
  53   // "ja-JP-mac" will be returned as "ja-JP-x-lvariant-mac", which can be
  54   // passed to ECMA402 Intl API methods without throwing a RangeError.
  55   ACString getSelectedLocale(in ACString packageName,
  56                              [optional] in boolean asBCP47);
  57
  58   // Get whether the default writing direction of the locale is RTL
  59   // (or may be overridden by intl.uidirection pref)
  60   boolean isLocaleRTL(in ACString package);
  61
  62   /* Should be called when skins change. Reloads only stylesheets. */
  63   void refreshSkins();
  64
  65   /**
  66    * Installable skin XBL is not always granted the same privileges as other
  67    * chrome. This asks the chrome registry whether scripts are allowed to be
  68    * run for a particular chrome URI. Do not pass non-chrome URIs to this
  69    * method.
  70    */
  71   boolean allowScriptsForPackage(in nsIURI url);
  72
  73   /**
  74    * Content should only be allowed to load chrome JS from certain packages.
  75    * This method reflects the contentaccessible flag on packages.
  76    * Do not pass non-chrome URIs to this method.
  77    */
  78   boolean allowContentToAccess(in nsIURI url);
  79
  80   /**
  81    * Returns true if the passed chrome URL is allowed to be loaded in a remote
  82    * process. This reflects the remoteenabled flag on packages.
  83    * Do not pass non-chrome URIs to this method.
  84    */
  85   boolean canLoadURLRemotely(in nsIURI url);
  86
  87   /**
  88    * Returns true if the passed chrome URL must be loaded in a remote process.
  89    * This reflects the remoterequired flag on packages.
  90    * Do not pass non-chrome URIs to this method.
  91    */
  92   boolean mustLoadURLRemotely(in nsIURI url);
  93 };
  94
  95 %{ C++
  96
  97 #define NS_CHROMEREGISTRY_CONTRACTID \
  98   "@mozilla.org/chrome/chrome-registry;1"
  99
 100 /**
 101  * Chrome registry will notify various caches that all chrome files need
 102  * flushing.
 103  */
 104 #define NS_CHROME_FLUSH_TOPIC \
 105   "chrome-flush-caches"
 106
 107 /**
 108  * Chrome registry will notify various caches that skin files need flushing.
 109  * If "chrome-flush-caches" is notified, this topic will *not* be notified.
 110  */
 111 #define NS_CHROME_FLUSH_SKINS_TOPIC \
 112   "chrome-flush-skin-caches"
 113
 114 %}