layout/style/nsICSSDeclaration.h
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Wed, 26 Feb 2020 14:42:27 +0000
changeset 575883 731d4b701af635dd274f25dd4cedba4ad84f095a
parent 574924 078cb087523fbd0c376509033a38057045838909
permissions -rw-r--r--
No bug - Tagging 588c2ea6418034a20c33f21e122da5c3e2f335a7 with FIREFOX_74_0b8_BUILD2 a=release CLOSED TREE DONTBUILD

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/*
 * interface for accessing style declarations using enums instead of strings,
 * for internal use
 */

#ifndef nsICSSDeclaration_h__
#define nsICSSDeclaration_h__

/**
 * This interface provides access to methods analogous to those of
 * CSSStyleDeclaration; the difference is that these use nsCSSPropertyID
 * enums for the prop names instead of using strings.
 */

#include "mozilla/Attributes.h"
#include "nsCSSPropertyID.h"
#include "mozilla/dom/CSSValue.h"
#include "nsWrapperCache.h"
#include "nsStringFwd.h"
#include "mozilla/ErrorResult.h"
#include "nsCOMPtr.h"

class nsINode;
class nsIPrincipal;
namespace mozilla {
namespace css {
class Rule;
}  // namespace css
namespace dom {
class DocGroup;
}  // namespace dom
}  // namespace mozilla

// dbeabbfa-6cb3-4f5c-aec2-dd558d9d681f
#define NS_ICSSDECLARATION_IID                       \
  {                                                  \
    0xdbeabbfa, 0x6cb3, 0x4f5c, {                    \
      0xae, 0xc2, 0xdd, 0x55, 0x8d, 0x9d, 0x68, 0x1f \
    }                                                \
  }

class nsICSSDeclaration : public nsISupports, public nsWrapperCache {
 public:
  NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICSSDECLARATION_IID)

  virtual nsINode* GetParentObject() = 0;
  mozilla::dom::DocGroup* GetDocGroup();

  NS_IMETHOD GetPropertyValue(const nsACString& aPropName,
                              nsAString& aValue) = 0;
  virtual void RemoveProperty(const nsACString& aPropertyName,
                              nsAString& aReturn,
                              mozilla::ErrorResult& aRv) = 0;
  virtual void SetProperty(const nsACString& aPropertyName,
                           const nsACString& aValue, const nsAString& aPriority,
                           nsIPrincipal* aSubjectPrincipal,
                           mozilla::ErrorResult& aRv) = 0;
  // For C++ callers.
  void SetProperty(const nsACString& aPropertyName, const nsACString& aValue,
                   const nsAString& aPriority, mozilla::ErrorResult& aRv) {
    SetProperty(aPropertyName, aValue, aPriority, nullptr, aRv);
  }

  void Item(uint32_t aIndex, nsACString& aReturn) {
    bool found;
    IndexedGetter(aIndex, found, aReturn);
    if (!found) {
      aReturn.Truncate();
    }
  }

  virtual void GetCSSImageURLs(const nsACString& aPropertyName,
                               nsTArray<nsCString>& aImageURLs,
                               mozilla::ErrorResult& aRv) {
    aRv.Throw(NS_ERROR_NOT_IMPLEMENTED);
  }

  // WebIDL interface for CSSStyleDeclaration
  virtual void SetCssText(const nsAString& aString,
                          nsIPrincipal* aSubjectPrincipal,
                          mozilla::ErrorResult& rv) = 0;
  virtual void GetCssText(nsAString& aString) = 0;
  virtual uint32_t Length() = 0;

  // The actual implementation of the Item method and the WebIDL indexed getter
  virtual void IndexedGetter(uint32_t aIndex, bool& aFound,
                             nsACString& aPropName) = 0;

  void GetPropertyValue(const nsACString& aPropName, nsString& aValue,
                        mozilla::ErrorResult& rv) {
    rv = GetPropertyValue(aPropName, aValue);
  }
  virtual void GetPropertyPriority(const nsACString& aPropName,
                                   nsAString& aPriority) = 0;
  virtual mozilla::css::Rule* GetParentRule() = 0;

 protected:
  bool IsReadOnly();
};

NS_DEFINE_STATIC_IID_ACCESSOR(nsICSSDeclaration, NS_ICSSDECLARATION_IID)

#define NS_DECL_NSIDOMCSSSTYLEDECLARATION_HELPER                               \
  void GetCssText(nsAString& aCssText) override;                               \
  void SetCssText(const nsAString& aCssText, nsIPrincipal* aSubjectPrincipal,  \
                  mozilla::ErrorResult& aRv) override;                         \
  NS_IMETHOD GetPropertyValue(const nsACString& propertyName,                  \
                              nsAString& _retval) override;                    \
  void RemoveProperty(const nsACString& propertyName, nsAString& _retval,      \
                      mozilla::ErrorResult& aRv) override;                     \
  void GetPropertyPriority(const nsACString& propertyName,                     \
                           nsAString& aPriority) override;                     \
  void SetProperty(const nsACString& propertyName, const nsACString& value,    \
                   const nsAString& priority, nsIPrincipal* aSubjectPrincipal, \
                   mozilla::ErrorResult& aRv) override;                        \
  uint32_t Length() override;                                                  \
  mozilla::css::Rule* GetParentRule() override;

#endif  // nsICSSDeclaration_h__