summaryrefslogtreecommitdiffstats
path: root/style/src/button.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/button.rs
parentbec1f5bbe0e0fec0d57b66ee227c41f15165057e (diff)
downloadiced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.gz
iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.tar.bz2
iced-4b3d0fb08d5b2e84c1061fa601b71363b6719f59.zip
Write documentation for `iced_style`
Diffstat (limited to 'style/src/button.rs')
-rw-r--r--style/src/button.rs13
1 files changed, 12 insertions, 1 deletions
diff --git a/style/src/button.rs b/style/src/button.rs
index 858a9ab2..a564a2b7 100644
--- a/style/src/button.rs
+++ b/style/src/button.rs
@@ -1,14 +1,20 @@
-//! Allow your users to perform actions by pressing a button.
+//! Change the apperance of a button.
use iced_core::{Background, Color, Vector};
/// The appearance of a button.
#[derive(Debug, Clone, Copy)]
pub struct Appearance {
+ /// The amount of offset to apply to the shadow of the button.
pub shadow_offset: Vector,
+ /// The [`Background`] of the button.
pub background: Option<Background>,
+ /// The border radius of the button.
pub border_radius: f32,
+ /// The border width of the button.
pub border_width: f32,
+ /// The border [`Color`] of the button.
pub border_color: Color,
+ /// The text [`Color`] of the button.
pub text_color: Color,
}
@@ -27,10 +33,13 @@ impl std::default::Default for Appearance {
/// A set of rules that dictate the style of a button.
pub trait StyleSheet {
+ /// The supported style of the [`StyleSheet`].
type Style: Default;
+ /// Produces the active [`Appearance`] of a button.
fn active(&self, style: &Self::Style) -> Appearance;
+ /// Produces the hovered [`Appearance`] of a button.
fn hovered(&self, style: &Self::Style) -> Appearance {
let active = self.active(style);
@@ -40,6 +49,7 @@ pub trait StyleSheet {
}
}
+ /// Produces the pressed [`Appearance`] of a button.
fn pressed(&self, style: &Self::Style) -> Appearance {
Appearance {
shadow_offset: Vector::default(),
@@ -47,6 +57,7 @@ pub trait StyleSheet {
}
}
+ /// Produces the disabled [`Appearance`] of a button.
fn disabled(&self, style: &Self::Style) -> Appearance {
let active = self.active(style);