1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
use crate::direction::Direction;
use crate::event::{Event, EventResult, Key};
use crate::view::{View, ViewWrapper};
/// Adds circular focus to a wrapped view.
///
/// Wrap a view in `CircularFocus` to enable wrap-around focus
/// (when the focus exits this view, it will come back the other side).
///
/// It can be configured to wrap Tab (and Shift+Tab) keys, and/or Arrow keys.
pub struct CircularFocus<T: View> {
view: T,
wrap_tab: bool,
wrap_arrows: bool,
}
impl<T: View> CircularFocus<T> {
/// Creates a new `CircularFocus` around the given view.
///
/// If `wrap_tab` is true, Tab keys will cause focus to wrap around.
/// If `wrap_arrows` is true, Arrow keys will cause focus to wrap around.
pub fn new(view: T, wrap_tab: bool, wrap_arrows: bool) -> Self {
CircularFocus {
view,
wrap_tab,
wrap_arrows,
}
}
/// Creates a new `CircularFocus` view which will wrap around Tab-based
/// focus changes.
///
/// Whenever `Tab` would leave focus from this view, the focus will be
/// brought back to the beginning of the view.
pub fn wrap_tab(view: T) -> Self {
CircularFocus::new(view, true, false)
}
/// Creates a new `CircularFocus` view which will wrap around Tab-based
/// focus changes.
///
/// Whenever an arrow key
pub fn wrap_arrows(view: T) -> Self {
CircularFocus::new(view, false, true)
}
/// Returns `true` if Tab key cause focus to wrap around.
pub fn wraps_tab(&self) -> bool {
self.wrap_tab
}
/// Returns `true` if Arrow keys cause focus to wrap around.
pub fn wraps_arrows(&self) -> bool {
self.wrap_arrows
}
inner_getters!(self.view: T);
}
impl<T: View> ViewWrapper for CircularFocus<T> {
wrap_impl!(self.view: T);
fn wrap_on_event(&mut self, event: Event) -> EventResult {
match (self.view.on_event(event.clone()), event) {
(EventResult::Ignored, Event::Key(Key::Tab)) if self.wrap_tab => {
// Focus comes back!
if self.view.take_focus(Direction::front()) {
EventResult::Consumed(None)
} else {
EventResult::Ignored
}
}
(EventResult::Ignored, Event::Shift(Key::Tab))
if self.wrap_tab =>
{
// Focus comes back!
if self.view.take_focus(Direction::back()) {
EventResult::Consumed(None)
} else {
EventResult::Ignored
}
}
(EventResult::Ignored, Event::Key(Key::Right))
if self.wrap_arrows =>
{
// Focus comes back!
if self.view.take_focus(Direction::left()) {
EventResult::Consumed(None)
} else {
EventResult::Ignored
}
}
(EventResult::Ignored, Event::Key(Key::Left))
if self.wrap_arrows =>
{
// Focus comes back!
if self.view.take_focus(Direction::right()) {
EventResult::Consumed(None)
} else {
EventResult::Ignored
}
}
(EventResult::Ignored, Event::Key(Key::Up))
if self.wrap_arrows =>
{
// Focus comes back!
if self.view.take_focus(Direction::down()) {
EventResult::Consumed(None)
} else {
EventResult::Ignored
}
}
(EventResult::Ignored, Event::Key(Key::Down))
if self.wrap_arrows =>
{
// Focus comes back!
if self.view.take_focus(Direction::up()) {
EventResult::Consumed(None)
} else {
EventResult::Ignored
}
}
(other, _) => other,
}
}
}