Menu.cs 32 KB

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