osu-framework / osu.Framework / Graphics / Cursor / IHasTooltip.cs

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using osu.Framework.Localisation;

namespace osu.Framework.Graphics.Cursor
{
    /// <summary>
    /// Implementing this interface allows the implementing <see cref="Drawable"/> to display a tooltip if it is the child of a <see cref="TooltipContainer"/>. The tooltip used is
    /// dependent on the implementation of the <see cref="TooltipContainer.CreateTooltip"/> method of the <see cref="TooltipContainer"/> containing this <see cref="Drawable"/>.
    /// </summary>
    public interface IHasTooltip : ITooltipContentProvider
    {
        /// <summary>
        /// Tooltip text that shows when hovering the drawable.
        /// </summary>
        LocalisableString TooltipText { get; }
    }
}