ModernTooltipService.cs 20 KB

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