Struct PopoverWidget 

pub struct PopoverWidget<T: PopoverTrigger> { /* private fields */ }

A trigger paired with a popover surface. See the module docs for the contract on which trigger properties get overridden during build(). Use the PopoverButton / PopoverIconButton aliases for the concrete trigger types.

Implementations

impl<T: PopoverTrigger> PopoverWidget<T>

pub fn new(trigger: T) -> Self

Wrap a pre-configured trigger. The popover content is set separately via Self::content (required).

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

Set the popover content — added to the tree as a dormant subtree during build(), woken via EventContext::activate when the trigger fires. Required.

pub fn placement(self, p: OverlayPlacement) -> Self

Override the popover’s placement relative to the trigger. Default: [OverlayPlacement::BelowPreferred].

pub fn dismiss_behavior(self, b: DismissBehavior) -> Self

Override the dismiss behavior. Default: [DismissBehavior::EscapeOrClickOutside].

pub fn fade_duration(self, d: Duration) -> Self

Animate the overlay in / out over the given duration. Default: no fade. See [OverlayRequest::with_fade] for the mechanism.

pub fn has_popup_kind(self, k: HasPopup) -> Self

Override the has_popup kind announced by AT. Defaults to the trigger type’s PopoverTrigger::default_has_popup.

pub fn show_disclosure_caret(self, on: bool) -> Self

Whether to paint the disclosure triangle in the trigger’s bottom-right corner. Defaults to the trigger type’s PopoverTrigger::default_show_caret. The caret is suppressed automatically when PopoverTrigger::suppress_caret returns true (e.g. IconButton at Compact) regardless of this flag. AT-hidden — the popup is announced via set_has_popup + set_expanded.

pub fn on_open(self, f: impl Fn() + 'static) -> Self

Notification fired on the rising edge of the popover (after the overlay show request is dispatched). No EventContext — observe Self::open_signal from your build() if you need frame / dispatch context.

pub fn on_close(self, f: impl Fn() + 'static) -> Self

Notification fired on the falling edge of the popover (when the overlay’s dismiss callback runs).

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

Observe-only handle to the popover-open state.

Read-back only — writing this does not open the popover. Presenting an overlay needs an EventContext (show_overlay + request_focus), which no signal observer has; this field is the mirror the trigger writes after it has done that work. To open the popover from somewhere other than its trigger, use open_action.

pub fn open_action(self, intent: &'static str) -> Self

Register a named global action that toggles this popover, so a menu entry, a global shortcut or ctx.send_intent(...) can open it — not only a click on its own trigger.

Without this a popover is reachable by pointer alone. on_open / on_close are notification-only and open_signal is a read-back mirror (see its doc), so an app that wanted “Go to… ⌘G” next to its button had no way to wire the second half. Action handlers are the one place that does get an EventContext, which is exactly what presenting an overlay requires — so the action runs the identical toggle the trigger runs, and the two can never drift.

Registered with register_action_global, deliberately: intents walk source-widget → root, and a menu renders in an overlay that is a sibling of the popover’s own subtree, so a plain register_action would never be reached from a menu item. Pair it with register_shortcut_global in the app for the keystroke.

PopoverButton::new(Button::new(tr!(go_to())))
    .content(palette)
    .open_action("go.to")
// elsewhere: MenuEntry::new(tr!(go_to())).intent("go.to").shortcut("go.to")

pub fn surface(self, variant: PopoverVariant) -> Self

Choose which themed [PopoverVariant] surface wraps the content. Default is [PopoverVariant::Default] (elevated panel with padding + shadow). The surface is resolved from the active [PopoverStyle] (theme.style_slots.popover), so it themes app-wide.

pub fn bare(self) -> Self

Opt OUT of the themed surface: the content is added raw, with no background / border / padding. Use when the content already supplies its own chrome — a MenuList (which routes through the Menu PopoverStyle itself) or a hand-rolled surface Panel. Without this, such content would be double-chromed.

pub fn surface_style(self, style: impl PopoverStyle) -> Self

Per-call [PopoverStyle] override for the surface (highest precedence over the theme slot and the built-in default). Mirrors the per-call override the standalone Popover used to offer. No effect under bare.

pub fn surface_name(self, name: impl Into<String>) -> Self

Accessible name for the surface’s Role::Dialog node. Defaults to empty (the wrapped content usually carries its own role and name). No effect under bare or for the Menu variant (which is presentational).

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

Show a plain single-line tooltip on the trigger after a hover delay. Mutually exclusive with rich_tooltip, rich_tooltip_content, and composite_tooltip — each setter clears the other three so the last call wins. The tooltip anchors on the trigger, not on the popover content.

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

Show a rich tooltip (looked up by registry key) on the trigger after a hover delay. Mutually exclusive with the other tooltip setters — the last call wins.

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

Show an inline rich tooltip (pre-built TooltipContent) on the trigger after a hover delay. Mutually exclusive with the other tooltip setters — the last call wins.

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

Show a composite tooltip (arbitrary widget tree) on the trigger after a longer hover delay. Mutually exclusive with the other tooltip setters — the last call wins.

Trait Implementations

impl<T: PopoverTrigger> Debug for PopoverWidget<T>

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

Formats the value using the given formatter.

impl<T: PopoverTrigger> Widget for PopoverWidget<T>

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 children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

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

Declare this widget’s accessibility identity.

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