gecko-dev/dom/svg/nsSVGViewBox.h

246 lines
7.1 KiB
C
Raw Normal View History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2012-05-21 11:12:37 +00:00
/* 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/. */
#ifndef __NS_SVGVIEWBOX_H__
#define __NS_SVGVIEWBOX_H__
#include "nsAutoPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsError.h"
#include "mozilla/dom/SVGAnimatedRect.h"
#include "mozilla/dom/SVGIRect.h"
#include "nsISMILAttr.h"
#include "nsSVGElement.h"
#include "mozilla/Attributes.h"
#include "nsSVGAttrTearoffTable.h"
class nsSMILValue;
namespace mozilla {
namespace dom {
class SVGAnimationElement;
}
}
struct nsSVGViewBoxRect
{
float x, y;
float width, height;
bool none;
nsSVGViewBoxRect() : none(true) {}
nsSVGViewBoxRect(float aX, float aY, float aWidth, float aHeight) :
x(aX), y(aY), width(aWidth), height(aHeight), none(false) {}
nsSVGViewBoxRect(const nsSVGViewBoxRect& rhs) :
x(rhs.x), y(rhs.y), width(rhs.width), height(rhs.height), none(rhs.none) {}
bool operator==(const nsSVGViewBoxRect& aOther) const;
};
class nsSVGViewBox
{
public:
void Init();
/**
* Returns true if the corresponding "viewBox" attribute defined a rectangle
* with finite values. Returns false if the viewBox was set to an invalid
* string, or if any of the four rect values were too big to store in a
* float.
*
* This method does not check whether the width or height values are
* positive, so callers must check whether the viewBox rect is valid where
* necessary!
*/
bool HasRect() const
{ return (mAnimVal && !mAnimVal->none) ||
(!mAnimVal && mHasBaseVal && !mBaseVal.none); }
/**
* Returns true if the corresponding "viewBox" attribute either defined a
* rectangle with finite values or the special "none" value.
*/
bool IsExplicitlySet() const
{ return mAnimVal || mHasBaseVal; }
const nsSVGViewBoxRect& GetBaseValue() const
{ return mBaseVal; }
void SetBaseValue(const nsSVGViewBoxRect& aRect,
nsSVGElement *aSVGElement);
const nsSVGViewBoxRect& GetAnimValue() const
{ return mAnimVal ? *mAnimVal : mBaseVal; }
void SetAnimValue(const nsSVGViewBoxRect& aRect,
nsSVGElement *aSVGElement);
nsresult SetBaseValueString(const nsAString& aValue,
nsSVGElement *aSVGElement,
bool aDoSetAttr);
void GetBaseValueString(nsAString& aValue) const;
already_AddRefed<mozilla::dom::SVGAnimatedRect>
ToSVGAnimatedRect(nsSVGElement *aSVGElement);
already_AddRefed<mozilla::dom::SVGIRect>
ToDOMBaseVal(nsSVGElement* aSVGElement);
already_AddRefed<mozilla::dom::SVGIRect>
ToDOMAnimVal(nsSVGElement* aSVGElement);
// Returns a new nsISMILAttr object that the caller must delete
nsISMILAttr* ToSMILAttr(nsSVGElement* aSVGElement);
private:
nsSVGViewBoxRect mBaseVal;
nsAutoPtr<nsSVGViewBoxRect> mAnimVal;
bool mHasBaseVal;
public:
struct DOMBaseVal MOZ_FINAL : public mozilla::dom::SVGIRect
{
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
2013-05-16 18:06:21 +00:00
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(DOMBaseVal)
DOMBaseVal(nsSVGViewBox *aVal, nsSVGElement *aSVGElement)
2013-05-16 18:06:21 +00:00
: mozilla::dom::SVGIRect()
, mVal(aVal)
, mSVGElement(aSVGElement)
{}
nsSVGViewBox* mVal; // kept alive because it belongs to content
nsRefPtr<nsSVGElement> mSVGElement;
float X() const MOZ_OVERRIDE MOZ_FINAL
{
return mVal->GetBaseValue().x;
}
float Y() const MOZ_OVERRIDE MOZ_FINAL
{
return mVal->GetBaseValue().y;
}
float Width() const MOZ_OVERRIDE MOZ_FINAL
{
return mVal->GetBaseValue().width;
}
float Height() const MOZ_OVERRIDE MOZ_FINAL
{
return mVal->GetBaseValue().height;
}
void SetX(float aX, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE;
void SetY(float aY, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE;
void SetWidth(float aWidth, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE;
void SetHeight(float aHeight, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE;
2013-05-16 18:06:21 +00:00
virtual nsIContent* GetParentObject() const MOZ_OVERRIDE
2013-05-16 18:06:21 +00:00
{
return mSVGElement;
}
private:
virtual ~DOMBaseVal();
};
struct DOMAnimVal MOZ_FINAL : public mozilla::dom::SVGIRect
{
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
2013-05-16 18:06:21 +00:00
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(DOMAnimVal)
DOMAnimVal(nsSVGViewBox *aVal, nsSVGElement *aSVGElement)
2013-05-16 18:06:21 +00:00
: mozilla::dom::SVGIRect()
, mVal(aVal)
, mSVGElement(aSVGElement)
{}
nsSVGViewBox* mVal; // kept alive because it belongs to content
nsRefPtr<nsSVGElement> mSVGElement;
// Script may have modified animation parameters or timeline -- DOM getters
// need to flush any resample requests to reflect these modifications.
float X() const MOZ_OVERRIDE MOZ_FINAL
{
mSVGElement->FlushAnimations();
return mVal->GetAnimValue().x;
}
float Y() const MOZ_OVERRIDE MOZ_FINAL
{
mSVGElement->FlushAnimations();
return mVal->GetAnimValue().y;
}
float Width() const MOZ_OVERRIDE MOZ_FINAL
{
mSVGElement->FlushAnimations();
return mVal->GetAnimValue().width;
}
float Height() const MOZ_OVERRIDE MOZ_FINAL
{
mSVGElement->FlushAnimations();
return mVal->GetAnimValue().height;
}
void SetX(float aX, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE
{
aRv.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR);
}
void SetY(float aY, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE
{
aRv.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR);
}
void SetWidth(float aWidth, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE
{
aRv.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR);
}
void SetHeight(float aHeight, mozilla::ErrorResult& aRv) MOZ_FINAL MOZ_OVERRIDE
{
aRv.Throw(NS_ERROR_DOM_NO_MODIFICATION_ALLOWED_ERR);
}
2013-05-16 18:06:21 +00:00
virtual nsIContent* GetParentObject() const MOZ_OVERRIDE
2013-05-16 18:06:21 +00:00
{
return mSVGElement;
}
private:
virtual ~DOMAnimVal();
};
struct SMILViewBox : public nsISMILAttr
{
public:
SMILViewBox(nsSVGViewBox* aVal, nsSVGElement* aSVGElement)
: mVal(aVal), mSVGElement(aSVGElement) {}
// These will stay alive because a nsISMILAttr only lives as long
// as the Compositing step, and DOM elements don't get a chance to
// die during that.
nsSVGViewBox* mVal;
nsSVGElement* mSVGElement;
// nsISMILAttr methods
virtual nsresult ValueFromString(const nsAString& aStr,
const mozilla::dom::SVGAnimationElement* aSrcElement,
nsSMILValue& aValue,
bool& aPreventCachingOfSandwich) const MOZ_OVERRIDE;
virtual nsSMILValue GetBaseValue() const MOZ_OVERRIDE;
virtual void ClearAnimValue() MOZ_OVERRIDE;
virtual nsresult SetAnimValue(const nsSMILValue& aValue) MOZ_OVERRIDE;
};
static nsSVGAttrTearoffTable<nsSVGViewBox, mozilla::dom::SVGAnimatedRect>
sSVGAnimatedRectTearoffTable;
};
#endif // __NS_SVGVIEWBOX_H__