Add tooltips to truncated text

[Joehuu]

• Resolves Truncated text should have tooltips of full text #6120

Made the changes said in ppy/osu-framework#5636 (comment) + simplifying the tooltip IsTruncated ? Text : string.Empty to just Text as it wasn't needed (i.e. the HandlePositionalInput override already disables tooltip showing).

Looking again, TruncatingSpriteText may be better suited for framework. OsuSpriteText is already a simple class with just two lines, so inheritance isn't a problem and could be TruncatingSpriteText : SpriteText for framework and OsuTruncatingSpriteText : TruncatingSpriteText for osu!-side.

---

I also tried centralising the MaxWidth and RelativeSizeAxes = Axes.X assigning to TruncatingSpriteText (Joehuu@dd8e1ba), but not sure about the solution as I'm working around a framework limitation and probably should be done more directly in SpriteText.

[peppy]

I'm just wondering if we don't want to add this implementation to OsuSpriteText to provide a default tooltip in cases of truncation, rather than making a specific class for it. Feels like we're going to end up manually adding it in places it gets forgotten over time.

[bdach]

We've been over this in the framework pull: ppy/osu-framework#5636 (comment)

[frenzibyte]

I was also hoping this could be done in OsuSpriteText where it makes sense, but as mentioned above, that causes all sprite texts to be considered as candidates for input events, which would lead to a performance hit.

In my opinion, rather than overthinking this further, I would be totally fine with this approach as long as the Truncate property is completely obsoleted and points at the new TruncatingSpriteText class. Along the lines of:

diff --git a/osu.Game/Graphics/Sprites/OsuSpriteText.cs b/osu.Game/Graphics/Sprites/OsuSpriteText.cs
index e149e0abfb..afbec0eab4 100644
--- a/osu.Game/Graphics/Sprites/OsuSpriteText.cs
+++ b/osu.Game/Graphics/Sprites/OsuSpriteText.cs
@@ -3,12 +3,19 @@
 
 #nullable disable
 
+using System;
 using osu.Framework.Graphics.Sprites;
 
 namespace osu.Game.Graphics.Sprites
 {
     public partial class OsuSpriteText : SpriteText
     {
+        [Obsolete("Use TruncatingSpriteText instead.")]
+        public new bool Truncate
+        {
+            set => throw new InvalidOperationException($"Use {nameof(TruncatingSpriteText)} instead.");
+        }
+
         public OsuSpriteText()
         {
             Shadow = true;
diff --git a/osu.Game/Graphics/Sprites/TruncatingSpriteText.cs b/osu.Game/Graphics/Sprites/TruncatingSpriteText.cs
index da0dbd49d2..229fad29f9 100644
--- a/osu.Game/Graphics/Sprites/TruncatingSpriteText.cs
+++ b/osu.Game/Graphics/Sprites/TruncatingSpriteText.cs
@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Graphics.Cursor;
+using osu.Framework.Graphics.Sprites;
 using osu.Framework.Localisation;
 
 namespace osu.Game.Graphics.Sprites
@@ -14,7 +15,7 @@ public sealed partial class TruncatingSpriteText : OsuSpriteText, IHasTooltip
 
         public TruncatingSpriteText()
         {
-            Truncate = true;
+            ((SpriteText)this).Truncate = true;
         }
     }
 }
diff --git a/osu.Game/Overlays/Mods/ModSelectPanel.cs b/osu.Game/Overlays/Mods/ModSelectPanel.cs
index 81285833bd..6179f31637 100644
--- a/osu.Game/Overlays/Mods/ModSelectPanel.cs
+++ b/osu.Game/Overlays/Mods/ModSelectPanel.cs
@@ -118,22 +118,20 @@ protected ModSelectPanel()
                                 Direction = FillDirection.Vertical,
                                 Children = new[]
                                 {
-                                    titleText = new OsuSpriteText
+                                    titleText = new TruncatingSpriteText
                                     {
                                         Font = OsuFont.TorusAlternate.With(size: 18, weight: FontWeight.SemiBold),
                                         RelativeSizeAxes = Axes.X,
-                                        Truncate = true,
                                         Shear = new Vector2(-ShearedOverlayContainer.SHEAR, 0),
                                         Margin = new MarginPadding
                                         {
                                             Left = -18 * ShearedOverlayContainer.SHEAR
                                         }
                                     },
-                                    descriptionText = new OsuSpriteText
+                                    descriptionText = new TruncatingSpriteText
                                     {
                                         Font = OsuFont.Default.With(size: 12),
                                         RelativeSizeAxes = Axes.X,
-                                        Truncate = true,
                                         Shear = new Vector2(-ShearedOverlayContainer.SHEAR, 0)
                                     }
                                 }

[Joehuu]

ModSelectPanels were intentionally omitted as IncompatibilityDisplayingModPanel has a custom tooltip implemented which conflicts:

Kind of a weird case, because the freemods overlay will actually benefit from this as it doesn't show the custom incompatibility tooltip:

[frenzibyte]

That should definitely be handled very explicitly. Either as...a truncating sprite text that doesn't show a tooltip...or move the tooltip provider to a drawable that would take hover away from the sprite text.

[peppy]

Kind of a weird case, because the freemods overlay will actually benefit from this as it doesn't show the custom incompatibility tooltip:

I was going to go in and fix this, but the mod column classes are a bit hard to work with (I got lost). Specifically, ModButtonTooltip exists as a base class but is never constructed itself, which seems very weird.

[peppy]

This is probably fine, but requesting one more approval.

[frenzibyte]

I'll abstain from approval here since part of the changes in this PR were proposed by me above.

[Susko3]

Looks fine. On first glance I thought TruncatingSpriteText was a framework class as it doesn't have Osu in it.

[bdach]

i have a weird feeling that this is overly constrained and is going to backfire on us but there's enough approvals that let's give it a go i guess