A view node (spec 5 §9). The kind's own properties come from its builder's options; the properties every node takes come from the member functions, each of which returns a copy with the property set. More...

#include <author.hpp>

Public Member Functions
	Node (Json json, CatalogFacts facts={})
	A node over its JSON, for a kind no builder spells.
Json const &	json () const noexcept
	The node's JSON.
CatalogFacts const &	facts () const noexcept
	The catalog facts of the models and actions the node names.
Node	with (std::string const &key, AnyHandle const &value) const
	A property set to an expression; an absent expression leaves the node as it is.
Node	withText (std::string const &key, std::string const &value) const
	A property set to a plain string.
Node	id (Element const &element) const
	The element id, by which relations read its values.
Node	visible (AnyHandle const &condition) const
	Whether the node shows.
Node	enabled (AnyHandle const &condition) const
	Whether the node is enabled.
Node	tooltip (AnyHandle const &text) const
	A tooltip.
Node	sizing (AnyHandle const &sizing) const
	The width's sizing: "content", {"fixed": n} or {"stretch": w}, such as content(), fixed(n) or stretch() give.
Node	sizing (AnyHandle const &width, AnyHandle const &height) const
	The sizing of both dimensions, as a {width, height} record; an absent one is content. Literal sizings (content(), fixed(n), stretch(w)) make a literal record, which the loader checks; another is evaluated at mount.
Node	alignSelf (Align align) const
	Where the node sits in its row, column or grid, in place of the container's align.
Node	minWidth (int units) const
	The least width, in backend units.
Node	maxWidth (int units) const
	The most width, in backend units.
Node	minHeight (int units) const
	The least height, in backend units.
Node	maxHeight (int units) const
	The most height, in backend units.
Node	span (AnyHandle const &columns) const
	The grid columns the node spans.
Node	autofocus (AnyHandle const &focus) const
	Whether the node takes focus when it mounts.
Node	testId (std::string const &name) const
	A stable identifier for automated tests.
Node	surface (std::string const &name) const
	A named token set for the subtree.
Node	a11y (AnyHandle const &name, std::string const &role={}) const
	The accessible name and role.
Node	drag (AnyHandle const &payload) const
	Makes the node draggable.
Node	drop (AnyHandle const &accepts, Commands const &onDrop) const
	Makes the node a drop target.
Node	key (std::string const &chord, Commands const &commands) const
	A key binding.
Node	readonly (AnyHandle const &condition) const
	Whether an input or text is read-only.
Node	required (AnyHandle const &condition) const
	Whether an input or text is required.
Node	errors (AnyHandle const &errors) const
	Errors shown on an input or text.
Node	stale (AnyHandle const &condition) const
	Whether an input or text shows a value that is being recalculated.

Detailed Description

A view node (spec 5 §9). The kind's own properties come from its builder's options; the properties every node takes come from the member functions, each of which returns a copy with the property set.

Definition at line 1778 of file author.hpp.

Constructor & Destructor Documentation

◆ Node()

morph::ui::author::Node::Node	(	Json	json,
		CatalogFacts	facts = {} )

inlineexplicit

A node over its JSON, for a kind no builder spells.

Parameters

json	The node.
facts	The catalog facts of the models and actions it names.

Definition at line 1783 of file author.hpp.

Member Function Documentation

◆ json()

Json const & morph::ui::author::Node::json ( ) const

inlinenodiscardnoexcept

The node's JSON.

Returns: The JSON.

Definition at line 1787 of file author.hpp.

◆ facts()

CatalogFacts const & morph::ui::author::Node::facts ( ) const

inlinenodiscardnoexcept

The catalog facts of the models and actions the node names.

Returns: The facts.

Definition at line 1791 of file author.hpp.

◆ with()

Node morph::ui::author::Node::with	(	std::string const &	key,
		AnyHandle const &	value ) const

inlinenodiscard

A property set to an expression; an absent expression leaves the node as it is.

Parameters

key	The property.
value	The expression.

Returns: The node with it.

Definition at line 1797 of file author.hpp.

◆ withText()

Node morph::ui::author::Node::withText	(	std::string const &	key,
		std::string const &	value ) const

inlinenodiscard

A property set to a plain string.

Parameters

key	The property.
value	The string.

Returns: The node with it.

Definition at line 1809 of file author.hpp.

◆ id()

Node morph::ui::author::Node::id ( Element const & element ) const

inlinenodiscard

The element id, by which relations read its values.

Parameters

element The element.

Returns: The node with it.

Definition at line 1818 of file author.hpp.

◆ visible()

Node morph::ui::author::Node::visible ( AnyHandle const & condition ) const

inlinenodiscard

Whether the node shows.

Parameters

condition The condition.

Returns: The node with it.

Definition at line 1823 of file author.hpp.

◆ enabled()

Node morph::ui::author::Node::enabled ( AnyHandle const & condition ) const

inlinenodiscard

Whether the node is enabled.

Parameters

condition The condition.

Returns: The node with it.

Definition at line 1828 of file author.hpp.

◆ tooltip()

Node morph::ui::author::Node::tooltip ( AnyHandle const & text ) const

inlinenodiscard

A tooltip.

Parameters

text The text.

Returns: The node with it.

Definition at line 1833 of file author.hpp.

◆ sizing() [1/2]

Node morph::ui::author::Node::sizing ( AnyHandle const & sizing ) const

inlinenodiscard

The width's sizing: "content", {"fixed": n} or {"stretch": w}, such as content(), fixed(n) or stretch() give.

Parameters

sizing The sizing.

Returns: The node with it.

Definition at line 1839 of file author.hpp.

◆ sizing() [2/2]

Node morph::ui::author::Node::sizing	(	AnyHandle const &	width,
		AnyHandle const &	height ) const

inlinenodiscard

The sizing of both dimensions, as a {width, height} record; an absent one is content. Literal sizings (content(), fixed(n), stretch(w)) make a literal record, which the loader checks; another is evaluated at mount.

Parameters

width	The width's sizing.
height	The height's sizing.

Returns: The node with it.

Definition at line 1847 of file author.hpp.

◆ alignSelf()

Node morph::ui::author::Node::alignSelf ( Align align ) const

inlinenodiscard

Where the node sits in its row, column or grid, in place of the container's align.

Parameters

align The alignment.

Returns: The node with it.

Definition at line 1872 of file author.hpp.

◆ minWidth()

Node morph::ui::author::Node::minWidth ( int units ) const

inlinenodiscard

The least width, in backend units.

Parameters

units The bound, 0 or more.

Returns: The node with it.

Definition at line 1877 of file author.hpp.

◆ maxWidth()

Node morph::ui::author::Node::maxWidth ( int units ) const

inlinenodiscard

The most width, in backend units.

Parameters

units The bound, 0 or more.

Returns: The node with it.

Definition at line 1882 of file author.hpp.

◆ minHeight()

Node morph::ui::author::Node::minHeight ( int units ) const

inlinenodiscard

The least height, in backend units.

Parameters

units The bound, 0 or more.

Returns: The node with it.

Definition at line 1887 of file author.hpp.

◆ maxHeight()

Node morph::ui::author::Node::maxHeight ( int units ) const

inlinenodiscard

The most height, in backend units.

Parameters

units The bound, 0 or more.

Returns: The node with it.

Definition at line 1892 of file author.hpp.

◆ span()

Node morph::ui::author::Node::span ( AnyHandle const & columns ) const

inlinenodiscard

The grid columns the node spans.

Parameters

columns The span.

Returns: The node with it.

Definition at line 1897 of file author.hpp.

◆ autofocus()

Node morph::ui::author::Node::autofocus ( AnyHandle const & focus ) const

inlinenodiscard

Whether the node takes focus when it mounts.

Parameters

focus The condition.

Returns: The node with it.

Definition at line 1902 of file author.hpp.

◆ testId()

Node morph::ui::author::Node::testId ( std::string const & name ) const

inlinenodiscard

A stable identifier for automated tests.

Parameters

name	The identifier.

Returns: The node with it.

Definition at line 1907 of file author.hpp.

◆ surface()

Node morph::ui::author::Node::surface ( std::string const & name ) const

inlinenodiscard

A named token set for the subtree.

Parameters

name	The token set.

Returns: The node with it.

Definition at line 1912 of file author.hpp.

◆ a11y()

Node morph::ui::author::Node::a11y	(	AnyHandle const &	name,
		std::string const &	role = {} ) const

inlinenodiscard

The accessible name and role.

Parameters

name	The name.
role	The role; empty for the kind's own.

Returns: The node with it.

Definition at line 1918 of file author.hpp.

◆ drag()

Node morph::ui::author::Node::drag ( AnyHandle const & payload ) const

inlinenodiscard

Makes the node draggable.

Parameters

payload The payload a drop receives.

Returns: The node with it.

Definition at line 1934 of file author.hpp.

◆ drop()

Node morph::ui::author::Node::drop	(	AnyHandle const &	accepts,
		Commands const &	onDrop ) const

inlinenodiscard

Makes the node a drop target.

Parameters

accepts	The payloads it accepts.
onDrop	The commands run with the payload as event.

Returns: The node with it.

Definition at line 1944 of file author.hpp.

◆ key()

Node morph::ui::author::Node::key	(	std::string const &	chord,
		Commands const &	commands ) const

inlinenodiscard

A key binding.

Parameters

chord	The chord, such as Ctrl+S.
commands	The commands.

Returns: The node with it.

Definition at line 1959 of file author.hpp.

◆ readonly()

Node morph::ui::author::Node::readonly ( AnyHandle const & condition ) const

inlinenodiscard

Whether an input or text is read-only.

Parameters

condition The condition.

Returns: The node with it.

Definition at line 1969 of file author.hpp.

◆ required()

Node morph::ui::author::Node::required ( AnyHandle const & condition ) const

inlinenodiscard

Whether an input or text is required.

Parameters

condition The condition.

Returns: The node with it.

Definition at line 1974 of file author.hpp.

◆ errors()

Node morph::ui::author::Node::errors ( AnyHandle const & errors ) const

inlinenodiscard

Errors shown on an input or text.

Parameters

errors The errors.

Returns: The node with them.

Definition at line 1979 of file author.hpp.

◆ stale()

Node morph::ui::author::Node::stale ( AnyHandle const & condition ) const

inlinenodiscard

Whether an input or text shows a value that is being recalculated.

Parameters

condition The condition.

Returns: The node with it.

Definition at line 1984 of file author.hpp.

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

morph/ui/author.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Node()

Member Function Documentation

◆ json()

◆ facts()

◆ with()

◆ withText()

◆ id()

◆ visible()

◆ enabled()

◆ tooltip()

◆ sizing() [1/2]

◆ sizing() [2/2]

◆ alignSelf()

◆ minWidth()

◆ maxWidth()

◆ minHeight()

◆ maxHeight()

◆ span()

◆ autofocus()

◆ testId()

◆ surface()

◆ a11y()

◆ drag()

◆ drop()

◆ key()

◆ readonly()

◆ required()

◆ errors()

◆ stale()