Base class for elements that support per-glyph positioning attributes (x, y, dx, dy, rotate) on top of the basic text content interface. More...

#include "donner/svg/SVGTextPositioningElement.h"

Inheritance diagram for donner::svg::SVGTextPositioningElement:

[legend]

Collaboration diagram for donner::svg::SVGTextPositioningElement:

[legend]

Public Member Functions
void	setX (std::optional< Lengthd > value)
	Sets the x attribute list to a single value (absolute x-position).
std::optional< Lengthd >	x () const
	Gets the first x attribute value (absolute x-position) from the list.
void	setXList (SmallVector< Lengthd, 1 > &&value)
	Sets the x attribute list (absolute x-position for each character).
const SmallVector< Lengthd, 1 > &	xList () const
	Gets the x attribute list (absolute x-position for each character).
void	setY (std::optional< Lengthd > value)
	Sets the y attribute list to a single value (absolute y-position).
std::optional< Lengthd >	y () const
	Gets the first y attribute value (absolute y-position) from the list.
void	setYList (SmallVector< Lengthd, 1 > &&value)
	Sets the y attribute list (absolute y-position for each character).
const SmallVector< Lengthd, 1 > &	yList () const
	Gets the y attribute list (absolute y-position for each character).
void	setDx (std::optional< Lengthd > value)
	Sets the dx attribute list to a single value (relative shift in x).
std::optional< Lengthd >	dx () const
	Gets the first dx attribute value (relative shift in x) from the list.
void	setDxList (SmallVector< Lengthd, 1 > &&value)
	Sets the dx attribute list (relative shift in x for each character).
const SmallVector< Lengthd, 1 > &	dxList () const
	Gets the dx attribute list (relative shift in x for each character).
void	setDy (std::optional< Lengthd > value)
	Sets the dy attribute list to a single value (relative shift in y).
std::optional< Lengthd >	dy () const
	Gets the first dy attribute value (relative shift in y) from the list.
void	setDyList (SmallVector< Lengthd, 1 > &&value)
	Sets the dy attribute list (relative shift in y for each character).
const SmallVector< Lengthd, 1 > &	dyList () const
	Gets the dy attribute list (relative shift in y for each character).
void	setRotate (std::optional< double > degrees)
	Sets the rotate attribute list to a single value (rotation in degrees).
std::optional< double >	rotate () const
	Gets the first rotate attribute value from the list.
void	setRotateList (SmallVector< double, 1 > &&value)
	Sets the rotate attribute list (rotation in degrees for each character).
const SmallVector< double, 1 > &	rotateList () const
	Gets the rotate attribute list (rotation in degrees for each character).
Public Member Functions inherited from donner::svg::SVGTextContentElement
std::optional< Lengthd >	textLength () const
	Returns the textLength attribute (the author's intended length for the text).
void	setTextLength (std::optional< Lengthd > value)
	Sets the textLength attribute, which indicates the author-computed total length for the text layout.
LengthAdjust	lengthAdjust () const
	Returns the lengthAdjust attribute, which controls how the text is stretched or spaced to fit the textLength.
void	setLengthAdjust (LengthAdjust value)
	Controls how the text is stretched or spaced to fit the textLength.
long	getNumberOfChars () const
	Returns the total number of addressable characters in the element.
double	getComputedTextLength () const
	Computes the total advance distance for all glyphs.
double	getSubStringLength (std::size_t charnum, std::size_t nchars) const
	Computes the advance distance for a substring of text.
Vector2d	getStartPositionOfChar (std::size_t charnum) const
	Returns the start position (in user space) of the glyphs corresponding to the given character index.
Vector2d	getEndPositionOfChar (std::size_t charnum) const
	Returns the end position (in user space) of the glyphs corresponding to the given character index.
Boxd	getExtentOfChar (std::size_t charnum) const
	Returns the bounding box of the glyph cell for the specified character, in the element's coordinate space.
double	getRotationOfChar (std::size_t charnum) const
	Returns the rotation applied to the glyphs corresponding to the given character index, in degrees.
long	getCharNumAtPosition (const Vector2d &point) const
	Given a point in the element's coordinate space, returns which character is rendered at that point.
void	selectSubString (std::size_t charnum, std::size_t nchars)
	Select a substring of characters for user operations (e.g.
void	appendText (std::string_view text)
	Append text content from text or CDATA nodes.
RcString	textContent () const
	Get the raw text content concatenated from all child text nodes.
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.
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.
void	updateStyle (std::string_view style)
	Update the element style, adding new attributes or overridding existing ones (without removing them).
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 constexpr bool	IsBaseOf (ElementType type)
	Returns true if the given element type can be cast to SVGTextPositioningElement.
Static Public Member Functions inherited from donner::svg::SVGTextContentElement
static constexpr bool	IsBaseOf (ElementType type)
	Returns true if the given element type can be cast to SVGTextContentElement.
Static Public Member Functions inherited from donner::svg::SVGGraphicsElement
static constexpr bool	IsBaseOf (ElementType type)
	Returns true if the given element type can be cast to SVGTextContentElement.

Protected Member Functions
	SVGTextPositioningElement (EntityHandle handle)
	Inheriting constructor to be called by derived classes.
Protected Member Functions inherited from donner::svg::SVGTextContentElement
	SVGTextContentElement (EntityHandle handle)
	Inheriting constructor to be called by derived classes.
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.

Friends
class	parser::SVGParserImpl

Additional Inherited Members
Static Protected Member Functions inherited from donner::svg::SVGElement
static EntityHandle	CreateEmptyEntity (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.
Protected Attributes inherited from donner::svg::SVGElement
EntityHandle	handle_
	The underlying ECS Entity for this element, which holds all data.

Detailed Description

Base class for elements that support per-glyph positioning attributes (x, y, dx, dy, rotate) on top of the basic text content interface.

This corresponds to the W3C IDL interface SVGTextPositioningElement.

These attributes can contain a list of values, one for each character. The methods here provide access to either the first value in the list (for convenience) or the entire list.

See also: https://www.w3.org/TR/SVG2/text.html#InterfaceSVGTextPositioningElement

Constructor & Destructor Documentation

◆ SVGTextPositioningElement()

donner::svg::SVGTextPositioningElement::SVGTextPositioningElement ( EntityHandle handle )

explicitprotected

Inheriting constructor to be called by derived classes.

SVGTextPositioningElement cannot be instantiated directly.

Parameters

handle The handle to the underlying entity.

Member Function Documentation

◆ dx()

std::optional< Lengthd > donner::svg::SVGTextPositioningElement::dx ( ) const

Gets the first dx attribute value (relative shift in x) from the list.

Returns: The first coordinate value if the list is not empty, otherwise std::nullopt.

◆ dxList()

const SmallVector< Lengthd, 1 > & donner::svg::SVGTextPositioningElement::dxList ( ) const

Gets the dx attribute list (relative shift in x for each character).

Returns: Const reference to the list of coordinate values.

◆ dy()

std::optional< Lengthd > donner::svg::SVGTextPositioningElement::dy ( ) const

Gets the first dy attribute value (relative shift in y) from the list.

Returns: The first coordinate value if the list is not empty, otherwise std::nullopt.

◆ dyList()

const SmallVector< Lengthd, 1 > & donner::svg::SVGTextPositioningElement::dyList ( ) const

Gets the dy attribute list (relative shift in y for each character).

Returns: Const reference to the list of coordinate values.

◆ rotate()

std::optional< double > donner::svg::SVGTextPositioningElement::rotate ( ) const

Gets the first rotate attribute value from the list.

Returns: Rotation in degrees if the list is not empty, otherwise std::nullopt.

◆ rotateList()

const SmallVector< double, 1 > & donner::svg::SVGTextPositioningElement::rotateList ( ) const

Gets the rotate attribute list (rotation in degrees for each character).

Returns: Const reference to the list of rotation values in degrees.

◆ setDx()

void donner::svg::SVGTextPositioningElement::setDx ( std::optional< Lengthd > value )

Sets the dx attribute list to a single value (relative shift in x).

Any existing values in the list are replaced.

Parameters

value Coordinate value, or std::nullopt to clear the list.

◆ setDxList()

void donner::svg::SVGTextPositioningElement::setDxList ( SmallVector< Lengthd, 1 > && value )

Sets the dx attribute list (relative shift in x for each character).

Parameters

value List of coordinate values.

◆ setDy()

void donner::svg::SVGTextPositioningElement::setDy ( std::optional< Lengthd > value )

Sets the dy attribute list to a single value (relative shift in y).

Any existing values in the list are replaced.

Parameters

value Coordinate value, or std::nullopt to clear the list.

◆ setDyList()

void donner::svg::SVGTextPositioningElement::setDyList ( SmallVector< Lengthd, 1 > && value )

Sets the dy attribute list (relative shift in y for each character).

Parameters

value List of coordinate values.

◆ setRotate()

void donner::svg::SVGTextPositioningElement::setRotate ( std::optional< double > degrees )

Sets the rotate attribute list to a single value (rotation in degrees).

Any existing values in the list are replaced.

Parameters

degrees Rotation in degrees, or std::nullopt to clear the list.

◆ setRotateList()

void donner::svg::SVGTextPositioningElement::setRotateList ( SmallVector< double, 1 > && value )

Sets the rotate attribute list (rotation in degrees for each character).

Parameters

value List of rotation values in degrees.

◆ setX()

void donner::svg::SVGTextPositioningElement::setX ( std::optional< Lengthd > value )

Sets the x attribute list to a single value (absolute x-position).

Any existing values in the list are replaced.

Parameters

value Coordinate value, or std::nullopt to clear the list.

◆ setXList()

void donner::svg::SVGTextPositioningElement::setXList ( SmallVector< Lengthd, 1 > && value )

Sets the x attribute list (absolute x-position for each character).

Parameters

value List of coordinate values.

◆ setY()

void donner::svg::SVGTextPositioningElement::setY ( std::optional< Lengthd > value )

Sets the y attribute list to a single value (absolute y-position).

Any existing values in the list are replaced.

Parameters

value Coordinate value, or std::nullopt to clear the list.

◆ setYList()

void donner::svg::SVGTextPositioningElement::setYList ( SmallVector< Lengthd, 1 > && value )

Sets the y attribute list (absolute y-position for each character).

Parameters

value List of coordinate values.

◆ x()

std::optional< Lengthd > donner::svg::SVGTextPositioningElement::x ( ) const

Gets the first x attribute value (absolute x-position) from the list.

Returns: The first coordinate value if the list is not empty, otherwise std::nullopt.

◆ xList()

const SmallVector< Lengthd, 1 > & donner::svg::SVGTextPositioningElement::xList ( ) const

Gets the x attribute list (absolute x-position for each character).

Returns: Const reference to the list of coordinate values.

◆ y()

std::optional< Lengthd > donner::svg::SVGTextPositioningElement::y ( ) const

Gets the first y attribute value (absolute y-position) from the list.

Returns: The first coordinate value if the list is not empty, otherwise std::nullopt.

◆ yList()

const SmallVector< Lengthd, 1 > & donner::svg::SVGTextPositioningElement::yList ( ) const

Gets the y attribute list (absolute y-position for each character).

Returns: Const reference to the list of coordinate values.

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

donner/svg/SVGTextPositioningElement.h
donner/svg/SVGTextPositioningElement.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SVGTextPositioningElement()

Member Function Documentation

◆ dx()

◆ dxList()

◆ dy()

◆ dyList()

◆ rotate()

◆ rotateList()

◆ setDx()

◆ setDxList()

◆ setDy()

◆ setDyList()

◆ setRotate()

◆ setRotateList()

◆ setX()

◆ setXList()

◆ setY()

◆ setYList()

◆ x()

◆ xList()

◆ y()

◆ yList()