layout/style/nsICSSRule.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) 1999
  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 /* internal interface for all rule types in a CSS style sheet */
  39
  40 #ifndef nsICSSRule_h
  41 #define nsICSSRule_h
  42
  43 #include "nsIStyleRule.h"
  44 #include "nsIDOMCSSRule.h"
  45
  46 class nsCSSStyleSheet;
  47 class nsICSSGroupRule;
  48 class nsAString;
  49 template<class T> struct already_AddRefed;
  50
  51 // IID for the nsICSSRule interface
  52 #define NS_ICSS_RULE_IID \
  53 { 0x1f560b20, 0xa829, 0x4b99, \
  54   { 0x87, 0xbd, 0x8c, 0x87, 0x95, 0x2b, 0x3b, 0xb6 } }
  55
  56
  57 // inheriting from nsIStyleRule is only for style rules, not other rule types
  58 class nsICSSRule : public nsIStyleRule {
  59 public:
  60   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICSS_RULE_IID)
  61   // The constants in this list must maintain the following invariants:
  62   //   If a rule of type N must appear before a rule of type M in stylesheets
  63   //   then N < M
  64   // Note that nsCSSStyleSheet::RebuildChildList assumes that no other kinds of
  65   // rules can come between two rules of type IMPORT_RULE.
  66   enum {
  67     UNKNOWN_RULE = 0,
  68     CHARSET_RULE,
  69     IMPORT_RULE,
  70     NAMESPACE_RULE,
  71     STYLE_RULE,
  72     MEDIA_RULE,
  73     FONT_FACE_RULE,
  74     PAGE_RULE,
  75     DOCUMENT_RULE
  76   };
  77
  78   virtual PRInt32 GetType() const = 0;
  79
  80   virtual already_AddRefed<nsIStyleSheet> GetStyleSheet() const = 0;
  81   virtual void SetStyleSheet(nsCSSStyleSheet* aSheet) = 0;
  82   virtual void SetParentRule(nsICSSGroupRule* aRule) = 0;
  83
  84   /**
  85    * Clones |this|. Never returns NULL.
  86    */
  87   virtual already_AddRefed<nsICSSRule> Clone() const = 0;
  88
  89   // Note that this returns null for inline style rules since they aren't
  90   // supposed to have a DOM rule representation (and our code wouldn't work).
  91   nsresult GetDOMRule(nsIDOMCSSRule** aDOMRule)
  92   {
  93     nsresult rv;
  94     NS_IF_ADDREF(*aDOMRule = GetDOMRuleWeak(&rv));
  95     return rv;
  96   }
  97   virtual nsIDOMCSSRule* GetDOMRuleWeak(nsresult* aResult) = 0;
  98 };
  99
 100 NS_DEFINE_STATIC_IID_ACCESSOR(nsICSSRule, NS_ICSS_RULE_IID)
 101
 102 /* Define global NS_New* functions for rules that don't need their own
 103    interfaces here */
 104 nsresult
 105 NS_NewCSSCharsetRule(nsICSSRule** aInstancePtrResult,
 106                      const nsAString& aEncoding);
 107
 108 #endif /* nsICSSRule_h */