mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2026-01-02 01:03:29 +01:00
Refactored again
This commit is contained in:
Tig
404
Terminal.Gui/Views/ScrollBar/ScrollSlider.cs
Normal file
404
Terminal.Gui/Views/ScrollBar/ScrollSlider.cs
Normal file
@@ -0,0 +1,404 @@
|
||||
#nullable enable
|
||||
|
||||
using System.ComponentModel;
|
||||
|
||||
namespace Terminal.Gui;
|
||||
|
||||
/// <summary>
|
||||
/// The ScrollSlider can be dragged with the mouse, constrained by the size of the Viewport of it's superview. The
|
||||
/// ScrollSlider can be
|
||||
/// oriented either vertically or horizontally.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// If <see cref="View.Text"/> is set, it will be displayed centered within the slider. Set
|
||||
/// <see cref="ShowPercent"/> to automatically have the Text
|
||||
/// be show what percent the slider is to the Superview's Viewport size.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Used to represent the proportion of the visible content to the Viewport in a <see cref="Scrolled"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public class ScrollSlider : View, IOrientation, IDesignable
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance.
|
||||
/// </summary>
|
||||
public ScrollSlider ()
|
||||
{
|
||||
Id = "scrollSlider";
|
||||
WantMousePositionReports = true;
|
||||
|
||||
_orientationHelper = new (this); // Do not use object initializer!
|
||||
_orientationHelper.Orientation = Orientation.Vertical;
|
||||
_orientationHelper.OrientationChanging += (sender, e) => OrientationChanging?.Invoke (this, e);
|
||||
_orientationHelper.OrientationChanged += (sender, e) => OrientationChanged?.Invoke (this, e);
|
||||
|
||||
OnOrientationChanged (Orientation);
|
||||
|
||||
HighlightStyle = HighlightStyle.Hover;
|
||||
|
||||
FrameChanged += OnFrameChanged;
|
||||
}
|
||||
|
||||
#region IOrientation members
|
||||
|
||||
private readonly OrientationHelper _orientationHelper;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public Orientation Orientation
|
||||
{
|
||||
get => _orientationHelper.Orientation;
|
||||
set => _orientationHelper.Orientation = value;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public event EventHandler<CancelEventArgs<Orientation>>? OrientationChanging;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public event EventHandler<EventArgs<Orientation>>? OrientationChanged;
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void OnOrientationChanged (Orientation newOrientation)
|
||||
{
|
||||
TextDirection = Orientation == Orientation.Vertical ? TextDirection.TopBottom_LeftRight : TextDirection.LeftRight_TopBottom;
|
||||
TextAlignment = Alignment.Center;
|
||||
VerticalTextAlignment = Alignment.Center;
|
||||
|
||||
// Reset Position to 0 when changing orientation
|
||||
X = 0;
|
||||
Y = 0;
|
||||
Position = 0;
|
||||
|
||||
// Reset Size to 1 when changing orientation
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
Width = Dim.Fill ();
|
||||
Height = 1;
|
||||
}
|
||||
else
|
||||
{
|
||||
Width = 1;
|
||||
Height = Dim.Fill ();
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override bool OnClearingViewport ()
|
||||
{
|
||||
FillRect (Viewport, Glyphs.ContinuousMeterSegment);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
private bool _showPercent;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets whether the ScrollSlider will set <see cref="View.Text"/> to show the percentage the slider
|
||||
/// takes up within the <see cref="View.SuperView"/>'s Viewport.
|
||||
/// </summary>
|
||||
public bool ShowPercent
|
||||
{
|
||||
get => _showPercent;
|
||||
set
|
||||
{
|
||||
_showPercent = value;
|
||||
SetNeedsDraw ();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the size of the ScrollSlider. This is a helper that simply gets or sets the Width or Height depending
|
||||
/// on the
|
||||
/// <see cref="Orientation"/>. The size will be constrained such that the ScrollSlider will not go outside the Viewport
|
||||
/// of
|
||||
/// the <see cref="View.SuperView"/>. The size will never be less than 1.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The dimension of the ScrollSlider that is perpendicular to the <see cref="Orientation"/> will be set to
|
||||
/// <see cref="Dim.Fill()"/>
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public int Size
|
||||
{
|
||||
get
|
||||
{
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
return Viewport.Height - ShrinkBy / 2;
|
||||
}
|
||||
|
||||
return Viewport.Width - ShrinkBy / 2;
|
||||
}
|
||||
set
|
||||
{
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
Width = Dim.Fill ();
|
||||
int viewport = Math.Max (1, SuperView?.Viewport.Height ?? 1);
|
||||
Height = Math.Clamp (value, 1, viewport);
|
||||
}
|
||||
else
|
||||
{
|
||||
Height = Dim.Fill ();
|
||||
int viewport = Math.Max (1, SuperView?.Viewport.Width ?? 1);
|
||||
Width = Math.Clamp (value, 1, viewport);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private int? _viewportDimension;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the size of the viewport into the content being scrolled, bounded by <see cref="Size"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is the SuperView's Viewport demension.
|
||||
/// </remarks>
|
||||
public int ViewportDimension
|
||||
{
|
||||
get
|
||||
{
|
||||
if (_viewportDimension.HasValue)
|
||||
{
|
||||
return _viewportDimension.Value;
|
||||
}
|
||||
|
||||
return Orientation == Orientation.Vertical ? SuperView?.Viewport.Height ?? 0 : SuperView?.Viewport.Width ?? 0;
|
||||
}
|
||||
set => _viewportDimension = value;
|
||||
}
|
||||
|
||||
private void OnFrameChanged (object? sender, EventArgs<Rectangle> e)
|
||||
{
|
||||
Position = (Orientation == Orientation.Vertical ? e.CurrentValue.Y : e.CurrentValue.X) - ShrinkBy / 2;
|
||||
}
|
||||
|
||||
private int _position;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the position of the ScrollSlider relative to the size of the ScrollSlider's Frame.
|
||||
/// The position will be constrained such that the ScrollSlider will not go outside the Viewport of
|
||||
/// the <see cref="View.SuperView"/>.
|
||||
/// </summary>
|
||||
public int Position
|
||||
{
|
||||
get => _position;
|
||||
set
|
||||
{
|
||||
if (_position == value)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
RaisePositionChangeEvents (ClampPosition (value));
|
||||
|
||||
SetNeedsLayout ();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Moves the scroll slider to the specified position.
|
||||
/// The position will be constrained such that the ScrollSlider will not go outside the Viewport of
|
||||
/// its <see cref="View.SuperView"/>.
|
||||
/// </summary>
|
||||
/// <param name="position"></param>
|
||||
public void MoveToPosition (int position)
|
||||
{
|
||||
_position = ClampPosition (position);
|
||||
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
Y = _position + ShrinkBy / 2;
|
||||
}
|
||||
else
|
||||
{
|
||||
X = _position + ShrinkBy / 2;
|
||||
}
|
||||
|
||||
Layout ();
|
||||
}
|
||||
|
||||
private int ClampPosition (int newPosittion)
|
||||
{
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
return Math.Clamp (newPosittion, 0, Math.Max (0, ViewportDimension - Viewport.Height));
|
||||
}
|
||||
|
||||
return Math.Clamp (newPosittion, 0, Math.Max (0, ViewportDimension - Viewport.Width));
|
||||
}
|
||||
|
||||
private void RaisePositionChangeEvents (int newPosition)
|
||||
{
|
||||
if (OnPositionChanging (_position, newPosition))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
CancelEventArgs<int> args = new (ref _position, ref newPosition);
|
||||
PositionChanging?.Invoke (this, args);
|
||||
|
||||
if (args.Cancel)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
int distance = newPosition - _position;
|
||||
MoveToPosition (newPosition);
|
||||
|
||||
OnPositionChanged (_position);
|
||||
PositionChanged?.Invoke (this, new (in _position));
|
||||
|
||||
OnScrolled (distance);
|
||||
Scrolled?.Invoke (this, new (in distance));
|
||||
|
||||
RaiseSelecting (new (Command.Select, null, null, distance));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called when <see cref="Position"/> is changing. Return true to cancel the change.
|
||||
/// </summary>
|
||||
protected virtual bool OnPositionChanging (int currentPos, int newPos) { return false; }
|
||||
|
||||
/// <summary>
|
||||
/// Raised when the <see cref="Position"/> is changing. Set <see cref="CancelEventArgs.Cancel"/> to
|
||||
/// <see langword="true"/> to prevent the position from being changed.
|
||||
/// </summary>
|
||||
public event EventHandler<CancelEventArgs<int>>? PositionChanging;
|
||||
|
||||
/// <summary>Called when <see cref="Position"/> has changed.</summary>
|
||||
protected virtual void OnPositionChanged (int position) { }
|
||||
|
||||
/// <summary>Raised when the <see cref="Position"/> has changed.</summary>
|
||||
public event EventHandler<EventArgs<int>>? PositionChanged;
|
||||
|
||||
/// <summary>Called when <see cref="Position"/> has changed. Indicates how much to scroll.</summary>
|
||||
protected virtual void OnScrolled (int distance) { }
|
||||
|
||||
/// <summary>Raised when the <see cref="Position"/> has changed. Indicates how much to scroll.</summary>
|
||||
public event EventHandler<EventArgs<int>>? Scrolled;
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override bool OnDrawingText ()
|
||||
{
|
||||
if (!ShowPercent)
|
||||
{
|
||||
Text = string.Empty;
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
if (SuperView is null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
Text = $"{(int)Math.Round ((double)Viewport.Height / SuperView!.GetContentSize ().Height * 100)}%";
|
||||
}
|
||||
else
|
||||
{
|
||||
Text = $"{(int)Math.Round ((double)Viewport.Width / SuperView!.GetContentSize ().Width * 100)}%";
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override Attribute GetNormalColor () { return base.GetHotNormalColor (); }
|
||||
|
||||
///// <inheritdoc/>
|
||||
private int _lastLocation = -1;
|
||||
|
||||
public int ShrinkBy { get; set; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override bool OnMouseEvent (MouseEventArgs mouseEvent)
|
||||
{
|
||||
if (SuperView is null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (mouseEvent.IsSingleDoubleOrTripleClicked)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
int location = (Orientation == Orientation.Vertical ? mouseEvent.Position.Y : mouseEvent.Position.X) + ShrinkBy / 2;
|
||||
int offset = _lastLocation > -1 ? location - _lastLocation : 0;
|
||||
int superViewDimension = ViewportDimension;
|
||||
|
||||
if (mouseEvent.IsPressed || mouseEvent.IsReleased)
|
||||
{
|
||||
if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed) && _lastLocation == -1)
|
||||
{
|
||||
if (Application.MouseGrabView != this)
|
||||
{
|
||||
Application.GrabMouse (this);
|
||||
_lastLocation = location;
|
||||
}
|
||||
}
|
||||
else if (mouseEvent.Flags == (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))
|
||||
{
|
||||
if (Orientation == Orientation.Vertical)
|
||||
{
|
||||
Y = Frame.Y + offset < ShrinkBy / 2
|
||||
? ShrinkBy / 2
|
||||
: Frame.Y + offset + Frame.Height > superViewDimension
|
||||
? Math.Max (superViewDimension - Frame.Height + ShrinkBy, 1)
|
||||
: Frame.Y + offset;
|
||||
}
|
||||
else
|
||||
{
|
||||
X = Frame.X + offset < ShrinkBy / 2
|
||||
? ShrinkBy / 2
|
||||
: Frame.X + offset + Frame.Height > superViewDimension
|
||||
? Math.Max (superViewDimension - Frame.Height + ShrinkBy / 2, 1)
|
||||
: Frame.X + offset;
|
||||
}
|
||||
}
|
||||
else if (mouseEvent.Flags == MouseFlags.Button1Released)
|
||||
{
|
||||
_lastLocation = -1;
|
||||
|
||||
if (Application.MouseGrabView == this)
|
||||
{
|
||||
Application.UngrabMouse ();
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public bool EnableForDesign ()
|
||||
{
|
||||
OrientationChanged += (sender, args) =>
|
||||
{
|
||||
if (args.CurrentValue == Orientation.Vertical)
|
||||
{
|
||||
Width = Dim.Fill ();
|
||||
Height = 5;
|
||||
}
|
||||
else
|
||||
{
|
||||
Width = 5;
|
||||
Height = Dim.Fill ();
|
||||
}
|
||||
};
|
||||
|
||||
Orientation = Orientation.Horizontal;
|
||||
ShowPercent = true;
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user