Struct zng::focus::FocusInfoBuilder

pub struct FocusInfoBuilder<'a>(/* private fields */);

Builder for FocusInfo accessible in a WidgetInfoBuilder.

There are multiple focusable metadata that can be set on a widget. These rules define how the focusable state of a widget is derived from the focusable metadata.

Rules

The widget is not focusable nor a focus scope if it set focusable to false.

The widget is a focus scope if it set scope to true or if it set tab_nav or directional_nav and did not set scope to false.

The widget is focusable if it set focusable to true or if it set the tab_index.

The widget is a focus scope if it sets nested_window, but the focus will always move inside the nested window.

The widget is not focusable if it did not set any of the members mentioned.

Tab Index

If the tab_index was not set but the widget is focusable or a focus scope, the TabIndex::AUTO is used for the widget.

Skip Directional

If the skip_directional was not set but the widget is focusable or a focus scope, it is set to false for the widget.

Focus Scope

If the widget is a focus scope, it is configured using alt_scope and on_focus. If the widget is not a scope these members are ignored.

Tab Navigation

If tab_nav is not set but the widget is a focus scope, TabNav::Continue is used.

Directional Navigation

If directional_nav is not set but the widget is a focus scope, DirectionalNav::Continue is used.

Implementations

impl<'a> FocusInfoBuilder<'a>

pub fn new(builder: &'a mut WidgetInfoBuilder) -> FocusInfoBuilder<'a>

New the builder.

pub fn focusable(&mut self, is_focusable: bool) -> &mut FocusInfoBuilder<'a>

If the widget is definitely focusable or not.

pub fn focusable_passive( &mut self, is_focusable: bool, ) -> &mut FocusInfoBuilder<'a>

Sets focusable, only if it was not already set.

pub fn scope(&mut self, is_focus_scope: bool) -> &mut FocusInfoBuilder<'a>

If the widget is definitely a focus scope or not.

pub fn alt_scope( &mut self, is_alt_focus_scope: bool, ) -> &mut FocusInfoBuilder<'a>

If the widget is definitely an ALT focus scope or not.

If true this also sets TabIndex::SKIP, skip_directional_nav, TabNav::Cycle and DirectionalNav::Cycle as default.

pub fn on_focus( &mut self, as_focus_scope_on_focus: FocusScopeOnFocus, ) -> &mut FocusInfoBuilder<'a>

When the widget is a focus scope, its behavior on receiving direct focus.

pub fn tab_index(&mut self, tab_index: TabIndex) -> &mut FocusInfoBuilder<'a>

Widget TAB index.

pub fn tab_nav(&mut self, scope_tab_nav: TabNav) -> &mut FocusInfoBuilder<'a>

TAB navigation within this widget, if set turns the widget into a focus scope.

pub fn directional_nav( &mut self, scope_directional_nav: DirectionalNav, ) -> &mut FocusInfoBuilder<'a>

Directional navigation within this widget, if set turns the widget into a focus scope.

pub fn skip_directional(&mut self, skip: bool) -> &mut FocusInfoBuilder<'a>

If directional navigation skips over this widget.