summaryrefslogtreecommitdiff
path: root/dom/smil/nsSMILCSSValueType.h
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commitad18d877ddd2a44d98fa12ccd3dbbcf4d0ac4299 (patch)
tree10027f336435511475e392454359edea8e25895d /dom/smil/nsSMILCSSValueType.h
parent15477ed9af4859dacb069040b5d4de600803d3bc (diff)
downloaduxp-ad18d877ddd2a44d98fa12ccd3dbbcf4d0ac4299.tar.gz
Add m-esr52 at 52.6.0
Diffstat (limited to 'dom/smil/nsSMILCSSValueType.h')
-rw-r--r--dom/smil/nsSMILCSSValueType.h116
1 files changed, 116 insertions, 0 deletions
diff --git a/dom/smil/nsSMILCSSValueType.h b/dom/smil/nsSMILCSSValueType.h
new file mode 100644
index 0000000000..0c71605f05
--- /dev/null
+++ b/dom/smil/nsSMILCSSValueType.h
@@ -0,0 +1,116 @@
+/* -*- 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/. */
+
+/* representation of a value for a SMIL-animated CSS property */
+
+#ifndef NS_SMILCSSVALUETYPE_H_
+#define NS_SMILCSSVALUETYPE_H_
+
+#include "nsISMILType.h"
+#include "nsCSSPropertyID.h"
+#include "mozilla/Attributes.h"
+
+class nsAString;
+
+namespace mozilla {
+namespace dom {
+class Element;
+} // namespace dom
+} // namespace mozilla
+
+/*
+ * nsSMILCSSValueType: Represents a SMIL-animated CSS value.
+ */
+class nsSMILCSSValueType : public nsISMILType
+{
+public:
+ typedef mozilla::dom::Element Element;
+
+ // Singleton for nsSMILValue objects to hold onto.
+ static nsSMILCSSValueType sSingleton;
+
+protected:
+ // nsISMILType Methods
+ // -------------------
+ virtual void Init(nsSMILValue& aValue) const override;
+ virtual void Destroy(nsSMILValue&) const override;
+ virtual nsresult Assign(nsSMILValue& aDest,
+ const nsSMILValue& aSrc) const override;
+ virtual bool IsEqual(const nsSMILValue& aLeft,
+ const nsSMILValue& aRight) const override;
+ virtual nsresult Add(nsSMILValue& aDest,
+ const nsSMILValue& aValueToAdd,
+ uint32_t aCount) const override;
+ virtual nsresult ComputeDistance(const nsSMILValue& aFrom,
+ const nsSMILValue& aTo,
+ double& aDistance) const override;
+ virtual nsresult Interpolate(const nsSMILValue& aStartVal,
+ const nsSMILValue& aEndVal,
+ double aUnitDistance,
+ nsSMILValue& aResult) const override;
+
+public:
+ // Helper Methods
+ // --------------
+ /**
+ * Sets up the given nsSMILValue to represent the given string value. The
+ * string is interpreted as a value for the given property on the given
+ * element.
+ *
+ * On failure, this method leaves aValue.mType == nsSMILNullType::sSingleton.
+ * Otherwise, this method leaves aValue.mType == this class's singleton.
+ *
+ * @param aPropID The property for which we're parsing a value.
+ * @param aTargetElement The target element to whom the property/value
+ * setting applies.
+ * @param aString The string to be parsed as a CSS value.
+ * @param [out] aValue The nsSMILValue to be populated. Should
+ * initially be null-typed.
+ * @param [out] aIsContextSensitive Set to true if |aString| may produce
+ * a different |aValue| depending on other
+ * CSS properties on |aTargetElement|
+ * or its ancestors (e.g. 'inherit).
+ * false otherwise. May be nullptr.
+ * Not set if the method fails.
+ * @pre aValue.IsNull()
+ * @post aValue.IsNull() || aValue.mType == nsSMILCSSValueType::sSingleton
+ */
+ static void ValueFromString(nsCSSPropertyID aPropID,
+ Element* aTargetElement,
+ const nsAString& aString,
+ nsSMILValue& aValue,
+ bool* aIsContextSensitive);
+
+ /**
+ * Creates a string representation of the given nsSMILValue.
+ *
+ * Note: aValue is expected to be of this type (that is, it's expected to
+ * have been initialized by nsSMILCSSValueType::sSingleton). If aValue is a
+ * freshly-initialized value, this method will succeed, though the resulting
+ * string will be empty.
+ *
+ * @param aValue The nsSMILValue to be converted into a string.
+ * @param [out] aString The string to be populated with the given value.
+ * @return true on success, false on failure.
+ */
+ static bool ValueToString(const nsSMILValue& aValue, nsAString& aString);
+
+ /**
+ * Return the CSS property animated by the specified value.
+ *
+ * @param aValue The nsSMILValue to examine.
+ * @return The nsCSSPropertyID enum value of the property animated
+ * by |aValue|, or eCSSProperty_UNKNOWN if the type of
+ * |aValue| is not nsSMILCSSValueType.
+ */
+ static nsCSSPropertyID PropertyFromValue(const nsSMILValue& aValue);
+
+private:
+ // Private constructor: prevent instances beyond my singleton.
+ constexpr nsSMILCSSValueType() {}
+};
+
+#endif // NS_SMILCSSVALUETYPE_H_