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 nsICSSStyleSheet;
  47 class nsICSSGroupRule;
  48 class nsAString;
  49
  50 // IID for the nsICSSRule interface {e775eac0-b022-462c-b1f9-221c01aa2988}
  51 #define NS_ICSS_RULE_IID     \
  52 {0xe775eac0, 0xb022, 0x462c, {0xb1, 0xf9, 0x22, 0x1c, 0x01, 0xaa, 0x29, 0x88}}
  53
  54 // inheriting from nsIStyleRule is only for style rules, not other rule types
  55 class nsICSSRule : public nsIStyleRule {
  56 public:
  57   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICSS_RULE_IID)
  58   enum {
  59     UNKNOWN_RULE = 0,
  60     STYLE_RULE = 1,
  61     IMPORT_RULE = 2,
  62     MEDIA_RULE = 3,
  63     FONT_FACE_RULE = 4,
  64     PAGE_RULE = 5,
  65     CHARSET_RULE = 6,
  66     NAMESPACE_RULE = 7,
  67     DOCUMENT_RULE = 8
  68   };
  69
  70   NS_IMETHOD GetType(PRInt32& aType) const = 0;
  71
  72   NS_IMETHOD GetStyleSheet(nsIStyleSheet*& aSheet) const = 0;
  73   NS_IMETHOD SetStyleSheet(nsICSSStyleSheet* aSheet) = 0;
  74   NS_IMETHOD SetParentRule(nsICSSGroupRule* aRule) = 0;
  75
  76   NS_IMETHOD Clone(nsICSSRule*& aClone) const = 0;
  77
  78   // Note that this returns null for inline style rules since they aren't
  79   // supposed to have a DOM rule representation (and our code wouldn't work).
  80   nsresult GetDOMRule(nsIDOMCSSRule** aDOMRule)
  81   {
  82     nsresult rv;
  83     NS_IF_ADDREF(*aDOMRule = GetDOMRuleWeak(&rv));
  84     return rv;
  85   }
  86   virtual nsIDOMCSSRule* GetDOMRuleWeak(nsresult* aResult) = 0;
  87 };
  88
  89 NS_DEFINE_STATIC_IID_ACCESSOR(nsICSSRule, NS_ICSS_RULE_IID)
  90
  91 /* Define global NS_New* functions for rules that don't need their own
  92    interfaces here */
  93 nsresult
  94 NS_NewCSSCharsetRule(nsICSSRule** aInstancePtrResult,
  95                      const nsAString& aEncoding);
  96
  97 #endif /* nsICSSRule_h___ */