donner::svg::PropertyRegistry Class Reference

Holds CSS properties for a single element. More...

#include "donner/svg/properties/PropertyRegistry.h"

Collaboration diagram for donner::svg::PropertyRegistry:

Public Member Functions
	PropertyRegistry ()
	Constructor.
	~PropertyRegistry ()
	Destructor.
	PropertyRegistry (const PropertyRegistry &)
	Copy constructor.
	PropertyRegistry (PropertyRegistry &&) noexcept
	Move constructor.
PropertyRegistry &	operator= (const PropertyRegistry &)
	Copy assignment operator.
PropertyRegistry &	operator= (PropertyRegistry &&) noexcept
	Move assignment operator.
auto	allProperties () const
	Return a tuple of all properties within the PropertyRegistry.
auto	allPropertiesMutable ()
	Return a mutable tuple of all properties within the PropertyRegistry.
PropertyRegistry	inheritFrom (const PropertyRegistry &parent, PropertyInheritOptions options=PropertyInheritOptions::All) const
	Inherit the value of each element in the stylesheet.
std::optional< parser::ParseError >	parseProperty (const css::Declaration &declaration, css::Specificity specificity)
	Parse a single declaration, adding it to the property registry.
void	parseStyle (std::string_view str)
	Parse a SVG style attribute, and set the parsed values on this PropertyRegistry.
parser::ParseResult< bool >	parsePresentationAttribute (std::string_view name, std::string_view value, std::optional< ElementType > type=std::nullopt, EntityHandle handle=EntityHandle())
	Parse a presentation attribute, which can contain a CSS value.

Static Public Member Functions
static constexpr size_t	numProperties ()
	Return the size of the tuple returned by allProperties().
template<size_t Start, size_t End, class F >
static constexpr void	forEachProperty (const F &f)
	Calls a compile time functor for each property in the registry.

Public Attributes
Property< css::Color, PropertyCascade::Inherit >	color
	color property, which stores the context color of the element. For painting shapes, use stroke or fill instead.
Property< Display >	display {"display", []() -> std::optional<Display> { return Display::Inline; }}
	display property, which determines how the element is rendered. Set to Display::None to hide the element.
Property< double >	opacity {"opacity", []() -> std::optional<double> { return 1.0; }}
	opacity property, which determines the opacity of the element. A value of 0.0 will make the element invisible.
Property< Visibility, PropertyCascade::Inherit >	visibility
	visibility property, which determines whether the element is visible. Set to Visibility::Hidden to hide the element. Compared to display with Display::None, hiding the element will not remove it from the document, so it will still contribute to bounding boxes.
Property< PaintServer, PropertyCascade::PaintInherit >	fill
	fill property, which determines the color of the element's interior. Defaults to black.
Property< FillRule, PropertyCascade::Inherit >	fillRule
	fill-rule property, which determines how the interior of the element is filled in the case of overlapping shapes. Defaults to FillRule::NonZero.
Property< double, PropertyCascade::Inherit >	fillOpacity
	fill-opacity property, which determines the opacity of the element's interior. Defaults to 1.0. A value of 0.0 will make the interior invisible.
Property< PaintServer, PropertyCascade::PaintInherit >	stroke
	stroke property, which determines the color of the element's outline stroke. Defaults to none.
Property< double, PropertyCascade::Inherit >	strokeOpacity
	stroke-opacity property, which determines the opacity of the element's outline stroke. Defaults to 1.0. A value of 0.0 will make the outline invisible.
Property< Lengthd, PropertyCascade::Inherit >	strokeWidth
	stroke-width property, which determines the width of the element's outline stroke. Defaults to 1.0.
Property< StrokeLinecap, PropertyCascade::Inherit >	strokeLinecap
	stroke-linecap property, which determines the shape of the element's outline stroke at the ends of the path. Defaults to StrokeLinecap::Butt.
Property< StrokeLinejoin, PropertyCascade::Inherit >	strokeLinejoin
	stroke-linejoin property, which determines the shape of the element's outline stroke in between line segments. Defaults to StrokeLinejoin::Miter.
Property< double, PropertyCascade::Inherit >	strokeMiterlimit
	stroke-miterlimit property, which determines the limit of the ratio of the miter length to the stroke width. Defaults to 4.0.
Property< StrokeDasharray, PropertyCascade::Inherit >	strokeDasharray
	stroke-dasharray property, which determines the pattern of dashes and gaps used to stroke paths.
Property< Lengthd, PropertyCascade::Inherit >	strokeDashoffset
	stroke-dashoffset property, which determines the distance into the dash pattern to start the stroke.
Property< Reference, PropertyCascade::None >	clipPath
	clip-path property, which determines the shape of the element's clipping region. Defaults to none.
Property< ClipRule, PropertyCascade::Inherit >	clipRule
	clip-rule property, which determines how the interior of the element is filled in the case of overlapping shapes. Defaults to ClipRule::NonZero.
Property< Reference, PropertyCascade::None >	mask
	mask property, which determines the shape of the element's clipping region. Defaults to none.
Property< FilterEffect >	filter
	filter property, which determines the filter effect to apply to the element. Defaults to none.
Property< PointerEvents, PropertyCascade::Inherit >	pointerEvents
	pointer-events property, which determines how the element responds to pointer events (such as clicks or hover). Defaults to PointerEvents::VisiblePainted.
std::map< RcString, parser::UnparsedProperty >	unparsedProperties
	Properties which don't have specific listings above, which are stored as raw css declarations.

Friends
std::ostream &	operator<< (std::ostream &os, const PropertyRegistry &registry)
	Ostream output operator, for debugging which outputs a human-readable representation of all of the properties.

Detailed Description

Holds CSS properties for a single element.

This class stores common properties which may be applied to any element, plus unparsedProperties which contains element-specific properties which are applied if the element matches.

For unparsedProperties, presentation attributes specified in CSS such as transform will be stored here until they can be applied to the element.

Supported properties

Property	Member	Default
color	color	black
display	display	inline
opacity	opacity	1.0
visibility	visibility	visible
fill	fill	black
fill-rule	fillRule	nonzero
fill-opacity	fillOpacity	1.0
stroke	stroke	none
stroke-opacity	strokeOpacity	1.0
stroke-width	strokeWidth	1.0
stroke-linecap	strokeLinecap	butt
stroke-linejoin	strokeLinejoin	miter
stroke-miterlimit	strokeMiterlimit	4.0
stroke-dasharray	strokeDasharray	none
stroke-dashoffset	strokeDashoffset	0
clip-path	clipPath	none
clip-rule	clipRule	nonzero
mask	mask	none
filter	filter	none
pointer-events	pointerEvents	auto

Member Function Documentation

allProperties()

auto donner::svg::PropertyRegistry::allProperties ( ) const

inline

Return a tuple of all properties within the PropertyRegistry.

To get the size of the tuple, use numProperties().

allPropertiesMutable()

auto donner::svg::PropertyRegistry::allPropertiesMutable ( )

inline

Return a mutable tuple of all properties within the PropertyRegistry.

See also

allProperties()

forEachProperty()

template<size_t Start, size_t End, class F >

static constexpr void donner::svg::PropertyRegistry::forEachProperty ( const F & f )

inlinestaticconstexpr

Calls a compile time functor for each property in the registry.

Example:

auto properties = allProperties();
forEachProperty<0, numProperties()>([&properties](auto i) {
  auto& property = std::get<i>(properties);
}

Template Parameters

Start	Index of the current property to call.
End	Total number of properties in the registry.
F	Type of the functor object, with signature void(std::integral_constant<size_t>).

Parameters

f	Functor instance.

inheritFrom()

PropertyRegistry donner::svg::PropertyRegistry::inheritFrom	(	const PropertyRegistry &	parent,
		PropertyInheritOptions	options = PropertyInheritOptions::All ) const

Inherit the value of each element in the stylesheet.

Parameters

parent	PropertyRegistry from this element's direct parent, where properties will be inherited from.
options	Options for how to inherit properties, which can be used to skip inheritance for a category of properties.

parsePresentationAttribute()

parser::ParseResult< bool > donner::svg::PropertyRegistry::parsePresentationAttribute	(	std::string_view	name,
		std::string_view	value,
		std::optional< ElementType >	type = std::nullopt,
		EntityHandle	handle = EntityHandle() )

Parse a presentation attribute, which can contain a CSS value.

See also

https://www.w3.org/TR/SVG2/styling.html#PresentationAttributes

Parameters

name	Name of the attribute.
value	Value of the attribute, parsed as a CSS value.
type	If set, parses additional presentation attributes for the given element type.
handle	Entity handle to use for parsing additional attributes.

Returns

true if the element supports this attribute and it was parsed successfully, or a donner::base::parser::ParseError if parsing failed.

parseProperty()

std::optional< parser::ParseError > donner::svg::PropertyRegistry::parseProperty	(	const css::Declaration &	declaration,
		css::Specificity	specificity )

Parse a single declaration, adding it to the property registry.

Parameters

declaration	Declaration to parse.
specificity	Specificity of the declaration.

Returns

Error if the declaration had errors parsing or the property is not supported.

parseStyle()

void donner::svg::PropertyRegistry::parseStyle

(

std::string_view

str

)

Parse a SVG style attribute, and set the parsed values on this PropertyRegistry.

Does not clear existing properties, new ones are applied additively.

Parses the string as a CSS "<declaration-list>", ignoring any parse errors or unsupported properties

Parameters

str	Input string from a style attribute, e.g. "fill: red; stroke: blue".

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const PropertyRegistry & registry )

friend

Ostream output operator, for debugging which outputs a human-readable representation of all of the properties.

Example output:

PropertyRegistry {
  color: Color(rgba(0, 255, 0, 255)) (set) @ Specificity(0, 0, 0)
}

Parameters

os	Output stream.
registry	PropertyRegistry to output.

Member Data Documentation

clipPath

Property<Reference, PropertyCascade::None> donner::svg::PropertyRegistry::clipPath

Initial value:

{
      "clip-path", []() -> std::optional<Reference> { return std::nullopt; }}

clip-path property, which determines the shape of the element's clipping region. Defaults to none.

clipRule

Property<ClipRule, PropertyCascade::Inherit> donner::svg::PropertyRegistry::clipRule

Initial value:

{
      "clip-rule", []() -> std::optional<ClipRule> { return ClipRule::NonZero; }}

clip-rule property, which determines how the interior of the element is filled in the case of overlapping shapes. Defaults to ClipRule::NonZero.

color

Property<css::Color, PropertyCascade::Inherit> donner::svg::PropertyRegistry::color

Initial value:

{
      "color", []() -> std::optional<css::Color> { return css::Color(css::RGBA(0, 0, 0, 0xFF)); }}

color property, which stores the context color of the element. For painting shapes, use stroke or fill instead.

fill

Property<PaintServer, PropertyCascade::PaintInherit> donner::svg::PropertyRegistry::fill

Initial value:

{
      "fill", []() -> std::optional<PaintServer> {
        return PaintServer::Solid(css::Color(css::RGBA::RGB(0, 0, 0)));
      }}

fill property, which determines the color of the element's interior. Defaults to black.

fillOpacity

Property<double, PropertyCascade::Inherit> donner::svg::PropertyRegistry::fillOpacity

Initial value:

{
      "fill-opacity", []() -> std::optional<double> { return 1.0; }}

fill-opacity property, which determines the opacity of the element's interior. Defaults to 1.0. A value of 0.0 will make the interior invisible.

fillRule

Property<FillRule, PropertyCascade::Inherit> donner::svg::PropertyRegistry::fillRule

Initial value:

{
      "fill-rule", []() -> std::optional<FillRule> { return FillRule::NonZero; }}

fill-rule property, which determines how the interior of the element is filled in the case of overlapping shapes. Defaults to FillRule::NonZero.

filter

Property<FilterEffect> donner::svg::PropertyRegistry::filter

Initial value:

{
      "filter", []() -> std::optional<FilterEffect> { return FilterEffect::None(); }}

filter property, which determines the filter effect to apply to the element. Defaults to none.

mask

Property<Reference, PropertyCascade::None> donner::svg::PropertyRegistry::mask

Initial value:

{
      "mask", []() -> std::optional<Reference> { return std::nullopt; }}

mask property, which determines the shape of the element's clipping region. Defaults to none.

pointerEvents

Property<PointerEvents, PropertyCascade::Inherit> donner::svg::PropertyRegistry::pointerEvents

Initial value:

{
      "pointer-events",
      []() -> std::optional<PointerEvents> { return PointerEvents::VisiblePainted; }}

pointer-events property, which determines how the element responds to pointer events (such as clicks or hover). Defaults to PointerEvents::VisiblePainted.

stroke

Property<PaintServer, PropertyCascade::PaintInherit> donner::svg::PropertyRegistry::stroke

Initial value:

{
      "stroke", []() -> std::optional<PaintServer> { return PaintServer::None(); }}

stroke property, which determines the color of the element's outline stroke. Defaults to none.

strokeDasharray

Property<StrokeDasharray, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeDasharray

Initial value:

{
      "stroke-dasharray", []() -> std::optional<StrokeDasharray> { return std::nullopt; }}

stroke-dasharray property, which determines the pattern of dashes and gaps used to stroke paths.

strokeDashoffset

Property<Lengthd, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeDashoffset

Initial value:

{
      "stroke-dashoffset",
      []() -> std::optional<Lengthd> { return Lengthd(0, Lengthd::Unit::None); }}

stroke-dashoffset property, which determines the distance into the dash pattern to start the stroke.

strokeLinecap

Property<StrokeLinecap, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeLinecap

Initial value:

{
      "stroke-linecap", []() -> std::optional<StrokeLinecap> { return StrokeLinecap::Butt; }}

stroke-linecap property, which determines the shape of the element's outline stroke at the ends of the path. Defaults to StrokeLinecap::Butt.

strokeLinejoin

Property<StrokeLinejoin, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeLinejoin

Initial value:

{
      "stroke-linejoin", []() -> std::optional<StrokeLinejoin> { return StrokeLinejoin::Miter; }}

stroke-linejoin property, which determines the shape of the element's outline stroke in between line segments. Defaults to StrokeLinejoin::Miter.

strokeMiterlimit

Property<double, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeMiterlimit

Initial value:

{
      "stroke-miterlimit", []() -> std::optional<double> { return 4.0; }}

stroke-miterlimit property, which determines the limit of the ratio of the miter length to the stroke width. Defaults to 4.0.

strokeOpacity

Property<double, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeOpacity

Initial value:

{
      "stroke-opacity", []() -> std::optional<double> { return 1.0; }}

stroke-opacity property, which determines the opacity of the element's outline stroke. Defaults to 1.0. A value of 0.0 will make the outline invisible.

strokeWidth

Property<Lengthd, PropertyCascade::Inherit> donner::svg::PropertyRegistry::strokeWidth

Initial value:

{
      "stroke-width", []() -> std::optional<Lengthd> { return Lengthd(1, Lengthd::Unit::None); }}

stroke-width property, which determines the width of the element's outline stroke. Defaults to 1.0.

visibility

Property<Visibility, PropertyCascade::Inherit> donner::svg::PropertyRegistry::visibility

Initial value:

{
      "visibility", []() -> std::optional<Visibility> { return Visibility::Visible; }}

visibility property, which determines whether the element is visible. Set to Visibility::Hidden to hide the element. Compared to display with Display::None, hiding the element will not remove it from the document, so it will still contribute to bounding boxes.

---

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

• donner/svg/properties/PropertyRegistry.h
• donner/svg/properties/PropertyRegistry.cc