summaryrefslogtreecommitdiffstats
path: root/style/src/checkbox.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/checkbox.rs
parentbec1f5bbe0e0fec0d57b66ee227c41f15165057e (diff)
downloadiced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.gz
iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.bz2
iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.zip
Write documentation for `iced_style`
Diffstat (limited to 'style/src/checkbox.rs')
-rw-r--r--style/src/checkbox.rs11
1 files changed, 10 insertions, 1 deletions
diff --git a/style/src/checkbox.rs b/style/src/checkbox.rs
index a8b4a11d..827b3225 100644
--- a/style/src/checkbox.rs
+++ b/style/src/checkbox.rs
@@ -1,22 +1,31 @@
-//! Show toggle controls using checkboxes.
+//! Change the appearance of a checkbox.
use iced_core::{Background, Color};
/// The appearance of a checkbox.
#[derive(Debug, Clone, Copy)]
pub struct Appearance {
+ /// The [`Background`] of the checkbox.
pub background: Background,
+ /// The checkmark [`Color`] of the checkbox.
pub checkmark_color: Color,
+ /// The border radius of the checkbox.
pub border_radius: f32,
+ /// The border width of the checkbox.
pub border_width: f32,
+ /// The border [`Color`] of the checkbox.
pub border_color: Color,
+ /// The text [`Color`] of the checkbox.
pub text_color: Option<Color>,
}
/// A set of rules that dictate the style of a checkbox.
pub trait StyleSheet {
+ /// The supported style of the [`StyleSheet`].
type Style: Default;
+ /// Produces the active [`Appearance`] of a checkbox.
fn active(&self, style: &Self::Style, is_checked: bool) -> Appearance;
+ /// Produces the hovered [`Appearance`] of a checkbox.
fn hovered(&self, style: &Self::Style, is_checked: bool) -> Appearance;
}