Struct FocusBuilder

pub struct FocusBuilder { /* private fields */ }

Builder for the Focus.

Implementations

impl FocusBuilder

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

pub fn enable_log(self) -> Self

pub fn container(&mut self, container: &dyn FocusContainer) -> &mut Self

Add a container widget.

Adds start+end and calls container.build()

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

Add a widget.

The widget is added to all open containers.

pub fn add_widget( &mut self, focus: FocusFlag, area: Rect, z_areas: &[ZRect], navigable: Navigation, )

Add a widget by setting all the attributes. The widget is added to all open containers.

pub fn start( &mut self, container_flag: Option<ContainerFlag>, area: Rect, ) -> Option<ContainerFlag>

Manually start a container widget. Must be matched with the equivalent end.

Use of container is preferred.

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

pub fn end(&mut self, container_flag: Option<ContainerFlag>)

Manually end a container widget.

Use of container is preferred.

pub fn build(self) -> Focus

Build the final focus.

If old is given, all widgets/containers no longer in the focus list are cleared().

pub fn for_container(container: &dyn FocusContainer) -> 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(container: &dyn FocusContainer, 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.

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.