Struct SceneMinimap 

pub struct SceneMinimap { /* private fields */ }

A small thumbnail rendering of a Scene’s content, with the live viewport rectangle highlighted.

Paint order: clip on → background fill → optional content-bounds outline → item thumbnails (dots / rects) → viewport overlay rect → inset border → clip off. The clip covers every one of those, the border included.

The projected extent is content_bounds expanded to contain every item thumbnail and the live viewport — see this module’s documentation (“The projection, and why it expands”) for why, and docs/teksilo-scene.md § Minimap for the same story in prose.

Implementations

impl SceneMinimap

pub fn new(content_bounds: Rect, viewport: Signal<Rect>) -> Self

Construct a minimap that shows at least content_bounds (the scene-coord extent guaranteed to be visible), with viewport driving the live overlay rectangle.

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

Override the minimap size. Default 200×150.

pub fn items(self, items: Vec<(Rect, Color)>) -> Self

Static list of item thumbnails: (scene_rect, color). The minimap projects each rect onto its drawing area and fills it with color. Apps refresh by rebuilding the widget tree when items move.

Item rects widen the projected extent, so a thumbnail outside a stale or hand-picked content_bounds shrinks the picture instead of painting outside the frame.

pub fn background(self, color: Color) -> Self

Background fill color. Default semi-transparent white.

pub fn border(self, border: Option<(Color, f32)>) -> Self

Border around the minimap drawing area. Pass None for no border. Default 1px @ 50% black.

The band is drawn inside the widget — width is consumed from the drawing area, never from the neighbours (the CSS border-box convention). A wide border therefore covers the outer rim of the picture instead of the sibling next door, and the width is honoured as given rather than clamped. A width that is not finite and positive draws nothing.

pub fn viewport_color(self, color: Color) -> Self

Color of the viewport overlay rectangle. Default solid blue.

pub fn content_outline(self, outline: Option<(Color, f32)>) -> Self

Outline the content extent inside the minimap (gives users a “you’re somewhere inside this much scene” cue when the minimap is taller / wider than its content). Default None.

The outline tracks content_bounds through the projection, so once the viewport wanders off it the outline visibly shrinks and offsets — that is the cue. A width that is not finite and positive draws nothing.

pub fn on_click<F>(self, callback: F) -> Self

where F: Fn(Point, &mut EventContext<'_>) + 'static,

Navigation handler: centre the view on this scene point.

The contract is that specific on purpose. It is not “here is a point, do as you like”: the keyboard and assistive-technology routes compute their destination from the current viewport and announce where the move leaves it, and both of those are only true if the app centres.

SceneView has no single “centre on this point” call, so the app drives the camera it already owns. Either move the view’s pan directly — SceneView::pan_x_signal / pan_y_signal, or the app-owned pair handed to SceneView::view_state — or, when the view is wrapped in a SceneScrollView, move its scroll_pos_x_signal / scroll_pos_y_signal: the same pan through the door the scroll bars use, already expressed against the scrollable extent so a target can be clamped to it. examples/scene_showcase wires the second.

This route is the silent one — see this module’s “Accessibility” for which routes speak and why the tap is not among them.

Installing it is also what turns the minimap from a read-out into a control: the node becomes focusable and starts advertising its actions (see this module’s “Accessibility”). Without it the widget still announces where the viewport is, but takes no focus — a Tab stop with nothing behind it is worse than none.

A pointer tap inverts the exact projection the last paint used — not a recomputed one — so click-to-recentre lands on what the user is looking at, even while the viewport is off the content or the parent handed the minimap less room than it asked for.

pub fn access_readout<F>(self, phrasing: F) -> Self

where F: Fn(MinimapReadout) -> LocalizedString + 'static,

Phrase the accessible readout yourself.

The closure receives the geometry as a MinimapReadout and returns the string the AT node announces as its value and every non-pointer route announces after a move. Use it to translate the reading (tr!(minimap_position(across = …, down = …))) or to say something the widget cannot know — page numbers, a chapter name, map coordinates. The default is English, built by the same numbers.

One closure for both the value and the announcement on purpose: they are the same sentence read at two moments, and two hooks would let them disagree.

Trait Implementations

impl Debug for SceneMinimap

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

Formats the value using the given formatter.

impl Widget for SceneMinimap

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

Compose child widgets. Called once after the widget is placed in the arena, and again whenever the widget is marked for rebuild — a BindingLevel::Rebuild binding, rebuild_single_widget, or a density switch. A theme or locale switch does not rebuild: set_theme and set_locale mark layout + paint dirty and leave the built subtree standing, so anything derived from the theme or the locale must be read per pass or bound to a signal rather than captured here. Takes &mut self — store child IDs, signal handles, any state needed later. Returns the list of root child IDs (empty for leaf widgets).

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

Declare this widget’s accessibility identity.

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 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 culls_children(&self) -> bool

Whether this widget decides, on every layout pass, which of its children exist at all.

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 accessible_title_node(&self) -> Option<WidgetId>

The widget that paints this one’s title, when it has one.

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 accessibility_proxy(&self) -> Option<WidgetId>

The descendant whose accessibility node stands for this widget.

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

Which descendant a keyboard request for a context menu should target.

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 accepts_child_hit(&self, _child: WidgetId, _point: Point) -> bool

Veto a hit on one of this widget’s direct children, per point.

fn hit_outset(&self, _kind: PointerKind, _tokens: &InputTokens) -> EdgeInsets

How far outside its own bounds this widget still absorbs a press, per edge, for the pointer that is asking.

fn hit_slop(&self, _kind: PointerKind, _tokens: &InputTokens) -> Option<HitSlop>

This widget’s own say in the miss-only slop pass, overriding the density default for its node.

fn hit_distance(&self, local_point: Point, bounds: Rect) -> Option<f32>

How far a missed press is from this widget’s actual silhouette, in the widget’s own bounds space.

fn target_regions(&self, _bounds: Rect) -> Vec<TargetRegion>

The interactive sub-regions this widget paints inside its own single node — a scroll bar’s thumb, a slider’s knob, a header cell’s filter affordance.

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).