mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-28 08:47:59 +01:00
Broke Pos & Dim out to separate .cs files
This commit is contained in:
Tig
@@ -2,573 +2,6 @@ using System.Diagnostics;
|
||||
|
||||
namespace Terminal.Gui;
|
||||
|
||||
/// <summary>
|
||||
/// Describes the position of a <see cref="View"/> which can be an absolute value, a percentage, centered, or
|
||||
/// relative to the ending dimension. Integer values are implicitly convertible to an absolute <see cref="Pos"/>. These
|
||||
/// objects are created using the static methods Percent, AnchorEnd, and Center. The <see cref="Pos"/> objects can be
|
||||
/// combined with the addition and subtraction operators.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>Use the <see cref="Pos"/> objects on the X or Y properties of a view to control the position.</para>
|
||||
/// <para>
|
||||
/// These can be used to set the absolute position, when merely assigning an integer value (via the implicit
|
||||
/// integer to <see cref="Pos"/> conversion), and they can be combined to produce more useful layouts, like:
|
||||
/// Pos.Center - 3, which would shift the position of the <see cref="View"/> 3 characters to the left after
|
||||
/// centering for example.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Reference coordinates of another view by using the methods Left(View), Right(View), Bottom(View), Top(View).
|
||||
/// The X(View) and Y(View) are aliases to Left(View) and Top(View) respectively.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <list type="table">
|
||||
/// <listheader>
|
||||
/// <term>Pos Object</term> <description>Description</description>
|
||||
/// </listheader>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Function(Func{int})"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that computes the position by executing the provided
|
||||
/// function. The function will be called every time the position is needed.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Percent(float)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that is a percentage of the width or height of the
|
||||
/// SuperView.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.AnchorEnd()"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that is anchored to the end (right side or bottom) of
|
||||
/// the dimension, useful to flush the layout from the right or bottom.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Center"/>
|
||||
/// </term>
|
||||
/// <description>Creates a <see cref="Pos"/> object that can be used to center the <see cref="View"/>.</description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.At(int)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that is an absolute position based on the specified
|
||||
/// integer value.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Left"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.X(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Top(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Y(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Right(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Right (X+Width) coordinate of the
|
||||
/// specified <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Bottom(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Bottom (Y+Height) coordinate of the
|
||||
/// specified <see cref="View"/>
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// </list>
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public class Pos
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that is anchored to the end (right side or
|
||||
/// bottom) of the SuperView, minus the respective dimension of the View. This is equivalent to using
|
||||
/// <see cref="Pos.AnchorEnd(int)"/>,
|
||||
/// with an offset equivalent to the View's respective dimension.
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> object anchored to the end (the bottom or the right side) minus the View's dimension.</returns>
|
||||
/// <example>
|
||||
/// This sample shows how align a <see cref="Button"/> to the bottom-right the SuperView.
|
||||
/// <code>
|
||||
/// anchorButton.X = Pos.AnchorEnd ();
|
||||
/// anchorButton.Y = Pos.AnchorEnd ();
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos AnchorEnd () { return new PosAnchorEnd (); }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that is anchored to the end (right side or bottom) of the SuperView,
|
||||
/// useful to flush the layout from the right or bottom. See also <see cref="Pos.AnchorEnd()"/>, which uses the view
|
||||
/// dimension to ensure the view is fully visible.
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> object anchored to the end (the bottom or the right side).</returns>
|
||||
/// <param name="offset">The view will be shifted left or up by the amount specified.</param>
|
||||
/// <example>
|
||||
/// This sample shows how align a 10 column wide <see cref="Button"/> to the bottom-right the SuperView.
|
||||
/// <code>
|
||||
/// anchorButton.X = Pos.AnchorEnd (10);
|
||||
/// anchorButton.Y = 1
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos AnchorEnd (int offset)
|
||||
{
|
||||
if (offset < 0)
|
||||
{
|
||||
throw new ArgumentException (@"Must be positive", nameof (offset));
|
||||
}
|
||||
|
||||
return new PosAnchorEnd (offset);
|
||||
}
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that is an absolute position based on the specified integer value.</summary>
|
||||
/// <returns>The Absolute <see cref="Pos"/>.</returns>
|
||||
/// <param name="n">The value to convert to the <see cref="Pos"/>.</param>
|
||||
public static Pos At (int n) { return new PosAbsolute (n); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that can be used to center the <see cref="View"/>.</summary>
|
||||
/// <returns>The center Pos.</returns>
|
||||
/// <example>
|
||||
/// This creates a <see cref="TextView"/> centered horizontally, is 50% of the way down, is 30% the height, and
|
||||
/// is 80% the width of the <see cref="View"/> it added to.
|
||||
/// <code>
|
||||
/// var textView = new TextView () {
|
||||
/// X = Pos.Center (),
|
||||
/// Y = Pos.Percent (50),
|
||||
/// Width = Dim.Percent (80),
|
||||
/// Height = Dim.Percent (30),
|
||||
/// };
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos Center () { return new PosCenter (); }
|
||||
|
||||
/// <summary>Determines whether the specified object is equal to the current object.</summary>
|
||||
/// <param name="other">The object to compare with the current object. </param>
|
||||
/// <returns>
|
||||
/// <see langword="true"/> if the specified object is equal to the current object; otherwise,
|
||||
/// <see langword="false"/>.
|
||||
/// </returns>
|
||||
public override bool Equals (object other) { return other is Pos abs && abs == this; }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that computes the position by executing the provided function. The function
|
||||
/// will be called every time the position is needed.
|
||||
/// </summary>
|
||||
/// <param name="function">The function to be executed.</param>
|
||||
/// <returns>The <see cref="Pos"/> returned from the function.</returns>
|
||||
public static Pos Function (Func<int> function) { return new PosFunc (function); }
|
||||
|
||||
/// <summary>Serves as the default hash function. </summary>
|
||||
/// <returns>A hash code for the current object.</returns>
|
||||
public override int GetHashCode () { return Anchor (0).GetHashCode (); }
|
||||
|
||||
/// <summary>Adds a <see cref="Terminal.Gui.Pos"/> to a <see cref="Terminal.Gui.Pos"/>, yielding a new <see cref="Pos"/>.</summary>
|
||||
/// <param name="left">The first <see cref="Terminal.Gui.Pos"/> to add.</param>
|
||||
/// <param name="right">The second <see cref="Terminal.Gui.Pos"/> to add.</param>
|
||||
/// <returns>The <see cref="Pos"/> that is the sum of the values of <c>left</c> and <c>right</c>.</returns>
|
||||
public static Pos operator + (Pos left, Pos right)
|
||||
{
|
||||
if (left is PosAbsolute && right is PosAbsolute)
|
||||
{
|
||||
return new PosAbsolute (left.Anchor (0) + right.Anchor (0));
|
||||
}
|
||||
|
||||
var newPos = new PosCombine (true, left, right);
|
||||
|
||||
if (left is PosView view)
|
||||
{
|
||||
view.Target.SetNeedsLayout ();
|
||||
}
|
||||
|
||||
return newPos;
|
||||
}
|
||||
|
||||
/// <summary>Creates an Absolute <see cref="Pos"/> from the specified integer value.</summary>
|
||||
/// <returns>The Absolute <see cref="Pos"/>.</returns>
|
||||
/// <param name="n">The value to convert to the <see cref="Pos"/> .</param>
|
||||
public static implicit operator Pos (int n) { return new PosAbsolute (n); }
|
||||
|
||||
/// <summary>
|
||||
/// Subtracts a <see cref="Terminal.Gui.Pos"/> from a <see cref="Terminal.Gui.Pos"/>, yielding a new
|
||||
/// <see cref="Pos"/>.
|
||||
/// </summary>
|
||||
/// <param name="left">The <see cref="Terminal.Gui.Pos"/> to subtract from (the minuend).</param>
|
||||
/// <param name="right">The <see cref="Terminal.Gui.Pos"/> to subtract (the subtrahend).</param>
|
||||
/// <returns>The <see cref="Pos"/> that is the <c>left</c> minus <c>right</c>.</returns>
|
||||
public static Pos operator - (Pos left, Pos right)
|
||||
{
|
||||
if (left is PosAbsolute && right is PosAbsolute)
|
||||
{
|
||||
return new PosAbsolute (left.Anchor (0) - right.Anchor (0));
|
||||
}
|
||||
|
||||
var newPos = new PosCombine (false, left, right);
|
||||
|
||||
if (left is PosView view)
|
||||
{
|
||||
view.Target.SetNeedsLayout ();
|
||||
}
|
||||
|
||||
return newPos;
|
||||
}
|
||||
|
||||
/// <summary>Creates a percentage <see cref="Pos"/> object</summary>
|
||||
/// <returns>The percent <see cref="Pos"/> object.</returns>
|
||||
/// <param name="percent">A value between 0 and 100 representing the percentage.</param>
|
||||
/// <example>
|
||||
/// This creates a <see cref="TextField"/> centered horizontally, is 50% of the way down, is 30% the height, and
|
||||
/// is 80% the width of the <see cref="View"/> it added to.
|
||||
/// <code>
|
||||
/// var textView = new TextField {
|
||||
/// X = Pos.Center (),
|
||||
/// Y = Pos.Percent (50),
|
||||
/// Width = Dim.Percent (80),
|
||||
/// Height = Dim.Percent (30),
|
||||
/// };
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos Percent (float percent)
|
||||
{
|
||||
if (percent is < 0 or > 100)
|
||||
{
|
||||
throw new ArgumentException ("Percent value must be between 0 and 100.");
|
||||
}
|
||||
|
||||
return new PosFactor (percent / 100);
|
||||
}
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Top (View view) { return new PosView (view, Side.Top); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Y (View view) { return new PosView (view, Side.Top); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Left (View view) { return new PosView (view, Side.Left); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos X (View view) { return new PosView (view, Side.Left); }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Bottom (Y+Height) coordinate of the specified
|
||||
/// <see cref="View"/>
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Bottom (View view) { return new PosView (view, Side.Bottom); }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Right (X+Width) coordinate of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Right (View view) { return new PosView (view, Side.Right); }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a position that is anchored to a certain point in the layout. This method is typically used
|
||||
/// internally by the layout system to determine where a View should be positioned.
|
||||
/// </summary>
|
||||
/// <param name="width">The width of the area where the View is being positioned (Superview.ContentSize).</param>
|
||||
/// <returns>
|
||||
/// An integer representing the calculated position. The way this position is calculated depends on the specific
|
||||
/// subclass of Pos that is used. For example, PosAbsolute returns a fixed position, PosAnchorEnd returns a
|
||||
/// position that is anchored to the end of the layout, and so on.
|
||||
/// </returns>
|
||||
internal virtual int Anchor (int width) { return 0; }
|
||||
|
||||
/// <summary>
|
||||
/// Calculates and returns the position of a <see cref="View"/> object. It takes into account the dimension of the
|
||||
/// superview and the dimension of the view itself.
|
||||
/// </summary>
|
||||
/// <param name="superviewDimension">
|
||||
/// The dimension of the superview. This could be the width for x-coordinate calculation or the
|
||||
/// height for y-coordinate calculation.
|
||||
/// </param>
|
||||
/// <param name="dim">The dimension of the View. It could be the current width or height.</param>
|
||||
/// <param name="us">The View that holds this Pos object.</param>
|
||||
/// <param name="dimension">Width or Height</param>
|
||||
/// <returns>
|
||||
/// The calculated position of the View. The way this position is calculated depends on the specific subclass of Pos
|
||||
/// that
|
||||
/// is used.
|
||||
/// </returns>
|
||||
internal virtual int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
return Anchor (superviewDimension);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Diagnostics API to determine if this Pos object references other views.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
internal virtual bool ReferencesOtherViews ()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
internal class PosAbsolute (int n) : Pos
|
||||
{
|
||||
private readonly int _n = n;
|
||||
public override bool Equals (object other) { return other is PosAbsolute abs && abs._n == _n; }
|
||||
public override int GetHashCode () { return _n.GetHashCode (); }
|
||||
public override string ToString () { return $"Absolute({_n})"; }
|
||||
internal override int Anchor (int width) { return _n; }
|
||||
}
|
||||
|
||||
internal class PosAnchorEnd : Pos
|
||||
{
|
||||
private readonly int _offset;
|
||||
public PosAnchorEnd () { UseDimForOffset = true; }
|
||||
public PosAnchorEnd (int offset) { _offset = offset; }
|
||||
public override bool Equals (object other) { return other is PosAnchorEnd anchorEnd && anchorEnd._offset == _offset; }
|
||||
public override int GetHashCode () { return _offset.GetHashCode (); }
|
||||
|
||||
/// <summary>
|
||||
/// If true, the offset is the width of the view, if false, the offset is the offset value.
|
||||
/// </summary>
|
||||
internal bool UseDimForOffset { get; set; }
|
||||
|
||||
public override string ToString () { return UseDimForOffset ? "AnchorEnd()" : $"AnchorEnd({_offset})"; }
|
||||
|
||||
internal override int Anchor (int width)
|
||||
{
|
||||
if (UseDimForOffset)
|
||||
{
|
||||
return width;
|
||||
}
|
||||
|
||||
return width - _offset;
|
||||
}
|
||||
|
||||
internal override int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
int newLocation = Anchor (superviewDimension);
|
||||
|
||||
if (UseDimForOffset)
|
||||
{
|
||||
newLocation -= dim.Anchor (superviewDimension);
|
||||
}
|
||||
|
||||
return newLocation;
|
||||
}
|
||||
}
|
||||
|
||||
internal class PosCenter : Pos
|
||||
{
|
||||
public override string ToString () { return "Center"; }
|
||||
internal override int Anchor (int width) { return width / 2; }
|
||||
|
||||
internal override int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
int newDimension = Math.Max (dim.Calculate (0, superviewDimension, us, dimension), 0);
|
||||
|
||||
return Anchor (superviewDimension - newDimension);
|
||||
}
|
||||
}
|
||||
|
||||
internal class PosCombine (bool add, Pos left, Pos right) : Pos
|
||||
{
|
||||
internal bool _add = add;
|
||||
internal Pos _left = left, _right = right;
|
||||
|
||||
public override string ToString () { return $"Combine({_left}{(_add ? '+' : '-')}{_right})"; }
|
||||
|
||||
internal override int Anchor (int width)
|
||||
{
|
||||
int la = _left.Anchor (width);
|
||||
int ra = _right.Anchor (width);
|
||||
|
||||
if (_add)
|
||||
{
|
||||
return la + ra;
|
||||
}
|
||||
|
||||
return la - ra;
|
||||
}
|
||||
|
||||
internal override int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
int newDimension = dim.Calculate (0, superviewDimension, us, dimension);
|
||||
int left = _left.Calculate (superviewDimension, dim, us, dimension);
|
||||
int right = _right.Calculate (superviewDimension, dim, us, dimension);
|
||||
|
||||
if (_add)
|
||||
{
|
||||
return left + right;
|
||||
}
|
||||
|
||||
return left - right;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Diagnostics API to determine if this Pos object references other views.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
internal override bool ReferencesOtherViews ()
|
||||
{
|
||||
if (_left.ReferencesOtherViews ())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (_right.ReferencesOtherViews ())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
internal class PosFactor (float factor) : Pos
|
||||
{
|
||||
private readonly float _factor = factor;
|
||||
public override bool Equals (object other) { return other is PosFactor f && f._factor == _factor; }
|
||||
public override int GetHashCode () { return _factor.GetHashCode (); }
|
||||
public override string ToString () { return $"Factor({_factor})"; }
|
||||
internal override int Anchor (int width) { return (int)(width * _factor); }
|
||||
}
|
||||
|
||||
// Helper class to provide dynamic value by the execution of a function that returns an integer.
|
||||
internal class PosFunc (Func<int> n) : Pos
|
||||
{
|
||||
private readonly Func<int> _function = n;
|
||||
public override bool Equals (object other) { return other is PosFunc f && f._function () == _function (); }
|
||||
public override int GetHashCode () { return _function.GetHashCode (); }
|
||||
public override string ToString () { return $"PosFunc({_function ()})"; }
|
||||
internal override int Anchor (int width) { return _function (); }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Describes which side of the view to use for the position.
|
||||
/// </summary>
|
||||
public enum Side
|
||||
{
|
||||
/// <summary>
|
||||
/// The left (X) side of the view.
|
||||
/// </summary>
|
||||
Left = 0,
|
||||
|
||||
/// <summary>
|
||||
/// The top (Y) side of the view.
|
||||
/// </summary>
|
||||
Top = 1,
|
||||
|
||||
/// <summary>
|
||||
/// The right (X + Width) side of the view.
|
||||
/// </summary>
|
||||
Right = 2,
|
||||
|
||||
/// <summary>
|
||||
/// The bottom (Y + Height) side of the view.
|
||||
/// </summary>
|
||||
Bottom = 3
|
||||
}
|
||||
|
||||
internal class PosView (View view, Side side) : Pos
|
||||
{
|
||||
public readonly View Target = view;
|
||||
|
||||
public override bool Equals (object other) { return other is PosView abs && abs.Target == Target; }
|
||||
public override int GetHashCode () { return Target.GetHashCode (); }
|
||||
|
||||
public override string ToString ()
|
||||
{
|
||||
string sideString = side switch
|
||||
{
|
||||
Side.Left => "left",
|
||||
Side.Top => "top",
|
||||
Side.Right => "right",
|
||||
Side.Bottom => "bottom",
|
||||
_ => "unknown"
|
||||
};
|
||||
|
||||
if (Target == null)
|
||||
{
|
||||
throw new NullReferenceException (nameof (Target));
|
||||
}
|
||||
|
||||
return $"View(side={sideString},target={Target})";
|
||||
}
|
||||
|
||||
internal override int Anchor (int width)
|
||||
{
|
||||
return side switch
|
||||
{
|
||||
Side.Left => Target.Frame.X,
|
||||
Side.Top => Target.Frame.Y,
|
||||
Side.Right => Target.Frame.Right,
|
||||
Side.Bottom => Target.Frame.Bottom,
|
||||
_ => 0
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Diagnostics API to determine if this Pos object references other views.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
internal override bool ReferencesOtherViews ()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// <para>
|
||||
/// A Dim object describes the dimensions of a <see cref="View"/>. Dim is the type of the
|
||||
570
Terminal.Gui/View/Layout/Pos.cs
Normal file
570
Terminal.Gui/View/Layout/Pos.cs
Normal file
@@ -0,0 +1,570 @@
|
||||
using System.Diagnostics;
|
||||
|
||||
namespace Terminal.Gui;
|
||||
|
||||
/// <summary>
|
||||
/// Describes the position of a <see cref="View"/> which can be an absolute value, a percentage, centered, or
|
||||
/// relative to the ending dimension. Integer values are implicitly convertible to an absolute <see cref="Pos"/>. These
|
||||
/// objects are created using the static methods Percent, AnchorEnd, and Center. The <see cref="Pos"/> objects can be
|
||||
/// combined with the addition and subtraction operators.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>Use the <see cref="Pos"/> objects on the X or Y properties of a view to control the position.</para>
|
||||
/// <para>
|
||||
/// These can be used to set the absolute position, when merely assigning an integer value (via the implicit
|
||||
/// integer to <see cref="Pos"/> conversion), and they can be combined to produce more useful layouts, like:
|
||||
/// Pos.Center - 3, which would shift the position of the <see cref="View"/> 3 characters to the left after
|
||||
/// centering for example.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Reference coordinates of another view by using the methods Left(View), Right(View), Bottom(View), Top(View).
|
||||
/// The X(View) and Y(View) are aliases to Left(View) and Top(View) respectively.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <list type="table">
|
||||
/// <listheader>
|
||||
/// <term>Pos Object</term> <description>Description</description>
|
||||
/// </listheader>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Function(Func{int})"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that computes the position by executing the provided
|
||||
/// function. The function will be called every time the position is needed.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Percent(float)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that is a percentage of the width or height of the
|
||||
/// SuperView.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.AnchorEnd()"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that is anchored to the end (right side or bottom) of
|
||||
/// the dimension, useful to flush the layout from the right or bottom.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Center"/>
|
||||
/// </term>
|
||||
/// <description>Creates a <see cref="Pos"/> object that can be used to center the <see cref="View"/>.</description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.At(int)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that is an absolute position based on the specified
|
||||
/// integer value.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Left"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.X(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Top(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Y(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Right(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Right (X+Width) coordinate of the
|
||||
/// specified <see cref="View"/>.
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <term>
|
||||
/// <see cref="Pos.Bottom(View)"/>
|
||||
/// </term>
|
||||
/// <description>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Bottom (Y+Height) coordinate of the
|
||||
/// specified <see cref="View"/>
|
||||
/// </description>
|
||||
/// </item>
|
||||
/// </list>
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public class Pos
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that is anchored to the end (right side or
|
||||
/// bottom) of the SuperView, minus the respective dimension of the View. This is equivalent to using
|
||||
/// <see cref="Pos.AnchorEnd(int)"/>,
|
||||
/// with an offset equivalent to the View's respective dimension.
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> object anchored to the end (the bottom or the right side) minus the View's dimension.</returns>
|
||||
/// <example>
|
||||
/// This sample shows how align a <see cref="Button"/> to the bottom-right the SuperView.
|
||||
/// <code>
|
||||
/// anchorButton.X = Pos.AnchorEnd ();
|
||||
/// anchorButton.Y = Pos.AnchorEnd ();
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos AnchorEnd () { return new PosAnchorEnd (); }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that is anchored to the end (right side or bottom) of the SuperView,
|
||||
/// useful to flush the layout from the right or bottom. See also <see cref="Pos.AnchorEnd()"/>, which uses the view
|
||||
/// dimension to ensure the view is fully visible.
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> object anchored to the end (the bottom or the right side).</returns>
|
||||
/// <param name="offset">The view will be shifted left or up by the amount specified.</param>
|
||||
/// <example>
|
||||
/// This sample shows how align a 10 column wide <see cref="Button"/> to the bottom-right the SuperView.
|
||||
/// <code>
|
||||
/// anchorButton.X = Pos.AnchorEnd (10);
|
||||
/// anchorButton.Y = 1
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos AnchorEnd (int offset)
|
||||
{
|
||||
if (offset < 0)
|
||||
{
|
||||
throw new ArgumentException (@"Must be positive", nameof (offset));
|
||||
}
|
||||
|
||||
return new PosAnchorEnd (offset);
|
||||
}
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that is an absolute position based on the specified integer value.</summary>
|
||||
/// <returns>The Absolute <see cref="Pos"/>.</returns>
|
||||
/// <param name="n">The value to convert to the <see cref="Pos"/>.</param>
|
||||
public static Pos At (int n) { return new PosAbsolute (n); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that can be used to center the <see cref="View"/>.</summary>
|
||||
/// <returns>The center Pos.</returns>
|
||||
/// <example>
|
||||
/// This creates a <see cref="TextView"/> centered horizontally, is 50% of the way down, is 30% the height, and
|
||||
/// is 80% the width of the <see cref="View"/> it added to.
|
||||
/// <code>
|
||||
/// var textView = new TextView () {
|
||||
/// X = Pos.Center (),
|
||||
/// Y = Pos.Percent (50),
|
||||
/// Width = Dim.Percent (80),
|
||||
/// Height = Dim.Percent (30),
|
||||
/// };
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos Center () { return new PosCenter (); }
|
||||
|
||||
/// <summary>Determines whether the specified object is equal to the current object.</summary>
|
||||
/// <param name="other">The object to compare with the current object. </param>
|
||||
/// <returns>
|
||||
/// <see langword="true"/> if the specified object is equal to the current object; otherwise,
|
||||
/// <see langword="false"/>.
|
||||
/// </returns>
|
||||
public override bool Equals (object other) { return other is Pos abs && abs == this; }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that computes the position by executing the provided function. The function
|
||||
/// will be called every time the position is needed.
|
||||
/// </summary>
|
||||
/// <param name="function">The function to be executed.</param>
|
||||
/// <returns>The <see cref="Pos"/> returned from the function.</returns>
|
||||
public static Pos Function (Func<int> function) { return new PosFunc (function); }
|
||||
|
||||
/// <summary>Serves as the default hash function. </summary>
|
||||
/// <returns>A hash code for the current object.</returns>
|
||||
public override int GetHashCode () { return Anchor (0).GetHashCode (); }
|
||||
|
||||
/// <summary>Adds a <see cref="Terminal.Gui.Pos"/> to a <see cref="Terminal.Gui.Pos"/>, yielding a new <see cref="Pos"/>.</summary>
|
||||
/// <param name="left">The first <see cref="Terminal.Gui.Pos"/> to add.</param>
|
||||
/// <param name="right">The second <see cref="Terminal.Gui.Pos"/> to add.</param>
|
||||
/// <returns>The <see cref="Pos"/> that is the sum of the values of <c>left</c> and <c>right</c>.</returns>
|
||||
public static Pos operator + (Pos left, Pos right)
|
||||
{
|
||||
if (left is PosAbsolute && right is PosAbsolute)
|
||||
{
|
||||
return new PosAbsolute (left.Anchor (0) + right.Anchor (0));
|
||||
}
|
||||
|
||||
var newPos = new PosCombine (true, left, right);
|
||||
|
||||
if (left is PosView view)
|
||||
{
|
||||
view.Target.SetNeedsLayout ();
|
||||
}
|
||||
|
||||
return newPos;
|
||||
}
|
||||
|
||||
/// <summary>Creates an Absolute <see cref="Pos"/> from the specified integer value.</summary>
|
||||
/// <returns>The Absolute <see cref="Pos"/>.</returns>
|
||||
/// <param name="n">The value to convert to the <see cref="Pos"/> .</param>
|
||||
public static implicit operator Pos (int n) { return new PosAbsolute (n); }
|
||||
|
||||
/// <summary>
|
||||
/// Subtracts a <see cref="Terminal.Gui.Pos"/> from a <see cref="Terminal.Gui.Pos"/>, yielding a new
|
||||
/// <see cref="Pos"/>.
|
||||
/// </summary>
|
||||
/// <param name="left">The <see cref="Terminal.Gui.Pos"/> to subtract from (the minuend).</param>
|
||||
/// <param name="right">The <see cref="Terminal.Gui.Pos"/> to subtract (the subtrahend).</param>
|
||||
/// <returns>The <see cref="Pos"/> that is the <c>left</c> minus <c>right</c>.</returns>
|
||||
public static Pos operator - (Pos left, Pos right)
|
||||
{
|
||||
if (left is PosAbsolute && right is PosAbsolute)
|
||||
{
|
||||
return new PosAbsolute (left.Anchor (0) - right.Anchor (0));
|
||||
}
|
||||
|
||||
var newPos = new PosCombine (false, left, right);
|
||||
|
||||
if (left is PosView view)
|
||||
{
|
||||
view.Target.SetNeedsLayout ();
|
||||
}
|
||||
|
||||
return newPos;
|
||||
}
|
||||
|
||||
/// <summary>Creates a percentage <see cref="Pos"/> object</summary>
|
||||
/// <returns>The percent <see cref="Pos"/> object.</returns>
|
||||
/// <param name="percent">A value between 0 and 100 representing the percentage.</param>
|
||||
/// <example>
|
||||
/// This creates a <see cref="TextField"/> centered horizontally, is 50% of the way down, is 30% the height, and
|
||||
/// is 80% the width of the <see cref="View"/> it added to.
|
||||
/// <code>
|
||||
/// var textView = new TextField {
|
||||
/// X = Pos.Center (),
|
||||
/// Y = Pos.Percent (50),
|
||||
/// Width = Dim.Percent (80),
|
||||
/// Height = Dim.Percent (30),
|
||||
/// };
|
||||
/// </code>
|
||||
/// </example>
|
||||
public static Pos Percent (float percent)
|
||||
{
|
||||
if (percent is < 0 or > 100)
|
||||
{
|
||||
throw new ArgumentException ("Percent value must be between 0 and 100.");
|
||||
}
|
||||
|
||||
return new PosFactor (percent / 100);
|
||||
}
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Top (View view) { return new PosView (view, Side.Top); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Top (Y) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Y (View view) { return new PosView (view, Side.Top); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Left (View view) { return new PosView (view, Side.Left); }
|
||||
|
||||
/// <summary>Creates a <see cref="Pos"/> object that tracks the Left (X) position of the specified <see cref="View"/>.</summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos X (View view) { return new PosView (view, Side.Left); }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Bottom (Y+Height) coordinate of the specified
|
||||
/// <see cref="View"/>
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Bottom (View view) { return new PosView (view, Side.Bottom); }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="Pos"/> object that tracks the Right (X+Width) coordinate of the specified
|
||||
/// <see cref="View"/>.
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="Pos"/> that depends on the other view.</returns>
|
||||
/// <param name="view">The <see cref="View"/> that will be tracked.</param>
|
||||
public static Pos Right (View view) { return new PosView (view, Side.Right); }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a position that is anchored to a certain point in the layout. This method is typically used
|
||||
/// internally by the layout system to determine where a View should be positioned.
|
||||
/// </summary>
|
||||
/// <param name="width">The width of the area where the View is being positioned (Superview.ContentSize).</param>
|
||||
/// <returns>
|
||||
/// An integer representing the calculated position. The way this position is calculated depends on the specific
|
||||
/// subclass of Pos that is used. For example, PosAbsolute returns a fixed position, PosAnchorEnd returns a
|
||||
/// position that is anchored to the end of the layout, and so on.
|
||||
/// </returns>
|
||||
internal virtual int Anchor (int width) { return 0; }
|
||||
|
||||
/// <summary>
|
||||
/// Calculates and returns the position of a <see cref="View"/> object. It takes into account the dimension of the
|
||||
/// superview and the dimension of the view itself.
|
||||
/// </summary>
|
||||
/// <param name="superviewDimension">
|
||||
/// The dimension of the superview. This could be the width for x-coordinate calculation or the
|
||||
/// height for y-coordinate calculation.
|
||||
/// </param>
|
||||
/// <param name="dim">The dimension of the View. It could be the current width or height.</param>
|
||||
/// <param name="us">The View that holds this Pos object.</param>
|
||||
/// <param name="dimension">Width or Height</param>
|
||||
/// <returns>
|
||||
/// The calculated position of the View. The way this position is calculated depends on the specific subclass of Pos
|
||||
/// that
|
||||
/// is used.
|
||||
/// </returns>
|
||||
internal virtual int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
return Anchor (superviewDimension);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Diagnostics API to determine if this Pos object references other views.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
internal virtual bool ReferencesOtherViews ()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
internal class PosAbsolute (int n) : Pos
|
||||
{
|
||||
private readonly int _n = n;
|
||||
public override bool Equals (object other) { return other is PosAbsolute abs && abs._n == _n; }
|
||||
public override int GetHashCode () { return _n.GetHashCode (); }
|
||||
public override string ToString () { return $"Absolute({_n})"; }
|
||||
internal override int Anchor (int width) { return _n; }
|
||||
}
|
||||
|
||||
internal class PosAnchorEnd : Pos
|
||||
{
|
||||
private readonly int _offset;
|
||||
public PosAnchorEnd () { UseDimForOffset = true; }
|
||||
public PosAnchorEnd (int offset) { _offset = offset; }
|
||||
public override bool Equals (object other) { return other is PosAnchorEnd anchorEnd && anchorEnd._offset == _offset; }
|
||||
public override int GetHashCode () { return _offset.GetHashCode (); }
|
||||
|
||||
/// <summary>
|
||||
/// If true, the offset is the width of the view, if false, the offset is the offset value.
|
||||
/// </summary>
|
||||
internal bool UseDimForOffset { get; set; }
|
||||
|
||||
public override string ToString () { return UseDimForOffset ? "AnchorEnd()" : $"AnchorEnd({_offset})"; }
|
||||
|
||||
internal override int Anchor (int width)
|
||||
{
|
||||
if (UseDimForOffset)
|
||||
{
|
||||
return width;
|
||||
}
|
||||
|
||||
return width - _offset;
|
||||
}
|
||||
|
||||
internal override int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
int newLocation = Anchor (superviewDimension);
|
||||
|
||||
if (UseDimForOffset)
|
||||
{
|
||||
newLocation -= dim.Anchor (superviewDimension);
|
||||
}
|
||||
|
||||
return newLocation;
|
||||
}
|
||||
}
|
||||
|
||||
internal class PosCenter : Pos
|
||||
{
|
||||
public override string ToString () { return "Center"; }
|
||||
internal override int Anchor (int width) { return width / 2; }
|
||||
|
||||
internal override int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
int newDimension = Math.Max (dim.Calculate (0, superviewDimension, us, dimension), 0);
|
||||
|
||||
return Anchor (superviewDimension - newDimension);
|
||||
}
|
||||
}
|
||||
|
||||
internal class PosCombine (bool add, Pos left, Pos right) : Pos
|
||||
{
|
||||
internal bool _add = add;
|
||||
internal Pos _left = left, _right = right;
|
||||
|
||||
public override string ToString () { return $"Combine({_left}{(_add ? '+' : '-')}{_right})"; }
|
||||
|
||||
internal override int Anchor (int width)
|
||||
{
|
||||
int la = _left.Anchor (width);
|
||||
int ra = _right.Anchor (width);
|
||||
|
||||
if (_add)
|
||||
{
|
||||
return la + ra;
|
||||
}
|
||||
|
||||
return la - ra;
|
||||
}
|
||||
|
||||
internal override int Calculate (int superviewDimension, Dim dim, View us, Dim.Dimension dimension)
|
||||
{
|
||||
int newDimension = dim.Calculate (0, superviewDimension, us, dimension);
|
||||
int left = _left.Calculate (superviewDimension, dim, us, dimension);
|
||||
int right = _right.Calculate (superviewDimension, dim, us, dimension);
|
||||
|
||||
if (_add)
|
||||
{
|
||||
return left + right;
|
||||
}
|
||||
|
||||
return left - right;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Diagnostics API to determine if this Pos object references other views.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
internal override bool ReferencesOtherViews ()
|
||||
{
|
||||
if (_left.ReferencesOtherViews ())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (_right.ReferencesOtherViews ())
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
internal class PosFactor (float factor) : Pos
|
||||
{
|
||||
private readonly float _factor = factor;
|
||||
public override bool Equals (object other) { return other is PosFactor f && f._factor == _factor; }
|
||||
public override int GetHashCode () { return _factor.GetHashCode (); }
|
||||
public override string ToString () { return $"Factor({_factor})"; }
|
||||
internal override int Anchor (int width) { return (int)(width * _factor); }
|
||||
}
|
||||
|
||||
// Helper class to provide dynamic value by the execution of a function that returns an integer.
|
||||
internal class PosFunc (Func<int> n) : Pos
|
||||
{
|
||||
private readonly Func<int> _function = n;
|
||||
public override bool Equals (object other) { return other is PosFunc f && f._function () == _function (); }
|
||||
public override int GetHashCode () { return _function.GetHashCode (); }
|
||||
public override string ToString () { return $"PosFunc({_function ()})"; }
|
||||
internal override int Anchor (int width) { return _function (); }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Describes which side of the view to use for the position.
|
||||
/// </summary>
|
||||
public enum Side
|
||||
{
|
||||
/// <summary>
|
||||
/// The left (X) side of the view.
|
||||
/// </summary>
|
||||
Left = 0,
|
||||
|
||||
/// <summary>
|
||||
/// The top (Y) side of the view.
|
||||
/// </summary>
|
||||
Top = 1,
|
||||
|
||||
/// <summary>
|
||||
/// The right (X + Width) side of the view.
|
||||
/// </summary>
|
||||
Right = 2,
|
||||
|
||||
/// <summary>
|
||||
/// The bottom (Y + Height) side of the view.
|
||||
/// </summary>
|
||||
Bottom = 3
|
||||
}
|
||||
|
||||
internal class PosView (View view, Side side) : Pos
|
||||
{
|
||||
public readonly View Target = view;
|
||||
|
||||
public override bool Equals (object other) { return other is PosView abs && abs.Target == Target; }
|
||||
public override int GetHashCode () { return Target.GetHashCode (); }
|
||||
|
||||
public override string ToString ()
|
||||
{
|
||||
string sideString = side switch
|
||||
{
|
||||
Side.Left => "left",
|
||||
Side.Top => "top",
|
||||
Side.Right => "right",
|
||||
Side.Bottom => "bottom",
|
||||
_ => "unknown"
|
||||
};
|
||||
|
||||
if (Target == null)
|
||||
{
|
||||
throw new NullReferenceException (nameof (Target));
|
||||
}
|
||||
|
||||
return $"View(side={sideString},target={Target})";
|
||||
}
|
||||
|
||||
internal override int Anchor (int width)
|
||||
{
|
||||
return side switch
|
||||
{
|
||||
Side.Left => Target.Frame.X,
|
||||
Side.Top => Target.Frame.Y,
|
||||
Side.Right => Target.Frame.Right,
|
||||
Side.Bottom => Target.Frame.Bottom,
|
||||
_ => 0
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Diagnostics API to determine if this Pos object references other views.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
internal override bool ReferencesOtherViews ()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user