Skip to main content

ButtonView

Struct ButtonView 

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

A declarative M3 Expressive button. See the module docs.

Implementations§

Source§

impl<State: 'static> ButtonView<State>

Source

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

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

Source

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

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

Source

pub fn shape(self, shape: ButtonShape) -> Self

Set the corner-radius family (pill vs. per-size token radius).

Source

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

Whether the button accepts a press. A disabled button paints the 38% / 12% disabled roles, reports disabled semantics, and swallows nothing — it simply never arms (m3e_button_content.dart:174’s null onPressed).

Source

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

Attach a leading icon (see button_with_icon).

Source

pub fn icon_alignment(self, alignment: IconAlignment) -> Self

Put the icon on the trailing side instead of the leading one.

Source

pub fn corner_radius(self, radius: f64) -> Self

Override the resting corner radius, ignoring both the shape family and the per-size token — the reference’s M3EButtonDecoration.borderRadius (m3e_button_content.dart:42). It also becomes the hovered radius, and the pressed one unless ButtonView::pressed_radius is set too, since that is the precedence _resolveShapes applies.

Source

pub fn pressed_radius(self, radius: f64) -> Self

Override the pressed corner radius — the reference’s M3EButtonDecoration.pressedRadius, the highest-precedence pressed input.

Source

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

The haptic signal to fire on a press. Defaults to HapticSignal::None — matching the reference, where a button is silent unless its decoration names a signal (the module docs’ Haptics section).

Source

pub fn decoration(self, decoration: Rc<dyn ButtonDecoration>) -> Self

Install a paint-time decoration layer (the module docs’ Seams section).

Source

pub fn overflow_observer(self, observer: Rc<dyn OverflowObserver>) -> Self

Install a layout-time content-measurement observer (the module docs’ Seams section).

Source

pub fn overflow(self, strategy: OverflowStrategy) -> Self

Select which strategy an overflowing label uses — OverflowStrategy::None (the default) by default. See OverflowStrategy’s own docs for the full three-way contract, and ButtonView::overflow_observer for the hook OverflowStrategy::BottomSheet calls into.

Trait Implementations§

Source§

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

Source§

type Element = ButtonWidget

The retained widget this view produces.
Source§

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

Materialise a fresh widget for this view.
Source§

fn rebuild( &self, prev: &Self, element: &mut ButtonWidget, 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 ButtonWidget, 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 ButtonView<State>

§

impl<State> !Send for ButtonView<State>

§

impl<State> !Sync for ButtonView<State>

§

impl<State> !UnwindSafe for ButtonView<State>

§

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

§

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

§

impl<State> UnsafeUnpin for ButtonView<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