layout/base/nsIStyleSheetService.idl

   1 /* -*- Mode: IDL; tab-width: 2; 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 Mozilla.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * IBM Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Brian Ryner <bryner@brianryner.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 /* interface for managing user and user-agent style sheets */
  40
  41 #include "nsISupports.idl"
  42
  43 interface nsIURI;
  44
  45 /*
  46  * nsIStyleSheetService allows extensions or embeddors to add to the
  47  * built-in list of user or agent style sheets.
  48  */
  49
  50 [scriptable, uuid(1f42a6a2-ab0a-45d4-8a96-396f58ea6c6d)]
  51 interface nsIStyleSheetService : nsISupports
  52 {
  53   const unsigned long AGENT_SHEET = 0;
  54   const unsigned long USER_SHEET = 1;
  55
  56   /**
  57    * Synchronously loads a style sheet from |sheetURI| and adds it to the list
  58    * of user or agent style sheets.
  59    *
  60    * A user sheet loaded via this API will come before userContent.css and
  61    * userChrome.css in the cascade (so the rules in it will have lower
  62    * precedence than rules in those sheets).
  63    *
  64    * An agent sheet loaded via this API will come after ua.css in the cascade
  65    * (so the rules in it will have higher precedence than rules in ua.css).
  66    *
  67    * The relative ordering of two user or two agent sheets loaded via
  68    * this API is undefined.
  69    *
  70    * Sheets added via this API take effect on all documents, including
  71    * already-loaded ones, immediately.
  72    */
  73   void loadAndRegisterSheet(in nsIURI sheetURI, in unsigned long type);
  74
  75   /**
  76    * Returns true if a style sheet at |sheetURI| has previously been
  77    * added to the list of style sheets specified by |type|.
  78    */
  79   boolean sheetRegistered(in nsIURI sheetURI, in unsigned long type);
  80
  81   /**
  82    * Remove the style sheet at |sheetURI| from the list of style sheets
  83    * specified by |type|.  The removal takes effect immediately, even for
  84    * already-loaded documents.
  85    */
  86   void unregisterSheet(in nsIURI sheetURI, in unsigned long type);
  87 };