Struct IconWidget 

pub struct IconWidget { /* private fields */ }

A leaf widget that renders an icon from a path, SVG string, PNG, or WebP source.

Implementations

impl IconWidget

pub fn from_path(path: Path, size: f32) -> Self

Create an icon from a custom path. The path should be defined in coordinates matching the given size (e.g., 0..24 for size=24).

pub fn checkmark(size: f32) -> Self

A checkmark icon (✓) at the given size.

pub fn dash(size: f32) -> Self

A short horizontal dash at the given size — used as the indeterminate-state glyph for tristate menu items (mirrors the Windows “mixed-state” convention).

pub fn radio_dot(size: f32) -> Self

A small filled disc centered in the given size — used as the selected-state glyph for radio menu items.

pub fn chevron_down(size: f32) -> Self

A downward-pointing chevron (▼) at the given size.

pub fn chevron_right(size: f32) -> Self

A right-pointing chevron (▶) at the given size.

pub fn chevron_left(size: f32) -> Self

A left-pointing chevron (◀) at the given size.

pub fn chevron_up(size: f32) -> Self

An upward-pointing chevron (▲) at the given size.

pub fn from_svg(svg_str: &str) -> Self

Create an icon from an SVG string. Parses the SVG and extracts geometry, ignoring any colors in the SVG. Display size defaults to the SVG’s viewBox dimensions; use icon_size to override.

If parsing fails, logs the error in debug mode and produces an empty icon.

pub fn from_svg_icon(icon: &SvgIcon) -> Self

Create an icon from a pre-parsed [SvgIcon]. Display size defaults to the SVG’s viewBox; use icon_size to override. Scaling is deferred to paint time.

pub fn from_png(data: &'static [u8], size: f32) -> Self

Create an icon from PNG data.

If decoding fails, logs the error in debug mode and produces an empty icon.

pub fn from_webp(data: &'static [u8], size: f32) -> Self

Create an icon from WebP data. Auto-detects static vs animated.

If decoding fails, logs the error in debug mode and produces an empty icon.

pub fn from_raster(icon: &RasterIcon, size: f32) -> Self

Create an icon from a pre-decoded [RasterIcon]. Accepts a reference — pixel data is copied internally.

pub fn from_animated(icon: &AnimatedIcon, size: f32) -> Self

Create an icon from a pre-decoded [AnimatedIcon]. Accepts a reference — frame data is copied internally.

pub fn mode(self, mode: IconMode) -> Self

Set the icon rendering mode (tintable or full-color). Re-computes cached pixel data for raster/animated icons.

pub fn color(self, color: impl Into<ColorProp>) -> Self

Set the tint. Accepts any impl Into<ColorProp>:

• A raw Color — a frozen literal.
• A [TextRole] / SurfaceRole / BorderRole — resolved against the theme at paint time (reactive across theme switches).
• A Signal<Color> — reactive state (usually interaction-driven).

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

Set the display size of the icon. The path/image is scaled to fit this size during rendering. This does not affect the design-time coordinate space — SVG paths scale correctly.

pub fn follow_text_scale(self, follow: bool) -> Self

Make this icon grow with the global accessibility text scale (ctx.text_scale). Off by default. Enable for icons that sit inline with text and should scale together — e.g. status glyphs in a SeverityBadge. The reported (and rendered) size becomes display_size × text_scale.

Trait Implementations

impl Debug for IconWidget

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Widget for IconWidget

fn build(&mut self, ctx: &mut BuildContext<'_>) -> Vec<WidgetId>

Compose child widgets. Called once after the widget is placed in the arena, and again on environment change (theme switch, locale switch). Takes &mut self — store child IDs, signal handles, any state needed later. Returns the list of root child IDs (empty for leaf widgets).

fn layout_response( &self, _proposal: SizeProposal, ctx: &LayoutContext<'_>, ) -> LayoutResponse

Respond to the parent’s size proposal with this widget’s wanted size, grow/shrink weights, and compression floor (see [LayoutResponse]).

fn paint(&self, bounds: Rect, canvas: &mut Canvas, ctx: &PaintContext<'_>)

Draw the widget’s visual representation.

fn accessibility(&self, _builder: &mut AccessNodeBuilder)

Declare this widget’s accessibility identity.

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

Concrete type name of this widget (e.g. "teksilo_widgets::button::Button"). The default implementation resolves at the impl site via std::any::type_name::<Self>(), so calls through &dyn Widget correctly dispatch to the monomorphized fn for the concrete type — getting the concrete name through the vtable without per-impl boilerplate.

fn cacheable_layout(&self) -> bool

Whether this widget’s layout_response may be memoized by the per-pass layout cache. Defaults to true.

fn place_children( &self, _bounds: Rect, _proposal: SizeProposal, _children: &mut [WidgetPlacement], _ctx: &LayoutContext<'_>, )

Position children within the allocated bounds.

fn wants_after_paint(&self) -> bool

Whether this widget wants its after_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t aggregate descendant geometry.

fn after_paint(&self, _view: &WidgetTreeView<'_>, _ctx: &PaintContext<'_>)

Called once per frame after this widget’s subtree has finished painting. Receives a read-only view of the layout-resolved arena so a parent can read its descendants’ final bounds — e.g. TitleBar aggregates its drag region and control-button rects into a single HitRegions payload for the Windows backend’s WM_NCHITTEST.

fn wants_post_paint(&self) -> bool

Whether this widget wants its post_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t draw a foreground over their children.

fn post_paint( &self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>, )

Draw a foreground layer over this widget’s children.

fn wants_descendant_redirects(&self) -> bool

Whether this widget wants the AT walker to consult its a11y_redirect_descendant hook for every descendant during AT tree emission, not just its direct arena children.

fn a11y_redirect_descendant( &self, _self_id: WidgetId, _descendant: WidgetId, ) -> Option<NodeId>

Optional redirection hook for AT-tree placement of a child.

fn accessible_title_hint(&self) -> Option<String>

Suggest an accessible title to an enclosing container that wraps this widget as content — typically a modal / dialog shell that wants to propagate the inner content’s visible title as the shell’s own accessible name.

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

Optional hint that directs initial focus to a specific descendant when this widget is the root of a deferred-built modal surface.

fn children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

fn accessibility_children(&self) -> Option<Vec<WidgetId>>

Optional override for the child ORDER presented to assistive technology, when it must differ from the paint / z-order child order returned by children.

fn as_any(&self) -> Option<&(dyn Any + 'static)>

Downcast hook. Default implementation returns None; concrete widgets override with Some(self) when they want to expose their concrete type to test-level introspection or reflection. The trait already bounds on std::any::Any so concrete types satisfy the 'static requirement.

fn as_any_mut(&mut self) -> Option<&mut (dyn Any + 'static)>

Mutable counterpart of as_any. Default returns None; widgets that want to expose mutable state to tests (e.g. so a test can mutate a Scene inside a SceneView post-layout) override with Some(self). Should follow the same opt-in pattern as as_any: only widgets that opt into & introspection should opt into &mut.

fn clips_children(&self) -> bool

Whether this widget clips its children to its bounds.

fn focus_reveal_rect(&self, _bounds: Rect) -> Option<Rect>

The rectangle (in absolute tree coordinates) that best represents this widget when the framework reveals it into an ancestor scroll area on focus gain. Returning None (the default) reveals the widget’s whole bounds — correct for most controls.

fn hit_shape(&self, _local_point: Point, _bounds: Rect) -> bool

Whether the point lies inside this widget’s actual shape, not just its rectangular bounds. Consulted by hit-testing right after the bounds check: returning false for a point that is inside the bounding box makes the widget transparent to the click there, so it falls through to whatever sibling is painted underneath (the same machinery as a fully pass-through node, but shape-aware).

fn preserves_children_on_rebuild(&self) -> bool

How rebuild_single_widget treats this widget’s existing children when re-running its build().

fn tooltip_has_content(&self) -> bool

Whether this widget, used as tooltip content, currently has anything worth showing.

fn declare_shortcuts(&self) -> Vec<Shortcut>

Declare the rebindable keyboard shortcuts this widget exposes, without installing handlers. The framework calls this at arena insertion time (before build()) and at certain lazy boundaries (e.g. Switcher walks declarations on its not-yet-mounted Pending slots), so settings UIs and the ShortcutRegistry see the keystrokes the moment the owning container mounts — even if build() hasn’t run.

fn take_handler_set(&mut self) -> Option<HandlerSet>

Extract attached handler set from a WidgetWithHandlers wrapper. Called during arena insertion to transfer handlers to the WidgetNode. Default: returns None (no attached handlers).