Skip to main content

Button

Struct Button 

Source
pub struct Button { /* private fields */ }

Implementations§

Source§

impl Button

Source

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

Creates a neutral, tonal button for an ordinary action.

Source

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

Creates a filled accent button for the primary action on a surface. Where the theme glows, as dark themes do, it glows with the accent.

Source

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

Creates a filled danger button for a destructive or irreversible action.

Source

pub fn current_label(&self) -> &str

Source

pub fn set_label(&mut self, label: impl Into<String>)

Source

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

Source

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

Source

pub fn appearance(self, appearance: ButtonAppearance) -> Self

Selects the button’s visual emphasis without changing its semantic meaning. The default is ButtonAppearance::Tonal.

Source

pub fn tone(self, tone: SemanticTone) -> Self

Selects the semantic color family used by this button. The default is SemanticTone::Neutral.

Source

pub fn primary_action(self) -> Self

Promotes this button to a filled accent primary action.

Source

pub fn danger_action(self) -> Self

Promotes this button to a filled danger action.

Source

pub fn theme(self, theme: DefaultTheme) -> Self

Source

pub fn theme_when<F>(self, theme: F) -> Self
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn text_style(self, text_style: TextStyle) -> Self

Source

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

Source

pub fn without_icon(self) -> Self

Source

pub fn icon_size(self, icon_size: f32) -> Self

Source

pub fn icon_gap(self, icon_gap: f32) -> Self

Source

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

Source

pub fn min_height(self, height: f32) -> Self

Source

pub fn padding(self, padding: Insets) -> Self

Source

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

Source

pub fn enabled_when<F>(self, enabled: F) -> Self
where F: Fn() -> bool + 'static,

Source

pub fn enabled_from<O>(self, enabled: O) -> Self
where O: Observable<bool> + 'static,

Enable the button while enabled holds, and repaint it when that changes. Unlike Self::enabled_when, the button follows the value without anything else asking it to repaint.

Source

pub fn interaction_preview(self, preview: InteractionPreview) -> Self

Pins hover, press, or focus visuals; see InteractionPreview.

Source

pub fn focus_on_press(self, focus: bool) -> Self

Whether clicking or tapping the button focuses it. On by default. Off, a press leaves focus where it is, so a toolbar button can act on the editor being typed in without taking focus from it. The button stays focusable: Tab still reaches it, Enter and Space press it, and assistive technology can still focus and activate it.

Source

pub fn on_press<F>(self, on_press: F) -> Self
where F: FnMut() + 'static,

Source

pub fn on_press_with_ctx<F>(self, on_press: F) -> Self
where F: FnMut(&mut EventCtx) + 'static,

Source

pub fn is_enabled(&self) -> bool

Source

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

Whether the primary action glows where the theme glows. On by default; other buttons never glow.

Source§

impl Button

Source

pub fn label_when<F>(self, reader: F) -> Self
where F: Fn() -> String + 'static,

Read the label each time the button lays out or handles an event.

Trait Implementations§

Source§

impl Widget for Button

Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)

Source§

fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn debug_name(&self) -> &'static str

Source§

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)

Source§

fn layer_options(&self) -> LayerOptions

Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.
Source§

fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Button

§

impl !Send for Button

§

impl !Sync for Button

§

impl !UnwindSafe for Button

§

impl Forget for Button

§

impl Freeze for Button

§

impl Move for Button

§

impl Unpin for Button

§

impl UnsafeUnpin for Button

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.