ListViewTests.cs 34 KB

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