DOM object for a "<linearGradient>" element. More...

#include "donner/svg/SVGLinearGradientElement.h"

Inheritance diagram for donner::svg::SVGLinearGradientElement:

Collaboration diagram for donner::svg::SVGLinearGradientElement:

Public Member Functions
void	setX1 (std::optional< Lengthd > value)
	Set the start X coordinate.

void	setY1 (std::optional< Lengthd > value)
	Set the start Y coordinate.

void	setX2 (std::optional< Lengthd > value)
	Set the end X coordinate.

void	setY2 (std::optional< Lengthd > value)
	Set the end Y coordinate.

std::optional< Lengthd >	x1 () const
	Get the start Y coordinate.

std::optional< Lengthd >	y1 () const
	Get the start Y coordinate.

std::optional< Lengthd >	x2 () const
	Get the end X coordinate.

std::optional< Lengthd >	y2 () const
	Get the end Y coordinate.

Public Member Functions inherited from donner::svg::SVGGradientElement
std::optional< RcString >	href () const
	`href` attribute to allow inheriting attributes from another gradient.

GradientUnits	gradientUnits () const
	`gradientUnits` attribute to specify the coordinate system for the gradient.

Transformd	gradientTransform () const
	`gradientTransform` attribute to specify a transform to apply to the gradient.

GradientSpreadMethod	spreadMethod () const
	`spreadMethod` attribute to specify how to fill the area outside the gradient.

void	setHref (const std::optional< RcString > &value)
	`href` attribute to allow inheriting attributes from another gradient.

void	setGradientUnits (GradientUnits value)
	`gradientUnits` attribute to specify the coordinate system for the gradient.

void	setGradientTransform (const Transformd &value)
	`gradientTransform` attribute to specify a transform to apply to the gradient.

void	setSpreadMethod (GradientSpreadMethod value)
	`spreadMethod` attribute to specify how to fill the area outside the gradient.

Public Member Functions inherited from donner::svg::SVGElement
	SVGElement (const SVGElement &other)
	Create another reference to the same SVGElement.

	SVGElement (SVGElement &&other) noexcept
	Move constructor.

	~SVGElement () noexcept=default
	Destructor.

SVGElement &	operator= (const SVGElement &other)
	Create another reference to the same SVGElement.

SVGElement &	operator= (SVGElement &&other) noexcept
	Move assignment operator.

ElementType	type () const
	Get the ElementType for known XML element types.

xml::XMLQualifiedNameRef	tagName () const
	Get the XML tag name string for this element.

bool	isKnownType () const
	Returns true if this is a known element type, returns false if this is an SVGUnknownElement.

EntityHandle	entityHandle () const
	Get the underlying EntityHandle, for advanced use-cases that require direct access to the ECS.

RcString	id () const
	Get the element id, the value of the "id" attribute.

void	setId (std::string_view id)
	Set the element id, the value of the "id" attribute.

RcString	className () const
	Get the element class name, the value of the "class" attribute.

void	setClassName (std::string_view name)
	Set the element class name, the value of the "class" attribute.

void	setStyle (std::string_view style)
	Set the element style, the value of the "style" attribute.

base::parser::ParseResult< bool >	trySetPresentationAttribute (std::string_view name, std::string_view value)
	Set the value of a presentation attribute, such as "fill" or "stroke".

bool	hasAttribute (const xml::XMLQualifiedNameRef &name) const
	Returns true if the element has an attribute with the given name.

std::optional< RcString >	getAttribute (const xml::XMLQualifiedNameRef &name) const
	Get the value of an attribute, if it exists.

SmallVector< xml::XMLQualifiedNameRef, 1 >	findMatchingAttributes (const xml::XMLQualifiedNameRef &matcher) const
	Find attributes matching the given name matcher.

void	setAttribute (const xml::XMLQualifiedNameRef &name, std::string_view value)
	Set the value of a generic XML attribute, which may be either a presentation attribute or custom user-provided attribute.

void	removeAttribute (const xml::XMLQualifiedNameRef &name)
	Remove an attribute, which may be either a presentation attribute or custom user-provided attribute.

SVGDocument	ownerDocument ()
	Get an owning reference to the SVGDocument containing this element.

std::optional< SVGElement >	parentElement () const
	Get this element's parent, if it exists.

std::optional< SVGElement >	firstChild () const
	Get the first child of this element, if it exists.

std::optional< SVGElement >	lastChild () const
	Get the last child of this element, if it exists.

std::optional< SVGElement >	previousSibling () const
	Get the previous sibling of this element, if it exists.

std::optional< SVGElement >	nextSibling () const
	Get the next sibling of this element, if it exists.

void	insertBefore (const SVGElement &newNode, std::optional< SVGElement > referenceNode)
	Insert `newNode` as a child, before `referenceNode`.

void	appendChild (const SVGElement &child)
	Append `child` as a child of the current node.

void	replaceChild (const SVGElement &newChild, const SVGElement &oldChild)
	Replace `oldChild` with `newChild` in the tree, removing `oldChild` and inserting `newChild` in its place.

void	removeChild (const SVGElement &child)
	Remove `child` from this node.

void	remove ()
	Remove this node from its parent, if it has one.

bool	operator== (const SVGElement &other) const
	Returns true if the two SVGElement handles reference the same underlying document.

bool	operator!= (const SVGElement &other) const
	Returns true if the two SVGElement handles reference the same underlying document.

template<typename Derived >
bool	isa () const
	Return true if this element "is a" instance of type, if it be cast to a specific type with cast.

template<typename Derived >
Derived	cast ()
	Cast this element to its derived type.

template<typename Derived >
Derived	cast () const
	Cast this element to its derived type (const version).

template<typename Derived >
std::optional< Derived >	tryCast ()
	Cast this element to its derived type, if possible.

template<typename Derived >
std::optional< const Derived >	tryCast () const
	Cast this element to its derived type, if possible.

std::optional< SVGElement >	querySelector (std::string_view selector)
	Find the first element in the tree that matches the given CSS selector.

const PropertyRegistry &	getComputedStyle () const
	Get the computed CSS style of this element, after the CSS cascade.

Static Public Member Functions
static SVGLinearGradientElement	Create (SVGDocument &document)
	Create a new "<linearGradient>" element.

Static Public Attributes
static constexpr ElementType	Type = ElementType::LinearGradient
	Element type.

static constexpr std::string_view	Tag {"linearGradient"}
	XML tag name, "<linearGradient>".

Protected Member Functions
	SVGLinearGradientElement (EntityHandle handle)
	Create an SVGLinearGradientElement wrapper from an entity.

Protected Member Functions inherited from donner::svg::SVGGradientElement
	SVGGradientElement (EntityHandle handle)
	Constructor for SVGGradientElement, which must be constructed from a derived class.

Protected Member Functions inherited from donner::svg::SVGElement
	SVGElement (EntityHandle handle)
	Internal constructor to create an SVGElement from an EntityHandle.

Registry &	registry () const
	Get the underlying ECS Registry, which holds all data for the document, for advanced use.

EntityHandle	toHandle (Entity entity) const
	Convert an Entity to an EntityHandle, for advanced use.

Static Protected Member Functions
static SVGLinearGradientElement	CreateOn (EntityHandle handle)
	Internal constructor to create the element on an existing Entity.

Static Protected Member Functions inherited from donner::svg::SVGElement
static EntityHandle	CreateEntity (SVGDocument &document)
	Create a new Entity within the document ECS, and return a handle to it.

static void	CreateEntityOn (EntityHandle handle, const xml::XMLQualifiedNameRef &tagName, ElementType Type)
	Create a new SVG element instance on a given Entity.

Friends
class	parser::SVGParserImpl

Additional Inherited Members
Protected Attributes inherited from donner::svg::SVGElement
EntityHandle	handle_
	The underlying ECS Entity for this element, which holds all data.

Detailed Description

DOM object for a "<linearGradient>" element.

<linearGradient id="MyGradient">
  <stop offset="0%" stop-color="blue" />
  <stop offset="100%" stop-color="yellow" />
</linearGradient>

To reference it with a fill:

To control the direction of the gradient, use the x1, y1, x2, and y2 attributes, which define a line that defines the start and stop of the gradient.

Attribute	Default	Description
`x1`	`0%`	Start X coordinate.
`y1`	`0%`	Start Y coordinate.
`x2`	`100%`	End X coordinate.
`y2`	`100%`	End Y coordinate.
`gradientUnits`	`objectBoundingBox`	The coordinate system for the gradient, either `userSpaceOnUse` or `objectBoundingBox`.
`gradientTransform`	(none)	A transform to apply to the gradient.
`spreadMethod`	`pad`	How to handle colors outside the gradient. Either `pad`, `reflect`, or `repeat`.
`href`	(none)	A URL reference to a template gradient element, which is then used as a template for this gradient. Example: `<linearGradient id="MyGradient" href="#MyGradient2" />`

See also: SVGRadialGradientElement, SVGStopElement

Member Function Documentation

◆ Create()

static SVGLinearGradientElement donner::svg::SVGLinearGradientElement::Create ( SVGDocument & document )

inlinestatic

Create a new "<linearGradient>" element.

Parameters

document Containing document.

◆ CreateOn()

SVGLinearGradientElement donner::svg::SVGLinearGradientElement::CreateOn ( EntityHandle handle )

staticprotected

Internal constructor to create the element on an existing Entity.

Parameters

handle Entity handle.

◆ setX1()

void donner::svg::SVGLinearGradientElement::setX1 ( std::optional< Lengthd > value )

Set the start X coordinate.

Parameters

value Coordinate value, or std::nullopt to remove the attribute.

◆ setX2()

void donner::svg::SVGLinearGradientElement::setX2 ( std::optional< Lengthd > value )

Set the end X coordinate.

Parameters

value Coordinate value, or std::nullopt to remove the attribute.

◆ setY1()

void donner::svg::SVGLinearGradientElement::setY1 ( std::optional< Lengthd > value )

Set the start Y coordinate.

Parameters

value Coordinate value, or std::nullopt to remove the attribute.

◆ setY2()

void donner::svg::SVGLinearGradientElement::setY2 ( std::optional< Lengthd > value )

Set the end Y coordinate.

Parameters

value Coordinate value, or std::nullopt to remove the attribute.

◆ x1()

std::optional< Lengthd > donner::svg::SVGLinearGradientElement::x1 ( ) const

Get the start Y coordinate.

Note that at render-time, this will default to 0% if not set.

◆ x2()

std::optional< Lengthd > donner::svg::SVGLinearGradientElement::x2 ( ) const

Get the end X coordinate.

Note that at render-time, this will default to 100% if not set.

◆ y1()

std::optional< Lengthd > donner::svg::SVGLinearGradientElement::y1 ( ) const

Get the start Y coordinate.

Note that at render-time, this will default to 0% if not set.

◆ y2()

std::optional< Lengthd > donner::svg::SVGLinearGradientElement::y2 ( ) const

Get the end Y coordinate.

Note that at render-time, this will default to 100% if not set.

The documentation for this class was generated from the following files:

donner/svg/SVGLinearGradientElement.h
donner/svg/SVGLinearGradientElement.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Create()

◆ CreateOn()

◆ setX1()

◆ setX2()

◆ setY1()

◆ setY2()

◆ x1()

◆ x2()

◆ y1()

◆ y2()