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