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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE-APACHE file or at:
// https://www.apache.org/licenses/LICENSE-2.0
//! `Slider` control
use super::{GripMsg, GripPart};
use kas::event::{Command, FocusSource};
use kas::prelude::*;
use kas::theme::Feature;
use std::fmt::Debug;
use std::ops::{Add, RangeInclusive, Sub};
use std::time::Duration;
/// Requirements on type used by [`Slider`]
///
/// Implementations are provided for standard float and integer types.
pub trait SliderValue:
Copy + Debug + PartialOrd + Add<Output = Self> + Sub<Output = Self> + 'static
{
/// The default step size (usually 1)
fn default_step() -> Self;
/// Divide self by another instance of this type, returning an `f64`
///
/// Note: in practice, we always have `rhs >= self` and expect the result
/// to be between 0 and 1.
fn div_as_f64(self, rhs: Self) -> f64;
/// Return the result of multiplying self by an `f64` scalar
///
/// Note: the `scalar` is expected to be between 0 and 1, hence this
/// operation should not produce a value larger than self.
///
/// Also note that this method is not required to preserve precision
/// (e.g. `u128::mul_64` may drop some low-order bits with large numbers).
#[must_use]
fn mul_f64(self, scalar: f64) -> Self;
}
impl SliderValue for f64 {
fn default_step() -> Self {
1.0
}
fn div_as_f64(self, rhs: Self) -> f64 {
self / rhs
}
fn mul_f64(self, scalar: f64) -> Self {
self * scalar
}
}
impl SliderValue for f32 {
fn default_step() -> Self {
1.0
}
fn div_as_f64(self, rhs: Self) -> f64 {
self as f64 / rhs as f64
}
fn mul_f64(self, scalar: f64) -> Self {
(self as f64 * scalar) as f32
}
}
macro_rules! impl_slider_ty {
($ty:ty) => {
impl SliderValue for $ty {
fn default_step() -> Self {
1
}
fn div_as_f64(self, rhs: Self) -> f64 {
self as f64 / rhs as f64
}
fn mul_f64(self, scalar: f64) -> Self {
let r = (self as f64 * scalar).round();
assert!(<$ty>::MIN as f64 <= r && r <= <$ty>::MAX as f64);
r as $ty
}
}
};
($ty:ty, $($tt:ty),*) => {
impl_slider_ty!($ty);
impl_slider_ty!($($tt),*);
};
}
impl_slider_ty!(i8, i16, i32, i64, i128, isize);
impl_slider_ty!(u8, u16, u32, u64, u128, usize);
/// Implement for [`Duration`]
///
/// The default step size is 1 second.
impl SliderValue for Duration {
fn default_step() -> Self {
Duration::from_secs(1)
}
fn div_as_f64(self, rhs: Self) -> f64 {
self.as_secs_f64() / rhs.as_secs_f64()
}
fn mul_f64(self, scalar: f64) -> Self {
self.mul_f64(scalar)
}
}
impl_scope! {
/// A slider
///
/// Sliders allow user input of a value from a fixed range.
#[autoimpl(Debug ignore self.state_fn, self.on_move)]
#[widget{
navigable = true;
hover_highlight = true;
}]
pub struct Slider<A, T: SliderValue, D: Directional = Direction> {
core: widget_core!(),
align: AlignPair,
direction: D,
// Terminology assumes vertical orientation:
range: (T, T),
step: T,
value: T,
#[widget(&())]
grip: GripPart,
state_fn: Box<dyn Fn(&ConfigCx, &A) -> T>,
on_move: Option<Box<dyn Fn(&mut EventCx, &A, T)>>,
}
impl Self
where
D: Default,
{
/// Construct a slider
///
/// Values vary within the given `range`, increasing in the given
/// `direction`. The default step size is
/// 1 for common types (see [`SliderValue::default_step`]).
///
/// The slider's current value is set by `state_fn` on update.
///
/// To make the slider interactive, assign an event handler with
/// [`Self::with`] or [`Self::with_msg`].
#[inline]
pub fn new(range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx, &A) -> T + 'static) -> Self {
Slider::new_dir(range, state_fn, D::default())
}
}
impl<A, T: SliderValue> Slider<A, T, kas::dir::Left> {
/// Construct with fixed direction
#[inline]
pub fn left(range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx, &A) -> T + 'static) -> Self {
Slider::new(range, state_fn)
}
}
impl<A, T: SliderValue> Slider<A, T, kas::dir::Right> {
/// Construct with fixed direction
#[inline]
pub fn right(range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx, &A) -> T + 'static) -> Self {
Slider::new(range, state_fn)
}
}
impl<A, T: SliderValue> Slider<A, T, kas::dir::Up> {
/// Construct with fixed direction
#[inline]
pub fn up(range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx, &A) -> T + 'static) -> Self {
Slider::new(range, state_fn)
}
}
impl<A, T: SliderValue> Slider<A, T, kas::dir::Down> {
/// Construct with fixed direction
#[inline]
pub fn down(range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx, &A) -> T + 'static) -> Self {
Slider::new(range, state_fn)
}
}
impl Self {
/// Construct a slider with given direction
///
/// Values vary within the given `range`, increasing in the given
/// `direction`. The default step size is
/// 1 for common types (see [`SliderValue::default_step`]).
///
/// The slider's current value is set by `state_fn` on update.
///
/// To make the slider interactive, assign an event handler with
/// [`Self::with`] or [`Self::with_msg`].
#[inline]
pub fn new_dir(
range: RangeInclusive<T>,
state_fn: impl Fn(&ConfigCx, &A) -> T + 'static,
direction: D,
) -> Self {
assert!(!range.is_empty());
let value = *range.start();
Slider {
core: Default::default(),
align: Default::default(),
direction,
range: range.into_inner(),
step: T::default_step(),
value,
grip: GripPart::new(),
state_fn: Box::new(state_fn),
on_move: None,
}
}
/// Send the message generated by `f` on movement
#[inline]
#[must_use]
pub fn with_msg<M>(self, f: impl Fn(T) -> M + 'static) -> Self
where
M: std::fmt::Debug + 'static,
{
self.with(move |cx, _, state| cx.push(f(state)))
}
/// Call the handler `f` on movement
#[inline]
#[must_use]
pub fn with(mut self, f: impl Fn(&mut EventCx, &A, T) + 'static) -> Self {
debug_assert!(self.on_move.is_none());
self.on_move = Some(Box::new(f));
self
}
/// Get the slider's direction
#[inline]
pub fn direction(&self) -> Direction {
self.direction.as_direction()
}
/// Set the step size
#[inline]
#[must_use]
pub fn with_step(mut self, step: T) -> Self {
self.step = step;
self
}
/// Set value and update grip
#[allow(clippy::neg_cmp_op_on_partial_ord)]
fn set_value(&mut self, value: T) -> Action {
let value = if !(value >= self.range.0) {
self.range.0
} else if !(value <= self.range.1) {
self.range.1
} else {
value
};
if value == self.value {
return Action::empty();
}
self.value = value;
self.grip.set_offset(self.offset()).1
}
// translate value to offset in local coordinates
fn offset(&self) -> Offset {
let a = self.value - self.range.0;
let b = self.range.1 - self.range.0;
let max_offset = self.grip.max_offset();
let mut frac = a.div_as_f64(b);
assert!((0.0..=1.0).contains(&frac));
if self.direction.is_reversed() {
frac = 1.0 - frac;
}
match self.direction.is_vertical() {
false => Offset((max_offset.0 as f64 * frac).cast_floor(), 0),
true => Offset(0, (max_offset.1 as f64 * frac).cast_floor()),
}
}
fn apply_grip_offset(&mut self, cx: &mut EventCx, data: &A, offset: Offset) {
let b = self.range.1 - self.range.0;
let max_offset = self.grip.max_offset();
let mut a = match self.direction.is_vertical() {
false => b.mul_f64(offset.0 as f64 / max_offset.0 as f64),
true => b.mul_f64(offset.1 as f64 / max_offset.1 as f64),
};
if self.direction.is_reversed() {
a = b - a;
}
let action = self.set_value(a + self.range.0);
if !action.is_empty() {
cx.action(&self, action);
if let Some(ref f) = self.on_move {
f(cx, data, self.value);
}
}
}
}
impl Layout for Self {
fn size_rules(&mut self, sizer: SizeCx, axis: AxisInfo) -> SizeRules {
self.align.set_component(
axis,
match axis.is_vertical() == self.direction.is_vertical() {
false => axis.align_or_center(),
true => axis.align_or_stretch(),
},
);
let _ = self.grip.size_rules(sizer.re(), axis);
sizer.feature(Feature::Slider(self.direction()), axis)
}
fn set_rect(&mut self, cx: &mut ConfigCx, rect: Rect) {
let rect = cx.align_feature(Feature::Slider(self.direction()), rect, self.align);
self.core.rect = rect;
self.grip.set_rect(cx, rect);
let mut size = rect.size;
size.set_component(self.direction, cx.size_cx().grip_len());
let _ = self.grip.set_size_and_offset(size, self.offset());
}
fn find_id(&mut self, coord: Coord) -> Option<Id> {
if !self.rect().contains(coord) {
return None;
}
if self.on_move.is_some() {
if let Some(id) = self.grip.find_id(coord) {
return Some(id);
}
}
Some(self.id())
}
fn draw(&mut self, mut draw: DrawCx) {
let dir = self.direction.as_direction();
draw.slider(self.rect(), &self.grip, dir);
}
}
impl Events for Self {
type Data = A;
fn update(&mut self, cx: &mut ConfigCx, data: &A) {
let action = self.set_value((self.state_fn)(cx, data));
cx.action(self, action);
}
fn handle_event(&mut self, cx: &mut EventCx, data: &A, event: Event) -> IsUsed {
if self.on_move.is_none() {
return Unused;
}
match event {
Event::Command(cmd, code) => {
let rev = self.direction.is_reversed();
let value = match cmd {
Command::Left | Command::Up => match rev {
false => self.value - self.step,
true => self.value + self.step,
},
Command::Right | Command::Down => match rev {
false => self.value + self.step,
true => self.value - self.step,
},
Command::PageUp | Command::PageDown => {
// Generics makes this easier than constructing a literal and multiplying!
let mut x = self.step + self.step;
x = x + x;
x = x + x;
x = x + x;
match rev == (cmd == Command::PageDown) {
false => self.value + x,
true => self.value - x,
}
}
Command::Home => self.range.0,
Command::End => self.range.1,
_ => return Unused,
};
if let Some(code) = code {
cx.depress_with_key(self.id(), code);
}
let action = self.set_value(value);
if !action.is_empty() {
cx.action(&self, action);
if let Some(ref f) = self.on_move {
f(cx, data, self.value);
}
}
}
Event::PressStart { press } => {
let offset = self.grip.handle_press_on_track(cx, &press);
self.apply_grip_offset(cx, data, offset);
}
_ => return Unused,
}
Used
}
fn handle_messages(&mut self, cx: &mut EventCx, data: &A) {
if self.on_move.is_none() {
return;
}
match cx.try_pop() {
Some(GripMsg::PressStart) => cx.set_nav_focus(self.id(), FocusSource::Synthetic),
Some(GripMsg::PressMove(pos)) => {
self.apply_grip_offset(cx, data, pos);
}
_ => (),
}
}
}
}