Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-01 16:59:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Aligner - one type per file

Browse Source
This commit is contained in:
Tig
2024-05-17 16:24:00 -07:00
parent b64f10cc6a
commit e0c07c1d9a
2 changed files with 191 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

192
Terminal.Gui/Drawing/Aligner.cs
View File

@@ -1,199 +1,7 @@
using System.ComponentModel;
using Microsoft.CodeAnalysis;
using static Terminal.Gui.Pos;
namespace Terminal.Gui;
/// <summary>
/// Controls how the <see cref="Aligner"/> aligns items within a container.
/// </summary>
public enum Alignment
{
/// <summary>
/// The items will be aligned to the left.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the right items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="Left"/> and <see cref="Top"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Left = 0,
/// <summary>
/// The items will be aligned to the top.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the bottom items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="Left"/> and <see cref="Top"/> have equivalent behavior.
/// </para>
/// </remarks>
Top,
/// <summary>
/// The items will be aligned to the right.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the left items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="Right"/> and <see cref="Bottom"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Right,
/// <summary>
/// The items will be aligned to the bottom.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the top items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="Right"/> and <see cref="Bottom"/> have equivalent behavior.
/// </para>
/// </remarks>
Bottom,
/// <summary>
/// The group will be centered in the container.
/// If centering is not possible, the group will be left-aligned.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// Extra space will be distributed between the items, biased towards the left.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Centered,
/// <summary>
/// The items will be justified. Space will be added between the items such that the first item
/// is at the start and the right side of the last item against the end.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// Extra space will be distributed between the items, biased towards the left.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Justified,
/// <summary>
/// The first item will be aligned to the left and the remaining will aligned to the right.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the right items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="FirstLeftRestRight"/> and <see cref="FirstTopRestBottom"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
FirstLeftRestRight,
/// <summary>
/// The first item will be aligned to the top and the remaining will aligned to the bottom.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the bottom items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="FirstLeftRestRight"/> and <see cref="FirstTopRestBottom"/> have equivalent behavior.
/// </para>
/// </remarks>
FirstTopRestBottom,
/// <summary>
/// The last item will be aligned to the right and the remaining will aligned to the left.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the left items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="LastRightRestLeft"/> and <see cref="LastBottomRestTop"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
LastRightRestLeft,
/// <summary>
/// The last item will be aligned to the bottom and the remaining will aligned to the left.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the top items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="LastRightRestLeft"/> and <see cref="LastBottomRestTop"/> have equivalent behavior.
/// </para>
/// </remarks>
LastBottomRestTop
}
/// <summary>
/// Aligns items within a container based on the specified <see cref="Gui.Alignment"/>. Both horizontal and vertical alignments are supported.
/// </summary>

191
Terminal.Gui/Drawing/Alignment.cs Normal file
View File

@@ -0,0 +1,191 @@
namespace Terminal.Gui;
/// <summary>
/// Controls how the <see cref="Aligner"/> aligns items within a container.
/// </summary>
public enum Alignment
{
/// <summary>
/// The items will be aligned to the left.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the right items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="Left"/> and <see cref="Top"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Left = 0,
/// <summary>
/// The items will be aligned to the top.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the bottom items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="Left"/> and <see cref="Top"/> have equivalent behavior.
/// </para>
/// </remarks>
Top,
/// <summary>
/// The items will be aligned to the right.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the left items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="Right"/> and <see cref="Bottom"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Right,
/// <summary>
/// The items will be aligned to the bottom.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the top items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="Right"/> and <see cref="Bottom"/> have equivalent behavior.
/// </para>
/// </remarks>
Bottom,
/// <summary>
/// The group will be centered in the container.
/// If centering is not possible, the group will be left-aligned.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// Extra space will be distributed between the items, biased towards the left.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Centered,
/// <summary>
/// The items will be justified. Space will be added between the items such that the first item
/// is at the start and the right side of the last item against the end.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// Extra space will be distributed between the items, biased towards the left.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
Justified,
/// <summary>
/// The first item will be aligned to the left and the remaining will aligned to the right.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the right items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="FirstLeftRestRight"/> and <see cref="FirstTopRestBottom"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
FirstLeftRestRight,
/// <summary>
/// The first item will be aligned to the top and the remaining will aligned to the bottom.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the bottom items will be clipped (their locations
/// will be greater than the container size).
/// </para>
/// <para>
/// <see cref="FirstLeftRestRight"/> and <see cref="FirstTopRestBottom"/> have equivalent behavior.
/// </para>
/// </remarks>
FirstTopRestBottom,
/// <summary>
/// The last item will be aligned to the right and the remaining will aligned to the left.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one space between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the left items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="LastRightRestLeft"/> and <see cref="LastBottomRestTop"/> have equivalent behavior.
/// </para>
/// </remarks>
/// <example>
/// <c>
/// 111 2222 33333
/// </c>
/// </example>
LastRightRestLeft,
/// <summary>
/// The last item will be aligned to the bottom and the remaining will aligned to the left.
/// Set <see cref="Aligner.SpaceBetweenItems"/> to <see langword="true"/> to ensure at least one line between
/// each item.
/// </summary>
/// <remarks>
/// <para>
/// If the container is smaller than the total size of the items, the top items will be clipped (their locations
/// will be negative).
/// </para>
/// <para>
/// <see cref="LastRightRestLeft"/> and <see cref="LastBottomRestTop"/> have equivalent behavior.
/// </para>
/// </remarks>
LastBottomRestTop
}