Menu.cs 32 KB

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