chrome/public/nsIToolkitChromeRegistry.idl

   1 /* -*- Mode: C++; tab-width; 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 the XUL toolkit.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Benjamin Smedberg <benjamin@smedbergs.us>
  19  *
  20  * Portions created by the Initial Developer are Copyright (C) 2005
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  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 "nsIChromeRegistry.idl"
  40
  41 interface nsIURI;
  42 interface nsIUTF8StringEnumerator;
  43
  44 [scriptable, uuid(94490b3f-f094-418e-b1b9-73878d29bff3)]
  45 interface nsIToolkitChromeRegistry : nsIXULChromeRegistry
  46 {
  47   /**
  48    * The "canonical" manifest is a plaintext file which sits outside of a
  49    * JAR file. To provide backwards-compatibility with contents.rdf, we provide
  50    * this function which reads a contents.rdf manifest and writes it to a file.
  51    *
  52    * @param aOldManifestURI  The URI of an old manifest to read, without
  53    *                         the trailing "contents.rdf", e.g.
  54    *                         "jar:resource:///chrome/foo.jar!/content/foo/" or
  55    *                         "file://path/to/contents/rdf/"
  56    * @param aFile            The URI of a manifest file to write. It's a good
  57    *                         idea to use a resource: URI if possible.
  58    * @param aBaseURI         The base URI for relative path creation
  59    *                         "jar:resource:///chrome/foo.jar!/content/foo/"
  60    *                         this is a separate param from aOldManifestURI so
  61    *                         the "contents.rdf" can be read outside of the jar
  62    *                         to keep the zipreader cache from holding it open.
  63    * @param aAppend          Whether we should append to an existing manifest
  64    *                         or truncate and start empty.
  65    * @param aSkinOnly        Only allow skin packages.
  66    */
  67   void processContentsManifest(in nsIURI aOldManifestURI, in nsIURI aFile,
  68                                in nsIURI aBaseURI, in boolean aAppend,
  69                                in boolean aSkinOnly);
  70
  71   /**
  72    * If the OS has a "high-visibility" or "disabled-friendly" theme set,
  73    * we want to force mozilla into the classic theme, which (for the most part
  74    * obeys the system color/font settings. We cannot do this at initialization,
  75    * because it depends on the toolkit (GTK2) being initialized, which is
  76    * not the case in some embedding situations. Embedders have to manually
  77    * call this method during the startup process.
  78    */
  79   void checkForOSAccessibility();
  80
  81   /**
  82    * Get a list of locales available for the specified package.
  83    */
  84   nsIUTF8StringEnumerator getLocalesForPackage(in AUTF8String aPackage);
  85 };
  86
  87 /**
  88  * The chrome registry will ask the directory service for this file list and
  89  * process each file as a manifest. Skin manifests may contain only skin
  90  * and style overlays.
  91  */
  92 %{ C++
  93 #define NS_CHROME_MANIFESTS_FILE_LIST "ChromeML"
  94 #define NS_SKIN_MANIFESTS_FILE_LIST "SkinML"
  95 %}