653 lines
19 KiB
Rust
653 lines
19 KiB
Rust
//! Build and show dropdown menus.
|
|
use crate::container::{self, Container};
|
|
use crate::core::alignment;
|
|
use crate::core::event::{self, Event};
|
|
use crate::core::layout::{self, Layout};
|
|
use crate::core::mouse;
|
|
use crate::core::overlay;
|
|
use crate::core::renderer;
|
|
use crate::core::text::{self, Text};
|
|
use crate::core::touch;
|
|
use crate::core::widget::Tree;
|
|
use crate::core::{
|
|
Background, Border, Clipboard, Color, Length, Padding, Pixels, Point,
|
|
Rectangle, Size, Theme, Vector,
|
|
};
|
|
use crate::core::{Element, Shell, Widget};
|
|
use crate::scrollable::{self, Scrollable};
|
|
|
|
/// A list of selectable options.
|
|
#[allow(missing_debug_implementations)]
|
|
pub struct Menu<
|
|
'a,
|
|
T,
|
|
Message,
|
|
Theme = crate::Theme,
|
|
Renderer = crate::Renderer,
|
|
> where
|
|
Renderer: text::Renderer,
|
|
{
|
|
state: &'a mut State,
|
|
options: &'a [T],
|
|
hovered_option: &'a mut Option<usize>,
|
|
on_selected: Box<dyn FnMut(T) -> Message + 'a>,
|
|
on_option_hovered: Option<&'a dyn Fn(T) -> Message>,
|
|
width: f32,
|
|
padding: Padding,
|
|
text_size: Option<Pixels>,
|
|
text_line_height: text::LineHeight,
|
|
text_shaping: text::Shaping,
|
|
font: Option<Renderer::Font>,
|
|
style: Style<Theme>,
|
|
}
|
|
|
|
impl<'a, T, Message, Theme, Renderer> Menu<'a, T, Message, Theme, Renderer>
|
|
where
|
|
T: ToString + Clone,
|
|
Message: 'a,
|
|
Theme: 'a,
|
|
Renderer: text::Renderer + 'a,
|
|
{
|
|
/// Creates a new [`Menu`] with the given [`State`], a list of options, and
|
|
/// the message to produced when an option is selected.
|
|
pub fn new(
|
|
state: &'a mut State,
|
|
options: &'a [T],
|
|
hovered_option: &'a mut Option<usize>,
|
|
on_selected: impl FnMut(T) -> Message + 'a,
|
|
on_option_hovered: Option<&'a dyn Fn(T) -> Message>,
|
|
) -> Self
|
|
where
|
|
Theme: DefaultStyle,
|
|
{
|
|
Self::with_style(
|
|
state,
|
|
options,
|
|
hovered_option,
|
|
on_selected,
|
|
on_option_hovered,
|
|
Theme::default_style(),
|
|
)
|
|
}
|
|
|
|
/// Creates a new [`Menu`] with the given [`State`], a list of options,
|
|
/// the message to produced when an option is selected, and its [`Style`].
|
|
pub fn with_style(
|
|
state: &'a mut State,
|
|
options: &'a [T],
|
|
hovered_option: &'a mut Option<usize>,
|
|
on_selected: impl FnMut(T) -> Message + 'a,
|
|
on_option_hovered: Option<&'a dyn Fn(T) -> Message>,
|
|
style: Style<Theme>,
|
|
) -> Self {
|
|
Menu {
|
|
state,
|
|
options,
|
|
hovered_option,
|
|
on_selected: Box::new(on_selected),
|
|
on_option_hovered,
|
|
width: 0.0,
|
|
padding: Padding::ZERO,
|
|
text_size: None,
|
|
text_line_height: text::LineHeight::default(),
|
|
text_shaping: text::Shaping::Basic,
|
|
font: None,
|
|
style,
|
|
}
|
|
}
|
|
|
|
/// Sets the width of the [`Menu`].
|
|
pub fn width(mut self, width: f32) -> Self {
|
|
self.width = width;
|
|
self
|
|
}
|
|
|
|
/// Sets the [`Padding`] of the [`Menu`].
|
|
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
|
|
self.padding = padding.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the text size of the [`Menu`].
|
|
pub fn text_size(mut self, text_size: impl Into<Pixels>) -> Self {
|
|
self.text_size = Some(text_size.into());
|
|
self
|
|
}
|
|
|
|
/// Sets the text [`text::LineHeight`] of the [`Menu`].
|
|
pub fn text_line_height(
|
|
mut self,
|
|
line_height: impl Into<text::LineHeight>,
|
|
) -> Self {
|
|
self.text_line_height = line_height.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the [`text::Shaping`] strategy of the [`Menu`].
|
|
pub fn text_shaping(mut self, shaping: text::Shaping) -> Self {
|
|
self.text_shaping = shaping;
|
|
self
|
|
}
|
|
|
|
/// Sets the font of the [`Menu`].
|
|
pub fn font(mut self, font: impl Into<Renderer::Font>) -> Self {
|
|
self.font = Some(font.into());
|
|
self
|
|
}
|
|
|
|
/// Sets the style of the [`Menu`].
|
|
pub fn style(mut self, style: impl Into<Style<Theme>>) -> Self {
|
|
self.style = style.into();
|
|
self
|
|
}
|
|
|
|
/// Turns the [`Menu`] into an overlay [`Element`] at the given target
|
|
/// position.
|
|
///
|
|
/// The `target_height` will be used to display the menu either on top
|
|
/// of the target or under it, depending on the screen position and the
|
|
/// dimensions of the [`Menu`].
|
|
pub fn overlay(
|
|
self,
|
|
position: Point,
|
|
target_height: f32,
|
|
) -> overlay::Element<'a, Message, Theme, Renderer> {
|
|
overlay::Element::new(Box::new(Overlay::new(
|
|
position,
|
|
self,
|
|
target_height,
|
|
)))
|
|
}
|
|
}
|
|
|
|
/// The local state of a [`Menu`].
|
|
#[derive(Debug)]
|
|
pub struct State {
|
|
tree: Tree,
|
|
}
|
|
|
|
impl State {
|
|
/// Creates a new [`State`] for a [`Menu`].
|
|
pub fn new() -> Self {
|
|
Self {
|
|
tree: Tree::empty(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Default for State {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
struct Overlay<'a, Message, Theme, Renderer>
|
|
where
|
|
Renderer: crate::core::Renderer,
|
|
{
|
|
position: Point,
|
|
state: &'a mut Tree,
|
|
container: Container<'a, Message, Theme, Renderer>,
|
|
width: f32,
|
|
target_height: f32,
|
|
style: Style<Theme>,
|
|
}
|
|
|
|
impl<'a, Message, Theme, Renderer> Overlay<'a, Message, Theme, Renderer>
|
|
where
|
|
Message: 'a,
|
|
Theme: 'a,
|
|
Renderer: text::Renderer + 'a,
|
|
{
|
|
pub fn new<T>(
|
|
position: Point,
|
|
menu: Menu<'a, T, Message, Theme, Renderer>,
|
|
target_height: f32,
|
|
) -> Self
|
|
where
|
|
T: Clone + ToString,
|
|
{
|
|
let Menu {
|
|
state,
|
|
options,
|
|
hovered_option,
|
|
on_selected,
|
|
on_option_hovered,
|
|
width,
|
|
padding,
|
|
font,
|
|
text_size,
|
|
text_line_height,
|
|
text_shaping,
|
|
style,
|
|
} = menu;
|
|
|
|
let container = Container::with_style(
|
|
Scrollable::with_direction_and_style(
|
|
List {
|
|
options,
|
|
hovered_option,
|
|
on_selected,
|
|
on_option_hovered,
|
|
font,
|
|
text_size,
|
|
text_line_height,
|
|
text_shaping,
|
|
padding,
|
|
style: style.list,
|
|
},
|
|
scrollable::Direction::default(),
|
|
style.scrollable,
|
|
),
|
|
container::transparent,
|
|
);
|
|
|
|
state.tree.diff(&container as &dyn Widget<_, _, _>);
|
|
|
|
Self {
|
|
position,
|
|
state: &mut state.tree,
|
|
container,
|
|
width,
|
|
target_height,
|
|
style,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Theme, Renderer>
|
|
crate::core::Overlay<Message, Theme, Renderer>
|
|
for Overlay<'a, Message, Theme, Renderer>
|
|
where
|
|
Renderer: text::Renderer,
|
|
{
|
|
fn layout(&mut self, renderer: &Renderer, bounds: Size) -> layout::Node {
|
|
let space_below =
|
|
bounds.height - (self.position.y + self.target_height);
|
|
let space_above = self.position.y;
|
|
|
|
let limits = layout::Limits::new(
|
|
Size::ZERO,
|
|
Size::new(
|
|
bounds.width - self.position.x,
|
|
if space_below > space_above {
|
|
space_below
|
|
} else {
|
|
space_above
|
|
},
|
|
),
|
|
)
|
|
.width(self.width);
|
|
|
|
let node = self.container.layout(self.state, renderer, &limits);
|
|
let size = node.size();
|
|
|
|
node.move_to(if space_below > space_above {
|
|
self.position + Vector::new(0.0, self.target_height)
|
|
} else {
|
|
self.position - Vector::new(0.0, size.height)
|
|
})
|
|
}
|
|
|
|
fn on_event(
|
|
&mut self,
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
renderer: &Renderer,
|
|
clipboard: &mut dyn Clipboard,
|
|
shell: &mut Shell<'_, Message>,
|
|
) -> event::Status {
|
|
let bounds = layout.bounds();
|
|
|
|
self.container.on_event(
|
|
self.state, event, layout, cursor, renderer, clipboard, shell,
|
|
&bounds,
|
|
)
|
|
}
|
|
|
|
fn mouse_interaction(
|
|
&self,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
viewport: &Rectangle,
|
|
renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
self.container
|
|
.mouse_interaction(self.state, layout, cursor, viewport, renderer)
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
renderer: &mut Renderer,
|
|
theme: &Theme,
|
|
style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
) {
|
|
let bounds = layout.bounds();
|
|
|
|
let appearance = (self.style.list)(theme);
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds,
|
|
border: appearance.border,
|
|
..renderer::Quad::default()
|
|
},
|
|
appearance.background,
|
|
);
|
|
|
|
self.container
|
|
.draw(self.state, renderer, theme, style, layout, cursor, &bounds);
|
|
}
|
|
}
|
|
|
|
struct List<'a, T, Message, Theme, Renderer>
|
|
where
|
|
Renderer: text::Renderer,
|
|
{
|
|
options: &'a [T],
|
|
hovered_option: &'a mut Option<usize>,
|
|
on_selected: Box<dyn FnMut(T) -> Message + 'a>,
|
|
on_option_hovered: Option<&'a dyn Fn(T) -> Message>,
|
|
padding: Padding,
|
|
text_size: Option<Pixels>,
|
|
text_line_height: text::LineHeight,
|
|
text_shaping: text::Shaping,
|
|
font: Option<Renderer::Font>,
|
|
style: fn(&Theme) -> Appearance,
|
|
}
|
|
|
|
impl<'a, T, Message, Theme, Renderer> Widget<Message, Theme, Renderer>
|
|
for List<'a, T, Message, Theme, Renderer>
|
|
where
|
|
T: Clone + ToString,
|
|
Renderer: text::Renderer,
|
|
{
|
|
fn size(&self) -> Size<Length> {
|
|
Size {
|
|
width: Length::Fill,
|
|
height: Length::Shrink,
|
|
}
|
|
}
|
|
|
|
fn layout(
|
|
&self,
|
|
_tree: &mut Tree,
|
|
renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
) -> layout::Node {
|
|
use std::f32;
|
|
|
|
let text_size =
|
|
self.text_size.unwrap_or_else(|| renderer.default_size());
|
|
|
|
let text_line_height = self.text_line_height.to_absolute(text_size);
|
|
|
|
let size = {
|
|
let intrinsic = Size::new(
|
|
0.0,
|
|
(f32::from(text_line_height) + self.padding.vertical())
|
|
* self.options.len() as f32,
|
|
);
|
|
|
|
limits.resolve(Length::Fill, Length::Shrink, intrinsic)
|
|
};
|
|
|
|
layout::Node::new(size)
|
|
}
|
|
|
|
fn on_event(
|
|
&mut self,
|
|
_state: &mut Tree,
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
renderer: &Renderer,
|
|
_clipboard: &mut dyn Clipboard,
|
|
shell: &mut Shell<'_, Message>,
|
|
_viewport: &Rectangle,
|
|
) -> event::Status {
|
|
match event {
|
|
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) => {
|
|
if cursor.is_over(layout.bounds()) {
|
|
if let Some(index) = *self.hovered_option {
|
|
if let Some(option) = self.options.get(index) {
|
|
shell.publish((self.on_selected)(option.clone()));
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
Event::Mouse(mouse::Event::CursorMoved { .. }) => {
|
|
if let Some(cursor_position) =
|
|
cursor.position_in(layout.bounds())
|
|
{
|
|
let text_size = self
|
|
.text_size
|
|
.unwrap_or_else(|| renderer.default_size());
|
|
|
|
let option_height =
|
|
f32::from(self.text_line_height.to_absolute(text_size))
|
|
+ self.padding.vertical();
|
|
|
|
let new_hovered_option =
|
|
(cursor_position.y / option_height) as usize;
|
|
|
|
if let Some(on_option_hovered) = self.on_option_hovered {
|
|
if *self.hovered_option != Some(new_hovered_option) {
|
|
if let Some(option) =
|
|
self.options.get(new_hovered_option)
|
|
{
|
|
shell
|
|
.publish(on_option_hovered(option.clone()));
|
|
}
|
|
}
|
|
}
|
|
|
|
*self.hovered_option = Some(new_hovered_option);
|
|
}
|
|
}
|
|
Event::Touch(touch::Event::FingerPressed { .. }) => {
|
|
if let Some(cursor_position) =
|
|
cursor.position_in(layout.bounds())
|
|
{
|
|
let text_size = self
|
|
.text_size
|
|
.unwrap_or_else(|| renderer.default_size());
|
|
|
|
let option_height =
|
|
f32::from(self.text_line_height.to_absolute(text_size))
|
|
+ self.padding.vertical();
|
|
|
|
*self.hovered_option =
|
|
Some((cursor_position.y / option_height) as usize);
|
|
|
|
if let Some(index) = *self.hovered_option {
|
|
if let Some(option) = self.options.get(index) {
|
|
shell.publish((self.on_selected)(option.clone()));
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
_ => {}
|
|
}
|
|
|
|
event::Status::Ignored
|
|
}
|
|
|
|
fn mouse_interaction(
|
|
&self,
|
|
_state: &Tree,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
_renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
let is_mouse_over = cursor.is_over(layout.bounds());
|
|
|
|
if is_mouse_over {
|
|
mouse::Interaction::Pointer
|
|
} else {
|
|
mouse::Interaction::default()
|
|
}
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
_state: &Tree,
|
|
renderer: &mut Renderer,
|
|
theme: &Theme,
|
|
_style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
_cursor: mouse::Cursor,
|
|
viewport: &Rectangle,
|
|
) {
|
|
let appearance = (self.style)(theme);
|
|
let bounds = layout.bounds();
|
|
|
|
let text_size =
|
|
self.text_size.unwrap_or_else(|| renderer.default_size());
|
|
let option_height =
|
|
f32::from(self.text_line_height.to_absolute(text_size))
|
|
+ self.padding.vertical();
|
|
|
|
let offset = viewport.y - bounds.y;
|
|
let start = (offset / option_height) as usize;
|
|
let end = ((offset + viewport.height) / option_height).ceil() as usize;
|
|
|
|
let visible_options = &self.options[start..end.min(self.options.len())];
|
|
|
|
for (i, option) in visible_options.iter().enumerate() {
|
|
let i = start + i;
|
|
let is_selected = *self.hovered_option == Some(i);
|
|
|
|
let bounds = Rectangle {
|
|
x: bounds.x,
|
|
y: bounds.y + (option_height * i as f32),
|
|
width: bounds.width,
|
|
height: option_height,
|
|
};
|
|
|
|
if is_selected {
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds: Rectangle {
|
|
x: bounds.x + appearance.border.width,
|
|
width: bounds.width - appearance.border.width * 2.0,
|
|
..bounds
|
|
},
|
|
border: Border::rounded(appearance.border.radius),
|
|
..renderer::Quad::default()
|
|
},
|
|
appearance.selected_background,
|
|
);
|
|
}
|
|
|
|
renderer.fill_text(
|
|
Text {
|
|
content: &option.to_string(),
|
|
bounds: Size::new(f32::INFINITY, bounds.height),
|
|
size: text_size,
|
|
line_height: self.text_line_height,
|
|
font: self.font.unwrap_or_else(|| renderer.default_font()),
|
|
horizontal_alignment: alignment::Horizontal::Left,
|
|
vertical_alignment: alignment::Vertical::Center,
|
|
shaping: self.text_shaping,
|
|
},
|
|
Point::new(bounds.x + self.padding.left, bounds.center_y()),
|
|
if is_selected {
|
|
appearance.selected_text_color
|
|
} else {
|
|
appearance.text_color
|
|
},
|
|
*viewport,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a, T, Message, Theme, Renderer>
|
|
From<List<'a, T, Message, Theme, Renderer>>
|
|
for Element<'a, Message, Theme, Renderer>
|
|
where
|
|
T: ToString + Clone,
|
|
Message: 'a,
|
|
Theme: 'a,
|
|
Renderer: 'a + text::Renderer,
|
|
{
|
|
fn from(list: List<'a, T, Message, Theme, Renderer>) -> Self {
|
|
Element::new(list)
|
|
}
|
|
}
|
|
|
|
/// The appearance of a [`Menu`].
|
|
#[derive(Debug, Clone, Copy)]
|
|
pub struct Appearance {
|
|
/// The [`Background`] of the menu.
|
|
pub background: Background,
|
|
/// The [`Border`] of the menu.
|
|
pub border: Border,
|
|
/// The text [`Color`] of the menu.
|
|
pub text_color: Color,
|
|
/// The text [`Color`] of a selected option in the menu.
|
|
pub selected_text_color: Color,
|
|
/// The background [`Color`] of a selected option in the menu.
|
|
pub selected_background: Background,
|
|
}
|
|
|
|
/// The style of the different parts of a [`Menu`].
|
|
#[derive(Debug, PartialEq, Eq)]
|
|
pub struct Style<Theme> {
|
|
/// The style of the list of the [`Menu`].
|
|
pub list: fn(&Theme) -> Appearance,
|
|
/// The style of the [`Scrollable`] of the [`Menu`].
|
|
pub scrollable: fn(&Theme, scrollable::Status) -> scrollable::Appearance,
|
|
}
|
|
|
|
impl Style<Theme> {
|
|
/// The default style of a [`Menu`] with the built-in [`Theme`].
|
|
pub const DEFAULT: Self = Self {
|
|
list: default,
|
|
scrollable: scrollable::default,
|
|
};
|
|
}
|
|
|
|
impl<Theme> Clone for Style<Theme> {
|
|
fn clone(&self) -> Self {
|
|
*self
|
|
}
|
|
}
|
|
|
|
impl<Theme> Copy for Style<Theme> {}
|
|
|
|
/// The default style of a [`Menu`].
|
|
pub trait DefaultStyle: Sized {
|
|
/// Returns the default style of a [`Menu`].
|
|
fn default_style() -> Style<Self>;
|
|
}
|
|
|
|
impl DefaultStyle for Theme {
|
|
fn default_style() -> Style<Self> {
|
|
Style::<Theme>::DEFAULT
|
|
}
|
|
}
|
|
|
|
/// The default style of the list of a [`Menu`].
|
|
pub fn default(theme: &Theme) -> Appearance {
|
|
let palette = theme.extended_palette();
|
|
|
|
Appearance {
|
|
background: palette.background.weak.color.into(),
|
|
border: Border {
|
|
width: 1.0,
|
|
radius: 0.0.into(),
|
|
color: palette.background.strong.color,
|
|
},
|
|
text_color: palette.background.weak.text,
|
|
selected_text_color: palette.primary.strong.text,
|
|
selected_background: palette.primary.strong.color.into(),
|
|
}
|
|
}
|