Skip to main content

SegmentedButton

Struct SegmentedButton 

Source
pub struct SegmentedButton<'a> { /* private fields */ }
Expand description

A toggle button with a built-in LED dot.

SegmentedButton shares ButtonSize with Button, so a mixed action row stays aligned when both widgets pass matching .size(...) values.

let mut on = false;
// Default: ButtonSize::Medium — aligns with Medium Button.
ui.add(SegmentedButton::new(&mut on, "Continuous").accent(Accent::Green));

// Chunkier row — Button + SegmentedButton, same height.
ui.horizontal(|ui| {
    ui.add(Button::new("Collect").size(ButtonSize::Large));
    ui.add(
        SegmentedButton::new(&mut on, "Continuous")
            .accent(Accent::Green)
            .size(ButtonSize::Large),
    );
});

Implementations§

Source§

impl<'a> SegmentedButton<'a>

Source

pub fn new(on: &'a mut bool, label: impl Into<WidgetText>) -> Self

Create a segmented button bound to on with the given label.

Source

pub fn accent(self, accent: Accent) -> Self

Pick the on-state colour from one of the theme’s accents. Default: Accent::Green.

Source

pub fn size(self, size: ButtonSize) -> Self

Pick a size preset matching Button’s sizes so a mixed Button + SegmentedButton row stays aligned at any size. Default: ButtonSize::Medium.

Source

pub fn dim_when_on(self, dim: bool) -> Self

When the button is on, render its fill dimmed and the label muted. Used to indicate “enabled but not currently applicable”.

Source

pub fn rounded(self, rounded: bool) -> Self

Set whether the button has rounded corners. Disable for segmented groups where neighbours share edges.

Source

pub fn corner_radius(self, radius: impl Into<CornerRadius>) -> Self

Explicitly set the corner radius (per-corner). Overrides Self::rounded. Useful for segmented strips where only the end cells should be rounded.

Source

pub fn min_width(self, width: f32) -> Self

Force the button to occupy at least this width. When wider than the LED + text, the content is centered horizontally.

Trait Implementations§

Source§

impl<'a> Debug for SegmentedButton<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a> Widget for SegmentedButton<'a>

Source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SegmentedButton<'a>

§

impl<'a> RefUnwindSafe for SegmentedButton<'a>

§

impl<'a> Send for SegmentedButton<'a>

§

impl<'a> Sync for SegmentedButton<'a>

§

impl<'a> Unpin for SegmentedButton<'a>

§

impl<'a> UnsafeUnpin for SegmentedButton<'a>

§

impl<'a> !UnwindSafe for SegmentedButton<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.