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 nsIAtom;
  50 class nsString;
  51 class nsIURI;
  52 class nsIStyleRule;
  53 class nsPresContext;
  54 class nsIContent;
  55 class nsIDocument;
  56 class nsIStyleRuleProcessor;
  57
  58 // IID for the nsIStyleSheet interface
  59 // 7b2d31da-c3fb-4537-bd97-337272b83568
  60 #define NS_ISTYLE_SHEET_IID     \
  61 { 0x7b2d31da, 0xc3fb, 0x4537,   \
  62  { 0xbd, 0x97, 0x33, 0x72, 0x72, 0xb8, 0x35, 0x68 } }
  63
  64 /**
  65  * A style sheet is a thing associated with a document that has style
  66  * rules.  Those style rules can be reached in one of two ways, depending
  67  * on which level of the nsStyleSet it is in:
  68  *   1) It can be |QueryInterface|d to nsIStyleRuleProcessor
  69  *   2) It can be |QueryInterface|d to nsICSSStyleSheet, with which the
  70  *      |nsStyleSet| uses an |nsCSSRuleProcessor| to access the rules.
  71  */
  72 class nsIStyleSheet : public nsISupports {
  73 public:
  74   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISTYLE_SHEET_IID)
  75
  76   // basic style sheet data
  77   NS_IMETHOD GetSheetURI(nsIURI** aSheetURI) const = 0;
  78   NS_IMETHOD GetBaseURI(nsIURI** aBaseURI) const = 0;
  79   NS_IMETHOD GetTitle(nsString& aTitle) const = 0;
  80   NS_IMETHOD GetType(nsString& aType) const = 0;
  81   NS_IMETHOD_(PRBool) HasRules() const = 0;
  82
  83   /**
  84    * Whether the sheet is applicable.  A sheet that is not applicable
  85    * should never be inserted into a style set.  A sheet may not be
  86    * applicable for a variety of reasons including being disabled and
  87    * being incomplete.
  88    *
  89    */
  90   NS_IMETHOD GetApplicable(PRBool& aApplicable) const = 0;
  91
  92   /**
  93    * Set the stylesheet to be enabled.  This may or may not make it
  94    * applicable.  Note that this WILL inform the sheet's document of
  95    * its new applicable state if the state changes but WILL NOT call
  96    * BeginUpdate() or EndUpdate() on the document -- calling those is
  97    * the caller's responsibility.  This allows use of SetEnabled when
  98    * batched updates are desired.  If you want updates handled for
  99    * you, see nsIDOMStyleSheet::SetDisabled().
 100    */
 101   NS_IMETHOD SetEnabled(PRBool aEnabled) = 0;
 102
 103   /**
 104    * Whether the sheet is complete.
 105    */
 106   NS_IMETHOD GetComplete(PRBool& aComplete) const = 0;
 107   NS_IMETHOD SetComplete() = 0;
 108
 109   // style sheet owner info
 110   NS_IMETHOD GetParentSheet(nsIStyleSheet*& aParent) const = 0;  // may be null
 111   NS_IMETHOD GetOwningDocument(nsIDocument*& aDocument) const = 0; // may be null
 112   NS_IMETHOD SetOwningDocument(nsIDocument* aDocument) = 0;
 113
 114 #ifdef DEBUG
 115   virtual void List(FILE* out = stdout, PRInt32 aIndent = 0) const = 0;
 116 #endif
 117 };
 118
 119 NS_DEFINE_STATIC_IID_ACCESSOR(nsIStyleSheet, NS_ISTYLE_SHEET_IID)
 120
 121 #endif /* nsIStyleSheet_h___ */