Skip to main content

teksilo_core/widget/
event_context.rs

1// SPDX-License-Identifier: MPL-2.0
2// SPDX-FileCopyrightText: 2026 FernTech
3
4use crate::pointer::touch_action::TouchAction;
5use crate::widget_id::WidgetId;
6
7use super::CursorIcon;
8
9/// Selects which overlay-dismissal pathway runs after a handler
10/// returns. Last-write-wins: each `dismiss_*_overlays()` setter
11/// overwrites the previous choice. `None` (the default) falls
12/// through to draining individual ids from `overlay_dismissals`.
13#[derive(Debug, Clone, Copy, PartialEq, Eq)]
14pub(crate) enum DismissScope {
15    /// Dismiss every overlay in the stack, including hosts.
16    All,
17    /// Dismiss every overlay whose content is *not* a host surface
18    /// (`Tooltip`, `Dialog`, `AlertDialog`). Used by popover triggers
19    /// and pre-show cleanup.
20    AllExceptHosts,
21    /// Walk up from the source widget's containing overlay,
22    /// dismissing menu-like overlays and stopping at the first host
23    /// surface. Used by menu / dropdown item activation.
24    SelfChain,
25    /// Dismiss the topmost overlay only.
26    Top,
27}
28
29/// One queued "reveal this rectangle" request, drained after the handler
30/// returns and turned into a [`WidgetEvent::ScrollIntoView`] per clipping
31/// ancestor.
32///
33/// A struct rather than a tuple because the three modifiers (margin, alignment,
34/// motion) are independent and positional tuples of that width stop being
35/// readable at the call site.
36///
37/// [`WidgetEvent::ScrollIntoView`]: crate::event::WidgetEvent::ScrollIntoView
38#[derive(Debug, Clone, Copy, PartialEq)]
39pub(crate) struct ScrollRevealRequest {
40    /// The target, in absolute tree (window) coordinates.
41    pub(crate) rect: teksilo_canvas::Rect,
42    /// Breathing room to keep around the target, in logical pixels.
43    pub(crate) margin: f32,
44    /// Where the target should come to rest vertically.
45    pub(crate) align: crate::event::ScrollAlign,
46    /// Whether to jump or glide.
47    pub(crate) motion: crate::event::ScrollMotion,
48    /// **Whose** ancestors to walk, when that is not the widget whose handler
49    /// queued this.
50    ///
51    /// `None` means the source widget, which is right whenever a widget reveals
52    /// something inside itself. It is wrong — silently — whenever the rect belongs
53    /// to a *different* widget: a find banner's Next button asking for a match in
54    /// the prose, a toolbar revealing a row in the list below it. Those walk the
55    /// button's ancestors, which do not include the scroll container the rect lives
56    /// in, so nothing scrolls and the reveal is a no-op no error reports.
57    pub(crate) from: Option<crate::widget_id::WidgetId>,
58}
59
60/// What a handler said about the cursor during one dispatch.
61///
62/// A handler either names a cursor or withdraws, and the two are distinct
63/// answers: withdrawing is not "show `Default`", it is "the node's own
64/// declaration applies again". One slot, so the last call in a dispatch wins,
65/// the way it did when this was a bare `Option<CursorIcon>`.
66#[derive(Clone, Copy, Debug, PartialEq, Eq)]
67pub(crate) enum CursorRequest {
68    /// Override the cursor with this icon.
69    Set(CursorIcon),
70    /// Give the cursor back to whatever the hovered node declared.
71    Release,
72}
73
74/// Context available during event handling.
75pub struct EventContext<'ops> {
76    /// A handler's word on the cursor for this dispatch, if it said one.
77    pub(crate) cursor_request: Option<CursorRequest>,
78    /// The cursor the **node** declared, written only by the router's
79    /// `PointerEnter` / `PointerLeave` arms. Kept apart from
80    /// [`cursor_request`](Self::cursor_request) so that a handler which also
81    /// speaks during the same dispatch overrides the declared cursor without
82    /// erasing the tree's memory of what it was — which is the value
83    /// [`release_cursor`](Self::release_cursor) hands back to.
84    pub(crate) declared_cursor_request: Option<CursorIcon>,
85    pub(crate) tree_mutations: Vec<TreeMutation>,
86    pub(crate) idle_callbacks: Vec<crate::idle::IdleCallback>,
87    pub(crate) modal_requests: Vec<crate::modal::ModalRequest>,
88    pub(crate) dismiss_modal: bool,
89    pub(crate) overlay_requests: Vec<crate::overlay::OverlayRequest>,
90    pub(crate) overlay_dismissals: Vec<crate::overlay::OverlayId>,
91    /// Content widget ids whose currently-shown overlay (if any) should
92    /// be dismissed. Resolved to an `OverlayId` via
93    /// `OverlayManager::find_by_content` at drain time. Lets a handler
94    /// dismiss an overlay it can only identify by content (e.g. a single
95    /// reusable tooltip surface) — the symmetric companion to
96    /// [`cancel_delayed_overlay`](EventContext::cancel_delayed_overlay).
97    pub(crate) overlay_content_dismissals: Vec<crate::widget_id::WidgetId>,
98    /// Overlay requests that name a z-band other than the default. Kept apart
99    /// from [`overlay_requests`](Self::overlay_requests) rather than carried on
100    /// `OverlayRequest` itself: the band is a property of the *show*, not of
101    /// the request, and every existing construction site of the struct would
102    /// otherwise have to name it.
103    pub(crate) overlay_band_requests:
104        Vec<(crate::overlay::OverlayRequest, crate::overlay::OverlayBand)>,
105    /// New placements for overlays named by their content root. A
106    /// caret-anchored overlay has to be re-placed as the caret moves, and
107    /// `position_overlays` re-reads the placement it was shown with — so
108    /// without this an affordance follows nothing.
109    pub(crate) overlay_placement_updates:
110        Vec<(crate::widget_id::WidgetId, crate::overlay::OverlayPlacement)>,
111    /// Overlay ids whose `auto_dismiss_after` timer should be paused
112    /// or resumed after the handler returns (`true` = pause, `false`
113    /// = resume). Drained by `WidgetTree::collect_from_ctx` against
114    /// `OverlayManager::pause_auto_dismiss` / `resume_auto_dismiss`,
115    /// after the dismissals in the same drain: a pause aimed at an
116    /// overlay the same handler dismissed is silently dropped. Used
117    /// by `ToastHost` for hover-pause.
118    pub(crate) overlay_pause_requests: Vec<(crate::overlay::OverlayId, bool)>,
119    /// The dismissal scope chosen by the handler, if any. Set by
120    /// `dismiss_all_overlays()` / `dismiss_all_except_hosts()` /
121    /// `dismiss_self_overlay_chain()` / `dismiss_top_overlay()` —
122    /// last setter wins. `None` falls through to draining the
123    /// per-id `overlay_dismissals` vec instead.
124    pub(crate) dismiss_scope: Option<DismissScope>,
125    /// Request to capture (`true`) or release (`false`) a pointer, and which
126    /// one. `None` for the pointer means the one whose sample this handler is
127    /// serving — the default, and what every pre-multi-touch call site means.
128    pub(crate) pointer_capture: Option<(Option<crate::pointer::PointerId>, bool)>,
129    /// The widget currently holding the capture of the pointer being
130    /// dispatched, as the tree knew it when this context was made. Read by
131    /// [`owns_pointer`](EventContext::owns_pointer).
132    pub(crate) pointer_captor: Option<WidgetId>,
133    /// Whether the capture request above came from a **widget handler** rather
134    /// than from framework plumbing.
135    ///
136    /// The distinction is the whole of A4's "explicit capture is an
137    /// arbitration act": the gesture arena and the drag pipeline both capture
138    /// the pointer for their own bookkeeping, and neither is a widget staking
139    /// a claim. Only a `capture_pointer()` written in a handler enrols its
140    /// caller as a [`MemberRole::RawDrag`](crate::gesture::MemberRole::RawDrag)
141    /// competitor.
142    pub(crate) explicit_capture: bool,
143    /// A recognizer on this node produced a gesture that **owns the rest of
144    /// the press** — a drag or a swipe, as opposed to a tap, which completes
145    /// the press rather than claiming it. Set by `dispatch_recognized_gesture`
146    /// and read by `collect_from_ctx`, which decides the pointer's sequence in
147    /// the recognizer's favour.
148    pub(crate) recognized_owning_gesture: bool,
149    /// A press-time [`DragActivation`](teksilo_tokens::DragActivation) chosen
150    /// for this node by its own press handler, overriding its build-time
151    /// declaration for this press alone. Applied by `collect_from_ctx` onto the
152    /// pointer's sequence, which the enrolment walk reads immediately
153    /// afterwards. See [`EventContext::set_drag_activation`].
154    pub(crate) drag_activation_override: Option<teksilo_tokens::DragActivation>,
155    /// Arbitration acts the handler performed on the sequence owning the
156    /// pointer it is serving, in the order it performed them. Applied by
157    /// `WidgetTree::collect_from_ctx` against that sequence.
158    pub(crate) gesture_acts: Vec<GestureAct>,
159    /// The handler asked for its pointer's whole interaction to be revoked.
160    /// Queued by `WidgetTree::collect_from_ctx` onto the cancel funnel, so it
161    /// runs after this dispatch rather than under it. Last reason wins.
162    pub(crate) cancel_pointer_request: Option<crate::pointer::CancelReason>,
163    /// The node whose handler is running, when the dispatcher knows it.
164    /// `None` for a context made outside per-node dispatch (a gesture timer, a
165    /// key-capture callback, an async completion).
166    pub(crate) dispatch_node: Option<WidgetId>,
167    /// The node the router resolved as this dispatch's **target** — the
168    /// innermost node the arena's hit walk accepted. Read by
169    /// [`dispatch_target`](EventContext::dispatch_target).
170    pub(crate) dispatch_target: Option<WidgetId>,
171    /// Delayed overlay requests (request, delay, optional focus target,
172    /// whether to dismiss sibling overlays when it finally shows).
173    pub(crate) delayed_overlay_requests: Vec<(
174        crate::overlay::OverlayRequest,
175        std::time::Duration,
176        Option<crate::widget_id::WidgetId>,
177        bool,
178    )>,
179    /// Timed overlay requests (request, auto-dismiss delay).
180    pub(crate) timed_overlay_requests: Vec<(crate::overlay::OverlayRequest, std::time::Duration)>,
181    /// Reveal overlay requests (request, caller-owned animated progress
182    /// signal, tween duration). The framework shows the overlay, then
183    /// drives `progress` 0 → 1 on show and 1 → 0 on dismiss, deferring
184    /// the actual stack removal until the roll-back tween completes —
185    /// the same deferral the fade path uses, minus the opacity scope.
186    /// The caller applies `progress` however it wants (e.g. an `Unroll`
187    /// width). See [`show_overlay_with_reveal`](EventContext::show_overlay_with_reveal).
188    pub(crate) reveal_overlay_requests: Vec<(
189        crate::overlay::OverlayRequest,
190        crate::signal::Signal<f32>,
191        std::time::Duration,
192    )>,
193    /// Dismiss descendant overlays of the source widget's containing overlay.
194    /// Optionally preserve the subtree rooted at a specific content widget ID.
195    pub(crate) dismiss_descendant_overlays: Vec<Option<crate::widget_id::WidgetId>>,
196    /// Cancel pending delayed overlays by content widget ID.
197    pub(crate) cancel_delayed_overlays: Vec<crate::widget_id::WidgetId>,
198    /// Overlays whose safe triangle should be armed at the current
199    /// pointer position once this handler returns. See
200    /// [`EventContext::arm_overlay_safe_region`].
201    pub(crate) safe_region_arm_requests: Vec<crate::widget_id::WidgetId>,
202    /// Widget IDs that need repainting (cross-widget signal propagation).
203    pub(crate) repaint_requests: Vec<crate::widget_id::WidgetId>,
204    /// Synthetic clicks to dispatch on target widgets after event processing.
205    pub(crate) synthetic_clicks: Vec<crate::widget_id::WidgetId>,
206    /// Focus requests — transfer focus to a specific widget (e.g., overlay content on open).
207    pub(crate) focus_requests: Vec<crate::widget_id::WidgetId>,
208    /// Focus-into requests — move focus to the *first focusable descendant* of
209    /// the given widget, with no fallback to the widget itself when the subtree
210    /// has none. The "dive into this region's content" intent (Enter on a tab
211    /// header → into the tab panel), distinct from `focus_requests` which
212    /// focuses the container itself as a last resort.
213    pub(crate) focus_into_requests: Vec<crate::widget_id::WidgetId>,
214    /// Rect-based "scroll this into view" requests, stated in the **queuing
215    /// widget's own bounds space** — window coordinates everywhere except
216    /// inside a content transform (a `SceneView`'s scene coordinates), which
217    /// the ancestor walk carries outward one space at a time.
218    /// Queued by [`ensure_visible`](EventContext::ensure_visible)
219    /// / [`ensure_visible_with_margin`](EventContext::ensure_visible_with_margin).
220    /// Drained in `collect_from_ctx`, which walks the ancestors of the widget
221    /// whose handler queued the request and dispatches
222    /// [`WidgetEvent::ScrollIntoView`](crate::event::WidgetEvent::ScrollIntoView)
223    /// to every `clips_children` scroll container that doesn't already fully
224    /// contain the rect — the same ancestor-walk the focus path uses, but
225    /// with a caller-supplied rectangle instead of a widget's own bounds
226    /// (so a caret, a virtualized row, or a scrolled-off tab header can be
227    /// revealed even though it is not itself a distinct focused node).
228    pub(crate) scroll_into_view_requests: Vec<ScrollRevealRequest>,
229    /// Widget-id-based "scroll this into view" requests, queued by
230    /// [`ensure_widget_visible`](EventContext::ensure_widget_visible) /
231    /// [`ensure_widget_visible_with_margin`](EventContext::ensure_widget_visible_with_margin).
232    /// Drained in `collect_from_ctx`, which resolves each id to its current
233    /// absolute arena bounds and walks *that widget's* ancestors (the target
234    /// widget itself excluded) dispatching
235    /// [`WidgetEvent::ScrollIntoView`](crate::event::WidgetEvent::ScrollIntoView).
236    /// The convenience form of the rect API for a target that is a real
237    /// mounted, non-virtualized child (a radio tile, a tab header) whose bounds
238    /// the framework already knows — the caller need not compute the rect.
239    pub(crate) scroll_widget_into_view_requests: Vec<(crate::widget_id::WidgetId, f32)>,
240    /// Keyboard-highlight tooltip requests: surface the tooltip of the given
241    /// (menu) item immediately and dismiss the previously-highlighted one.
242    /// Drained after the handler (see `pointer_router::collect_from_ctx`).
243    /// Only the last entry per handler is honoured — a handler sets one
244    /// highlight per key.
245    pub(crate) highlight_tooltip_requests: Vec<crate::widget_id::WidgetId>,
246    /// Drag start request: (source_widget_id, payload, optional_preview_widget).
247    pub(crate) drag_start_request: Option<(
248        crate::widget_id::WidgetId,
249        crate::drag_payload::DragPayload,
250        Option<Box<dyn crate::widget::Widget>>,
251    )>,
252    /// Cancel any active drag session.
253    pub(crate) cancel_drag: bool,
254    /// Whether the drag session active while this context is live was
255    /// started by an external (OS) drag. Read via `drag_is_external()`.
256    /// `false` for hand-constructed contexts and when no drag is active.
257    pub(crate) drag_is_external: bool,
258    /// Replace the tree-level theme. Drained after dispatch; triggers a
259    /// composite-widget rebuild and full repaint.
260    pub(crate) theme_request: Option<crate::styles::Theme>,
261    /// Request that the app follow the OS theme (native / system mode).
262    /// Drained after dispatch; the app switches to `ThemeMode::Native` and
263    /// recomputes the theme from the current OS colours. Parameterless so
264    /// `teksilo-widgets` never needs the app-layer `ThemeMode` enum.
265    pub(crate) follow_system_request: bool,
266    /// Replace the tree-level locale identifier. Drained after dispatch;
267    /// triggers a composite-widget rebuild and full repaint.
268    pub(crate) locale_request: Option<String>,
269    /// Set the user-controlled text-scale factor. Drained after dispatch and
270    /// fanned out to every window; grows all text without a rebuild.
271    pub(crate) text_scale_request: Option<f32>,
272    /// Set by `request_frame()`; consumed by the event dispatcher which
273    /// forwards it to `WidgetTree::request_frame()` so the next layout
274    /// pass advances the per-frame tick signal.
275    pub(crate) frame_requested: bool,
276    /// Optional reference to the tree's app-state registry, so handlers
277    /// can look up application-scoped values via `app_state::<T>()`.
278    /// Populated by the dispatcher before running each handler; `None`
279    /// for hand-constructed contexts in tests.
280    pub(crate) app_context: Option<std::rc::Rc<crate::event_source::TreeAppContext>>,
281    /// App-level window-ops sink. Injected by the dispatcher so
282    /// handlers can reach the multi-window API (`open_window`,
283    /// `focus_window`, …) synchronously. For `EventContext`
284    /// instances constructed outside a dispatch (standalone trees,
285    /// tests) this is `None` and the multi-window methods no-op /
286    /// return `None`.
287    pub(crate) window_ops: Option<&'ops mut dyn crate::window::WindowOps>,
288    /// [`WindowState`](crate::window::WindowState) for the window
289    /// this tree belongs to. Cloned from the tree at construction.
290    /// `None` for standalone trees.
291    pub(crate) current_window: Option<crate::window::WindowState>,
292    /// Snapshot of the tree's occlusion-aware window-active state
293    /// (`focused AND not occluded`) at construction time. Distinct from
294    /// `current_window.focused()` (raw OS focus, no occlusion). Read by
295    /// [`window_active`](Self::window_active). Defaults `true` (matches the
296    /// tree's initial value) for standalone / test contexts.
297    pub(crate) tree_window_active: bool,
298    /// Last `PointerMove` position observed by the tree. Snapshotted
299    /// at handler-invocation time so widgets that don't see the live
300    /// pointer event (e.g. an `on_hover` callback that fires on the
301    /// boundary edge) can still query "where is the cursor right
302    /// now". Read by the safe-triangle submenu hover gate.
303    pub(crate) tree_pointer_position: Option<teksilo_canvas::Point>,
304    /// True when the in-flight pointer press's hit target is a strict
305    /// descendant of the widget whose handler is currently running and that
306    /// descendant carries its own tap gesture (a chevron, checkbox, inline
307    /// button). Set per-node by the dispatcher for `PointerDown`/`PointerUp`.
308    /// Read via [`press_claimed_by_interactive_child`](Self::press_claimed_by_interactive_child).
309    pub(crate) press_claimed_by_interactive_child: bool,
310    /// Per-content-widget overlay bounds — and armed safe-triangle apex,
311    /// when the overlay has one — snapshotted at handler invocation. A
312    /// flat vec is fine: open overlays are typically 0–3 per tree. Read
313    /// by [`EventContext::overlay_bounds_for_content`] and
314    /// [`EventContext::overlay_safe_region_armed`].
315    pub(crate) overlay_bounds_snapshot: Vec<(
316        WidgetId,
317        teksilo_canvas::Rect,
318        Option<teksilo_canvas::Point>,
319    )>,
320    /// The widget holding focus when this batch began. Part of the same
321    /// per-dispatch snapshot as the two above, and read by
322    /// [`focused`](EventContext::focused).
323    pub(crate) focused_widget: Option<WidgetId>,
324    /// Intents queued by handlers via `send_intent`. Drained by the
325    /// tree after event dispatch and routed source-widget → root.
326    pub(crate) pending_intents: Vec<crate::intent::Intent>,
327    /// The dispatcher sets this to the appropriate
328    /// [`IntentSource`](crate::telemetry::IntentSource) before
329    /// invoking a typed handler (menu select → `Menu`, AccessKit
330    /// action → `Accessibility`, on_tap / button activation →
331    /// `Handler`, …). `send_intent` reads it and stamps the intent
332    /// before queuing. `None` outside a managed handler — bare
333    /// programmatic sends keep their `Intent::source` value
334    /// (default `Programmatic`).
335    pub(crate) current_source: Option<crate::telemetry::IntentSource>,
336    /// Key-capture callback armed via `ctx.begin_key_capture(...)`.
337    /// The callback + its shared slot are installed on the tree by
338    /// `collect_from_ctx`. Only one per ctx; the last caller wins.
339    pub(crate) pending_key_capture: Option<crate::shortcut::KeyCaptureSlot>,
340    /// Set to request cancellation of any armed key capture.
341    pub(crate) cancel_key_capture: bool,
342    /// Deferred mutations to the tree's [`ShortcutRegistry`](crate::shortcut::ShortcutRegistry),
343    /// typically issued by settings-UI buttons to rebind or clear
344    /// overrides. Applied in `collect_from_ctx` after the handler
345    /// returns.
346    pub(crate) pending_shortcut_mutations: Vec<ShortcutMutation>,
347    /// Requests that the app-level event loop close the window this
348    /// tree belongs to. Drained after dispatch via
349    /// `WidgetTree::take_close_window_request`. Routed through the
350    /// window's close guard (if any) — see
351    /// [`WindowConfig::on_close_requested`](crate::window::WindowConfig::on_close_requested).
352    pub(crate) close_window_requested: bool,
353    /// Like [`close_window_requested`](Self::close_window_requested), but
354    /// **bypasses** the window's close guard. Set by
355    /// [`close_window_forced`](Self::close_window_forced). Drained after
356    /// dispatch via `WidgetTree::take_force_close_request`. The escape
357    /// hatch a confirmation dialog uses once the user confirms.
358    pub(crate) force_close_requested: bool,
359    /// Set by [`request_accessibility_update`](EventContext::request_accessibility_update);
360    /// drained in `collect_from_ctx` to set `WidgetTree::a11y_dirty`, forcing the
361    /// next `sync_accessibility` to re-walk the AccessKit tree. The general lever for a
362    /// composing widget that restructured its subtree in a way that changes the AT tree
363    /// (relayout alone no longer re-walks AT).
364    pub(crate) request_a11y_update: bool,
365    /// Set by [`request_soft_keyboard`](EventContext::request_soft_keyboard);
366    /// drained in `collect_from_ctx` onto the tree, from where the app layer
367    /// takes it once per dispatch — after the IME-allowance reconcile, which
368    /// is the only place that knows whether re-asserting would cancel a live
369    /// composition.
370    pub(crate) soft_keyboard_request: Option<bool>,
371    /// Messages queued by [`announce`](EventContext::announce) /
372    /// [`announce_with`](EventContext::announce_with), drained into the tree's
373    /// own live regions by `collect_from_ctx`. See [`crate::announcer`].
374    pub(crate) announcements: Vec<(String, crate::announcer::Politeness)>,
375    /// Layout direction (LTR/RTL) of the hosting tree, snapshotted at
376    /// handler-invocation time by `make_event_context`. Read via
377    /// [`is_rtl`](EventContext::is_rtl) so pointer / keyboard / drag
378    /// handlers can mirror their x-axis logic live — a runtime locale
379    /// switch dirties the tree but does **not** rebuild, so direction
380    /// must be read here rather than captured at `build()` time.
381    /// Defaults to `LeftToRight` for hand-constructed (test) contexts.
382    pub(crate) layout_direction: crate::environment::LayoutDirection,
383    /// What the tree knows about the sample being dispatched: which pointer
384    /// produced it, where it was, and — for a scroll — its phase and source.
385    /// Snapshotted by `make_event_context` from the tree's in-flight sample.
386    /// Holds its default (a mouse at the epoch) for hand-constructed contexts
387    /// and for handlers run outside a pointer dispatch (a timer, an
388    /// accessibility action).
389    pub(crate) input: crate::pointer::InputSnapshot,
390    /// The frozen [`TouchAction`] for the gesture being handled. Populated by
391    /// `make_event_context` from the pressed pointer's sequence; defaults to
392    /// [`TouchAction::AUTO`] for a hand-constructed context and for a handler
393    /// running outside a press — see
394    /// [`touch_action`](EventContext::touch_action) and
395    /// `crate::pointer::touch_action`.
396    pub(crate) touch_action: TouchAction,
397    /// The framework press held by the pointer being dispatched, as the router
398    /// tracks it: `(inside, pending)`. `None` when that pointer holds no press
399    /// — every handler outside a press, and every hand-constructed context.
400    /// Read by [`is_pressed`](EventContext::is_pressed) and its two siblings.
401    pub(crate) press: Option<(bool, bool)>,
402    /// Debug-only WCAG 3.2.1 guard: `Some(flag)` where `flag` is set while a
403    /// focus-change dispatch is running. `open_window` / `focus_window` warn if
404    /// invoked while it reads `true` (a focus handler changing context). `None`
405    /// for hand-constructed (test) contexts.
406    pub(crate) in_focus_dispatch: Option<std::rc::Rc<std::cell::Cell<bool>>>,
407    /// What asked for the context menu whose factory this context is serving.
408    /// Set by `show_context_menu_for` only; `None` everywhere else. Read by
409    /// [`context_menu_trigger`](EventContext::context_menu_trigger).
410    pub(crate) context_menu_trigger: Option<crate::widget_builder::ContextMenuTrigger>,
411}
412
413/// One arbitration act a handler performed on its pointer's sequence.
414///
415/// Queued on the context and applied in order by
416/// `WidgetTree::collect_from_ctx`, so a handler that claims and then rejects
417/// leaves the sequence in the state its last word describes.
418#[derive(Debug, Clone, Copy, PartialEq, Eq)]
419pub(crate) enum GestureAct {
420    /// [`EventContext::claim_gesture`].
421    Claim,
422    /// [`EventContext::reject_gesture`].
423    Reject,
424    /// [`EventContext::hold_gesture`].
425    Hold,
426    /// [`EventContext::release_gesture`].
427    Release,
428}
429
430/// Deferred edit to the tree's shortcut registry, queued on an
431/// `EventContext` and applied in `collect_from_ctx`.
432#[derive(Debug, Clone)]
433pub(crate) enum ShortcutMutation {
434    RebindPrimary {
435        id: String,
436        keystroke: Option<crate::shortcut::KeyStroke>,
437    },
438    RebindSecondary {
439        id: String,
440        keystroke: Option<crate::shortcut::KeyStroke>,
441    },
442    ClearOverride {
443        id: String,
444    },
445}
446
447/// A structural change to the widget tree, deferred until after event dispatch.
448pub(crate) enum TreeMutation {
449    SetDormant(WidgetId),
450    Activate(WidgetId),
451    Destroy(WidgetId),
452    /// Typed mutable access to a mounted widget, applied in
453    /// `apply_tree_mutations` where `&mut arena` is live. The boxed closure
454    /// downcasts the node's `as_any_mut()` to the requested concrete type;
455    /// `dirty` selects the post-mutation re-render level.
456    WithWidgetMut {
457        id: WidgetId,
458        dirty: crate::binding::BindingLevel,
459        apply: Box<dyn FnOnce(&mut dyn std::any::Any)>,
460    },
461    /// Re-run one widget's `build()` **now**, inside `apply_tree_mutations`,
462    /// rather than marking it for the next layout pass. See
463    /// [`EventContext::materialize_now`].
464    MaterializeNow(WidgetId),
465    /// `Space` on a data view's focused row: run the keyboard-toggle action
466    /// published inside `row`, or `fallback` when the row publishes none.
467    ///
468    /// Deferred rather than resolved in the handler because finding the action
469    /// means walking the row's subtree, and `EventContext` is a command buffer
470    /// with no view of the arena. Carrying the fallback keeps the decision in
471    /// one place: whether a row has a checkbox is a fact about the tree, not
472    /// something the key handler can know.
473    RowSpaceActivate {
474        row: WidgetId,
475        fallback: std::rc::Rc<dyn Fn(&mut EventContext)>,
476    },
477}
478
479// Manual `Debug`: the `WithWidgetMut` closure is not `Debug`.
480impl std::fmt::Debug for TreeMutation {
481    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
482        match self {
483            Self::SetDormant(id) => f.debug_tuple("SetDormant").field(id).finish(),
484            Self::Activate(id) => f.debug_tuple("Activate").field(id).finish(),
485            Self::MaterializeNow(id) => f.debug_tuple("MaterializeNow").field(id).finish(),
486            Self::Destroy(id) => f.debug_tuple("Destroy").field(id).finish(),
487            Self::WithWidgetMut { id, dirty, .. } => f
488                .debug_struct("WithWidgetMut")
489                .field("id", id)
490                .field("dirty", dirty)
491                .finish_non_exhaustive(),
492            Self::RowSpaceActivate { row, .. } => f
493                .debug_struct("RowSpaceActivate")
494                .field("row", row)
495                .finish_non_exhaustive(),
496        }
497    }
498}
499
500impl<'ops> EventContext<'ops> {
501    pub(crate) fn new() -> Self {
502        Self {
503            cursor_request: None,
504            declared_cursor_request: None,
505            tree_mutations: Vec::new(),
506            idle_callbacks: Vec::new(),
507            modal_requests: Vec::new(),
508            dismiss_modal: false,
509            overlay_requests: Vec::new(),
510            overlay_dismissals: Vec::new(),
511            overlay_content_dismissals: Vec::new(),
512            overlay_band_requests: Vec::new(),
513            overlay_placement_updates: Vec::new(),
514            overlay_pause_requests: Vec::new(),
515            dismiss_scope: None,
516            pointer_capture: None,
517            pointer_captor: None,
518            dispatch_node: None,
519            dispatch_target: None,
520            delayed_overlay_requests: Vec::new(),
521            timed_overlay_requests: Vec::new(),
522            reveal_overlay_requests: Vec::new(),
523            dismiss_descendant_overlays: Vec::new(),
524            cancel_delayed_overlays: Vec::new(),
525            safe_region_arm_requests: Vec::new(),
526            repaint_requests: Vec::new(),
527            synthetic_clicks: Vec::new(),
528            focus_requests: Vec::new(),
529            focus_into_requests: Vec::new(),
530            scroll_into_view_requests: Vec::new(),
531            scroll_widget_into_view_requests: Vec::new(),
532            highlight_tooltip_requests: Vec::new(),
533            drag_start_request: None,
534            cancel_drag: false,
535            drag_is_external: false,
536            theme_request: None,
537            follow_system_request: false,
538            locale_request: None,
539            text_scale_request: None,
540            frame_requested: false,
541            app_context: None,
542            pending_intents: Vec::new(),
543            current_source: None,
544            pending_key_capture: None,
545            cancel_key_capture: false,
546            pending_shortcut_mutations: Vec::new(),
547            close_window_requested: false,
548            force_close_requested: false,
549            request_a11y_update: false,
550            soft_keyboard_request: None,
551            announcements: Vec::new(),
552            window_ops: None,
553            current_window: None,
554            tree_window_active: true,
555            tree_pointer_position: None,
556            press_claimed_by_interactive_child: false,
557            overlay_bounds_snapshot: Vec::new(),
558            focused_widget: None,
559            layout_direction: crate::environment::LayoutDirection::LeftToRight,
560            input: crate::pointer::InputSnapshot::default(),
561            touch_action: TouchAction::AUTO,
562            press: None,
563            in_focus_dispatch: None,
564            context_menu_trigger: None,
565            explicit_capture: false,
566            recognized_owning_gesture: false,
567            drag_activation_override: None,
568            gesture_acts: Vec::new(),
569            cancel_pointer_request: None,
570        }
571    }
572
573    /// Record the [`TouchAction`] frozen at press for the sequence owning the
574    /// pointer being dispatched. Called by `make_event_context`.
575    pub(crate) fn with_touch_action(mut self, action: TouchAction) -> Self {
576        self.touch_action = action;
577        self
578    }
579
580    /// Record the framework press held by the pointer being dispatched, as
581    /// `(inside, pending)`. Called by `make_event_context`.
582    pub(crate) fn with_press(mut self, press: Option<(bool, bool)>) -> Self {
583        self.press = press;
584        self
585    }
586
587    /// Whether the pointer being dispatched holds a press whose visual is
588    /// showing — inside its tap boundary and past any press-feedback delay.
589    ///
590    /// The framework already drives the pressed node's own
591    /// [`pressed_signal`](crate::BuildContext::pressed_signal) from the same
592    /// state; this is for a handler that has to *branch* on the press rather
593    /// than paint it. `false` outside a press.
594    pub fn is_pressed(&self) -> bool {
595        matches!(self.press, Some((true, false)))
596    }
597
598    /// Whether the pointer being dispatched holds a press that has not left
599    /// its tap boundary. Unlike [`is_pressed`](Self::is_pressed) this is still
600    /// true during the press-feedback delay: the press is real, only its
601    /// visual is being withheld.
602    pub fn press_is_inside(&self) -> bool {
603        matches!(self.press, Some((true, _)))
604    }
605
606    /// Whether the pointer being dispatched holds a press whose feedback delay
607    /// has not elapsed — the press is inside a pan claimant and the framework
608    /// is waiting to see whether it becomes a scroll.
609    pub fn press_pending(&self) -> bool {
610        matches!(self.press, Some((_, true)))
611    }
612
613    /// Record what the tree knows about the sample being dispatched. Called by
614    /// `make_event_context` once per event batch.
615    pub(crate) fn with_input_snapshot(mut self, input: crate::pointer::InputSnapshot) -> Self {
616        self.input = input;
617        self
618    }
619
620    /// Record who holds the capture of the pointer being dispatched, so
621    /// [`owns_pointer`](Self::owns_pointer) can answer without a tree lookup.
622    pub(crate) fn with_pointer_captor(mut self, captor: Option<WidgetId>) -> Self {
623        self.pointer_captor = captor;
624        self
625    }
626
627    /// Record the node the arena picked for this event — the *target*, which is
628    /// not in general the node whose handler is running (a preview fires on
629    /// every strict ancestor of it).
630    pub(crate) fn with_dispatch_target(mut self, target: WidgetId) -> Self {
631        self.dispatch_target = Some(target);
632        self
633    }
634
635    /// Record which node's handler is about to run.
636    pub(crate) fn with_dispatch_node(mut self, node: WidgetId) -> Self {
637        self.dispatch_node = Some(node);
638        self
639    }
640
641    /// What asked for the context menu, inside a
642    /// [`ContextMenuFactory`](crate::widget_builder::ContextMenuFactory); `None`
643    /// in any other handler.
644    ///
645    /// The factory's point is where the user pointed only for
646    /// [`Pointer`](crate::widget_builder::ContextMenuTrigger::Pointer). A menu
647    /// the keyboard or an assistive technology asked for is anchored on the
648    /// widget it is about, so a factory that moves a caret or picks an item
649    /// from the point does that for a pointer alone.
650    pub fn context_menu_trigger(&self) -> Option<crate::widget_builder::ContextMenuTrigger> {
651        self.context_menu_trigger
652    }
653
654    /// The pointer that produced the event being handled.
655    ///
656    /// Two dispatches have a pointer without having a sample, and both report
657    /// it: a gesture the timer recognised — a hold — reports the **contact that
658    /// held**, and a drag-and-drop handler (`on_drag_hover` / `on_drag_tick` /
659    /// `on_drag_leave` / `on_drop`) reports the pointer **that started the
660    /// drag**, which is what makes it right inside a tick fired from a layout
661    /// pass or an OS drag phase delivered from a platform thread. Outside any
662    /// pointer, scroll, gesture or drag dispatch — an assistive-technology
663    /// action, a hand-constructed test context — this is the mouse at the tree
664    /// epoch, which is the same answer every such handler got before pointers
665    /// were distinguishable.
666    pub fn pointer(&self) -> crate::pointer::PointerInfo {
667        self.input.pointer
668    }
669
670    /// What kind of device is pointing: mouse, finger, stylus.
671    ///
672    /// The one question most handlers actually need — it is what decides
673    /// whether a hover affordance is reachable, whether a target needs slop,
674    /// and which gesture profile governs.
675    pub fn pointer_kind(&self) -> teksilo_tokens::PointerKind {
676        self.input.pointer.kind
677    }
678
679    /// Where the pointer was, in window-logical coordinates, when the event
680    /// being handled was produced.
681    ///
682    /// `None` for an event that carries no position — a keyboard-driven
683    /// scroll, a wheel notch (which routes by hover rather than by position),
684    /// anything dispatched outside a pointer sample. Distinct from
685    /// [`tree_pointer_position`](Self::tree_pointer_position), which reports
686    /// where the pointer is *at this instant* regardless of what is being
687    /// dispatched.
688    pub fn pointer_position(&self) -> Option<teksilo_canvas::Point> {
689        self.input.position
690    }
691
692    /// The positions the OS batched into the packet being dispatched, oldest
693    /// first and **excluding** the packet's own
694    /// ([`pointer_position`](Self::pointer_position), which is the newest).
695    ///
696    /// A backend whose device outruns the window's message rate hands over one
697    /// sample per *message* and puts the intermediate positions here, each with
698    /// the [`PointerAxes`](crate::pointer::PointerAxes) it was sampled at and
699    /// its own [`EventTime`](crate::pointer::EventTime). A surface that must
700    /// see every position a stylus produced — an ink tool is the case this
701    /// exists for — iterates these and *then* handles
702    /// [`pointer_position`](Self::pointer_position), and is correct whether or
703    /// not the backend batches, because a backend that does not returns an
704    /// empty slice.
705    ///
706    /// **Window**-logical coordinates, like
707    /// [`WidgetEvent::Scroll`](crate::event::WidgetEvent::Scroll)'s `window_position` and
708    /// for the same reason: a batch has no single widget to localise against.
709    /// A handler working in its own space converts at the use site.
710    ///
711    /// Empty on every dispatch that is not a pointer sample — a gesture the
712    /// timer recognised, a drag-and-drop tick, an assistive-technology action.
713    /// Those batched nothing, and reporting whichever sample arrived last would
714    /// attribute its positions to a gesture that did not produce them.
715    pub fn coalesced(&self) -> &[crate::pointer::CoalescedSample] {
716        &self.input.coalesced
717    }
718
719    /// Where in a continuous scroll gesture the event being handled sits.
720    ///
721    /// [`ScrollPhase::Discrete`](crate::pointer::ScrollPhase::Discrete) — a
722    /// self-contained wheel notch — for everything that is not a phased
723    /// gesture, which is every scroll Teksilo produced before the touch
724    /// programme.
725    pub fn scroll_phase(&self) -> crate::pointer::ScrollPhase {
726        self.input.scroll_phase
727    }
728
729    /// What produced the scroll being handled: a notched wheel, a precision
730    /// trackpad, a synthesised touch pan, or the app itself.
731    pub fn scroll_source(&self) -> crate::pointer::ScrollSource {
732        self.input.scroll_source
733    }
734
735    /// The [`TouchAction`] governing the gesture being handled.
736    ///
737    /// The value is **frozen at press** for the whole gesture's lifetime: the
738    /// router computes it once, from `WidgetTree::effective_touch_action` of
739    /// the pressed target, and stores it on that pointer's
740    /// [`PointerSequence`](crate::gesture::PointerSequence), so a handler never
741    /// re-reads a subtree that may have rebuilt mid-gesture.
742    ///
743    /// [`TouchAction::AUTO`] — the neutral value — outside a press, and for a
744    /// hand-constructed context. A mouse never consults this at all. See
745    /// `crate::pointer::touch_action`.
746    pub fn touch_action(&self) -> TouchAction {
747        self.touch_action
748    }
749
750    /// Snapshot the hosting tree's layout direction. Called by
751    /// `make_event_context` once per event batch so x-axis handlers
752    /// (resize, drag-reorder, arrow-key navigation) can mirror under
753    /// RTL without a rebuild.
754    pub(crate) fn with_layout_direction(
755        mut self,
756        direction: crate::environment::LayoutDirection,
757    ) -> Self {
758        self.layout_direction = direction;
759        self
760    }
761
762    /// Layout direction of the hosting tree at dispatch time.
763    pub fn layout_direction(&self) -> crate::environment::LayoutDirection {
764        self.layout_direction
765    }
766
767    /// Whether the hosting tree is laid out right-to-left. Mirrors
768    /// [`LayoutContext::is_rtl`](crate::widget::LayoutContext::is_rtl)
769    /// for the event-dispatch side.
770    pub fn is_rtl(&self) -> bool {
771        self.layout_direction == crate::environment::LayoutDirection::RightToLeft
772    }
773
774    /// The widget that held focus when this event batch began.
775    ///
776    /// A snapshot, not a live read: it answers what the tree's focus was at
777    /// dispatch time, so a handler that has already called
778    /// [`request_focus`](EventContext::request_focus) still sees the old
779    /// value. That is the useful reading for a handler deciding *whether* to
780    /// act on the focused widget.
781    ///
782    /// `None` when nothing is focused, and also for an `EventContext` built
783    /// outside `WidgetTree::make_event_context`, which is what a hand-made
784    /// test context is. Treat it as `None`-safe, like the other snapshots.
785    ///
786    /// The reason this exists: a widget-scoped shortcut fires before the
787    /// focused widget sees the key, so a container that binds a key which its
788    /// own children also handle has no other way to yield to them.
789    /// `MessageBox` is the case that asked for it, where Enter is bound to the
790    /// default button and must not answer for the button the user has actually
791    /// tabbed to.
792    pub fn focused(&self) -> Option<WidgetId> {
793        self.focused_widget
794    }
795
796    /// Attach a per-dispatch snapshot of read-only tree query state
797    /// (current pointer position, overlay bounds, focus). Called by
798    /// `WidgetTree::make_event_context` once per event batch. Test
799    /// `EventContext`s that don't go through that path stay with
800    /// empty snapshots — handlers must treat every read as `None`-
801    /// safe.
802    pub(crate) fn with_query_snapshot(
803        mut self,
804        pointer: Option<teksilo_canvas::Point>,
805        overlays: Vec<(
806            WidgetId,
807            teksilo_canvas::Rect,
808            Option<teksilo_canvas::Point>,
809        )>,
810        focused: Option<WidgetId>,
811    ) -> Self {
812        self.tree_pointer_position = pointer;
813        self.overlay_bounds_snapshot = overlays;
814        self.focused_widget = focused;
815        self
816    }
817
818    /// Attach the app-level window-ops sink and the hosting tree's
819    /// [`WindowState`](crate::window::WindowState). Called by the
820    /// dispatcher once per event batch so handlers can reach the
821    /// multi-window API synchronously.
822    pub(crate) fn with_window_context(
823        mut self,
824        ops: &'ops mut dyn crate::window::WindowOps,
825        current_window: Option<crate::window::WindowState>,
826    ) -> Self {
827        self.window_ops = Some(ops);
828        self.current_window = current_window;
829        self
830    }
831
832    /// Snapshot the tree's occlusion-aware window-active state. Called by
833    /// `make_event_context` once per event batch so handlers can read
834    /// [`window_active`](Self::window_active).
835    pub(crate) fn with_window_active(mut self, active: bool) -> Self {
836        self.tree_window_active = active;
837        self
838    }
839
840    /// Attach the tree's shared "inside focus dispatch" flag (WCAG 3.2.1
841    /// debug guard). See [`EventContext::open_window`].
842    pub(crate) fn with_focus_dispatch_flag(
843        mut self,
844        flag: std::rc::Rc<std::cell::Cell<bool>>,
845    ) -> Self {
846        self.in_focus_dispatch = Some(flag);
847        self
848    }
849
850    /// Debug-only: warn (once per call) if a context change is being made from
851    /// inside a focus-change dispatch — a WCAG 3.2.1 (On Focus) anti-pattern.
852    /// Compiled out entirely in release builds.
853    #[inline]
854    fn warn_if_context_change_in_focus_dispatch(&self, what: &str) {
855        #[cfg(debug_assertions)]
856        if self.in_focus_dispatch.as_ref().is_some_and(|f| f.get()) {
857            eprintln!(
858                "[teksilo a11y] WCAG 3.2.1 (On Focus): `{what}` was called from \
859                 inside an on_focus handler. Changing context (opening/focusing a \
860                 window, navigating) merely because a control received focus \
861                 surprises keyboard users tabbing through the UI. Move this to an \
862                 explicit activation handler (on_tap / on_activate / a shortcut)."
863            );
864        }
865        let _ = what;
866    }
867
868    /// Attach the tree's app-state registry so handlers can look up
869    /// application-scoped values (`ClipboardHandle`, `SharedTypesetter`,
870    /// …). Called by the dispatcher once per event batch.
871    pub(crate) fn with_app_context(
872        mut self,
873        ctx: std::rc::Rc<crate::event_source::TreeAppContext>,
874    ) -> Self {
875        self.app_context = Some(ctx);
876        self
877    }
878
879    /// Record whether the drag session active while this context is live
880    /// originated from an external (OS) drag. Set by `make_event_context`.
881    pub(crate) fn with_drag_external(mut self, is_external: bool) -> Self {
882        self.drag_is_external = is_external;
883        self
884    }
885
886    /// Whether a drag is currently in flight that was started by an external
887    /// (OS) drag-and-drop (files / text / URLs from another application),
888    /// rather than by an in-app `start_drag`. Useful in `on_drag_leave` /
889    /// `on_drag_tick` handlers, which don't receive the payload directly;
890    /// in `on_drag_hover` / `on_drop` prefer `payload.is_external()`.
891    pub fn drag_is_external(&self) -> bool {
892        self.drag_is_external
893    }
894
895    /// Look up an application-scoped value by type. Mirrors
896    /// `BuildContext::app_state`. Returns `None` when the handler was
897    /// invoked without a registry (hand-constructed `EventContext` in
898    /// tests, or when no value of that type was registered).
899    pub fn app_state<T: 'static>(&self) -> Option<&T> {
900        self.app_context
901            .as_ref()
902            .and_then(|ctx| ctx.app_state::<T>())
903    }
904
905    /// Borrow the [`AppEventPoster`](crate::AppEventPoster) installed
906    /// by the framework. Used by integrations that need to post
907    /// typed payloads back to the UI loop from a worker thread
908    /// (`teksilo_platform::file_dialog`'s `RfdAsyncBackend`, future
909    /// async-result features). Returns `None` for hand-constructed
910    /// `EventContext`s in tests.
911    pub fn poster(&self) -> Option<&std::sync::Arc<dyn crate::AppEventPoster>> {
912        self.app_context.as_ref().and_then(|ctx| ctx.poster())
913    }
914
915    /// Ask the tree to pump one more frame after this handler returns.
916    /// Use from event handlers that kick off per-frame work (pending
917    /// document events to drain, drag-select auto-scroll, caret blink
918    /// restart on focus). See `WidgetTree::request_frame` for the
919    /// draw-when-needed contract.
920    pub fn request_frame(&mut self) {
921        self.frame_requested = true;
922    }
923
924    /// Dispatch an [`Intent`](crate::intent::Intent) as if the source
925    /// widget pressed its keyboard shortcut. The framework walks
926    /// source-widget → root after the current handler returns,
927    /// invoking any matching [`Action`](crate::action::Action) it
928    /// finds. Unmatched intents are silently dropped.
929    ///
930    /// The intent's `source` is overridden by the dispatcher's
931    /// current handler-source label (`current_source`) when one is
932    /// active. This is how the framework distinguishes
933    /// `IntentSource::Handler` (button taps, generic on_tap) from
934    /// `IntentSource::Menu`, `IntentSource::Accessibility`, etc.
935    /// Programmatic callers outside any handler pass through with
936    /// `IntentSource::Programmatic` (the default).
937    pub fn send_intent(&mut self, intent: impl Into<crate::intent::Intent>) {
938        let mut intent: crate::intent::Intent = intent.into();
939        if let Some(src) = self.current_source {
940            intent.source = src;
941        }
942        self.pending_intents.push(intent);
943    }
944
945    /// Run a closure with the given `IntentSource` active. Any
946    /// `ctx.send_intent(...)` issued from within the closure will
947    /// be tagged with this source instead of the dispatcher's
948    /// default (`Handler` / `Shortcut` / `Accessibility`).
949    ///
950    /// The previous source is restored after the closure returns.
951    /// Panic during the closure unwinds the dispatcher's whole
952    /// frame, so the EventContext is destroyed before the next
953    /// dispatch — no need for a panic-safe drop guard.
954    ///
955    /// Used by framework widgets that want a more specific source
956    /// label than the default — `MenuItem` wraps its activation
957    /// handler to emit `IntentSource::Menu`, etc.
958    pub fn with_intent_source<R>(
959        &mut self,
960        source: crate::telemetry::IntentSource,
961        f: impl FnOnce(&mut Self) -> R,
962    ) -> R {
963        let prev = self.current_source.replace(source);
964        let r = f(self);
965        self.current_source = prev;
966        r
967    }
968
969    /// Arm a one-shot key-capture callback, returning a
970    /// [`CaptureHandle`](crate::shortcut::CaptureHandle) whose `Drop`
971    /// cancels the capture if it hasn't fired yet. The next `KeyDown`
972    /// bypasses shortcut resolution and invokes the callback with:
973    /// - the captured [`KeyStroke`](crate::shortcut::KeyStroke)
974    /// - mutable access to the registry (rebinds in-place)
975    /// - a mutable [`EventContext`] (emit commands, send intents,
976    ///   dismiss overlays, …)
977    ///
978    /// The handle must be stored somewhere with an appropriate
979    /// lifetime (typically in the calling widget's state) or the
980    /// capture will be cancelled immediately when the returned
981    /// handle drops at end of scope.
982    pub fn begin_key_capture(
983        &mut self,
984        callback: impl FnOnce(
985            crate::shortcut::KeyStroke,
986            &mut crate::shortcut::ShortcutRegistry,
987            &mut EventContext,
988        ) + 'static,
989    ) -> crate::shortcut::CaptureHandle {
990        let slot: crate::shortcut::KeyCaptureSlot =
991            std::rc::Rc::new(std::cell::RefCell::new(Some(Box::new(callback))));
992        self.pending_key_capture = Some(slot.clone());
993        self.cancel_key_capture = false;
994        crate::shortcut::CaptureHandle::new(slot)
995    }
996
997    /// Cancel any key capture armed earlier in this handler or via
998    /// `WidgetTree::begin_key_capture` before the handler ran.
999    pub fn cancel_key_capture(&mut self) {
1000        self.pending_key_capture = None;
1001        self.cancel_key_capture = true;
1002    }
1003
1004    /// Queue a deferred rebind of the primary keystroke for the
1005    /// registered shortcut with the given id. Applied by the tree
1006    /// after the current handler returns. Use `None` to explicitly
1007    /// unbind the slot.
1008    pub fn rebind_shortcut_primary(
1009        &mut self,
1010        id: impl Into<String>,
1011        keystroke: Option<crate::shortcut::KeyStroke>,
1012    ) {
1013        self.pending_shortcut_mutations
1014            .push(ShortcutMutation::RebindPrimary {
1015                id: id.into(),
1016                keystroke,
1017            });
1018    }
1019
1020    /// Queue a deferred rebind of the secondary keystroke for the
1021    /// registered shortcut with the given id.
1022    pub fn rebind_shortcut_secondary(
1023        &mut self,
1024        id: impl Into<String>,
1025        keystroke: Option<crate::shortcut::KeyStroke>,
1026    ) {
1027        self.pending_shortcut_mutations
1028            .push(ShortcutMutation::RebindSecondary {
1029                id: id.into(),
1030                keystroke,
1031            });
1032    }
1033
1034    /// Queue a deferred clear of any user override for the given
1035    /// shortcut id, restoring its declared defaults.
1036    pub fn clear_shortcut_override(&mut self, id: impl Into<String>) {
1037        self.pending_shortcut_mutations
1038            .push(ShortcutMutation::ClearOverride { id: id.into() });
1039    }
1040
1041    /// Request that the application close the window this tree
1042    /// belongs to. Drained by the app event loop after the handler
1043    /// returns. Typical use: title-bar close button handlers.
1044    ///
1045    /// This is a *guarded* close: if the window declared a close guard
1046    /// via
1047    /// [`WindowConfig::on_close_requested`](crate::window::WindowConfig::on_close_requested)
1048    /// or [`can_close`](crate::window::WindowConfig::can_close), that
1049    /// guard runs first and may veto the close. To skip the guard (e.g.
1050    /// from the confirmation dialog the guard itself opened), use
1051    /// [`close_window_forced`](Self::close_window_forced).
1052    pub fn close_window(&mut self) {
1053        self.close_window_requested = true;
1054    }
1055
1056    /// Request that the application close this tree's window
1057    /// **unconditionally**, bypassing any close guard declared via
1058    /// [`WindowConfig::on_close_requested`](crate::window::WindowConfig::on_close_requested)
1059    /// / [`can_close`](crate::window::WindowConfig::can_close).
1060    ///
1061    /// This is the second half of the veto-then-reissue pattern: the
1062    /// guard returns [`CloseResponse::Veto`](crate::window::CloseResponse::Veto)
1063    /// and opens a confirmation dialog; the dialog's "close anyway"
1064    /// button calls `close_window_forced` so the window actually closes
1065    /// without re-triggering the guard.
1066    pub fn close_window_forced(&mut self) {
1067        self.force_close_requested = true;
1068    }
1069
1070    // -------------------- Multi-window API --------------------
1071
1072    /// Cursor position at the moment this handler was invoked. `None`
1073    /// when no `PointerMove` has reached the tree yet, or when the
1074    /// context was constructed without a tree-side snapshot (e.g.
1075    /// hand-built `EventContext`s in tests). Used by the safe-triangle
1076    /// submenu hover gate.
1077    pub fn tree_pointer_position(&self) -> Option<teksilo_canvas::Point> {
1078        self.tree_pointer_position
1079    }
1080
1081    /// True when the in-flight pointer press's hit target is a strict
1082    /// descendant of THIS handler's widget that carries its own tap gesture
1083    /// (chevron, checkbox, inline button). A row/container that selects on
1084    /// press should early-return `EventResponse::Ignored` when this is set, so
1085    /// the press belongs to the inner control, not the row. Only meaningful
1086    /// inside `on_pointer_event` handlers for `PointerDown`/`PointerUp`.
1087    pub fn press_claimed_by_interactive_child(&self) -> bool {
1088        self.press_claimed_by_interactive_child
1089    }
1090
1091    /// The node this dispatch is **addressed to** — the innermost node the
1092    /// arena's hit walk accepted for this pointer sample, with
1093    /// [`hit_transparent`](crate::widget_builder::HandlerSet::hit_transparent),
1094    /// [`Widget::hit_shape`](crate::widget::Widget::hit_shape),
1095    /// [`Widget::accepts_child_hit`](crate::widget::Widget::accepts_child_hit)
1096    /// and `event_pass_through` all already applied.
1097    ///
1098    /// The point of it is the **preview** pass. `on_pointer_event` fires on
1099    /// every strict ancestor of the target during preview and on the target
1100    /// itself during the bubble, so an ancestor handler cannot otherwise tell
1101    /// "a descendant won the walk" from "I am the one that was hit". A widget
1102    /// that owns a second picking system over the same area needs exactly that
1103    /// distinction, to know whether to yield: comparing this against its own id
1104    /// reads the arena's verdict instead of re-deriving it from a rectangle,
1105    /// which is what keeps the two pickers from answering in different orders.
1106    ///
1107    /// `None` for a context made outside pointer dispatch (a gesture timer, a
1108    /// key-capture callback, an async completion). Treat `None` as "no verdict
1109    /// available", not as "not the target".
1110    pub fn dispatch_target(&self) -> Option<WidgetId> {
1111        self.dispatch_target
1112    }
1113
1114    /// Look up the bounds rect of an open overlay by its root content
1115    /// widget id. Returns `None` when no such overlay is currently
1116    /// active. The snapshot is taken once per dispatch; mid-handler
1117    /// `show_overlay` calls will not appear here. Used by the
1118    /// safe-triangle submenu hover gate.
1119    pub fn overlay_bounds_for_content(&self, content_id: WidgetId) -> Option<teksilo_canvas::Rect> {
1120        self.overlay_bounds_snapshot
1121            .iter()
1122            .find(|(cid, _, _)| *cid == content_id)
1123            .map(|(_, r, _)| *r)
1124    }
1125
1126    /// Whether a safe-triangle traversal toward the overlay rooted at
1127    /// `content_id` is still live — i.e. whether the user may still be on
1128    /// their way to that submenu.
1129    ///
1130    /// A widget whose hover would otherwise tear the overlay down (a
1131    /// sibling menu row switching the selection) asks this first and
1132    /// stands aside while it is `true`, leaving the dismissal to the
1133    /// overlay's own pointer-leave grace — which tests the cone on every
1134    /// sample and closes the overlay one `delay` after the pointer stops
1135    /// heading there.
1136    ///
1137    /// **This is deliberately the armed window, not a point-in-cone
1138    /// test.** A sibling row's hover fires exactly once, at the instant
1139    /// the pointer crosses onto it — a pixel or two from the apex, where
1140    /// the cone is a needle — so answering "is this one sample inside the
1141    /// cone" made a single quantized step final, and any departure
1142    /// steeper than the cone (which is most of them, for a wide menu with
1143    /// a short submenu) killed the submenu the moment the pointer left
1144    /// the trigger row. Whether *this* sample is inside the cone is the
1145    /// framework's question, asked continuously; the widget's question is
1146    /// only whether to get out of the way.
1147    ///
1148    /// `false` when no region is armed and when its budget is spent.
1149    ///
1150    /// Arm the region with
1151    /// [`arm_overlay_safe_region`](Self::arm_overlay_safe_region).
1152    pub fn overlay_safe_region_armed(&self, content_id: WidgetId) -> bool {
1153        self.overlay_bounds_snapshot
1154            .iter()
1155            .find(|(cid, _, _)| *cid == content_id)
1156            .is_some_and(|(_, _, apex)| apex.is_some())
1157    }
1158
1159    pub fn window(&self) -> Option<&crate::window::WindowState> {
1160        self.current_window.as_ref()
1161    }
1162
1163    /// Whether the host window is currently active (`focused AND not
1164    /// occluded`) — the occlusion-aware companion to
1165    /// `self.window().map(|w| w.focused())` (raw OS focus). Snapshotted at
1166    /// context construction. Matches [`BuildContext::window_active`].
1167    ///
1168    /// [`BuildContext::window_active`]: crate::build_context::BuildContext::window_active
1169    pub fn window_active(&self) -> bool {
1170        self.tree_window_active
1171    }
1172
1173    /// Open a new window, creating the winit-level surface
1174    /// synchronously. The returned id is immediately valid for
1175    /// [`focus_window`](Self::focus_window),
1176    /// [`window_state`](Self::window_state), and
1177    /// [`find_window`](Self::find_window).
1178    ///
1179    /// Panics when called from a handler on a standalone `WidgetTree`
1180    /// (no app context) — tests should not invoke this method.
1181    pub fn open_window(
1182        &mut self,
1183        config: crate::window::WindowConfig,
1184    ) -> crate::window::TeksiloWindowId {
1185        self.warn_if_context_change_in_focus_dispatch("open_window");
1186        self.window_ops
1187            .as_deref_mut()
1188            .expect("open_window called outside of a dispatch")
1189            .open_window(config)
1190    }
1191
1192    /// Find a window by the string id assigned via
1193    /// [`WindowConfig::id`](crate::window::WindowConfig::id). Returns
1194    /// `None` if no open window carries that id.
1195    pub fn find_window(&self, string_id: &str) -> Option<crate::window::TeksiloWindowId> {
1196        self.window_ops.as_deref()?.find_window(string_id)
1197    }
1198
1199    /// Read the [`WindowState`](crate::window::WindowState) for a
1200    /// specific window.
1201    pub fn window_state(
1202        &self,
1203        id: crate::window::TeksiloWindowId,
1204    ) -> Option<crate::window::WindowState> {
1205        self.window_ops.as_deref()?.window_state(id)
1206    }
1207
1208    /// Snapshot of every live window's state.
1209    pub fn windows(&self) -> Vec<crate::window::WindowState> {
1210        self.window_ops
1211            .as_deref()
1212            .map(|o| o.windows())
1213            .unwrap_or_default()
1214    }
1215
1216    /// Raise a window to the front and give it keyboard focus.
1217    pub fn focus_window(&mut self, id: crate::window::TeksiloWindowId) {
1218        self.warn_if_context_change_in_focus_dispatch("focus_window");
1219        if let Some(ops) = self.window_ops.as_deref_mut() {
1220            ops.focus_window(id);
1221        }
1222    }
1223
1224    /// Request an xdg-activation token for `id` (see
1225    /// [`WindowOps::request_activation_token`](crate::window::WindowOps::request_activation_token)).
1226    /// `cb` fires once with the token string, or `None` where the platform can't
1227    /// provide one — used to hand a token to a child process ("open in new
1228    /// window") or an IPC peer that will raise itself on Wayland.
1229    pub fn request_activation_token(
1230        &mut self,
1231        id: crate::window::TeksiloWindowId,
1232        cb: Box<dyn FnOnce(Option<String>)>,
1233    ) {
1234        if let Some(ops) = self.window_ops.as_deref_mut() {
1235            ops.request_activation_token(id, cb);
1236        } else {
1237            cb(None);
1238        }
1239    }
1240
1241    /// Request an activation token for the **current** window (see
1242    /// [`WindowOps::request_activation_token_self`](crate::window::WindowOps::request_activation_token_self)).
1243    /// Use this from a widget handler to mint a token from *this* focused window
1244    /// to hand to another window or process — it works mid-dispatch, unlike the
1245    /// id-based variant.
1246    pub fn request_activation_token_self(&mut self, cb: Box<dyn FnOnce(Option<String>)>) {
1247        if let Some(ops) = self.window_ops.as_deref_mut() {
1248            ops.request_activation_token_self(cb);
1249        } else {
1250            cb(None);
1251        }
1252    }
1253
1254    /// Close a specific window by id. Equivalent to
1255    /// [`close_window`](Self::close_window) when `id` is the current
1256    /// window's id.
1257    pub fn close_window_by_id(&mut self, id: crate::window::TeksiloWindowId) {
1258        if let Some(ops) = self.window_ops.as_deref_mut() {
1259            ops.close_window_by_id(id);
1260        }
1261    }
1262
1263    /// Report the focused text widget's caret rectangle (window-logical
1264    /// pixels) so the platform can position the OS IME candidate window at
1265    /// the insertion point. Text-editing widgets call this whenever the
1266    /// caret moves. No-op outside a dispatch / on a standalone tree.
1267    pub fn set_ime_cursor_area(&mut self, area: teksilo_canvas::Rect) {
1268        if let Some(ops) = self.window_ops.as_deref_mut() {
1269            ops.set_ime_cursor_area(area);
1270        }
1271    }
1272
1273    /// Resolve the platform parent handle of the window currently
1274    /// dispatching the event. Used by native-dialog integrations
1275    /// (`teksilo_platform::file_dialog`) to parent OS dialogs to the
1276    /// originating Teksilo window.
1277    ///
1278    /// Returns `None` when called from a standalone `WidgetTree` (no
1279    /// app-level `WindowOps` sink), or when the platform refuses to
1280    /// surface a handle (rare; mostly during teardown).
1281    pub fn parent_window_handle(&self) -> Option<crate::raw_handle::ParentHandle> {
1282        self.window_ops.as_deref()?.current_parent_handle()
1283    }
1284
1285    /// Request a cursor icon change.
1286    ///
1287    /// This is an **override**: it outranks the cursor the hovered node
1288    /// declared with [`WidgetBuilder::cursor`], and it outlives the dispatch
1289    /// that set it. The tree's cursor moves only when something writes to it,
1290    /// and the node-declared cursor is written on `PointerEnter` /
1291    /// `PointerLeave` alone — so a handler that sets a cursor while the
1292    /// pointer is inside a node owns the cursor until the pointer leaves that
1293    /// node, or until the handler gives it back with
1294    /// [`release_cursor`](Self::release_cursor).
1295    ///
1296    /// [`WidgetBuilder::cursor`]: crate::widget_builder::WidgetBuilder::cursor
1297    pub fn set_cursor(&mut self, cursor: CursorIcon) {
1298        self.cursor_request = Some(CursorRequest::Set(cursor));
1299    }
1300
1301    /// Withdraw this handler's cursor override, so the cursor the hovered
1302    /// node declared applies again.
1303    ///
1304    /// The cursor counterpart of returning [`EventResponse::Ignored`]: it says
1305    /// "I have nothing to say about the cursor", which is *not* the same as
1306    /// saying [`CursorIcon::Default`] and not the same as staying silent.
1307    ///
1308    /// Silence is only safe for a handler that has never spoken. A handler
1309    /// which re-decides the cursor on every move — a scene arbitrating a
1310    /// lightweight item's cursor against the card underneath it, a chart's
1311    /// overlay marks, a terminal's link layer — reaches points where it has no
1312    /// answer while the pointer is still inside the same node. No hover
1313    /// transition fires there, so nothing re-applies the node's declared
1314    /// cursor, and going quiet leaves the handler's *last* word standing. This
1315    /// is how it takes that word back.
1316    ///
1317    /// Restores exactly what the `PointerEnter` walk resolved for the current
1318    /// hover chain (or [`CursorIcon::Default`] if that chain declared none),
1319    /// so it can never disagree with the declared-cursor mechanism it defers
1320    /// to. Calling it when nothing was overridden is a no-op.
1321    ///
1322    /// [`EventResponse::Ignored`]: crate::event::EventResponse::Ignored
1323    pub fn release_cursor(&mut self) {
1324        self.cursor_request = Some(CursorRequest::Release);
1325    }
1326
1327    /// Set a widget subtree as dormant (preserves state, releases rendering).
1328    pub fn set_dormant(&mut self, id: WidgetId) {
1329        self.tree_mutations.push(TreeMutation::SetDormant(id));
1330    }
1331
1332    /// Activate a dormant widget subtree.
1333    pub fn activate(&mut self, id: WidgetId) {
1334        self.tree_mutations.push(TreeMutation::Activate(id));
1335    }
1336
1337    /// Destroy a widget subtree (removes from arena entirely, state is gone).
1338    pub fn destroy(&mut self, id: WidgetId) {
1339        self.tree_mutations.push(TreeMutation::Destroy(id));
1340    }
1341
1342    /// Imperatively mutate a mounted widget by id, downcasting to the
1343    /// concrete type `W`.
1344    ///
1345    /// The mutation is **deferred**: the closure runs after the handler
1346    /// returns, inside `apply_tree_mutations`, where the framework holds
1347    /// `&mut` arena access (a handler cannot re-borrow the arena to reach
1348    /// another node, so this is the only safe channel — the same model as
1349    /// [`destroy`](Self::destroy)). After the closure runs, the target is
1350    /// dirty-marked at `dirty` so the mutation takes visual effect.
1351    ///
1352    /// The target widget must override `Widget::as_any_mut` to return
1353    /// `Some(self)`. If the id is gone or is not a `W`, the closure is a
1354    /// no-op in release and a `debug_assert` failure in debug — it never
1355    /// silently mutates the wrong widget.
1356    ///
1357    /// Use it for per-view state a handler can't otherwise reach — e.g.
1358    /// `SceneView::ensure_visible(...)` (camera) after the view is mounted:
1359    /// ```ignore
1360    /// ctx.with_widget_mut::<SceneView>(view_id, BindingLevel::Relayout, |v| {
1361    ///     v.ensure_visible(card_rect, 40.0);
1362    /// });
1363    /// ```
1364    /// For scene *content*, prefer the shared `SceneModel` handle (`view.model()`)
1365    /// — its mutators are `&self`, so a handler holding a clone can drive the
1366    /// scene directly and every attached view reconciles, no `with_widget_mut`
1367    /// needed.
1368    pub fn with_widget_mut<W: 'static>(
1369        &mut self,
1370        id: WidgetId,
1371        dirty: crate::binding::BindingLevel,
1372        f: impl FnOnce(&mut W) + 'static,
1373    ) {
1374        self.tree_mutations.push(TreeMutation::WithWidgetMut {
1375            id,
1376            dirty,
1377            apply: Box::new(move |any| match any.downcast_mut::<W>() {
1378                Some(w) => f(w),
1379                None => debug_assert!(
1380                    false,
1381                    "with_widget_mut: widget {id:?} is not the requested type (or does not \
1382                     override Widget::as_any_mut)"
1383                ),
1384            }),
1385        });
1386    }
1387
1388    /// Re-run one widget's `build()` **during this handler's drain**, before
1389    /// overlays are shown and before focus requests are applied — rather than
1390    /// dirty-marking it for the next layout pass, which is what every other
1391    /// rebuild trigger does.
1392    ///
1393    /// It exists for one shape:
1394    /// [`DeferredSubtree`](crate::deferred_subtree::DeferredSubtree) content
1395    /// that a handler is *about to depend on*. Opening a popover activates its
1396    /// content, shows an overlay anchored to it, and moves focus into it — all
1397    /// three inside the same drain (see `collect_from_ctx`). A deferred panel
1398    /// marked for rebuild would not exist yet at any of those points: the
1399    /// overlay would be measured against an empty node and
1400    /// `first_focusable_descendant` would find nothing to focus, so the popover
1401    /// would open in the wrong place and swallow the keyboard. Materializing
1402    /// here closes that window, and makes deferred content behave exactly like
1403    /// the eagerly-built content it replaces.
1404    ///
1405    /// Cheap to call redundantly: a `DeferredSubtree` that is already
1406    /// materialized returns its existing child, so a second open costs one
1407    /// `build()` of the host and nothing below it.
1408    ///
1409    /// Not a general "rebuild this widget now" door — reach for
1410    /// [`with_widget_mut`](Self::with_widget_mut) or a `Rebuild` binding for
1411    /// ordinary reactive updates, which are correctly served by the next
1412    /// layout pass.
1413    /// `Space` on a data view's focused row: activate the row's published
1414    /// keyboard toggle — the checkbox `StandardListItem` embeds, most often —
1415    /// or run `fallback` when the row publishes none.
1416    ///
1417    /// A row's controls are out of the Tab order, so this is the only keyboard
1418    /// route to them; `fallback` is what `Space` means on a row without one,
1419    /// which for the data views is "toggle the selection".
1420    pub fn row_space_activate(
1421        &mut self,
1422        row: WidgetId,
1423        fallback: std::rc::Rc<dyn Fn(&mut EventContext)>,
1424    ) {
1425        self.tree_mutations
1426            .push(TreeMutation::RowSpaceActivate { row, fallback });
1427    }
1428
1429    pub fn materialize_now(&mut self, id: WidgetId) {
1430        self.tree_mutations.push(TreeMutation::MaterializeNow(id));
1431    }
1432
1433    /// Request that the AccessKit tree be re-walked after this handler
1434    /// returns. Use after a mutation that changes the accessibility tree
1435    /// **shape** in a way the framework doesn't already detect (relayout
1436    /// alone no longer re-walks AT; only events that change the AT tree
1437    /// — focus, overlays, locale/shortcut rebinds — set the dirty flag).
1438    /// The companion `BuildContext::request_accessibility_update` covers
1439    /// the build-time path.
1440    pub fn request_accessibility_update(&mut self) {
1441        self.request_a11y_update = true;
1442    }
1443
1444    /// Ask the platform to raise its on-screen keyboard.
1445    ///
1446    /// For the case the desktop convention has no answer for: a *finger*
1447    /// landing in a text field, where there is no physical keyboard and no
1448    /// focus change the accessibility layer would notice on its own.
1449    ///
1450    /// The request is honoured **only where it can do no harm**. Where the
1451    /// platform's keyboard follows the framework's IME-allowance reconcile
1452    /// ([`SoftKeyboardSupport::ViaAccessibility`](crate::window::SoftKeyboardSupport::ViaAccessibility)),
1453    /// the request resolves to nothing — always, not merely while a composition
1454    /// happens to be live. That reconcile *is* the request, and the only thing
1455    /// an explicit ask could add is a re-assertion of IME allowance, which is
1456    /// what cancels a composition mid-word. Nothing on this path calls
1457    /// `set_ime_allowed`, and that is what makes placing a caret with a finger
1458    /// mid-composition safe. Where the framework has no keyboard request to
1459    /// send at all the request is dropped; ask
1460    /// [`soft_keyboard_support`](Self::soft_keyboard_support) first if the
1461    /// widget needs to offer a fallback.
1462    pub fn request_soft_keyboard(&mut self) {
1463        self.soft_keyboard_request = Some(true);
1464    }
1465
1466    /// Ask the platform to dismiss its on-screen keyboard.
1467    ///
1468    /// Only a platform reporting
1469    /// [`SoftKeyboardSupport::Explicit`](crate::window::SoftKeyboardSupport::Explicit)
1470    /// can honour this; elsewhere there is no dismiss request to send, and a
1471    /// keyboard that rose on the IME enable goes away on the matching disable
1472    /// when focus leaves the text surface.
1473    pub fn dismiss_soft_keyboard(&mut self) {
1474        self.soft_keyboard_request = Some(false);
1475    }
1476
1477    /// What the host platform can do about an on-screen keyboard.
1478    ///
1479    /// [`SoftKeyboardSupport::None`](crate::window::SoftKeyboardSupport::None)
1480    /// on a standalone tree and on every platform the framework has no keyboard
1481    /// request to send on — which, on the desktop, is most of them.
1482    pub fn soft_keyboard_support(&self) -> crate::window::SoftKeyboardSupport {
1483        self.window_ops
1484            .as_deref()
1485            .map(|ops| ops.soft_keyboard_support())
1486            .unwrap_or_default()
1487    }
1488
1489    /// Speak `message` to the screen reader, politely.
1490    ///
1491    /// For anything the user needs told that is not the name of a widget: a
1492    /// completed action, a new count, the result of an undo, a row that moved.
1493    /// Sighted users read those off the screen; a screen-reader user is told
1494    /// only what the framework says out loud.
1495    ///
1496    /// ```ignore
1497    /// ctx.announce(tr!(event_added(title = title.clone())));
1498    /// ```
1499    ///
1500    /// Takes `impl Into<String>`, so `tr!(…)` works directly.
1501    /// `LocalizedString` is deliberately not the parameter type: an
1502    /// announcement is an event, not a label, and
1503    /// re-resolving it on a later language switch would re-speak it. See
1504    /// [`crate::announcer`].
1505    ///
1506    /// **Do not pair this with a toast on the same path.** `Toast` is already a
1507    /// correct live region, so doing both says everything twice.
1508    pub fn announce(&mut self, message: impl Into<String>) {
1509        self.announce_with(message, crate::announcer::Politeness::Polite);
1510    }
1511
1512    /// Speak `message` to the screen reader at the given urgency.
1513    ///
1514    /// [`Politeness::Assertive`](crate::announcer::Politeness::Assertive)
1515    /// interrupts whatever is being spoken. Reserve it for something the user
1516    /// must not miss and cannot recover by re-reading the screen — a failure, a
1517    /// refusal, a destructive result. Everything else is
1518    /// [`Polite`](crate::announcer::Politeness::Polite), which is what
1519    /// [`announce`](Self::announce) uses.
1520    pub fn announce_with(
1521        &mut self,
1522        message: impl Into<String>,
1523        politeness: crate::announcer::Politeness,
1524    ) {
1525        self.announcements.push((message.into(), politeness));
1526    }
1527
1528    /// Show an overlay (tooltip, menu, popover).
1529    pub fn show_overlay(&mut self, request: crate::overlay::OverlayRequest) {
1530        self.overlay_requests.push(request);
1531    }
1532
1533    /// Show an overlay in an explicit z-band.
1534    ///
1535    /// [`show_overlay`](Self::show_overlay) is this with
1536    /// [`Standard`](crate::overlay::OverlayBand::Standard). The other band is
1537    /// for the touch text affordances, which must render above the editor's
1538    /// `clips_children` ancestor, below every menu, and outside the
1539    /// outside-press dismissal that every caret-moving tap would otherwise
1540    /// trigger. Their lifetime is the controller's — see
1541    /// [`TouchSelection::dismiss`](crate::text_touch::TouchSelection::dismiss).
1542    ///
1543    /// Showing content that is already up is a no-op, so a host may call this
1544    /// on every raise without tracking whether it has.
1545    pub fn show_overlay_in_band(
1546        &mut self,
1547        request: crate::overlay::OverlayRequest,
1548        band: crate::overlay::OverlayBand,
1549    ) {
1550        self.overlay_band_requests.push((request, band));
1551    }
1552
1553    /// Re-place the currently-shown overlay whose content root is `content_id`.
1554    ///
1555    /// Content-keyed for the same reason
1556    /// [`dismiss_overlay_by_content`](Self::dismiss_overlay_by_content) is:
1557    /// [`show_overlay`](Self::show_overlay) returns nothing, so a handler
1558    /// cannot learn the [`OverlayId`](crate::overlay::OverlayId) it created. A
1559    /// no-op when no overlay is showing that content.
1560    pub fn update_overlay_placement_by_content(
1561        &mut self,
1562        content_id: crate::widget_id::WidgetId,
1563        placement: crate::overlay::OverlayPlacement,
1564    ) {
1565        self.overlay_placement_updates.push((content_id, placement));
1566    }
1567
1568    /// Show an overlay whose reveal/dismiss is animated by a
1569    /// caller-owned progress signal.
1570    ///
1571    /// `progress` must be an animated `Signal<f32>` (created with
1572    /// [`Signal::new_animated`](crate::signal::Signal::new_animated) or
1573    /// [`BuildContext::animated_signal`](crate::build_context::BuildContext::animated_signal)).
1574    /// The framework shows the overlay, tweens `progress` 0 → 1 over
1575    /// `duration`, and on any dismiss path tweens it 1 → 0 while
1576    /// **deferring** the overlay's removal (and its content's dormancy)
1577    /// until the roll-back completes — the same window the fade path
1578    /// uses, but with no opacity applied. The caller binds `progress`
1579    /// to whatever paints the reveal (e.g. an
1580    /// [`Unroll`](https://docs.rs/teksilo) width), and is responsible for
1581    /// resetting it to `0.0` before the show if a prior reveal left it
1582    /// at `1.0`.
1583    ///
1584    /// Under `prefers-reduced-motion`, skip this and use
1585    /// [`show_overlay`](Self::show_overlay) with the progress pinned at
1586    /// `1.0` so there is no tween and dismissal is immediate.
1587    pub fn show_overlay_with_reveal(
1588        &mut self,
1589        request: crate::overlay::OverlayRequest,
1590        progress: crate::signal::Signal<f32>,
1591        duration: std::time::Duration,
1592    ) {
1593        self.reveal_overlay_requests
1594            .push((request, progress, duration));
1595    }
1596
1597    /// Show an overlay that dismisses automatically after `duration`.
1598    pub fn show_overlay_for(
1599        &mut self,
1600        request: crate::overlay::OverlayRequest,
1601        duration: std::time::Duration,
1602    ) {
1603        self.timed_overlay_requests.push((request, duration));
1604    }
1605
1606    /// Dismiss an overlay by ID.
1607    pub fn dismiss_overlay(&mut self, id: crate::overlay::OverlayId) {
1608        self.overlay_dismissals.push(id);
1609    }
1610
1611    /// Dismiss the currently-shown overlay whose content root is
1612    /// `content_id`, if one is active. No-op when no overlay is showing
1613    /// that content. Use this to dismiss an overlay you can only name by
1614    /// its content widget — the symmetric companion to
1615    /// [`cancel_delayed_overlay`](Self::cancel_delayed_overlay), which
1616    /// cancels a *pending* delayed show for the same content. Together
1617    /// they let a caller fully retract a reusable tooltip surface
1618    /// (shown or pending) without tracking the `OverlayId`.
1619    pub fn dismiss_overlay_by_content(&mut self, content_id: crate::widget_id::WidgetId) {
1620        self.overlay_content_dismissals.push(content_id);
1621    }
1622
1623    /// Queue a request to pause an overlay's `auto_dismiss_after`
1624    /// timer. Drained by the framework after this handler returns —
1625    /// equivalent to calling
1626    /// [`OverlayManager::pause_auto_dismiss`](crate::overlay::OverlayManager::pause_auto_dismiss)
1627    /// at the next safe point. Idempotent.
1628    ///
1629    /// Used by `ToastHost` for hover-pause: on pointer-enter the
1630    /// host queues `pause_overlay_auto_dismiss(id)` for every live
1631    /// toast; on pointer-leave it queues `resume_overlay_auto_dismiss`.
1632    pub fn pause_overlay_auto_dismiss(&mut self, id: crate::overlay::OverlayId) {
1633        self.overlay_pause_requests.push((id, true));
1634    }
1635
1636    /// Queue a request to resume an overlay's `auto_dismiss_after`
1637    /// timer paused via
1638    /// [`pause_overlay_auto_dismiss`](Self::pause_overlay_auto_dismiss).
1639    /// Idempotent on un-paused overlays.
1640    pub fn resume_overlay_auto_dismiss(&mut self, id: crate::overlay::OverlayId) {
1641        self.overlay_pause_requests.push((id, false));
1642    }
1643
1644    /// Dismiss all active overlays (e.g., after a menu item is activated).
1645    pub fn dismiss_all_overlays(&mut self) {
1646        self.dismiss_scope = Some(DismissScope::All);
1647    }
1648
1649    /// Dismiss the source widget's containing overlay and any ancestor
1650    /// overlays in the chain that are menu-like (anything that isn't a
1651    /// `Role::Tooltip`, `Role::Dialog`, or `Role::AlertDialog`),
1652    /// preserving an outer composite tooltip or modal hosting the
1653    /// popover. Use for menu / dropdown item activation that wants to
1654    /// close the menu cascade without disturbing the host surface.
1655    pub fn dismiss_self_overlay_chain(&mut self) {
1656        self.dismiss_scope = Some(DismissScope::SelfChain);
1657    }
1658
1659    /// Dismiss every overlay whose content is *not* a host surface
1660    /// (`Role::Tooltip`, `Role::Dialog`, `Role::AlertDialog`),
1661    /// preserving an outer composite tooltip or modal hosting the
1662    /// trigger. Use for popover triggers and pre-show cleanup that
1663    /// want to close stale popovers / menus without taking a hosting
1664    /// surface with them.
1665    pub fn dismiss_all_except_hosts(&mut self) {
1666        self.dismiss_scope = Some(DismissScope::AllExceptHosts);
1667    }
1668
1669    /// Dismiss the topmost overlay only (e.g., closing a submenu while
1670    /// keeping the parent menu open).
1671    pub fn dismiss_top_overlay(&mut self) {
1672        self.dismiss_scope = Some(DismissScope::Top);
1673    }
1674
1675    /// Dismiss descendant overlays of the source widget's containing overlay.
1676    /// Useful for closing sibling submenu branches while keeping the current
1677    /// parent menu open.
1678    pub fn dismiss_child_overlays(&mut self) {
1679        self.dismiss_descendant_overlays.push(None);
1680    }
1681
1682    /// Dismiss descendant overlays of the source widget's containing overlay,
1683    /// preserving the subtree rooted at `content_id` if it is already open.
1684    pub fn dismiss_child_overlays_except(&mut self, content_id: crate::widget_id::WidgetId) {
1685        self.dismiss_descendant_overlays.push(Some(content_id));
1686    }
1687
1688    /// Request an idle callback to be run during the next idle period.
1689    /// Use this for incremental work that takes 5-50ms — too short for a
1690    /// background thread, too long for a single frame.
1691    pub fn request_idle_callback(
1692        &mut self,
1693        callback: impl FnOnce(crate::idle::IdleDeadline) + 'static,
1694    ) {
1695        self.idle_callbacks.push(Box::new(callback));
1696    }
1697
1698    /// Request framework-owned modal presentation.
1699    ///
1700    /// The widget tree records the request together with the originating
1701    /// widget, and the application layer can later resolve `Auto` into a
1702    /// concrete presentation backend.
1703    pub fn present_modal(&mut self, request: crate::modal::ModalRequest) {
1704        self.modal_requests.push(request);
1705    }
1706
1707    /// Synchronously open a modal as a native window — the single
1708    /// unified path for native-window modals. Callers that don't
1709    /// care whether the modal lands in-tree or in a native window
1710    /// use [`present_modal`](Self::present_modal), which routes
1711    /// `ModalPresentation::Auto` through the framework's picker.
1712    ///
1713    /// Returns the new window's id, or `None` when called outside a
1714    /// dispatch context (standalone trees). The window's parent is
1715    /// the current window; focus target and title / size from the
1716    /// request are honored.
1717    ///
1718    /// Only `ModalContent::Deferred` is supported here — an
1719    /// `ExistingWidget` id wouldn't make sense in a fresh tree.
1720    pub fn open_modal(
1721        &mut self,
1722        request: crate::modal::ModalRequest,
1723    ) -> Option<crate::window::TeksiloWindowId> {
1724        let parent = self.current_window.as_ref()?.id();
1725        let crate::modal::ModalContent::Deferred(builder) = request.content else {
1726            return None;
1727        };
1728        let mut config = crate::window::WindowConfig::new().modal(crate::window::ModalConfig {
1729            parent,
1730            focus_target: request.focus_target,
1731        });
1732        if let Some(title) = request.title {
1733            config = config.title(title);
1734        }
1735        if let Some((w, h)) = request.size {
1736            config = config.size(w, h);
1737        }
1738        let config = config.root(move |tree, _state| builder(tree));
1739        Some(self.open_window(config))
1740    }
1741
1742    /// Dismiss the current framework-owned modal presentation.
1743    pub fn dismiss_modal(&mut self) {
1744        self.dismiss_modal = true;
1745    }
1746
1747    /// Show an overlay after a delay. The widget tree checks pending delayed
1748    /// overlays during `layout()` and shows them once the delay elapses.
1749    /// Use this for submenu hover-open delays.
1750    ///
1751    /// The content widget should already be added to the tree (typically
1752    /// dormant). It will be activated automatically when the delay elapses.
1753    pub fn show_overlay_after(
1754        &mut self,
1755        request: crate::overlay::OverlayRequest,
1756        delay: std::time::Duration,
1757    ) {
1758        self.delayed_overlay_requests
1759            .push((request, delay, None, false));
1760    }
1761
1762    /// Show an overlay after a delay and move focus when it opens.
1763    pub fn show_overlay_after_with_focus(
1764        &mut self,
1765        request: crate::overlay::OverlayRequest,
1766        delay: std::time::Duration,
1767        focus_target: crate::widget_id::WidgetId,
1768    ) {
1769        self.delayed_overlay_requests
1770            .push((request, delay, Some(focus_target), false));
1771    }
1772
1773    /// Show an overlay after a delay, move focus when it opens, and
1774    /// dismiss the anchor's sibling overlays **at that moment** rather
1775    /// than when the request was made.
1776    ///
1777    /// This is the hover-switch between two submenu triggers in the same
1778    /// menu. Dismissing eagerly at hover-enter closes the submenu the
1779    /// user is still walking toward as soon as the pointer crosses a
1780    /// neighbouring trigger; deferring the dismissal to the moment the
1781    /// new submenu actually opens means a pointer merely passing through
1782    /// costs nothing, and one that settles gets the swap on the same
1783    /// frame — no window with two submenus on screen.
1784    pub fn show_overlay_after_replacing_siblings(
1785        &mut self,
1786        request: crate::overlay::OverlayRequest,
1787        delay: std::time::Duration,
1788        focus_target: crate::widget_id::WidgetId,
1789    ) {
1790        self.delayed_overlay_requests
1791            .push((request, delay, Some(focus_target), true));
1792    }
1793
1794    /// Request a repaint on a specific widget. Use this when an event handler
1795    /// on one widget changes state that affects a different widget's appearance
1796    /// (e.g., keyboard navigation highlighting items in an overlay).
1797    pub fn request_repaint(&mut self, id: crate::widget_id::WidgetId) {
1798        self.repaint_requests.push(id);
1799    }
1800
1801    /// Programmatically click a widget (synthetic PointerDown + PointerUp at
1802    /// its center). Use this for keyboard activation of a child widget, e.g.,
1803    /// Enter on a keyboard-focused menu item.
1804    pub fn synthetic_click(&mut self, id: crate::widget_id::WidgetId) {
1805        self.synthetic_clicks.push(id);
1806    }
1807
1808    /// Transfer focus to a specific widget. Use this when opening overlay
1809    /// content (menus, dialogs) that should receive keyboard events.
1810    pub fn request_focus(&mut self, id: crate::widget_id::WidgetId) {
1811        self.focus_requests.push(id);
1812    }
1813
1814    /// Move focus **into** the content of `id`: focus its first focusable
1815    /// descendant in tab order. Unlike [`request_focus`](Self::request_focus),
1816    /// this does **not** fall back to focusing `id` itself when the subtree has
1817    /// no focusable descendant — it is a no-op in that case, so an empty region
1818    /// never traps focus on a non-interactive container.
1819    ///
1820    /// Use this for "dive into this region" gestures, e.g. pressing Enter on a
1821    /// focused tab header to move focus into the tab's content panel. A panel
1822    /// with focusable content lands on its first control; a panel that opted
1823    /// into focusability itself (no inner controls) lands on the panel; a bare
1824    /// panel with neither leaves focus where it was.
1825    pub fn request_focus_into(&mut self, id: crate::widget_id::WidgetId) {
1826        self.focus_into_requests.push(id);
1827    }
1828
1829    /// Scroll the given rectangle into view inside every enclosing scroll
1830    /// container, walking outward from the widget whose handler is running.
1831    ///
1832    /// `rect` is in **absolute tree (window) coordinates** — the same space
1833    /// the arena stores widget bounds in. After the handler returns, the
1834    /// framework walks the current widget's ancestors and, for each
1835    /// `clips_children` scroll container whose viewport does not already
1836    /// fully contain `rect`, dispatches
1837    /// [`WidgetEvent::ScrollIntoView`](crate::event::WidgetEvent::ScrollIntoView)
1838    /// so the container adjusts its offset. Nested scroll areas each get a
1839    /// turn (outermost included), exactly like the focus-driven path.
1840    ///
1841    /// Unlike the automatic focus follow — which can only reveal a *focused
1842    /// widget's own bounds* — this lets a widget reveal an arbitrary interior
1843    /// rectangle it computed itself: a text caret, a virtualized list/table
1844    /// row (which is not a distinct focusable node), or a scrolled-off tab
1845    /// header. The widget remains responsible for scrolling its *own* interior
1846    /// viewport; `ensure_visible` handles the enclosing containers. It is a
1847    /// no-op when there is no scroll container above the widget, or when every
1848    /// container already shows the rect.
1849    ///
1850    /// See [`ensure_visible_with_margin`](Self::ensure_visible_with_margin) to
1851    /// keep breathing room around the target.
1852    pub fn ensure_visible(&mut self, rect: teksilo_canvas::Rect) {
1853        self.scroll_into_view_requests.push(ScrollRevealRequest {
1854            rect,
1855            margin: 0.0,
1856            align: crate::event::ScrollAlign::Minimal,
1857            motion: crate::event::ScrollMotion::Instant,
1858            from: None,
1859        });
1860    }
1861
1862    /// [`ensure_visible`](Self::ensure_visible), for a rect that belongs to
1863    /// **another** widget.
1864    ///
1865    /// The framework walks `owner`'s ancestors rather than the handling widget's.
1866    /// That distinction is the whole of it, and getting it wrong fails silently:
1867    /// a find banner's Next button sits *beside* the scrolling page, not inside
1868    /// it, so a reveal walked from the button climbs out through the banner and
1869    /// never meets the scroll container the match is in. The match is selected,
1870    /// the counter moves, and the viewport does not follow.
1871    ///
1872    /// The same reasoning [`ensure_widget_visible`](Self::ensure_widget_visible)
1873    /// already records for the id-based form; this is its rect-based twin, for a
1874    /// target that is an interior span rather than a mounted child.
1875    ///
1876    /// `rect` is in absolute tree (window) coordinates.
1877    pub fn ensure_visible_from(
1878        &mut self,
1879        owner: crate::widget_id::WidgetId,
1880        rect: teksilo_canvas::Rect,
1881    ) {
1882        self.scroll_into_view_requests.push(ScrollRevealRequest {
1883            rect,
1884            margin: 0.0,
1885            align: crate::event::ScrollAlign::Minimal,
1886            motion: crate::event::ScrollMotion::Instant,
1887            from: Some(owner),
1888        });
1889    }
1890
1891    /// Like [`ensure_visible`](Self::ensure_visible), but keeps `margin`
1892    /// logical pixels of breathing room around `rect` on every edge, so the
1893    /// target does not sit flush against the viewport boundary (the caret at
1894    /// the bottom line, the selected row at the fold). `rect` is in absolute
1895    /// tree (window) coordinates.
1896    pub fn ensure_visible_with_margin(&mut self, rect: teksilo_canvas::Rect, margin: f32) {
1897        self.scroll_into_view_requests.push(ScrollRevealRequest {
1898            rect,
1899            margin: margin.max(0.0),
1900            align: crate::event::ScrollAlign::Minimal,
1901            motion: crate::event::ScrollMotion::Instant,
1902            from: None,
1903        });
1904    }
1905
1906    /// **Pin** `rect` at `fraction` of the way down the innermost enclosing
1907    /// scroll container — `0.0` flush with the top, `0.5` centred, `1.0` flush
1908    /// with the bottom — instead of merely revealing it.
1909    ///
1910    /// The difference from [`ensure_visible`](Self::ensure_visible) is that this
1911    /// scrolls **even when the target is already visible**. That is what makes
1912    /// it usable for typewriter scrolling: a caret that only moved the view once
1913    /// it fell off the edge would not be pinned to anything.
1914    ///
1915    /// Only the **innermost** scroll container aligns; any further ancestors
1916    /// out fall back to a minimal reveal, since an outer container's job is to
1917    /// bring the inner viewport on screen, not to align a rectangle it does not
1918    /// own. A clipping wrapper that does not scroll (a `MaxSize` capping the
1919    /// column, say) sits between them without taking the pin.
1920    ///
1921    /// `fraction` is clamped to `0.0..=1.0`. The container additionally clamps
1922    /// to its own scroll range, so a target near the start or end of the content
1923    /// lands as close to `fraction` as the range permits — see the scroll
1924    /// container's `scroll_past_end` for buying range past the content's end so
1925    /// the last line can still reach the pin.
1926    ///
1927    /// `rect` is in absolute tree (window) coordinates.
1928    pub fn ensure_visible_aligned(
1929        &mut self,
1930        rect: teksilo_canvas::Rect,
1931        fraction: f32,
1932        motion: crate::event::ScrollMotion,
1933    ) {
1934        self.scroll_into_view_requests.push(ScrollRevealRequest {
1935            rect,
1936            margin: 0.0,
1937            align: crate::event::ScrollAlign::Fraction(fraction.clamp(0.0, 1.0)),
1938            motion,
1939            from: None,
1940        });
1941    }
1942
1943    /// [`ensure_visible_aligned`](Self::ensure_visible_aligned), for a rect that
1944    /// belongs to **another** widget — see [`ensure_visible_from`](Self::ensure_visible_from)
1945    /// for why the distinction exists and how it fails when it is missed.
1946    pub fn ensure_visible_aligned_from(
1947        &mut self,
1948        owner: crate::widget_id::WidgetId,
1949        rect: teksilo_canvas::Rect,
1950        fraction: f32,
1951        motion: crate::event::ScrollMotion,
1952    ) {
1953        self.scroll_into_view_requests.push(ScrollRevealRequest {
1954            rect,
1955            margin: 0.0,
1956            align: crate::event::ScrollAlign::Fraction(fraction.clamp(0.0, 1.0)),
1957            motion,
1958            from: Some(owner),
1959        });
1960    }
1961
1962    /// Scroll a specific mounted widget into view inside every enclosing
1963    /// scroll container — the id-based companion to
1964    /// [`ensure_visible`](Self::ensure_visible).
1965    ///
1966    /// The framework resolves `id` to its current absolute bounds after the
1967    /// handler returns and walks *that widget's* ancestors (never `id`
1968    /// itself), dispatching
1969    /// [`WidgetEvent::ScrollIntoView`](crate::event::WidgetEvent::ScrollIntoView)
1970    /// to each `clips_children` container that doesn't already show it.
1971    ///
1972    /// Use this when the target you want revealed is a real, non-virtualized
1973    /// child whose bounds the arena already knows — a selected radio tile, a
1974    /// tab header — so you don't have to compute a rect. For a target that has
1975    /// no distinct node (a text caret) or that may not be realized (a
1976    /// virtualized list/table row), use [`ensure_visible`](Self::ensure_visible)
1977    /// with an analytic rect instead. No-op if `id` is not currently mounted.
1978    pub fn ensure_widget_visible(&mut self, id: crate::widget_id::WidgetId) {
1979        self.scroll_widget_into_view_requests.push((id, 0.0));
1980    }
1981
1982    /// Like [`ensure_widget_visible`](Self::ensure_widget_visible), but keeps
1983    /// `margin` logical pixels of breathing room around the widget.
1984    pub fn ensure_widget_visible_with_margin(
1985        &mut self,
1986        id: crate::widget_id::WidgetId,
1987        margin: f32,
1988    ) {
1989        self.scroll_widget_into_view_requests
1990            .push((id, margin.max(0.0)));
1991    }
1992
1993    /// Surface the tooltip of a keyboard-highlighted item immediately (no
1994    /// dwell), dismissing the previously-highlighted item's tooltip. Used by
1995    /// `MenuList` on arrow-key navigation so a menu item's rich/composite
1996    /// tooltip is reachable by keyboard — real focus stays on the menu panel,
1997    /// so this is keyed on the item id rather than on focus. Pass the item's
1998    /// own widget id; a tooltip-less item simply dismisses the previous one.
1999    pub fn show_highlight_tooltip(&mut self, id: crate::widget_id::WidgetId) {
2000        self.highlight_tooltip_requests.push(id);
2001    }
2002
2003    /// Cancel a pending delayed overlay by its content widget ID.
2004    /// Call this when the hover ends before the delay elapses.
2005    pub fn cancel_delayed_overlay(&mut self, content_id: crate::widget_id::WidgetId) {
2006        self.cancel_delayed_overlays.push(content_id);
2007    }
2008
2009    /// Arm the "safe triangle" of the open overlay rooted at
2010    /// `content_id`, with its apex at the current pointer position.
2011    ///
2012    /// Call this from the anchor's hover-leave handler: the pointer is
2013    /// then exactly at the point the diagonal toward the overlay
2014    /// starts. While the pointer sits inside the triangle spanned by
2015    /// that apex and the overlay's near edge, the overlay's
2016    /// pointer-leave grace is held off; leaving the triangle starts the
2017    /// grace and re-entering it cancels the grace again, so a wobble
2018    /// mid-diagonal costs nothing. Throughout — cone or no cone, until
2019    /// the pointer arrives or the framework's budget runs out —
2020    /// [`overlay_safe_region_armed`](Self::overlay_safe_region_armed)
2021    /// reports `true` so sibling widgets stand aside and let that one
2022    /// re-evaluated grace own the dismissal.
2023    ///
2024    /// No-ops when the overlay is not open (a submenu whose hover-open
2025    /// delay was cancelled before it ever showed) or when no pointer
2026    /// position is known.
2027    pub fn arm_overlay_safe_region(&mut self, content_id: crate::widget_id::WidgetId) {
2028        self.safe_region_arm_requests.push(content_id);
2029    }
2030
2031    /// Choose, **from this press's `PointerDown` handler**, when this node's own
2032    /// drag may begin — overriding its declared
2033    /// [`DragActivation`](teksilo_tokens::DragActivation) for this press alone.
2034    ///
2035    /// `.drag_activation(..)` is a node property, decided at build time. That is
2036    /// the right grain when a node's `on_drag` means one thing. It is the wrong
2037    /// grain when one handler means several: a scene viewport's single `on_drag`
2038    /// is its marquee *and* its item grab *and* its magnet port drag, and which
2039    /// of the three a press is cannot be known until the press has been
2040    /// hit-tested. This is the per-press door — the press handler has already
2041    /// done that hit test, so it can say "this one landed on an item, arm it
2042    /// immediately" while leaving an empty-space press to defer to the pan.
2043    ///
2044    /// Stashed on the pointer's sequence, **not** written back onto the node, so
2045    /// it dies with the press that chose it. That matters here more than
2046    /// hygiene usually does: `on_pointer_event` previews root-first over every
2047    /// strict ancestor of the press target, so a node that answers from it also
2048    /// answers for presses an interactive descendant owns, and a node write
2049    /// would leave the declaration changed for the *next* press.
2050    ///
2051    /// Read by the enrolment walk, which runs immediately after the press
2052    /// dispatch. Called from anything but a press handler it is inert for the
2053    /// press in flight — there is no enrolment left to read it — and applies to
2054    /// nothing else.
2055    ///
2056    /// Last writer wins: answering twice on one press means the second answer.
2057    pub fn set_drag_activation(&mut self, activation: teksilo_tokens::DragActivation) {
2058        self.drag_activation_override = Some(activation);
2059    }
2060
2061    /// Capture **the pointer this handler is serving**: its subsequent
2062    /// `PointerMove` and `PointerUp` are routed to this widget regardless of
2063    /// hit test, until the capture is released.
2064    ///
2065    /// Capture is per pointer. Two fingers pressing two widgets hold two
2066    /// independent captures, and each is released only by its own Up or
2067    /// Cancel — so a second contact lifting can no longer steal the first
2068    /// one's stream. A mouse call site is unaffected: there is one mouse, and
2069    /// this captures it.
2070    /// **Also an arbitration act.** Taking the pointer from an undecided
2071    /// [`PointerSequence`](crate::gesture::PointerSequence) enrols this widget
2072    /// as a [`MemberRole::RawDrag`](crate::gesture::MemberRole::RawDrag)
2073    /// competitor, and for a precise pointer with no eligible pan competitor
2074    /// it decides the sequence outright — which is what makes the splitter
2075    /// handle, the dock resize handle and the table column grip (all of which
2076    /// answer `Ignored` from `on_pointer_event` and work from `PointerMove`
2077    /// with no recognizer at all) first-class competitors rather than widgets
2078    /// the arbitration cannot see.
2079    pub fn capture_pointer(&mut self) {
2080        self.pointer_capture = Some((None, true));
2081        self.explicit_capture = true;
2082    }
2083
2084    /// Capture a *named* pointer, for a handler driving a pointer other than
2085    /// the one whose sample it is serving.
2086    pub fn capture_pointer_id(&mut self, pointer: crate::pointer::PointerId) {
2087        self.pointer_capture = Some((Some(pointer), true));
2088        self.explicit_capture = true;
2089    }
2090
2091    /// Capture the pointer as **framework plumbing**, without staking an
2092    /// arbitration claim.
2093    ///
2094    /// The gesture arena takes the pointer for the Down..Up window so a
2095    /// recognizer keeps seeing moves that leave the widget's bounds, and the
2096    /// drag pipeline takes it for the life of a drag. Neither is a widget
2097    /// saying "this press is mine"; routing them through the public
2098    /// [`capture_pointer`](Self::capture_pointer) would enrol every
2099    /// arena-bearing node as a `RawDrag` member and decide every mouse
2100    /// sequence at press.
2101    pub(crate) fn capture_pointer_implicit(&mut self) {
2102        self.pointer_capture = Some((None, true));
2103    }
2104
2105    /// Claim the pointer sequence for the widget whose handler is running:
2106    /// arbitration ends, every other competitor is cancelled.
2107    ///
2108    /// The explicit form of what a recognizer does when it recognizes. Use it
2109    /// from an application recognizer that decides by its own rules.
2110    pub fn claim_gesture(&mut self) {
2111        self.gesture_acts.push(GestureAct::Claim);
2112    }
2113
2114    /// Withdraw the widget whose handler is running from the sequence. It can
2115    /// no longer win this press; its peers carry on.
2116    pub fn reject_gesture(&mut self) {
2117        self.gesture_acts.push(GestureAct::Reject);
2118    }
2119
2120    /// Defer this widget's own decision without withdrawing: no peer may win
2121    /// while a member is holding.
2122    ///
2123    /// **The framework never holds.** This exists for an application
2124    /// recognizer awaiting an answer it does not have yet (a hit test against
2125    /// an off-thread model, a network round trip). The hold auto-releases at
2126    /// [`GestureProfile::max_hold`](teksilo_tokens::GestureProfile::max_hold)
2127    /// — 250 ms — so a holder that never answers cannot strand the press.
2128    pub fn hold_gesture(&mut self) {
2129        self.gesture_acts.push(GestureAct::Hold);
2130    }
2131
2132    /// End this widget's hold, putting it back in the running.
2133    pub fn release_gesture(&mut self) {
2134        self.gesture_acts.push(GestureAct::Release);
2135    }
2136
2137    /// Revoke the whole interaction of the pointer this handler is serving,
2138    /// for `reason`.
2139    ///
2140    /// The widget's own way into the cancel funnel, for a widget that knows
2141    /// the interaction can no longer mean anything — the document under a text
2142    /// drag was reloaded, the row being reordered was deleted by a peer. Every
2143    /// competitor is cancelled, the capture is given back, and a
2144    /// [`PointerCancel`](crate::event::WidgetEvent::PointerCancel) is
2145    /// delivered, all **after** this handler returns: a cancel taken inline
2146    /// would unwind the very sample the handler is standing on.
2147    ///
2148    /// Distinct from [`reject_gesture`](Self::reject_gesture), which withdraws
2149    /// only *this* widget and lets its peers carry on with a pointer that is
2150    /// still perfectly alive.
2151    pub fn cancel_pointer_sequence(&mut self, reason: crate::pointer::CancelReason) {
2152        self.cancel_pointer_request = Some(reason);
2153    }
2154
2155    /// Release the capture of the pointer this handler is serving. Its events
2156    /// resume normal hit-test dispatch.
2157    pub fn release_pointer(&mut self) {
2158        self.pointer_capture = Some((None, false));
2159    }
2160
2161    /// Whether the widget whose handler is running already holds the capture
2162    /// of the pointer it is serving.
2163    ///
2164    /// `true` also immediately after a [`capture_pointer`](Self::capture_pointer)
2165    /// in the same handler, even though the tree does not apply the request
2166    /// until the handler returns — asking "do I own this pointer?" after
2167    /// claiming it must not answer no.
2168    pub fn owns_pointer(&self) -> bool {
2169        match self.pointer_capture {
2170            Some((None, capture)) => capture,
2171            _ => self.dispatch_node.is_some() && self.dispatch_node == self.pointer_captor,
2172        }
2173    }
2174
2175    /// Start a drag-and-drop operation from the given source widget.
2176    ///
2177    /// The `payload` carries the data being dragged. During the drag:
2178    /// - `PointerMove` events update the drag position and fire `on_drag_hover`
2179    ///   on widgets under the pointer that have drop handlers
2180    /// - `PointerUp` fires `on_drop` on the target widget (if any)
2181    /// - `Escape` cancels the drag
2182    pub fn start_drag(
2183        &mut self,
2184        source_widget: crate::widget_id::WidgetId,
2185        payload: crate::drag_payload::DragPayload,
2186    ) {
2187        self.drag_start_request = Some((source_widget, payload, None));
2188    }
2189
2190    /// Start a drag-and-drop with a preview widget that follows the pointer.
2191    pub fn start_drag_with_preview(
2192        &mut self,
2193        source_widget: crate::widget_id::WidgetId,
2194        payload: crate::drag_payload::DragPayload,
2195        preview: Box<dyn crate::widget::Widget>,
2196    ) {
2197        self.drag_start_request = Some((source_widget, payload, Some(preview)));
2198    }
2199
2200    /// Cancel the active drag-and-drop session (if any).
2201    pub fn cancel_drag(&mut self) {
2202        self.cancel_drag = true;
2203    }
2204
2205    /// Replace the tree-level theme. All widgets are marked dirty for
2206    /// relayout and repaint; nothing is rebuilt (see
2207    /// `WidgetTree::set_theme`), so focus, scroll offsets and other
2208    /// interaction state survive.
2209    ///
2210    /// An explicit theme also turns **off** OS-following: the app's theme
2211    /// mode is reset to manual, so a later OS light/dark change won't
2212    /// override the chosen theme.
2213    pub fn set_theme(&mut self, theme: crate::styles::Theme) {
2214        self.theme_request = Some(theme);
2215    }
2216
2217    /// Switch the application to follow the OS theme (native / system mode):
2218    /// the app adopts the OS's colours and tracks OS light/dark changes at
2219    /// runtime. On platforms without OS-colour support it falls back to
2220    /// following the built-in light/dark presets.
2221    ///
2222    /// This is the counterpart to [`set_theme`](Self::set_theme): calling
2223    /// `set_theme` pins a fixed theme (manual mode), while this resumes
2224    /// OS-following. Parameterless by design, so widgets need not reference
2225    /// the app-layer theme-mode enum.
2226    pub fn follow_system_theme(&mut self) {
2227        self.follow_system_request = true;
2228    }
2229
2230    /// Replace the tree-level locale identifier. Composite widgets are
2231    /// rebuilt so any tr! lookups picked up at build time are re-evaluated
2232    /// against the new locale.
2233    pub fn set_locale(&mut self, locale: impl Into<String>) {
2234        self.locale_request = Some(locale.into());
2235    }
2236
2237    /// Set the user-controlled global text-scale factor (`1.0` = 100 %).
2238    ///
2239    /// The change is applied app-wide (every window) after the handler returns,
2240    /// mirroring [`set_theme`](Self::set_theme) / [`set_locale`](Self::set_locale).
2241    /// All text grows uniformly without a rebuild. Persist the value through
2242    /// `ctx.settings()` (e.g. `teksilo_settings::TEXT_SCALE_KEY`) so it survives
2243    /// a restart — the `TextScaleControl` widget does both for you.
2244    pub fn set_text_scale(&mut self, factor: f32) {
2245        self.text_scale_request = Some(factor);
2246    }
2247}
2248
2249#[cfg(test)]
2250mod multi_window_tests {
2251    use super::*;
2252    use crate::window::state::WindowStateInit;
2253    use crate::window::{
2254        NoopWindowOps, TeksiloWindowId, WindowConfig, WindowOps, WindowPlacement, WindowState,
2255    };
2256    use std::cell::RefCell;
2257    use std::rc::Rc;
2258
2259    /// Recording implementation of `WindowOps` so tests can assert
2260    /// that `EventContext` routes each method through the trait.
2261    #[derive(Default)]
2262    struct RecordingOps {
2263        open_calls: RefCell<Vec<WindowConfig>>,
2264        focus_calls: RefCell<Vec<TeksiloWindowId>>,
2265        close_calls: RefCell<Vec<TeksiloWindowId>>,
2266        next_id: RefCell<u64>,
2267        // A fake registry so `find_window` / `window_state` / `windows`
2268        // can return values.
2269        states: RefCell<Vec<WindowState>>,
2270    }
2271
2272    impl RecordingOps {
2273        fn alloc_id(&self) -> TeksiloWindowId {
2274            let mut n = self.next_id.borrow_mut();
2275            *n += 1;
2276            TeksiloWindowId::new(*n)
2277        }
2278    }
2279
2280    impl WindowOps for RecordingOps {
2281        fn open_window(&mut self, config: WindowConfig) -> TeksiloWindowId {
2282            let id = self.alloc_id();
2283            let state = WindowState::new(WindowStateInit {
2284                id,
2285                string_id: config.string_id.clone(),
2286                placement: config.initial_placement,
2287                title: config.title.clone(),
2288                size: config.size,
2289                position: config.position.unwrap_or((0, 0)),
2290                focused: true,
2291                resizable: config.resizable,
2292                always_on_top: config.always_on_top,
2293            });
2294            self.states.borrow_mut().push(state);
2295            self.open_calls.borrow_mut().push(config);
2296            id
2297        }
2298
2299        fn find_window(&self, string_id: &str) -> Option<TeksiloWindowId> {
2300            self.states
2301                .borrow()
2302                .iter()
2303                .find(|s| s.string_id() == Some(string_id))
2304                .map(|s| s.id())
2305        }
2306
2307        fn window_state(&self, id: TeksiloWindowId) -> Option<WindowState> {
2308            self.states.borrow().iter().find(|s| s.id() == id).cloned()
2309        }
2310
2311        fn windows(&self) -> Vec<WindowState> {
2312            self.states.borrow().clone()
2313        }
2314
2315        fn focus_window(&mut self, id: TeksiloWindowId) {
2316            self.focus_calls.borrow_mut().push(id);
2317        }
2318
2319        fn close_window_by_id(&mut self, id: TeksiloWindowId) {
2320            self.close_calls.borrow_mut().push(id);
2321        }
2322    }
2323
2324    fn make_state(id: u64, string_id: Option<&str>) -> WindowState {
2325        WindowState::new(WindowStateInit {
2326            id: TeksiloWindowId::new(id),
2327            string_id: string_id.map(String::from),
2328            placement: WindowPlacement::Floating,
2329            title: "Test".into(),
2330            size: (800, 600),
2331            position: (0, 0),
2332            focused: true,
2333            resizable: true,
2334            always_on_top: false,
2335        })
2336    }
2337
2338    #[test]
2339    fn window_returns_current_window_state() {
2340        let state = make_state(1, Some("main"));
2341        let mut noop = NoopWindowOps;
2342        let ctx = EventContext::new().with_window_context(&mut noop, Some(state.clone()));
2343        assert_eq!(ctx.window().unwrap().id(), TeksiloWindowId::new(1));
2344        assert_eq!(ctx.window().unwrap().string_id(), Some("main"));
2345    }
2346
2347    #[test]
2348    fn window_is_none_without_context() {
2349        let ctx = EventContext::new();
2350        assert!(ctx.window().is_none());
2351    }
2352
2353    #[test]
2354    fn open_window_routes_through_ops() {
2355        let mut ops = RecordingOps::default();
2356        let main_state = make_state(1, Some("main"));
2357        let returned_id = {
2358            let mut ctx = EventContext::new().with_window_context(&mut ops, Some(main_state));
2359            ctx.open_window(WindowConfig::new().id("help").title("Help"))
2360        };
2361        assert_eq!(ops.open_calls.borrow().len(), 1);
2362        assert_eq!(
2363            ops.open_calls.borrow()[0].string_id.as_deref(),
2364            Some("help")
2365        );
2366        // Recording ops allocates ids 2+; 1 was reserved for `main`
2367        // only in this test — Recording's counter starts from 0, so the
2368        // first alloc yields 1.
2369        assert_eq!(returned_id, TeksiloWindowId::new(1));
2370    }
2371
2372    #[test]
2373    fn find_window_routes_through_ops() {
2374        let mut ops = RecordingOps::default();
2375        ops.states.borrow_mut().push(make_state(7, Some("foo")));
2376        let main_state = make_state(1, Some("main"));
2377        let ctx = EventContext::new().with_window_context(&mut ops, Some(main_state));
2378        assert_eq!(ctx.find_window("foo"), Some(TeksiloWindowId::new(7)));
2379        assert!(ctx.find_window("missing").is_none());
2380    }
2381
2382    #[test]
2383    fn focus_window_records_via_ops() {
2384        let mut ops = RecordingOps::default();
2385        let main_state = make_state(1, None);
2386        {
2387            let mut ctx = EventContext::new().with_window_context(&mut ops, Some(main_state));
2388            ctx.focus_window(TeksiloWindowId::new(42));
2389        }
2390        assert_eq!(
2391            ops.focus_calls.borrow().as_slice(),
2392            &[TeksiloWindowId::new(42)]
2393        );
2394    }
2395
2396    #[test]
2397    fn close_window_by_id_records_via_ops() {
2398        let mut ops = RecordingOps::default();
2399        let main_state = make_state(1, None);
2400        {
2401            let mut ctx = EventContext::new().with_window_context(&mut ops, Some(main_state));
2402            ctx.close_window_by_id(TeksiloWindowId::new(9));
2403        }
2404        assert_eq!(
2405            ops.close_calls.borrow().as_slice(),
2406            &[TeksiloWindowId::new(9)]
2407        );
2408    }
2409
2410    #[test]
2411    fn close_window_sets_guarded_flag_only() {
2412        let mut ctx = EventContext::new();
2413        ctx.close_window();
2414        assert!(
2415            ctx.close_window_requested,
2416            "close_window must raise the guarded-close flag"
2417        );
2418        assert!(
2419            !ctx.force_close_requested,
2420            "close_window must NOT raise the forced-close flag"
2421        );
2422    }
2423
2424    #[test]
2425    fn close_window_forced_sets_force_flag_only() {
2426        let mut ctx = EventContext::new();
2427        ctx.close_window_forced();
2428        assert!(
2429            ctx.force_close_requested,
2430            "close_window_forced must raise the forced-close flag"
2431        );
2432        assert!(
2433            !ctx.close_window_requested,
2434            "close_window_forced must NOT raise the guarded-close flag"
2435        );
2436    }
2437
2438    /// End-to-end: a handler calling `close_window_forced` during
2439    /// dispatch must transfer the flag onto the `WidgetTree` (the
2440    /// `collect_from_ctx` teardown), where the app loop drains it via
2441    /// `take_force_close_request` — separately from the guarded
2442    /// `take_close_window_request` flag.
2443    #[test]
2444    fn forced_close_flag_propagates_to_tree_and_drains_independently() {
2445        use crate::test_widgets::FillWidget;
2446        use crate::widget_tree::WidgetTree;
2447
2448        // `run_with_event_context` only runs the `collect_from_ctx`
2449        // teardown (which transfers ctx flags onto the tree) when the
2450        // tree has a root to anchor on, so give it one.
2451        let mut tree = WidgetTree::new();
2452        tree.add(FillWidget::new());
2453        tree.run_with_event_context(&mut NoopWindowOps, |ctx| ctx.close_window_forced());
2454        assert!(
2455            tree.take_force_close_request(),
2456            "forced-close flag must reach the tree"
2457        );
2458        assert!(
2459            !tree.take_close_window_request(),
2460            "a forced close must not also raise the guarded flag"
2461        );
2462
2463        // And the guarded path stays on its own channel.
2464        let mut tree = WidgetTree::new();
2465        tree.add(FillWidget::new());
2466        tree.run_with_event_context(&mut NoopWindowOps, |ctx| ctx.close_window());
2467        assert!(tree.take_close_window_request());
2468        assert!(!tree.take_force_close_request());
2469    }
2470
2471    #[test]
2472    fn windows_enumerates_via_ops() {
2473        let mut ops = RecordingOps::default();
2474        ops.states.borrow_mut().push(make_state(1, Some("a")));
2475        ops.states.borrow_mut().push(make_state(2, Some("b")));
2476        let main_state = make_state(1, Some("a"));
2477        let ctx = EventContext::new().with_window_context(&mut ops, Some(main_state));
2478        let ids: Vec<_> = ctx.windows().iter().map(|s| s.id()).collect();
2479        assert_eq!(ids, vec![TeksiloWindowId::new(1), TeksiloWindowId::new(2)]);
2480    }
2481
2482    #[test]
2483    fn standalone_context_returns_empty_windows_and_none_lookups() {
2484        let ctx = EventContext::new();
2485        assert!(ctx.find_window("anything").is_none());
2486        assert!(ctx.window_state(TeksiloWindowId::new(1)).is_none());
2487        assert!(ctx.windows().is_empty());
2488    }
2489
2490    #[test]
2491    #[should_panic(expected = "open_window called outside of a dispatch")]
2492    fn open_window_on_standalone_context_panics() {
2493        let mut ctx = EventContext::new();
2494        let _ = ctx.open_window(WindowConfig::new());
2495    }
2496
2497    #[test]
2498    fn open_modal_builds_window_config_from_request() {
2499        use crate::modal::{ModalContent, ModalRequest};
2500        let mut ops = RecordingOps::default();
2501        let main_state = make_state(1, Some("main"));
2502        let built_widget = Rc::new(RefCell::new(false));
2503        let built_widget_flag = built_widget.clone();
2504        let request = ModalRequest {
2505            content: ModalContent::Deferred(Box::new(move |_tree| {
2506                *built_widget_flag.borrow_mut() = true;
2507                // Return a dummy WidgetId — not used in this test since
2508                // the RecordingOps doesn't actually build the tree.
2509                crate::widget_id::WidgetId::default()
2510            })),
2511            presentation: crate::modal::ModalPresentation::NativeWindow,
2512            close_behavior: crate::modal::ModalCloseBehavior::default(),
2513            title: Some("Confirm".to_string()),
2514            size: Some((420, 180)),
2515            focus_target: None,
2516            on_dismiss: None,
2517        };
2518        {
2519            let mut ctx = EventContext::new().with_window_context(&mut ops, Some(main_state));
2520            let id = ctx.open_modal(request);
2521            assert!(id.is_some());
2522        }
2523        // open_modal is a thin wrapper over open_window — the config
2524        // it built must reach RecordingOps::open_window.
2525        let calls = ops.open_calls.borrow();
2526        assert_eq!(calls.len(), 1);
2527        let cfg = &calls[0];
2528        assert_eq!(cfg.title, "Confirm");
2529        assert_eq!(cfg.size, (420, 180));
2530        assert!(cfg.is_modal());
2531        assert_eq!(cfg.modal_parent(), Some(TeksiloWindowId::new(1)));
2532        // Cell is just to let us observe something reachable via cfg.root_builder;
2533        // the builder hasn't been called yet (RecordingOps records the config
2534        // but doesn't build the tree).
2535        let _ = built_widget;
2536    }
2537
2538    #[test]
2539    fn open_modal_requires_current_window() {
2540        use crate::modal::{ModalContent, ModalRequest};
2541        let mut ops = RecordingOps::default();
2542        let mut ctx = EventContext::new().with_window_context(&mut ops, None);
2543        let request = ModalRequest {
2544            content: ModalContent::Deferred(Box::new(|_tree| {
2545                crate::widget_id::WidgetId::default()
2546            })),
2547            presentation: crate::modal::ModalPresentation::NativeWindow,
2548            close_behavior: crate::modal::ModalCloseBehavior::default(),
2549            title: None,
2550            size: None,
2551            focus_target: None,
2552            on_dismiss: None,
2553        };
2554        assert!(ctx.open_modal(request).is_none());
2555    }
2556}