A loaded and validated UI document: a screen, or the app document (id app, spec 6 §5). More...

#include <document.hpp>

Public Attributes
std::string	vocab
	The vocabulary, ui/1.
std::string	id
	The document id, such as lims.results.
ExprPtr	title
	The title expression.
ExprPtr	identity
	The identity expression: equal identities are one screen.
ExprPtr	dirty
	The unsaved-changes expression.
ExprPtr	subtitle
	The subtitle expression of the screen's head; nullptr when none is declared.
std::vector< DocNodePtr >	status
	The head's status badges: headBadge parts, in order.
std::vector< DocNodePtr >	actions
	The head's actions: actionButton parts, in order.
std::vector< std::pair< std::string, Type > >	params
	The typed params, in declaration order.
ScopeDecl	scope
	The screen scope's declarations.
std::map< std::string, Commands, std::less<> >	lifecycle
	The lifecycle command lists by key: onMount, onUnmount, onClose, onSave, onBackendChange.
std::map< std::string, Commands, std::less<> >	keys
	The screen's key bindings.
std::string	showErrors
	When errors show: touched, submit or always; empty for the default.
std::vector< std::string >	prefetch
	Queries started before the screen mounts.
std::map< std::string, Component, std::less<> >	components
	Custom components, by name.
std::map< std::string, CustomizePoint, std::less<> >	customize
	Customization points, by name.
DocNodePtr	view
	The view; nullptr for the app document.
std::map< DocNode const *, TypeKind >	dateValueKinds
	The static type of each dateTimeInput's value that the loader could decide: String or Timestamp, keyed by the node. A node whose value type is any or key has no entry.
std::vector< LoadWarning >	warnings
	What load-time validation found that does not refuse the document, in the order found. Empty when the catalog answers no actions.

Detailed Description

A loaded and validated UI document: a screen, or the app document (id app, spec 6 §5).

Definition at line 536 of file document.hpp.

Member Data Documentation

◆ vocab

std::string morph::ui::Document::vocab

The vocabulary, ui/1.

Definition at line 538 of file document.hpp.

◆ id

std::string morph::ui::Document::id

The document id, such as lims.results.

Definition at line 540 of file document.hpp.

◆ title

ExprPtr morph::ui::Document::title

The title expression.

Definition at line 542 of file document.hpp.

◆ identity

ExprPtr morph::ui::Document::identity

The identity expression: equal identities are one screen.

Definition at line 544 of file document.hpp.

◆ dirty

ExprPtr morph::ui::Document::dirty

The unsaved-changes expression.

Definition at line 546 of file document.hpp.

◆ subtitle

ExprPtr morph::ui::Document::subtitle

The subtitle expression of the screen's head; nullptr when none is declared.

Definition at line 548 of file document.hpp.

◆ status

std::vector<DocNodePtr> morph::ui::Document::status

The head's status badges: headBadge parts, in order.

Definition at line 550 of file document.hpp.

◆ actions

std::vector<DocNodePtr> morph::ui::Document::actions

The head's actions: actionButton parts, in order.

Definition at line 552 of file document.hpp.

◆ params

std::vector<std::pair<std::string, Type> > morph::ui::Document::params

The typed params, in declaration order.

Definition at line 554 of file document.hpp.

◆ scope

ScopeDecl morph::ui::Document::scope

The screen scope's declarations.

Definition at line 556 of file document.hpp.

◆ lifecycle

std::map<std::string, Commands, std::less<> > morph::ui::Document::lifecycle

The lifecycle command lists by key: onMount, onUnmount, onClose, onSave, onBackendChange.

Definition at line 558 of file document.hpp.

◆ keys

std::map<std::string, Commands, std::less<> > morph::ui::Document::keys

The screen's key bindings.

Definition at line 560 of file document.hpp.

◆ showErrors

std::string morph::ui::Document::showErrors

When errors show: touched, submit or always; empty for the default.

Definition at line 562 of file document.hpp.

◆ prefetch

std::vector<std::string> morph::ui::Document::prefetch

Queries started before the screen mounts.

Definition at line 564 of file document.hpp.

◆ components

std::map<std::string, Component, std::less<> > morph::ui::Document::components

Custom components, by name.

Definition at line 566 of file document.hpp.

◆ customize

std::map<std::string, CustomizePoint, std::less<> > morph::ui::Document::customize

Customization points, by name.

Definition at line 568 of file document.hpp.

◆ view

DocNodePtr morph::ui::Document::view

The view; nullptr for the app document.

Definition at line 570 of file document.hpp.

◆ dateValueKinds

std::map<DocNode const*, TypeKind> morph::ui::Document::dateValueKinds

The static type of each dateTimeInput's value that the loader could decide: String or Timestamp, keyed by the node. A node whose value type is any or key has no entry.

Definition at line 573 of file document.hpp.

◆ warnings

std::vector<LoadWarning> morph::ui::Document::warnings

What load-time validation found that does not refuse the document, in the order found. Empty when the catalog answers no actions.

Definition at line 576 of file document.hpp.

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

morph/ui/document.hpp

Public Attributes