diff options
author | 2022-11-10 01:10:28 +0100 | |
---|---|---|
committer | 2022-11-10 01:10:28 +0100 | |
commit | 4b3d0fb08d5b2e84c1061fa601b71363b6719f59 (patch) | |
tree | b5397a0ae874c523dcd755ff7e16f0ba5239f10e /style/src/slider.rs | |
parent | bec1f5bbe0e0fec0d57b66ee227c41f15165057e (diff) | |
download | iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.gz iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.bz2 iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.zip |
Write documentation for `iced_style`
Diffstat (limited to '')
-rw-r--r-- | style/src/slider.rs | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/style/src/slider.rs b/style/src/slider.rs index 73ee097b..4b52fad3 100644 --- a/style/src/slider.rs +++ b/style/src/slider.rs @@ -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. |