Struct ImageButton 

pub struct ImageButton<'a, C: PixelColor, M: Clone> { /* private fields */ }

Tappable button whose face is a borrowed raster image, with an optional text label below it.

Implementations

impl<'a, C: PixelColor, M: Clone> ImageButton<'a, C, M>

pub fn new(pixels: &'a [C], image_size: Size) -> Self

Create a new image button from a row-major pixels slice of image_size. Defaults to ButtonClass::Standard and no label. Position and size are assigned by the parent container via arrange.

pub fn width(self, width: impl Into<Length>) -> Self

Width sizing intent.

pub fn height(self, height: impl Into<Length>) -> Self

Height sizing intent.

pub fn on_press(self, msg: M) -> Self

Set the message emitted on release.

pub fn on_press_maybe(self, msg: Option<M>) -> Self

Conditionally set the message. None leaves the button disabled.

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

Add a text label drawn beneath the image.

pub fn class(self, class: ButtonClass) -> Self

Select the semantic ButtonClass. Default is Standard.

pub fn font(self, font: &'a MonoFont<'a>) -> Self

Override the default font for the label.

pub fn is_enabled(&self) -> bool

True iff this button has a message bound. Disabled buttons render dimmed and ignore touches.

Trait Implementations

impl<'a, C: PixelColor, M: Clone> Widget<C, M> for ImageButton<'a, C, M>

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

Report the size this widget wants within constraints.

fn preferred_size(&self) -> (Length, Length)

Per-axis sizing intent set via .width(...) / .height(...). Containers consult this during layout to allocate fixed slots, query intrinsic sizes, and split residual space among Fill / FillPortion children. Default is Length::Fill on both axes.

fn arrange(&mut self, rect: Rectangle)

Commit the final rectangle, recursively arranging any children.

fn rect(&self) -> Rectangle

The current arranged rectangle.

fn handle_touch(&mut self, point: Point, phase: TouchPhase) -> Option<M>

Dispatch a touch event. Returns a message if consumed.

fn mark_pressed(&mut self, point: Point)

Set this widget’s pressed flag if point hits. No message emit. Containers forward to children. Default no-op.

fn draw<'t>( &self, renderer: &mut dyn Renderer<C>, theme: &Theme<'t, C>, ) -> Result<(), RenderError>

Paint into renderer at rect.

fn widget_id(&self) -> Option<WidgetId>

Stable id of this widget, if it participates in focus.

fn is_focusable(&self) -> bool

True if this widget should appear in focus traversal.

fn collect_focusable(&self, out: &mut Vec<WidgetId>)

Append focusable widget ids in traversal order.

fn sync_focus(&mut self, focused: Option<WidgetId>)

Synchronize focused state against the runtime’s currently-focused id.

fn handle_action(&mut self, action: UiAction) -> Option<M>

Handle a semantic action directed at this widget.

fn route_action(&mut self, target: WidgetId, action: UiAction) -> Option<M>

Route a semantic action to the widget with id target.

fn navigate_focus(&self, target: WidgetId, action: UiAction) -> Option<WidgetId>

Request a focus movement relative to target for directional actions.

fn focus_rect(&self, target: WidgetId) -> Option<Rectangle>

Rectangle currently occupied by the focusable target, if any.

fn focus_at(&self, point: Point) -> Option<WidgetId>

Focusable widget id at point, if any.