Write documentation for iced_style

This commit is contained in:
Héctor Ramón Jiménez 2022-11-10 01:10:28 +01:00
parent bec1f5bbe0
commit 4b3d0fb08d
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
18 changed files with 261 additions and 56 deletions

View file

@ -1,31 +1,48 @@
//! Display an interactive selector of a single value from a range of values.
//! Change the apperance of a slider.
use iced_core::Color;
/// The appearance of a slider.
#[derive(Debug, Clone, Copy)]
pub struct Appearance {
/// The colors of the rail of the slider.
pub rail_colors: (Color, Color),
/// The appearance of the [`Handle`] of the slider.
pub handle: Handle,
}
/// The appearance of the handle of a slider.
#[derive(Debug, Clone, Copy)]
pub struct Handle {
/// The shape of the handle.
pub shape: HandleShape,
/// The [`Color`] of the handle.
pub color: Color,
/// The border width of the handle.
pub border_width: f32,
/// The border [`Color`] of the handle.
pub border_color: Color,
}
/// The shape of the handle of a slider.
#[derive(Debug, Clone, Copy)]
pub enum HandleShape {
Circle { radius: f32 },
Rectangle { width: u16, border_radius: f32 },
/// A circular handle.
Circle {
/// The radius of the circle.
radius: f32,
},
/// A rectangular shape.
Rectangle {
/// The width of the rectangle.
width: u16,
/// The border radius of the corners of the rectangle.
border_radius: f32,
},
}
/// A set of rules that dictate the style of a slider.
pub trait StyleSheet {
/// The supported style of the [`StyleSheet`].
type Style: Default;
/// Produces the style of an active slider.