Struct Toolbar 

pub struct Toolbar { /* private fields */ }

A command bar with automatic overflow. See the module docs.

Implementations

impl Toolbar

pub fn new() -> Self

Create an empty toolbar with the default orientation (horizontal) and Compact, ghost icon buttons. Add commands with action or layout items with item.

pub fn item(self, item: ToolbarItem) -> Self

Add an item (action, pinned widget, separator, flexible space).

pub fn action(self, action: ToolbarAction) -> Self

Sugar for .item(ToolbarItem::action(a)).

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

Add a pinned inline child widget (sugar for .item(ToolbarItem::custom(widget))). Pinned widgets never collapse into the overflow menu — use action for collapsible commands.

pub fn add_child(self, id: WidgetId) -> Self

Add a pinned inline child by pre-registered id (sugar for .item(ToolbarItem::custom_id(id))).

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

Set the layout axis (default ToolbarOrientation::Horizontal).

pub fn button_size(self, size: IconButtonSize) -> Self

Size variant applied to every action’s inline IconButton and the overflow chevron (default IconButtonSize::Compact).

pub fn button_style(self, style: impl IconButtonStyle) -> Self

A toolbar-wide [IconButtonStyle] applied to every action button and the overflow chevron — one shared style for the whole bar (the icon-button analogue of theme.style_slots). Default: the theme’s flat / ghost icon-button style.

pub fn spacing(self, spacing: f32) -> Self

Gap between consecutive toolbar items in logical pixels (default TOOLBAR_SPACING).

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

Override the accessible name (default: the localized “Toolbar”).

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

Compact (shrink-to-fit) sizing. By default a toolbar fills the main extent it is offered (it is meant to span a full command bar). In compact mode it instead reports its natural content extent as the wanted size and is shrinkable down to its collapsed minimum (the pinned items plus the overflow chevron) — so it sits as a tight cluster when there is room, composes next to other widgets (e.g. a title and a Spacer) without claiming their space, and still collapses excess actions into the ⌄ menu when the slot is genuinely too narrow. Use it to embed a toolbar in a constrained header rather than a full-width bar.

pub fn is_overflowing(&self) -> Signal<bool>

Reactive signal that is true whenever any action is collapsed into the overflow menu (WinUI IsOverflowOpen-adjacent introspection).

Trait Implementations

impl Debug for Toolbar

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

Formats the value using the given formatter.

impl Default for Toolbar

fn default() -> Self

Returns the “default value” for a type.

impl Widget for Toolbar

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