morph 0.1.0
Asynchronous bridge between GUI thread and business models
Loading...
Searching...
No Matches
morph::ui::Command Struct Reference

One command. Which members a kind uses is listed with each member. More...

#include <document.hpp>

Public Attributes

CommandKind kind = CommandKind::Set
 The kind.
std::string path
 The command's JSON Pointer.
std::string target
 The name it acts on: set's name.path; the state of reset; the mutation of run, signIn and upload; the query of refetch; the element of open, close and focus; the screen of navigate; the name of host, switchBackend, setLocale; the point of resetPrefs; the state of a download to preview.
ExprPtr value
 The main expression: set's value, run's body, navigate's params, return's value, host's args, notify's message, if's condition, the file of upload and download.
ExprPtr extra
 The second expression: run's each, navigate's route, download's suggested name.
std::string binding
 A binding name: run's and upload's as.
std::string option
 A closed option: navigate's as, notify's role, download's save or to.
std::string transfer
 The transfer id of upload, whose progress is an element value.
bool bytes = false
 Whether the file moves inline: download's "from": "bytes", upload's "into": "bytes".
ExprPtr mediaType
 download's media type of inline bytes.
std::string nameAs
 upload's body members for an inline file's name and media type; empty for none.
std::string typeAs
 See nameAs.
Commands commands
 Nested commands: seq and all; if's then branch; navigate's onResult.
Commands alternative
 The alternative: if's else branch; navigate's onCancel.

Detailed Description

One command. Which members a kind uses is listed with each member.

Definition at line 271 of file document.hpp.

Member Data Documentation

◆ kind

CommandKind morph::ui::Command::kind = CommandKind::Set

The kind.

Definition at line 273 of file document.hpp.

◆ path

std::string morph::ui::Command::path

The command's JSON Pointer.

Definition at line 275 of file document.hpp.

◆ target

std::string morph::ui::Command::target

The name it acts on: set's name.path; the state of reset; the mutation of run, signIn and upload; the query of refetch; the element of open, close and focus; the screen of navigate; the name of host, switchBackend, setLocale; the point of resetPrefs; the state of a download to preview.

Definition at line 280 of file document.hpp.

◆ value

ExprPtr morph::ui::Command::value

The main expression: set's value, run's body, navigate's params, return's value, host's args, notify's message, if's condition, the file of upload and download.

Definition at line 283 of file document.hpp.

◆ extra

ExprPtr morph::ui::Command::extra

The second expression: run's each, navigate's route, download's suggested name.

Definition at line 285 of file document.hpp.

◆ binding

std::string morph::ui::Command::binding

A binding name: run's and upload's as.

Definition at line 287 of file document.hpp.

◆ option

std::string morph::ui::Command::option

A closed option: navigate's as, notify's role, download's save or to.

Definition at line 289 of file document.hpp.

◆ transfer

std::string morph::ui::Command::transfer

The transfer id of upload, whose progress is an element value.

Definition at line 291 of file document.hpp.

◆ bytes

bool morph::ui::Command::bytes = false

Whether the file moves inline: download's "from": "bytes", upload's "into": "bytes".

Definition at line 293 of file document.hpp.

◆ mediaType

ExprPtr morph::ui::Command::mediaType

download's media type of inline bytes.

Definition at line 295 of file document.hpp.

◆ nameAs

std::string morph::ui::Command::nameAs

upload's body members for an inline file's name and media type; empty for none.

Definition at line 297 of file document.hpp.

◆ typeAs

std::string morph::ui::Command::typeAs

See nameAs.

Definition at line 299 of file document.hpp.

◆ commands

Commands morph::ui::Command::commands

Nested commands: seq and all; if's then branch; navigate's onResult.

Definition at line 301 of file document.hpp.

◆ alternative

Commands morph::ui::Command::alternative

The alternative: if's else branch; navigate's onCancel.

Definition at line 303 of file document.hpp.


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