ListViewTests.cs 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161
  1. using System.Collections;
  2. using System.Collections.ObjectModel;
  3. using System.Collections.Specialized;
  4. using System.ComponentModel;
  5. using Xunit.Abstractions;
  6. namespace Terminal.Gui.ViewsTests;
  7. public class ListViewTests (ITestOutputHelper output)
  8. {
  9. [Fact]
  10. public void Constructors_Defaults ()
  11. {
  12. var lv = new ListView ();
  13. Assert.Null (lv.Source);
  14. Assert.True (lv.CanFocus);
  15. Assert.Equal (-1, lv.SelectedItem);
  16. lv = new () { Source = new ListWrapper<string> (["One", "Two", "Three"]) };
  17. Assert.NotNull (lv.Source);
  18. Assert.Equal (-1, lv.SelectedItem);
  19. lv = new() { Source = new NewListDataSource () };
  20. Assert.NotNull (lv.Source);
  21. Assert.Equal (-1, lv.SelectedItem);
  22. lv = new()
  23. {
  24. Y = 1, Width = 10, Height = 20, Source = new ListWrapper<string> (["One", "Two", "Three"])
  25. };
  26. Assert.NotNull (lv.Source);
  27. Assert.Equal (-1, lv.SelectedItem);
  28. Assert.Equal (new (0, 1, 10, 20), lv.Frame);
  29. lv = new() { Y = 1, Width = 10, Height = 20, Source = new NewListDataSource () };
  30. Assert.NotNull (lv.Source);
  31. Assert.Equal (-1, lv.SelectedItem);
  32. Assert.Equal (new (0, 1, 10, 20), lv.Frame);
  33. }
  34. [Fact]
  35. [AutoInitShutdown]
  36. public void Ensures_Visibility_SelectedItem_On_MoveDown_And_MoveUp ()
  37. {
  38. ObservableCollection<string> source = [];
  39. for (var i = 0; i < 20; i++)
  40. {
  41. source.Add ($"Line{i}");
  42. }
  43. var lv = new ListView { Width = Dim.Fill (), Height = Dim.Fill (), Source = new ListWrapper<string> (source) };
  44. var win = new Window ();
  45. win.Add (lv);
  46. var top = new Toplevel ();
  47. top.Add (win);
  48. Application.Begin (top);
  49. ((FakeDriver)Application.Driver!).SetBufferSize (12, 12);
  50. Application.Refresh ();
  51. Assert.Equal (-1, lv.SelectedItem);
  52. TestHelpers.AssertDriverContentsWithFrameAre (
  53. @"
  54. ┌──────────┐
  55. │Line0 │
  56. │Line1 │
  57. │Line2 │
  58. │Line3 │
  59. │Line4 │
  60. │Line5 │
  61. │Line6 │
  62. │Line7 │
  63. │Line8 │
  64. │Line9 │
  65. └──────────┘",
  66. output
  67. );
  68. Assert.True (lv.ScrollVertical (10));
  69. lv.Draw ();
  70. Assert.Equal (-1, lv.SelectedItem);
  71. TestHelpers.AssertDriverContentsWithFrameAre (
  72. @"
  73. ┌──────────┐
  74. │Line10 │
  75. │Line11 │
  76. │Line12 │
  77. │Line13 │
  78. │Line14 │
  79. │Line15 │
  80. │Line16 │
  81. │Line17 │
  82. │Line18 │
  83. │Line19 │
  84. └──────────┘",
  85. output
  86. );
  87. Assert.True (lv.MoveDown ());
  88. lv.Draw ();
  89. Assert.Equal (0, lv.SelectedItem);
  90. TestHelpers.AssertDriverContentsWithFrameAre (
  91. @"
  92. ┌──────────┐
  93. │Line0 │
  94. │Line1 │
  95. │Line2 │
  96. │Line3 │
  97. │Line4 │
  98. │Line5 │
  99. │Line6 │
  100. │Line7 │
  101. │Line8 │
  102. │Line9 │
  103. └──────────┘",
  104. output
  105. );
  106. Assert.True (lv.MoveEnd ());
  107. lv.Draw ();
  108. Assert.Equal (19, lv.SelectedItem);
  109. TestHelpers.AssertDriverContentsWithFrameAre (
  110. @"
  111. ┌──────────┐
  112. │Line10 │
  113. │Line11 │
  114. │Line12 │
  115. │Line13 │
  116. │Line14 │
  117. │Line15 │
  118. │Line16 │
  119. │Line17 │
  120. │Line18 │
  121. │Line19 │
  122. └──────────┘",
  123. output
  124. );
  125. Assert.True (lv.ScrollVertical (-20));
  126. lv.Draw ();
  127. Assert.Equal (19, lv.SelectedItem);
  128. TestHelpers.AssertDriverContentsWithFrameAre (
  129. @"
  130. ┌──────────┐
  131. │Line0 │
  132. │Line1 │
  133. │Line2 │
  134. │Line3 │
  135. │Line4 │
  136. │Line5 │
  137. │Line6 │
  138. │Line7 │
  139. │Line8 │
  140. │Line9 │
  141. └──────────┘",
  142. output
  143. );
  144. Assert.True (lv.MoveDown ());
  145. lv.Draw ();
  146. Assert.Equal (19, lv.SelectedItem);
  147. TestHelpers.AssertDriverContentsWithFrameAre (
  148. @"
  149. ┌──────────┐
  150. │Line10 │
  151. │Line11 │
  152. │Line12 │
  153. │Line13 │
  154. │Line14 │
  155. │Line15 │
  156. │Line16 │
  157. │Line17 │
  158. │Line18 │
  159. │Line19 │
  160. └──────────┘",
  161. output
  162. );
  163. Assert.True (lv.ScrollVertical (-20));
  164. lv.Draw ();
  165. Assert.Equal (19, lv.SelectedItem);
  166. TestHelpers.AssertDriverContentsWithFrameAre (
  167. @"
  168. ┌──────────┐
  169. │Line0 │
  170. │Line1 │
  171. │Line2 │
  172. │Line3 │
  173. │Line4 │
  174. │Line5 │
  175. │Line6 │
  176. │Line7 │
  177. │Line8 │
  178. │Line9 │
  179. └──────────┘",
  180. output
  181. );
  182. Assert.True (lv.MoveDown ());
  183. lv.Draw ();
  184. Assert.Equal (19, lv.SelectedItem);
  185. TestHelpers.AssertDriverContentsWithFrameAre (
  186. @"
  187. ┌──────────┐
  188. │Line10 │
  189. │Line11 │
  190. │Line12 │
  191. │Line13 │
  192. │Line14 │
  193. │Line15 │
  194. │Line16 │
  195. │Line17 │
  196. │Line18 │
  197. │Line19 │
  198. └──────────┘",
  199. output
  200. );
  201. Assert.True (lv.MoveHome ());
  202. lv.Draw ();
  203. Assert.Equal (0, lv.SelectedItem);
  204. TestHelpers.AssertDriverContentsWithFrameAre (
  205. @"
  206. ┌──────────┐
  207. │Line0 │
  208. │Line1 │
  209. │Line2 │
  210. │Line3 │
  211. │Line4 │
  212. │Line5 │
  213. │Line6 │
  214. │Line7 │
  215. │Line8 │
  216. │Line9 │
  217. └──────────┘",
  218. output
  219. );
  220. Assert.True (lv.ScrollVertical (20));
  221. lv.Draw ();
  222. Assert.Equal (0, lv.SelectedItem);
  223. TestHelpers.AssertDriverContentsWithFrameAre (
  224. @"
  225. ┌──────────┐
  226. │Line19 │
  227. │ │
  228. │ │
  229. │ │
  230. │ │
  231. │ │
  232. │ │
  233. │ │
  234. │ │
  235. │ │
  236. └──────────┘",
  237. output
  238. );
  239. Assert.True (lv.MoveUp ());
  240. lv.Draw ();
  241. Assert.Equal (0, lv.SelectedItem);
  242. TestHelpers.AssertDriverContentsWithFrameAre (
  243. @"
  244. ┌──────────┐
  245. │Line0 │
  246. │Line1 │
  247. │Line2 │
  248. │Line3 │
  249. │Line4 │
  250. │Line5 │
  251. │Line6 │
  252. │Line7 │
  253. │Line8 │
  254. │Line9 │
  255. └──────────┘",
  256. output
  257. );
  258. top.Dispose ();
  259. }
  260. [Fact]
  261. [AutoInitShutdown]
  262. public void EnsureSelectedItemVisible_SelectedItem ()
  263. {
  264. ObservableCollection<string> source = [];
  265. for (var i = 0; i < 10; i++)
  266. {
  267. source.Add ($"Item {i}");
  268. }
  269. var lv = new ListView { Width = 10, Height = 5, Source = new ListWrapper<string> (source) };
  270. var top = new Toplevel ();
  271. top.Add (lv);
  272. Application.Begin (top);
  273. TestHelpers.AssertDriverContentsWithFrameAre (
  274. @"
  275. Item 0
  276. Item 1
  277. Item 2
  278. Item 3
  279. Item 4",
  280. output
  281. );
  282. // EnsureSelectedItemVisible is auto enabled on the OnSelectedChanged
  283. lv.SelectedItem = 6;
  284. Application.Refresh ();
  285. TestHelpers.AssertDriverContentsWithFrameAre (
  286. @"
  287. Item 2
  288. Item 3
  289. Item 4
  290. Item 5
  291. Item 6",
  292. output
  293. );
  294. top.Dispose ();
  295. }
  296. [Fact]
  297. [AutoInitShutdown]
  298. public void EnsureSelectedItemVisible_Top ()
  299. {
  300. ObservableCollection<string> source = ["First", "Second"];
  301. var lv = new ListView { Width = Dim.Fill (), Height = 1, Source = new ListWrapper<string> (source) };
  302. lv.SelectedItem = 1;
  303. var top = new Toplevel ();
  304. top.Add (lv);
  305. Application.Begin (top);
  306. Assert.Equal ("Second ", GetContents (0));
  307. Assert.Equal (new (' ', 7), GetContents (1));
  308. lv.MoveUp ();
  309. lv.Draw ();
  310. Assert.Equal ("First ", GetContents (0));
  311. Assert.Equal (new (' ', 7), GetContents (1));
  312. string GetContents (int line)
  313. {
  314. var item = "";
  315. for (var i = 0; i < 7; i++)
  316. {
  317. item += Application.Driver?.Contents [line, i].Rune;
  318. }
  319. return item;
  320. }
  321. top.Dispose ();
  322. }
  323. [Fact]
  324. public void KeyBindings_Command ()
  325. {
  326. ObservableCollection<string> source = ["One", "Two", "Three"];
  327. var lv = new ListView { Height = 2, AllowsMarking = true, Source = new ListWrapper<string> (source) };
  328. lv.BeginInit ();
  329. lv.EndInit ();
  330. Assert.Equal (-1, lv.SelectedItem);
  331. Assert.True (lv.NewKeyDownEvent (Key.CursorDown));
  332. Assert.Equal (0, lv.SelectedItem);
  333. Assert.True (lv.NewKeyDownEvent (Key.CursorUp));
  334. Assert.Equal (0, lv.SelectedItem);
  335. Assert.True (lv.NewKeyDownEvent (Key.PageDown));
  336. Assert.Equal (2, lv.SelectedItem);
  337. Assert.Equal (2, lv.TopItem);
  338. Assert.True (lv.NewKeyDownEvent (Key.PageUp));
  339. Assert.Equal (0, lv.SelectedItem);
  340. Assert.Equal (0, lv.TopItem);
  341. Assert.False (lv.Source.IsMarked (lv.SelectedItem));
  342. Assert.True (lv.NewKeyDownEvent (Key.Space));
  343. Assert.True (lv.Source.IsMarked (lv.SelectedItem));
  344. var opened = false;
  345. lv.OpenSelectedItem += (s, _) => opened = true;
  346. Assert.True (lv.NewKeyDownEvent (Key.Enter));
  347. Assert.True (opened);
  348. Assert.True (lv.NewKeyDownEvent (Key.End));
  349. Assert.Equal (2, lv.SelectedItem);
  350. Assert.True (lv.NewKeyDownEvent (Key.Home));
  351. Assert.Equal (0, lv.SelectedItem);
  352. }
  353. [Fact]
  354. public void HotKey_Command_SetsFocus ()
  355. {
  356. var view = new ListView ();
  357. view.CanFocus = true;
  358. Assert.False (view.HasFocus);
  359. view.InvokeCommand (Command.HotKey);
  360. Assert.True (view.HasFocus);
  361. }
  362. [Fact]
  363. public void HotKey_Command_Does_Not_Accept ()
  364. {
  365. var listView = new ListView ();
  366. var accepted = false;
  367. listView.Accept += OnAccept;
  368. listView.InvokeCommand (Command.HotKey);
  369. Assert.False (accepted);
  370. return;
  371. void OnAccept (object sender, HandledEventArgs e) { accepted = true; }
  372. }
  373. [Fact]
  374. public void Accept_Command_Accepts_and_Opens_Selected_Item ()
  375. {
  376. ObservableCollection<string> source = ["One", "Two", "Three"];
  377. var listView = new ListView { Source = new ListWrapper<string> (source) };
  378. listView.SelectedItem = 0;
  379. var accepted = false;
  380. var opened = false;
  381. var selectedValue = string.Empty;
  382. listView.Accept += Accept;
  383. listView.OpenSelectedItem += OpenSelectedItem;
  384. listView.InvokeCommand (Command.Accept);
  385. Assert.True (accepted);
  386. Assert.True (opened);
  387. Assert.Equal (source [0], selectedValue);
  388. return;
  389. void OpenSelectedItem (object sender, ListViewItemEventArgs e)
  390. {
  391. opened = true;
  392. selectedValue = e.Value.ToString ();
  393. }
  394. void Accept (object sender, HandledEventArgs e) { accepted = true; }
  395. }
  396. [Fact]
  397. public void Accept_Cancel_Event_Prevents_OpenSelectedItem ()
  398. {
  399. ObservableCollection<string> source = ["One", "Two", "Three"];
  400. var listView = new ListView { Source = new ListWrapper<string> (source) };
  401. listView.SelectedItem = 0;
  402. var accepted = false;
  403. var opened = false;
  404. var selectedValue = string.Empty;
  405. listView.Accept += Accept;
  406. listView.OpenSelectedItem += OpenSelectedItem;
  407. listView.InvokeCommand (Command.Accept);
  408. Assert.True (accepted);
  409. Assert.False (opened);
  410. Assert.Equal (string.Empty, selectedValue);
  411. return;
  412. void OpenSelectedItem (object sender, ListViewItemEventArgs e)
  413. {
  414. opened = true;
  415. selectedValue = e.Value.ToString ();
  416. }
  417. void Accept (object sender, HandledEventArgs e)
  418. {
  419. accepted = true;
  420. e.Handled = true;
  421. }
  422. }
  423. /// <summary>
  424. /// Tests that when none of the Commands in a chained keybinding are possible the
  425. /// <see cref="View.NewKeyDownEvent"/> returns the appropriate result
  426. /// </summary>
  427. [Fact]
  428. public void ListViewProcessKeyReturnValue_WithMultipleCommands ()
  429. {
  430. var lv = new ListView { Source = new ListWrapper<string> (["One", "Two", "Three", "Four"]) };
  431. Assert.NotNull (lv.Source);
  432. // first item should be deselected by default
  433. Assert.Equal (-1, lv.SelectedItem);
  434. // bind shift down to move down twice in control
  435. lv.KeyBindings.Add (Key.CursorDown.WithShift, Command.LineDown, Command.LineDown);
  436. Key ev = Key.CursorDown.WithShift;
  437. Assert.True (lv.NewKeyDownEvent (ev), "The first time we move down 2 it should be possible");
  438. // After moving down twice from -1 we should be at 'Two'
  439. Assert.Equal (1, lv.SelectedItem);
  440. // clear the items
  441. lv.SetSource<string> (null);
  442. // Press key combo again - return should be false this time as none of the Commands are allowable
  443. Assert.False (lv.NewKeyDownEvent (ev), "We cannot move down so will not respond to this");
  444. }
  445. [Fact]
  446. public void ListViewSelectThenDown ()
  447. {
  448. var lv = new ListView { Source = new ListWrapper<string> (["One", "Two", "Three"]) };
  449. lv.AllowsMarking = true;
  450. Assert.NotNull (lv.Source);
  451. // first item should be deselected by default
  452. Assert.Equal (-1, lv.SelectedItem);
  453. // nothing is ticked
  454. Assert.False (lv.Source.IsMarked (0));
  455. Assert.False (lv.Source.IsMarked (1));
  456. Assert.False (lv.Source.IsMarked (2));
  457. lv.KeyBindings.Add (Key.Space.WithShift, Command.Select, Command.LineDown);
  458. Key ev = Key.Space.WithShift;
  459. // view should indicate that it has accepted and consumed the event
  460. Assert.True (lv.NewKeyDownEvent (ev));
  461. // first item should now be selected
  462. Assert.Equal (0, lv.SelectedItem);
  463. // none of the items should be ticked
  464. Assert.False (lv.Source.IsMarked (0));
  465. Assert.False (lv.Source.IsMarked (1));
  466. Assert.False (lv.Source.IsMarked (2));
  467. // Press key combo again
  468. Assert.True (lv.NewKeyDownEvent (ev));
  469. // second item should now be selected
  470. Assert.Equal (1, lv.SelectedItem);
  471. // first item only should be ticked
  472. Assert.True (lv.Source.IsMarked (0));
  473. Assert.False (lv.Source.IsMarked (1));
  474. Assert.False (lv.Source.IsMarked (2));
  475. // Press key combo again
  476. Assert.True (lv.NewKeyDownEvent (ev));
  477. Assert.Equal (2, lv.SelectedItem);
  478. Assert.True (lv.Source.IsMarked (0));
  479. Assert.True (lv.Source.IsMarked (1));
  480. Assert.False (lv.Source.IsMarked (2));
  481. // Press key combo again
  482. Assert.True (lv.NewKeyDownEvent (ev));
  483. Assert.Equal (2, lv.SelectedItem); // cannot move down any further
  484. Assert.True (lv.Source.IsMarked (0));
  485. Assert.True (lv.Source.IsMarked (1));
  486. Assert.True (lv.Source.IsMarked (2)); // but can toggle marked
  487. // Press key combo again
  488. Assert.True (lv.NewKeyDownEvent (ev));
  489. Assert.Equal (2, lv.SelectedItem); // cannot move down any further
  490. Assert.True (lv.Source.IsMarked (0));
  491. Assert.True (lv.Source.IsMarked (1));
  492. Assert.False (lv.Source.IsMarked (2)); // untoggle toggle marked
  493. }
  494. [Fact]
  495. public void ListWrapper_StartsWith ()
  496. {
  497. var lw = new ListWrapper<string> (["One", "Two", "Three"]);
  498. Assert.Equal (1, lw.StartsWith ("t"));
  499. Assert.Equal (1, lw.StartsWith ("tw"));
  500. Assert.Equal (2, lw.StartsWith ("th"));
  501. Assert.Equal (1, lw.StartsWith ("T"));
  502. Assert.Equal (1, lw.StartsWith ("TW"));
  503. Assert.Equal (2, lw.StartsWith ("TH"));
  504. lw = new (["One", "Two", "Three"]);
  505. Assert.Equal (1, lw.StartsWith ("t"));
  506. Assert.Equal (1, lw.StartsWith ("tw"));
  507. Assert.Equal (2, lw.StartsWith ("th"));
  508. Assert.Equal (1, lw.StartsWith ("T"));
  509. Assert.Equal (1, lw.StartsWith ("TW"));
  510. Assert.Equal (2, lw.StartsWith ("TH"));
  511. }
  512. [Fact]
  513. public void OnEnter_Does_Not_Throw_Exception ()
  514. {
  515. var lv = new ListView ();
  516. var top = new View ();
  517. top.Add (lv);
  518. Exception exception = Record.Exception (() => lv.SetFocus());
  519. Assert.Null (exception);
  520. }
  521. [Fact]
  522. [AutoInitShutdown]
  523. public void RowRender_Event ()
  524. {
  525. var rendered = false;
  526. ObservableCollection<string> source = ["one", "two", "three"];
  527. var lv = new ListView { Width = Dim.Fill (), Height = Dim.Fill () };
  528. lv.RowRender += (s, _) => rendered = true;
  529. var top = new Toplevel ();
  530. top.Add (lv);
  531. Application.Begin (top);
  532. Assert.False (rendered);
  533. lv.SetSource (source);
  534. lv.Draw ();
  535. Assert.True (rendered);
  536. top.Dispose ();
  537. }
  538. [Fact]
  539. public void SelectedItem_Get_Set ()
  540. {
  541. var lv = new ListView { Source = new ListWrapper<string> (["One", "Two", "Three"]) };
  542. Assert.Equal (-1, lv.SelectedItem);
  543. Assert.Throws<ArgumentException> (() => lv.SelectedItem = 3);
  544. Exception exception = Record.Exception (() => lv.SelectedItem = -1);
  545. Assert.Null (exception);
  546. }
  547. [Fact]
  548. public void SetSource_Preserves_ListWrapper_Instance_If_Not_Null ()
  549. {
  550. var lv = new ListView { Source = new ListWrapper<string> (["One", "Two"]) };
  551. Assert.NotNull (lv.Source);
  552. lv.SetSource<string> (null);
  553. Assert.NotNull (lv.Source);
  554. lv.Source = null;
  555. Assert.Null (lv.Source);
  556. lv = new () { Source = new ListWrapper<string> (["One", "Two"]) };
  557. Assert.NotNull (lv.Source);
  558. lv.SetSourceAsync<string> (null);
  559. Assert.NotNull (lv.Source);
  560. }
  561. [Fact]
  562. public void SettingEmptyKeybindingThrows ()
  563. {
  564. var lv = new ListView { Source = new ListWrapper<string> (["One", "Two", "Three"]) };
  565. Assert.Throws<ArgumentException> (() => lv.KeyBindings.Add (Key.Space));
  566. }
  567. private class NewListDataSource : IListDataSource
  568. {
  569. #pragma warning disable CS0067
  570. /// <inheritdoc />
  571. public event NotifyCollectionChangedEventHandler CollectionChanged;
  572. #pragma warning restore CS0067
  573. public int Count => 0;
  574. public int Length => 0;
  575. public bool SuspendCollectionChangedEvent { get => throw new NotImplementedException (); set => throw new NotImplementedException (); }
  576. public bool IsMarked (int item) { throw new NotImplementedException (); }
  577. public void Render (
  578. ListView container,
  579. ConsoleDriver driver,
  580. bool selected,
  581. int item,
  582. int col,
  583. int line,
  584. int width,
  585. int start = 0
  586. )
  587. {
  588. throw new NotImplementedException ();
  589. }
  590. public void SetMark (int item, bool value) { throw new NotImplementedException (); }
  591. public IList ToList () { return new List<string> { "One", "Two", "Three" }; }
  592. public void Dispose ()
  593. {
  594. throw new NotImplementedException ();
  595. }
  596. }
  597. [Fact]
  598. [AutoInitShutdown]
  599. public void Clicking_On_Border_Is_Ignored ()
  600. {
  601. var selected = "";
  602. var lv = new ListView
  603. {
  604. Height = 5,
  605. Width = 7,
  606. BorderStyle = LineStyle.Single
  607. };
  608. lv.SetSource (["One", "Two", "Three", "Four"]);
  609. lv.SelectedItemChanged += (s, e) => selected = e.Value.ToString ();
  610. var top = new Toplevel ();
  611. top.Add (lv);
  612. Application.Begin (top);
  613. Assert.Equal (new (1), lv.Border.Thickness);
  614. Assert.Equal (-1, lv.SelectedItem);
  615. Assert.Equal ("", lv.Text);
  616. TestHelpers.AssertDriverContentsWithFrameAre (
  617. @"
  618. ┌─────┐
  619. │One │
  620. │Two │
  621. │Three│
  622. └─────┘",
  623. output);
  624. Application.OnMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked });
  625. Assert.Equal ("", selected);
  626. Assert.Equal (-1, lv.SelectedItem);
  627. Application.OnMouseEvent (
  628. new ()
  629. {
  630. Position = new (1, 1), Flags = MouseFlags.Button1Clicked
  631. });
  632. Assert.Equal ("One", selected);
  633. Assert.Equal (0, lv.SelectedItem);
  634. Application.OnMouseEvent (
  635. new ()
  636. {
  637. Position = new (1, 2), Flags = MouseFlags.Button1Clicked
  638. });
  639. Assert.Equal ("Two", selected);
  640. Assert.Equal (1, lv.SelectedItem);
  641. Application.OnMouseEvent (
  642. new ()
  643. {
  644. Position = new (1, 3), Flags = MouseFlags.Button1Clicked
  645. });
  646. Assert.Equal ("Three", selected);
  647. Assert.Equal (2, lv.SelectedItem);
  648. Application.OnMouseEvent (
  649. new ()
  650. {
  651. Position = new (1, 4), Flags = MouseFlags.Button1Clicked
  652. });
  653. Assert.Equal ("Three", selected);
  654. Assert.Equal (2, lv.SelectedItem);
  655. top.Dispose ();
  656. }
  657. [Fact]
  658. [AutoInitShutdown]
  659. public void LeftItem_TopItem_Tests ()
  660. {
  661. ObservableCollection<string> source = [];
  662. for (int i = 0; i < 5; i++)
  663. {
  664. source.Add ($"Item {i}");
  665. }
  666. var lv = new ListView
  667. {
  668. X = 1,
  669. Width = 10,
  670. Height = 5,
  671. Source = new ListWrapper<string> (source)
  672. };
  673. var top = new Toplevel ();
  674. top.Add (lv);
  675. Application.Begin (top);
  676. TestHelpers.AssertDriverContentsWithFrameAre (
  677. @"
  678. Item 0
  679. Item 1
  680. Item 2
  681. Item 3
  682. Item 4",
  683. output);
  684. lv.LeftItem = 1;
  685. lv.TopItem = 1;
  686. Application.Refresh ();
  687. TestHelpers.AssertDriverContentsWithFrameAre (
  688. @"
  689. tem 1
  690. tem 2
  691. tem 3
  692. tem 4",
  693. output);
  694. top.Dispose ();
  695. }
  696. [Fact]
  697. public void CollectionChanged_Event ()
  698. {
  699. var added = 0;
  700. var removed = 0;
  701. ObservableCollection<string> source = [];
  702. var lv = new ListView { Source = new ListWrapper<string> (source) };
  703. lv.CollectionChanged += (sender, args) =>
  704. {
  705. if (args.Action == NotifyCollectionChangedAction.Add)
  706. {
  707. added++;
  708. }
  709. else if (args.Action == NotifyCollectionChangedAction.Remove)
  710. {
  711. removed++;
  712. }
  713. };
  714. for (int i = 0; i < 3; i++)
  715. {
  716. source.Add ($"Item{i}");
  717. }
  718. Assert.Equal (3, added);
  719. Assert.Equal (0, removed);
  720. added = 0;
  721. for (int i = 0; i < 3; i++)
  722. {
  723. source.Remove (source [0]);
  724. }
  725. Assert.Equal (0, added);
  726. Assert.Equal (3, removed);
  727. Assert.Empty (source);
  728. }
  729. [Fact]
  730. public void CollectionChanged_Event_Is_Only_Subscribed_Once ()
  731. {
  732. var added = 0;
  733. var removed = 0;
  734. var otherActions = 0;
  735. IList<string> source1 = [];
  736. var lv = new ListView { Source = new ListWrapper<string> (new ( source1)) };
  737. lv.CollectionChanged += (sender, args) =>
  738. {
  739. if (args.Action == NotifyCollectionChangedAction.Add)
  740. {
  741. added++;
  742. }
  743. else if (args.Action == NotifyCollectionChangedAction.Remove)
  744. {
  745. removed++;
  746. }
  747. else
  748. {
  749. otherActions++;
  750. }
  751. };
  752. ObservableCollection<string> source2 = [];
  753. lv.Source = new ListWrapper<string> (source2);
  754. ObservableCollection<string> source3 = [];
  755. lv.Source = new ListWrapper<string> (source3);
  756. Assert.Equal (0, added);
  757. Assert.Equal (0, removed);
  758. Assert.Equal (0, otherActions);
  759. for (int i = 0; i < 3; i++)
  760. {
  761. source1.Add ($"Item{i}");
  762. source2.Add ($"Item{i}");
  763. source3.Add ($"Item{i}");
  764. }
  765. Assert.Equal (3, added);
  766. Assert.Equal (0, removed);
  767. Assert.Equal (0, otherActions);
  768. added = 0;
  769. for (int i = 0; i < 3; i++)
  770. {
  771. source1.Remove (source1 [0]);
  772. source2.Remove (source2 [0]);
  773. source3.Remove (source3 [0]);
  774. }
  775. Assert.Equal (0, added);
  776. Assert.Equal (3, removed);
  777. Assert.Equal (0, otherActions);
  778. Assert.Empty (source1);
  779. Assert.Empty (source2);
  780. Assert.Empty (source3);
  781. }
  782. [Fact]
  783. public void CollectionChanged_Event_UnSubscribe_Previous_If_New_Is_Null ()
  784. {
  785. var added = 0;
  786. var removed = 0;
  787. var otherActions = 0;
  788. ObservableCollection<string> source1 = [];
  789. var lv = new ListView { Source = new ListWrapper<string> (source1) };
  790. lv.CollectionChanged += (sender, args) =>
  791. {
  792. if (args.Action == NotifyCollectionChangedAction.Add)
  793. {
  794. added++;
  795. }
  796. else if (args.Action == NotifyCollectionChangedAction.Remove)
  797. {
  798. removed++;
  799. }
  800. else
  801. {
  802. otherActions++;
  803. }
  804. };
  805. lv.Source = new ListWrapper<string> (null);
  806. Assert.Equal (0, added);
  807. Assert.Equal (0, removed);
  808. Assert.Equal (0, otherActions);
  809. for (int i = 0; i < 3; i++)
  810. {
  811. source1.Add ($"Item{i}");
  812. }
  813. Assert.Equal (0, added);
  814. Assert.Equal (0, removed);
  815. Assert.Equal (0, otherActions);
  816. for (int i = 0; i < 3; i++)
  817. {
  818. source1.Remove (source1 [0]);
  819. }
  820. Assert.Equal (0, added);
  821. Assert.Equal (0, removed);
  822. Assert.Equal (0, otherActions);
  823. Assert.Empty (source1);
  824. }
  825. [Fact]
  826. public void ListWrapper_CollectionChanged_Event_Is_Only_Subscribed_Once ()
  827. {
  828. var added = 0;
  829. var removed = 0;
  830. var otherActions = 0;
  831. ObservableCollection<string> source1 = [];
  832. ListWrapper<string> lw = new (source1);
  833. lw.CollectionChanged += (sender, args) =>
  834. {
  835. if (args.Action == NotifyCollectionChangedAction.Add)
  836. {
  837. added++;
  838. }
  839. else if (args.Action == NotifyCollectionChangedAction.Remove)
  840. {
  841. removed++;
  842. }
  843. else
  844. {
  845. otherActions++;
  846. }
  847. };
  848. ObservableCollection<string> source2 = [];
  849. lw = new (source2);
  850. ObservableCollection<string> source3 = [];
  851. lw = new (source3);
  852. Assert.Equal (0, added);
  853. Assert.Equal (0, removed);
  854. Assert.Equal (0, otherActions);
  855. for (int i = 0; i < 3; i++)
  856. {
  857. source1.Add ($"Item{i}");
  858. source2.Add ($"Item{i}");
  859. source3.Add ($"Item{i}");
  860. }
  861. Assert.Equal (3, added);
  862. Assert.Equal (0, removed);
  863. Assert.Equal (0, otherActions);
  864. added = 0;
  865. for (int i = 0; i < 3; i++)
  866. {
  867. source1.Remove (source1 [0]);
  868. source2.Remove (source2 [0]);
  869. source3.Remove (source3 [0]);
  870. }
  871. Assert.Equal (0, added);
  872. Assert.Equal (3, removed);
  873. Assert.Equal (0, otherActions);
  874. Assert.Empty (source1);
  875. Assert.Empty (source2);
  876. Assert.Empty (source3);
  877. }
  878. [Fact]
  879. public void ListWrapper_CollectionChanged_Event_UnSubscribe_Previous_Is_Disposed ()
  880. {
  881. var added = 0;
  882. var removed = 0;
  883. var otherActions = 0;
  884. ObservableCollection<string> source1 = [];
  885. ListWrapper<string> lw = new (source1);
  886. lw.CollectionChanged += Lw_CollectionChanged;
  887. lw.Dispose ();
  888. lw = new (null);
  889. Assert.Equal (0, lw.Count);
  890. Assert.Equal (0, added);
  891. Assert.Equal (0, removed);
  892. Assert.Equal (0, otherActions);
  893. for (int i = 0; i < 3; i++)
  894. {
  895. source1.Add ($"Item{i}");
  896. }
  897. Assert.Equal (0, added);
  898. Assert.Equal (0, removed);
  899. Assert.Equal (0, otherActions);
  900. for (int i = 0; i < 3; i++)
  901. {
  902. source1.Remove (source1 [0]);
  903. }
  904. Assert.Equal (0, added);
  905. Assert.Equal (0, removed);
  906. Assert.Equal (0, otherActions);
  907. Assert.Empty (source1);
  908. void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e)
  909. {
  910. if (e.Action == NotifyCollectionChangedAction.Add)
  911. {
  912. added++;
  913. }
  914. else if (e.Action == NotifyCollectionChangedAction.Remove)
  915. {
  916. removed++;
  917. }
  918. else
  919. {
  920. otherActions++;
  921. }
  922. }
  923. }
  924. [Fact]
  925. public void ListWrapper_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests ()
  926. {
  927. var added = 0;
  928. ObservableCollection<string> source = [];
  929. ListWrapper<string> lw = new (source);
  930. lw.CollectionChanged += Lw_CollectionChanged;
  931. lw.SuspendCollectionChangedEvent = true;
  932. for (int i = 0; i < 3; i++)
  933. {
  934. source.Add ($"Item{i}");
  935. }
  936. Assert.Equal (0, added);
  937. Assert.Equal (3, lw.Count);
  938. Assert.Equal (3, source.Count);
  939. lw.SuspendCollectionChangedEvent = false;
  940. for (int i = 3; i < 6; i++)
  941. {
  942. source.Add ($"Item{i}");
  943. }
  944. Assert.Equal (3, added);
  945. Assert.Equal (6, lw.Count);
  946. Assert.Equal (6, source.Count);
  947. void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e)
  948. {
  949. if (e.Action == NotifyCollectionChangedAction.Add)
  950. {
  951. added++;
  952. }
  953. }
  954. }
  955. [Fact]
  956. public void ListView_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests ()
  957. {
  958. var added = 0;
  959. ObservableCollection<string> source = [];
  960. ListView lv = new ListView { Source = new ListWrapper<string> (source) };
  961. lv.CollectionChanged += Lw_CollectionChanged;
  962. lv.SuspendCollectionChangedEvent ();
  963. for (int i = 0; i < 3; i++)
  964. {
  965. source.Add ($"Item{i}");
  966. }
  967. Assert.Equal (0, added);
  968. Assert.Equal (3, lv.Source.Count);
  969. Assert.Equal (3, source.Count);
  970. lv.ResumeSuspendCollectionChangedEvent ();
  971. for (int i = 3; i < 6; i++)
  972. {
  973. source.Add ($"Item{i}");
  974. }
  975. Assert.Equal (3, added);
  976. Assert.Equal (6, lv.Source.Count);
  977. Assert.Equal (6, source.Count);
  978. void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e)
  979. {
  980. if (e.Action == NotifyCollectionChangedAction.Add)
  981. {
  982. added++;
  983. }
  984. }
  985. }
  986. }