Skip to main content

ToggleButtonView

Struct ToggleButtonView 

Source
pub struct ToggleButtonView<State: 'static> { /* private fields */ }
Expand description

A declarative M3 Expressive toggle button. See the module docs.

Implementations§

Source§

impl<State: 'static> ToggleButtonView<State>

Source

pub fn variant(self, variant: ButtonVariant) -> Self

Set the container treatment (the module docs’ Variants table).

Source

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

Set the size tier (the module docs’ Sizes table).

Source

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

Whether the toggle button accepts a press. A disabled button paints the 38%/12% disabled roles and reports disabled semantics.

Source

pub fn icon(self, icon: impl View<State>) -> Self

Icon shown while unchecked (and while checked too, if Self::checked_icon is unset).

Source

pub fn checked_icon(self, icon: impl View<State>) -> Self

Icon shown while checked. Falls back to Self::icon when unset.

Source

pub fn label(self, label: impl Into<String>) -> Self

Label shown while unchecked (and while checked too, if Self::checked_label is unset).

Source

pub fn checked_label(self, label: impl Into<String>) -> Self

Label shown while checked. Falls back to Self::label when unset.

Source

pub fn group_connected(self, connected: bool) -> Self

Whether this button is part of a connected group — the module docs’ Group-connection corner asymmetry section. Plumbing for the upcoming button-group rework.

Source

pub fn first_in_group(self, first: bool) -> Self

Whether this is the first (leading) member of a connected group — only consulted while Self::group_connected is true. Defaults to true (a standalone button behaves as if it were both ends).

Source

pub fn last_in_group(self, last: bool) -> Self

Whether this is the last (trailing) member of a connected group — only consulted while Self::group_connected is true. Defaults to true.

Source

pub fn haptic(self, haptic: HapticSignal) -> Self

The haptic signal to fire on a confirmed checked-toggle. Defaults to HapticSignal::None (the module docs’ Haptics section).

Source

pub fn on_long_press<F: Fn(&mut State) + 'static>( self, on_long_press: F, ) -> Self

Fire on_long_press when a press is held past the threshold — the module docs’ Long-press section documents the exact firing contract (deferred to the next pointer event, not immediate).

Trait Implementations§

Source§

impl<State: 'static> View<State> for ToggleButtonView<State>

Source§

type Element = ToggleButtonWidget

The retained widget this view produces.
Source§

fn build(&self, ctx: &mut BuildCtx<'_>) -> ToggleButtonWidget

Materialise a fresh widget for this view.
Source§

fn rebuild( &self, prev: &Self, element: &mut ToggleButtonWidget, ctx: &mut BuildCtx<'_>, ) -> ChangeFlags

Reconcile prev (the previous view of the same type) against the live element, mutating it in place and reporting what changed.
Source§

fn teardown(&self, element: &mut ToggleButtonWidget, ctx: &mut BuildCtx<'_>)

Tear down element when this view is being removed. Read more
Source§

fn message(&self, _element: &mut Self::Element, _state: &mut State)

Deliver an event message to this view, mutating application state. Read more

Auto Trait Implementations§

§

impl<State> !RefUnwindSafe for ToggleButtonView<State>

§

impl<State> !Send for ToggleButtonView<State>

§

impl<State> !Sync for ToggleButtonView<State>

§

impl<State> !UnwindSafe for ToggleButtonView<State>

§

impl<State> Freeze for ToggleButtonView<State>
where Rc<dyn Fn(&mut State, bool)>: Freeze, Option<AnyView<State>>: Freeze, Option<Rc<dyn Fn(&mut State)>>: Freeze,

§

impl<State> Unpin for ToggleButtonView<State>
where Rc<dyn Fn(&mut State, bool)>: Unpin, Option<AnyView<State>>: Unpin, Option<Rc<dyn Fn(&mut State)>>: Unpin,

§

impl<State> UnsafeUnpin for ToggleButtonView<State>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

fn simd_from(_simd: S, value: T) -> 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> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<State, V> ViewSeq<State, One> for V
where State: 'static, V: View<State>,

Source§

fn extend_views(self, out: &mut Vec<AnyView<State>>)

Push every element of this sequence, in order, onto out — erasing each with AnyView::new (a no-op for an element already an AnyView).
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more