Introduce support for disabling a checkbox

This commit is contained in:
Alexander van Saase 2023-10-02 20:18:15 +02:00 committed by Héctor Ramón Jiménez
parent b95f3ab12f
commit b5f1ca1695
No known key found for this signature in database
GPG key ID: 7CC46565708259A7
14 changed files with 166 additions and 85 deletions

View file

@ -1,6 +1,7 @@
use iced::executor;
use iced::font::{self, Font};
use iced::widget::{checkbox, column, container, text};
use iced::theme::Checkbox;
use iced::widget::{checkbox, column, container, row, text};
use iced::{Application, Command, Element, Length, Settings, Theme};
const ICON_FONT: Font = Font::with_name("icons");
@ -13,12 +14,15 @@ pub fn main() -> iced::Result {
struct Example {
default_checkbox: bool,
custom_checkbox: bool,
styled_checkbox_enabled: bool,
styled_checkbox_checked: bool,
}
#[derive(Debug, Clone, Copy)]
enum Message {
DefaultChecked(bool),
CustomChecked(bool),
StyledChecked(bool),
FontLoaded(Result<(), font::Error>),
}
@ -42,8 +46,14 @@ impl Application for Example {
fn update(&mut self, message: Message) -> Command<Message> {
match message {
Message::DefaultChecked(value) => self.default_checkbox = value,
Message::DefaultChecked(value) => {
self.default_checkbox = value;
self.styled_checkbox_enabled = value;
}
Message::CustomChecked(value) => self.custom_checkbox = value,
Message::StyledChecked(value) => {
self.styled_checkbox_checked = value
}
Message::FontLoaded(_) => (),
}
@ -51,19 +61,40 @@ impl Application for Example {
}
fn view(&self) -> Element<Message> {
let default_checkbox =
checkbox("Default", self.default_checkbox, Message::DefaultChecked);
let custom_checkbox =
checkbox("Custom", self.custom_checkbox, Message::CustomChecked)
.icon(checkbox::Icon {
font: ICON_FONT,
code_point: '\u{e901}',
size: None,
line_height: text::LineHeight::Relative(1.0),
shaping: text::Shaping::Basic,
});
let default_checkbox = checkbox("Default", self.default_checkbox)
.on_toggle(Message::DefaultChecked);
let content = column![default_checkbox, custom_checkbox].spacing(22);
let checkboxes = [
("Primary", Checkbox::Primary),
("Secondary", Checkbox::Secondary),
("Success", Checkbox::Success),
("Danger", Checkbox::Danger),
];
let checkboxes = row(checkboxes
.into_iter()
.map(|(label, style)| {
checkbox(label, self.styled_checkbox_checked)
.on_toggle_maybe(
self.default_checkbox.then(|| Message::StyledChecked),
)
.style(style)
})
.map(Element::from))
.spacing(10);
let custom_checkbox = checkbox("Custom", self.custom_checkbox)
.on_toggle(Message::CustomChecked)
.icon(checkbox::Icon {
font: ICON_FONT,
code_point: '\u{e901}',
size: None,
line_height: text::LineHeight::Relative(1.0),
shaping: text::Shaping::Basic,
});
let content =
column![default_checkbox, checkboxes, custom_checkbox,].spacing(22);
container(content)
.width(Length::Fill)

View file

@ -89,11 +89,8 @@ impl Application for IcedCubes {
.step(0.01)
.width(100),
),
checkbox(
"Show Depth Buffer",
self.scene.show_depth_buffer,
Message::ShowDepthBuffer
),
checkbox("Show Depth Buffer", self.scene.show_depth_buffer)
.on_toggle(Message::ShowDepthBuffer),
]
.spacing(40);

View file

@ -85,11 +85,8 @@ impl Application for Events {
.map(Element::from),
);
let toggle = checkbox(
"Listen to runtime events",
self.enabled,
Message::Toggled,
);
let toggle = checkbox("Listen to runtime events", self.enabled)
.on_toggle(Message::Toggled);
let exit = button(
text("Exit")

View file

@ -185,7 +185,8 @@ fn view_controls<'a>(
row![
playback_controls,
speed_controls,
checkbox("Grid", is_grid_enabled, Message::ToggleGrid)
checkbox("Grid", is_grid_enabled)
.on_toggle(Message::ToggleGrid)
.size(16)
.spacing(5)
.text_size(16),

View file

@ -86,7 +86,8 @@ impl Application for Layout {
let header = row![
text(self.example.title).size(20).font(Font::MONOSPACE),
horizontal_space(Length::Fill),
checkbox("Explain", self.explain, Message::ExplainToggled),
checkbox("Explain", self.explain)
.on_toggle(Message::ExplainToggled),
pick_list(
Theme::ALL,
Some(self.theme.clone()),

View file

@ -115,11 +115,8 @@ impl Sandbox for Styling {
.width(Length::Fill)
.height(100);
let checkbox = checkbox(
"Check me!",
self.checkbox_value,
Message::CheckboxToggled,
);
let checkbox = checkbox("Check me!", self.checkbox_value)
.on_toggle(Message::CheckboxToggled);
let toggler = toggler(
String::from("Toggle me!"),

View file

@ -51,11 +51,9 @@ impl Sandbox for Tiger {
},
);
let apply_color_filter = checkbox(
"Apply a color filter",
self.apply_color_filter,
Message::ToggleColorFilter,
);
let apply_color_filter =
checkbox("Apply a color filter", self.apply_color_filter)
.on_toggle(Message::ToggleColorFilter);
container(
column![

View file

@ -352,13 +352,10 @@ impl Task {
fn view(&self, i: usize) -> Element<TaskMessage> {
match &self.state {
TaskState::Idle => {
let checkbox = checkbox(
&self.description,
self.completed,
TaskMessage::Completed,
)
.width(Length::Fill)
.text_shaping(text::Shaping::Advanced);
let checkbox = checkbox(&self.description, self.completed)
.on_toggle(TaskMessage::Completed)
.width(Length::Fill)
.text_shaping(text::Shaping::Advanced);
row![
checkbox,

View file

@ -554,11 +554,13 @@ impl<'a> Step {
.width(Length::Fill)
.horizontal_alignment(alignment::Horizontal::Center),
)
.push(checkbox(
"Use nearest interpolation",
filter_method == image::FilterMethod::Nearest,
StepMessage::ImageUseNearestToggled,
))
.push(
checkbox(
"Use nearest interpolation",
filter_method == image::FilterMethod::Nearest,
)
.on_toggle(StepMessage::ImageUseNearestToggled),
)
.align_items(Alignment::Center)
}
@ -616,16 +618,14 @@ impl<'a> Step {
} else {
text_input
})
.push(checkbox(
"Enable password mode",
is_secure,
StepMessage::ToggleSecureInput,
))
.push(checkbox(
"Show icon",
is_showing_icon,
StepMessage::ToggleTextInputIcon,
))
.push(
checkbox("Enable password mode", is_secure)
.on_toggle(StepMessage::ToggleSecureInput),
)
.push(
checkbox("Show icon", is_showing_icon)
.on_toggle(StepMessage::ToggleTextInputIcon),
)
.push(
"A text input produces a message every time it changes. It is \
very easy to keep track of its contents:",
@ -658,7 +658,8 @@ impl<'a> Step {
.horizontal_alignment(alignment::Horizontal::Center),
)
} else {
checkbox("Explain layout", debug, StepMessage::DebugToggled)
checkbox("Explain layout", debug)
.on_toggle(StepMessage::DebugToggled)
.into()
})
.push("Feel free to go back and take a look.")

View file

@ -75,11 +75,8 @@ impl Sandbox for VectorialText {
column![
canvas(&self.state).width(Length::Fill).height(Length::Fill),
column![
checkbox(
"Use Japanese",
self.state.use_japanese,
Message::ToggleJapanese
),
checkbox("Use Japanese", self.state.use_japanese,)
.on_toggle(Message::ToggleJapanese),
row![
slider_with_label(
"Size",

View file

@ -24,4 +24,7 @@ pub trait StyleSheet {
/// Produces the hovered [`Appearance`] of a checkbox.
fn hovered(&self, style: &Self::Style, is_checked: bool) -> Appearance;
/// Produces the disabled [`Appearance`] of a checkbox.
fn disabled(&self, style: &Self::Style, is_checked: bool) -> Appearance;
}

View file

@ -319,7 +319,7 @@ impl checkbox::StyleSheet for Theme {
Checkbox::Secondary => checkbox_appearance(
palette.background.base.text,
palette.background.base,
palette.background.base,
palette.background.weak,
is_checked,
),
Checkbox::Success => checkbox_appearance(
@ -355,7 +355,7 @@ impl checkbox::StyleSheet for Theme {
Checkbox::Secondary => checkbox_appearance(
palette.background.base.text,
palette.background.weak,
palette.background.base,
palette.background.weak,
is_checked,
),
Checkbox::Success => checkbox_appearance(
@ -373,6 +373,42 @@ impl checkbox::StyleSheet for Theme {
Checkbox::Custom(custom) => custom.hovered(self, is_checked),
}
}
fn disabled(
&self,
style: &Self::Style,
is_checked: bool,
) -> checkbox::Appearance {
let palette = self.extended_palette();
match style {
Checkbox::Primary => checkbox_appearance(
palette.primary.strong.text,
palette.background.weak,
palette.background.strong,
is_checked,
),
Checkbox::Secondary => checkbox_appearance(
palette.background.strong.color,
palette.background.weak,
palette.background.weak,
is_checked,
),
Checkbox::Success => checkbox_appearance(
palette.success.base.text,
palette.background.weak,
palette.success.weak,
is_checked,
),
Checkbox::Danger => checkbox_appearance(
palette.danger.base.text,
palette.background.weak,
palette.danger.weak,
is_checked,
),
Checkbox::Custom(custom) => custom.active(self, is_checked),
}
}
}
fn checkbox_appearance(

View file

@ -43,7 +43,7 @@ pub struct Checkbox<
Renderer: text::Renderer,
{
is_checked: bool,
on_toggle: Box<dyn Fn(bool) -> Message + 'a>,
on_toggle: Option<Box<dyn Fn(bool) -> Message + 'a>>,
label: String,
width: Length,
size: f32,
@ -70,18 +70,12 @@ where
/// Creates a new [`Checkbox`].
///
/// It expects:
/// * a boolean describing whether the [`Checkbox`] is checked or not
/// * the label of the [`Checkbox`]
/// * a function that will be called when the [`Checkbox`] is toggled. It
/// will receive the new state of the [`Checkbox`] and must produce a
/// `Message`.
pub fn new<F>(label: impl Into<String>, is_checked: bool, f: F) -> Self
where
F: 'a + Fn(bool) -> Message,
{
/// * a boolean describing whether the [`Checkbox`] is checked or not
pub fn new(label: impl Into<String>, is_checked: bool) -> Self {
Checkbox {
is_checked,
on_toggle: Box::new(f),
on_toggle: None,
label: label.into(),
width: Length::Shrink,
size: Self::DEFAULT_SIZE,
@ -101,6 +95,32 @@ where
}
}
/// Sets the function that will be called when the [`Checkbox`] is toggled.
/// It will receive the new state of the [`Checkbox`] and must produce a
/// `Message`.
///
/// Unless `on_toggle` is called, the [`Checkbox`] will be disabled.
pub fn on_toggle<F>(mut self, f: F) -> Self
where
F: 'a + Fn(bool) -> Message,
{
self.on_toggle = Some(Box::new(f));
self
}
/// Sets the function that will be called when the [`Checkbox`] is toggled,
/// if `Some`.
///
/// If `None`, the checkbox will be disabled.
pub fn on_toggle_maybe<F>(mut self, f: Option<F>) -> Self
where
F: Fn(bool) -> Message + 'a,
{
self.on_toggle =
f.map(|f| Box::new(f) as Box<dyn Fn(bool) -> Message + 'a>);
self
}
/// Sets the size of the [`Checkbox`].
pub fn size(mut self, size: impl Into<Pixels>) -> Self {
self.size = size.into().0;
@ -235,9 +255,10 @@ where
let mouse_over = cursor.is_over(layout.bounds());
if mouse_over {
shell.publish((self.on_toggle)(!self.is_checked));
return event::Status::Captured;
if let Some(on_toggle) = &self.on_toggle {
shell.publish((on_toggle)(!self.is_checked));
return event::Status::Captured;
}
}
}
_ => {}
@ -254,7 +275,7 @@ where
_viewport: &Rectangle,
_renderer: &Renderer,
) -> mouse::Interaction {
if cursor.is_over(layout.bounds()) {
if cursor.is_over(layout.bounds()) && self.on_toggle.is_some() {
mouse::Interaction::Pointer
} else {
mouse::Interaction::default()
@ -272,13 +293,18 @@ where
viewport: &Rectangle,
) {
let is_mouse_over = cursor.is_over(layout.bounds());
let is_enabled = self.on_toggle.is_some();
let mut children = layout.children();
let custom_style = if is_mouse_over {
theme.hovered(&self.style, self.is_checked)
let custom_style = if is_enabled {
if is_mouse_over {
theme.hovered(&self.style, self.is_checked)
} else {
theme.active(&self.style, self.is_checked)
}
} else {
theme.active(&self.style, self.is_checked)
theme.disabled(&self.style, self.is_checked)
};
{

View file

@ -158,13 +158,12 @@ where
pub fn checkbox<'a, Message, Theme, Renderer>(
label: impl Into<String>,
is_checked: bool,
f: impl Fn(bool) -> Message + 'a,
) -> Checkbox<'a, Message, Theme, Renderer>
where
Theme: checkbox::StyleSheet + text::StyleSheet,
Renderer: core::text::Renderer,
{
Checkbox::new(label, is_checked, f)
Checkbox::new(label, is_checked)
}
/// Creates a new [`Radio`].