donner::svg::SVGImageElement Class Reference

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

#include "donner/svg/SVGImageElement.h"

Inheritance diagram for donner::svg::SVGImageElement:

Collaboration diagram for donner::svg::SVGImageElement:

Public Member Functions
void	setHref (RcStringOrRef value)
	Set the href attribute.
RcString	href () const
	Get the href attribute.
void	setPreserveAspectRatio (PreserveAspectRatio preserveAspectRatio)
	Set the preserveAspectRatio attribute, which defines how to scale the image to fit the rectangle defined by width and height if the image's intrinsic size doesn't match.
PreserveAspectRatio	preserveAspectRatio () const
	The value of the preserveAspectRatio attribute, which defines how to scale the image to fit the rectangle defined by width and height if the image's intrinsic size doesn't match.
void	setX (Lengthd value)
	Set the X coordinate.
Lengthd	x () const
	Get the X coordinate.
void	setY (Lengthd value)
	Set the Y coordinate.
Lengthd	y () const
	Get the Y coordinate.
void	setWidth (std::optional< Lengthd > value)
	Set the width, or std::nullopt to use the image's intrinsic width.
std::optional< Lengthd >	width () const
	Get the width.
void	setHeight (std::optional< Lengthd > value)
	Set the height, or std::nullopt to use the image's intrinsic height.
std::optional< Lengthd >	height () const
	Get the height.
Public Member Functions inherited from donner::svg::SVGGraphicsElement
Transformd	transform () const
	Get the 2d transformation for this element, element-from-parent.
void	setTransform (const Transformd &transform)
	Set the 2d transformation for this element, element-from-parent. This is a no-op if the transform is identity.
Transformd	elementFromWorld () const
	Get the absolute element-from-world transform for this 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.
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.
Entity	entity () const
	Get the underlying Entity, 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 XMLQualifiedNameRef &name) const
	Returns true if the element has an attribute with the given name.
std::optional< RcString >	getAttribute (const XMLQualifiedNameRef &name) const
	Get the value of an attribute, if it exists.
SmallVector< XMLQualifiedNameRef, 1 >	findMatchingAttributes (const XMLQualifiedNameRef &matcher) const
	Find attributes matching the given name matcher.
void	setAttribute (const 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 XMLQualifiedNameRef &name)
	Remove an attribute, which may be either a presentation attribute or custom user-provided attribute.
SVGDocument &	ownerDocument ()
	Get the SVGDocument that holds 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.
SVGElement	insertBefore (SVGElement newNode, std::optional< SVGElement > referenceNode)
	Insert newNode as a child, before referenceNode.
SVGElement	appendChild (SVGElement child)
	Append child as a child of the current node.
SVGElement	replaceChild (SVGElement newChild, SVGElement oldChild)
	Replace oldChild with newChild in the tree, removing oldChild and inserting newChild in its place.
SVGElement	removeChild (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 SVGImageElement	Create (SVGDocument &document)
	Create a new "<image>" element.

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

Additional Inherited Members
Protected Member Functions inherited from donner::svg::SVGGraphicsElement
	SVGGraphicsElement (EntityHandle handle)
	Inheriting constructor to be called by derived classes. SVGGraphicsElement cannot be instantiated directly.
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 inherited from donner::svg::SVGElement
static EntityHandle	CreateEntity (Registry &registry, const XMLQualifiedNameRef &tagName, ElementType Type)
	Create a new Entity of the given type.
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 "<image>" element.

Use the href, x, y, width, and height attributes to define the image.

Member Function Documentation

Create()

SVGImageElement donner::svg::SVGImageElement::Create ( SVGDocument & document )

static

Create a new "<image>" element.

Parameters

document

Containing document.

setHeight()

void donner::svg::SVGImageElement::setHeight

(

std::optional< Lengthd >

value

)

Set the height, or std::nullopt to use the image's intrinsic height.

Parameters

value

Height value.

setHref()

void donner::svg::SVGImageElement::setHref

(

RcStringOrRef

value

)

Set the href attribute.

Parameters

value

URL or base64 data string of the image.

setPreserveAspectRatio()

void donner::svg::SVGImageElement::setPreserveAspectRatio

(

PreserveAspectRatio

preserveAspectRatio

)

Set the preserveAspectRatio attribute, which defines how to scale the image to fit the rectangle defined by width and height if the image's intrinsic size doesn't match.

Parameters

preserveAspectRatio

The preserveAspectRatio value to set.

setWidth()

void donner::svg::SVGImageElement::setWidth

(

std::optional< Lengthd >

value

)

Set the width, or std::nullopt to use the image's intrinsic width.

Parameters

value

Width value.

setX()

void donner::svg::SVGImageElement::setX

(

Lengthd

value

)

Set the X coordinate.

Parameters

value

Coordinate value.

setY()

void donner::svg::SVGImageElement::setY

(

Lengthd

value

)

Set the Y coordinate.

Parameters

value

Coordinate value.

---

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

• donner/svg/SVGImageElement.h
• donner/svg/SVGImageElement.cc