Struct rat_focus::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 new() -> Self

Construct a new focus list.

pub fn new_list(list: &[&dyn HasFocusFlag]) -> Self

Construct a new focus list.

pub fn new_container(container: ContainerFlag, area: Rect) -> Self

Construct a new focus list for a container widget.

The focus-flag for the container accumulates all the flags. If any widget has focus, the container has the focus too. Focus-gained and focus-lost are only set if the focus leaves the container.

The container widget itself interacts with the mouse too. If no single widget is hit with the mouse, but the area of the container is, the first widget gets the focus.

See examples/focus_recursive and examples/focus_recursive2

pub fn new_container_list( container: ContainerFlag, area: Rect, list: &[&dyn HasFocusFlag], ) -> Self

Construct a new focus list for a container widget.

The focus-flag for the container accumulates all the flags. If any widget has focus, the container has the focus too. Focus-gained and focus-lost are only set if the focus leaves the container.

The container widget itself interacts with the mouse too. If no single widget is hit with the mouse, but the area of the container is, the first widget gets the focus.

See examples/focus_recursive and examples/focus_recursive2

pub fn container_flag(&self) -> Option<ContainerFlag>

Container-flag for this Focus.

pub fn container_area(&self) -> Rect

Container-area for this Focus.

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

Add a container widget.

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

Remove a container widget.

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

Update the composition of the container.

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

Replace a container widget.

Panic

Panics if the

pub fn add(&mut self, f: &dyn HasFocusFlag)

Add a single widget.

pub fn insert_before(&mut self, f: &dyn HasFocusFlag, before: &dyn HasFocusFlag)

Add a single widget.

pub fn insert_after(&mut self, f: &dyn HasFocusFlag, after: &dyn HasFocusFlag)

Add a single widget.

pub fn remove(&mut self, f: &dyn HasFocusFlag)

Remove a single widget

pub fn update(&mut self, f: &dyn HasFocusFlag)

Update the flags of a widget.

pub fn replace(&mut self, f: &dyn HasFocusFlag, new: &dyn HasFocusFlag)

Replace a single widget.

pub fn add_all(&mut self, list: &[&dyn HasFocusFlag])

Append a list of widgets.

pub fn add_flag(&mut self, flag: FocusFlag, area: Rect)

Add a single widget. This doesn’t add any z_areas and assumes navigable is true.

pub fn add_focus(&mut self, container: Focus)

Add a sub-focus cycle.

All its widgets are appended to this list. If the sub-cycle has an accumulator it’s added to the sub-accumulators. All sub-sub-accumulators are appended too.

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 HasFocusFlag)

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 HasFocusFlag)

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 focus_flag_no_lost(&self, flag: FocusFlag)

Sets the focus to the widget with the given flag.

Sets focus and gained but not lost. This can be used to prevent validation of the field.

pub fn focus_flag(&self, flag: FocusFlag)

Sets the focus to the widget with the given flag.

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 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_idx(&self, idx: usize)

Change the focus.

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 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 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.

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 Default for Focus

fn default() -> Focus

Returns the “default value” for a type.

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.