622 lines
18 KiB
Rust
622 lines
18 KiB
Rust
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
use cosmic::{
|
|
iced::{
|
|
alignment,
|
|
event::{self, Event},
|
|
keyboard, mouse, overlay,
|
|
overlay::menu::{self, Menu},
|
|
touch,
|
|
widget::container,
|
|
widget::scrollable,
|
|
Background, Color, Element, Length, Padding, Rectangle, Size,
|
|
},
|
|
iced_core::{
|
|
clipboard::Clipboard,
|
|
layout::{self, Layout},
|
|
renderer,
|
|
text::{self, LineHeight, Shaping, Text},
|
|
widget::tree::{self, Tree},
|
|
Shell, Widget,
|
|
},
|
|
};
|
|
use std::borrow::Cow;
|
|
|
|
/// The appearance of a pick list.
|
|
#[derive(Debug, Clone, Copy)]
|
|
pub struct Appearance {
|
|
/// The text [`Color`] of the pick list.
|
|
pub text_color: Color,
|
|
/// The placeholder [`Color`] of the pick list.
|
|
pub placeholder_color: Color,
|
|
/// The [`Background`] of the pick list.
|
|
pub background: Background,
|
|
/// The border radius of the pick list.
|
|
pub border_radius: f32,
|
|
/// The border width of the pick list.
|
|
pub border_width: f32,
|
|
/// The border color of the pick list.
|
|
pub border_color: Color,
|
|
}
|
|
|
|
/// A set of rules that dictate the style of a container.
|
|
pub trait StyleSheet {
|
|
/// The supported style of the [`StyleSheet`].
|
|
type Style: Default + Clone;
|
|
|
|
/// Produces the active [`Appearance`] of a pick list.
|
|
fn active(&self, style: &<Self as StyleSheet>::Style) -> Appearance;
|
|
|
|
/// Produces the hovered [`Appearance`] of a pick list.
|
|
fn hovered(&self, style: &<Self as StyleSheet>::Style) -> Appearance;
|
|
}
|
|
|
|
impl StyleSheet for cosmic::theme::Theme {
|
|
type Style = ();
|
|
|
|
fn active(&self, _style: &()) -> Appearance {
|
|
let cosmic = &self.cosmic().primary.component;
|
|
|
|
Appearance {
|
|
text_color: cosmic.on.into(),
|
|
background: Color::TRANSPARENT.into(),
|
|
placeholder_color: cosmic.on.into(),
|
|
border_radius: 8.0,
|
|
border_width: 0.0,
|
|
border_color: Color::TRANSPARENT,
|
|
}
|
|
}
|
|
|
|
fn hovered(&self, style: &()) -> Appearance {
|
|
let cosmic = &self.cosmic().primary.component;
|
|
|
|
Appearance {
|
|
background: Background::Color(cosmic.hover.into()),
|
|
..self.active(style)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A widget for selecting a single value from a list of options.
|
|
#[allow(missing_debug_implementations)]
|
|
pub struct MenuList<'a, T, Message, Renderer>
|
|
where
|
|
[T]: ToOwned<Owned = Vec<T>>,
|
|
Renderer: text::Renderer,
|
|
Renderer::Theme: StyleSheet,
|
|
{
|
|
on_selected: Box<dyn Fn(T) -> Message + 'a>,
|
|
options: Cow<'a, [T]>,
|
|
placeholder: Option<String>,
|
|
selected: Option<T>,
|
|
width: Length,
|
|
padding: Padding,
|
|
text_size: Option<u16>,
|
|
font: Renderer::Font,
|
|
style: <Renderer::Theme as StyleSheet>::Style,
|
|
}
|
|
|
|
impl<'a, T: 'a, Message, Renderer> MenuList<'a, T, Message, Renderer>
|
|
where
|
|
T: ToString + Eq,
|
|
[T]: ToOwned<Owned = Vec<T>>,
|
|
Renderer: text::Renderer,
|
|
<Renderer as text::Renderer>::Font: std::default::Default,
|
|
Renderer::Theme: StyleSheet + scrollable::StyleSheet + menu::StyleSheet + container::StyleSheet,
|
|
<Renderer::Theme as menu::StyleSheet>::Style: From<<Renderer::Theme as StyleSheet>::Style>,
|
|
{
|
|
/// The default padding of a [`MenuList`].
|
|
pub const DEFAULT_PADDING: Padding = Padding::new(8.0);
|
|
|
|
/// Creates a new [`MenuList`] with the given list of options, the current
|
|
/// selected value, and the message to produce when an option is selected.
|
|
pub fn new(
|
|
options: impl Into<Cow<'a, [T]>>,
|
|
selected: Option<T>,
|
|
on_selected: impl Fn(T) -> Message + 'a,
|
|
) -> Self {
|
|
Self {
|
|
on_selected: Box::new(on_selected),
|
|
options: options.into(),
|
|
placeholder: None,
|
|
selected,
|
|
width: Length::Shrink,
|
|
text_size: None,
|
|
padding: Self::DEFAULT_PADDING,
|
|
font: Default::default(),
|
|
style: Default::default(),
|
|
}
|
|
}
|
|
|
|
/// Sets the placeholder of the [`MenuList`].
|
|
pub fn placeholder(mut self, placeholder: impl Into<String>) -> Self {
|
|
self.placeholder = Some(placeholder.into());
|
|
self
|
|
}
|
|
|
|
/// Sets the width of the [`MenuList`].
|
|
pub fn width(mut self, width: Length) -> Self {
|
|
self.width = width;
|
|
self
|
|
}
|
|
|
|
/// Sets the [`Padding`] of the [`MenuList`].
|
|
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
|
|
self.padding = padding.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the text size of the [`MenuList`].
|
|
pub fn text_size(mut self, size: u16) -> Self {
|
|
self.text_size = Some(size);
|
|
self
|
|
}
|
|
|
|
/// Sets the font of the [`MenuList`].
|
|
pub fn font(mut self, font: Renderer::Font) -> Self {
|
|
self.font = font;
|
|
self
|
|
}
|
|
|
|
/// Sets the style of the [`MenuList`].
|
|
pub fn style(mut self, style: impl Into<<Renderer::Theme as StyleSheet>::Style>) -> Self {
|
|
self.style = style.into();
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a, T: 'a, Message, Renderer> Widget<Message, Renderer> for MenuList<'a, T, Message, Renderer>
|
|
where
|
|
T: Clone + ToString + Eq + 'static,
|
|
[T]: ToOwned<Owned = Vec<T>>,
|
|
Message: 'a,
|
|
Renderer: text::Renderer + 'a,
|
|
Renderer::Theme: StyleSheet + scrollable::StyleSheet + menu::StyleSheet + container::StyleSheet,
|
|
<Renderer::Theme as menu::StyleSheet>::Style: From<<Renderer::Theme as StyleSheet>::Style>,
|
|
{
|
|
fn tag(&self) -> tree::Tag {
|
|
tree::Tag::of::<State<T>>()
|
|
}
|
|
|
|
fn state(&self) -> tree::State {
|
|
tree::State::new(State::<T>::new())
|
|
}
|
|
|
|
fn width(&self) -> Length {
|
|
self.width
|
|
}
|
|
|
|
fn height(&self) -> Length {
|
|
Length::Shrink
|
|
}
|
|
|
|
fn layout(&self, renderer: &Renderer, limits: &layout::Limits) -> layout::Node {
|
|
layout(
|
|
renderer,
|
|
limits,
|
|
self.width,
|
|
self.padding,
|
|
self.text_size,
|
|
&self.font,
|
|
self.placeholder.as_deref(),
|
|
&self.options,
|
|
)
|
|
}
|
|
|
|
fn on_event(
|
|
&mut self,
|
|
tree: &mut Tree,
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor_position: mouse::Cursor,
|
|
_renderer: &Renderer,
|
|
_clipboard: &mut dyn Clipboard,
|
|
shell: &mut Shell<'_, Message>,
|
|
_viewport: &Rectangle<f32>,
|
|
) -> event::Status {
|
|
update(
|
|
event,
|
|
layout,
|
|
cursor_position,
|
|
shell,
|
|
self.on_selected.as_ref(),
|
|
self.selected.as_ref(),
|
|
&self.options,
|
|
|| tree.state.downcast_mut::<State<T>>(),
|
|
)
|
|
}
|
|
|
|
fn mouse_interaction(
|
|
&self,
|
|
_tree: &Tree,
|
|
layout: Layout<'_>,
|
|
cursor_position: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
_renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
mouse_interaction(layout, cursor_position)
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
_tree: &Tree,
|
|
renderer: &mut Renderer,
|
|
theme: &Renderer::Theme,
|
|
_style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
cursor_position: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
) {
|
|
draw(
|
|
renderer,
|
|
theme,
|
|
layout,
|
|
cursor_position,
|
|
self.padding,
|
|
self.text_size,
|
|
&self.font,
|
|
self.placeholder.as_deref(),
|
|
self.selected.as_ref(),
|
|
&self.style,
|
|
)
|
|
}
|
|
|
|
fn overlay<'b>(
|
|
&'b mut self,
|
|
tree: &'b mut Tree,
|
|
layout: Layout<'_>,
|
|
renderer: &Renderer,
|
|
) -> Option<overlay::Element<'b, Message, Renderer>> {
|
|
let state = tree.state.downcast_mut::<State<T>>();
|
|
|
|
overlay(
|
|
renderer,
|
|
layout,
|
|
state,
|
|
self.padding,
|
|
self.text_size,
|
|
self.font.clone(),
|
|
&self.options,
|
|
&self.on_selected,
|
|
self.style.clone(),
|
|
)
|
|
}
|
|
}
|
|
|
|
impl<'a, T: 'a, Message, Renderer> From<MenuList<'a, T, Message, Renderer>>
|
|
for Element<'a, Message, Renderer>
|
|
where
|
|
T: Clone + ToString + Eq + 'static,
|
|
[T]: ToOwned<Owned = Vec<T>>,
|
|
Message: 'a,
|
|
Renderer: text::Renderer + 'a,
|
|
Renderer::Theme: StyleSheet + scrollable::StyleSheet + menu::StyleSheet + container::StyleSheet,
|
|
<Renderer::Theme as menu::StyleSheet>::Style: From<<Renderer::Theme as StyleSheet>::Style>,
|
|
{
|
|
fn from(menu_list: MenuList<'a, T, Message, Renderer>) -> Self {
|
|
Self::new(menu_list)
|
|
}
|
|
}
|
|
|
|
/// The local state of a [`MenuList`].
|
|
#[derive(Debug)]
|
|
pub struct State<T> {
|
|
menu: menu::State,
|
|
keyboard_modifiers: keyboard::Modifiers,
|
|
is_open: bool,
|
|
hovered_option: Option<usize>,
|
|
last_selection: Option<T>,
|
|
}
|
|
|
|
impl<T> State<T> {
|
|
/// Creates a new [`State`] for a [`MenuList`].
|
|
pub fn new() -> Self {
|
|
Self {
|
|
menu: menu::State::default(),
|
|
keyboard_modifiers: keyboard::Modifiers::default(),
|
|
is_open: bool::default(),
|
|
hovered_option: Option::default(),
|
|
last_selection: Option::default(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T> Default for State<T> {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
/// Computes the layout of a [`MenuList`].
|
|
pub fn layout<Renderer, T>(
|
|
renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
width: Length,
|
|
padding: Padding,
|
|
text_size: Option<u16>,
|
|
font: &Renderer::Font,
|
|
placeholder: Option<&str>,
|
|
options: &[T],
|
|
) -> layout::Node
|
|
where
|
|
Renderer: text::Renderer,
|
|
T: ToString,
|
|
{
|
|
use std::f32;
|
|
|
|
let limits = limits.width(width).height(Length::Shrink).pad(padding);
|
|
|
|
let text_size = text_size.unwrap_or_else(|| renderer.default_size() as u16);
|
|
|
|
let max_width = match width {
|
|
Length::Shrink => {
|
|
let measure = |label: &str| -> u32 {
|
|
let size = renderer.measure(
|
|
label,
|
|
text_size as f32,
|
|
LineHeight::default(),
|
|
font.clone(),
|
|
Size::new(f32::INFINITY, f32::INFINITY),
|
|
Shaping::Advanced,
|
|
);
|
|
|
|
size.width.round() as u32
|
|
};
|
|
|
|
placeholder.map(measure).unwrap_or(100)
|
|
}
|
|
_ => 0,
|
|
};
|
|
|
|
let size = {
|
|
let intrinsic = Size::new(max_width as f32, f32::from(text_size));
|
|
|
|
limits.resolve(intrinsic).pad(padding)
|
|
};
|
|
|
|
layout::Node::new(size)
|
|
}
|
|
|
|
/// Processes an [`Event`] and updates the [`State`] of a [`MenuList`]
|
|
/// accordingly.
|
|
pub fn update<'a, T, Message>(
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor_position: mouse::Cursor,
|
|
shell: &mut Shell<'_, Message>,
|
|
on_selected: &dyn Fn(T) -> Message,
|
|
selected: Option<&T>,
|
|
options: &[T],
|
|
state: impl FnOnce() -> &'a mut State<T>,
|
|
) -> event::Status
|
|
where
|
|
T: PartialEq + Clone + 'a,
|
|
{
|
|
match event {
|
|
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left))
|
|
| Event::Touch(touch::Event::FingerPressed { .. }) => {
|
|
let state = state();
|
|
|
|
let event_status = if state.is_open {
|
|
// Event wasn't processed by overlay, so cursor was clicked either outside it's
|
|
// bounds or on the drop-down, either way we close the overlay.
|
|
state.is_open = false;
|
|
|
|
event::Status::Captured
|
|
} else if cursor_position.is_over(layout.bounds()) {
|
|
state.is_open = true;
|
|
state.hovered_option = options.iter().position(|option| Some(option) == selected);
|
|
|
|
event::Status::Captured
|
|
} else {
|
|
event::Status::Ignored
|
|
};
|
|
|
|
if let Some(last_selection) = state.last_selection.take() {
|
|
shell.publish((on_selected)(last_selection));
|
|
|
|
state.is_open = false;
|
|
|
|
event::Status::Captured
|
|
} else {
|
|
event_status
|
|
}
|
|
}
|
|
Event::Mouse(mouse::Event::WheelScrolled {
|
|
delta: mouse::ScrollDelta::Lines { y, .. },
|
|
}) => {
|
|
let state = state();
|
|
|
|
if state.keyboard_modifiers.command()
|
|
&& cursor_position.is_over(layout.bounds())
|
|
&& !state.is_open
|
|
{
|
|
fn find_next<'a, T: PartialEq>(
|
|
selected: &'a T,
|
|
mut options: impl Iterator<Item = &'a T>,
|
|
) -> Option<&'a T> {
|
|
let _ = options.find(|&option| option == selected);
|
|
|
|
options.next()
|
|
}
|
|
|
|
let next_option = if y < 0.0 {
|
|
if let Some(selected) = selected {
|
|
find_next(selected, options.iter())
|
|
} else {
|
|
options.first()
|
|
}
|
|
} else if y > 0.0 {
|
|
if let Some(selected) = selected {
|
|
find_next(selected, options.iter().rev())
|
|
} else {
|
|
options.last()
|
|
}
|
|
} else {
|
|
None
|
|
};
|
|
|
|
if let Some(next_option) = next_option {
|
|
shell.publish((on_selected)(next_option.clone()));
|
|
}
|
|
|
|
event::Status::Captured
|
|
} else {
|
|
event::Status::Ignored
|
|
}
|
|
}
|
|
Event::Keyboard(keyboard::Event::ModifiersChanged(modifiers)) => {
|
|
let state = state();
|
|
|
|
state.keyboard_modifiers = modifiers;
|
|
|
|
event::Status::Ignored
|
|
}
|
|
_ => event::Status::Ignored,
|
|
}
|
|
}
|
|
|
|
/// Returns the current [`mouse::Interaction`] of a [`MenuList`].
|
|
pub fn mouse_interaction(layout: Layout<'_>, cursor_position: mouse::Cursor) -> mouse::Interaction {
|
|
let bounds = layout.bounds();
|
|
let is_mouse_over = cursor_position.is_over(bounds);
|
|
|
|
if is_mouse_over {
|
|
mouse::Interaction::Pointer
|
|
} else {
|
|
mouse::Interaction::default()
|
|
}
|
|
}
|
|
|
|
/// Returns the current overlay of a [`MenuList`].
|
|
pub fn overlay<'a, T, Message, Renderer>(
|
|
renderer: &Renderer,
|
|
layout: Layout<'_>,
|
|
state: &'a mut State<T>,
|
|
padding: Padding,
|
|
text_size: Option<u16>,
|
|
font: Renderer::Font,
|
|
options: &'a [T],
|
|
on_selected: &'a dyn Fn(T) -> Message,
|
|
style: <Renderer::Theme as StyleSheet>::Style,
|
|
) -> Option<overlay::Element<'a, Message, Renderer>>
|
|
where
|
|
T: Clone + ToString,
|
|
Message: 'a,
|
|
Renderer: text::Renderer + 'a,
|
|
Renderer::Theme: StyleSheet + scrollable::StyleSheet + menu::StyleSheet + container::StyleSheet,
|
|
<Renderer::Theme as menu::StyleSheet>::Style: From<<Renderer::Theme as StyleSheet>::Style>,
|
|
{
|
|
if state.is_open {
|
|
let bounds = layout.bounds();
|
|
|
|
let text_size = text_size.unwrap_or_else(|| renderer.default_size() as u16);
|
|
|
|
let width = {
|
|
let measure = |label: &str| -> u32 {
|
|
let size = renderer.measure(
|
|
label,
|
|
text_size as f32,
|
|
LineHeight::default(),
|
|
font.clone(),
|
|
Size::new(f32::INFINITY, f32::INFINITY),
|
|
Shaping::Advanced,
|
|
);
|
|
|
|
size.width.round() as u32
|
|
};
|
|
|
|
let labels = options.iter().map(ToString::to_string);
|
|
|
|
let labels_width = labels.map(|label| measure(&label)).max().unwrap_or(100);
|
|
|
|
labels_width as f32 + padding.left + padding.right
|
|
};
|
|
|
|
let menu = Menu::new(
|
|
&mut state.menu,
|
|
options,
|
|
&mut state.hovered_option,
|
|
|option| {
|
|
state.is_open = false;
|
|
|
|
(on_selected)(option)
|
|
},
|
|
None,
|
|
)
|
|
.width(width)
|
|
.padding(padding)
|
|
.font(font)
|
|
.style(style)
|
|
.text_size(text_size);
|
|
|
|
Some(menu.overlay(layout.position(), bounds.height))
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
|
|
/// Draws a [`MenuList`].
|
|
pub fn draw<T, Renderer>(
|
|
renderer: &mut Renderer,
|
|
theme: &Renderer::Theme,
|
|
layout: Layout<'_>,
|
|
cursor_position: mouse::Cursor,
|
|
padding: Padding,
|
|
text_size: Option<u16>,
|
|
font: &Renderer::Font,
|
|
placeholder: Option<&str>,
|
|
selected: Option<&T>,
|
|
style: &<Renderer::Theme as StyleSheet>::Style,
|
|
) where
|
|
Renderer: text::Renderer,
|
|
Renderer::Theme: StyleSheet,
|
|
T: ToString,
|
|
{
|
|
let bounds = layout.bounds();
|
|
let is_mouse_over = cursor_position.is_over(bounds);
|
|
let is_selected = selected.is_some();
|
|
|
|
let style = if is_mouse_over {
|
|
theme.hovered(style)
|
|
} else {
|
|
theme.active(style)
|
|
};
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds,
|
|
border_color: style.border_color,
|
|
border_width: style.border_width,
|
|
border_radius: style.border_radius.into(),
|
|
},
|
|
style.background,
|
|
);
|
|
|
|
let label = selected.map(ToString::to_string);
|
|
|
|
if let Some(label) = label.as_deref().or(placeholder) {
|
|
let text_size = text_size.map_or_else(|| renderer.default_size(), f32::from);
|
|
|
|
renderer.fill_text(Text {
|
|
content: label,
|
|
bounds: Rectangle {
|
|
x: bounds.x + f32::from(padding.left),
|
|
y: bounds.center_y() - text_size / 2.0,
|
|
width: bounds.width - f32::from(padding.horizontal()),
|
|
height: text_size,
|
|
},
|
|
size: text_size,
|
|
line_height: LineHeight::default(),
|
|
color: if is_selected {
|
|
style.text_color
|
|
} else {
|
|
style.placeholder_color
|
|
},
|
|
font: font.clone(),
|
|
horizontal_alignment: alignment::Horizontal::Left,
|
|
vertical_alignment: alignment::Vertical::Top,
|
|
shaping: Shaping::Advanced,
|
|
});
|
|
}
|
|
}
|