BREAKING CHANGE: Various type and function names have changed to reflect themselves better in documentation. Code has been reorganized into separate modules with a better placement in libcosmic. Most of the functions, types, and modules now have documentation and examples. These changes no longer require the `Model` type to define the data/component type that it stores. The component functionality is now optional, and it's also possible to associate many components to an item with one component per type. This has had a side effect of simplifying a lot of the type signatures in the implementation. Before, to insert an item into the model, you had to define a `SegmentedItem` and a `Component` on insert, and get back an ID for that item. Which makes it difficult to define an item that contains only an icon or has no components. And requires an extra insert function to activate the item on insert. Now, there is a flexible builder-style API for configuring newly-inserted items in the model. So the complexity for inserting and retrieving values from the model has decreased significantly
49 lines
1.7 KiB
Rust
49 lines
1.7 KiB
Rust
// Copyright 2023 System76 <info@system76.com>
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
//! A selection of multiple choices appearing as a conjoined button.
|
|
//!
|
|
//! See the [`segmented_button`] module for more details.
|
|
|
|
use super::segmented_button::{
|
|
self, HorizontalSegmentedButton, Model, Selectable, VerticalSegmentedButton,
|
|
};
|
|
|
|
/// A selection of multiple choices appearing as a conjoined button.
|
|
///
|
|
/// The data for the widget comes from a model that is maintained the application.
|
|
///
|
|
/// For details on the model, see the [`segmented_button`] module for more details.
|
|
#[must_use]
|
|
pub fn horizontal<SelectionMode: Default, Message>(
|
|
model: &Model<SelectionMode>,
|
|
) -> HorizontalSegmentedButton<SelectionMode, Message, crate::Renderer>
|
|
where
|
|
Model<SelectionMode>: Selectable,
|
|
{
|
|
segmented_button::horizontal(model)
|
|
.button_padding([16, 0, 16, 0])
|
|
.button_height(32)
|
|
.style(crate::theme::SegmentedButton::Selection)
|
|
.font_active(crate::font::FONT_SEMIBOLD)
|
|
}
|
|
|
|
/// A selection of multiple choices appearing as a conjoined button.
|
|
///
|
|
/// The data for the widget comes from a model that is maintained the application.
|
|
///
|
|
/// For details on the model, see the [`segmented_button`] module for more details.
|
|
#[must_use]
|
|
pub fn vertical<SelectionMode, Message>(
|
|
model: &Model<SelectionMode>,
|
|
) -> VerticalSegmentedButton<SelectionMode, Message, crate::Renderer>
|
|
where
|
|
Model<SelectionMode>: Selectable,
|
|
SelectionMode: Default,
|
|
{
|
|
segmented_button::vertical(model)
|
|
.button_padding([16, 0, 16, 0])
|
|
.button_height(32)
|
|
.style(crate::theme::SegmentedButton::Selection)
|
|
.font_active(crate::font::FONT_SEMIBOLD)
|
|
}
|