One command-line option as the screen shows it. More...

#include <app/tui.hpp>

Public Member Functions
bool	is_flag () const

Public Attributes
std::string	label
	as shown: "--via-cost-mm", "-o, --output", "board"
std::string	arg
	spelling written before the value; empty for a positional argument
std::string	key
	options-file key of a value option: its long name without the dashes
std::vector< std::string >	spellings
	a flag's spellings ("--pair-twists", "--no-pair-twists"); empty for a value option
std::string	help
std::string	def
	the default as text; empty if not known
bool	hidden = false
	experimental and test options, shown on request
bool	save = true
	false for what belongs to one run (board, output): not written to an options file
std::string	value
	what is in effect: value option: its text; flag: the chosen spelling; empty: the default
std::string	layer [kScopes]
	the same, per scope; value is the highest scope's that is not empty
Scope	scope = Scope::run
	the scope value comes from (meaningless while value is empty)

Detailed Description

One command-line option as the screen shows it.

Definition at line 23 of file tui.hpp.

Member Function Documentation

◆ is_flag()

bool tmk::app::tui::Field::is_flag ( ) const

inline

Definition at line 35 of file tui.hpp.

Member Data Documentation

◆ arg

std::string tmk::app::tui::Field::arg

spelling written before the value; empty for a positional argument

Definition at line 25 of file tui.hpp.

◆ def

std::string tmk::app::tui::Field::def

the default as text; empty if not known

Definition at line 29 of file tui.hpp.

◆ help

std::string tmk::app::tui::Field::help

Definition at line 28 of file tui.hpp.

◆ hidden

bool tmk::app::tui::Field::hidden = false

experimental and test options, shown on request

Definition at line 30 of file tui.hpp.

◆ key

std::string tmk::app::tui::Field::key

options-file key of a value option: its long name without the dashes

Definition at line 26 of file tui.hpp.

◆ label

std::string tmk::app::tui::Field::label

as shown: "--via-cost-mm", "-o, --output", "board"

Definition at line 24 of file tui.hpp.

◆ layer

std::string tmk::app::tui::Field::layer[kScopes]

the same, per scope; value is the highest scope's that is not empty

Definition at line 33 of file tui.hpp.

◆ save

bool tmk::app::tui::Field::save = true

false for what belongs to one run (board, output): not written to an options file

Definition at line 31 of file tui.hpp.

◆ scope

Scope tmk::app::tui::Field::scope = Scope::run

the scope value comes from (meaningless while value is empty)

Definition at line 34 of file tui.hpp.

◆ spellings

std::vector<std::string> tmk::app::tui::Field::spellings

a flag's spellings ("--pair-twists", "--no-pair-twists"); empty for a value option

Definition at line 27 of file tui.hpp.

◆ value

std::string tmk::app::tui::Field::value

what is in effect: value option: its text; flag: the chosen spelling; empty: the default

Definition at line 32 of file tui.hpp.

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

app/tui.hpp

Public Member Functions

Public Attributes