ModernTooltipService.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. // 此文件主体由 AI 生成,应作为独立模块,尽量减少与其他内容的耦合。
  2. // 使用 ModernTooltipService 接管后,TooltipService 仅有 IsEnabled、ShowOnDisabled、InitialShowDelay 仍然有效,其他属性不再生效。
  3. using System.Windows;
  4. using System.Windows.Controls;
  5. using System.Windows.Controls.Primitives;
  6. using System.Windows.Input;
  7. using System.Windows.Media;
  8. using System.Windows.Media.Animation;
  9. using System.Windows.Media.Effects;
  10. using System.Windows.Media.Media3D;
  11. using System.Windows.Threading;
  12. namespace MeloongCore.Wpf;
  13. public static class ModernTooltipService {
  14. // 控制是否使用现代化 Tooltip 渲染;默认为 true。是否允许显示 Tooltip 仍由 ToolTipService.IsEnabled 控制。
  15. public static void SetUseModernTooltip(DependencyObject element, bool value) => element.SetValue(UseModernTooltipProperty, value);
  16. public static bool GetUseModernTooltip(DependencyObject element) => (bool) element.GetValue(UseModernTooltipProperty);
  17. // 控制 Tooltip 是否跟随鼠标移动;默认为 true。
  18. public static void SetFollowMouse(DependencyObject element, bool value) => element.SetValue(FollowMouseProperty, value);
  19. public static bool GetFollowMouse(DependencyObject element) => (bool) element.GetValue(FollowMouseProperty);
  20. /// <summary>
  21. /// 全局启用现代 Tooltip。启用后会接管所有 <see cref="FrameworkElement.ToolTip"/>。
  22. /// </summary>
  23. internal static void Init() {
  24. if (initialized) return;
  25. initialized = true;
  26. EventManager.RegisterClassHandler(typeof(FrameworkElement), UIElement.MouseEnterEvent, new MouseEventHandler(OnMouseEnter), true);
  27. EventManager.RegisterClassHandler(typeof(FrameworkElement), UIElement.MouseMoveEvent, new MouseEventHandler(OnMouseMove), true);
  28. EventManager.RegisterClassHandler(typeof(FrameworkElement), UIElement.MouseLeaveEvent, new MouseEventHandler(OnMouseLeave), true);
  29. EventManager.RegisterClassHandler(typeof(FrameworkElement), UIElement.PreviewMouseUpEvent, new MouseButtonEventHandler(OnPreviewMouseUp), true);
  30. EventManager.RegisterClassHandler(typeof(FrameworkElement), ToolTipService.ToolTipOpeningEvent, new ToolTipEventHandler(OnToolTipOpening), true);
  31. EventManager.RegisterClassHandler(typeof(FrameworkElement), FrameworkElement.UnloadedEvent, new RoutedEventHandler(static (sender, _) => {
  32. if (sender is FrameworkElement owner && ReferenceEquals(owner, currentOwner)) Close(false);
  33. }), true);
  34. // Loaded 负责常规路径;PreviewMouseDown 兜底处理 Init 晚于控件 Loaded 的情况。
  35. EventManager.RegisterClassHandler(typeof(ComboBox), FrameworkElement.LoadedEvent, new RoutedEventHandler(static (sender, _) => HookComboBoxDropDown(sender as ComboBox)), true);
  36. EventManager.RegisterClassHandler(typeof(ComboBox), UIElement.PreviewMouseDownEvent, new MouseButtonEventHandler(static (sender, _) => HookComboBoxDropDown(sender as ComboBox)), true);
  37. }
  38. #region 字段与属性
  39. // 附加属性
  40. public static readonly DependencyProperty UseModernTooltipProperty = DependencyProperty.RegisterAttached(
  41. "UseModernTooltip", typeof(bool), typeof(ModernTooltipService), new PropertyMetadata(true));
  42. public static readonly DependencyProperty FollowMouseProperty = DependencyProperty.RegisterAttached(
  43. "FollowMouse", typeof(bool), typeof(ModernTooltipService), new PropertyMetadata(true));
  44. private static readonly DependencyProperty IsComboBoxDropDownHookedProperty = DependencyProperty.RegisterAttached(
  45. "IsComboBoxDropDownHooked", typeof(bool), typeof(ModernTooltipService), new PropertyMetadata(false));
  46. // 常量
  47. private const double closedScale = 0.97;
  48. private const int shadowRadius = 18, contentMaxWidth = 676;
  49. private static readonly Thickness contentMargin = new(12, 11, 12, 8);
  50. private static readonly Brush backgroundBrush = new SolidColorBrush(Colors.White);
  51. private static readonly Brush borderBrush = new SolidColorBrush(Color.FromRgb(0xD6, 0xD6, 0xD6));
  52. private static readonly Brush foregroundBrush = new SolidColorBrush(Color.FromRgb(0x52, 0x52, 0x52));
  53. // 状态字段
  54. private static readonly DispatcherTimer openTimer = new();
  55. private static bool initialized;
  56. private static int animationToken;
  57. private static Point lastMousePoint;
  58. private static Popup? popup;
  59. private static Border? popupCard;
  60. private static ScaleTransform? popupScale;
  61. private static FrameworkElement? currentOwner;
  62. private static ToolTip? borrowedToolTip;
  63. private static object? borrowedContent;
  64. static ModernTooltipService() {
  65. backgroundBrush.Freeze();
  66. borderBrush.Freeze();
  67. foregroundBrush.Freeze();
  68. openTimer.Tick += (_, _) => {
  69. openTimer.Stop();
  70. if (currentOwner is not null) Show(currentOwner, lastMousePoint);
  71. };
  72. }
  73. #endregion
  74. #region 事件入口
  75. private static void OnMouseEnter(object sender, MouseEventArgs e) {
  76. if (sender is not FrameworkElement reference) return;
  77. reference.Dispatcher.BeginInvoke(new Action(() => RefreshCurrentOwner(reference)), DispatcherPriority.Input);
  78. }
  79. private static void OnMouseMove(object sender, MouseEventArgs e) {
  80. if (sender is not FrameworkElement reference) return;
  81. if (IsAnyMouseButtonPressed()) {
  82. if (currentOwner is FrameworkElement pressedOwner) {
  83. lastMousePoint = Mouse.GetPosition(pressedOwner);
  84. if (GetFollowMouse(pressedOwner) && popup is { IsOpen: true } && IsPointInside(pressedOwner, lastMousePoint)) {
  85. UpdatePosition(pressedOwner, lastMousePoint);
  86. }
  87. }
  88. return;
  89. }
  90. RefreshCurrentOwner(reference);
  91. if (currentOwner is not FrameworkElement owner) return;
  92. lastMousePoint = Mouse.GetPosition(owner);
  93. if (GetFollowMouse(owner) && popup is { IsOpen: true }) UpdatePosition(owner, lastMousePoint);
  94. }
  95. private static void OnMouseLeave(object sender, MouseEventArgs e) {
  96. if (sender is not FrameworkElement owner || !ReferenceEquals(owner, currentOwner)) return;
  97. // 长按、拖选时鼠标会短暂离开元素边界;此时收回 Tooltip 会造成明显闪烁。
  98. if (IsAnyMouseButtonPressed()) return;
  99. var nextOwner = FindCurrentTooltipOwner(owner);
  100. if (nextOwner is not null && !ReferenceEquals(nextOwner, owner)) {
  101. BeginShow(nextOwner, Mouse.GetPosition(nextOwner));
  102. return;
  103. }
  104. Close(true);
  105. }
  106. private static void OnPreviewMouseUp(object sender, MouseButtonEventArgs e) {
  107. if (sender is not FrameworkElement reference) return;
  108. reference.Dispatcher.BeginInvoke(new Action(() => {
  109. if (currentOwner is null) return;
  110. var owner = FindCurrentTooltipOwner(reference);
  111. if (owner is null) {
  112. Close(true);
  113. } else {
  114. BeginShow(owner, Mouse.GetPosition(owner));
  115. }
  116. }), DispatcherPriority.Input);
  117. }
  118. private static void OnToolTipOpening(object sender, ToolTipEventArgs e) {
  119. if (sender is not FrameworkElement owner || !CanShowModernTooltip(owner) || !TryGetToolTip(owner, out _, out _)) return;
  120. e.Handled = true;
  121. if (ShouldSuppressTooltip(owner)) {
  122. Close(false);
  123. return;
  124. }
  125. // 启用状态控件走 MouseEnter 延迟逻辑;禁用控件只能从原生 Opening 事件接管。
  126. if (owner.IsEnabled) return;
  127. if (!ReferenceEquals(currentOwner, owner)) HideImmediately();
  128. currentOwner = owner;
  129. openTimer.Stop();
  130. lastMousePoint = Mouse.GetPosition(owner);
  131. Show(owner, lastMousePoint);
  132. }
  133. #endregion
  134. #region Tooltip 目标解析
  135. private static void RefreshCurrentOwner(FrameworkElement reference) {
  136. var owner = FindCurrentTooltipOwner(reference);
  137. if (ShouldSuppressTooltip(owner)) {
  138. // 鼠标捕获仍在当前拥有者分支内时,保留现有气泡,避免拖选或按压时闪烁。
  139. if (currentOwner is not null &&
  140. Mouse.Captured is DependencyObject captured &&
  141. IsSameTreeBranch(captured, currentOwner) &&
  142. IsPointInside(currentOwner, Mouse.GetPosition(currentOwner))) {
  143. return;
  144. }
  145. Close(false);
  146. return;
  147. }
  148. if (owner is not null) BeginShow(owner, Mouse.GetPosition(owner));
  149. }
  150. private static FrameworkElement? FindCurrentTooltipOwner(FrameworkElement reference) {
  151. static FrameworkElement? FindOwnerInAncestors(DependencyObject? start) {
  152. for (var current = start; current is not null; current = GetParent(current)) {
  153. if (current is FrameworkElement owner && CanShowModernTooltip(owner) && TryGetToolTip(owner, out _, out _)) {
  154. return owner;
  155. }
  156. }
  157. return null;
  158. }
  159. var owner = FindOwnerInAncestors(Mouse.DirectlyOver as DependencyObject);
  160. if (owner is not null) return owner;
  161. return reference.InputHitTest(Mouse.GetPosition(reference)) is DependencyObject hit
  162. ? FindOwnerInAncestors(hit)
  163. : null;
  164. }
  165. private static bool CanShowModernTooltip(FrameworkElement owner) =>
  166. GetUseModernTooltip(owner) && ToolTipService.GetIsEnabled(owner) && (owner.IsEnabled || ToolTipService.GetShowOnDisabled(owner));
  167. private static bool TryGetToolTip(FrameworkElement owner, out object? content, out ToolTip? sourceToolTip) {
  168. var raw = owner.ToolTip;
  169. sourceToolTip = raw as ToolTip;
  170. content = sourceToolTip?.Content ?? raw;
  171. return content is not null && (content is not string text || text.Length > 0);
  172. }
  173. private static bool ShouldSuppressTooltip(FrameworkElement? owner) {
  174. if (IsAnyMouseButtonPressed() || Mouse.Captured is null) return false;
  175. if (Mouse.Captured is not DependencyObject captured) return true;
  176. if (owner is null) return true;
  177. return !IsSameTreeBranch(captured, owner);
  178. }
  179. private static bool IsAnyMouseButtonPressed() =>
  180. Mouse.LeftButton == MouseButtonState.Pressed || Mouse.RightButton == MouseButtonState.Pressed ||
  181. Mouse.MiddleButton == MouseButtonState.Pressed || Mouse.XButton1 == MouseButtonState.Pressed ||
  182. Mouse.XButton2 == MouseButtonState.Pressed;
  183. private static bool IsPointInside(FrameworkElement owner, Point point) =>
  184. point.X >= 0 && point.Y >= 0 && point.X <= owner.ActualWidth && point.Y <= owner.ActualHeight;
  185. private static bool IsSameTreeBranch(DependencyObject first, DependencyObject second) {
  186. if (ReferenceEquals(first, second)) return true;
  187. for (var current = GetParent(second); current is not null; current = GetParent(current)) {
  188. if (ReferenceEquals(current, first)) return true;
  189. }
  190. for (var current = GetParent(first); current is not null; current = GetParent(current)) {
  191. if (ReferenceEquals(current, second)) return true;
  192. }
  193. return false;
  194. }
  195. private static DependencyObject? GetParent(DependencyObject current) {
  196. if (current is Visual or Visual3D && VisualTreeHelper.GetParent(current) is { } visualParent) return visualParent;
  197. return LogicalTreeHelper.GetParent(current);
  198. }
  199. #endregion
  200. #region 显示生命周期
  201. private static void BeginShow(FrameworkElement owner, Point point) {
  202. if (!CanShowModernTooltip(owner) || !TryGetToolTip(owner, out _, out _)) return;
  203. if (ShouldSuppressTooltip(owner)) {
  204. Close(false);
  205. return;
  206. }
  207. if (owner is ComboBox comboBox) HookComboBoxDropDown(comboBox);
  208. if (ReferenceEquals(currentOwner, owner)) {
  209. lastMousePoint = point;
  210. if (popup is not { IsOpen: true } && !openTimer.IsEnabled) StartOpenTimer(owner);
  211. return;
  212. }
  213. HideImmediately();
  214. currentOwner = owner;
  215. lastMousePoint = point;
  216. StartOpenTimer(owner);
  217. }
  218. private static void StartOpenTimer(FrameworkElement owner) {
  219. openTimer.Stop();
  220. var delay = Math.Max(0, ToolTipService.GetInitialShowDelay(owner));
  221. if (delay == 0) {
  222. Show(owner, lastMousePoint);
  223. return;
  224. }
  225. openTimer.Interval = TimeSpan.FromMilliseconds(delay);
  226. openTimer.Start();
  227. }
  228. private static void Show(FrameworkElement owner, Point point) {
  229. if (!ReferenceEquals(owner, currentOwner) || !CanShowModernTooltip(owner) || !TryGetToolTip(owner, out var content, out var sourceToolTip)) return;
  230. if (popup is null) {
  231. popupScale = new ScaleTransform(closedScale, closedScale);
  232. popupCard = new Border {
  233. Background = backgroundBrush, BorderBrush = borderBrush, BorderThickness = new(1),
  234. CornerRadius = new(8), MaxWidth = 700, SnapsToDevicePixels = true, UseLayoutRounding = true,
  235. RenderTransform = popupScale, RenderTransformOrigin = new(0, 0),
  236. Effect = new DropShadowEffect { Opacity = 0.15, BlurRadius = shadowRadius, ShadowDepth = 0, Color = Colors.Black }
  237. };
  238. var root = new Grid { Margin = new(shadowRadius + 1), SnapsToDevicePixels = true, UseLayoutRounding = true };
  239. root.Children.Add(popupCard);
  240. popup = new Popup {
  241. AllowsTransparency = true, IsHitTestVisible = false, StaysOpen = true, PopupAnimation = PopupAnimation.None,
  242. Placement = PlacementMode.Relative, Child = root
  243. };
  244. }
  245. popup!.PlacementTarget = owner;
  246. popupCard!.DataContext = sourceToolTip?.DataContext ?? owner.DataContext;
  247. popupCard.FlowDirection = owner.FlowDirection;
  248. UpdatePosition(owner, point);
  249. // 先还原上一次借出的 Visual,再挂载新的内容,避免同一元素拥有两个逻辑父级。
  250. popupCard.Child = null;
  251. RestoreBorrowedContent();
  252. if (sourceToolTip is not null && content is DependencyObject contentObject && ReferenceEquals(LogicalTreeHelper.GetParent(contentObject), sourceToolTip)) {
  253. borrowedToolTip = sourceToolTip;
  254. borrowedContent = content;
  255. sourceToolTip.Content = null;
  256. }
  257. var hasTemplate = sourceToolTip?.ContentTemplate is not null || sourceToolTip?.ContentTemplateSelector is not null;
  258. popupCard.Child = content is string stringContent && !hasTemplate
  259. ? new TextBlock {
  260. Text = stringContent, TextWrapping = TextWrapping.Wrap, Foreground = foregroundBrush,
  261. Margin = contentMargin, FontSize = 12.5, LineHeight = 17, MaxWidth = contentMaxWidth
  262. }
  263. : new ContentPresenter {
  264. Content = content, ContentTemplate = sourceToolTip?.ContentTemplate, ContentTemplateSelector = sourceToolTip?.ContentTemplateSelector,
  265. ContentStringFormat = sourceToolTip?.ContentStringFormat, Margin = contentMargin, MaxWidth = contentMaxWidth
  266. };
  267. animationToken++;
  268. popupCard.Opacity = 0;
  269. popupScale!.ScaleX = closedScale;
  270. popupScale.ScaleY = closedScale;
  271. popup.IsOpen = true;
  272. Animate(1, 1, null);
  273. }
  274. private static void Close(bool animated) {
  275. openTimer.Stop();
  276. currentOwner = null;
  277. if (popup is not { IsOpen: true } || popupCard is null || !animated) {
  278. HideImmediately();
  279. return;
  280. }
  281. var token = ++animationToken;
  282. Animate(0, closedScale, (_, _) => {
  283. if (token != animationToken) return;
  284. HideImmediately();
  285. });
  286. }
  287. private static void HideImmediately() {
  288. openTimer.Stop();
  289. animationToken++;
  290. if (popup is not null) popup.IsOpen = false;
  291. if (popupCard is not null) {
  292. popupCard.BeginAnimation(UIElement.OpacityProperty, null);
  293. popupCard.Child = null;
  294. }
  295. if (popupScale is not null) {
  296. popupScale.BeginAnimation(ScaleTransform.ScaleXProperty, null);
  297. popupScale.BeginAnimation(ScaleTransform.ScaleYProperty, null);
  298. }
  299. RestoreBorrowedContent();
  300. }
  301. private static void RestoreBorrowedContent() {
  302. if (borrowedToolTip is null) return;
  303. borrowedToolTip.Content = borrowedContent;
  304. borrowedToolTip = null;
  305. borrowedContent = null;
  306. }
  307. #endregion
  308. #region Popup 渲染与动画
  309. private static void UpdatePosition(FrameworkElement owner, Point point) {
  310. popup!.PlacementTarget = owner;
  311. popup.HorizontalOffset = Math.Round(point.X + 15);
  312. popup.VerticalOffset = Math.Round(point.Y + 25);
  313. }
  314. private static void Animate(double opacity, double scale, EventHandler? completed) {
  315. var duration = new Duration(TimeSpan.FromMilliseconds(70));
  316. var opacityAnimation = new DoubleAnimation(opacity, duration) {
  317. EasingFunction = new QuadraticEase { EasingMode = EasingMode.EaseOut }
  318. };
  319. if (completed is not null) opacityAnimation.Completed += completed;
  320. var scaleAnimation = new DoubleAnimation(scale, duration) {
  321. EasingFunction = new QuadraticEase { EasingMode = EasingMode.EaseOut }
  322. };
  323. popupCard!.BeginAnimation(UIElement.OpacityProperty, opacityAnimation, HandoffBehavior.SnapshotAndReplace);
  324. popupScale!.BeginAnimation(ScaleTransform.ScaleXProperty, scaleAnimation, HandoffBehavior.SnapshotAndReplace);
  325. popupScale.BeginAnimation(ScaleTransform.ScaleYProperty, scaleAnimation, HandoffBehavior.SnapshotAndReplace);
  326. }
  327. #endregion
  328. // WPF 原生 Tooltip 会在 ComboBox 下拉弹出时关闭;这里保持同样行为。
  329. private static void HookComboBoxDropDown(ComboBox? comboBox) {
  330. if (comboBox is null || (bool) comboBox.GetValue(IsComboBoxDropDownHookedProperty)) return;
  331. comboBox.SetValue(IsComboBoxDropDownHookedProperty, true);
  332. comboBox.DropDownOpened += static (_, _) => { if (currentOwner is not null) Close(true); };
  333. }
  334. }