557 lines
15 KiB
Rust
557 lines
15 KiB
Rust
//! Display an interactive selector of a single value from a range of values.
|
|
//!
|
|
//! A [`Slider`] has some local [`State`].
|
|
use crate::core::event::{self, Event};
|
|
use crate::core::keyboard;
|
|
use crate::core::keyboard::key::{self, Key};
|
|
use crate::core::layout;
|
|
use crate::core::mouse;
|
|
use crate::core::renderer;
|
|
use crate::core::touch;
|
|
use crate::core::widget::tree::{self, Tree};
|
|
use crate::core::{
|
|
Border, Clipboard, Element, Layout, Length, Pixels, Point, Rectangle,
|
|
Shell, Size, Widget,
|
|
};
|
|
|
|
use std::ops::RangeInclusive;
|
|
|
|
pub use iced_style::slider::{
|
|
Appearance, Handle, HandleShape, Rail, StyleSheet,
|
|
};
|
|
|
|
/// An horizontal bar and a handle that selects a single value from a range of
|
|
/// values.
|
|
///
|
|
/// A [`Slider`] will try to fill the horizontal space of its container.
|
|
///
|
|
/// The [`Slider`] range of numeric values is generic and its step size defaults
|
|
/// to 1 unit.
|
|
///
|
|
/// # Example
|
|
/// ```no_run
|
|
/// # type Slider<'a, T, Message> =
|
|
/// # iced_widget::Slider<'a, Message, T, iced_widget::style::Theme>;
|
|
/// #
|
|
/// #[derive(Clone)]
|
|
/// pub enum Message {
|
|
/// SliderChanged(f32),
|
|
/// }
|
|
///
|
|
/// let value = 50.0;
|
|
///
|
|
/// Slider::new(0.0..=100.0, value, Message::SliderChanged);
|
|
/// ```
|
|
///
|
|
/// 
|
|
#[allow(missing_debug_implementations)]
|
|
pub struct Slider<'a, T, Message, Theme = crate::Theme>
|
|
where
|
|
Theme: StyleSheet,
|
|
{
|
|
range: RangeInclusive<T>,
|
|
step: T,
|
|
shift_step: Option<T>,
|
|
value: T,
|
|
default: Option<T>,
|
|
on_change: Box<dyn Fn(T) -> Message + 'a>,
|
|
on_release: Option<Message>,
|
|
width: Length,
|
|
height: f32,
|
|
style: Theme::Style,
|
|
}
|
|
|
|
impl<'a, T, Message, Theme> Slider<'a, T, Message, Theme>
|
|
where
|
|
T: Copy + From<u8> + PartialOrd,
|
|
Message: Clone,
|
|
Theme: StyleSheet,
|
|
{
|
|
/// The default height of a [`Slider`].
|
|
pub const DEFAULT_HEIGHT: f32 = 22.0;
|
|
|
|
/// Creates a new [`Slider`].
|
|
///
|
|
/// It expects:
|
|
/// * an inclusive range of possible values
|
|
/// * the current value of the [`Slider`]
|
|
/// * a function that will be called when the [`Slider`] is dragged.
|
|
/// It receives the new value of the [`Slider`] and must produce a
|
|
/// `Message`.
|
|
pub fn new<F>(range: RangeInclusive<T>, value: T, on_change: F) -> Self
|
|
where
|
|
F: 'a + Fn(T) -> Message,
|
|
{
|
|
let value = if value >= *range.start() {
|
|
value
|
|
} else {
|
|
*range.start()
|
|
};
|
|
|
|
let value = if value <= *range.end() {
|
|
value
|
|
} else {
|
|
*range.end()
|
|
};
|
|
|
|
Slider {
|
|
value,
|
|
default: None,
|
|
range,
|
|
step: T::from(1),
|
|
shift_step: None,
|
|
on_change: Box::new(on_change),
|
|
on_release: None,
|
|
width: Length::Fill,
|
|
height: Self::DEFAULT_HEIGHT,
|
|
style: Default::default(),
|
|
}
|
|
}
|
|
|
|
/// Sets the optional default value for the [`Slider`].
|
|
///
|
|
/// If set, the [`Slider`] will reset to this value when ctrl-clicked or command-clicked.
|
|
pub fn default(mut self, default: impl Into<T>) -> Self {
|
|
self.default = Some(default.into());
|
|
self
|
|
}
|
|
|
|
/// Sets the release message of the [`Slider`].
|
|
/// This is called when the mouse is released from the slider.
|
|
///
|
|
/// Typically, the user's interaction with the slider is finished when this message is produced.
|
|
/// This is useful if you need to spawn a long-running task from the slider's result, where
|
|
/// the default on_change message could create too many events.
|
|
pub fn on_release(mut self, on_release: Message) -> Self {
|
|
self.on_release = Some(on_release);
|
|
self
|
|
}
|
|
|
|
/// Sets the width of the [`Slider`].
|
|
pub fn width(mut self, width: impl Into<Length>) -> Self {
|
|
self.width = width.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the height of the [`Slider`].
|
|
pub fn height(mut self, height: impl Into<Pixels>) -> Self {
|
|
self.height = height.into().0;
|
|
self
|
|
}
|
|
|
|
/// Sets the style of the [`Slider`].
|
|
pub fn style(mut self, style: impl Into<Theme::Style>) -> Self {
|
|
self.style = style.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the step size of the [`Slider`].
|
|
pub fn step(mut self, step: impl Into<T>) -> Self {
|
|
self.step = step.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the optional "shift" step for the [`Slider`].
|
|
///
|
|
/// If set, this value is used as the step while the shift key is pressed.
|
|
pub fn shift_step(mut self, shift_step: impl Into<T>) -> Self {
|
|
self.shift_step = Some(shift_step.into());
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a, T, Message, Theme, Renderer> Widget<Message, Theme, Renderer>
|
|
for Slider<'a, T, Message, Theme>
|
|
where
|
|
T: Copy + Into<f64> + num_traits::FromPrimitive,
|
|
Message: Clone,
|
|
Theme: StyleSheet,
|
|
Renderer: crate::core::Renderer,
|
|
{
|
|
fn tag(&self) -> tree::Tag {
|
|
tree::Tag::of::<State>()
|
|
}
|
|
|
|
fn state(&self) -> tree::State {
|
|
tree::State::new(State::new())
|
|
}
|
|
|
|
fn size(&self) -> Size<Length> {
|
|
Size {
|
|
width: self.width,
|
|
height: Length::Shrink,
|
|
}
|
|
}
|
|
|
|
fn layout(
|
|
&self,
|
|
_tree: &mut Tree,
|
|
_renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
) -> layout::Node {
|
|
layout::atomic(limits, self.width, self.height)
|
|
}
|
|
|
|
fn on_event(
|
|
&mut self,
|
|
tree: &mut Tree,
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_renderer: &Renderer,
|
|
_clipboard: &mut dyn Clipboard,
|
|
shell: &mut Shell<'_, Message>,
|
|
_viewport: &Rectangle,
|
|
) -> event::Status {
|
|
update(
|
|
event,
|
|
layout,
|
|
cursor,
|
|
shell,
|
|
tree.state.downcast_mut::<State>(),
|
|
&mut self.value,
|
|
self.default,
|
|
&self.range,
|
|
self.step,
|
|
self.shift_step,
|
|
self.on_change.as_ref(),
|
|
&self.on_release,
|
|
)
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
tree: &Tree,
|
|
renderer: &mut Renderer,
|
|
theme: &Theme,
|
|
_style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
) {
|
|
draw(
|
|
renderer,
|
|
layout,
|
|
cursor,
|
|
tree.state.downcast_ref::<State>(),
|
|
self.value,
|
|
&self.range,
|
|
theme,
|
|
&self.style,
|
|
);
|
|
}
|
|
|
|
fn mouse_interaction(
|
|
&self,
|
|
tree: &Tree,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
_renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
mouse_interaction(layout, cursor, tree.state.downcast_ref::<State>())
|
|
}
|
|
}
|
|
|
|
impl<'a, T, Message, Theme, Renderer> From<Slider<'a, T, Message, Theme>>
|
|
for Element<'a, Message, Theme, Renderer>
|
|
where
|
|
T: Copy + Into<f64> + num_traits::FromPrimitive + 'a,
|
|
Message: Clone + 'a,
|
|
Theme: StyleSheet + 'a,
|
|
Renderer: crate::core::Renderer + 'a,
|
|
{
|
|
fn from(
|
|
slider: Slider<'a, T, Message, Theme>,
|
|
) -> Element<'a, Message, Theme, Renderer> {
|
|
Element::new(slider)
|
|
}
|
|
}
|
|
|
|
/// Processes an [`Event`] and updates the [`State`] of a [`Slider`]
|
|
/// accordingly.
|
|
pub fn update<Message, T>(
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
shell: &mut Shell<'_, Message>,
|
|
state: &mut State,
|
|
value: &mut T,
|
|
default: Option<T>,
|
|
range: &RangeInclusive<T>,
|
|
step: T,
|
|
shift_step: Option<T>,
|
|
on_change: &dyn Fn(T) -> Message,
|
|
on_release: &Option<Message>,
|
|
) -> event::Status
|
|
where
|
|
T: Copy + Into<f64> + num_traits::FromPrimitive,
|
|
Message: Clone,
|
|
{
|
|
let is_dragging = state.is_dragging;
|
|
let current_value = *value;
|
|
|
|
let locate = |cursor_position: Point| -> Option<T> {
|
|
let bounds = layout.bounds();
|
|
let new_value = if cursor_position.x <= bounds.x {
|
|
Some(*range.start())
|
|
} else if cursor_position.x >= bounds.x + bounds.width {
|
|
Some(*range.end())
|
|
} else {
|
|
let step = if state.keyboard_modifiers.shift() {
|
|
shift_step.unwrap_or(step)
|
|
} else {
|
|
step
|
|
}
|
|
.into();
|
|
|
|
let start = (*range.start()).into();
|
|
let end = (*range.end()).into();
|
|
|
|
let percent = f64::from(cursor_position.x - bounds.x)
|
|
/ f64::from(bounds.width);
|
|
|
|
let steps = (percent * (end - start) / step).round();
|
|
let value = steps * step + start;
|
|
|
|
T::from_f64(value)
|
|
};
|
|
|
|
new_value
|
|
};
|
|
|
|
let increment = |value: T| -> Option<T> {
|
|
let step = if state.keyboard_modifiers.shift() {
|
|
shift_step.unwrap_or(step)
|
|
} else {
|
|
step
|
|
}
|
|
.into();
|
|
|
|
let steps = (value.into() / step).round();
|
|
let new_value = step * (steps + 1.0);
|
|
|
|
if new_value > (*range.end()).into() {
|
|
return Some(*range.end());
|
|
}
|
|
|
|
T::from_f64(new_value)
|
|
};
|
|
|
|
let decrement = |value: T| -> Option<T> {
|
|
let step = if state.keyboard_modifiers.shift() {
|
|
shift_step.unwrap_or(step)
|
|
} else {
|
|
step
|
|
}
|
|
.into();
|
|
|
|
let steps = (value.into() / step).round();
|
|
let new_value = step * (steps - 1.0);
|
|
|
|
if new_value < (*range.start()).into() {
|
|
return Some(*range.start());
|
|
}
|
|
|
|
T::from_f64(new_value)
|
|
};
|
|
|
|
let change = |new_value: T| {
|
|
if ((*value).into() - new_value.into()).abs() > f64::EPSILON {
|
|
shell.publish((on_change)(new_value));
|
|
|
|
*value = new_value;
|
|
}
|
|
};
|
|
|
|
match event {
|
|
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left))
|
|
| Event::Touch(touch::Event::FingerPressed { .. }) => {
|
|
if let Some(cursor_position) = cursor.position_over(layout.bounds())
|
|
{
|
|
if state.keyboard_modifiers.command() {
|
|
let _ = default.map(change);
|
|
state.is_dragging = false;
|
|
} else {
|
|
let _ = locate(cursor_position).map(change);
|
|
state.is_dragging = true;
|
|
}
|
|
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
Event::Mouse(mouse::Event::ButtonReleased(mouse::Button::Left))
|
|
| Event::Touch(touch::Event::FingerLifted { .. })
|
|
| Event::Touch(touch::Event::FingerLost { .. }) => {
|
|
if is_dragging {
|
|
if let Some(on_release) = on_release.clone() {
|
|
shell.publish(on_release);
|
|
}
|
|
state.is_dragging = false;
|
|
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
Event::Mouse(mouse::Event::CursorMoved { .. })
|
|
| Event::Touch(touch::Event::FingerMoved { .. }) => {
|
|
if is_dragging {
|
|
let _ = cursor.position().and_then(locate).map(change);
|
|
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
Event::Keyboard(keyboard::Event::KeyPressed { key, .. }) => {
|
|
if cursor.position_over(layout.bounds()).is_some() {
|
|
match key {
|
|
Key::Named(key::Named::ArrowUp) => {
|
|
let _ = increment(current_value).map(change);
|
|
}
|
|
Key::Named(key::Named::ArrowDown) => {
|
|
let _ = decrement(current_value).map(change);
|
|
}
|
|
_ => (),
|
|
}
|
|
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
Event::Keyboard(keyboard::Event::ModifiersChanged(modifiers)) => {
|
|
state.keyboard_modifiers = modifiers;
|
|
}
|
|
_ => {}
|
|
}
|
|
|
|
event::Status::Ignored
|
|
}
|
|
|
|
/// Draws a [`Slider`].
|
|
pub fn draw<T, Theme, Renderer>(
|
|
renderer: &mut Renderer,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
state: &State,
|
|
value: T,
|
|
range: &RangeInclusive<T>,
|
|
theme: &Theme,
|
|
style: &Theme::Style,
|
|
) where
|
|
T: Into<f64> + Copy,
|
|
Theme: StyleSheet,
|
|
Renderer: crate::core::Renderer,
|
|
{
|
|
let bounds = layout.bounds();
|
|
let is_mouse_over = cursor.is_over(bounds);
|
|
|
|
let style = if state.is_dragging {
|
|
theme.dragging(style)
|
|
} else if is_mouse_over {
|
|
theme.hovered(style)
|
|
} else {
|
|
theme.active(style)
|
|
};
|
|
|
|
let (handle_width, handle_height, handle_border_radius) =
|
|
match style.handle.shape {
|
|
HandleShape::Circle { radius } => {
|
|
(radius * 2.0, radius * 2.0, radius.into())
|
|
}
|
|
HandleShape::Rectangle {
|
|
width,
|
|
border_radius,
|
|
} => (f32::from(width), bounds.height, border_radius),
|
|
};
|
|
|
|
let value = value.into() as f32;
|
|
let (range_start, range_end) = {
|
|
let (start, end) = range.clone().into_inner();
|
|
|
|
(start.into() as f32, end.into() as f32)
|
|
};
|
|
|
|
let offset = if range_start >= range_end {
|
|
0.0
|
|
} else {
|
|
(bounds.width - handle_width) * (value - range_start)
|
|
/ (range_end - range_start)
|
|
};
|
|
|
|
let rail_y = bounds.y + bounds.height / 2.0;
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds: Rectangle {
|
|
x: bounds.x,
|
|
y: rail_y - style.rail.width / 2.0,
|
|
width: offset + handle_width / 2.0,
|
|
height: style.rail.width,
|
|
},
|
|
border: Border::with_radius(style.rail.border_radius),
|
|
..renderer::Quad::default()
|
|
},
|
|
style.rail.colors.0,
|
|
);
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds: Rectangle {
|
|
x: bounds.x + offset + handle_width / 2.0,
|
|
y: rail_y - style.rail.width / 2.0,
|
|
width: bounds.width - offset - handle_width / 2.0,
|
|
height: style.rail.width,
|
|
},
|
|
border: Border::with_radius(style.rail.border_radius),
|
|
..renderer::Quad::default()
|
|
},
|
|
style.rail.colors.1,
|
|
);
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds: Rectangle {
|
|
x: bounds.x + offset,
|
|
y: rail_y - handle_height / 2.0,
|
|
width: handle_width,
|
|
height: handle_height,
|
|
},
|
|
border: Border {
|
|
radius: handle_border_radius,
|
|
width: style.handle.border_width,
|
|
color: style.handle.border_color,
|
|
},
|
|
..renderer::Quad::default()
|
|
},
|
|
style.handle.color,
|
|
);
|
|
}
|
|
|
|
/// Computes the current [`mouse::Interaction`] of a [`Slider`].
|
|
pub fn mouse_interaction(
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
state: &State,
|
|
) -> mouse::Interaction {
|
|
let bounds = layout.bounds();
|
|
let is_mouse_over = cursor.is_over(bounds);
|
|
|
|
if state.is_dragging {
|
|
mouse::Interaction::Grabbing
|
|
} else if is_mouse_over {
|
|
mouse::Interaction::Grab
|
|
} else {
|
|
mouse::Interaction::default()
|
|
}
|
|
}
|
|
|
|
/// The local state of a [`Slider`].
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
|
|
pub struct State {
|
|
is_dragging: bool,
|
|
keyboard_modifiers: keyboard::Modifiers,
|
|
}
|
|
|
|
impl State {
|
|
/// Creates a new [`State`].
|
|
pub fn new() -> State {
|
|
State::default()
|
|
}
|
|
}
|