layout/style/nsICSSGroupRule.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 /*
  39  * internal interface representing CSS style rules that contain other
  40  * rules, such as @media rules
  41  */
  42
  43 #ifndef nsICSSGroupRule_h___
  44 #define nsICSSGroupRule_h___
  45
  46 #include "nsICSSRule.h"
  47 #include "nsCOMArray.h"
  48
  49 class nsIAtom;
  50 class nsPresContext;
  51 class nsMediaQueryResultCacheKey;
  52
  53 // IID for the nsICSSGroupRule interface {67b8492e-6d8d-43a5-8037-71eb269f24fe}
  54 #define NS_ICSS_GROUP_RULE_IID     \
  55 {0x67b8492e, 0x6d8d, 0x43a5, {0x80, 0x37, 0x71, 0xeb, 0x26, 0x9f, 0x24, 0xfe}}
  56
  57 class nsICSSGroupRule : public nsICSSRule {
  58 public:
  59   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICSS_GROUP_RULE_IID)
  60
  61   NS_IMETHOD  AppendStyleRule(nsICSSRule* aRule) = 0;
  62
  63   NS_IMETHOD  StyleRuleCount(PRInt32& aCount) const = 0;
  64   NS_IMETHOD  GetStyleRuleAt(PRInt32 aIndex, nsICSSRule*& aRule) const = 0;
  65
  66   typedef nsCOMArray<nsICSSRule>::nsCOMArrayEnumFunc RuleEnumFunc;
  67   NS_IMETHOD_(PRBool) EnumerateRulesForwards(RuleEnumFunc aFunc, void * aData) const = 0;
  68
  69   /*
  70    * The next three methods should never be called unless you have first
  71    * called WillDirty() on the parent stylesheet.  After they are
  72    * called, DidDirty() needs to be called on the sheet.
  73    */
  74   NS_IMETHOD  DeleteStyleRuleAt(PRUint32 aIndex) = 0;
  75   NS_IMETHOD  InsertStyleRulesAt(PRUint32 aIndex,
  76                                  nsCOMArray<nsICSSRule>& aRules) = 0;
  77   NS_IMETHOD  ReplaceStyleRule(nsICSSRule* aOld, nsICSSRule* aNew) = 0;
  78
  79   NS_IMETHOD_(PRBool) UseForPresentation(nsPresContext* aPresContext,
  80                                          nsMediaQueryResultCacheKey& aKey) = 0;
  81
  82 };
  83
  84 NS_DEFINE_STATIC_IID_ACCESSOR(nsICSSGroupRule, NS_ICSS_GROUP_RULE_IID)
  85
  86 #endif /* nsICSSGroupRule_h___ */