From 4b3d0fb08d5b2e84c1061fa601b71363b6719f59 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Thu, 10 Nov 2022 01:10:28 +0100 Subject: Write documentation for `iced_style` --- style/src/text_input.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'style/src/text_input.rs') diff --git a/style/src/text_input.rs b/style/src/text_input.rs index 1be9ccea..d97016dc 100644 --- a/style/src/text_input.rs +++ b/style/src/text_input.rs @@ -1,17 +1,22 @@ -//! Display fields that can be filled with text. +//! Change the appearance of a text input. use iced_core::{Background, Color}; /// The appearance of a text input. #[derive(Debug, Clone, Copy)] pub struct Appearance { + /// The [`Background`] of the text input. pub background: Background, + /// The border radius of the text input. pub border_radius: f32, + /// The border width of the text input. pub border_width: f32, + /// The border [`Color`] of the text input. pub border_color: Color, } /// A set of rules that dictate the style of a text input. pub trait StyleSheet { + /// The supported style of the [`StyleSheet`]. type Style: Default; /// Produces the style of an active text input. @@ -20,10 +25,13 @@ pub trait StyleSheet { /// Produces the style of a focused text input. fn focused(&self, style: &Self::Style) -> Appearance; + /// Produces the [`Color`] of the placeholder of a text input. fn placeholder_color(&self, style: &Self::Style) -> Color; + /// Produces the [`Color`] of the value of a text input. fn value_color(&self, style: &Self::Style) -> Color; + /// Produces the [`Color`] of the selection of a text input. fn selection_color(&self, style: &Self::Style) -> Color; /// Produces the style of an hovered text input. -- cgit