summaryrefslogtreecommitdiffstats
path: root/style/src/toggler.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-11-10 01:10:28 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-11-10 01:10:28 +0100
commit4b3d0fb08d5b2e84c1061fa601b71363b6719f59 (patch)
treeb5397a0ae874c523dcd755ff7e16f0ba5239f10e /style/src/toggler.rs
parentbec1f5bbe0e0fec0d57b66ee227c41f15165057e (diff)
downloadiced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.gz
iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.bz2
iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.zip
Write documentation for `iced_style`
Diffstat (limited to '')
-rw-r--r--style/src/toggler.rs13
1 files changed, 12 insertions, 1 deletions
diff --git a/style/src/toggler.rs b/style/src/toggler.rs
index fcc7e45b..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 {
+ /// The supported style of the [`StyleSheet`].
type Style: Default;
+ /// Returns the active [`Appearance`] of the toggler for the provided [`Style`].
+ ///
+ /// [`Style`]: Self::Style
fn active(&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;
}