Struct Prefs 

pub struct Prefs(/* private fields */);

The handle Preferences::install returns: Copy, so pages and the nav take it by value.

Implementations

impl Prefs

pub fn open(&self) -> bool

Open-or-focus the surface: the window on desktop; on mobile, select the nav item when one is mounted, else present the navigation presentation as a cover.

pub fn open_at(&self, route: &str) -> bool

Open and select a group ("updates"), optionally a row ("updates/check").

pub fn in_nav(&self) -> bool

Whether the app should place a Settings entry in its own navigation: true where the platform gives no app menu to reach the surface from (the phones); false on the desktops and on the web, whose menu button carries Settings… and About.

pub fn nav_item<K>(&self, key: impl Into<K>) -> Option<NavItem<K>>

The Settings entry for the app’s navigation, titled with the platform’s word and opening page: Some where Self::in_nav, None where the platform’s application menu already carries Settings. Goes straight into a nav’s items: nav(sel).items((…, prefs.nav_item(Section::Settings))).

pub fn nav_item_everywhere<K>(&self, key: impl Into<K>) -> NavItem<K>

The Settings entry on every platform, menu or not: for an app that wants Settings in its sidebar on the desktop too. Most apps want nav_item.

pub fn page(&self) -> AnyPiece

The navigation presentation as a piece: the destination of the nav item, or any place the app embeds settings.

pub fn group_page(&self, id: &str) -> AnyPiece

One group’s page alone (an in-reader sheet, a sidebar pane).

pub fn group_body(&self, id: &str) -> AnyPiece

One group’s sections without a scroll, for a sheet that stacks several groups and owns the scrolling itself: put the bodies in one scroll. The phones keep their native shape, sized to its rows.

pub fn about_page(&self) -> AnyPiece

The composed About page.

pub fn title(&self) -> String

The surface’s title.

Trait Implementations

impl Clone for Prefs

fn clone(&self) -> Prefs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.