From 16fb3d46e1eaa0d455465e4e66a3ac7b17b55bd3 Mon Sep 17 00:00:00 2001 From: aiongg <67543387+aiongg@users.noreply.github.com> Date: Sat, 24 Oct 2026 14:49:29 -0400 Subject: [PATCH] docking: the window under the pointer draws the undock hint (#285) --- crates/ui/src/docking/native_tests.rs | 48 ++++++++++++++ crates/ui/src/docking/render/cross.rs | 83 +++++++------------------ crates/ui/src/docking/render/frame.rs | 8 +-- crates/ui/src/docking/render/preview.rs | 4 +- 4 files changed, 75 insertions(+), 68 deletions(-) diff --git a/crates/ui/src/docking/native_tests.rs b/crates/ui/src/docking/native_tests.rs index ef55c9dc9..12a0eabfd 100644 --- a/crates/ui/src/docking/native_tests.rs +++ b/crates/ui/src/docking/native_tests.rs @@ -559,6 +559,54 @@ fn the_preview_is_drawn_in_the_window_under_the_pointer() { assert!(matches!(out.actions.as_slice(), [Action::Move { panel: 1, anchor: 7, .. }]), "{:?}", out.actions); } +/// The texts drawn in `shapes`. +fn texts(shapes: &[ClippedShape]) -> Vec { + fn walk(shape: &egui::Shape, out: &mut Vec) { + match shape { + egui::Shape::Vec(shapes) => shapes.iter().for_each(|s| walk(s, out)), + egui::Shape::Text(text) => out.push(text.galley.text().to_owned()), + _ => {} + } + } + let mut out = Vec::new(); + shapes.iter().for_each(|clipped| walk(&clipped.shape, &mut out)); + out +} + +#[test] +fn the_undock_hint_is_drawn_in_the_window_under_the_pointer() { + let key = if egui::os::OperatingSystem::from_target_os() == egui::os::OperatingSystem::Mac { "⌘" } else { "Ctrl" }; + let hint = format!("Hold {key} to undock"); + let hinted = |shapes: &[ClippedShape]| texts(shapes).contains(&hint); + let driver = || { + DockDriver::new(two_windows(), Content::default()) + .with_style(|s| { + s.command_press_floats = true; + s.float_hint = true; + }) + .with_native_host(ORIGIN) + }; + + // Tab 1 of the main window over window [7]'s body. + let mut d = driver(); + let viewport = d.viewport(window(&d, 7).id); + let tab = d.hit(&Hit::Tab(1)).unwrap().center(); + let body = d.host().windows[&viewport].rect.center() - ORIGIN.to_vec2(); + d.hold(tab, body); + d.move_to(body); + assert!(hinted(&d.host().windows[&viewport].shapes), "{:?}", texts(&d.host().windows[&viewport].shapes)); + assert!(!hinted(d.shapes()), "not in the source"); + + // Tab 5 of window [5, 6] over frame [1, 2] of the main window. + let mut d = driver(); + let id = window(&d, 5).id; + let viewport = d.viewport(id); + let local = d.window_local(id, ORIGIN + vec2(100.0, 300.0)).unwrap(); + d.window_hold(id, pos2(15.0, TAB_ROW), local); + assert!(hinted(d.shapes()), "{:?}", texts(d.shapes())); + assert!(!hinted(&d.host().windows[&viewport].shapes), "not in the source"); +} + /// Zone outlines: closed 1 pt paths without a fill. fn zone_outlines(shapes: &[ClippedShape]) -> usize { shapes diff --git a/crates/ui/src/docking/render/cross.rs b/crates/ui/src/docking/render/cross.rs index b30e058ce..bd7b767db 100644 --- a/crates/ui/src/docking/render/cross.rs +++ b/crates/ui/src/docking/render/cross.rs @@ -8,7 +8,7 @@ //! frame, with the targets it drew. The release is resolved at the end of the main window's //! frame, after every native window has drawn. -use std::{cell::Cell, fmt::Debug, hash::Hash}; +use std::{fmt::Debug, hash::Hash}; use egui::{Context, Key, Pos2, Rect, Ui, Vec2, vec2}; @@ -22,8 +22,6 @@ use crate::docking::{Action, Drag, DropTarget, Floating, GroupDrag, GroupGesture /// Key of [`DragPointer`] in the context's data, under the area's id. pub(super) const POINTER: &str = "drag-pointer"; -/// Key of whether a target was offered last frame, for the source window's undock hint. -const OFFERED: &str = "drag-offered"; /// Key of an Escape that reached one of the application's windows other than the drag's /// owner. Keys go to the window with keyboard focus, which need not be the one dragging. const ESCAPE: &str = "drag-escape"; @@ -93,12 +91,8 @@ pub(in crate::docking) struct Cross

{ pub pointer: Option, /// A bar drag released this frame. pub release: Option<(WindowDrag, DragPointer)>, - /// Drawing for a window other than the drag's source: the undock hint is the source's. - pub quiet: bool, /// Resolving a native window's bar drag over the main window: frame edge zones count. pub bar: bool, - /// A target was offered while `quiet`. - pub offered: Cell, /// Where the native window drawing now was told to move its content this frame. pub moved: Option, /// Resolving a window move that docks whatever `title_bar_docks` says. @@ -115,9 +109,7 @@ impl

Default for Cross

{ surfaces: Vec::new(), pointer: None, release: None, - quiet: false, bar: false, - offered: Cell::new(false), moved: None, docks: false, } @@ -173,27 +165,25 @@ impl Renderer<'_, P> { } /// Run `f` with a native window's targets and bounds in place of the main window's. - /// `quiet` leaves the undock hint to the drag's source window. - fn within(&mut self, surface: &mut Surface

, quiet: bool, f: impl FnOnce(&mut Self) -> R) -> R { + fn within(&mut self, surface: &mut Surface

, f: impl FnOnce(&mut Self) -> R) -> R { std::mem::swap(&mut self.targets, &mut surface.targets); std::mem::swap(&mut self.dock_targets, &mut surface.dock_targets); std::mem::swap(&mut self.frame.windows, &mut surface.windows); let bounds = std::mem::replace(&mut self.float_bounds, surface.bounds); let blockers = std::mem::take(&mut self.blockers); - let was = std::mem::replace(&mut self.cross.quiet, quiet); let result = f(self); std::mem::swap(&mut self.targets, &mut surface.targets); std::mem::swap(&mut self.dock_targets, &mut surface.dock_targets); std::mem::swap(&mut self.frame.windows, &mut surface.windows); - (self.float_bounds, self.blockers, self.cross.quiet) = (bounds, blockers, was); + (self.float_bounds, self.blockers) = (bounds, blockers); result } /// [`Self::within`] the native window `window` drawn this frame. - fn within_window(&mut self, window: u64, quiet: bool, f: impl FnOnce(&mut Self) -> R) -> Option { + fn within_window(&mut self, window: u64, f: impl FnOnce(&mut Self) -> R) -> Option { let index = self.cross.surfaces.iter().position(|s| s.window == window)?; let mut surface = self.cross.surfaces.swap_remove(index); - let result = self.within(&mut surface, quiet, f); + let result = self.within(&mut surface, f); self.cross.surfaces.push(surface); Some(result) } @@ -214,7 +204,6 @@ impl Renderer<'_, P> { /// drag in the main window's coordinates and the input to finish it with; elsewhere it /// docks in another window or floats a new one on release. pub(super) fn cross_tab(&mut self, ctx: &Context, drag: &Drag

, input: DragInput) -> Option<(Drag

, DragInput)> { - self.cross.quiet = false; let Some(pointer) = self.cross.pointer.filter(|p| self.cross.on && p.window.is_none() && p.local.is_some()) else { return Some((drag.clone(), input)); }; @@ -227,15 +216,14 @@ impl Renderer<'_, P> { match self.destination(&pointer, None)? { Dest::Main(local) if !floats_out => { let shift = self.shift(&pointer, self.cross.main.map(|m| m.min)); - self.cross.quiet = pointer.owner.is_some(); let drag = Drag { origin: drag.origin + shift, source: drag.source.translate(shift), ..drag.clone() }; return Some((drag, DragInput { pointer: Some(local), ..input })); } - _ if !pointer.released => self.source_hint(ctx, &pointer), + _ if !pointer.released => {} Dest::Window(window, local) if !float_only => { let shift = self.shift(&pointer, self.origin_of(window)); let drag = Drag { origin: drag.origin + shift, source: drag.source.translate(shift), ..drag.clone() }; - let action = self.within_window(window, true, |r| { + let action = self.within_window(window, |r| { let proposal = r.tab_proposal(&drag.panel, local).filter(|p| !p.noop && local.distance(drag.origin) >= 2.0)?; Some(Action::Move { panel: drag.panel.clone(), anchor: proposal.anchor, placement: proposal.placement }) }); @@ -258,7 +246,6 @@ impl Renderer<'_, P> { /// A group or column drag at the end of the main window's frame, like [`Self::cross_tab`]. pub(super) fn cross_group(&mut self, ui: &Ui, drag: &GroupDrag

, input: DragInput) -> Option<(GroupDrag

, DragInput)> { - self.cross.quiet = false; let Some(pointer) = self.cross.pointer.filter(|p| self.cross.on && p.window.is_none() && p.local.is_some()) else { return Some((drag.clone(), input)); }; @@ -274,15 +261,14 @@ impl Renderer<'_, P> { match self.destination(&pointer, None)? { Dest::Main(local) if !floats_out => { let shift = self.shift(&pointer, self.cross.main.map(|m| m.min)); - self.cross.quiet = pointer.owner.is_some(); let drag = GroupDrag { origin: drag.origin + shift, source: drag.source.translate(shift), ..drag.clone() }; return Some((drag, DragInput { pointer: Some(local), ..input })); } - _ if !pointer.released => self.source_hint(ctx, &pointer), + _ if !pointer.released => {} Dest::Window(window, local) if !pointer.command => { let shift = self.shift(&pointer, self.origin_of(window)); let drag = GroupDrag { origin: drag.origin + shift, source: drag.source.translate(shift), ..drag.clone() }; - let action = self.within_window(window, true, |r| { + let action = self.within_window(window, |r| { let proposal = r.group_proposal(&drag, local).filter(|p| !p.noop && local.distance(drag.origin) >= 2.0)?; Some(group_action(&drag, Target::At { anchor: proposal.anchor, placement: proposal.placement })) }); @@ -305,7 +291,6 @@ impl Renderer<'_, P> { /// A bar drag of a native window, at the end of the main window's frame: the preview /// over the main window, and the release. pub(in crate::docking) fn finish_window_drag(&mut self, ui: &Ui) { - self.cross.quiet = false; if let Some((drag, pointer)) = self.cross.release.take() { self.drop_native_window(drag.window, &pointer); return; @@ -313,9 +298,9 @@ impl Renderer<'_, P> { let Some(pointer) = self.cross.pointer.filter(|p| p.window.is_some() && !p.released) else { return }; let Some(drag) = pointer.window.and_then(|w| self.window_group_drag(w)) else { return }; if let Some(Dest::Main(local)) = self.destination(&pointer, None) { - (self.cross.quiet, self.cross.bar, self.cross.docks) = (true, true, pointer.docks); + (self.cross.bar, self.cross.docks) = (true, pointer.docks); self.paint_group_drag(ui, &drag, local, pointer.command); - (self.cross.quiet, self.cross.bar, self.cross.docks) = (false, false, false); + (self.cross.bar, self.cross.docks) = (false, false); } } @@ -330,7 +315,7 @@ impl Renderer<'_, P> { (self.cross.bar, self.cross.docks) = (false, false); } Some(Dest::Window(target, local)) => { - let action = self.within_window(target, true, |r| { + let action = self.within_window(target, |r| { let proposal = r.group_proposal(&drag, local).filter(|p| !p.noop)?; Some(group_action(&drag, Target::At { anchor: proposal.anchor, placement: proposal.placement })) }); @@ -350,23 +335,16 @@ impl Renderer<'_, P> { Some(GroupDrag { panel, original: window.rect, gesture: GroupGesture::Window, members, origin: Pos2::ZERO, source: Rect::NOTHING }) } - /// At the end of a native window's frame: the drop preview when the drag's pointer is - /// over this window, or the undock hint when this window is the drag's source and a target - /// elsewhere was offered last frame. + /// At the end of a native window's frame: the drop preview, and its undock hint, when the + /// drag's pointer is over this window. pub(super) fn paint_cross(&mut self, ui: &Ui, surface: &mut Surface

) { let ctx = ui.ctx(); let Some(pointer) = ctx.data(|d| d.get_temp::(self.id.with(POINTER))).filter(|p| !p.released && p.down) else { return }; - let source = pointer.owner == Some(surface.window); - match self.destination(&pointer, Some(&*surface)) { - Some(Dest::Window(window, local)) if window == surface.window => { - let shift = self.shift(&pointer, surface.origin); - self.within(surface, !source, |r| r.paint_drop(ui, &pointer, local, shift)); - } - _ if source && ctx.data(|d| d.get_temp::(self.id.with(OFFERED))).unwrap_or(false) => { - let Some(local) = pointer.local else { return }; - self.within(surface, false, |r| r.paint_float_hint(ctx, local)); - } - _ => {} + if let Some(Dest::Window(window, local)) = self.destination(&pointer, Some(&*surface)) + && window == surface.window + { + let shift = self.shift(&pointer, surface.origin); + self.within(surface, |r| r.paint_drop(ui, &pointer, local, shift)); } } @@ -397,19 +375,7 @@ impl Renderer<'_, P> { } } - /// The undock hint in the main window, when it is the source and another window offered a - /// target this frame. - fn source_hint(&self, ctx: &Context, pointer: &DragPointer) { - if pointer.owner.is_none() - && self.cross.offered.get() - && let Some(local) = pointer.local - { - self.paint_float_hint(ctx, local); - } - } - - /// End of the main window's frame: remember whether a target was offered for the source - /// window's hint, and forget the pointer of a finished drag. + /// End of the main window's frame: forget the pointer of a finished drag. pub(in crate::docking) fn end_cross(&mut self, ctx: &Context) { let id = self.id; let active = ctx.data(|d| { @@ -417,12 +383,9 @@ impl Renderer<'_, P> { || d.get_temp::>(id.with("group-drag")).is_some() || d.get_temp::(id.with("window-drag")).is_some() }); - ctx.data_mut(|d| { - d.insert_temp(id.with(OFFERED), self.cross.offered.get()); - if !active { - d.remove::(id.with(POINTER)); - } - }); + if !active { + ctx.data_mut(|d| d.remove::(id.with(POINTER))); + } } /// The drag's input as its owner saw it, at `pointer` in the coordinates of the window diff --git a/crates/ui/src/docking/render/frame.rs b/crates/ui/src/docking/render/frame.rs index f0096df1d..618216eca 100644 --- a/crates/ui/src/docking/render/frame.rs +++ b/crates/ui/src/docking/render/frame.rs @@ -193,17 +193,11 @@ impl Renderer<'_, P> { } /// Under the pointer while a drag offers a docking target: which modifier floats the drop - /// instead. + /// instead. With native windows, the window under the pointer draws it, beside its preview. pub(super) fn paint_float_hint(&self, ctx: &Context, pointer: Pos2) { if !self.style.float_hint || self.style.float_hint_label.is_empty() { return; } - // A window other than the drag's source: the source shows the hint. - #[cfg(feature = "native-windows")] - if self.cross.quiet { - self.cross.offered.set(true); - return; - } let key = if ctx.os() == egui::os::OperatingSystem::Mac { "⌘" } else { "Ctrl" }; let painter = self.preview_painter(ctx); let galley = painter.layout_no_wrap(self.style.float_hint_label.replace("{key}", key), self.style.font.clone(), self.style.text); diff --git a/crates/ui/src/docking/render/preview.rs b/crates/ui/src/docking/render/preview.rs index 60d38b89c..5488850a1 100644 --- a/crates/ui/src/docking/render/preview.rs +++ b/crates/ui/src/docking/render/preview.rs @@ -286,7 +286,9 @@ impl Renderer<'_, P> { if let Some((action, line)) = self.dock_group_proposal(drag, pointer) { if action.is_some() { self.paint_dock_line(ctx, line); - self.paint_float_hint(ctx, pointer); + if drag.gesture != GroupGesture::Window { + self.paint_float_hint(ctx, pointer); + } } return; }