356 lines
10 KiB
Rust
356 lines
10 KiB
Rust
//! Show toggle controls using checkboxes.
|
|
use crate::core::alignment;
|
|
use crate::core::event::{self, Event};
|
|
use crate::core::layout;
|
|
use crate::core::mouse;
|
|
use crate::core::renderer;
|
|
use crate::core::text;
|
|
use crate::core::touch;
|
|
use crate::core::widget::Tree;
|
|
use crate::core::{
|
|
Alignment, Clipboard, Element, Layout, Length, Pixels, Rectangle, Shell,
|
|
Widget,
|
|
};
|
|
use crate::{Row, Text};
|
|
|
|
pub use iced_style::checkbox::{Appearance, StyleSheet};
|
|
|
|
/// A box that can be checked.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```no_run
|
|
/// # type Checkbox<'a, Message> =
|
|
/// # iced_widget::Checkbox<'a, Message, iced_widget::renderer::Renderer<iced_widget::style::Theme>>;
|
|
/// #
|
|
/// pub enum Message {
|
|
/// CheckboxToggled(bool),
|
|
/// }
|
|
///
|
|
/// let is_checked = true;
|
|
///
|
|
/// Checkbox::new("Toggle me!", is_checked, Message::CheckboxToggled);
|
|
/// ```
|
|
///
|
|
/// 
|
|
#[allow(missing_debug_implementations)]
|
|
pub struct Checkbox<'a, Message, Renderer = crate::Renderer>
|
|
where
|
|
Renderer: text::Renderer,
|
|
Renderer::Theme: StyleSheet + crate::text::StyleSheet,
|
|
{
|
|
is_checked: bool,
|
|
on_toggle: Box<dyn Fn(bool) -> Message + 'a>,
|
|
label: String,
|
|
width: Length,
|
|
size: f32,
|
|
spacing: f32,
|
|
text_size: Option<f32>,
|
|
text_line_height: text::LineHeight,
|
|
text_shaping: text::Shaping,
|
|
font: Option<Renderer::Font>,
|
|
icon: Icon<Renderer::Font>,
|
|
style: <Renderer::Theme as StyleSheet>::Style,
|
|
}
|
|
|
|
impl<'a, Message, Renderer> Checkbox<'a, Message, Renderer>
|
|
where
|
|
Renderer: text::Renderer,
|
|
Renderer::Theme: StyleSheet + crate::text::StyleSheet,
|
|
{
|
|
/// The default size of a [`Checkbox`].
|
|
const DEFAULT_SIZE: f32 = 20.0;
|
|
|
|
/// The default spacing of a [`Checkbox`].
|
|
const DEFAULT_SPACING: f32 = 15.0;
|
|
|
|
/// 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,
|
|
{
|
|
Checkbox {
|
|
is_checked,
|
|
on_toggle: Box::new(f),
|
|
label: label.into(),
|
|
width: Length::Shrink,
|
|
size: Self::DEFAULT_SIZE,
|
|
spacing: Self::DEFAULT_SPACING,
|
|
text_size: None,
|
|
text_line_height: text::LineHeight::default(),
|
|
text_shaping: text::Shaping::Basic,
|
|
font: None,
|
|
icon: Icon {
|
|
font: Renderer::ICON_FONT,
|
|
code_point: Renderer::CHECKMARK_ICON,
|
|
size: None,
|
|
line_height: text::LineHeight::default(),
|
|
shaping: text::Shaping::Basic,
|
|
},
|
|
style: Default::default(),
|
|
}
|
|
}
|
|
|
|
/// Sets the size of the [`Checkbox`].
|
|
pub fn size(mut self, size: impl Into<Pixels>) -> Self {
|
|
self.size = size.into().0;
|
|
self
|
|
}
|
|
|
|
/// Sets the width of the [`Checkbox`].
|
|
pub fn width(mut self, width: impl Into<Length>) -> Self {
|
|
self.width = width.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the spacing between the [`Checkbox`] and the text.
|
|
pub fn spacing(mut self, spacing: impl Into<Pixels>) -> Self {
|
|
self.spacing = spacing.into().0;
|
|
self
|
|
}
|
|
|
|
/// Sets the text size of the [`Checkbox`].
|
|
pub fn text_size(mut self, text_size: impl Into<Pixels>) -> Self {
|
|
self.text_size = Some(text_size.into().0);
|
|
self
|
|
}
|
|
|
|
/// Sets the text [`LineHeight`] of the [`Checkbox`].
|
|
pub fn text_line_height(
|
|
mut self,
|
|
line_height: impl Into<text::LineHeight>,
|
|
) -> Self {
|
|
self.text_line_height = line_height.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the [`text::Shaping`] strategy of the [`Checkbox`].
|
|
pub fn text_shaping(mut self, shaping: text::Shaping) -> Self {
|
|
self.text_shaping = shaping;
|
|
self
|
|
}
|
|
|
|
/// Sets the [`Font`] of the text of the [`Checkbox`].
|
|
///
|
|
/// [`Font`]: crate::text::Renderer::Font
|
|
pub fn font(mut self, font: impl Into<Renderer::Font>) -> Self {
|
|
self.font = Some(font.into());
|
|
self
|
|
}
|
|
|
|
/// Sets the [`Icon`] of the [`Checkbox`].
|
|
pub fn icon(mut self, icon: Icon<Renderer::Font>) -> Self {
|
|
self.icon = icon;
|
|
self
|
|
}
|
|
|
|
/// Sets the style of the [`Checkbox`].
|
|
pub fn style(
|
|
mut self,
|
|
style: impl Into<<Renderer::Theme as StyleSheet>::Style>,
|
|
) -> Self {
|
|
self.style = style.into();
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Renderer> Widget<Message, Renderer>
|
|
for Checkbox<'a, Message, Renderer>
|
|
where
|
|
Renderer: text::Renderer,
|
|
Renderer::Theme: StyleSheet + crate::text::StyleSheet,
|
|
{
|
|
fn width(&self) -> Length {
|
|
self.width
|
|
}
|
|
|
|
fn height(&self) -> Length {
|
|
Length::Shrink
|
|
}
|
|
|
|
fn layout(
|
|
&self,
|
|
renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
) -> layout::Node {
|
|
Row::<(), Renderer>::new()
|
|
.width(self.width)
|
|
.spacing(self.spacing)
|
|
.align_items(Alignment::Center)
|
|
.push(Row::new().width(self.size).height(self.size))
|
|
.push(
|
|
Text::new(&self.label)
|
|
.font(self.font.unwrap_or_else(|| renderer.default_font()))
|
|
.width(self.width)
|
|
.size(
|
|
self.text_size
|
|
.unwrap_or_else(|| renderer.default_size()),
|
|
)
|
|
.line_height(self.text_line_height)
|
|
.shaping(self.text_shaping),
|
|
)
|
|
.layout(renderer, limits)
|
|
}
|
|
|
|
fn on_event(
|
|
&mut self,
|
|
_tree: &mut Tree,
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_renderer: &Renderer,
|
|
_clipboard: &mut dyn Clipboard,
|
|
shell: &mut Shell<'_, Message>,
|
|
_viewport: &Rectangle,
|
|
) -> event::Status {
|
|
match event {
|
|
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left))
|
|
| Event::Touch(touch::Event::FingerPressed { .. }) => {
|
|
let mouse_over = cursor.is_over(layout.bounds());
|
|
|
|
if mouse_over {
|
|
shell.publish((self.on_toggle)(!self.is_checked));
|
|
|
|
return event::Status::Captured;
|
|
}
|
|
}
|
|
_ => {}
|
|
}
|
|
|
|
event::Status::Ignored
|
|
}
|
|
|
|
fn mouse_interaction(
|
|
&self,
|
|
_tree: &Tree,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
_renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
if cursor.is_over(layout.bounds()) {
|
|
mouse::Interaction::Pointer
|
|
} else {
|
|
mouse::Interaction::default()
|
|
}
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
_tree: &Tree,
|
|
renderer: &mut Renderer,
|
|
theme: &Renderer::Theme,
|
|
style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
_viewport: &Rectangle,
|
|
) {
|
|
let is_mouse_over = cursor.is_over(layout.bounds());
|
|
|
|
let mut children = layout.children();
|
|
|
|
let custom_style = if is_mouse_over {
|
|
theme.hovered(&self.style, self.is_checked)
|
|
} else {
|
|
theme.active(&self.style, self.is_checked)
|
|
};
|
|
|
|
{
|
|
let layout = children.next().unwrap();
|
|
let bounds = layout.bounds();
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds,
|
|
border_radius: custom_style.border_radius,
|
|
border_width: custom_style.border_width,
|
|
border_color: custom_style.border_color,
|
|
},
|
|
custom_style.background,
|
|
);
|
|
|
|
let Icon {
|
|
font,
|
|
code_point,
|
|
size,
|
|
line_height,
|
|
shaping,
|
|
} = &self.icon;
|
|
let size = size.unwrap_or(bounds.height * 0.7);
|
|
|
|
if self.is_checked {
|
|
renderer.fill_text(text::Text {
|
|
content: &code_point.to_string(),
|
|
font: *font,
|
|
size,
|
|
line_height: *line_height,
|
|
bounds: Rectangle {
|
|
x: bounds.center_x(),
|
|
y: bounds.center_y(),
|
|
..bounds
|
|
},
|
|
color: custom_style.icon_color,
|
|
horizontal_alignment: alignment::Horizontal::Center,
|
|
vertical_alignment: alignment::Vertical::Center,
|
|
shaping: *shaping,
|
|
});
|
|
}
|
|
}
|
|
|
|
{
|
|
let label_layout = children.next().unwrap();
|
|
|
|
crate::text::draw(
|
|
renderer,
|
|
style,
|
|
label_layout,
|
|
&self.label,
|
|
self.text_size,
|
|
self.text_line_height,
|
|
self.font,
|
|
crate::text::Appearance {
|
|
color: custom_style.text_color,
|
|
},
|
|
alignment::Horizontal::Left,
|
|
alignment::Vertical::Center,
|
|
self.text_shaping,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Renderer> From<Checkbox<'a, Message, Renderer>>
|
|
for Element<'a, Message, Renderer>
|
|
where
|
|
Message: 'a,
|
|
Renderer: 'a + text::Renderer,
|
|
Renderer::Theme: StyleSheet + crate::text::StyleSheet,
|
|
{
|
|
fn from(
|
|
checkbox: Checkbox<'a, Message, Renderer>,
|
|
) -> Element<'a, Message, Renderer> {
|
|
Element::new(checkbox)
|
|
}
|
|
}
|
|
|
|
/// The icon in a [`Checkbox`].
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct Icon<Font> {
|
|
/// Font that will be used to display the `code_point`,
|
|
pub font: Font,
|
|
/// The unicode code point that will be used as the icon.
|
|
pub code_point: char,
|
|
/// Font size of the content.
|
|
pub size: Option<f32>,
|
|
/// The line height of the icon.
|
|
pub line_height: text::LineHeight,
|
|
/// The shaping strategy of the icon.
|
|
pub shaping: text::Shaping,
|
|
}
|