pub struct Button { /* private fields */ }Implementations§
Source§impl Button
impl Button
Sourcepub fn new(label: impl Into<String>) -> Self
pub fn new(label: impl Into<String>) -> Self
Creates a neutral, tonal button for an ordinary action.
Sourcepub fn primary(label: impl Into<String>) -> Self
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.
Sourcepub fn danger(label: impl Into<String>) -> Self
pub fn danger(label: impl Into<String>) -> Self
Creates a filled danger button for a destructive or irreversible action.
pub fn current_label(&self) -> &str
pub fn set_label(&mut self, label: impl Into<String>)
pub fn semantic_name(self, name: impl Into<String>) -> Self
pub fn description(self, description: impl Into<String>) -> Self
Sourcepub fn appearance(self, appearance: ButtonAppearance) -> Self
pub fn appearance(self, appearance: ButtonAppearance) -> Self
Selects the button’s visual emphasis without changing its semantic
meaning. The default is ButtonAppearance::Tonal.
Sourcepub fn tone(self, tone: SemanticTone) -> Self
pub fn tone(self, tone: SemanticTone) -> Self
Selects the semantic color family used by this button. The default is
SemanticTone::Neutral.
Sourcepub fn primary_action(self) -> Self
pub fn primary_action(self) -> Self
Promotes this button to a filled accent primary action.
Sourcepub fn danger_action(self) -> Self
pub fn danger_action(self) -> Self
Promotes this button to a filled danger action.
pub fn theme(self, theme: DefaultTheme) -> Self
pub fn theme_when<F>(self, theme: F) -> Selfwhere
F: Fn() -> DefaultTheme + 'static,
pub fn text_style(self, text_style: TextStyle) -> Self
pub fn icon(self, icon: IconGlyph) -> Self
pub fn without_icon(self) -> Self
pub fn icon_size(self, icon_size: f32) -> Self
pub fn icon_gap(self, icon_gap: f32) -> Self
pub fn min_width(self, width: f32) -> Self
pub fn min_height(self, height: f32) -> Self
pub fn padding(self, padding: Insets) -> Self
pub fn enabled(self, enabled: bool) -> Self
pub fn enabled_when<F>(self, enabled: F) -> Self
Sourcepub fn enabled_from<O>(self, enabled: O) -> Selfwhere
O: Observable<bool> + 'static,
pub fn enabled_from<O>(self, enabled: O) -> Selfwhere
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.
Sourcepub fn interaction_preview(self, preview: InteractionPreview) -> Self
pub fn interaction_preview(self, preview: InteractionPreview) -> Self
Pins hover, press, or focus visuals; see InteractionPreview.
Sourcepub fn focus_on_press(self, focus: bool) -> Self
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.
pub fn on_press<F>(self, on_press: F) -> Selfwhere
F: FnMut() + 'static,
pub fn on_press_with_ctx<F>(self, on_press: F) -> Self
pub fn is_enabled(&self) -> bool
Trait Implementations§
Source§impl Widget for Button
impl Widget for Button
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn paint(&self, ctx: &mut PaintCtx)
fn semantics(&self, ctx: &mut SemanticsCtx)
fn accepts_focus(&self) -> bool
fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)
Source§fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
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
fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32
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
fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize
fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
Source§fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
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.fn stack_host_options(&self) -> Option<StackHostOptions>
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Source§fn hit_test_self(&self) -> bool
fn hit_test_self(&self) -> bool
false so those points reach what is behind
them.