ListViewTests.cs 34 KB

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