//
// ScrollView.cs: ScrollView and ScrollBarView views.
//
// Authors:
// Miguel de Icaza (miguel@gnome.org)
//
//
// TODO:
// - focus in scrollview
// - focus handling in scrollview to auto scroll to focused view
// - Raise events
// - Perhaps allow an option to not display the scrollbar arrow indicators?
using System;
using System.Reflection;
namespace Terminal.Gui {
///
/// ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
///
///
///
/// The scrollbar is drawn to be a representation of the Size, assuming that the
/// scroll position is set at Position.
///
///
/// If the region to display the scrollbar is larger than three characters,
/// arrow indicators are drawn.
///
///
public class ScrollBarView : View {
bool vertical = false;
int size = 0, position = 0;
///
/// If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
///
public bool IsVertical {
get => vertical;
set {
vertical = value;
SetNeedsDisplay ();
}
}
///
/// The size of content the scrollbar represents.
///
/// The size.
/// The is typically the size of the virtual content. E.g. when a Scrollbar is
/// part of a the Size is set to the appropriate dimension of .
public int Size {
get => size;
set {
size = value;
SetNeedsDisplay ();
}
}
///
/// This event is raised when the position on the scrollbar has changed.
///
public event Action ChangedPosition;
///
/// The position, relative to , to set the scrollbar at.
///
/// The position.
public int Position {
get => position;
set {
position = value;
SetNeedsDisplay ();
}
}
///
/// Get or sets the view that host this
///
public ScrollView Host { get; internal set; }
void SetPosition (int newPos)
{
Position = newPos;
ChangedPosition?.Invoke ();
}
///
/// Initializes a new instance of the class using layout.
///
/// Frame for the scrollbar.
public ScrollBarView (Rect rect) : this (rect, 0, 0, false) { }
///
/// Initializes a new instance of the class using layout.
///
/// Frame for the scrollbar.
/// The size that this scrollbar represents. Sets the property.
/// The position within this scrollbar. Sets the property.
/// If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the property.
public ScrollBarView (Rect rect, int size, int position, bool isVertical) : base (rect)
{
Init (size, position, isVertical);
}
///
/// Initializes a new instance of the class using layout.
///
public ScrollBarView () : this (0, 0, false) { }
///
/// Initializes a new instance of the class using layout.
///
/// The size that this scrollbar represents.
/// The position within this scrollbar.
/// If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
public ScrollBarView (int size, int position, bool isVertical) : base ()
{
Init (size, position, isVertical);
}
void Init (int size, int position, bool isVertical)
{
vertical = isVertical;
this.position = position;
this.size = size;
WantContinuousButtonPressed = true;
}
int posTopTee;
int posLeftTee;
int posBottomTee;
int posRightTee;
///
public override void Redraw (Rect region)
{
if (ColorScheme == null || Size == 0)
return;
Driver.SetAttribute (ColorScheme.Normal);
if (Bounds.Height == 0) {
return;
}
if (vertical) {
if (region.Right < Bounds.Width - 1)
return;
var col = Bounds.Width - 1;
var bh = Bounds.Height;
Rune special;
if (bh < 4) {
var by1 = position * bh / Size;
var by2 = (position + bh) * bh / Size;
Move (col, 0);
if (Bounds.Height == 1) {
Driver.AddRune (Driver.Diamond);
} else {
Driver.AddRune (Driver.UpArrow);
}
if (Bounds.Height == 3) {
Move (col, 1);
Driver.AddRune (Driver.Diamond);
}
if (Bounds.Height > 1) {
Move (col, Bounds.Height - 1);
Driver.AddRune (Driver.DownArrow);
}
} else {
bh -= 2;
var by1 = position * bh / Size;
var by2 = Host.KeepContentAlwaysInViewport ? Math.Min (((position + bh) * bh / Size) + 1, bh - 1) : (position + bh) * bh / Size;
if (Host.KeepContentAlwaysInViewport && by1 == by2) {
by1 = Math.Max (by1 - 1, 0);
}
Move (col, 0);
Driver.AddRune (Driver.UpArrow);
Move (col, Bounds.Height - 1);
Driver.AddRune (Driver.DownArrow);
bool hasTopTee = false;
bool hasDiamond = false;
bool hasBottomTee = false;
for (int y = 0; y < bh; y++) {
Move (col, y + 1);
if ((y < by1 || y > by2) && ((position > 0 && !hasTopTee) || (hasTopTee && hasBottomTee))) {
special = Driver.Stipple;
} else {
if (y != by2 && y > 1 && by2 - by1 == 0 && by1 < bh - 1 && hasTopTee && !hasDiamond) {
hasDiamond = true;
special = Driver.Diamond;
} else {
if (y == by1 && !hasTopTee) {
hasTopTee = true;
posTopTee = y;
special = Driver.TopTee;
} else if ((position == 0 && y == bh - 1 || y >= by2 || by2 == 0) && !hasBottomTee) {
hasBottomTee = true;
posBottomTee = y;
special = Driver.BottomTee;
} else {
special = Driver.VLine;
}
}
}
Driver.AddRune (special);
}
if (!hasTopTee) {
Move (col, Bounds.Height - 2);
Driver.AddRune (Driver.TopTee);
}
}
} else {
if (region.Bottom < Bounds.Height - 1)
return;
var row = Bounds.Height - 1;
var bw = Bounds.Width;
Rune special;
if (bw < 4) {
var bx1 = position * bw / Size;
var bx2 = (position + bw) * bw / Size;
Move (0, row);
Driver.AddRune (Driver.LeftArrow);
Driver.AddRune (Driver.RightArrow);
} else {
bw -= 2;
var bx1 = position * bw / Size;
var bx2 = Host.KeepContentAlwaysInViewport ? Math.Min (((position + bw) * bw / Size) + 1, bw - 1) : (position + bw) * bw / Size;
if (Host.KeepContentAlwaysInViewport && bx1 == bx2) {
bx1 = Math.Max (bx1 - 1, 0);
}
Move (0, row);
Driver.AddRune (Driver.LeftArrow);
bool hasLeftTee = false;
bool hasDiamond = false;
bool hasRightTee = false;
for (int x = 0; x < bw; x++) {
if ((x < bx1 || x >= bx2 + 1) && ((position > 0 && !hasLeftTee) || (hasLeftTee && hasRightTee))) {
special = Driver.Stipple;
} else {
if (x != bx2 && x > 1 && bx2 - bx1 == 0 && bx1 < bw - 1 && hasLeftTee && !hasDiamond) {
hasDiamond = true;
special = Driver.Diamond;
} else {
if (x == bx1 && !hasLeftTee) {
hasLeftTee = true;
posLeftTee = x;
special = Driver.LeftTee;
} else if ((position == 0 && x == bw - 1 || x >= bx2 || bx2 == 0) && !hasRightTee) {
hasRightTee = true;
posRightTee = x;
special = Driver.RightTee;
} else {
special = Driver.HLine;
}
}
}
Driver.AddRune (special);
}
if (!hasLeftTee) {
Move (Bounds.Width -2, row);
Driver.AddRune (Driver.LeftTee);
}
Driver.AddRune (Driver.RightArrow);
}
}
}
///
public override bool MouseEvent (MouseEvent me)
{
if (me.Flags != MouseFlags.Button1Pressed && me.Flags != MouseFlags.Button1Clicked &&
!me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition)) {
return false;
}
int location = vertical ? me.Y : me.X;
int barsize = vertical ? Bounds.Height : Bounds.Width;
int posTopLeftTee = vertical ? posTopTee : posLeftTee;
int posBottomRightTee = vertical ? posBottomTee : posRightTee;
barsize -= 2;
var pos = Position;
if (location == 0) {
if (pos > 0) {
SetPosition (pos - 1);
}
} else if (location == barsize + 1) {
if (Host.CanScroll (1, out _, vertical)) {
SetPosition (pos + 1);
}
} else if (location > 0 && location < barsize + 1) {
var b1 = pos * barsize / Size;
var b2 = Host.KeepContentAlwaysInViewport ? Math.Min (((pos + barsize) * barsize / Size) + 1, barsize - 1) : (pos + barsize) * barsize / Size;
if (Host.KeepContentAlwaysInViewport && b1 == b2) {
b1 = Math.Max (b1 - 1, 0);
}
if (location > b2 + 1 && location > posTopLeftTee && location > b1 && location > posBottomRightTee && posBottomRightTee > 0) {
Host.CanScroll (location, out int nv, vertical);
if (nv > 0) {
SetPosition (Math.Min (pos + nv, Size));
}
} else if (location <= b1) {
SetPosition (Math.Max (pos - barsize - location, 0));
}
}
return true;
}
}
///
/// Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
///
///
///
/// The subviews that are added to this are offset by the
/// property. The view itself is a window into the
/// space represented by the .
///
///
/// Use the
///
///
public class ScrollView : View {
View contentView = null;
ScrollBarView vertical, horizontal;
///
/// Initializes a new instance of the class using positioning.
///
///
public ScrollView (Rect frame) : base (frame)
{
Init (frame);
}
///
/// Initializes a new instance of the class using positioning.
///
public ScrollView () : base ()
{
Init (new Rect (0, 0, 0, 0));
}
void Init (Rect frame)
{
contentView = new View (frame);
vertical = new ScrollBarView (1, 0, isVertical: true) {
X = Pos.AnchorEnd (1),
Y = 0,
Width = 1,
Height = Dim.Fill (showHorizontalScrollIndicator ? 1 : 0)
};
vertical.ChangedPosition += delegate {
ContentOffset = new Point (ContentOffset.X, vertical.Position);
};
vertical.Host = this;
horizontal = new ScrollBarView (1, 0, isVertical: false) {
X = 0,
Y = Pos.AnchorEnd (1),
Width = Dim.Fill (showVerticalScrollIndicator ? 1 : 0),
Height = 1
};
horizontal.ChangedPosition += delegate {
ContentOffset = new Point (horizontal.Position, ContentOffset.Y);
};
horizontal.Host = this;
base.Add (contentView);
CanFocus = true;
MouseEnter += View_MouseEnter;
MouseLeave += View_MouseLeave;
}
Size contentSize;
Point contentOffset;
bool showHorizontalScrollIndicator;
bool showVerticalScrollIndicator;
bool keepContentAlwaysInViewport = true;
///
/// Represents the contents of the data shown inside the scrolview
///
/// The size of the content.
public Size ContentSize {
get {
return contentSize;
}
set {
if (contentSize != value) {
contentSize = value;
contentView.Frame = new Rect (contentOffset, value);
vertical.Size = contentSize.Height;
horizontal.Size = contentSize.Width;
SetNeedsDisplay ();
}
}
}
///
/// Represents the top left corner coordinate that is displayed by the scrollview
///
/// The content offset.
public Point ContentOffset {
get {
return contentOffset;
}
set {
contentOffset = new Point (-Math.Abs (value.X), -Math.Abs (value.Y));
contentView.Frame = new Rect (contentOffset, contentSize);
vertical.Position = Math.Max (0, -contentOffset.Y);
horizontal.Position = Math.Max (0, -contentOffset.X);
SetNeedsDisplay ();
}
}
///
/// If true the vertical/horizontal scroll bars won't be showed if it's not needed.
///
public bool AutoHideScrollBars { get; set; } = true;
///
/// Get or sets if the view-port is kept always visible in the area of this
///
public bool KeepContentAlwaysInViewport {
get { return keepContentAlwaysInViewport; }
set {
if (keepContentAlwaysInViewport != value) {
keepContentAlwaysInViewport = value;
Point p = default;
if (value && -contentOffset.X + Bounds.Width > contentSize.Width) {
p = new Point (contentSize.Width - Bounds.Width + (showVerticalScrollIndicator ? 1 : 0), -contentOffset.Y);
}
if (value && -contentOffset.Y + Bounds.Height > contentSize.Height) {
if (p == default) {
p = new Point (-contentOffset.X, contentSize.Height - Bounds.Height + (showHorizontalScrollIndicator ? 1 : 0));
} else {
p.Y = contentSize.Height - Bounds.Height + (showHorizontalScrollIndicator ? 1 : 0);
}
}
if (p != default) {
ContentOffset = p;
}
}
}
}
///
/// Adds the view to the scrollview.
///
/// The view to add to the scrollview.
public override void Add (View view)
{
if (!IsOverridden (view)) {
view.MouseEnter += View_MouseEnter;
view.MouseLeave += View_MouseLeave;
}
contentView.Add (view);
SetNeedsLayout ();
}
void View_MouseLeave (MouseEventArgs e)
{
Application.UngrabMouse ();
}
void View_MouseEnter (MouseEventArgs e)
{
Application.GrabMouse (this);
}
bool IsOverridden (View view)
{
Type t = view.GetType ();
MethodInfo m = t.GetMethod ("MouseEvent");
return m.DeclaringType == t && m.GetBaseDefinition ().DeclaringType == typeof (Responder);
}
///
/// Gets or sets the visibility for the horizontal scroll indicator.
///
/// true if show horizontal scroll indicator; otherwise, false.
public bool ShowHorizontalScrollIndicator {
get => showHorizontalScrollIndicator;
set {
if (value == showHorizontalScrollIndicator)
return;
showHorizontalScrollIndicator = value;
SetNeedsLayout ();
if (value) {
base.Add (horizontal);
horizontal.MouseEnter += View_MouseEnter;
horizontal.MouseLeave += View_MouseLeave;
} else {
Remove (horizontal);
horizontal.MouseEnter -= View_MouseEnter;
horizontal.MouseLeave -= View_MouseLeave;
}
vertical.Height = Dim.Fill (showHorizontalScrollIndicator ? 1 : 0);
}
}
///
/// Removes all widgets from this container.
///
///
///
public override void RemoveAll ()
{
contentView.RemoveAll ();
}
///
/// /// Gets or sets the visibility for the vertical scroll indicator.
///
/// true if show vertical scroll indicator; otherwise, false.
public bool ShowVerticalScrollIndicator {
get => showVerticalScrollIndicator;
set {
if (value == showVerticalScrollIndicator)
return;
showVerticalScrollIndicator = value;
SetNeedsLayout ();
if (value) {
base.Add (vertical);
vertical.MouseEnter += View_MouseEnter;
vertical.MouseLeave += View_MouseLeave;
} else {
Remove (vertical);
vertical.MouseEnter -= View_MouseEnter;
vertical.MouseLeave -= View_MouseLeave;
}
horizontal.Width = Dim.Fill (showVerticalScrollIndicator ? 1 : 0);
}
}
///
public override void Redraw (Rect region)
{
Driver.SetAttribute (ColorScheme.Normal);
SetViewsNeedsDisplay ();
Clear ();
var savedClip = ClipToBounds ();
OnDrawContent (new Rect (ContentOffset,
new Size (Math.Max (Bounds.Width - (ShowVerticalScrollIndicator ? 1 : 0), 0),
Math.Max (Bounds.Height - (ShowHorizontalScrollIndicator ? 1 : 0), 0))));
contentView.Redraw (contentView.Frame);
Driver.Clip = savedClip;
if (AutoHideScrollBars) {
ShowHideScrollBars ();
} else {
if (ShowVerticalScrollIndicator) {
vertical.Redraw (vertical.Bounds);
}
if (ShowHorizontalScrollIndicator) {
horizontal.Redraw (horizontal.Bounds);
}
}
// Fill in the bottom left corner
if (ShowVerticalScrollIndicator && ShowHorizontalScrollIndicator) {
AddRune (Bounds.Width - 1, Bounds.Height - 1, ' ');
}
Driver.SetAttribute (ColorScheme.Normal);
}
void ShowHideScrollBars ()
{
bool v = false, h = false; bool p = false;
if (Bounds.Height == 0 || Bounds.Height > contentSize.Height) {
if (ShowVerticalScrollIndicator) {
ShowVerticalScrollIndicator = false;
}
v = false;
} else if (Bounds.Height > 0 && Bounds.Height == contentSize.Height) {
p = true;
} else {
if (!ShowVerticalScrollIndicator) {
ShowVerticalScrollIndicator = true;
}
v = true;
}
if (Bounds.Width == 0 || Bounds.Width > contentSize.Width) {
if (ShowHorizontalScrollIndicator) {
ShowHorizontalScrollIndicator = false;
}
h = false;
} else if (Bounds.Width > 0 && Bounds.Width == contentSize.Width && p) {
if (ShowHorizontalScrollIndicator) {
ShowHorizontalScrollIndicator = false;
}
h = false;
if (ShowVerticalScrollIndicator) {
ShowVerticalScrollIndicator = false;
}
v = false;
} else {
if (p) {
if (!ShowVerticalScrollIndicator) {
ShowVerticalScrollIndicator = true;
}
v = true;
}
if (!ShowHorizontalScrollIndicator) {
ShowHorizontalScrollIndicator = true;
}
h = true;
}
vertical.Height = Dim.Fill (h ? 1 : 0);
horizontal.Width = Dim.Fill (v ? 1 : 0);
if (v) {
vertical.SetRelativeLayout (Bounds);
vertical.Redraw (vertical.Bounds);
}
if (h) {
horizontal.SetRelativeLayout (Bounds);
horizontal.Redraw (horizontal.Bounds);
}
}
void SetViewsNeedsDisplay ()
{
foreach (View view in contentView) {
view.SetNeedsDisplay ();
}
}
///
public override void PositionCursor ()
{
if (InternalSubviews.Count == 0)
Move (0, 0);
else
base.PositionCursor ();
}
///
/// Scrolls the view up.
///
/// true, if left was scrolled, false otherwise.
/// Number of lines to scroll.
public bool ScrollUp (int lines)
{
if (contentOffset.Y < 0) {
ContentOffset = new Point (contentOffset.X, Math.Min (contentOffset.Y + lines, 0));
return true;
}
return false;
}
///
/// Scrolls the view to the left
///
/// true, if left was scrolled, false otherwise.
/// Number of columns to scroll by.
public bool ScrollLeft (int cols)
{
if (contentOffset.X < 0) {
ContentOffset = new Point (Math.Min (contentOffset.X + cols, 0), contentOffset.Y);
return true;
}
return false;
}
///
/// Scrolls the view down.
///
/// true, if left was scrolled, false otherwise.
/// Number of lines to scroll.
public bool ScrollDown (int lines)
{
if (CanScroll (lines, out _, true)) {
ContentOffset = new Point (contentOffset.X, contentOffset.Y - lines);
return true;
}
return false;
}
///
/// Scrolls the view to the right.
///
/// true, if right was scrolled, false otherwise.
/// Number of columns to scroll by.
public bool ScrollRight (int cols)
{
if (CanScroll (cols, out _)) {
ContentOffset = new Point (contentOffset.X - cols, contentOffset.Y);
return true;
}
return false;
}
internal bool CanScroll (int n, out int max, bool isVertical = false)
{
var size = isVertical ?
(KeepContentAlwaysInViewport ? Bounds.Height + (showHorizontalScrollIndicator ? -2 : -1) : 0) :
(KeepContentAlwaysInViewport ? Bounds.Width + (showVerticalScrollIndicator ? -2 : -1) : 0);
var cSize = isVertical ? -contentSize.Height : -contentSize.Width;
var cOffSet = isVertical ? contentOffset.Y : contentOffset.X;
var newSize = Math.Max (cSize, cOffSet - n);
max = cSize < newSize - size ? n : -cSize + (cOffSet - size) - 1;
if (cSize < newSize - size) {
return true;
}
return false;
}
///
public override bool ProcessKey (KeyEvent kb)
{
if (base.ProcessKey (kb))
return true;
switch (kb.Key) {
case Key.CursorUp:
return ScrollUp (1);
case (Key)'v' | Key.AltMask:
case Key.PageUp:
return ScrollUp (Bounds.Height);
case Key.ControlV:
case Key.PageDown:
return ScrollDown (Bounds.Height);
case Key.CursorDown:
return ScrollDown (1);
case Key.CursorLeft:
return ScrollLeft (1);
case Key.CursorRight:
return ScrollRight (1);
case Key.Home:
return ScrollUp (contentSize.Height);
case Key.End:
return ScrollDown (contentSize.Height);
}
return false;
}
///
public override bool MouseEvent (MouseEvent me)
{
if (me.Flags != MouseFlags.WheeledDown && me.Flags != MouseFlags.WheeledUp &&
me.Flags != MouseFlags.WheeledRight && me.Flags != MouseFlags.WheeledLeft &&
me.Flags != MouseFlags.Button1Pressed && me.Flags != MouseFlags.Button1Clicked &&
!me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition)) {
return false;
}
if (me.Flags == MouseFlags.WheeledDown && ShowVerticalScrollIndicator) {
ScrollDown (1);
} else if (me.Flags == MouseFlags.WheeledUp && ShowVerticalScrollIndicator) {
ScrollUp (1);
} else if (me.Flags == MouseFlags.WheeledRight && showHorizontalScrollIndicator) {
ScrollRight (1);
} else if (me.Flags == MouseFlags.WheeledLeft && ShowVerticalScrollIndicator) {
ScrollLeft (1);
} else if (me.X == vertical.Frame.X && ShowVerticalScrollIndicator) {
vertical.MouseEvent (me);
} else if (me.Y == horizontal.Frame.Y && ShowHorizontalScrollIndicator) {
horizontal.MouseEvent (me);
} else if (IsOverridden (me.View)) {
Application.UngrabMouse ();
return false;
}
return true;
}
///
protected override void Dispose (bool disposing)
{
if (!showVerticalScrollIndicator) {
// It was not added to SuperView, so it won't get disposed automatically
vertical?.Dispose ();
}
if (!showHorizontalScrollIndicator) {
// It was not added to SuperView, so it won't get disposed automatically
horizontal?.Dispose ();
}
base.Dispose (disposing);
}
}
}