Struct Stepper 

pub struct Stepper { /* private fields */ }

An embeddable multi-step flow widget. See the module docs for the data-flow pattern and a usage example.

Implementations

impl Stepper

pub fn new() -> Self

Create an empty Stepper. Append steps with step or steps and provide a finish callback with on_finish.

pub fn step(self, step: Step) -> Self

Append a single Step definition.

pub fn steps(self, steps: impl IntoIterator<Item = Step>) -> Self

Append multiple Step definitions from an iterator.

pub fn controller(self, controller: StepperController) -> Self

Drive the stepper with an externally-held controller (for programmatic reset / jump / introspection). If omitted, the stepper creates its own.

pub fn orientation(self, orientation: StepperOrientation) -> Self

Set the indicator-strip orientation (horizontal or vertical).

pub fn vertical(self) -> Self

Shorthand for .orientation(StepperOrientation::Vertical).

pub fn non_linear(self, non_linear: bool) -> Self

Allow jumping between steps by clicking their indicators (the markers become Role::Tab). Linear (default) markers are Role::ListItem.

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

Override the marker circle diameter (logical px).

pub fn chrome(self, chrome: impl Widget + 'static) -> Self

A generic chrome widget (banner / sidebar) — the modern replacement for QWizard’s watermark pixmap.

It lands in the leading column by default (ChromePosition::Leading, QWizard’s watermark slot), i.e. a full height sidebar. For a title banner pair it with .chrome_position(ChromePosition::Top), or the chrome renders as a wide sidebar holding a few words.

pub fn chrome_position(self, position: ChromePosition) -> Self

Choose where the optional chrome widget sits relative to the stepper body. Forced to ChromePosition::Top when orientation is Vertical.

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

Override the “Back” button label. Default: “Back”.

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

Override the “Next” button label. Default: “Next”.

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

Override the “Finish” button label. Default: “Finish”.

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

Override the “Skip” button label. Default: “Skip”.

pub fn help( self, label: impl Into<LocalizedString>, action: impl Fn(&mut EventContext<'_>, &StepperController) + 'static, ) -> Self

Add a Help button + callback to the footer.

pub fn cancel( self, label: impl Into<LocalizedString>, action: impl Fn(&mut EventContext<'_>, &StepperController) + 'static, ) -> Self

Add a Cancel button + callback to the footer.

pub fn on_finish<R: IntoFinishOutcome>( self, action: impl Fn(&mut EventContext<'_>, &StepperController) -> R + 'static, ) -> Self

Called when Finish is activated on the last step. Receives the event context and the controller (for skipped / visited introspection); read collected values from the form signals your steps wrote.

The callback may refuse. Its return value goes through the IntoFinishOutcome bridge — () always succeeds, while false, Err(_), or FinishOutcome::Rejected keep the stepper on the last step and mark it StepStatus::Error (a Wizard modal stays open). This is the Finish counterpart of Step::validate_on_next — for the case where the commit itself can fail (disk full, name taken, server refused):

.on_finish(move |ctx, _ctrl| match create_project(&name.get()) {
    Ok(()) => true,
    Err(e) => { status.set(e.to_string()); false }
})

pub fn enter_advances(self, enter_advances: bool) -> Self

Whether pressing Enter activates the footer’s primary button (Next, or Finish on the last step). Default: true.

The key is handled on the bubble pass at the stepper root, so a focused control that wants Enter for itself — a Button, a multi-line editor, a list row — consumes it first and the stepper never sees it. A single-line form field lets it through, which is where the “Enter means Next” contract is expected. Gates apply exactly as they do to a click: a blocked complete_when / validate_on_next refuses the same way.

Turn it off for a step whose body treats Enter as content in a way the framework cannot see.

pub fn tooltip(self, text: impl Into<LocalizedString>) -> Self

Attach a plain single-line tooltip to this stepper. Clears any previously set rich or composite tooltip.

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

Attach a rich tooltip identified by a registry key. Clears any previously set plain or composite tooltip.

pub fn rich_tooltip_content(self, content: TooltipContent) -> Self

Attach a rich tooltip with inline content. Clears any previously set plain or composite tooltip.

pub fn composite_tooltip(self, content: impl Widget + 'static) -> Self

Attach a composite tooltip (arbitrary widget body). Clears any previously set plain or rich tooltip.

Trait Implementations

impl Debug for Stepper

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

Formats the value using the given formatter.

impl Default for Stepper

fn default() -> Self

Returns the “default value” for a type.

impl Widget for Stepper

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 place_children( &self, bounds: Rect, _proposal: SizeProposal, children: &mut [WidgetPlacement], _ctx: &LayoutContext<'_>, )

Position children within the allocated bounds.

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

Declare this widget’s accessibility identity.

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

Return the child widget IDs that this widget manages.

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 paint(&self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>)

Draw the widget’s visual representation.

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