Struct FocusBuilder

pub struct FocusBuilder { /* private fields */ }

Builder for the Focus.

Implementations

impl FocusBuilder

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

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 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 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 widget(&mut self, widget: &dyn HasFocus) -> &mut Self

Add a widget by calling its build function. The build function of the HasFocus trait can use builder to define its focus requirements.

The widget is added to all open containers.

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

Add a widget by calling its build function. The build function of the HasFocus trait can use builder to define its focus requirements.

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.

The widget is added to all open containers.

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

Add a bunch of widget.

The widget is added to all open containers.

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 Self

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

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. Must be matched with the equivalent end.

Attention

If container_flag is None a dummy flag will be created and returned. Use the returned value when calling end.

Panic

Panics if the same container-flag is added twice.

pub fn build(self) -> Focus

Build the final Focus.

If the old Focus has been set with new(), all widgets that are no longer part of the focus will be cleared().

Trait Implementations

impl Debug for FocusBuilder

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

Formats the value using the given formatter.

impl Default for FocusBuilder

fn default() -> FocusBuilder

Returns the “default value” for a type.