One catalog entry (spec 6 §8). More...

#include <bundle.hpp>

Public Attributes
std::string	id
	The screen's id.
Json	title
	The title: a string, or a message reference such as {"t": "lims.sample.title", "fallback": "…"}.
std::string	module
	The navigator's module.
std::string	group
	The navigator's group.
std::string	icon
	The icon name.
bool	singleton = false
	Whether the screen opens at most once.
bool	available = true
	Whether the entry can be opened; false lists it disabled with reason.
std::optional< std::string >	reason
	Why the entry is not available: the application's reason, or denied.
std::string	whenDenied = "hide"
	What a permission refusal does to the entry: hide or disable.
bool	isPublic = false
	Whether the client may fetch the screen before sign-in.
std::optional< std::string >	host
	The host screen the application registered with the client instead of a document.
bool	reuseEmpty = false
	Whether opening the entry replaces an empty, unmodified tab of it.

Detailed Description

One catalog entry (spec 6 §8).

Definition at line 251 of file bundle.hpp.

Member Data Documentation

◆ id

std::string morph::ui::CatalogEntry::id

The screen's id.

Definition at line 253 of file bundle.hpp.

◆ title

Json morph::ui::CatalogEntry::title

The title: a string, or a message reference such as {"t": "lims.sample.title", "fallback": "…"}.

Definition at line 255 of file bundle.hpp.

◆ module

std::string morph::ui::CatalogEntry::module

The navigator's module.

Definition at line 257 of file bundle.hpp.

◆ group

std::string morph::ui::CatalogEntry::group

The navigator's group.

Definition at line 259 of file bundle.hpp.

◆ icon

std::string morph::ui::CatalogEntry::icon

The icon name.

Definition at line 261 of file bundle.hpp.

◆ singleton

bool morph::ui::CatalogEntry::singleton = false

Whether the screen opens at most once.

Definition at line 263 of file bundle.hpp.

◆ available

bool morph::ui::CatalogEntry::available = true

Whether the entry can be opened; false lists it disabled with reason.

Definition at line 265 of file bundle.hpp.

◆ reason

std::optional<std::string> morph::ui::CatalogEntry::reason

Why the entry is not available: the application's reason, or denied.

Definition at line 267 of file bundle.hpp.

◆ whenDenied

std::string morph::ui::CatalogEntry::whenDenied = "hide"

What a permission refusal does to the entry: hide or disable.

Definition at line 269 of file bundle.hpp.

◆ isPublic

bool morph::ui::CatalogEntry::isPublic = false

Whether the client may fetch the screen before sign-in.

Definition at line 271 of file bundle.hpp.

◆ host

std::optional<std::string> morph::ui::CatalogEntry::host

The host screen the application registered with the client instead of a document.

Definition at line 273 of file bundle.hpp.

◆ reuseEmpty

bool morph::ui::CatalogEntry::reuseEmpty = false

Whether opening the entry replaces an empty, unmodified tab of it.

Definition at line 275 of file bundle.hpp.

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

morph/ui/bundle.hpp

Public Attributes