123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014 |
- using System.Collections;
- using static Terminal.Gui.SpinnerStyle;
- namespace Terminal.Gui;
- /// <summary>Implement <see cref="IListDataSource"/> to provide custom rendering for a <see cref="ListView"/>.</summary>
- public interface IListDataSource
- {
- /// <summary>Returns the number of elements to display</summary>
- int Count { get; }
- /// <summary>Returns the maximum length of elements to display</summary>
- int Length { get; }
- /// <summary>Should return whether the specified item is currently marked.</summary>
- /// <returns><see langword="true"/>, if marked, <see langword="false"/> otherwise.</returns>
- /// <param name="item">Item index.</param>
- bool IsMarked (int item);
- /// <summary>This method is invoked to render a specified item, the method should cover the entire provided width.</summary>
- /// <returns>The render.</returns>
- /// <param name="container">The list view to render.</param>
- /// <param name="driver">The console driver to render.</param>
- /// <param name="selected">Describes whether the item being rendered is currently selected by the user.</param>
- /// <param name="item">The index of the item to render, zero for the first item and so on.</param>
- /// <param name="col">The column where the rendering will start</param>
- /// <param name="line">The line where the rendering will be done.</param>
- /// <param name="width">The width that must be filled out.</param>
- /// <param name="start">The index of the string to be displayed.</param>
- /// <remarks>
- /// The default color will be set before this method is invoked, and will be based on whether the item is selected
- /// or not.
- /// </remarks>
- void Render (
- ListView container,
- ConsoleDriver driver,
- bool selected,
- int item,
- int col,
- int line,
- int width,
- int start = 0
- );
- /// <summary>Flags the item as marked.</summary>
- /// <param name="item">Item index.</param>
- /// <param name="value">If set to <see langword="true"/> value.</param>
- void SetMark (int item, bool value);
- /// <summary>Return the source as IList.</summary>
- /// <returns></returns>
- IList ToList ();
- }
- /// <summary>
- /// ListView <see cref="View"/> renders a scrollable list of data where each item can be activated to perform an
- /// action.
- /// </summary>
- /// <remarks>
- /// <para>
- /// The <see cref="ListView"/> displays lists of data and allows the user to scroll through the data. Items in
- /// the can be activated firing an event (with the ENTER key or a mouse double-click). If the
- /// <see cref="AllowsMarking"/> property is true, elements of the list can be marked by the user.
- /// </para>
- /// <para>
- /// By default <see cref="ListView"/> uses <see cref="object.ToString"/> to render the items of any
- /// <see cref="IList"/> object (e.g. arrays, <see cref="List{T}"/>, and other collections). Alternatively, an
- /// object that implements <see cref="IListDataSource"/> can be provided giving full control of what is rendered.
- /// </para>
- /// <para>
- /// <see cref="ListView"/> can display any object that implements the <see cref="IList"/> interface.
- /// <see cref="string"/> values are converted into <see cref="string"/> values before rendering, and other values
- /// are converted into <see cref="string"/> by calling <see cref="object.ToString"/> and then converting to
- /// <see cref="string"/> .
- /// </para>
- /// <para>
- /// To change the contents of the ListView, set the <see cref="Source"/> property (when providing custom
- /// rendering via <see cref="IListDataSource"/>) or call <see cref="SetSource"/> an <see cref="IList"/> is being
- /// used.
- /// </para>
- /// <para>
- /// When <see cref="AllowsMarking"/> is set to true the rendering will prefix the rendered items with [x] or [ ]
- /// and bind the SPACE key to toggle the selection. To implement a different marking style set
- /// <see cref="AllowsMarking"/> to false and implement custom rendering.
- /// </para>
- /// <para>
- /// Searching the ListView with the keyboard is supported. Users type the first characters of an item, and the
- /// first item that starts with what the user types will be selected.
- /// </para>
- /// </remarks>
- public class ListView : View
- {
- private bool _allowsMarking;
- private bool _allowsMultipleSelection = true;
- private int _lastSelectedItem = -1;
- private int _selected = -1;
- private IListDataSource _source;
- // TODO: ListView has been upgraded to use Viewport and ContentSize instead of the
- // TODO: bespoke _top and _left. It was a quick & dirty port. There is now duplicate logic
- // TODO: that could be removed.
- //private int _top, _left;
- /// <summary>
- /// Initializes a new instance of <see cref="ListView"/>. Set the <see cref="Source"/> property to display
- /// something.
- /// </summary>
- public ListView ()
- {
- CanFocus = true;
- // Things this view knows how to do
- AddCommand (Command.LineUp, () => MoveUp ());
- AddCommand (Command.LineDown, () => MoveDown ());
- AddCommand (Command.ScrollUp, () => ScrollVertical (-1));
- AddCommand (Command.ScrollDown, () => ScrollVertical (1));
- AddCommand (Command.PageUp, () => MovePageUp ());
- AddCommand (Command.PageDown, () => MovePageDown ());
- AddCommand (Command.TopHome, () => MoveHome ());
- AddCommand (Command.BottomEnd, () => MoveEnd ());
- AddCommand (Command.Accept, () => OnOpenSelectedItem ());
- AddCommand (Command.OpenSelectedItem, () => OnOpenSelectedItem ());
- AddCommand (Command.Select, () => MarkUnmarkRow ());
- AddCommand (Command.ScrollLeft, () => ScrollHorizontal (-1));
- AddCommand (Command.ScrollRight, () => ScrollHorizontal (1));
- // Default keybindings for all ListViews
- KeyBindings.Add (Key.CursorUp, Command.LineUp);
- KeyBindings.Add (Key.P.WithCtrl, Command.LineUp);
- KeyBindings.Add (Key.CursorDown, Command.LineDown);
- KeyBindings.Add (Key.N.WithCtrl, Command.LineDown);
- KeyBindings.Add (Key.PageUp, Command.PageUp);
- KeyBindings.Add (Key.PageDown, Command.PageDown);
- KeyBindings.Add (Key.V.WithCtrl, Command.PageDown);
- KeyBindings.Add (Key.Home, Command.TopHome);
- KeyBindings.Add (Key.End, Command.BottomEnd);
- KeyBindings.Add (Key.Enter, Command.OpenSelectedItem);
- }
- /// <summary>Gets or sets whether this <see cref="ListView"/> allows items to be marked.</summary>
- /// <value>Set to <see langword="true"/> to allow marking elements of the list.</value>
- /// <remarks>
- /// If set to <see langword="true"/>, <see cref="ListView"/> will render items marked items with "[x]", and
- /// unmarked items with "[ ]" spaces. SPACE key will toggle marking. The default is <see langword="false"/>.
- /// </remarks>
- public bool AllowsMarking
- {
- get => _allowsMarking;
- set
- {
- _allowsMarking = value;
- if (_allowsMarking)
- {
- KeyBindings.Add (Key.Space, Command.Select);
- }
- else
- {
- KeyBindings.Remove (Key.Space);
- }
- SetNeedsDisplay ();
- }
- }
- /// <summary>
- /// If set to <see langword="true"/> more than one item can be selected. If <see langword="false"/> selecting an
- /// item will cause all others to be un-selected. The default is <see langword="false"/>.
- /// </summary>
- public bool AllowsMultipleSelection
- {
- get => _allowsMultipleSelection;
- set
- {
- _allowsMultipleSelection = value;
- if (Source is { } && !_allowsMultipleSelection)
- {
- // Clear all selections except selected
- for (var i = 0; i < Source.Count; i++)
- {
- if (Source.IsMarked (i) && i != _selected)
- {
- Source.SetMark (i, false);
- }
- }
- }
- SetNeedsDisplay ();
- }
- }
- /// <summary>
- /// Gets the <see cref="CollectionNavigator"/> that searches the <see cref="ListView.Source"/> collection as the
- /// user types.
- /// </summary>
- public CollectionNavigator KeystrokeNavigator { get; } = new ();
- /// <summary>Gets or sets the leftmost column that is currently visible (when scrolling horizontally).</summary>
- /// <value>The left position.</value>
- public int LeftItem
- {
- get => Viewport.X;
- set
- {
- if (_source is null)
- {
- return;
- }
- if (value < 0 || (MaxLength > 0 && value >= MaxLength))
- {
- throw new ArgumentException ("value");
- }
- Viewport = Viewport with { X = value };
- SetNeedsDisplay ();
- }
- }
- /// <summary>Gets the widest item in the list.</summary>
- public int MaxLength => _source?.Length ?? 0;
- /// <summary>Gets or sets the index of the currently selected item.</summary>
- /// <value>The selected item.</value>
- public int SelectedItem
- {
- get => _selected;
- set
- {
- if (_source is null || _source.Count == 0)
- {
- return;
- }
- if (value < -1 || value >= _source.Count)
- {
- throw new ArgumentException ("value");
- }
- _selected = value;
- OnSelectedChanged ();
- }
- }
- /// <summary>Gets or sets the <see cref="IListDataSource"/> backing this <see cref="ListView"/>, enabling custom rendering.</summary>
- /// <value>The source.</value>
- /// <remarks>Use <see cref="SetSource"/> to set a new <see cref="IList"/> source.</remarks>
- public IListDataSource Source
- {
- get => _source;
- set
- {
- if (_source == value)
- {
- return;
- }
- _source = value;
- SetContentSize (new Size (_source?.Length ?? Viewport.Width, _source?.Count ?? Viewport.Width));
- if (IsInitialized)
- {
- Viewport = Viewport with { Y = 0 };
- }
- KeystrokeNavigator.Collection = _source?.ToList ();
- _selected = -1;
- _lastSelectedItem = -1;
- SetNeedsDisplay ();
- }
- }
- /// <summary>Gets or sets the index of the item that will appear at the top of the <see cref="View.Viewport"/>.</summary>
- /// <remarks>
- /// This a helper property for accessing <c>listView.Viewport.Y</c>.
- /// </remarks>
- /// <value>The top item.</value>
- public int TopItem
- {
- get => Viewport.Y;
- set
- {
- if (_source is null)
- {
- return;
- }
- Viewport = Viewport with { Y = value };
- }
- }
- /// <summary>
- /// If <see cref="AllowsMarking"/> and <see cref="AllowsMultipleSelection"/> are both <see langword="true"/>,
- /// unmarks all marked items other than the currently selected.
- /// </summary>
- /// <returns><see langword="true"/> if unmarking was successful.</returns>
- public virtual bool AllowsAll ()
- {
- if (!_allowsMarking)
- {
- return false;
- }
- if (!AllowsMultipleSelection)
- {
- for (var i = 0; i < Source.Count; i++)
- {
- if (Source.IsMarked (i) && i != _selected)
- {
- Source.SetMark (i, false);
- return true;
- }
- }
- }
- return true;
- }
- /// <summary>Ensures the selected item is always visible on the screen.</summary>
- public void EnsureSelectedItemVisible ()
- {
- if (SuperView?.IsInitialized == true)
- {
- if (_selected < Viewport.Y)
- {
- // TODO: The Max check here is not needed because, by default, Viewport enforces staying w/in ContentArea (View.ScrollSettings).
- Viewport = Viewport with { Y = _selected };
- }
- else if (Viewport.Height > 0 && _selected >= Viewport.Y + Viewport.Height)
- {
- Viewport = Viewport with { Y = _selected - Viewport.Height + 1 };
- }
- LayoutStarted -= ListView_LayoutStarted;
- }
- else
- {
- LayoutStarted += ListView_LayoutStarted;
- }
- }
- /// <summary>Marks the <see cref="SelectedItem"/> if it is not already marked.</summary>
- /// <returns><see langword="true"/> if the <see cref="SelectedItem"/> was marked.</returns>
- public virtual bool MarkUnmarkRow ()
- {
- if (AllowsAll ())
- {
- Source.SetMark (SelectedItem, !Source.IsMarked (SelectedItem));
- SetNeedsDisplay ();
- return true;
- }
- return false;
- }
- /// <inheritdoc/>
- protected internal override bool OnMouseEvent (MouseEvent me)
- {
- if (!me.Flags.HasFlag (MouseFlags.Button1Clicked)
- && !me.Flags.HasFlag (MouseFlags.Button1DoubleClicked)
- && me.Flags != MouseFlags.WheeledDown
- && me.Flags != MouseFlags.WheeledUp
- && me.Flags != MouseFlags.WheeledRight
- && me.Flags != MouseFlags.WheeledLeft)
- {
- return false;
- }
- if (!HasFocus && CanFocus)
- {
- SetFocus ();
- }
- if (_source is null)
- {
- return false;
- }
- if (me.Flags == MouseFlags.WheeledDown)
- {
- ScrollVertical (1);
- return true;
- }
- if (me.Flags == MouseFlags.WheeledUp)
- {
- ScrollVertical (-1);
- return true;
- }
- if (me.Flags == MouseFlags.WheeledRight)
- {
- ScrollHorizontal (1);
- return true;
- }
- if (me.Flags == MouseFlags.WheeledLeft)
- {
- ScrollHorizontal (-1);
- return true;
- }
- if (me.Position.Y + Viewport.Y >= _source.Count
- || me.Position.Y + Viewport.Y < 0
- || me.Position.Y + Viewport.Y > Viewport.Y + Viewport.Height)
- {
- return true;
- }
- _selected = Viewport.Y + me.Position.Y;
- if (AllowsAll ())
- {
- Source.SetMark (SelectedItem, !Source.IsMarked (SelectedItem));
- SetNeedsDisplay ();
- return true;
- }
- OnSelectedChanged ();
- SetNeedsDisplay ();
- if (me.Flags == MouseFlags.Button1DoubleClicked)
- {
- OnOpenSelectedItem ();
- }
- return true;
- }
- /// <summary>Changes the <see cref="SelectedItem"/> to the next item in the list, scrolling the list if needed.</summary>
- /// <returns></returns>
- public virtual bool MoveDown ()
- {
- if (_source is null || _source.Count == 0)
- {
- // Do we set lastSelectedItem to -1 here?
- return false; //Nothing for us to move to
- }
- if (_selected >= _source.Count)
- {
- // If for some reason we are currently outside of the
- // valid values range, we should select the bottommost valid value.
- // This can occur if the backing data source changes.
- _selected = _source.Count - 1;
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- else if (_selected + 1 < _source.Count)
- {
- //can move by down by one.
- _selected++;
- if (_selected >= Viewport.Y + Viewport.Height)
- {
- Viewport = Viewport with { Y = Viewport.Y + 1 };
- }
- else if (_selected < Viewport.Y)
- {
- Viewport = Viewport with { Y = _selected };
- }
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- else if (_selected == 0)
- {
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- else if (_selected >= Viewport.Y + Viewport.Height)
- {
- Viewport = Viewport with { Y = _source.Count - Viewport.Height };
- SetNeedsDisplay ();
- }
- return true;
- }
- /// <summary>Changes the <see cref="SelectedItem"/> to last item in the list, scrolling the list if needed.</summary>
- /// <returns></returns>
- public virtual bool MoveEnd ()
- {
- if (_source is { Count: > 0 } && _selected != _source.Count - 1)
- {
- _selected = _source.Count - 1;
- if (Viewport.Y + _selected > Viewport.Height - 1)
- {
- Viewport = Viewport with { Y = _selected };
- }
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- return true;
- }
- /// <summary>Changes the <see cref="SelectedItem"/> to the first item in the list, scrolling the list if needed.</summary>
- /// <returns></returns>
- public virtual bool MoveHome ()
- {
- if (_selected != 0)
- {
- _selected = 0;
- Viewport = Viewport with { Y = _selected };
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- return true;
- }
- /// <summary>
- /// Changes the <see cref="SelectedItem"/> to the item just below the bottom of the visible list, scrolling if
- /// needed.
- /// </summary>
- /// <returns></returns>
- public virtual bool MovePageDown ()
- {
- if (_source is null)
- {
- return true;
- }
- int n = _selected + Viewport.Height;
- if (n >= _source.Count)
- {
- n = _source.Count - 1;
- }
- if (n != _selected)
- {
- _selected = n;
- if (_source.Count >= Viewport.Height)
- {
- Viewport = Viewport with { Y = _selected };
- }
- else
- {
- Viewport = Viewport with { Y = 0 };
- }
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- return true;
- }
- /// <summary>Changes the <see cref="SelectedItem"/> to the item at the top of the visible list.</summary>
- /// <returns></returns>
- public virtual bool MovePageUp ()
- {
- int n = _selected - Viewport.Height;
- if (n < 0)
- {
- n = 0;
- }
- if (n != _selected)
- {
- _selected = n;
- Viewport = Viewport with { Y = _selected };
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- return true;
- }
- /// <summary>Changes the <see cref="SelectedItem"/> to the previous item in the list, scrolling the list if needed.</summary>
- /// <returns></returns>
- public virtual bool MoveUp ()
- {
- if (_source is null || _source.Count == 0)
- {
- // Do we set lastSelectedItem to -1 here?
- return false; //Nothing for us to move to
- }
- if (_selected >= _source.Count)
- {
- // If for some reason we are currently outside of the
- // valid values range, we should select the bottommost valid value.
- // This can occur if the backing data source changes.
- _selected = _source.Count - 1;
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- else if (_selected > 0)
- {
- _selected--;
- if (_selected > Source.Count)
- {
- _selected = Source.Count - 1;
- }
- if (_selected < Viewport.Y)
- {
- Viewport = Viewport with { Y = _selected };
- }
- else if (_selected > Viewport.Y + Viewport.Height)
- {
- Viewport = Viewport with { Y = _selected - Viewport.Height + 1 };
- }
- OnSelectedChanged ();
- SetNeedsDisplay ();
- }
- else if (_selected < Viewport.Y)
- {
- Viewport = Viewport with { Y = _selected };
- SetNeedsDisplay ();
- }
- return true;
- }
- /// <inheritdoc/>
- public override void OnDrawContent (Rectangle viewport)
- {
- base.OnDrawContent (viewport);
- Attribute current = ColorScheme.Focus;
- Driver.SetAttribute (current);
- Move (0, 0);
- Rectangle f = Viewport;
- int item = Viewport.Y;
- bool focused = HasFocus;
- int col = _allowsMarking ? 2 : 0;
- int start = Viewport.X;
- for (var row = 0; row < f.Height; row++, item++)
- {
- bool isSelected = item == _selected;
- Attribute newcolor = focused ? isSelected ? ColorScheme.Focus : GetNormalColor () :
- isSelected ? ColorScheme.HotNormal : GetNormalColor ();
- if (newcolor != current)
- {
- Driver.SetAttribute (newcolor);
- current = newcolor;
- }
- Move (0, row);
- if (_source is null || item >= _source.Count)
- {
- for (var c = 0; c < f.Width; c++)
- {
- Driver.AddRune ((Rune)' ');
- }
- }
- else
- {
- var rowEventArgs = new ListViewRowEventArgs (item);
- OnRowRender (rowEventArgs);
- if (rowEventArgs.RowAttribute is { } && current != rowEventArgs.RowAttribute)
- {
- current = (Attribute)rowEventArgs.RowAttribute;
- Driver.SetAttribute (current);
- }
- if (_allowsMarking)
- {
- Driver.AddRune (
- _source.IsMarked (item) ? AllowsMultipleSelection ? Glyphs.Checked : Glyphs.Selected :
- AllowsMultipleSelection ? Glyphs.UnChecked : Glyphs.UnSelected
- );
- Driver.AddRune ((Rune)' ');
- }
- Source.Render (this, Driver, isSelected, item, col, row, f.Width - col, start);
- }
- }
- }
- /// <inheritdoc/>
- public override bool OnEnter (View view)
- {
- if (_lastSelectedItem != _selected)
- {
- EnsureSelectedItemVisible ();
- }
- return base.OnEnter (view);
- }
- // TODO: This should be cancelable
- /// <summary>Invokes the <see cref="OpenSelectedItem"/> event if it is defined.</summary>
- /// <returns><see langword="true"/> if the <see cref="OpenSelectedItem"/> event was fired.</returns>
- public bool OnOpenSelectedItem ()
- {
- if (_source is null || _source.Count <= _selected || _selected < 0 || OpenSelectedItem is null)
- {
- return false;
- }
- object value = _source.ToList () [_selected];
- // By default, Command.Accept calls OnAccept, so we need to call it here to ensure that the event is fired.
- if (OnAccept () == true)
- {
- return true;
- }
- OpenSelectedItem?.Invoke (this, new ListViewItemEventArgs (_selected, value));
- return true;
- }
- /// <inheritdoc/>
- public override bool OnProcessKeyDown (Key a)
- {
- // Enable user to find & select an item by typing text
- if (CollectionNavigatorBase.IsCompatibleKey (a))
- {
- int? newItem = KeystrokeNavigator?.GetNextMatchingItem (SelectedItem, (char)a);
- if (newItem is int && newItem != -1)
- {
- SelectedItem = (int)newItem;
- EnsureSelectedItemVisible ();
- SetNeedsDisplay ();
- return true;
- }
- }
- return false;
- }
- /// <summary>Virtual method that will invoke the <see cref="RowRender"/>.</summary>
- /// <param name="rowEventArgs"></param>
- public virtual void OnRowRender (ListViewRowEventArgs rowEventArgs) { RowRender?.Invoke (this, rowEventArgs); }
- /// <summary>Invokes the <see cref="SelectedItemChanged"/> event if it is defined.</summary>
- /// <returns></returns>
- public virtual bool OnSelectedChanged ()
- {
- if (_selected != _lastSelectedItem)
- {
- object value = _source?.Count > 0 ? _source.ToList () [_selected] : null;
- SelectedItemChanged?.Invoke (this, new ListViewItemEventArgs (_selected, value));
- _lastSelectedItem = _selected;
- EnsureSelectedItemVisible ();
- return true;
- }
- return false;
- }
- /// <summary>This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.</summary>
- public event EventHandler<ListViewItemEventArgs> OpenSelectedItem;
- /// <inheritdoc/>
- public override Point? PositionCursor ()
- {
- int x = 0;
- int y = _selected - Viewport.Y;
- if (!_allowsMarking)
- {
- x = Viewport.Width - 1;
- }
- Move (x, y);
- return null; // Don't show the cursor
- }
- /// <summary>This event is invoked when this <see cref="ListView"/> is being drawn before rendering.</summary>
- public event EventHandler<ListViewRowEventArgs> RowRender;
- /// <summary>This event is raised when the selected item in the <see cref="ListView"/> has changed.</summary>
- public event EventHandler<ListViewItemEventArgs> SelectedItemChanged;
- /// <summary>Sets the source of the <see cref="ListView"/> to an <see cref="IList"/>.</summary>
- /// <value>An object implementing the IList interface.</value>
- /// <remarks>
- /// Use the <see cref="Source"/> property to set a new <see cref="IListDataSource"/> source and use custome
- /// rendering.
- /// </remarks>
- public void SetSource (IList source)
- {
- if (source is null && (Source is null || !(Source is ListWrapper)))
- {
- Source = null;
- }
- else
- {
- Source = new ListWrapper (source);
- }
- }
- /// <summary>Sets the source to an <see cref="IList"/> value asynchronously.</summary>
- /// <value>An item implementing the IList interface.</value>
- /// <remarks>
- /// Use the <see cref="Source"/> property to set a new <see cref="IListDataSource"/> source and use custom
- /// rendering.
- /// </remarks>
- public Task SetSourceAsync (IList source)
- {
- return Task.Factory.StartNew (
- () =>
- {
- if (source is null && (Source is null || !(Source is ListWrapper)))
- {
- Source = null;
- }
- else
- {
- Source = new ListWrapper (source);
- }
- return source;
- },
- CancellationToken.None,
- TaskCreationOptions.DenyChildAttach,
- TaskScheduler.Default
- );
- }
- private void ListView_LayoutStarted (object sender, LayoutEventArgs e) { EnsureSelectedItemVisible (); }
- }
- /// <summary>
- /// Provides a default implementation of <see cref="IListDataSource"/> that renders <see cref="ListView"/> items
- /// using <see cref="object.ToString()"/>.
- /// </summary>
- public class ListWrapper : IListDataSource
- {
- private readonly int _count;
- private readonly BitArray _marks;
- private readonly IList _source;
- /// <inheritdoc/>
- public ListWrapper (IList source)
- {
- if (source is { })
- {
- _count = source.Count;
- _marks = new BitArray (_count);
- _source = source;
- Length = GetMaxLengthItem ();
- }
- }
- /// <inheritdoc/>
- public int Count => _source is { } ? _source.Count : 0;
- /// <inheritdoc/>
- public int Length { get; }
- /// <inheritdoc/>
- public void Render (
- ListView container,
- ConsoleDriver driver,
- bool marked,
- int item,
- int col,
- int line,
- int width,
- int start = 0
- )
- {
- container.Move (Math.Max (col - start, 0), line);
- object t = _source? [item];
- if (t is null)
- {
- RenderUstr (driver, "", col, line, width);
- }
- else
- {
- if (t is string u)
- {
- RenderUstr (driver, u, col, line, width, start);
- }
- else if (t is string s)
- {
- RenderUstr (driver, s, col, line, width, start);
- }
- else
- {
- RenderUstr (driver, t.ToString (), col, line, width, start);
- }
- }
- }
- /// <inheritdoc/>
- public bool IsMarked (int item)
- {
- if (item >= 0 && item < _count)
- {
- return _marks [item];
- }
- return false;
- }
- /// <inheritdoc/>
- public void SetMark (int item, bool value)
- {
- if (item >= 0 && item < _count)
- {
- _marks [item] = value;
- }
- }
- /// <inheritdoc/>
- public IList ToList () { return _source; }
- /// <inheritdoc/>
- public int StartsWith (string search)
- {
- if (_source is null || _source?.Count == 0)
- {
- return -1;
- }
- for (var i = 0; i < _source.Count; i++)
- {
- object t = _source [i];
- if (t is string u)
- {
- if (u.ToUpper ().StartsWith (search.ToUpperInvariant ()))
- {
- return i;
- }
- }
- else if (t is string s)
- {
- if (s.StartsWith (search, StringComparison.InvariantCultureIgnoreCase))
- {
- return i;
- }
- }
- }
- return -1;
- }
- private int GetMaxLengthItem ()
- {
- if (_source is null || _source?.Count == 0)
- {
- return 0;
- }
- var maxLength = 0;
- for (var i = 0; i < _source.Count; i++)
- {
- object t = _source [i];
- int l;
- if (t is string u)
- {
- l = u.GetColumns ();
- }
- else if (t is string s)
- {
- l = s.Length;
- }
- else
- {
- l = t.ToString ().Length;
- }
- if (l > maxLength)
- {
- maxLength = l;
- }
- }
- return maxLength;
- }
- private void RenderUstr (ConsoleDriver driver, string ustr, int col, int line, int width, int start = 0)
- {
- string str = start > ustr.GetColumns () ? string.Empty : ustr.Substring (Math.Min (start, ustr.ToRunes ().Length - 1));
- string u = TextFormatter.ClipAndJustify (str, width, Alignment.Start);
- driver.AddStr (u);
- width -= u.GetColumns ();
- while (width-- > 0)
- {
- driver.AddRune ((Rune)' ');
- }
- }
- }
|