summaryrefslogtreecommitdiffstats
path: root/style/src/toggler.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-12-02 18:53:21 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-12-02 18:53:21 +0100
commit4029a1cdaaac1abbdcc141b20469a49670cd99b6 (patch)
tree71fa9d9c4aa1f02ce05771db43a4bb7bc6570e77 /style/src/toggler.rs
parent676d8efe03ebdbeeb95aef96b8097395b788b1ab (diff)
parent8b55e9b9e6ba0b83038dd491dd34d95b4f9a381b (diff)
downloadiced-4029a1cdaaac1abbdcc141b20469a49670cd99b6.tar.gz
iced-4029a1cdaaac1abbdcc141b20469a49670cd99b6.tar.bz2
iced-4029a1cdaaac1abbdcc141b20469a49670cd99b6.zip
Merge branch 'master' into non-uniform-border-radius-for-quads
Diffstat (limited to 'style/src/toggler.rs')
-rw-r--r--style/src/toggler.rs19
1 files changed, 15 insertions, 4 deletions
diff --git a/style/src/toggler.rs b/style/src/toggler.rs
index 0acf8e97..abc73f2a 100644
--- a/style/src/toggler.rs
+++ b/style/src/toggler.rs
@@ -1,20 +1,31 @@
-//! Show toggle controls using togglers.
+//! Change the appearance of a toggler.
use iced_core::Color;
/// The appearance of a toggler.
#[derive(Debug, Clone, Copy)]
pub struct Appearance {
+ /// The background [`Color`] of the toggler.
pub background: Color,
+ /// The [`Color`] of the background border of the toggler.
pub background_border: Option<Color>,
+ /// The foreground [`Color`] of the toggler.
pub foreground: Color,
+ /// The [`Color`] of the foreground border of the toggler.
pub foreground_border: Option<Color>,
}
/// A set of rules that dictate the style of a toggler.
pub trait StyleSheet {
- type Style: Default + Copy;
+ /// The supported style of the [`StyleSheet`].
+ type Style: Default;
- fn active(&self, style: Self::Style, is_active: bool) -> Appearance;
+ /// Returns the active [`Appearance`] of the toggler for the provided [`Style`].
+ ///
+ /// [`Style`]: Self::Style
+ fn active(&self, style: &Self::Style, is_active: bool) -> Appearance;
- fn hovered(&self, style: Self::Style, is_active: bool) -> Appearance;
+ /// Returns the hovered [`Appearance`] of the toggler for the provided [`Style`].
+ ///
+ /// [`Style`]: Self::Style
+ fn hovered(&self, style: &Self::Style, is_active: bool) -> Appearance;
}