layout/style/nsICSSDeclaration.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  * Boris Zbarsky <bzbarsky@mit.edu>.
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  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  * faster version of nsIDOMCSSStyleDeclaration using enums instead of
  40  * strings, for internal use
  41  */
  42
  43 #ifndef nsICSSDeclaration_h__
  44 #define nsICSSDeclaration_h__
  45
  46 /**
  47  * This interface provides access to methods analogous to those of
  48  * nsIDOMCSSStyleDeclaration; the difference is that these use
  49  * nsCSSProperty enums for the prop names instead of using strings.
  50  * This is meant for use in performance-sensitive code only!  Most
  51  * consumers should continue to use nsIDOMCSSStyleDeclaration.
  52  */
  53
  54 #include "nsIDOMCSSStyleDeclaration.h"
  55 #include "nsCSSProperty.h"
  56
  57 // 57eb81d1-a607-4429-926b-802519d43aad
  58 #define NS_ICSSDECLARATION_IID \
  59  { 0x57eb81d1, 0xa607, 0x4429, \
  60     {0x92, 0x6b, 0x80, 0x25, 0x19, 0xd4, 0x3a, 0xad } }
  61
  62
  63 class nsICSSDeclaration : public nsIDOMCSSStyleDeclaration
  64 {
  65 public:
  66   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICSSDECLARATION_IID)
  67
  68   /**
  69    * Method analogous to nsIDOMCSSStyleDeclaration::GetPropertyValue,
  70    * which obeys all the same restrictions.
  71    */
  72   NS_IMETHOD GetPropertyValue(const nsCSSProperty aPropID,
  73                               nsAString& aValue) = 0;
  74
  75   // Also have to declare the nsIDOMCSSStyleDeclaration method, so we
  76   // don't hide it... very sad, but it stole the good method name
  77   NS_IMETHOD GetPropertyValue(const nsAString& aPropName,
  78                               nsAString& aValue) = 0;
  79
  80   /**
  81    * Method analogous to nsIDOMCSSStyleDeclaration::SetProperty.  This
  82    * method does NOT allow setting a priority (the priority will
  83    * always be set to default priority).
  84    */
  85   NS_IMETHOD SetPropertyValue(const nsCSSProperty aPropID,
  86                               const nsAString& aValue) = 0;
  87 };
  88
  89 NS_DEFINE_STATIC_IID_ACCESSOR(nsICSSDeclaration, NS_ICSSDECLARATION_IID)
  90
  91 #define NS_DECL_NSICSSDECLARATION                               \
  92   NS_IMETHOD GetPropertyValue(const nsCSSProperty aPropID,    \
  93                               nsAString& aValue);               \
  94   NS_IMETHOD SetPropertyValue(const nsCSSProperty aPropID,    \
  95                               const nsAString& aValue);
  96
  97
  98
  99 #endif // nsICSSDeclaration_h__