layout/style/nsIStyleSheet.h

   1 /* -*- Mode: C++; 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.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 of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or 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 /*
  39  * interface representing a collection of style data attached to a
  40  * document, which may be or be combined into a style rule processor
  41  */
  42
  43 #ifndef nsIStyleSheet_h___
  44 #define nsIStyleSheet_h___
  45
  46 #include <stdio.h>
  47 #include "nsISupports.h"
  48
  49 class nsString;
  50 class nsIURI;
  51 class nsIDocument;
  52
  53 // IID for the nsIStyleSheet interface
  54 // 3eb34a60-04bd-41d9-9f60-882694e61c38
  55 #define NS_ISTYLE_SHEET_IID     \
  56 { 0x3eb34a60, 0x04bd, 0x41d9,   \
  57  { 0x9f, 0x60, 0x88, 0x26, 0x94, 0xe6, 0x1c, 0x38 } }
  58
  59 /**
  60  * A style sheet is a thing associated with a document that has style
  61  * rules.  Those style rules can be reached in one of two ways, depending
  62  * on which level of the nsStyleSet it is in:
  63  *   1) It can be |QueryInterface|d to nsIStyleRuleProcessor
  64  *   2) It can be |QueryInterface|d to nsCSSStyleSheet, with which the
  65  *      |nsStyleSet| uses an |nsCSSRuleProcessor| to access the rules.
  66  */
  67 class nsIStyleSheet : public nsISupports {
  68 public:
  69   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISTYLE_SHEET_IID)
  70
  71   // basic style sheet data
  72   virtual nsIURI* GetSheetURI() const = 0;
  73   virtual nsIURI* GetBaseURI() const = 0;
  74   virtual void GetTitle(nsString& aTitle) const = 0;
  75   virtual void GetType(nsString& aType) const = 0;
  76   virtual PRBool HasRules() const = 0;
  77
  78   /**
  79    * Whether the sheet is applicable.  A sheet that is not applicable
  80    * should never be inserted into a style set.  A sheet may not be
  81    * applicable for a variety of reasons including being disabled and
  82    * being incomplete.
  83    *
  84    */
  85   virtual PRBool IsApplicable() const = 0;
  86
  87   /**
  88    * Set the stylesheet to be enabled.  This may or may not make it
  89    * applicable.  Note that this WILL inform the sheet's document of
  90    * its new applicable state if the state changes but WILL NOT call
  91    * BeginUpdate() or EndUpdate() on the document -- calling those is
  92    * the caller's responsibility.  This allows use of SetEnabled when
  93    * batched updates are desired.  If you want updates handled for
  94    * you, see nsIDOMStyleSheet::SetDisabled().
  95    */
  96   virtual void SetEnabled(PRBool aEnabled) = 0;
  97
  98   /**
  99    * Whether the sheet is complete.
 100    */
 101   virtual PRBool IsComplete() const = 0;
 102   virtual void SetComplete() = 0;
 103
 104   // style sheet owner info
 105   virtual nsIStyleSheet* GetParentSheet() const = 0;  // may be null
 106   virtual nsIDocument* GetOwningDocument() const = 0; // may be null
 107   virtual void SetOwningDocument(nsIDocument* aDocument) = 0;
 108
 109 #ifdef DEBUG
 110   virtual void List(FILE* out = stdout, PRInt32 aIndent = 0) const = 0;
 111 #endif
 112 };
 113
 114 NS_DEFINE_STATIC_IID_ACCESSOR(nsIStyleSheet, NS_ISTYLE_SHEET_IID)
 115
 116 #endif /* nsIStyleSheet_h___ */