What a document (or an application) changes about one top-level field before the session is built: a form node's fields entry (spec 6 §10). An unset member keeps the schema's. More...

#include <field_model.hpp>

Public Attributes
bool	omit = false
	Removes the member from the form and from its body.
bool	hidden = false
	Keeps the member in the body and out of the view (x-hidden).
std::optional< std::string >	label
	Replaces the label (title).
std::optional< std::string >	unit
	The unit a Quantity is entered in: the id of one of its units (its canonical unit or an alternative). On a field without units, the unit shown beside it.
std::optional< std::uint32_t >	decimals
	The places a Decimal or Quantity is entered with in its entry unit, or a Number's display decimals. The wire value keeps the schema's places.
std::optional< std::string >	widget
	Replaces x-widget, so the kind is read again (textarea, radio, slider, epochDays, …).
std::optional< BlankAs >	blankAs
	Replaces x-blankAs.

Detailed Description

What a document (or an application) changes about one top-level field before the session is built: a form node's fields entry (spec 6 §10). An unset member keeps the schema's.

Definition at line 244 of file field_model.hpp.

Member Data Documentation

◆ omit

bool morph::forms::FieldOverlay::omit = false

Removes the member from the form and from its body.

Definition at line 246 of file field_model.hpp.

◆ hidden

bool morph::forms::FieldOverlay::hidden = false

Keeps the member in the body and out of the view (x-hidden).

Definition at line 248 of file field_model.hpp.

◆ label

std::optional<std::string> morph::forms::FieldOverlay::label

Replaces the label (title).

Definition at line 250 of file field_model.hpp.

◆ unit

std::optional<std::string> morph::forms::FieldOverlay::unit

The unit a Quantity is entered in: the id of one of its units (its canonical unit or an alternative). On a field without units, the unit shown beside it.

Definition at line 253 of file field_model.hpp.

◆ decimals

std::optional<std::uint32_t> morph::forms::FieldOverlay::decimals

The places a Decimal or Quantity is entered with in its entry unit, or a Number's display decimals. The wire value keeps the schema's places.

Definition at line 256 of file field_model.hpp.

◆ widget

std::optional<std::string> morph::forms::FieldOverlay::widget

Replaces x-widget, so the kind is read again (textarea, radio, slider, epochDays, …).

Definition at line 258 of file field_model.hpp.

◆ blankAs

std::optional<BlankAs> morph::forms::FieldOverlay::blankAs

Replaces x-blankAs.

Definition at line 260 of file field_model.hpp.

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

morph/forms/engine/field_model.hpp

Public Attributes