Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document ui crate traits

Browse source
This commit is contained in:
Nate Butler 2024-01-09 14:15:25 -05:00
parent 46065c2621
commit e020d7ca11
7 changed files with 21 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
crates/ui/src/selectable.rs
View file

@ -1,18 +1,25 @@
/// A trait for elements that can be selected.
/// A trait for elements that can be selected. Generally used to enable "toggle" or "active" behavior and styles on an element through the [Selection] status.
pub trait Selectable {
/// Sets whether the element is selected.
fn selected(self, selected: bool) -> Self;
}
/// Represents the selection status of an element.
#[derive(Debug, Default, PartialEq, Eq, Hash, Clone, Copy)]
pub enum Selection {
/// The element is not selected.
#[default]
Unselected,
/// The selection state of the element is indeterminate.
Indeterminate,
/// The element is selected.
Selected,
}
impl Selection {
/// Returns the inverse of the current selection status.
///
/// Indeterminate states become selected if inverted.
pub fn inverse(&self) -> Self {
match self {
Self::Unselected | Self::Indeterminate => Self::Selected,