MonoGame.Extended/Source/MonoGame.Extended.NuclexGui/Controls/Desktop/IOpeningLocator.cs

using Microsoft.Xna.Framework;

namespace MonoGame.Extended.NuclexGui.Controls.Desktop
{
    /// <summary>
    ///     Interface which can be established between a control and its renderer to
    ///     allow the control to locate openings between letters
    /// </summary>
    /// <remarks>
    ///     A renderer can implement this interface and assign it to a control that
    ///     it renders so the control can ask the renderer for extended informations
    ///     regarding the look of its text. If this interface is provided, certain
    ///     controls will be able to correctly place the caret in user-editable text
    ///     when they are clicked by the mouse.
    /// </remarks>
    public interface IOpeningLocator
    {
        /// <summary>
        ///     Calculates which opening between two letters is closest to a position
        /// </summary>
        /// <param name="bounds">
        ///     Boundaries of the control, should be in absolute coordinates
        /// </param>
        /// <param name="text">Text in which the nearest opening will be located</param>
        /// <param name="position">
        ///     Position to which the closest opening will be found,
        ///     should be in absolute coordinates
        /// </param>
        /// <returns>The index of the opening closest to the provided position</returns>
        int GetClosestOpening(RectangleF bounds, string text, Vector2 position);
    }
}