Menu.cs 31 KB

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