How a Navigator lists the catalog and what it reports. More...

#include <navigator.hpp>

Public Attributes
std::vector< CatalogEntry >	entries
	The catalog's entries, in the order the navigator lists them within a group.
std::function< std::vector< std::string >(CatalogEntry const &)>	titles
	An entry's titles, each one a search can match: one per locale (spec 6 §19). Empty uses the entry's title, a string or a message reference's fallback. The first title is the one shown.
std::vector< std::string >	pins
	The person's pins as stored, in order; unknown ids and those past maxPins are dropped.
std::size_t	maxPins = 12
	The most pins (app-max-pins).
std::function< void(std::string const &)>	onOpen
	Called with an available entry's screen id when it, or its pin, is chosen.
std::function< void(std::string const &)>	onPrefetch
	Called with an available entry's screen id when the pointer rests on it or its pin: the time to start the screen's prefetch queries.
std::function< void(std::vector< std::string > const &)>	onPins
	Called with the whole new list each time the pins change, for the application to store.

Detailed Description

How a Navigator lists the catalog and what it reports.

Definition at line 28 of file navigator.hpp.

Member Data Documentation

◆ entries

std::vector<CatalogEntry> morph::ui::NavigatorOptions::entries

The catalog's entries, in the order the navigator lists them within a group.

Definition at line 30 of file navigator.hpp.

◆ titles

std::function<std::vector<std::string>(CatalogEntry const&)> morph::ui::NavigatorOptions::titles

An entry's titles, each one a search can match: one per locale (spec 6 §19). Empty uses the entry's title, a string or a message reference's fallback. The first title is the one shown.

Definition at line 33 of file navigator.hpp.

◆ pins

std::vector<std::string> morph::ui::NavigatorOptions::pins

The person's pins as stored, in order; unknown ids and those past maxPins are dropped.

Definition at line 35 of file navigator.hpp.

◆ maxPins

std::size_t morph::ui::NavigatorOptions::maxPins = 12

The most pins (app-max-pins).

Definition at line 37 of file navigator.hpp.

◆ onOpen

std::function<void(std::string const&)> morph::ui::NavigatorOptions::onOpen

Called with an available entry's screen id when it, or its pin, is chosen.

Definition at line 39 of file navigator.hpp.

◆ onPrefetch

std::function<void(std::string const&)> morph::ui::NavigatorOptions::onPrefetch

Called with an available entry's screen id when the pointer rests on it or its pin: the time to start the screen's prefetch queries.

Definition at line 42 of file navigator.hpp.

◆ onPins

std::function<void(std::vector<std::string> const&)> morph::ui::NavigatorOptions::onPins

Called with the whole new list each time the pins change, for the application to store.

Definition at line 44 of file navigator.hpp.

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

morph/ui/navigator.hpp

Public Attributes