morph 0.1.0
Asynchronous bridge between GUI thread and business models
Loading...
Searching...
No Matches
morph::ui::author::Element Class Reference

An element of the view, named by its id, whose live values relations read (spec 5 §6). More...

#include <author.hpp>

Public Member Functions

 Element (std::string name)
 An element.
std::string const & name () const noexcept
 The element's id.
AnyHandle get (std::string const &value) const
 One of the element's values.
AnyHandle value () const
 An input's committed value.
AnyHandle draft () const
 An input's text while it is edited.
Handle< bool > checked () const
 A checkbox's state.
AnyHandle selected () const
 A select's chosen key.
AnyHandle selection () const
 A table's selection.
Handle< bool > open () const
 Whether a dialog or drawer is open.
Handle< bool > valid () const
 Whether a form, dialog or element is valid.
Handle< bool > ready () const
 Whether a form or dialog is ready to submit.

Detailed Description

An element of the view, named by its id, whose live values relations read (spec 5 §6).

Definition at line 1235 of file author.hpp.

Constructor & Destructor Documentation

◆ Element()

morph::ui::author::Element::Element ( std::string name)
inlineexplicit

An element.

Parameters
nameThe element's id.

Definition at line 1239 of file author.hpp.

Member Function Documentation

◆ name()

std::string const & morph::ui::author::Element::name ( ) const
inlinenodiscardnoexcept

The element's id.

Returns
The id.

Definition at line 1243 of file author.hpp.

◆ get()

AnyHandle morph::ui::author::Element::get ( std::string const & value) const
inlinenodiscard

One of the element's values.

Parameters
valueThe value's name, or a dotted path such as a form field's mass.value.
Returns
The read.

Definition at line 1248 of file author.hpp.

◆ value()

AnyHandle morph::ui::author::Element::value ( ) const
inlinenodiscard

An input's committed value.

Returns
The read.

Definition at line 1252 of file author.hpp.

◆ draft()

AnyHandle morph::ui::author::Element::draft ( ) const
inlinenodiscard

An input's text while it is edited.

Returns
The read.

Definition at line 1256 of file author.hpp.

◆ checked()

Handle< bool > morph::ui::author::Element::checked ( ) const
inlinenodiscard

A checkbox's state.

Returns
The read.

Definition at line 1260 of file author.hpp.

◆ selected()

AnyHandle morph::ui::author::Element::selected ( ) const
inlinenodiscard

A select's chosen key.

Returns
The read.

Definition at line 1264 of file author.hpp.

◆ selection()

AnyHandle morph::ui::author::Element::selection ( ) const
inlinenodiscard

A table's selection.

Returns
The read.

Definition at line 1268 of file author.hpp.

◆ open()

Handle< bool > morph::ui::author::Element::open ( ) const
inlinenodiscard

Whether a dialog or drawer is open.

Returns
The read.

Definition at line 1272 of file author.hpp.

◆ valid()

Handle< bool > morph::ui::author::Element::valid ( ) const
inlinenodiscard

Whether a form, dialog or element is valid.

Returns
The read.

Definition at line 1276 of file author.hpp.

◆ ready()

Handle< bool > morph::ui::author::Element::ready ( ) const
inlinenodiscard

Whether a form or dialog is ready to submit.

Returns
The read.

Definition at line 1280 of file author.hpp.


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