Menu.cs 31 KB

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