//! Operate on widgets that can be focused. use crate::Rectangle; use crate::widget::Id; use crate::widget::operation::{self, Operation, Outcome}; /// The internal state of a widget that can be focused. pub trait Focusable { /// Returns whether the widget is focused or not. fn is_focused(&self) -> bool; /// Focuses the widget. fn focus(&mut self); /// Unfocuses the widget. fn unfocus(&mut self); } /// A summary of the focusable widgets present on a widget tree. #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)] pub struct Count { /// The index of the current focused widget, if any. pub focused: Option, /// The total amount of focusable widgets. pub total: usize, } /// Produces an [`Operation`] that focuses the widget with the given [`Id`]. pub fn focus(target: Id) -> impl Operation { struct Focus { target: Id, } impl Operation for Focus { fn focusable( &mut self, id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { match id { Some(id) if id == &self.target => { state.focus(); } _ => { state.unfocus(); } } } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { operate_on_children(self); } } Focus { target } } /// Produces an [`Operation`] that unfocuses the focused widget. pub fn unfocus() -> impl Operation { struct Unfocus; impl Operation for Unfocus { fn focusable( &mut self, _id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { state.unfocus(); } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { operate_on_children(self); } } Unfocus } /// Produces an [`Operation`] that generates a [`Count`] and chains it with the /// provided function to build a new [`Operation`]. pub fn count() -> impl Operation { struct CountFocusable { count: Count, } impl Operation for CountFocusable { fn focusable( &mut self, _id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { if state.is_focused() { self.count.focused = Some(self.count.total); } self.count.total += 1; } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { operate_on_children(self); } fn finish(&self) -> Outcome { Outcome::Some(self.count) } } CountFocusable { count: Count::default(), } } /// Produces an [`Operation`] that searches for the current focused widget, and /// - if found, focuses the previous focusable widget. /// - if not found, focuses the last focusable widget. pub fn focus_previous() -> impl Operation where T: Send + 'static, { struct FocusPrevious { count: Count, current: usize, } impl Operation for FocusPrevious { fn focusable( &mut self, _id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { if self.count.total == 0 { return; } match self.count.focused { None if self.current == self.count.total - 1 => state.focus(), Some(0) if self.current == 0 => state.unfocus(), Some(0) => {} Some(focused) if focused == self.current => state.unfocus(), Some(focused) if focused - 1 == self.current => state.focus(), _ => {} } self.current += 1; } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { operate_on_children(self); } } operation::then(count(), |count| FocusPrevious { count, current: 0 }) } /// Produces an [`Operation`] that searches for the current focused widget, and /// - if found, focuses the next focusable widget. /// - if not found, focuses the first focusable widget. pub fn focus_next() -> impl Operation where T: Send + 'static, { struct FocusNext { count: Count, current: usize, } impl Operation for FocusNext { fn focusable( &mut self, _id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { match self.count.focused { None if self.current == 0 => state.focus(), Some(focused) if focused == self.current => state.unfocus(), Some(focused) if focused + 1 == self.current => state.focus(), _ => {} } self.current += 1; } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { operate_on_children(self); } } operation::then(count(), |count| FocusNext { count, current: 0 }) } /// Produces an [`Operation`] that searches for the current focused widget /// and stores its ID. This ignores widgets that do not have an ID. pub fn find_focused() -> impl Operation { struct FindFocused { focused: Option, } impl Operation for FindFocused { fn focusable( &mut self, id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { if state.is_focused() && id.is_some() { self.focused = id.cloned(); } } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { operate_on_children(self); } fn finish(&self) -> Outcome { if let Some(id) = &self.focused { Outcome::Some(id.clone()) } else { Outcome::None } } } FindFocused { focused: None } } /// Produces an [`Operation`] that searches for the focusable widget /// and stores whether it is focused or not. This ignores widgets that /// do not have an ID. pub fn is_focused(target: Id) -> impl Operation { struct IsFocused { target: Id, is_focused: Option, } impl Operation for IsFocused { fn focusable( &mut self, id: Option<&Id>, _bounds: Rectangle, state: &mut dyn Focusable, ) { if id.is_some_and(|id| *id == self.target) { self.is_focused = Some(state.is_focused()); } } fn container( &mut self, _id: Option<&Id>, _bounds: Rectangle, operate_on_children: &mut dyn FnMut(&mut dyn Operation), ) { if self.is_focused.is_some() { return; } operate_on_children(self); } fn finish(&self) -> Outcome { self.is_focused.map_or(Outcome::None, Outcome::Some) } } IsFocused { target, is_focused: None, } }