Struct Focus

pub struct Focus { /* private fields */ }

Focus deals with all focus-related issues.

It must be constructed at least after each render(), as it holds copies of the widget-areas for mouse-handling.

In practice, construct it, when you first need it.

Implementations

impl Focus

pub fn remove_container(&mut self, container: &dyn HasFocus)

Dynamic change of the widget structure of a container widget.

This is only necessary if your widget structure changes during event-handling, and you need a programmatic focus-change for the new structure.

This resets the focus-flags of the removed container.

pub fn update_container(&mut self, container: &dyn HasFocus)

Dynamic change of the widget structure of a container.

This is only necessary if your widget structure changes during event-handling, and you need a programmatic focus-change for the new structure.

If the widget that currently has the focus is still part of the widget structure it keeps the focus. The focus-flags for all widgets that are no longer part of the widget structure are reset.

pub fn replace_container( &mut self, container: &dyn HasFocus, new: &dyn HasFocus, )

Dynamic change of the widget structure of a container.

This is only necessary if your widget structure changes during event-handling, and you need a programmatic focus-change.

This removes the widgets of one container and inserts the widgets of the other one in place.

If the widget that currently has the focus is still part of the widget structure it keeps the focus. The focus-flags for all widgets that are no longer part of the widget structure are reset.

pub fn enable_log(&self)

Writes a log for each operation.

pub fn disable_log(&self)

Writes a log for each operation.

pub fn focus_no_lost(&self, widget_state: &dyn HasFocus)

Sets the focus to the widget.

Sets the focus, but doesn’t set lost or gained. This can be used to prevent validation of the field.

pub fn focus(&self, widget_state: &dyn HasFocus)

Sets the focus to the given widget.

Sets the focus, gained and lost flags.

If this ends up with the same widget as before gained and lost flags are not set.

pub fn expel_focus(&self, widget_state: &dyn HasFocus)

Expels the focus from the given widget regardless of the current state.

pub fn focused(&self) -> Option<FocusFlag>

Returns the focused widget as FocusFlag.

This is mainly for debugging purposes. For control-flow crate::match_focus or crate::on_gained or crate::on_lost will be nicer.

pub fn focused_name(&self) -> Option<String>

Returns the debug name of the focused widget.

This is mainly for debugging purposes.

pub fn navigation(&self) -> Option<Navigation>

Returns the navigation flag for the focused widget.

pub fn lost_focus(&self) -> Option<FocusFlag>

Returns the widget that lost the focus as FocusFlag.

This is mainly for debugging purposes. For control-flow crate::match_focus or crate::on_gained or crate::on_lost will be nicer.

pub fn gained_focus(&self) -> Option<FocusFlag>

Returns the widget that gained the focus as FocusFlag.

This is mainly for debugging purposes. For control-flow crate::match_focus or crate::on_gained or crate::on_lost will be nicer.

pub fn reset_lost_gained(&self)

Reset lost + gained flags. This is done automatically in HandleEvent::handle() for every event.

pub fn focus_at(&self, col: u16, row: u16) -> bool

Change to focus to the given position.

pub fn first(&self)

Set the initial state for all widgets.

This ensures that there is only one focused widget. The first widget in the list gets the focus.

pub fn first_in(&self, container: &dyn HasFocus)

Focus the first widget of a given container. It the given HasFocus is a widget it will get the focus.

The first navigable widget in the container gets the focus.

pub fn none(&self)

Clear the focus for all widgets.

When navigating after this focus will restart somewhere, most probably the very first widget.

pub fn next(&self) -> bool

Focus the next widget in the cycle.

Sets the focus, gained and lost flags. If this ends up with the same widget as before focus, gained and lost flag are all set.

If no field has the focus the first one gets it.

pub fn prev(&self) -> bool

Focus the previous widget in the cycle.

Sets the focus and lost flags. If this ends up with the same widget as before it returns true and sets the focus, gained and lost flag.

If no field has the focus the first one gets it.

pub fn next_force(&self) -> bool

Focus the next widget in the cycle. Applies some extra force to this action and allows leaving widgets that have Navigation::(Mouse, ReachLeafFront, Reach).

Sets the focus, gained and lost flags. If this ends up with the same widget as before focus, gained and lost flag are all set.

If no field has the focus the first one gets it.

pub fn prev_force(&self) -> bool

Focus the previous widget in the cycle.

Applies some extra force to this action and allows leaving widgets that have Navigation::(Mouse, ReachLeafBack, Reach).

Sets the focus and lost flags. If this ends up with the same widget as before it returns true and sets the focus, gained and lost flag.

If no field has the focus the first one gets it.

pub fn clone_destruct( &self, ) -> (Vec<FocusFlag>, Vec<bool>, Vec<(Rect, u16)>, Vec<Navigation>, Vec<(FocusFlag, (Rect, u16), Range<usize>)>)

Debug destructuring.

Trait Implementations

impl Clone for Focus

fn clone(&self) -> Focus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Focus

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

Formats the value using the given formatter.

impl HandleEvent<Event, MouseOnly, Outcome> for Focus

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for Focus

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.