ListViewTests.cs 34 KB

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