donner::svg::SVGUseElement Class Reference

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

#include "donner/svg/SVGUseElement.h"

Inheritance diagram for donner::svg::SVGUseElement:

Collaboration diagram for donner::svg::SVGUseElement:

Public Member Functions
void	setHref (const RcString &value)
	Set the URI to the element to reuse.
void	setX (Lengthd value)
	Set the X coordinate to position the referenced element.
void	setY (Lengthd value)
	Set the Y coordinate to position the referenced element.
void	setWidth (std::optional< Lengthd > value)
	Set the width to scale the referenced element.
void	setHeight (std::optional< Lengthd > value)
	Set the height to scale the referenced element.
RcString	href () const
	Get the URI to the element to reuse.
Lengthd	x () const
	Get the X coordinate to position the referenced element.
Lengthd	y () const
	Get the Y coordinate to position the referenced element.
std::optional< Lengthd >	width () const
	Get the width to scale the referenced element.
std::optional< Lengthd >	height () const
	Get the height to scale the referenced element.
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 SVGUseElement	Create (SVGDocument &document)
	Create a new "<use>" element.

Static Public Attributes
static constexpr ElementType	Type = ElementType::Use
	Element type.
static constexpr std::string_view	Tag {"use"}
	XML tag name, "<use>".

Protected Member Functions
	SVGUseElement (EntityHandle handle)
	Create an SVGUseElement object.
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 SVGUseElement	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 "<use>" element.

<svg width="200" height="100">
  <circle id="a" cx="50" cy="50" r="40" stroke="blue" />
  <use href="#a" x="100" fill="blue" />
</svg>

Attribute	Default	Description
x	0	X coordinate to position the referenced element.
y	0	Y coordinate to position the referenced element.
width	auto	Width of the referenced element.
height	auto	Height of the referenced element.
href	(none)	URI to the element to reuse.

Member Function Documentation

Create()

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

inlinestatic

Create a new "<use>" element.

Parameters

document

Containing document.

CreateOn()

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

staticprotected

Internal constructor to create the element on an existing Entity.

Parameters

handle

Entity handle.

setHeight()

void donner::svg::SVGUseElement::setHeight

(

std::optional< Lengthd >

value

)

Set the height to scale the referenced element.

Parameters

value

Height to scale the referenced element.

setHref()

void donner::svg::SVGUseElement::setHref

(

const RcString &

value

)

Set the URI to the element to reuse.

Parameters

value

URI to the element to reuse, such as #elementId

setWidth()

void donner::svg::SVGUseElement::setWidth

(

std::optional< Lengthd >

value

)

Set the width to scale the referenced element.

Parameters

value

Width to scale the referenced element.

setX()

void donner::svg::SVGUseElement::setX

(

Lengthd

value

)

Set the X coordinate to position the referenced element.

Parameters

value

X coordinate to position the referenced element.

setY()

void donner::svg::SVGUseElement::setY

(

Lengthd

value

)

Set the Y coordinate to position the referenced element.

Parameters

value

Y coordinate to position the referenced element.

---

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

• donner/svg/SVGUseElement.h
• donner/svg/SVGUseElement.cc