pub struct IconButton { /* private fields */ }Implementations§
Source§impl IconButton
impl IconButton
pub fn new(icon: IconGlyph, label: impl Into<String>) -> Self
Sourcepub fn from_image(icon: ImageHandle, label: impl Into<String>) -> Self
pub fn from_image(icon: ImageHandle, label: impl Into<String>) -> Self
Use a registered mask image with the same interaction, tint and focus behavior as the built-in glyph buttons.
pub fn theme(self, theme: DefaultTheme) -> Self
pub fn description(self, description: impl Into<String>) -> Self
pub fn appearance(self, appearance: ButtonAppearance) -> Self
pub fn tone(self, tone: SemanticTone) -> Self
pub fn theme_when<F>(self, theme: F) -> Selfwhere
F: Fn() -> DefaultTheme + 'static,
pub fn size(self, size: f32) -> Self
pub fn icon_size(self, icon_size: f32) -> Self
pub fn selected(self, selected: bool) -> Self
pub fn selected_when<F>(self, selected: F) -> 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 IconButton
impl Widget for IconButton
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<'_>)
Receive a typed command addressed directly to this widget. Commands are
target-only and do not capture or bubble through the widget tree.
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
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
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
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
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
fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)
Source§fn supports_output_reuse(&self) -> bool
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.
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
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.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>
Describe this widget as the logical owner of a presented overlay. Read more
Source§fn hit_test_self(&self) -> bool
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)
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)
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 IconButton
impl !Send for IconButton
impl !Sync for IconButton
impl !UnwindSafe for IconButton
impl Forget for IconButton
impl Freeze for IconButton
impl Move for IconButton
impl Unpin for IconButton
impl UnsafeUnpin for IconButton
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more