Struct FocusBuilder 

pub struct FocusBuilder { /* private fields */ }

Builder for the Focus.

Implementations

impl FocusBuilder

pub fn new(last: Option<Focus>) -> FocusBuilder

Create a new FocusBuilder.

This can take the previous Focus and ensures that widgets that are no longer part of the focus list have their focus-flag cleared.

It will also recycle the storage of the old Focus.

pub fn log_build_for(container: &dyn HasFocus) -> Focus

The same as build_for but with logs enabled.

pub fn build_for(container: &dyn HasFocus) -> Focus

Shortcut for building the focus for a container that implements HasFocus.

This creates a fresh Focus.

See

Use rebuild_for if you want to ensure that widgets that are no longer in the widget structure have their focus flag reset properly. If you don’t have some logic to conditionally add widgets to the focus, this function is probably fine.

pub fn log_rebuild_for(container: &dyn HasFocus, old: Option<Focus>) -> Focus

The same as rebuild_for but with logs enabled.

pub fn rebuild_for(container: &dyn HasFocus, old: Option<Focus>) -> Focus

Shortcut function for building the focus for a container that implements HasFocus

This takes the old Focus and reuses most of its allocations. It also ensures that any widgets no longer in the widget structure have their focus-flags reset.

pub fn enable_log(&self)

Do some logging of the build.

pub fn disable_log(&self)

Do some logging of the build.

pub fn enable_panic(&self)

Enable insta-panic for certain failures.

pub fn disable_panic(&self)

Disable insta-panic for certain failures.

pub fn widget(&mut self, widget: &dyn HasFocus) -> &mut FocusBuilder

Add a widget by calling its build function.

pub fn widget_navigate( &mut self, widget: &dyn HasFocus, navigation: Navigation, ) -> &mut FocusBuilder

Add a widget by calling its build function.

This tries to override the default navigation for the given widget. This will fail if the widget is a container. It may also fail for other reasons. Depends on the widget.

Enable log to check.

pub fn widgets<const N: usize>( &mut self, widgets: [&dyn HasFocus; N], ) -> &mut FocusBuilder

Add a bunch of widgets.

pub fn start(&mut self, container: &dyn HasFocus) -> FocusFlag

Start a container widget. Must be matched with the equivalent end. Uses focus(), area() and z_area() of the given container. navigable() is currently not used, just leave it at the default.

Attention

Use the returned value when calling end.

Panic

Panics if the same container-flag is added twice.

pub fn end(&mut self, tag: FocusFlag)

End a container widget.

pub fn leaf_widget(&mut self, widget: &dyn HasFocus) -> &mut FocusBuilder

Directly add the given widget’s flags. Doesn’t call build() instead it uses focus(), etc. and appends a single widget.

This is intended to be used when implementing HasFocus::build() for a widget.

In all other situations it’s better to use widget().

Panic

Panics if the same focus-flag is added twice.

pub fn widget_with_flags( &mut self, focus: FocusFlag, area: Rect, area_z: u16, navigable: Navigation, )

Manually add a widgets flags.

This is intended to be used when implementing HasFocus::build() for a widget.

In all other situations it’s better to use widget().

Panic

Panics if the same focus-flag is added twice. Except it is allowable to add the flag a second time with Navigation::Mouse or Navigation::None

pub fn start_with_flags( &mut self, container_flag: FocusFlag, area: Rect, area_z: u16, ) -> FocusFlag

Start a container widget.

Returns the FocusFlag of the container. This flag must be used to close the container with end.

Panic

Panics if the same container-flag is added twice.

pub fn build(self) -> Focus

Build the Focus.

If the previous Focus is known, this will also reset the FocusFlag for any widget no longer part of the Focus.

Trait Implementations

impl Debug for FocusBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for FocusBuilder

fn default() -> FocusBuilder

Returns the “default value” for a type.