ListViewTests.cs 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159
  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. /// <inheritdoc />
  570. public event NotifyCollectionChangedEventHandler CollectionChanged;
  571. public int Count => 0;
  572. public int Length => 0;
  573. public bool SuspendCollectionChangedEvent { get => throw new NotImplementedException (); set => throw new NotImplementedException (); }
  574. public bool IsMarked (int item) { throw new NotImplementedException (); }
  575. public void Render (
  576. ListView container,
  577. ConsoleDriver driver,
  578. bool selected,
  579. int item,
  580. int col,
  581. int line,
  582. int width,
  583. int start = 0
  584. )
  585. {
  586. throw new NotImplementedException ();
  587. }
  588. public void SetMark (int item, bool value) { throw new NotImplementedException (); }
  589. public IList ToList () { return new List<string> { "One", "Two", "Three" }; }
  590. public void Dispose ()
  591. {
  592. throw new NotImplementedException ();
  593. }
  594. }
  595. [Fact]
  596. [AutoInitShutdown]
  597. public void Clicking_On_Border_Is_Ignored ()
  598. {
  599. var selected = "";
  600. var lv = new ListView
  601. {
  602. Height = 5,
  603. Width = 7,
  604. BorderStyle = LineStyle.Single
  605. };
  606. lv.SetSource (["One", "Two", "Three", "Four"]);
  607. lv.SelectedItemChanged += (s, e) => selected = e.Value.ToString ();
  608. var top = new Toplevel ();
  609. top.Add (lv);
  610. Application.Begin (top);
  611. Assert.Equal (new (1), lv.Border.Thickness);
  612. Assert.Equal (-1, lv.SelectedItem);
  613. Assert.Equal ("", lv.Text);
  614. TestHelpers.AssertDriverContentsWithFrameAre (
  615. @"
  616. ┌─────┐
  617. │One │
  618. │Two │
  619. │Three│
  620. └─────┘",
  621. output);
  622. Application.OnMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked });
  623. Assert.Equal ("", selected);
  624. Assert.Equal (-1, lv.SelectedItem);
  625. Application.OnMouseEvent (
  626. new ()
  627. {
  628. Position = new (1, 1), Flags = MouseFlags.Button1Clicked
  629. });
  630. Assert.Equal ("One", selected);
  631. Assert.Equal (0, lv.SelectedItem);
  632. Application.OnMouseEvent (
  633. new ()
  634. {
  635. Position = new (1, 2), Flags = MouseFlags.Button1Clicked
  636. });
  637. Assert.Equal ("Two", selected);
  638. Assert.Equal (1, lv.SelectedItem);
  639. Application.OnMouseEvent (
  640. new ()
  641. {
  642. Position = new (1, 3), Flags = MouseFlags.Button1Clicked
  643. });
  644. Assert.Equal ("Three", selected);
  645. Assert.Equal (2, lv.SelectedItem);
  646. Application.OnMouseEvent (
  647. new ()
  648. {
  649. Position = new (1, 4), Flags = MouseFlags.Button1Clicked
  650. });
  651. Assert.Equal ("Three", selected);
  652. Assert.Equal (2, lv.SelectedItem);
  653. top.Dispose ();
  654. }
  655. [Fact]
  656. [AutoInitShutdown]
  657. public void LeftItem_TopItem_Tests ()
  658. {
  659. ObservableCollection<string> source = [];
  660. for (int i = 0; i < 5; i++)
  661. {
  662. source.Add ($"Item {i}");
  663. }
  664. var lv = new ListView
  665. {
  666. X = 1,
  667. Width = 10,
  668. Height = 5,
  669. Source = new ListWrapper<string> (source)
  670. };
  671. var top = new Toplevel ();
  672. top.Add (lv);
  673. Application.Begin (top);
  674. TestHelpers.AssertDriverContentsWithFrameAre (
  675. @"
  676. Item 0
  677. Item 1
  678. Item 2
  679. Item 3
  680. Item 4",
  681. output);
  682. lv.LeftItem = 1;
  683. lv.TopItem = 1;
  684. Application.Refresh ();
  685. TestHelpers.AssertDriverContentsWithFrameAre (
  686. @"
  687. tem 1
  688. tem 2
  689. tem 3
  690. tem 4",
  691. output);
  692. top.Dispose ();
  693. }
  694. [Fact]
  695. public void CollectionChanged_Event ()
  696. {
  697. var added = 0;
  698. var removed = 0;
  699. ObservableCollection<string> source = [];
  700. var lv = new ListView { Source = new ListWrapper<string> (source) };
  701. lv.CollectionChanged += (sender, args) =>
  702. {
  703. if (args.Action == NotifyCollectionChangedAction.Add)
  704. {
  705. added++;
  706. }
  707. else if (args.Action == NotifyCollectionChangedAction.Remove)
  708. {
  709. removed++;
  710. }
  711. };
  712. for (int i = 0; i < 3; i++)
  713. {
  714. source.Add ($"Item{i}");
  715. }
  716. Assert.Equal (3, added);
  717. Assert.Equal (0, removed);
  718. added = 0;
  719. for (int i = 0; i < 3; i++)
  720. {
  721. source.Remove (source [0]);
  722. }
  723. Assert.Equal (0, added);
  724. Assert.Equal (3, removed);
  725. Assert.Empty (source);
  726. }
  727. [Fact]
  728. public void CollectionChanged_Event_Is_Only_Subscribed_Once ()
  729. {
  730. var added = 0;
  731. var removed = 0;
  732. var otherActions = 0;
  733. IList<string> source1 = [];
  734. var lv = new ListView { Source = new ListWrapper<string> (new ( source1)) };
  735. lv.CollectionChanged += (sender, args) =>
  736. {
  737. if (args.Action == NotifyCollectionChangedAction.Add)
  738. {
  739. added++;
  740. }
  741. else if (args.Action == NotifyCollectionChangedAction.Remove)
  742. {
  743. removed++;
  744. }
  745. else
  746. {
  747. otherActions++;
  748. }
  749. };
  750. ObservableCollection<string> source2 = [];
  751. lv.Source = new ListWrapper<string> (source2);
  752. ObservableCollection<string> source3 = [];
  753. lv.Source = new ListWrapper<string> (source3);
  754. Assert.Equal (0, added);
  755. Assert.Equal (0, removed);
  756. Assert.Equal (0, otherActions);
  757. for (int i = 0; i < 3; i++)
  758. {
  759. source1.Add ($"Item{i}");
  760. source2.Add ($"Item{i}");
  761. source3.Add ($"Item{i}");
  762. }
  763. Assert.Equal (3, added);
  764. Assert.Equal (0, removed);
  765. Assert.Equal (0, otherActions);
  766. added = 0;
  767. for (int i = 0; i < 3; i++)
  768. {
  769. source1.Remove (source1 [0]);
  770. source2.Remove (source2 [0]);
  771. source3.Remove (source3 [0]);
  772. }
  773. Assert.Equal (0, added);
  774. Assert.Equal (3, removed);
  775. Assert.Equal (0, otherActions);
  776. Assert.Empty (source1);
  777. Assert.Empty (source2);
  778. Assert.Empty (source3);
  779. }
  780. [Fact]
  781. public void CollectionChanged_Event_UnSubscribe_Previous_If_New_Is_Null ()
  782. {
  783. var added = 0;
  784. var removed = 0;
  785. var otherActions = 0;
  786. ObservableCollection<string> source1 = [];
  787. var lv = new ListView { Source = new ListWrapper<string> (source1) };
  788. lv.CollectionChanged += (sender, args) =>
  789. {
  790. if (args.Action == NotifyCollectionChangedAction.Add)
  791. {
  792. added++;
  793. }
  794. else if (args.Action == NotifyCollectionChangedAction.Remove)
  795. {
  796. removed++;
  797. }
  798. else
  799. {
  800. otherActions++;
  801. }
  802. };
  803. lv.Source = new ListWrapper<string> (null);
  804. Assert.Equal (0, added);
  805. Assert.Equal (0, removed);
  806. Assert.Equal (0, otherActions);
  807. for (int i = 0; i < 3; i++)
  808. {
  809. source1.Add ($"Item{i}");
  810. }
  811. Assert.Equal (0, added);
  812. Assert.Equal (0, removed);
  813. Assert.Equal (0, otherActions);
  814. for (int i = 0; i < 3; i++)
  815. {
  816. source1.Remove (source1 [0]);
  817. }
  818. Assert.Equal (0, added);
  819. Assert.Equal (0, removed);
  820. Assert.Equal (0, otherActions);
  821. Assert.Empty (source1);
  822. }
  823. [Fact]
  824. public void ListWrapper_CollectionChanged_Event_Is_Only_Subscribed_Once ()
  825. {
  826. var added = 0;
  827. var removed = 0;
  828. var otherActions = 0;
  829. ObservableCollection<string> source1 = [];
  830. ListWrapper<string> lw = new (source1);
  831. lw.CollectionChanged += (sender, args) =>
  832. {
  833. if (args.Action == NotifyCollectionChangedAction.Add)
  834. {
  835. added++;
  836. }
  837. else if (args.Action == NotifyCollectionChangedAction.Remove)
  838. {
  839. removed++;
  840. }
  841. else
  842. {
  843. otherActions++;
  844. }
  845. };
  846. ObservableCollection<string> source2 = [];
  847. lw = new (source2);
  848. ObservableCollection<string> source3 = [];
  849. lw = new (source3);
  850. Assert.Equal (0, added);
  851. Assert.Equal (0, removed);
  852. Assert.Equal (0, otherActions);
  853. for (int i = 0; i < 3; i++)
  854. {
  855. source1.Add ($"Item{i}");
  856. source2.Add ($"Item{i}");
  857. source3.Add ($"Item{i}");
  858. }
  859. Assert.Equal (3, added);
  860. Assert.Equal (0, removed);
  861. Assert.Equal (0, otherActions);
  862. added = 0;
  863. for (int i = 0; i < 3; i++)
  864. {
  865. source1.Remove (source1 [0]);
  866. source2.Remove (source2 [0]);
  867. source3.Remove (source3 [0]);
  868. }
  869. Assert.Equal (0, added);
  870. Assert.Equal (3, removed);
  871. Assert.Equal (0, otherActions);
  872. Assert.Empty (source1);
  873. Assert.Empty (source2);
  874. Assert.Empty (source3);
  875. }
  876. [Fact]
  877. public void ListWrapper_CollectionChanged_Event_UnSubscribe_Previous_Is_Disposed ()
  878. {
  879. var added = 0;
  880. var removed = 0;
  881. var otherActions = 0;
  882. ObservableCollection<string> source1 = [];
  883. ListWrapper<string> lw = new (source1);
  884. lw.CollectionChanged += Lw_CollectionChanged;
  885. lw.Dispose ();
  886. lw = new (null);
  887. Assert.Equal (0, lw.Count);
  888. Assert.Equal (0, added);
  889. Assert.Equal (0, removed);
  890. Assert.Equal (0, otherActions);
  891. for (int i = 0; i < 3; i++)
  892. {
  893. source1.Add ($"Item{i}");
  894. }
  895. Assert.Equal (0, added);
  896. Assert.Equal (0, removed);
  897. Assert.Equal (0, otherActions);
  898. for (int i = 0; i < 3; i++)
  899. {
  900. source1.Remove (source1 [0]);
  901. }
  902. Assert.Equal (0, added);
  903. Assert.Equal (0, removed);
  904. Assert.Equal (0, otherActions);
  905. Assert.Empty (source1);
  906. void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e)
  907. {
  908. if (e.Action == NotifyCollectionChangedAction.Add)
  909. {
  910. added++;
  911. }
  912. else if (e.Action == NotifyCollectionChangedAction.Remove)
  913. {
  914. removed++;
  915. }
  916. else
  917. {
  918. otherActions++;
  919. }
  920. }
  921. }
  922. [Fact]
  923. public void ListWrapper_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests ()
  924. {
  925. var added = 0;
  926. ObservableCollection<string> source = [];
  927. ListWrapper<string> lw = new (source);
  928. lw.CollectionChanged += Lw_CollectionChanged;
  929. lw.SuspendCollectionChangedEvent = true;
  930. for (int i = 0; i < 3; i++)
  931. {
  932. source.Add ($"Item{i}");
  933. }
  934. Assert.Equal (0, added);
  935. Assert.Equal (3, lw.Count);
  936. Assert.Equal (3, source.Count);
  937. lw.SuspendCollectionChangedEvent = false;
  938. for (int i = 3; i < 6; i++)
  939. {
  940. source.Add ($"Item{i}");
  941. }
  942. Assert.Equal (3, added);
  943. Assert.Equal (6, lw.Count);
  944. Assert.Equal (6, source.Count);
  945. void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e)
  946. {
  947. if (e.Action == NotifyCollectionChangedAction.Add)
  948. {
  949. added++;
  950. }
  951. }
  952. }
  953. [Fact]
  954. public void ListView_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests ()
  955. {
  956. var added = 0;
  957. ObservableCollection<string> source = [];
  958. ListView lv = new ListView { Source = new ListWrapper<string> (source) };
  959. lv.CollectionChanged += Lw_CollectionChanged;
  960. lv.SuspendCollectionChangedEvent ();
  961. for (int i = 0; i < 3; i++)
  962. {
  963. source.Add ($"Item{i}");
  964. }
  965. Assert.Equal (0, added);
  966. Assert.Equal (3, lv.Source.Count);
  967. Assert.Equal (3, source.Count);
  968. lv.ResumeSuspendCollectionChangedEvent ();
  969. for (int i = 3; i < 6; i++)
  970. {
  971. source.Add ($"Item{i}");
  972. }
  973. Assert.Equal (3, added);
  974. Assert.Equal (6, lv.Source.Count);
  975. Assert.Equal (6, source.Count);
  976. void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e)
  977. {
  978. if (e.Action == NotifyCollectionChangedAction.Add)
  979. {
  980. added++;
  981. }
  982. }
  983. }
  984. }