Improve Menu API to facilitate external control

This commit is contained in:
Héctor Ramón Jiménez 2020-07-23 03:58:59 +02:00
parent bf5eaca2f2
commit aaf5986123
4 changed files with 71 additions and 83 deletions

View file

@ -788,7 +788,7 @@ struct Controls {
next_button: button::State, next_button: button::State,
clear_button: button::State, clear_button: button::State,
speed_slider: slider::State, speed_slider: slider::State,
preset_list: pick_list::State, preset_list: pick_list::State<Preset>,
} }
impl Controls { impl Controls {

View file

@ -10,7 +10,7 @@ pub fn main() {
#[derive(Default)] #[derive(Default)]
struct Example { struct Example {
scroll: scrollable::State, scroll: scrollable::State,
pick_list: pick_list::State, pick_list: pick_list::State<Language>,
selected_language: Language, selected_language: Language,
} }

View file

@ -7,10 +7,11 @@ use crate::{
/// A list of selectable options. /// A list of selectable options.
#[allow(missing_debug_implementations)] #[allow(missing_debug_implementations)]
pub struct Menu<'a, T, Message, Renderer: self::Renderer> { pub struct Menu<'a, T, Renderer: self::Renderer> {
state: &'a mut State, state: &'a mut State,
options: &'a [T], options: &'a [T],
on_selected: &'a dyn Fn(T) -> Message, hovered_option: &'a mut Option<usize>,
last_selection: &'a mut Option<T>,
width: u16, width: u16,
padding: u16, padding: u16,
text_size: Option<u16>, text_size: Option<u16>,
@ -18,10 +19,9 @@ pub struct Menu<'a, T, Message, Renderer: self::Renderer> {
style: <Renderer as self::Renderer>::Style, style: <Renderer as self::Renderer>::Style,
} }
impl<'a, T, Message, Renderer> Menu<'a, T, Message, Renderer> impl<'a, T, Renderer> Menu<'a, T, Renderer>
where where
T: ToString + Clone, T: ToString + Clone,
Message: 'a,
Renderer: self::Renderer + 'a, Renderer: self::Renderer + 'a,
{ {
/// Creates a new [`Menu`] with the given [`State`], a list of options, and /// Creates a new [`Menu`] with the given [`State`], a list of options, and
@ -32,12 +32,14 @@ where
pub fn new( pub fn new(
state: &'a mut State, state: &'a mut State,
options: &'a [T], options: &'a [T],
on_selected: &'a dyn Fn(T) -> Message, hovered_option: &'a mut Option<usize>,
last_selection: &'a mut Option<T>,
) -> Self { ) -> Self {
Menu { Menu {
state, state,
options, options,
on_selected, hovered_option,
last_selection,
width: 0, width: 0,
padding: 0, padding: 0,
text_size: None, text_size: None,
@ -97,7 +99,7 @@ where
/// dimensions of the [`Menu`]. /// dimensions of the [`Menu`].
/// ///
/// [`Menu`]: struct.Menu.html /// [`Menu`]: struct.Menu.html
pub fn overlay( pub fn overlay<Message: 'a>(
self, self,
position: Point, position: Point,
target_height: f32, target_height: f32,
@ -115,8 +117,6 @@ where
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
pub struct State { pub struct State {
scrollable: scrollable::State, scrollable: scrollable::State,
hovered_option: Option<usize>,
is_open: bool,
} }
impl State { impl State {
@ -127,26 +127,10 @@ impl State {
pub fn new() -> Self { pub fn new() -> Self {
Self::default() Self::default()
} }
/// Returns whether the [`Menu`] is currently open or not.
///
/// [`Menu`]: struct.Menu.html
pub fn is_open(&self) -> bool {
self.is_open
}
/// Opens the [`Menu`] with the given option hovered by default.
///
/// [`Menu`]: struct.Menu.html
pub fn open(&mut self, hovered_option: Option<usize>) {
self.is_open = true;
self.hovered_option = hovered_option;
}
} }
struct Overlay<'a, Message, Renderer: self::Renderer> { struct Overlay<'a, Message, Renderer: self::Renderer> {
container: Container<'a, Message, Renderer>, container: Container<'a, Message, Renderer>,
is_open: &'a mut bool,
width: u16, width: u16,
target_height: f32, target_height: f32,
style: <Renderer as self::Renderer>::Style, style: <Renderer as self::Renderer>::Style,
@ -157,17 +141,15 @@ where
Message: 'a, Message: 'a,
Renderer: 'a, Renderer: 'a,
{ {
pub fn new<T>( pub fn new<T>(menu: Menu<'a, T, Renderer>, target_height: f32) -> Self
menu: Menu<'a, T, Message, Renderer>,
target_height: f32,
) -> Self
where where
T: Clone + ToString, T: Clone + ToString,
{ {
let Menu { let Menu {
state, state,
options, options,
on_selected, hovered_option,
last_selection,
width, width,
padding, padding,
font, font,
@ -178,8 +160,8 @@ where
let container = let container =
Container::new(Scrollable::new(&mut state.scrollable).push(List { Container::new(Scrollable::new(&mut state.scrollable).push(List {
options, options,
hovered_option: &mut state.hovered_option, hovered_option,
on_selected, last_selection,
font, font,
text_size, text_size,
padding, padding,
@ -189,7 +171,6 @@ where
Self { Self {
container, container,
is_open: &mut state.is_open,
width: width, width: width,
target_height, target_height,
style: style, style: style,
@ -255,9 +236,6 @@ where
renderer: &Renderer, renderer: &Renderer,
clipboard: Option<&dyn Clipboard>, clipboard: Option<&dyn Clipboard>,
) { ) {
let bounds = layout.bounds();
let current_messages = messages.len();
self.container.on_event( self.container.on_event(
event.clone(), event.clone(),
layout, layout,
@ -266,17 +244,6 @@ where
renderer, renderer,
clipboard, clipboard,
); );
let option_was_selected = current_messages < messages.len();
match event {
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left))
if !bounds.contains(cursor_position) || option_was_selected =>
{
*self.is_open = false;
}
_ => {}
}
} }
fn draw( fn draw(
@ -299,10 +266,10 @@ where
} }
} }
struct List<'a, T, Message, Renderer: self::Renderer> { struct List<'a, T, Renderer: self::Renderer> {
options: &'a [T], options: &'a [T],
hovered_option: &'a mut Option<usize>, hovered_option: &'a mut Option<usize>,
on_selected: &'a dyn Fn(T) -> Message, last_selection: &'a mut Option<T>,
padding: u16, padding: u16,
text_size: Option<u16>, text_size: Option<u16>,
font: Renderer::Font, font: Renderer::Font,
@ -310,7 +277,7 @@ struct List<'a, T, Message, Renderer: self::Renderer> {
} }
impl<'a, T, Message, Renderer: self::Renderer> Widget<Message, Renderer> impl<'a, T, Message, Renderer: self::Renderer> Widget<Message, Renderer>
for List<'a, T, Message, Renderer> for List<'a, T, Renderer>
where where
T: Clone + ToString, T: Clone + ToString,
Renderer: self::Renderer, Renderer: self::Renderer,
@ -362,7 +329,7 @@ where
event: Event, event: Event,
layout: Layout<'_>, layout: Layout<'_>,
cursor_position: Point, cursor_position: Point,
messages: &mut Vec<Message>, _messages: &mut Vec<Message>,
renderer: &Renderer, renderer: &Renderer,
_clipboard: Option<&dyn Clipboard>, _clipboard: Option<&dyn Clipboard>,
) { ) {
@ -373,7 +340,7 @@ where
if bounds.contains(cursor_position) { if bounds.contains(cursor_position) {
if let Some(index) = *self.hovered_option { if let Some(index) = *self.hovered_option {
if let Some(option) = self.options.get(index) { if let Some(option) = self.options.get(index) {
messages.push((self.on_selected)(option.clone())); *self.last_selection = Some(option.clone());
} }
} }
} }
@ -461,7 +428,7 @@ pub trait Renderer:
} }
impl<'a, T, Message, Renderer> Into<Element<'a, Message, Renderer>> impl<'a, T, Message, Renderer> Into<Element<'a, Message, Renderer>>
for List<'a, T, Message, Renderer> for List<'a, T, Renderer>
where where
T: ToString + Clone, T: ToString + Clone,
Message: 'a, Message: 'a,

View file

@ -14,6 +14,9 @@ where
[T]: ToOwned<Owned = Vec<T>>, [T]: ToOwned<Owned = Vec<T>>,
{ {
menu: &'a mut menu::State, menu: &'a mut menu::State,
is_open: &'a mut bool,
hovered_option: &'a mut Option<usize>,
last_selection: &'a mut Option<T>,
on_selected: Box<dyn Fn(T) -> Message>, on_selected: Box<dyn Fn(T) -> Message>,
options: Cow<'a, [T]>, options: Cow<'a, [T]>,
selected: Option<T>, selected: Option<T>,
@ -22,15 +25,17 @@ where
text_size: Option<u16>, text_size: Option<u16>,
font: Renderer::Font, font: Renderer::Font,
style: <Renderer as self::Renderer>::Style, style: <Renderer as self::Renderer>::Style,
is_open: bool,
} }
/// The local state of a [`PickList`]. /// The local state of a [`PickList`].
/// ///
/// [`PickList`]: struct.PickList.html /// [`PickList`]: struct.PickList.html
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
pub struct State { pub struct State<T> {
menu: menu::State, menu: menu::State,
is_open: bool,
hovered_option: Option<usize>,
last_selection: Option<T>,
} }
impl<'a, T: 'a, Message, Renderer: self::Renderer> impl<'a, T: 'a, Message, Renderer: self::Renderer>
@ -46,15 +51,23 @@ where
/// [`PickList`]: struct.PickList.html /// [`PickList`]: struct.PickList.html
/// [`State`]: struct.State.html /// [`State`]: struct.State.html
pub fn new( pub fn new(
state: &'a mut State, state: &'a mut State<T>,
options: impl Into<Cow<'a, [T]>>, options: impl Into<Cow<'a, [T]>>,
selected: Option<T>, selected: Option<T>,
on_selected: impl Fn(T) -> Message + 'static, on_selected: impl Fn(T) -> Message + 'static,
) -> Self { ) -> Self {
let is_open = state.menu.is_open(); let State {
menu,
is_open,
hovered_option,
last_selection,
} = state;
Self { Self {
menu: &mut state.menu, menu,
is_open,
hovered_option,
last_selection,
on_selected: Box::new(on_selected), on_selected: Box::new(on_selected),
options: options.into(), options: options.into(),
selected, selected,
@ -63,7 +76,6 @@ where
padding: Renderer::DEFAULT_PADDING, padding: Renderer::DEFAULT_PADDING,
font: Default::default(), font: Default::default(),
style: Default::default(), style: Default::default(),
is_open,
} }
} }
@ -197,27 +209,32 @@ where
event: Event, event: Event,
layout: Layout<'_>, layout: Layout<'_>,
cursor_position: Point, cursor_position: Point,
_messages: &mut Vec<Message>, messages: &mut Vec<Message>,
_renderer: &Renderer, _renderer: &Renderer,
_clipboard: Option<&dyn Clipboard>, _clipboard: Option<&dyn Clipboard>,
) { ) {
if !self.is_open { match event {
match event { Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) => {
Event::Mouse(mouse::Event::ButtonPressed( if *self.is_open {
mouse::Button::Left, *self.is_open =
)) => { cursor_position.x < 0.0 || cursor_position.y < 0.0;
if layout.bounds().contains(cursor_position) { } else if layout.bounds().contains(cursor_position) {
let selected = self.selected.as_ref(); let selected = self.selected.as_ref();
self.menu.open( *self.is_open = true;
self.options *self.hovered_option = self
.iter() .options
.position(|option| Some(option) == selected), .iter()
); .position(|option| Some(option) == selected);
} }
if let Some(last_selection) = self.last_selection.take() {
messages.push((self.on_selected)(last_selection));
*self.is_open = false;
} }
_ => {}
} }
_ => {}
} }
} }
@ -244,15 +261,19 @@ where
&mut self, &mut self,
layout: Layout<'_>, layout: Layout<'_>,
) -> Option<overlay::Element<'_, Message, Renderer>> { ) -> Option<overlay::Element<'_, Message, Renderer>> {
if self.menu.is_open() { if *self.is_open {
let bounds = layout.bounds(); let bounds = layout.bounds();
let mut menu = let mut menu = Menu::new(
Menu::new(&mut self.menu, &self.options, &self.on_selected) &mut self.menu,
.width(bounds.width.round() as u16) &self.options,
.padding(self.padding) &mut self.hovered_option,
.font(self.font) &mut self.last_selection,
.style(Renderer::menu_style(&self.style)); )
.width(bounds.width.round() as u16)
.padding(self.padding)
.font(self.font)
.style(Renderer::menu_style(&self.style));
if let Some(text_size) = self.text_size { if let Some(text_size) = self.text_size {
menu = menu.text_size(text_size); menu = menu.text_size(text_size);