gui-cs.Terminal.Gui/Terminal.Gui/View/Layout/DimFill.cs

#nullable enable
namespace Terminal.Gui;

/// <summary>
///     Represents a dimension that fills the dimension, leaving the specified margin.
/// </summary>
/// <remarks>
///     This is a low-level API that is typically used internally by the layout system. Use the various static
///     methods on the <see cref="Dim"/> class to create <see cref="Dim"/> objects instead.
/// </remarks>
/// <param name="margin">The margin to not fill.</param>
public class DimFill (int margin) : Dim
{
    /// <inheritdoc/>
    public override bool Equals (object? other) { return other is DimFill fill && fill.Margin == Margin; }

    /// <inheritdoc/>
    public override int GetHashCode () { return Margin.GetHashCode (); }

    /// <summary>
    ///     Gets the margin to not fill.
    /// </summary>
    public int Margin { get; } = margin;

    /// <inheritdoc/>
    public override string ToString () { return $"Fill({Margin})"; }

    internal override int GetAnchor (int size) { return size - Margin; }
}