Struct WindowBar 

pub struct WindowBar<R: Resource> { /* private fields */ }

The window’s bar: the slots the app declares now, and what pressing each of them submits.

Implementations

impl<R: Resource> WindowBar<R>

pub fn new(dispatcher: Dispatcher<R>) -> Self

The bar of the window running dispatcher’s record: nothing declared yet.

pub fn dispatcher(&self) -> Dispatcher<R>

The dispatcher this bar’s actions are submitted through: what a window keeps to declare its bar anew for what it shows now.

pub fn over(self, shell: &NavShell) -> Self

Start from shell’s own slots — its sidebar toggle, Back, the inspector toggle — and hand it the presses on them. The shell draws no header row of its own (NavShell::with_window_toolbar).

pub fn under(self, link: &WindowBarLink) -> Self

Start from the slots the shell of link last laid out, for an app painted inside the shell’s content column.

pub fn label(self, label: impl Into<String>) -> Self

The window shows label: its mode, the open document, the place.

pub fn place(self, location: Option<ToolbarLocation>) -> Self

The window’s location whole: its label, its choices, its breadcrumb, the anchor it reopens at (ToolbarLocation); None where the window shows no location (its sidebar stands in front of the content).

pub fn sidebar(self, open: bool, binding: impl Binding<R>) -> Self

The window’s sidebar toggle and whether it is open, for a window whose app shows the sidebar itself: pressing it submits binding.

pub fn views( self, name: impl Into<String>, chosen: usize, choices: impl IntoIterator<Item = Choice<R>>, ) -> Self

The app’s views of what the window shows — Issues and Board, Month and Week — as its view switcher: chosen is the place in choices of the one shown now, and choosing one submits what it carries (the effect that shows it).

pub fn action(self, submit: impl Submit<R>) -> Self

The button that submits submit — a verb with its arguments, a field edit, a form — named and pictured as the action is declared, disabled where the participant may not take it. The framework submits it through the window’s dispatcher when it is pressed.

pub fn effect<E: Effect>(self, effect: &E) -> Self

The button that invokes effect, named and pictured as it is declared, and disabled where the participant may not take it. The effect is answered wherever the app answers that effect: the window’s own view, or the host.

pub fn leading(self, submit: impl Submit<R>) -> Self

The action submit as a leading action: on where the window is (previous, next, today), right after the navigation.

pub fn flag( self, icon: impl Into<String>, name: impl Into<String>, field: &Path<R, bool>, on: bool, ) -> Self

The record’s flag at field as a toggle: it shows on, and pressing it submits the opposite, disabled where the participant may not edit the record.

pub fn on(self, on: bool) -> Self

The entry declared last shows as pressed when on and as a toggle: an effect that sets one of a window’s own states (a unit, a panel) reads as the state it sets.

pub fn in_menu(self) -> Self

The entry declared last goes to the bar’s overflowing menu, never the row: an occasional action (import, export, the app’s settings).

pub fn named(self, icon: impl Into<String>, name: impl Into<String>) -> Self

The entry declared last is pictured by icon and named name: the window’s own words for what the record’s action or effect calls itself, where the bar names it differently.

pub fn enabled(self, enabled: bool) -> Self

The entry declared last is enabled only where enabled too: what it would do is possible only sometimes (a theme that must be legible before it applies), and never where the participant may not take it.

pub fn slots(&self) -> WindowToolbar

The slots as the app declared them: the shell’s own, then the app’s, in the row and in the menu.

pub fn declare(&self)

Declare these slots as the window’s.

pub fn take_events(&self) -> bool

Submit what the person pressed in the window’s bar since the last call: on the shell’s own slots, the sidebar toggle, then the record’s actions and effects. Returns whether anything was asked.

pub fn press(&self, event: &ToolbarEvent) -> bool

Submit one event the bar sent. Returns whether it was one of these slots (then it is handled, even where the slot is gone).