Struct ToolbarAction 

pub struct ToolbarAction { /* private fields */ }

A toolbar command: a label + an icon (both required), plus optional tooltip/toggle, an activation handler, an overflow priority, and an always_overflow flag. Renders as an icon-only IconButton inline (the label is its tooltip + accessible name) and as a labelled MenuItem in the overflow menu.

Implementations

impl ToolbarAction

pub fn new( label: impl Into<LocalizedString>, icon: impl Fn() -> IconWidget + 'static, ) -> Self

A new action with the given (translatable) label and icon factory, and a no-op handler. The label is the inline button’s tooltip + accessible name (the button is icon-only); the icon factory builds the glyph for both the inline IconButton and the overflow menu row (IconWidget isn’t Clone, so it is a factory).

pub fn menu(self, factory: impl Fn() -> MenuList + 'static) -> Self

Turn this action into a dropdown: its inline control becomes a PopoverIconButton that opens the MenuList built by factory (instead of a plain button that runs on_activate), and in the overflow it becomes a submenu. MenuList isn’t Clone, so pass a factory that builds a fresh one. Mutually exclusive with on_activate / toggle (the menu owns the interaction).

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

Plain-text tooltip shown after a hover delay (also the AT name supplement in IconOnly mode). Overrides any previously set rich tooltip — every setter clears the other so last-call wins.

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

Attach a rich tooltip resolved from the app-wide tooltip registry. The key is looked up via TooltipRegistry at build time; the resolved body text supports inline markup ([label](url), *italic*, **bold**) and the entry’s shortcut / “more” fields are rendered automatically.

Overrides any previously set plain .tooltip(...) — every setter clears the other so last-call wins.

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

Attach a rich tooltip driven by inline TooltipContent — for one-off tooltips that aren’t worth registering in the central catalog. Overrides any previously set plain .tooltip(...).

pub fn composite_tooltip( self, factory: impl Fn() -> Box<dyn Widget> + 'static, ) -> Self

Attach a composite tooltip whose body is built by factory — an arbitrary widget tree (tabbed sections, charts, conditional rows). Because ToolbarAction is Clone, the body is supplied as a factory closure (not a Box<dyn Widget> instance, which is not Clone); the closure is invoked to produce a fresh body for the inline button. Overrides any previously set tooltip — every setter clears the others so last-call wins.

pub fn enabled(self, enabled: impl Into<Prop<bool>>) -> Self

Enabled state, static or reactive.

pub fn on_activate(self, f: impl Fn(&mut EventContext<'_>) + 'static) -> Self

Activation handler (tap / Enter / Space / AT click / menu activate).

pub fn toggle(self, state: Signal<bool>) -> Self

Make this a checkable (toggle) action bound to state. Inline it reads as a pressed toggle button; in overflow as a checkmark menu item.

pub fn priority(self, priority: i32) -> Self

Overflow priority — actions with the lowest priority collapse into the menu first (NSToolbar semantics). Default 0.

pub fn always_overflow(self) -> Self

Always live in the overflow menu, never inline (WinUI secondary command).

Trait Implementations

impl Clone for ToolbarAction

fn clone(&self) -> ToolbarAction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.