Menu.cs 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202
  1. //
  2. // Menu.cs: application menus and submenus
  3. //
  4. // Authors:
  5. // Miguel de Icaza ([email protected])
  6. //
  7. // TODO:
  8. // Add accelerator support, but should also support chords (ShortCut in MenuItem)
  9. // Allow menus inside menus
  10. using System;
  11. using NStack;
  12. using System.Linq;
  13. using System.Collections.Generic;
  14. using System.Reflection;
  15. namespace Terminal.Gui {
  16. /// <summary>
  17. /// A <see cref="MenuItem"/> has a title, an associated help text, and an action to execute on activation.
  18. /// </summary>
  19. public class MenuItem {
  20. /// <summary>
  21. /// Initializes a new instance of <see cref="MenuItem"/>
  22. /// </summary>
  23. public MenuItem ()
  24. {
  25. Title = "";
  26. Help = "";
  27. }
  28. /// <summary>
  29. /// Initializes a new instance of <see cref="MenuItem"/>.
  30. /// </summary>
  31. /// <param name="title">Title for the menu item.</param>
  32. /// <param name="help">Help text to display.</param>
  33. /// <param name="action">Action to invoke when the menu item is activated.</param>
  34. /// <param name="canExecute">Function to determine if the action can currently be executred.</param>
  35. public MenuItem (ustring title, string help, Action action, Func<bool> canExecute = null)
  36. {
  37. Title = title ?? "";
  38. Help = help ?? "";
  39. Action = action;
  40. CanExecute = canExecute;
  41. bool nextIsHot = false;
  42. foreach (var x in Title) {
  43. if (x == '_')
  44. nextIsHot = true;
  45. else {
  46. if (nextIsHot) {
  47. HotKey = Char.ToUpper ((char)x);
  48. break;
  49. }
  50. nextIsHot = false;
  51. }
  52. }
  53. }
  54. /// <summary>
  55. /// Initializes a new instance of <see cref="MenuItem"/>
  56. /// </summary>
  57. /// <param name="title">Title for the menu item.</param>
  58. /// <param name="subMenu">The menu sub-menu.</param>
  59. public MenuItem (ustring title, MenuBarItem subMenu) : this (title, "", null)
  60. {
  61. SubMenu = subMenu;
  62. IsFromSubMenu = true;
  63. }
  64. /// <summary>
  65. /// The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active.
  66. /// For example HotKey would be "N" when the File Menu is open (assuming there is a "_New" entry
  67. /// if the ShortCut is set to "Control-N", this would be a global hotkey that would trigger as well
  68. /// </summary>
  69. public Rune HotKey;
  70. /// <summary>
  71. /// This is the global setting that can be used as a global shortcut to invoke the action on the menu.
  72. /// </summary>
  73. public Key ShortCut;
  74. /// <summary>
  75. /// Gets or sets the title.
  76. /// </summary>
  77. /// <value>The title.</value>
  78. public ustring Title { get; set; }
  79. /// <summary>
  80. /// Gets or sets the help text for the menu item.
  81. /// </summary>
  82. /// <value>The help text.</value>
  83. public ustring Help { get; set; }
  84. /// <summary>
  85. /// Gets or sets the action to be invoked when the menu is triggered
  86. /// </summary>
  87. /// <value>Method to invoke.</value>
  88. public Action Action { get; set; }
  89. /// <summary>
  90. /// Gets or sets the action to be invoked if the menu can be triggered
  91. /// </summary>
  92. /// <value>Function to determine if action is ready to be executed.</value>
  93. public Func<bool> CanExecute { get; set; }
  94. /// <summary>
  95. /// Shortcut to check if the menu item is enabled
  96. /// </summary>
  97. public bool IsEnabled ()
  98. {
  99. return CanExecute == null ? true : CanExecute ();
  100. }
  101. internal int Width => Title.Length + Help.Length + 1 + 2;
  102. /// <summary>
  103. /// Gets or sets the parent for this <see cref="MenuItem"/>
  104. /// </summary>
  105. /// <value>The parent.</value>
  106. internal MenuBarItem SubMenu { get; set; }
  107. internal bool IsFromSubMenu { get; set; }
  108. /// <summary>
  109. /// Merely a debugging aid to see the interaction with main
  110. /// </summary>
  111. public MenuItem GetMenuItem ()
  112. {
  113. return this;
  114. }
  115. /// <summary>
  116. /// Merely a debugging aid to see the interaction with main
  117. /// </summary>
  118. public bool GetMenuBarItem ()
  119. {
  120. return IsFromSubMenu;
  121. }
  122. }
  123. /// <summary>
  124. /// A <see cref="MenuBarItem"/> contains <see cref="MenuBarItem"/>s or <see cref="MenuItem"/>s.
  125. /// </summary>
  126. public class MenuBarItem : MenuItem {
  127. /// <summary>
  128. /// Initializes a new <see cref="MenuBarItem"/> as a <see cref="MenuItem"/>.
  129. /// </summary>
  130. /// <param name="title">Title for the menu item.</param>
  131. /// <param name="help">Help text to display.</param>
  132. /// <param name="action">Action to invoke when the menu item is activated.</param>
  133. /// <param name="canExecute">Function to determine if the action can currently be executred.</param>
  134. public MenuBarItem (ustring title, string help, Action action, Func<bool> canExecute = null) : base (title, help, action, canExecute)
  135. {
  136. SetTitle (title ?? "");
  137. Children = null;
  138. }
  139. /// <summary>
  140. /// Initializes a new <see cref="MenuBarItem"/>.
  141. /// </summary>
  142. /// <param name="title">Title for the menu item.</param>
  143. /// <param name="children">The items in the current menu.</param>
  144. public MenuBarItem (ustring title, MenuItem [] children)
  145. {
  146. if (children == null)
  147. throw new ArgumentNullException (nameof (children), "The parameter cannot be null. Use an empty array instead.");
  148. SetTitle (title ?? "");
  149. Children = children;
  150. }
  151. /// <summary>
  152. /// Initializes a new <see cref="MenuBarItem"/>.
  153. /// </summary>
  154. /// <param name="children">The items in the current menu.</param>
  155. public MenuBarItem (MenuItem [] children) : this (new string (' ', GetMaxTitleLength (children)), children)
  156. {
  157. }
  158. static int GetMaxTitleLength (MenuItem [] children)
  159. {
  160. int maxLength = 0;
  161. foreach (var item in children) {
  162. int len = GetMenuBarItemLength (item.Title);
  163. if (len > maxLength)
  164. maxLength = len;
  165. item.IsFromSubMenu = true;
  166. }
  167. return maxLength;
  168. }
  169. void SetTitle (ustring title)
  170. {
  171. if (title == null)
  172. title = "";
  173. Title = title;
  174. TitleLength = GetMenuBarItemLength (Title);
  175. }
  176. static int GetMenuBarItemLength (ustring title)
  177. {
  178. int len = 0;
  179. foreach (var ch in title) {
  180. if (ch == '_')
  181. continue;
  182. len++;
  183. }
  184. return len;
  185. }
  186. ///// <summary>
  187. ///// Gets or sets the title to display.
  188. ///// </summary>
  189. ///// <value>The title.</value>
  190. //public ustring Title { get; set; }
  191. /// <summary>
  192. /// Gets or sets an array of <see cref="MenuItem"/> objects that are the children of this <see cref="MenuBarItem"/>
  193. /// </summary>
  194. /// <value>The children.</value>
  195. public MenuItem [] Children { get; set; }
  196. internal int TitleLength { get; private set; }
  197. internal bool IsTopLevel { get => (Children == null || Children.Length == 0); }
  198. }
  199. class Menu : View {
  200. internal MenuBarItem barItems;
  201. MenuBar host;
  202. internal int current;
  203. internal View previousSubFocused;
  204. static Rect MakeFrame (int x, int y, MenuItem [] items)
  205. {
  206. if (items == null || items.Length == 0) {
  207. return new Rect ();
  208. }
  209. int maxW = items.Max (z => z?.Width) ?? 0;
  210. return new Rect (x, y, maxW + 2, items.Length + 2);
  211. }
  212. public Menu (MenuBar host, int x, int y, MenuBarItem barItems) : base (MakeFrame (x, y, barItems.Children))
  213. {
  214. this.barItems = barItems;
  215. this.host = host;
  216. if (barItems.IsTopLevel) {
  217. // This is a standalone MenuItem on a MenuBar
  218. ColorScheme = Colors.Menu;
  219. CanFocus = true;
  220. } else {
  221. current = -1;
  222. for (int i = 0; i < barItems.Children.Length; i++) {
  223. if (barItems.Children [i] != null) {
  224. current = i;
  225. break;
  226. }
  227. }
  228. ColorScheme = Colors.Menu;
  229. CanFocus = true;
  230. WantMousePositionReports = host.WantMousePositionReports;
  231. }
  232. }
  233. internal Attribute DetermineColorSchemeFor (MenuItem item, int index)
  234. {
  235. if (item != null) {
  236. if (index == current) return ColorScheme.Focus;
  237. if (!item.IsEnabled ()) return ColorScheme.Disabled;
  238. }
  239. return ColorScheme.Normal;
  240. }
  241. public override void Redraw (Rect region)
  242. {
  243. Driver.SetAttribute (ColorScheme.Normal);
  244. DrawFrame (region, padding: 0, fill: true);
  245. for (int i = 0; i < barItems.Children.Length; i++) {
  246. var item = barItems.Children [i];
  247. Driver.SetAttribute (item == null ? ColorScheme.Normal : i == current ? ColorScheme.Focus : ColorScheme.Normal);
  248. if (item == null) {
  249. Move (0, i + 1);
  250. Driver.AddRune (Driver.LeftTee);
  251. } else
  252. Move (1, i + 1);
  253. Driver.SetAttribute (DetermineColorSchemeFor (item, i));
  254. for (int p = 0; p < Frame.Width - 2; p++)
  255. if (item == null)
  256. Driver.AddRune (Driver.HLine);
  257. else if (p == Frame.Width - 3 && barItems.Children [i].SubMenu != null)
  258. Driver.AddRune ('>');
  259. else
  260. Driver.AddRune (' ');
  261. if (item == null) {
  262. Move (Frame.Right - 1, i + 1);
  263. Driver.AddRune (Driver.RightTee);
  264. continue;
  265. }
  266. Move (2, i + 1);
  267. if (!item.IsEnabled ())
  268. DrawHotString (item.Title, ColorScheme.Disabled, ColorScheme.Disabled);
  269. else
  270. DrawHotString (item.Title,
  271. i == current ? ColorScheme.HotFocus : ColorScheme.HotNormal,
  272. i == current ? ColorScheme.Focus : ColorScheme.Normal);
  273. // The help string
  274. var l = item.Help.Length;
  275. Move (Frame.Width - l - 2, 1 + i);
  276. Driver.AddStr (item.Help);
  277. }
  278. PositionCursor ();
  279. }
  280. public override void PositionCursor ()
  281. {
  282. if (host == null || !host.isMenuClosed)
  283. if (barItems.IsTopLevel) {
  284. host.PositionCursor ();
  285. } else
  286. Move (2, 1 + current);
  287. else
  288. host.PositionCursor ();
  289. }
  290. public void Run (Action action)
  291. {
  292. if (action == null)
  293. return;
  294. Application.UngrabMouse ();
  295. host.CloseAllMenus ();
  296. Application.Refresh ();
  297. Application.MainLoop.AddIdle (() => {
  298. action ();
  299. return false;
  300. });
  301. }
  302. public override bool OnKeyDown (KeyEvent keyEvent)
  303. {
  304. if (keyEvent.IsAlt) {
  305. host.CloseAllMenus ();
  306. return true;
  307. }
  308. return false;
  309. }
  310. public override bool ProcessHotKey (KeyEvent keyEvent)
  311. {
  312. // To ncurses simulate a AltMask key pressing Alt+Space because
  313. // it can�t detect an alone special key down was pressed.
  314. if (keyEvent.IsAlt && keyEvent.Key == Key.AltMask) {
  315. OnKeyDown (keyEvent);
  316. return true;
  317. }
  318. return false;
  319. }
  320. public override bool ProcessKey (KeyEvent kb)
  321. {
  322. bool disabled;
  323. switch (kb.Key) {
  324. case Key.CursorUp:
  325. if (barItems.IsTopLevel || current == -1)
  326. break;
  327. do {
  328. disabled = false;
  329. current--;
  330. if (host.UseKeysUpDownAsKeysLeftRight) {
  331. if (current == -1 && barItems.Children [current + 1].IsFromSubMenu && host.selectedSub > -1) {
  332. current++;
  333. host.PreviousMenu (true);
  334. break;
  335. }
  336. }
  337. if (current < 0)
  338. current = barItems.Children.Length - 1;
  339. var item = barItems.Children [current];
  340. if (item == null || !item.IsEnabled ()) disabled = true;
  341. } while (barItems.Children [current] == null || disabled);
  342. SetNeedsDisplay ();
  343. break;
  344. case Key.CursorDown:
  345. if (barItems.IsTopLevel) {
  346. break;
  347. }
  348. do {
  349. current++;
  350. disabled = false;
  351. if (current == barItems.Children.Length)
  352. current = 0;
  353. var item = barItems.Children [current];
  354. if (item == null || !item.IsEnabled ()) disabled = true;
  355. if (host.UseKeysUpDownAsKeysLeftRight && barItems.Children [current]?.SubMenu != null &&
  356. !disabled && !host.isMenuClosed) {
  357. CheckSubMenu ();
  358. break;
  359. }
  360. if (host.isMenuClosed)
  361. host.OpenMenu (host.selected);
  362. } while (barItems.Children [current] == null || disabled);
  363. SetNeedsDisplay ();
  364. break;
  365. case Key.CursorLeft:
  366. host.PreviousMenu (true);
  367. break;
  368. case Key.CursorRight:
  369. host.NextMenu (barItems.IsTopLevel || barItems.Children [current].IsFromSubMenu ? true : false);
  370. break;
  371. case Key.Esc:
  372. Application.UngrabMouse ();
  373. host.CloseAllMenus ();
  374. break;
  375. case Key.Enter:
  376. if (barItems.IsTopLevel) {
  377. Run (barItems.Action);
  378. } else {
  379. CheckSubMenu ();
  380. Run (barItems.Children [current].Action);
  381. }
  382. break;
  383. default:
  384. // TODO: rune-ify
  385. if (barItems.Children != null && Char.IsLetterOrDigit ((char)kb.KeyValue)) {
  386. var x = Char.ToUpper ((char)kb.KeyValue);
  387. foreach (var item in barItems.Children) {
  388. if (item == null) continue;
  389. if (item.IsEnabled () && item.HotKey == x) {
  390. host.CloseMenu ();
  391. Run (item.Action);
  392. return true;
  393. }
  394. }
  395. }
  396. break;
  397. }
  398. return true;
  399. }
  400. public override bool MouseEvent (MouseEvent me)
  401. {
  402. if (!host.handled && !host.HandleGrabView (me, this)) {
  403. return false;
  404. }
  405. host.handled = false;
  406. bool disabled;
  407. if (me.Flags == MouseFlags.Button1Clicked) {
  408. disabled = false;
  409. if (me.Y < 1)
  410. return true;
  411. var meY = me.Y - 1;
  412. if (meY >= barItems.Children.Length)
  413. return true;
  414. var item = barItems.Children [meY];
  415. if (item == null || !item.IsEnabled ()) disabled = true;
  416. if (item != null && !disabled)
  417. Run (barItems.Children [meY].Action);
  418. return true;
  419. } else if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked ||
  420. me.Flags == MouseFlags.ReportMousePosition ||
  421. me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition)) {
  422. disabled = false;
  423. if (me.Y < 1)
  424. return true;
  425. if (me.Y - 1 >= barItems.Children.Length)
  426. return true;
  427. var item = barItems.Children [me.Y - 1];
  428. if (item == null || !item.IsEnabled ()) disabled = true;
  429. if (item != null && !disabled)
  430. current = me.Y - 1;
  431. HasFocus = true;
  432. SetNeedsDisplay ();
  433. CheckSubMenu ();
  434. return true;
  435. }
  436. return false;
  437. }
  438. internal void CheckSubMenu ()
  439. {
  440. if (barItems.Children [current] == null)
  441. return;
  442. var subMenu = barItems.Children [current].SubMenu;
  443. if (subMenu != null) {
  444. int pos = -1;
  445. if (host.openSubMenu != null)
  446. pos = host.openSubMenu.FindIndex (o => o?.barItems == subMenu);
  447. host.Activate (host.selected, pos, subMenu);
  448. } else if (host.openSubMenu != null && !barItems.Children [current].IsFromSubMenu)
  449. host.CloseMenu (false, true);
  450. }
  451. int GetSubMenuIndex (MenuBarItem subMenu)
  452. {
  453. int pos = -1;
  454. if (this != null && Subviews.Count > 0) {
  455. Menu v = null;
  456. foreach (var menu in Subviews) {
  457. if (((Menu)menu).barItems == subMenu)
  458. v = (Menu)menu;
  459. }
  460. if (v != null)
  461. pos = Subviews.IndexOf (v);
  462. }
  463. return pos;
  464. }
  465. }
  466. /// <summary>
  467. /// The MenuBar provides a menu for Terminal.Gui applications.
  468. /// </summary>
  469. /// <remarks>
  470. /// <para>
  471. /// The <see cref="MenuBar"/> appears on the first row of the terminal.
  472. /// </para>
  473. /// <para>
  474. /// The <see cref="MenuBar"/> provides global hotkeys for the application.
  475. /// </para>
  476. /// </remarks>
  477. public class MenuBar : View {
  478. /// <summary>
  479. /// Gets or sets the array of <see cref="MenuBarItem"/>s for the menu. Only set this when the <see cref="MenuBar"/> is vislble.
  480. /// </summary>
  481. /// <value>The menu array.</value>
  482. public MenuBarItem [] Menus { get; set; }
  483. internal int selected;
  484. internal int selectedSub;
  485. Action action;
  486. /// <summary>
  487. /// Used for change the navigation key style.
  488. /// </summary>
  489. public bool UseKeysUpDownAsKeysLeftRight { get; set; } = true;
  490. /// <summary>
  491. /// Initializes a new instance of the <see cref="MenuBar"/> class with the specified set of toplevel menu items.
  492. /// </summary>
  493. /// <param name="menus">Individual menu items; a null item will result in a separator being drawn.</param>
  494. public MenuBar (MenuBarItem [] menus) : base ()
  495. {
  496. X = 0;
  497. Y = 0;
  498. Width = Dim.Fill ();
  499. Height = 1;
  500. Menus = menus;
  501. //CanFocus = true;
  502. selected = -1;
  503. selectedSub = -1;
  504. ColorScheme = Colors.Menu;
  505. WantMousePositionReports = true;
  506. isMenuClosed = true;
  507. }
  508. bool openedByAltKey;
  509. ///<inheritdoc cref="OnKeyDown"/>
  510. public override bool OnKeyDown (KeyEvent keyEvent)
  511. {
  512. if (keyEvent.IsAlt) {
  513. openedByAltKey = true;
  514. SetNeedsDisplay ();
  515. openedByHotKey = false;
  516. }
  517. return false;
  518. }
  519. ///<inheritdoc cref="OnKeyUp"/>
  520. public override bool OnKeyUp (KeyEvent keyEvent)
  521. {
  522. if (keyEvent.IsAlt) {
  523. // User pressed Alt - this may be a precursor to a menu accelerator (e.g. Alt-F)
  524. if (!keyEvent.IsCtrl && openedByAltKey && isMenuClosed && openMenu == null && ((uint)keyEvent.Key & (uint)Key.CharMask) == 0) {
  525. // There's no open menu, the first menu item should be highlight.
  526. // The right way to do this is to SetFocus(MenuBar), but for some reason
  527. // that faults.
  528. //Activate (0);
  529. //StartMenu ();
  530. isMenuClosed = false;
  531. selected = 0;
  532. CanFocus = true;
  533. lastFocused = SuperView.MostFocused;
  534. SuperView.SetFocus (this);
  535. SetNeedsDisplay ();
  536. Application.GrabMouse (this);
  537. } else if (!openedByHotKey) {
  538. // There's an open menu. If this Alt key-up is a pre-cursor to an accelerator
  539. // we don't want to close the menu because it'll flash.
  540. // How to deal with that?
  541. if (openMenu != null)
  542. CloseAllMenus ();
  543. openedByAltKey = false;
  544. isMenuClosed = true;
  545. selected = -1;
  546. CanFocus = false;
  547. if (lastFocused != null)
  548. SuperView?.SetFocus (lastFocused);
  549. SetNeedsDisplay ();
  550. Application.UngrabMouse ();
  551. }
  552. return true;
  553. }
  554. return false;
  555. }
  556. ///<inheritdoc cref="Redraw"/>
  557. public override void Redraw (Rect region)
  558. {
  559. Move (0, 0);
  560. Driver.SetAttribute (Colors.Menu.Normal);
  561. for (int i = 0; i < Frame.Width; i++)
  562. Driver.AddRune (' ');
  563. Move (1, 0);
  564. int pos = 1;
  565. for (int i = 0; i < Menus.Length; i++) {
  566. var menu = Menus [i];
  567. Move (pos, 0);
  568. Attribute hotColor, normalColor;
  569. if (i == selected) {
  570. hotColor = i == selected ? ColorScheme.HotFocus : ColorScheme.HotNormal;
  571. normalColor = i == selected ? ColorScheme.Focus : ColorScheme.Normal;
  572. } else if (openedByAltKey) {
  573. hotColor = ColorScheme.HotNormal;
  574. normalColor = ColorScheme.Normal;
  575. } else {
  576. hotColor = ColorScheme.Normal;
  577. normalColor = ColorScheme.Normal;
  578. }
  579. DrawHotString ($" {menu.Title} ", hotColor, normalColor);
  580. pos += 1 + menu.TitleLength + 2;
  581. }
  582. PositionCursor ();
  583. }
  584. ///<inheritdoc cref="PositionCursor"/>
  585. public override void PositionCursor ()
  586. {
  587. int pos = 0;
  588. for (int i = 0; i < Menus.Length; i++) {
  589. if (i == selected) {
  590. pos++;
  591. if (!isMenuClosed)
  592. Move (pos + 1, 0);
  593. else
  594. Move (pos + 1, 0);
  595. return;
  596. } else {
  597. if (!isMenuClosed)
  598. pos += 1 + Menus [i].TitleLength + 2;
  599. else
  600. pos += 2 + Menus [i].TitleLength + 1;
  601. }
  602. }
  603. //Move (0, 0);
  604. }
  605. void Selected (MenuItem item)
  606. {
  607. // TODO: Running = false;
  608. action = item.Action;
  609. }
  610. /// <summary>
  611. /// Raised as a menu is opened.
  612. /// </summary>
  613. public event EventHandler OnOpenMenu;
  614. /// <summary>
  615. /// Raised when a menu is closing.
  616. /// </summary>
  617. public event EventHandler OnCloseMenu;
  618. internal Menu openMenu;
  619. Menu openCurrentMenu;
  620. internal List<Menu> openSubMenu;
  621. View previousFocused;
  622. internal bool isMenuOpening;
  623. internal bool isMenuClosing;
  624. internal bool isMenuClosed;
  625. /// <summary>
  626. /// True of the menu is open; otherwise false.
  627. /// </summary>
  628. public bool MenuOpen { get; set; }
  629. View lastFocused;
  630. /// <summary>
  631. /// Get the lasted focused view before open the menu.
  632. /// </summary>
  633. public View LastFocused { get; private set; }
  634. internal void OpenMenu (int index, int sIndex = -1, MenuBarItem subMenu = null)
  635. {
  636. isMenuOpening = true;
  637. OnOpenMenu?.Invoke (this, null);
  638. int pos = 0;
  639. switch (subMenu) {
  640. case null:
  641. lastFocused = lastFocused ?? SuperView.MostFocused;
  642. if (openSubMenu != null)
  643. CloseMenu (false, true);
  644. if (openMenu != null)
  645. SuperView.Remove (openMenu);
  646. for (int i = 0; i < index; i++)
  647. pos += Menus [i].Title.Length + 2;
  648. openMenu = new Menu (this, pos, 1, Menus [index]);
  649. openCurrentMenu = openMenu;
  650. openCurrentMenu.previousSubFocused = openMenu;
  651. SuperView.Add (openMenu);
  652. SuperView.SetFocus (openMenu);
  653. break;
  654. default:
  655. if (openSubMenu == null)
  656. openSubMenu = new List<Menu> ();
  657. if (sIndex > -1) {
  658. RemoveSubMenu (sIndex);
  659. } else {
  660. var last = openSubMenu.Count > 0 ? openSubMenu.Last () : openMenu;
  661. openCurrentMenu = new Menu (this, last.Frame.Left + last.Frame.Width, last.Frame.Top + 1 + last.current, subMenu);
  662. openCurrentMenu.previousSubFocused = last.previousSubFocused;
  663. openSubMenu.Add (openCurrentMenu);
  664. SuperView.Add (openCurrentMenu);
  665. }
  666. selectedSub = openSubMenu.Count - 1;
  667. SuperView?.SetFocus (openCurrentMenu);
  668. break;
  669. }
  670. isMenuOpening = false;
  671. isMenuClosed = false;
  672. MenuOpen = true;
  673. }
  674. // Starts the menu from a hotkey
  675. void StartMenu ()
  676. {
  677. if (openMenu != null)
  678. return;
  679. selected = 0;
  680. SetNeedsDisplay ();
  681. previousFocused = SuperView.Focused;
  682. OpenMenu (selected);
  683. Application.GrabMouse (this);
  684. }
  685. // Activates the menu, handles either first focus, or activating an entry when it was already active
  686. // For mouse events.
  687. internal void Activate (int idx, int sIdx = -1, MenuBarItem subMenu = null)
  688. {
  689. selected = idx;
  690. selectedSub = sIdx;
  691. if (openMenu == null)
  692. previousFocused = SuperView.Focused;
  693. OpenMenu (idx, sIdx, subMenu);
  694. SetNeedsDisplay ();
  695. }
  696. internal void CloseMenu (bool reopen = false, bool isSubMenu = false)
  697. {
  698. isMenuClosing = true;
  699. OnCloseMenu?.Invoke (this, null);
  700. switch (isSubMenu) {
  701. case false:
  702. if (openMenu != null)
  703. SuperView.Remove (openMenu);
  704. SetNeedsDisplay ();
  705. if (previousFocused != null && openMenu != null && previousFocused.ToString () != openCurrentMenu.ToString ())
  706. previousFocused?.SuperView?.SetFocus (previousFocused);
  707. openMenu = null;
  708. if (lastFocused is Menu) {
  709. lastFocused = null;
  710. }
  711. LastFocused = lastFocused;
  712. lastFocused = null;
  713. if (LastFocused != null) {
  714. if (!reopen)
  715. selected = -1;
  716. LastFocused.SuperView?.SetFocus (LastFocused);
  717. } else {
  718. SuperView.SetFocus (this);
  719. isMenuClosed = true;
  720. PositionCursor ();
  721. }
  722. isMenuClosed = true;
  723. break;
  724. case true:
  725. selectedSub = -1;
  726. SetNeedsDisplay ();
  727. RemoveAllOpensSubMenus ();
  728. openCurrentMenu.previousSubFocused?.SuperView?.SetFocus (openCurrentMenu.previousSubFocused);
  729. openSubMenu = null;
  730. break;
  731. }
  732. isMenuClosing = false;
  733. MenuOpen = false;
  734. }
  735. void RemoveSubMenu (int index)
  736. {
  737. if (openSubMenu == null)
  738. return;
  739. for (int i = openSubMenu.Count - 1; i > index; i--) {
  740. isMenuClosing = true;
  741. if (openSubMenu.Count - 1 > 0)
  742. SuperView.SetFocus (openSubMenu [i - 1]);
  743. else
  744. SuperView.SetFocus (openMenu);
  745. if (openSubMenu != null) {
  746. SuperView.Remove (openSubMenu [i]);
  747. openSubMenu.Remove (openSubMenu [i]);
  748. }
  749. RemoveSubMenu (i);
  750. }
  751. if (openSubMenu.Count > 0)
  752. openCurrentMenu = openSubMenu.Last ();
  753. //if (openMenu.Subviews.Count == 0)
  754. // return;
  755. //if (index == 0) {
  756. // //SuperView.SetFocus (previousSubFocused);
  757. // FocusPrev ();
  758. // return;
  759. //}
  760. //for (int i = openMenu.Subviews.Count - 1; i > index; i--) {
  761. // isMenuClosing = true;
  762. // if (openMenu.Subviews.Count - 1 > 0)
  763. // SuperView.SetFocus (openMenu.Subviews [i - 1]);
  764. // else
  765. // SuperView.SetFocus (openMenu);
  766. // if (openMenu != null) {
  767. // Remove (openMenu.Subviews [i]);
  768. // openMenu.Remove (openMenu.Subviews [i]);
  769. // }
  770. // RemoveSubMenu (i);
  771. //}
  772. isMenuClosing = false;
  773. }
  774. internal void RemoveAllOpensSubMenus ()
  775. {
  776. if (openSubMenu != null) {
  777. foreach (var item in openSubMenu) {
  778. SuperView.Remove (item);
  779. }
  780. }
  781. }
  782. internal void CloseAllMenus ()
  783. {
  784. if (!isMenuOpening && !isMenuClosing) {
  785. if (openSubMenu != null)
  786. CloseMenu (false, true);
  787. CloseMenu ();
  788. if (LastFocused != null && LastFocused != this)
  789. selected = -1;
  790. }
  791. isMenuClosed = true;
  792. openedByHotKey = false;
  793. openedByAltKey = false;
  794. }
  795. View FindDeepestMenu (View view, ref int count)
  796. {
  797. count = count > 0 ? count : 0;
  798. foreach (var menu in view.Subviews) {
  799. if (menu is Menu) {
  800. count++;
  801. return FindDeepestMenu ((Menu)menu, ref count);
  802. }
  803. }
  804. return view;
  805. }
  806. internal void PreviousMenu (bool isSubMenu = false)
  807. {
  808. switch (isSubMenu) {
  809. case false:
  810. if (selected <= 0)
  811. selected = Menus.Length - 1;
  812. else
  813. selected--;
  814. if (selected > -1)
  815. CloseMenu (true, false);
  816. OpenMenu (selected);
  817. break;
  818. case true:
  819. if (selectedSub > -1) {
  820. selectedSub--;
  821. RemoveSubMenu (selectedSub);
  822. SetNeedsDisplay ();
  823. } else
  824. PreviousMenu ();
  825. break;
  826. }
  827. }
  828. internal void NextMenu (bool isSubMenu = false)
  829. {
  830. switch (isSubMenu) {
  831. case false:
  832. if (selected == -1)
  833. selected = 0;
  834. else if (selected + 1 == Menus.Length)
  835. selected = 0;
  836. else
  837. selected++;
  838. if (selected > -1)
  839. CloseMenu (true);
  840. OpenMenu (selected);
  841. break;
  842. case true:
  843. if (UseKeysUpDownAsKeysLeftRight) {
  844. CloseMenu (false, true);
  845. NextMenu ();
  846. } else {
  847. if ((selectedSub == -1 || openSubMenu == null || openSubMenu?.Count == selectedSub) && openCurrentMenu.barItems.Children [openCurrentMenu.current].SubMenu == null) {
  848. if (openSubMenu != null)
  849. CloseMenu (false, true);
  850. NextMenu ();
  851. } else if (openCurrentMenu.barItems.Children [openCurrentMenu.current].SubMenu != null ||
  852. !openCurrentMenu.barItems.Children [openCurrentMenu.current].IsFromSubMenu)
  853. selectedSub++;
  854. else
  855. return;
  856. SetNeedsDisplay ();
  857. openCurrentMenu.CheckSubMenu ();
  858. }
  859. break;
  860. }
  861. }
  862. bool openedByHotKey;
  863. internal bool FindAndOpenMenuByHotkey (KeyEvent kb)
  864. {
  865. //int pos = 0;
  866. var c = ((uint)kb.Key & (uint)Key.CharMask);
  867. for (int i = 0; i < Menus.Length; i++) {
  868. // TODO: this code is duplicated, hotkey should be part of the MenuBarItem
  869. var mi = Menus [i];
  870. int p = mi.Title.IndexOf ('_');
  871. if (p != -1 && p + 1 < mi.Title.Length) {
  872. if (Char.ToUpperInvariant ((char)mi.Title [p + 1]) == c) {
  873. ProcessMenu (i, mi);
  874. return true;
  875. }
  876. }
  877. }
  878. return false;
  879. }
  880. private void ProcessMenu (int i, MenuBarItem mi)
  881. {
  882. if (mi.IsTopLevel) {
  883. var menu = new Menu (this, i, 0, mi);
  884. menu.Run (mi.Action);
  885. } else {
  886. openedByHotKey = true;
  887. Application.GrabMouse (this);
  888. selected = i;
  889. OpenMenu (i);
  890. }
  891. }
  892. ///<inheritdoc cref="ProcessHotKey"/>
  893. public override bool ProcessHotKey (KeyEvent kb)
  894. {
  895. if (kb.Key == Key.F9) {
  896. if (isMenuClosed)
  897. StartMenu ();
  898. else
  899. CloseAllMenus ();
  900. return true;
  901. }
  902. // To ncurses simulate a AltMask key pressing Alt+Space because
  903. // it can�t detect an alone special key down was pressed.
  904. if (kb.IsAlt && kb.Key == Key.AltMask && openMenu == null) {
  905. OnKeyDown (kb);
  906. OnKeyUp (kb);
  907. return true;
  908. } else if (kb.IsAlt) {
  909. if (FindAndOpenMenuByHotkey (kb)) return true;
  910. }
  911. //var kc = kb.KeyValue;
  912. return base.ProcessHotKey (kb);
  913. }
  914. ///<inheritdoc cref="ProcessKey"/>
  915. public override bool ProcessKey (KeyEvent kb)
  916. {
  917. switch (kb.Key) {
  918. case Key.CursorLeft:
  919. selected--;
  920. if (selected < 0)
  921. selected = Menus.Length - 1;
  922. break;
  923. case Key.CursorRight:
  924. selected = (selected + 1) % Menus.Length;
  925. break;
  926. case Key.Esc:
  927. case Key.ControlC:
  928. //TODO: Running = false;
  929. CloseMenu ();
  930. if (openedByAltKey) {
  931. openedByAltKey = false;
  932. LastFocused.SuperView?.SetFocus (LastFocused);
  933. }
  934. break;
  935. case Key.CursorDown:
  936. case Key.Enter:
  937. ProcessMenu (selected, Menus [selected]);
  938. break;
  939. default:
  940. var key = kb.KeyValue;
  941. if ((key >= 'a' && key <= 'z') || (key >= 'A' && key <= 'Z') || (key >= '0' && key <= '9')) {
  942. char c = Char.ToUpper ((char)key);
  943. if (selected == -1 || Menus [selected].IsTopLevel)
  944. return false;
  945. foreach (var mi in Menus [selected].Children) {
  946. if (mi == null)
  947. continue;
  948. int p = mi.Title.IndexOf ('_');
  949. if (p != -1 && p + 1 < mi.Title.Length) {
  950. if (mi.Title [p + 1] == c) {
  951. Selected (mi);
  952. return true;
  953. }
  954. }
  955. }
  956. }
  957. return false;
  958. }
  959. SetNeedsDisplay ();
  960. return true;
  961. }
  962. ///<inheritdoc cref="MouseEvent"/>
  963. public override bool MouseEvent (MouseEvent me)
  964. {
  965. if (!handled && !HandleGrabView (me, this)) {
  966. return false;
  967. }
  968. handled = false;
  969. if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1Clicked || me.Flags == MouseFlags.Button1DoubleClicked ||
  970. (me.Flags == MouseFlags.ReportMousePosition && selected > -1) ||
  971. (me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) && selected > -1)) {
  972. int pos = 1;
  973. int cx = me.X;
  974. for (int i = 0; i < Menus.Length; i++) {
  975. if (cx > pos && me.X < pos + 1 + Menus [i].TitleLength) {
  976. if (selected == i && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) &&
  977. !isMenuClosed) {
  978. Application.UngrabMouse ();
  979. if (Menus [i].IsTopLevel) {
  980. var menu = new Menu (this, i, 0, Menus [i]);
  981. menu.Run (Menus [i].Action);
  982. } else {
  983. CloseMenu ();
  984. }
  985. } else if ((me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) &&
  986. isMenuClosed) {
  987. if (Menus [i].IsTopLevel) {
  988. var menu = new Menu (this, i, 0, Menus [i]);
  989. menu.Run (Menus [i].Action);
  990. } else {
  991. Activate (i);
  992. }
  993. } else if (selected != i && selected > -1 && me.Flags == MouseFlags.ReportMousePosition) {
  994. if (!isMenuClosed) {
  995. CloseMenu ();
  996. Activate (i);
  997. }
  998. } else {
  999. if (!isMenuClosed)
  1000. Activate (i);
  1001. }
  1002. return true;
  1003. }
  1004. pos += 2 + Menus [i].TitleLength + 1;
  1005. }
  1006. }
  1007. return false;
  1008. }
  1009. internal bool handled;
  1010. internal bool HandleGrabView (MouseEvent me, View current)
  1011. {
  1012. if (Application.mouseGrabView != null) {
  1013. if (me.View is MenuBar || me.View is Menu) {
  1014. if (me.View != current) {
  1015. Application.UngrabMouse ();
  1016. Application.GrabMouse (me.View);
  1017. me.View.MouseEvent (me);
  1018. }
  1019. } else if (!(me.View is MenuBar || me.View is Menu) && (me.Flags.HasFlag (MouseFlags.Button1Clicked) ||
  1020. me.Flags == MouseFlags.Button1DoubleClicked || me.Flags == MouseFlags.Button1Pressed)) {
  1021. Application.UngrabMouse ();
  1022. CloseAllMenus ();
  1023. handled = false;
  1024. return false;
  1025. } else {
  1026. handled = false;
  1027. return false;
  1028. }
  1029. } else if (isMenuClosed && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked ||
  1030. me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))) {
  1031. Application.GrabMouse (current);
  1032. } else {
  1033. handled = false;
  1034. return false;
  1035. }
  1036. //if (me.View != this && (me.Flags != MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked))
  1037. // return true;
  1038. //else if (me.View != this && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked)) {
  1039. // Application.UngrabMouse ();
  1040. // host.CloseAllMenus ();
  1041. // return true;
  1042. //}
  1043. //if (!(me.View is MenuBar) && !(me.View is Menu) && (me.Flags != MouseFlags.Button1Pressed ||
  1044. // me.Flags != MouseFlags.Button1DoubleClicked))
  1045. // return false;
  1046. //if (Application.mouseGrabView != null) {
  1047. // if (me.View is MenuBar || me.View is Menu) {
  1048. // me.X -= me.OfX;
  1049. // me.Y -= me.OfY;
  1050. // me.View.MouseEvent (me);
  1051. // return true;
  1052. // } else if (!(me.View is MenuBar || me.View is Menu) && (me.Flags == MouseFlags.Button1Pressed ||
  1053. // me.Flags == MouseFlags.Button1DoubleClicked)) {
  1054. // Application.UngrabMouse ();
  1055. // CloseAllMenus ();
  1056. // }
  1057. //} else if (!isMenuClosed && selected == -1 && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked)) {
  1058. // Application.GrabMouse (this);
  1059. // return true;
  1060. //}
  1061. //if (Application.mouseGrabView != null) {
  1062. // if (Application.mouseGrabView == me.View && me.View == current) {
  1063. // me.X -= me.OfX;
  1064. // me.Y -= me.OfY;
  1065. // } else if (me.View != current && me.View is MenuBar && me.View is Menu) {
  1066. // Application.UngrabMouse ();
  1067. // Application.GrabMouse (me.View);
  1068. // } else if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  1069. // Application.UngrabMouse ();
  1070. // CloseMenu ();
  1071. // }
  1072. //} else if ((!isMenuClosed && selected > -1)) {
  1073. // Application.GrabMouse (current);
  1074. //}
  1075. handled = true;
  1076. return true;
  1077. }
  1078. }
  1079. }