ToolbarButton

Layer: cell · Path: src/cells/toolbar_button.rs · Exports: toolbar_button::ToolbarButton

An icon toggle button with an optional hover tooltip, modelled on Unity/O3DE toolbars. It wraps the Toggle atom in icon mode and binds it to a &mut bool (the active state). When a tooltip is set the response is wrapped by the Tooltip atom. Carries lifetime 'a from the mutable borrow.

Design

• Purpose / when to use — Tool palettes / toolbars where each button is a momentary-or-sticky icon toggle (select / move / rotate, view modes, snapping flags).

• Anatomy — A Toggle in .icon(glyph) mode bound to the &mut bool, optionally decorated by a Tooltip over the resulting response.

• Variants / states

  State	Source
  active / inactive	the bound &mut bool (mutated in place by Toggle)
  tooltip on hover	present only when tooltip(...) was set

• Tokens / layout consumed — Inherited from the Toggle atom (sizing/fill); ToolbarButton adds none of its own. See tokens.

• Accessibility — Tooltip provides the textual label for an otherwise icon-only control; prefer always setting tooltip(...).

API

Usage

#![allow(unused)]
fn main() {
use ouroboros_ui::cells::ToolbarButton;
use ouroboros_ui::egui_phosphor::light;

let mut active = true;
ToolbarButton::new(&mut active, light::CURSOR).tooltip("Select").id_source("tb0").show(ui);
}

#![allow(unused)]
fn main() {
// realistic — a horizontal tool palette over an array of flags
let mut state = [true, false, false];
ui.horizontal(|ui| {
    ToolbarButton::new(&mut state[0], light::CURSOR).tooltip("Select").id_source("tb0").show(ui);
    ToolbarButton::new(&mut state[1], light::ARROWS_OUT).tooltip("Move").id_source("tb1").show(ui);
    ToolbarButton::new(&mut state[2], light::ARROWS_CLOCKWISE).tooltip("Rotate").id_source("tb2").show(ui);
});
}

Composition

Composes the Toggle atom (icon mode) and, when a tooltip is set, the Tooltip atom. It paints nothing — all visuals come from Toggle. Enforced by tests/no_painter_in_molecules.rs.

Notes

• Binding: active is &mut bool — the toggle flips it in place; there is no selected/return-value to read for state, only .clicked() on the response for reacting to a press.
• Give each button an id_source (e.g. "tb0"); buttons sharing the same glyph would otherwise collide on the toggle’s auto id.
• Mutually-exclusive tools (radio-like) are the consumer’s responsibility — reset the other flags when one is clicked.