Menu.cs 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199
  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="KeyDown"/>
  502. public override bool KeyDown (KeyEvent keyEvent)
  503. {
  504. if (keyEvent.IsAlt) {
  505. openedByAltKey = true;
  506. SetNeedsDisplay ();
  507. openedByHotKey = false;
  508. }
  509. return false;
  510. }
  511. /// <summary>
  512. /// Track Alt key-up events. On Windows, when a user releases Alt (without another key), the menu gets focus but doesn't open.
  513. /// We mimic that behavior here.
  514. /// </summary>
  515. /// <param name="keyEvent"></param>
  516. /// <returns></returns>
  517. public override bool OnKeyUp (KeyEvent keyEvent)
  518. {
  519. if (keyEvent.IsAlt) {
  520. // User pressed Alt - this may be a precursor to a menu accelerator (e.g. Alt-F)
  521. if (!keyEvent.IsCtrl && openedByAltKey && isMenuClosed && openMenu == null && ((uint)keyEvent.Key & (uint)Key.CharMask) == 0) {
  522. // There's no open menu, the first menu item should be highlight.
  523. // The right way to do this is to SetFocus(MenuBar), but for some reason
  524. // that faults.
  525. //Activate (0);
  526. //StartMenu ();
  527. isMenuClosed = false;
  528. selected = 0;
  529. CanFocus = true;
  530. lastFocused = SuperView.MostFocused;
  531. SuperView.SetFocus (this);
  532. SetNeedsDisplay ();
  533. Application.GrabMouse (this);
  534. } else if (!openedByHotKey) {
  535. // There's an open menu. If this Alt key-up is a pre-cursor to an accelerator
  536. // we don't want to close the menu because it'll flash.
  537. // How to deal with that?
  538. if (openMenu != null)
  539. CloseAllMenus ();
  540. openedByAltKey = false;
  541. isMenuClosed = true;
  542. selected = -1;
  543. CanFocus = false;
  544. if (lastFocused != null)
  545. SuperView?.SetFocus (lastFocused);
  546. SetNeedsDisplay ();
  547. Application.UngrabMouse ();
  548. }
  549. return true;
  550. }
  551. return false;
  552. }
  553. ///<inheritdoc cref="Redraw"/>
  554. public override void Redraw (Rect region)
  555. {
  556. Move (0, 0);
  557. Driver.SetAttribute (Colors.Menu.Normal);
  558. for (int i = 0; i < Frame.Width; i++)
  559. Driver.AddRune (' ');
  560. Move (1, 0);
  561. int pos = 1;
  562. for (int i = 0; i < Menus.Length; i++) {
  563. var menu = Menus [i];
  564. Move (pos, 0);
  565. Attribute hotColor, normalColor;
  566. if (i == selected) {
  567. hotColor = i == selected ? ColorScheme.HotFocus : ColorScheme.HotNormal;
  568. normalColor = i == selected ? ColorScheme.Focus : ColorScheme.Normal;
  569. } else if (openedByAltKey) {
  570. hotColor = ColorScheme.HotNormal;
  571. normalColor = ColorScheme.Normal;
  572. } else {
  573. hotColor = ColorScheme.Normal;
  574. normalColor = ColorScheme.Normal;
  575. }
  576. DrawHotString ($" {menu.Title} ", hotColor, normalColor);
  577. pos += 1 + menu.TitleLength + 2;
  578. }
  579. PositionCursor ();
  580. }
  581. ///<inheritdoc cref="PositionCursor"/>
  582. public override void PositionCursor ()
  583. {
  584. int pos = 0;
  585. for (int i = 0; i < Menus.Length; i++) {
  586. if (i == selected) {
  587. pos++;
  588. if (!isMenuClosed)
  589. Move (pos + 1, 0);
  590. else
  591. Move (pos + 1, 0);
  592. return;
  593. } else {
  594. if (!isMenuClosed)
  595. pos += 1 + Menus [i].TitleLength + 2;
  596. else
  597. pos += 2 + Menus [i].TitleLength + 1;
  598. }
  599. }
  600. //Move (0, 0);
  601. }
  602. void Selected (MenuItem item)
  603. {
  604. // TODO: Running = false;
  605. action = item.Action;
  606. }
  607. /// <summary>
  608. /// Raised as a menu is opened.
  609. /// </summary>
  610. public event EventHandler OnOpenMenu;
  611. /// <summary>
  612. /// Raised when a menu is closing.
  613. /// </summary>
  614. public event EventHandler OnCloseMenu;
  615. internal Menu openMenu;
  616. Menu openCurrentMenu;
  617. internal List<Menu> openSubMenu;
  618. View previousFocused;
  619. internal bool isMenuOpening;
  620. internal bool isMenuClosing;
  621. internal bool isMenuClosed;
  622. /// <summary>
  623. /// True of the menu is open; otherwise false.
  624. /// </summary>
  625. public bool MenuOpen { get; set; }
  626. View lastFocused;
  627. /// <summary>
  628. /// Get the lasted focused view before open the menu.
  629. /// </summary>
  630. public View LastFocused { get; private set; }
  631. internal void OpenMenu (int index, int sIndex = -1, MenuBarItem subMenu = null)
  632. {
  633. isMenuOpening = true;
  634. OnOpenMenu?.Invoke (this, null);
  635. int pos = 0;
  636. switch (subMenu) {
  637. case null:
  638. lastFocused = lastFocused ?? SuperView.MostFocused;
  639. if (openSubMenu != null)
  640. CloseMenu (false, true);
  641. if (openMenu != null)
  642. SuperView.Remove (openMenu);
  643. for (int i = 0; i < index; i++)
  644. pos += Menus [i].Title.Length + 2;
  645. openMenu = new Menu (this, pos, 1, Menus [index]);
  646. openCurrentMenu = openMenu;
  647. openCurrentMenu.previousSubFocused = openMenu;
  648. SuperView.Add (openMenu);
  649. SuperView.SetFocus (openMenu);
  650. break;
  651. default:
  652. if (openSubMenu == null)
  653. openSubMenu = new List<Menu> ();
  654. if (sIndex > -1) {
  655. RemoveSubMenu (sIndex);
  656. } else {
  657. var last = openSubMenu.Count > 0 ? openSubMenu.Last () : openMenu;
  658. openCurrentMenu = new Menu (this, last.Frame.Left + last.Frame.Width, last.Frame.Top + 1 + last.current, subMenu);
  659. openCurrentMenu.previousSubFocused = last.previousSubFocused;
  660. openSubMenu.Add (openCurrentMenu);
  661. SuperView.Add (openCurrentMenu);
  662. }
  663. selectedSub = openSubMenu.Count - 1;
  664. SuperView?.SetFocus (openCurrentMenu);
  665. break;
  666. }
  667. isMenuOpening = false;
  668. isMenuClosed = false;
  669. MenuOpen = true;
  670. }
  671. // Starts the menu from a hotkey
  672. void StartMenu ()
  673. {
  674. if (openMenu != null)
  675. return;
  676. selected = 0;
  677. SetNeedsDisplay ();
  678. previousFocused = SuperView.Focused;
  679. OpenMenu (selected);
  680. Application.GrabMouse (this);
  681. }
  682. // Activates the menu, handles either first focus, or activating an entry when it was already active
  683. // For mouse events.
  684. internal void Activate (int idx, int sIdx = -1, MenuBarItem subMenu = null)
  685. {
  686. selected = idx;
  687. selectedSub = sIdx;
  688. if (openMenu == null)
  689. previousFocused = SuperView.Focused;
  690. OpenMenu (idx, sIdx, subMenu);
  691. SetNeedsDisplay ();
  692. }
  693. internal void CloseMenu (bool reopen = false, bool isSubMenu = false)
  694. {
  695. isMenuClosing = true;
  696. OnCloseMenu?.Invoke (this, null);
  697. switch (isSubMenu) {
  698. case false:
  699. if (openMenu != null)
  700. SuperView.Remove (openMenu);
  701. SetNeedsDisplay ();
  702. if (previousFocused != null && openMenu != null && previousFocused.ToString () != openCurrentMenu.ToString ())
  703. previousFocused?.SuperView?.SetFocus (previousFocused);
  704. openMenu = null;
  705. if (lastFocused is Menu) {
  706. lastFocused = null;
  707. }
  708. LastFocused = lastFocused;
  709. lastFocused = null;
  710. if (LastFocused != null) {
  711. if (!reopen)
  712. selected = -1;
  713. LastFocused.SuperView?.SetFocus (LastFocused);
  714. } else {
  715. SuperView.SetFocus (this);
  716. isMenuClosed = true;
  717. PositionCursor ();
  718. }
  719. isMenuClosed = true;
  720. break;
  721. case true:
  722. selectedSub = -1;
  723. SetNeedsDisplay ();
  724. RemoveAllOpensSubMenus ();
  725. openCurrentMenu.previousSubFocused?.SuperView?.SetFocus (openCurrentMenu.previousSubFocused);
  726. openSubMenu = null;
  727. break;
  728. }
  729. isMenuClosing = false;
  730. MenuOpen = false;
  731. }
  732. void RemoveSubMenu (int index)
  733. {
  734. if (openSubMenu == null)
  735. return;
  736. for (int i = openSubMenu.Count - 1; i > index; i--) {
  737. isMenuClosing = true;
  738. if (openSubMenu.Count - 1 > 0)
  739. SuperView.SetFocus (openSubMenu [i - 1]);
  740. else
  741. SuperView.SetFocus (openMenu);
  742. if (openSubMenu != null) {
  743. SuperView.Remove (openSubMenu [i]);
  744. openSubMenu.Remove (openSubMenu [i]);
  745. }
  746. RemoveSubMenu (i);
  747. }
  748. if (openSubMenu.Count > 0)
  749. openCurrentMenu = openSubMenu.Last ();
  750. //if (openMenu.Subviews.Count == 0)
  751. // return;
  752. //if (index == 0) {
  753. // //SuperView.SetFocus (previousSubFocused);
  754. // FocusPrev ();
  755. // return;
  756. //}
  757. //for (int i = openMenu.Subviews.Count - 1; i > index; i--) {
  758. // isMenuClosing = true;
  759. // if (openMenu.Subviews.Count - 1 > 0)
  760. // SuperView.SetFocus (openMenu.Subviews [i - 1]);
  761. // else
  762. // SuperView.SetFocus (openMenu);
  763. // if (openMenu != null) {
  764. // Remove (openMenu.Subviews [i]);
  765. // openMenu.Remove (openMenu.Subviews [i]);
  766. // }
  767. // RemoveSubMenu (i);
  768. //}
  769. isMenuClosing = false;
  770. }
  771. internal void RemoveAllOpensSubMenus ()
  772. {
  773. if (openSubMenu != null) {
  774. foreach (var item in openSubMenu) {
  775. SuperView.Remove (item);
  776. }
  777. }
  778. }
  779. internal void CloseAllMenus ()
  780. {
  781. if (!isMenuOpening && !isMenuClosing) {
  782. if (openSubMenu != null)
  783. CloseMenu (false, true);
  784. CloseMenu ();
  785. if (LastFocused != null && LastFocused != this)
  786. selected = -1;
  787. }
  788. isMenuClosed = true;
  789. openedByHotKey = false;
  790. openedByAltKey = false;
  791. }
  792. View FindDeepestMenu (View view, ref int count)
  793. {
  794. count = count > 0 ? count : 0;
  795. foreach (var menu in view.Subviews) {
  796. if (menu is Menu) {
  797. count++;
  798. return FindDeepestMenu ((Menu)menu, ref count);
  799. }
  800. }
  801. return view;
  802. }
  803. internal void PreviousMenu (bool isSubMenu = false)
  804. {
  805. switch (isSubMenu) {
  806. case false:
  807. if (selected <= 0)
  808. selected = Menus.Length - 1;
  809. else
  810. selected--;
  811. if (selected > -1)
  812. CloseMenu (true, false);
  813. OpenMenu (selected);
  814. break;
  815. case true:
  816. if (selectedSub > -1) {
  817. selectedSub--;
  818. RemoveSubMenu (selectedSub);
  819. SetNeedsDisplay ();
  820. } else
  821. PreviousMenu ();
  822. break;
  823. }
  824. }
  825. internal void NextMenu (bool isSubMenu = false)
  826. {
  827. switch (isSubMenu) {
  828. case false:
  829. if (selected == -1)
  830. selected = 0;
  831. else if (selected + 1 == Menus.Length)
  832. selected = 0;
  833. else
  834. selected++;
  835. if (selected > -1)
  836. CloseMenu (true);
  837. OpenMenu (selected);
  838. break;
  839. case true:
  840. if (UseKeysUpDownAsKeysLeftRight) {
  841. CloseMenu (false, true);
  842. NextMenu ();
  843. } else {
  844. if ((selectedSub == -1 || openSubMenu == null || openSubMenu?.Count == selectedSub) && openCurrentMenu.barItems.Children [openCurrentMenu.current].SubMenu == null) {
  845. if (openSubMenu != null)
  846. CloseMenu (false, true);
  847. NextMenu ();
  848. } else if (openCurrentMenu.barItems.Children [openCurrentMenu.current].SubMenu != null ||
  849. !openCurrentMenu.barItems.Children [openCurrentMenu.current].IsFromSubMenu)
  850. selectedSub++;
  851. else
  852. return;
  853. SetNeedsDisplay ();
  854. openCurrentMenu.CheckSubMenu ();
  855. }
  856. break;
  857. }
  858. }
  859. bool openedByHotKey;
  860. internal bool FindAndOpenMenuByHotkey (KeyEvent kb)
  861. {
  862. //int pos = 0;
  863. var c = ((uint)kb.Key & (uint)Key.CharMask);
  864. for (int i = 0; i < Menus.Length; i++) {
  865. // TODO: this code is duplicated, hotkey should be part of the MenuBarItem
  866. var mi = Menus [i];
  867. int p = mi.Title.IndexOf ('_');
  868. if (p != -1 && p + 1 < mi.Title.Length) {
  869. if (Char.ToUpperInvariant ((char)mi.Title [p + 1]) == c) {
  870. ProcessMenu (i, mi);
  871. return true;
  872. }
  873. }
  874. }
  875. return false;
  876. }
  877. private void ProcessMenu (int i, MenuBarItem mi)
  878. {
  879. if (mi.IsTopLevel) {
  880. var menu = new Menu (this, i, 0, mi);
  881. menu.Run (mi.Action);
  882. } else {
  883. openedByHotKey = true;
  884. Application.GrabMouse (this);
  885. selected = i;
  886. OpenMenu (i);
  887. }
  888. }
  889. ///<inheritdoc cref="ProcessHotKey"/>
  890. public override bool ProcessHotKey (KeyEvent kb)
  891. {
  892. if (kb.Key == Key.F9) {
  893. if (isMenuClosed)
  894. StartMenu ();
  895. else
  896. CloseAllMenus ();
  897. return true;
  898. }
  899. // To ncurses simulate a AltMask key pressing Alt+Space because
  900. // it can´t detect an alone special key down was pressed.
  901. if (kb.IsAlt && kb.Key == Key.AltMask && openMenu == null) {
  902. OnKeyDown (kb);
  903. OnKeyUp (kb);
  904. return true;
  905. } else if (kb.IsAlt) {
  906. if (FindAndOpenMenuByHotkey (kb)) return true;
  907. }
  908. //var kc = kb.KeyValue;
  909. return base.ProcessHotKey (kb);
  910. }
  911. ///<inheritdoc cref="ProcessKey"/>
  912. public override bool ProcessKey (KeyEvent kb)
  913. {
  914. switch (kb.Key) {
  915. case Key.CursorLeft:
  916. selected--;
  917. if (selected < 0)
  918. selected = Menus.Length - 1;
  919. break;
  920. case Key.CursorRight:
  921. selected = (selected + 1) % Menus.Length;
  922. break;
  923. case Key.Esc:
  924. case Key.ControlC:
  925. //TODO: Running = false;
  926. CloseMenu ();
  927. if (openedByAltKey) {
  928. openedByAltKey = false;
  929. LastFocused.SuperView?.SetFocus (LastFocused);
  930. }
  931. break;
  932. case Key.CursorDown:
  933. case Key.Enter:
  934. ProcessMenu (selected, Menus [selected]);
  935. break;
  936. default:
  937. var key = kb.KeyValue;
  938. if ((key >= 'a' && key <= 'z') || (key >= 'A' && key <= 'Z') || (key >= '0' && key <= '9')) {
  939. char c = Char.ToUpper ((char)key);
  940. if (selected == -1 || Menus [selected].IsTopLevel)
  941. return false;
  942. foreach (var mi in Menus [selected].Children) {
  943. if (mi == null)
  944. continue;
  945. int p = mi.Title.IndexOf ('_');
  946. if (p != -1 && p + 1 < mi.Title.Length) {
  947. if (mi.Title [p + 1] == c) {
  948. Selected (mi);
  949. return true;
  950. }
  951. }
  952. }
  953. }
  954. return false;
  955. }
  956. SetNeedsDisplay ();
  957. return true;
  958. }
  959. ///<inheritdoc cref="MouseEvent"/>
  960. public override bool MouseEvent (MouseEvent me)
  961. {
  962. if (!handled && !HandleGrabView (me, this)) {
  963. return false;
  964. }
  965. handled = false;
  966. if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1Clicked || me.Flags == MouseFlags.Button1DoubleClicked ||
  967. (me.Flags == MouseFlags.ReportMousePosition && selected > -1) ||
  968. (me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) && selected > -1)) {
  969. int pos = 1;
  970. int cx = me.X;
  971. for (int i = 0; i < Menus.Length; i++) {
  972. if (cx > pos && me.X < pos + 1 + Menus [i].TitleLength) {
  973. if (selected == i && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) &&
  974. !isMenuClosed) {
  975. Application.UngrabMouse ();
  976. if (Menus [i].IsTopLevel) {
  977. var menu = new Menu (this, i, 0, Menus [i]);
  978. menu.Run (Menus [i].Action);
  979. } else {
  980. CloseMenu ();
  981. }
  982. } else if ((me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) &&
  983. isMenuClosed) {
  984. if (Menus [i].IsTopLevel) {
  985. var menu = new Menu (this, i, 0, Menus [i]);
  986. menu.Run (Menus [i].Action);
  987. } else {
  988. Activate (i);
  989. }
  990. } else if (selected != i && selected > -1 && me.Flags == MouseFlags.ReportMousePosition) {
  991. if (!isMenuClosed) {
  992. CloseMenu ();
  993. Activate (i);
  994. }
  995. } else {
  996. if (!isMenuClosed)
  997. Activate (i);
  998. }
  999. return true;
  1000. }
  1001. pos += 2 + Menus [i].TitleLength + 1;
  1002. }
  1003. }
  1004. return false;
  1005. }
  1006. internal bool handled;
  1007. internal bool HandleGrabView (MouseEvent me, View current)
  1008. {
  1009. if (Application.mouseGrabView != null) {
  1010. if (me.View is MenuBar || me.View is Menu) {
  1011. if (me.View != current) {
  1012. Application.UngrabMouse ();
  1013. Application.GrabMouse (me.View);
  1014. me.View.MouseEvent (me);
  1015. }
  1016. } else if (!(me.View is MenuBar || me.View is Menu) && (me.Flags.HasFlag (MouseFlags.Button1Clicked) ||
  1017. me.Flags == MouseFlags.Button1DoubleClicked || me.Flags == MouseFlags.Button1Pressed)) {
  1018. Application.UngrabMouse ();
  1019. CloseAllMenus ();
  1020. handled = false;
  1021. return false;
  1022. } else {
  1023. handled = false;
  1024. return false;
  1025. }
  1026. } else if (isMenuClosed && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked ||
  1027. me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))) {
  1028. Application.GrabMouse (current);
  1029. } else {
  1030. handled = false;
  1031. return false;
  1032. }
  1033. //if (me.View != this && (me.Flags != MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked))
  1034. // return true;
  1035. //else if (me.View != this && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked)) {
  1036. // Application.UngrabMouse ();
  1037. // host.CloseAllMenus ();
  1038. // return true;
  1039. //}
  1040. //if (!(me.View is MenuBar) && !(me.View is Menu) && (me.Flags != MouseFlags.Button1Pressed ||
  1041. // me.Flags != MouseFlags.Button1DoubleClicked))
  1042. // return false;
  1043. //if (Application.mouseGrabView != null) {
  1044. // if (me.View is MenuBar || me.View is Menu) {
  1045. // me.X -= me.OfX;
  1046. // me.Y -= me.OfY;
  1047. // me.View.MouseEvent (me);
  1048. // return true;
  1049. // } else if (!(me.View is MenuBar || me.View is Menu) && (me.Flags == MouseFlags.Button1Pressed ||
  1050. // me.Flags == MouseFlags.Button1DoubleClicked)) {
  1051. // Application.UngrabMouse ();
  1052. // CloseAllMenus ();
  1053. // }
  1054. //} else if (!isMenuClosed && selected == -1 && (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked)) {
  1055. // Application.GrabMouse (this);
  1056. // return true;
  1057. //}
  1058. //if (Application.mouseGrabView != null) {
  1059. // if (Application.mouseGrabView == me.View && me.View == current) {
  1060. // me.X -= me.OfX;
  1061. // me.Y -= me.OfY;
  1062. // } else if (me.View != current && me.View is MenuBar && me.View is Menu) {
  1063. // Application.UngrabMouse ();
  1064. // Application.GrabMouse (me.View);
  1065. // } else if (me.Flags == MouseFlags.Button1Pressed || me.Flags == MouseFlags.Button1DoubleClicked) {
  1066. // Application.UngrabMouse ();
  1067. // CloseMenu ();
  1068. // }
  1069. //} else if ((!isMenuClosed && selected > -1)) {
  1070. // Application.GrabMouse (current);
  1071. //}
  1072. handled = true;
  1073. return true;
  1074. }
  1075. }
  1076. }