libcosmic/src/widget/settings/item.rs
2024-05-30 13:57:47 +02:00

128 lines
3.7 KiB
Rust

// Copyright 2022 System76 <info@system76.com>
// SPDX-License-Identifier: MPL-2.0
use std::borrow::Cow;
use crate::{
widget::{column, container, flex_row, horizontal_space, row, text, FlexRow, Row},
Element,
};
use derive_setters::Setters;
use iced::alignment::Horizontal;
use iced_core::Length;
use taffy::AlignContent;
/// A settings item aligned in a row
#[must_use]
#[allow(clippy::module_name_repetitions)]
pub fn item<'a, Message: 'static>(
title: impl Into<Cow<'a, str>> + 'a,
widget: impl Into<Element<'a, Message>> + 'a,
) -> Row<'a, Message> {
item_row(vec![
text(title).into(),
horizontal_space(iced::Length::Fill).into(),
widget.into(),
])
}
/// A settings item aligned in a row
#[must_use]
#[allow(clippy::module_name_repetitions)]
pub fn item_row<Message>(children: Vec<Element<Message>>) -> Row<Message> {
row::with_children(children)
.spacing(12)
.align_items(iced::Alignment::Center)
.padding([0, 18])
}
/// A settings item aligned in a flex row
#[allow(clippy::module_name_repetitions)]
pub fn flex_item<'a, Message: 'static>(
title: impl Into<Cow<'a, str>> + 'a,
widget: impl Into<Element<'a, Message>> + 'a,
) -> FlexRow<'a, Message> {
flex_item_row(vec![
text(title).width(Length::Fill).into(),
container(widget).into(),
])
}
/// A settings item aligned in a flex row
#[allow(clippy::module_name_repetitions)]
pub fn flex_item_row<Message>(children: Vec<Element<Message>>) -> FlexRow<Message> {
flex_row(children)
.padding([0, 18])
.spacing(12)
.min_item_width(200.0)
.justify_items(iced::Alignment::Center)
.justify_content(AlignContent::SpaceBetween)
.width(Length::Fill)
}
/// Creates a builder for an item, beginning with the title.
pub fn builder<'a, Message: 'static>(title: impl Into<Cow<'a, str>>) -> Item<'a, Message> {
Item {
title: title.into(),
description: None,
icon: None,
}
}
/// A builder for a settings item.
#[derive(Setters)]
pub struct Item<'a, Message> {
/// Describes the item being controlled.
title: Cow<'a, str>,
/// A description to display beneath the title.
#[setters(strip_option, into)]
description: Option<Cow<'a, str>>,
/// A custom icon to display before the text.
#[setters(strip_option, into)]
icon: Option<Element<'a, Message>>,
}
impl<'a, Message: 'static> Item<'a, Message> {
/// Assigns a control to the item.
pub fn control(self, widget: impl Into<Element<'a, Message>>) -> Row<'a, Message> {
item_row(self.control_(widget))
}
/// Assigns a control which flexes.
pub fn flex_control(self, widget: impl Into<Element<'a, Message>>) -> FlexRow<'a, Message> {
flex_item_row(self.control_(widget))
}
fn control_(self, widget: impl Into<Element<'a, Message>>) -> Vec<Element<'a, Message>> {
let mut contents = Vec::with_capacity(4);
if let Some(icon) = self.icon {
contents.push(icon);
}
if let Some(description) = self.description {
let column = column::with_capacity(2)
.spacing(2)
.push(text(self.title))
.push(text(description).size(10))
.width(Length::Fill);
contents.push(column.into());
} else {
contents.push(text(self.title).width(Length::Fill).into());
}
contents.push(widget.into());
contents
}
pub fn toggler(
self,
is_checked: bool,
message: impl Fn(bool) -> Message + 'static,
) -> FlexRow<'a, Message> {
self.flex_control(crate::widget::toggler(None, is_checked, message))
}
}