Skip to main content

ButtonScope

Struct ButtonScope 

Source
pub struct ButtonScope { /* private fields */ }
Expand description

A Button and its builder.

Implementations§

Source§

impl ButtonScope

Source

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

The name assistive technology reads. With no visible label it is the control’s name; with one it replaces the label, and on an icon-only button it is read instead of the icon’s meaning.

Source§

impl ButtonScope

Source

pub fn text_align(self, align: TextAlign) -> Self

Where the label sits in the button. A button that never calls this sends nothing and keeps its label centred.

Source

pub fn font_size(self, sp: f32) -> Self

The label’s size in sp. A button that never calls this sends nothing and takes the design system’s size for its variant.

Source

pub fn font_weight(self, weight: u16) -> Self

The label’s weight (e.g. 400, 500, 600, 700). Overrides the type role’s weight. A button that never calls this sends nothing.

Source

pub fn type_role(self, role: TypeRole) -> Self

The rung of the type ladder the label is set in: its size, weight and line height. font_size and font_weight win over the role’s values. A button that never calls this sends nothing and keeps the design system’s label style for its variant.

Source

pub fn content_padding(self, horizontal: f32, vertical: f32) -> Self

The room between the button’s edge and its label, in dp: horizontal at each side and vertical above and below. It replaces the design system’s padding for this button only, and still gives way when the button is too small for the label and the padding together. Modifier::padding is the room around the button and is not changed by this. A button that never calls this sends nothing and keeps the design system’s padding.

Source

pub fn icon(self, icon: IconRole) -> Self

The meaning of the glyph on it, never a picture.

Source

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

Source

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

Source

pub fn kind(self, kind: ButtonKind) -> Self

What the button is, apart from how loud it is: ButtonKind::ActionKey is one key of a dense grid, drawn in the design system’s own calculator-key shape.

Source

pub fn max_lines(self, lines: u32) -> Self

How many lines the label may take. A label is one line unless this says more, so a Korean label is never broken between syllables by a squeezed parent.

Source

pub fn overflow(self, overflow: TextOverflow) -> Self

What happens to a label longer than its lines.

Source

pub fn color(self, paint: Paint) -> Self

The label’s colour, for the rare button whose meaning is not its variant’s.

Source

pub fn color_if(self, paint: Option<Paint>) -> Self

The same, when there may be no colour of its own.

Source

pub fn on_click(self, handler: impl FnMut() + 'static) -> Self

Source

pub fn focus_handle(self, handle: &FocusHandle) -> Self

Binds handle to this button, so handle.request() puts keyboard focus here.

Source§

impl ButtonScope

Source

pub fn modifier(self, modifier: Modifier) -> Self

What sits around it. Compose’s modifier parameter.

Source§

impl ButtonScope

Source

pub fn content(self, content: impl FnOnce())

Composes this widget with content as its children.

Source§

impl ButtonScope

Source

pub fn on_motion_finished( self, handler: impl FnMut(MotionFinished) + 'static, ) -> Self

Runs once when this node’s size motion comes to rest, with the size it settled at in dp. The node needs Modifier::motion for its size to move; without it nothing is reported. A run interrupted by a newer size is not reported, only the one that settles, and under reduced motion it arrives in the frame the size changes in.

Trait Implementations§

Source§

impl Drop for ButtonScope

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

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, 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.