Menu.cs 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212
  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 opened.
  618. /// </summary>
  619. public event EventHandler OnOpenMenu;
  620. /// <summary>
  621. /// Raised when a menu is closing.
  622. /// </summary>
  623. public event EventHandler OnCloseMenu;
  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. View lastFocused;
  635. /// <summary>
  636. /// Get the lasted focused view before open the menu.
  637. /// </summary>
  638. public View LastFocused { get; private set; }
  639. internal void OpenMenu (int index, int sIndex = -1, MenuBarItem subMenu = null)
  640. {
  641. isMenuOpening = true;
  642. OnOpenMenu?.Invoke (this, null);
  643. int pos = 0;
  644. switch (subMenu) {
  645. case null:
  646. lastFocused = lastFocused ?? SuperView.MostFocused;
  647. if (openSubMenu != null)
  648. CloseMenu (false, true);
  649. if (openMenu != null)
  650. SuperView.Remove (openMenu);
  651. for (int i = 0; i < index; i++)
  652. pos += Menus [i].Title.Length + 2;
  653. openMenu = new Menu (this, pos, 1, Menus [index]);
  654. openCurrentMenu = openMenu;
  655. openCurrentMenu.previousSubFocused = openMenu;
  656. SuperView.Add (openMenu);
  657. SuperView.SetFocus (openMenu);
  658. break;
  659. default:
  660. if (openSubMenu == null)
  661. openSubMenu = new List<Menu> ();
  662. if (sIndex > -1) {
  663. RemoveSubMenu (sIndex);
  664. } else {
  665. var last = openSubMenu.Count > 0 ? openSubMenu.Last () : openMenu;
  666. openCurrentMenu = new Menu (this, last.Frame.Left + last.Frame.Width, last.Frame.Top + 1 + last.current, subMenu);
  667. openCurrentMenu.previousSubFocused = last.previousSubFocused;
  668. openSubMenu.Add (openCurrentMenu);
  669. SuperView.Add (openCurrentMenu);
  670. }
  671. selectedSub = openSubMenu.Count - 1;
  672. SuperView?.SetFocus (openCurrentMenu);
  673. break;
  674. }
  675. isMenuOpening = false;
  676. IsMenuOpen = true;
  677. }
  678. /// <summary>
  679. /// Opens the current Menu programatically.
  680. /// </summary>
  681. public void OpenMenu ()
  682. {
  683. if (openMenu != null)
  684. return;
  685. selected = 0;
  686. SetNeedsDisplay ();
  687. previousFocused = SuperView.Focused;
  688. OpenMenu (selected);
  689. Application.GrabMouse (this);
  690. }
  691. // Activates the menu, handles either first focus, or activating an entry when it was already active
  692. // For mouse events.
  693. internal void Activate (int idx, int sIdx = -1, MenuBarItem subMenu = null)
  694. {
  695. selected = idx;
  696. selectedSub = sIdx;
  697. if (openMenu == null)
  698. previousFocused = SuperView.Focused;
  699. OpenMenu (idx, sIdx, subMenu);
  700. SetNeedsDisplay ();
  701. }
  702. /// <summary>
  703. /// Closes the current Menu programatically, if open.
  704. /// </summary>
  705. public void CloseMenu ()
  706. {
  707. CloseMenu (false, false);
  708. }
  709. internal void CloseMenu (bool reopen = false, bool isSubMenu = false)
  710. {
  711. isMenuClosing = true;
  712. OnCloseMenu?.Invoke (this, null);
  713. switch (isSubMenu) {
  714. case false:
  715. if (openMenu != null)
  716. SuperView.Remove (openMenu);
  717. SetNeedsDisplay ();
  718. if (previousFocused != null && openMenu != null && previousFocused.ToString () != openCurrentMenu.ToString ())
  719. previousFocused?.SuperView?.SetFocus (previousFocused);
  720. openMenu = null;
  721. if (lastFocused is Menu) {
  722. lastFocused = null;
  723. }
  724. LastFocused = lastFocused;
  725. lastFocused = null;
  726. if (LastFocused != null) {
  727. if (!reopen)
  728. selected = -1;
  729. LastFocused.SuperView?.SetFocus (LastFocused);
  730. } else {
  731. SuperView.SetFocus (this);
  732. PositionCursor ();
  733. }
  734. IsMenuOpen = false;
  735. break;
  736. case true:
  737. selectedSub = -1;
  738. SetNeedsDisplay ();
  739. RemoveAllOpensSubMenus ();
  740. openCurrentMenu.previousSubFocused?.SuperView?.SetFocus (openCurrentMenu.previousSubFocused);
  741. openSubMenu = null;
  742. IsMenuOpen = true;
  743. break;
  744. }
  745. isMenuClosing = false;
  746. }
  747. void RemoveSubMenu (int index)
  748. {
  749. if (openSubMenu == null)
  750. return;
  751. for (int i = openSubMenu.Count - 1; i > index; i--) {
  752. isMenuClosing = true;
  753. if (openSubMenu.Count - 1 > 0)
  754. SuperView.SetFocus (openSubMenu [i - 1]);
  755. else
  756. SuperView.SetFocus (openMenu);
  757. if (openSubMenu != null) {
  758. SuperView.Remove (openSubMenu [i]);
  759. openSubMenu.Remove (openSubMenu [i]);
  760. }
  761. RemoveSubMenu (i);
  762. }
  763. if (openSubMenu.Count > 0)
  764. openCurrentMenu = openSubMenu.Last ();
  765. //if (openMenu.Subviews.Count == 0)
  766. // return;
  767. //if (index == 0) {
  768. // //SuperView.SetFocus (previousSubFocused);
  769. // FocusPrev ();
  770. // return;
  771. //}
  772. //for (int i = openMenu.Subviews.Count - 1; i > index; i--) {
  773. // isMenuClosing = true;
  774. // if (openMenu.Subviews.Count - 1 > 0)
  775. // SuperView.SetFocus (openMenu.Subviews [i - 1]);
  776. // else
  777. // SuperView.SetFocus (openMenu);
  778. // if (openMenu != null) {
  779. // Remove (openMenu.Subviews [i]);
  780. // openMenu.Remove (openMenu.Subviews [i]);
  781. // }
  782. // RemoveSubMenu (i);
  783. //}
  784. isMenuClosing = false;
  785. }
  786. internal void RemoveAllOpensSubMenus ()
  787. {
  788. if (openSubMenu != null) {
  789. foreach (var item in openSubMenu) {
  790. SuperView.Remove (item);
  791. }
  792. }
  793. }
  794. internal void CloseAllMenus ()
  795. {
  796. if (!isMenuOpening && !isMenuClosing) {
  797. if (openSubMenu != null)
  798. CloseMenu (false, true);
  799. CloseMenu ();
  800. if (LastFocused != null && LastFocused != this)
  801. selected = -1;
  802. }
  803. IsMenuOpen = false;
  804. openedByHotKey = false;
  805. openedByAltKey = false;
  806. }
  807. View FindDeepestMenu (View view, ref int count)
  808. {
  809. count = count > 0 ? count : 0;
  810. foreach (var menu in view.Subviews) {
  811. if (menu is Menu) {
  812. count++;
  813. return FindDeepestMenu ((Menu)menu, ref count);
  814. }
  815. }
  816. return view;
  817. }
  818. internal void PreviousMenu (bool isSubMenu = false)
  819. {
  820. switch (isSubMenu) {
  821. case false:
  822. if (selected <= 0)
  823. selected = Menus.Length - 1;
  824. else
  825. selected--;
  826. if (selected > -1)
  827. CloseMenu (true, false);
  828. OpenMenu (selected);
  829. break;
  830. case true:
  831. if (selectedSub > -1) {
  832. selectedSub--;
  833. RemoveSubMenu (selectedSub);
  834. SetNeedsDisplay ();
  835. } else
  836. PreviousMenu ();
  837. break;
  838. }
  839. }
  840. internal void NextMenu (bool isSubMenu = false)
  841. {
  842. switch (isSubMenu) {
  843. case false:
  844. if (selected == -1)
  845. selected = 0;
  846. else if (selected + 1 == Menus.Length)
  847. selected = 0;
  848. else
  849. selected++;
  850. if (selected > -1)
  851. CloseMenu (true);
  852. OpenMenu (selected);
  853. break;
  854. case true:
  855. if (UseKeysUpDownAsKeysLeftRight) {
  856. CloseMenu (false, true);
  857. NextMenu ();
  858. } else {
  859. if ((selectedSub == -1 || openSubMenu == null || openSubMenu?.Count == selectedSub) && openCurrentMenu.barItems.Children [openCurrentMenu.current].SubMenu == null) {
  860. if (openSubMenu != null)
  861. CloseMenu (false, true);
  862. NextMenu ();
  863. } else if (openCurrentMenu.barItems.Children [openCurrentMenu.current].SubMenu != null ||
  864. !openCurrentMenu.barItems.Children [openCurrentMenu.current].IsFromSubMenu)
  865. selectedSub++;
  866. else
  867. return;
  868. SetNeedsDisplay ();
  869. openCurrentMenu.CheckSubMenu ();
  870. }
  871. break;
  872. }
  873. }
  874. bool openedByHotKey;
  875. internal bool FindAndOpenMenuByHotkey (KeyEvent kb)
  876. {
  877. //int pos = 0;
  878. var c = ((uint)kb.Key & (uint)Key.CharMask);
  879. for (int i = 0; i < Menus.Length; i++) {
  880. // TODO: this code is duplicated, hotkey should be part of the MenuBarItem
  881. var mi = Menus [i];
  882. int p = mi.Title.IndexOf ('_');
  883. if (p != -1 && p + 1 < mi.Title.Length) {
  884. if (Char.ToUpperInvariant ((char)mi.Title [p + 1]) == c) {
  885. ProcessMenu (i, mi);
  886. return true;
  887. }
  888. }
  889. }
  890. return false;
  891. }
  892. private void ProcessMenu (int i, MenuBarItem mi)
  893. {
  894. if (mi.IsTopLevel) {
  895. var menu = new Menu (this, i, 0, mi);
  896. menu.Run (mi.Action);
  897. } else {
  898. openedByHotKey = true;
  899. Application.GrabMouse (this);
  900. selected = i;
  901. OpenMenu (i);
  902. }
  903. }
  904. ///<inheritdoc/>
  905. public override bool ProcessHotKey (KeyEvent kb)
  906. {
  907. if (kb.Key == Key.F9) {
  908. if (!IsMenuOpen)
  909. OpenMenu ();
  910. else
  911. CloseAllMenus ();
  912. return true;
  913. }
  914. // To ncurses simulate a AltMask key pressing Alt+Space because
  915. // it can�t detect an alone special key down was pressed.
  916. if (kb.IsAlt && kb.Key == Key.AltMask && openMenu == null) {
  917. OnKeyDown (kb);
  918. OnKeyUp (kb);
  919. return true;
  920. } else if (kb.IsAlt) {
  921. if (FindAndOpenMenuByHotkey (kb)) return true;
  922. }
  923. //var kc = kb.KeyValue;
  924. return base.ProcessHotKey (kb);
  925. }
  926. ///<inheritdoc/>
  927. public override bool ProcessKey (KeyEvent kb)
  928. {
  929. switch (kb.Key) {
  930. case Key.CursorLeft:
  931. selected--;
  932. if (selected < 0)
  933. selected = Menus.Length - 1;
  934. break;
  935. case Key.CursorRight:
  936. selected = (selected + 1) % Menus.Length;
  937. break;
  938. case Key.Esc:
  939. case Key.ControlC:
  940. //TODO: Running = false;
  941. CloseMenu ();
  942. if (openedByAltKey) {
  943. openedByAltKey = false;
  944. LastFocused.SuperView?.SetFocus (LastFocused);
  945. }
  946. break;
  947. case Key.CursorDown:
  948. case Key.Enter:
  949. ProcessMenu (selected, Menus [selected]);
  950. break;
  951. default:
  952. var key = kb.KeyValue;
  953. if ((key >= 'a' && key <= 'z') || (key >= 'A' && key <= 'Z') || (key >= '0' && key <= '9')) {
  954. char c = Char.ToUpper ((char)key);
  955. if (selected == -1 || Menus [selected].IsTopLevel)
  956. return false;
  957. foreach (var mi in Menus [selected].Children) {
  958. if (mi == null)
  959. continue;
  960. int p = mi.Title.IndexOf ('_');
  961. if (p != -1 && p + 1 < mi.Title.Length) {
  962. if (mi.Title [p + 1] == c) {
  963. Selected (mi);
  964. return true;
  965. }
  966. }
  967. }
  968. }
  969. return false;
  970. }
  971. SetNeedsDisplay ();
  972. return true;
  973. }
  974. ///<inheritdoc/>
  975. public override bool MouseEvent (MouseEvent me)
  976. {
  977. if (!handled && !HandleGrabView (me, this)) {
  978. return false;
  979. }
  980. handled = false;
  981. if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked || me.Flags == MouseFlags.Button1Clicked ||
  982. (me.Flags == MouseFlags.ReportMousePosition && selected > -1) ||
  983. (me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) && selected > -1)) {
  984. int pos = 1;
  985. int cx = me.X;
  986. for (int i = 0; i < Menus.Length; i++) {
  987. if (cx > pos && me.X < pos + 1 + Menus [i].TitleLength) {
  988. if (me.Flags == MouseFlags.Button1Clicked) {
  989. if (Menus [i].IsTopLevel) {
  990. var menu = new Menu (this, i, 0, Menus [i]);
  991. menu.Run (Menus [i].Action);
  992. }
  993. } else if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  994. if (IsMenuOpen) {
  995. CloseAllMenus ();
  996. } else {
  997. Activate (i);
  998. }
  999. } else if (selected != i && selected > -1 && (me.Flags == MouseFlags.ReportMousePosition ||
  1000. me.Flags == MouseFlags.Button1Pressed && me.Flags == MouseFlags.ReportMousePosition)) {
  1001. if (IsMenuOpen) {
  1002. CloseMenu ();
  1003. Activate (i);
  1004. }
  1005. } else {
  1006. if (IsMenuOpen)
  1007. Activate (i);
  1008. }
  1009. return true;
  1010. }
  1011. pos += 2 + Menus [i].TitleLength + 1;
  1012. }
  1013. }
  1014. return false;
  1015. }
  1016. internal bool handled;
  1017. internal bool HandleGrabView (MouseEvent me, View current)
  1018. {
  1019. if (Application.mouseGrabView != null) {
  1020. if (me.View is MenuBar || me.View is Menu) {
  1021. if (me.View != current) {
  1022. Application.UngrabMouse ();
  1023. Application.GrabMouse (me.View);
  1024. me.View.MouseEvent (me);
  1025. }
  1026. } else if (!(me.View is MenuBar || me.View is Menu) && (me.Flags.HasFlag (MouseFlags.Button1Clicked) ||
  1027. me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked)) {
  1028. Application.UngrabMouse ();
  1029. CloseAllMenus ();
  1030. handled = false;
  1031. return false;
  1032. } else {
  1033. handled = false;
  1034. return false;
  1035. }
  1036. } else if (!IsMenuOpen && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked || me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))) {
  1037. Application.GrabMouse (current);
  1038. } else if (IsMenuOpen && (me.View is MenuBar || me.View is Menu)) {
  1039. Application.GrabMouse (me.View);
  1040. }
  1041. else {
  1042. handled = false;
  1043. return false;
  1044. }
  1045. //if (me.View != this && me.Flags != MouseFlags.Button1Pressed)
  1046. // return true;
  1047. //else if (me.View != this && me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  1048. // Application.UngrabMouse ();
  1049. // host.CloseAllMenus ();
  1050. // return true;
  1051. //}
  1052. //if (!(me.View is MenuBar) && !(me.View is Menu) && me.Flags != MouseFlags.Button1Pressed))
  1053. // return false;
  1054. //if (Application.mouseGrabView != null) {
  1055. // if (me.View is MenuBar || me.View is Menu) {
  1056. // me.X -= me.OfX;
  1057. // me.Y -= me.OfY;
  1058. // me.View.MouseEvent (me);
  1059. // return true;
  1060. // } else if (!(me.View is MenuBar || me.View is Menu) && me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  1061. // Application.UngrabMouse ();
  1062. // CloseAllMenus ();
  1063. // }
  1064. //} else if (!isMenuClosed && selected == -1 && me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  1065. // Application.GrabMouse (this);
  1066. // return true;
  1067. //}
  1068. //if (Application.mouseGrabView != null) {
  1069. // if (Application.mouseGrabView == me.View && me.View == current) {
  1070. // me.X -= me.OfX;
  1071. // me.Y -= me.OfY;
  1072. // } else if (me.View != current && me.View is MenuBar && me.View is Menu) {
  1073. // Application.UngrabMouse ();
  1074. // Application.GrabMouse (me.View);
  1075. // } else if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  1076. // Application.UngrabMouse ();
  1077. // CloseMenu ();
  1078. // }
  1079. //} else if ((!isMenuClosed && selected > -1)) {
  1080. // Application.GrabMouse (current);
  1081. //}
  1082. handled = true;
  1083. return true;
  1084. }
  1085. }
  1086. }