Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-30 17:57:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Renamed Dim.Function->Func to align iwth C# Func type.

Browse Source 
Dim API doc fixes and code cleanup
This commit is contained in:
Tig
2024-05-16 06:41:36 -07:00
parent c12c20603f
commit 80d9a97e2d
7 changed files with 64 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
Terminal.Gui/View/Layout/Dim.cs
View File

@@ -94,7 +94,7 @@ public enum Dimension
/// </item>
/// <item>
/// <term>
/// <see cref="Dim.Function(Func{int})"/>
/// <see cref="Func"/>
/// </term>
/// <description>
/// Creates a <see cref="Dim"/> object that computes the dimension by executing the provided
@@ -143,8 +143,10 @@ public enum Dimension
/// </remarks>
public class Dim
{
#region static Dim creation methods
/// <summary>
/// Creates a <see cref="Dim"/> object that automatically sizes the view to fit all the view's SubViews and/or Text.
/// Creates a <see cref="Dim"/> object that automatically sizes the view to fit all the view's Content, Subviews, and/or Text.
/// </summary>
/// <remarks>
/// <para>
@@ -191,7 +193,7 @@ public class Dim
/// </summary>
/// <param name="function">The function to be executed.</param>
/// <returns>The <see cref="Dim"/> returned from the function.</returns>
public static Dim Function (Func<int> function) { return new DimFunc (function); }
public static Dim Func (Func<int> function) { return new DimFunc (function); }
/// <summary>Creates a <see cref="Dim"/> object that tracks the Height of the specified <see cref="View"/>.</summary>
/// <returns>The height <see cref="Dim"/> of the other <see cref="View"/>.</returns>
@@ -239,6 +241,47 @@ public class Dim
/// <param name="view">The view that will be tracked.</param>
public static Dim Width (View view) { return new DimView (view, Dimension.Width); }
#endregion static Dim creation methods
#region virtual methods
/// <summary>
/// Gets a dimension that is anchored to a certain point in the layout.
/// This method is typically used internally by the layout system to determine the size of a View.
/// </summary>
/// <param name="width">The width of the area where the View is being sized (Superview.ContentSize).</param>
/// <returns>
/// An integer representing the calculated dimension. The way this dimension is calculated depends on the specific
/// subclass of Dim that is used. For example, DimAbsolute returns a fixed dimension, DimFactor returns a
/// dimension that is a certain percentage of the super view's size, and so on.
/// </returns>
internal virtual int Anchor (int size) { return 0; }
/// <summary>
/// Calculates and returns the dimension of a <see cref="View"/> object. It takes into account the location of the
/// <see cref="View"/>, it's SuperView's ContentSize, and whether it should automatically adjust its size based on its
/// content.
/// </summary>
/// <param name="location">
/// The starting point from where the size calculation begins. It could be the left edge for width calculation or the
/// top edge for height calculation.
/// </param>
/// <param name="superviewContentSize">The size of the SuperView's content. It could be 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 size of the View. The way this size is calculated depends on the specific subclass of Dim that
/// is used.
/// </returns>
internal virtual int Calculate (int location, int superviewContentSize, View us, Dimension dimension)
{
return Math.Max (Anchor (superviewContentSize - location), 0);
}
#endregion virtual methods
#region operators
/// <summary>Adds a <see cref="Dim"/> to a <see cref="Dim"/>, yielding a new <see cref="Dim"/>.</summary>
/// <param name="left">The first <see cref="Dim"/> to add.</param>
/// <param name="right">The second <see cref="Dim"/> to add.</param>
@@ -281,38 +324,9 @@ public class Dim
return newDim;
}
/// <summary>
/// Gets a dimension that is anchored to a certain point in the layout.
/// This method is typically used internally by the layout system to determine the size of a View.
/// </summary>
/// <param name="width">The width of the area where the View is being sized (Superview.ContentSize).</param>
/// <returns>
/// An integer representing the calculated dimension. The way this dimension is calculated depends on the specific
/// subclass of Dim that is used. For example, DimAbsolute returns a fixed dimension, DimFactor returns a
/// dimension that is a certain percentage of the super view's size, and so on.
/// </returns>
internal virtual int Anchor (int size) { return 0; }
#endregion operators
/// <summary>
/// Calculates and returns the dimension of a <see cref="View"/> object. It takes into account the location of the
/// <see cref="View"/>, it's SuperView's ContentSize, and whether it should automatically adjust its size based on its
/// content.
/// </summary>
/// <param name="location">
/// The starting point from where the size calculation begins. It could be the left edge for width calculation or the
/// top edge for height calculation.
/// </param>
/// <param name="superviewContentSize">The size of the SuperView's content. It could be 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 size of the View. The way this size is calculated depends on the specific subclass of Dim that
/// is used.
/// </returns>
internal virtual int Calculate (int location, int superviewContentSize, View us, Dimension dimension)
{
return Math.Max (Anchor (superviewContentSize - location), 0);
}
#region overrides
/// <summary>
/// Diagnostics API to determine if this Dim object references other views.
@@ -325,6 +339,8 @@ public class Dim
/// <inheritdoc/>
public override int GetHashCode () { return Anchor (0).GetHashCode (); }
#endregion overrides
}
/// <summary>
@@ -332,8 +348,8 @@ public class Dim
/// </summary>
/// <remarks>
/// <para>
/// 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.
/// 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.
/// </para>
/// </remarks>
/// <param name="size"></param>
@@ -370,8 +386,8 @@ public class DimAbsolute (int size) : Dim
/// See <see cref="DimAutoStyle"/>.
/// </para>
/// <para>
/// 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.
/// 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.
/// </para>
/// </remarks>
/// <param name="style">

4
UICatalog/Scenarios/Buttons.cs
View File

@@ -420,7 +420,7 @@ public class Buttons : Scenario
// TODO: Use Dim.Auto for the Width and Height
Height = 1;
Width = Dim.Function (() => Digits + 2); // button + 3 for number + button
Width = Dim.Func (() => Digits + 2); // button + 3 for number + button
_down = new ()
{
@@ -438,7 +438,7 @@ public class Buttons : Scenario
Text = Value.ToString (),
X = Pos.Right (_down),
Y = Pos.Top (_down),
Width = Dim.Function (() => Digits),
Width = Dim.Func (() => Digits),
Height = 1,
TextAlignment = TextAlignment.Centered,
CanFocus = true

2
UICatalog/Scenarios/DynamicMenuBar.cs
View File

@@ -627,7 +627,7 @@ public class DynamicMenuBar : Scenario
X = Pos.Right (_btnPrevious) + 1,
Y = Pos.Top (_btnPrevious),
Width = Dim.Fill () - Dim.Function (() => _btnAdd.Frame.Width + 1),
Width = Dim.Fill () - Dim.Func (() => _btnAdd.Frame.Width + 1),
Height = 1
};
_frmMenu.Add (_lblMenuBar);

2
UnitTests/View/Layout/Dim.AutoTests.cs
View File

@@ -1086,7 +1086,7 @@ public class DimAutoTests (ITestOutputHelper output)
public void With_Subview_Using_DimFunc ()
{
var view = new View ();
var subview = new View () { Width = Dim.Function (() => 20), Height = Dim.Function (() => 25) };
var subview = new View () { Width = Dim.Func (() => 20), Height = Dim.Func (() => 25) };
view.Add (subview);
subview.SetRelativeLayout (new (100, 100));

8
UnitTests/View/Layout/Dim.FunctionTests.cs
View File

@@ -14,12 +14,12 @@ public class DimFunctionTests (ITestOutputHelper output)
Func<int> f1 = () => 0;
Func<int> f2 = () => 0;
Dim dim1 = Dim.Function (f1);
Dim dim2 = Dim.Function (f2);
Dim dim1 = Dim.Func (f1);
Dim dim2 = Dim.Func (f2);
Assert.Equal (dim1, dim2);
f2 = () => 1;
dim2 = Dim.Function (f2);
dim2 = Dim.Func (f2);
Assert.NotEqual (dim1, dim2);
}
@@ -27,7 +27,7 @@ public class DimFunctionTests (ITestOutputHelper output)
public void DimFunction_SetsValue ()
{
var text = "Test";
Dim dim = Dim.Function (() => text.Length);
Dim dim = Dim.Func (() => text.Length);
Assert.Equal ("DimFunc(4)", dim.ToString ());
text = "New Test";

2
UnitTests/View/Layout/Pos.AnchorEndTests.cs
View File

@@ -204,7 +204,7 @@ public class PosAnchorEndTests (ITestOutputHelper output)
// Dim.Fill (1) fills remaining space minus 1 (16 - 1 = 15)
// Dim.Function (Btn_Width) is 6
// Width should be 15 - 6 = 9
Width = Dim.Fill (1) - Dim.Function (Btn_Width),
Width = Dim.Fill (1) - Dim.Func (Btn_Width),
Height = 1
};

2
UnitTests/View/Layout/SetRelativeLayoutTests.cs
View File

@@ -418,7 +418,7 @@ public class SetRelativeLayoutTests
Assert.Equal (1, view.Frame.Height);
var tf = new TextField { Text = "01234567890123456789" };
tf.Width = Dim.Fill (1) - Dim.Function (GetViewWidth);
tf.Width = Dim.Fill (1) - Dim.Func (GetViewWidth);
// tf will fill the screen minus 1 minus the width of view (3).
// so it's width will be 26 (30 - 1 - 3).