Toplevel.cs 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072
  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel;
  4. using System.Linq;
  5. namespace Terminal.Gui {
  6. /// <summary>
  7. /// Toplevel views can be modally executed. They are used for both an application's main view (filling the entire screeN and
  8. /// for pop-up views such as <see cref="Dialog"/>, <see cref="MessageBox"/>, and <see cref="Wizard"/>.
  9. /// </summary>
  10. /// <remarks>
  11. /// <para>
  12. /// Toplevels can be modally executing views, started by calling <see cref="Application.Run(Toplevel, Func{Exception, bool})"/>.
  13. /// They return control to the caller when <see cref="Application.RequestStop(Toplevel)"/> has
  14. /// been called (which sets the <see cref="Toplevel.Running"/> property to <c>false</c>).
  15. /// </para>
  16. /// <para>
  17. /// A Toplevel is created when an application initializes Terminal.Gui by calling <see cref="Application.Init(ConsoleDriver, IMainLoopDriver)"/>.
  18. /// The application Toplevel can be accessed via <see cref="Application.Top"/>. Additional Toplevels can be created
  19. /// and run (e.g. <see cref="Dialog"/>s. To run a Toplevel, create the <see cref="Toplevel"/> and
  20. /// call <see cref="Application.Run(Toplevel, Func{Exception, bool})"/>.
  21. /// </para>
  22. /// <para>
  23. /// Toplevels can also opt-in to more sophisticated initialization
  24. /// by implementing <see cref="ISupportInitialize"/>. When they do
  25. /// so, the <see cref="ISupportInitialize.BeginInit"/> and
  26. /// <see cref="ISupportInitialize.EndInit"/> methods will be called
  27. /// before running the view.
  28. /// If first-run-only initialization is preferred, the <see cref="ISupportInitializeNotification"/>
  29. /// can be implemented too, in which case the <see cref="ISupportInitialize"/>
  30. /// methods will only be called if <see cref="ISupportInitializeNotification.IsInitialized"/>
  31. /// is <see langword="false"/>. This allows proper <see cref="View"/> inheritance hierarchies
  32. /// to override base class layout code optimally by doing so only on first run,
  33. /// instead of on every run.
  34. /// </para>
  35. /// </remarks>
  36. public class Toplevel : View {
  37. /// <summary>
  38. /// Gets or sets whether the <see cref="MainLoop"/> for this <see cref="Toplevel"/> is running or not.
  39. /// </summary>
  40. /// <remarks>
  41. /// Setting this property directly is discouraged. Use <see cref="Application.RequestStop"/> instead.
  42. /// </remarks>
  43. public bool Running { get; set; }
  44. /// <summary>
  45. /// Invoked when the Toplevel <see cref="Application.RunState"/> has begun to be loaded.
  46. /// A Loaded event handler is a good place to finalize initialization before calling
  47. /// <see cref="Application.RunLoop(Application.RunState, bool)"/>.
  48. /// </summary>
  49. public event Action Loaded;
  50. /// <summary>
  51. /// Invoked when the Toplevel <see cref="MainLoop"/> has started it's first iteration.
  52. /// Subscribe to this event to perform tasks when the <see cref="Toplevel"/> has been laid out and focus has been set.
  53. /// changes.
  54. /// <para>A Ready event handler is a good place to finalize initialization after calling
  55. /// <see cref="Application.Run(Func{Exception, bool})"/> on this Toplevel.</para>
  56. /// </summary>
  57. public event Action Ready;
  58. /// <summary>
  59. /// Invoked when the Toplevel <see cref="Application.RunState"/> has been unloaded.
  60. /// A Unloaded event handler is a good place to dispose objects after calling <see cref="Application.End(Application.RunState)"/>.
  61. /// </summary>
  62. public event Action Unloaded;
  63. /// <summary>
  64. /// Invoked when the Toplevel <see cref="Application.RunState"/> becomes the <see cref="Application.Current"/> Toplevel.
  65. /// </summary>
  66. public event Action<Toplevel> Activate;
  67. /// <summary>
  68. /// Invoked when the Toplevel<see cref="Application.RunState"/> ceases to be the <see cref="Application.Current"/> Toplevel.
  69. /// </summary>
  70. public event Action<Toplevel> Deactivate;
  71. /// <summary>
  72. /// Invoked when a child of the Toplevel <see cref="Application.RunState"/> is closed by
  73. /// <see cref="Application.End(Application.RunState)"/>.
  74. /// </summary>
  75. public event Action<Toplevel> ChildClosed;
  76. /// <summary>
  77. /// Invoked when the last child of the Toplevel <see cref="Application.RunState"/> is closed from
  78. /// by <see cref="Application.End(Application.RunState)"/>.
  79. /// </summary>
  80. public event Action AllChildClosed;
  81. /// <summary>
  82. /// Invoked when the Toplevel's <see cref="Application.RunState"/> is being closed by
  83. /// <see cref="Application.RequestStop(Toplevel)"/>.
  84. /// </summary>
  85. public event Action<ToplevelClosingEventArgs> Closing;
  86. /// <summary>
  87. /// Invoked when the Toplevel's <see cref="Application.RunState"/> is closed by <see cref="Application.End(Application.RunState)"/>.
  88. /// </summary>
  89. public event Action<Toplevel> Closed;
  90. /// <summary>
  91. /// Invoked when a child Toplevel's <see cref="Application.RunState"/> has been loaded.
  92. /// </summary>
  93. public event Action<Toplevel> ChildLoaded;
  94. /// <summary>
  95. /// Invoked when a cjhild Toplevel's <see cref="Application.RunState"/> has been unloaded.
  96. /// </summary>
  97. public event Action<Toplevel> ChildUnloaded;
  98. /// <summary>
  99. /// Invoked when the terminal has been resized. The new <see cref="Size"/> of the terminal is provided.
  100. /// </summary>
  101. public event Action<Size> Resized;
  102. internal virtual void OnResized (Size size)
  103. {
  104. Resized?.Invoke (size);
  105. }
  106. internal virtual void OnChildUnloaded (Toplevel top)
  107. {
  108. ChildUnloaded?.Invoke (top);
  109. }
  110. internal virtual void OnChildLoaded (Toplevel top)
  111. {
  112. ChildLoaded?.Invoke (top);
  113. }
  114. internal virtual void OnClosed (Toplevel top)
  115. {
  116. Closed?.Invoke (top);
  117. }
  118. internal virtual bool OnClosing (ToplevelClosingEventArgs ev)
  119. {
  120. Closing?.Invoke (ev);
  121. return ev.Cancel;
  122. }
  123. internal virtual void OnAllChildClosed ()
  124. {
  125. AllChildClosed?.Invoke ();
  126. }
  127. internal virtual void OnChildClosed (Toplevel top)
  128. {
  129. if (IsMdiContainer) {
  130. SetChildNeedsDisplay ();
  131. }
  132. ChildClosed?.Invoke (top);
  133. }
  134. internal virtual void OnDeactivate (Toplevel activated)
  135. {
  136. Deactivate?.Invoke (activated);
  137. }
  138. internal virtual void OnActivate (Toplevel deactivated)
  139. {
  140. Activate?.Invoke (deactivated);
  141. }
  142. /// <summary>
  143. /// Called from <see cref="Application.Begin(Toplevel)"/> before the <see cref="Toplevel"/> redraws for the first time.
  144. /// </summary>
  145. virtual public void OnLoaded ()
  146. {
  147. foreach (Toplevel tl in Subviews.Where (v => v is Toplevel)) {
  148. tl.OnLoaded ();
  149. }
  150. Loaded?.Invoke ();
  151. }
  152. /// <summary>
  153. /// Called from <see cref="Application.RunLoop"/> after the <see cref="Toplevel"/> has entered the
  154. /// first iteration of the loop.
  155. /// </summary>
  156. internal virtual void OnReady ()
  157. {
  158. foreach (Toplevel tl in Subviews.Where (v => v is Toplevel)) {
  159. tl.OnReady ();
  160. }
  161. Ready?.Invoke ();
  162. }
  163. /// <summary>
  164. /// Called from <see cref="Application.End(Application.RunState)"/> before the <see cref="Toplevel"/> is disposed.
  165. /// </summary>
  166. internal virtual void OnUnloaded ()
  167. {
  168. foreach (Toplevel tl in Subviews.Where (v => v is Toplevel)) {
  169. tl.OnUnloaded ();
  170. }
  171. Unloaded?.Invoke ();
  172. }
  173. /// <summary>
  174. /// Initializes a new instance of the <see cref="Toplevel"/> class with the specified <see cref="LayoutStyle.Absolute"/> layout.
  175. /// </summary>
  176. /// <param name="frame">A superview-relative rectangle specifying the location and size for the new Toplevel</param>
  177. public Toplevel (Rect frame) : base (frame)
  178. {
  179. Initialize ();
  180. }
  181. /// <summary>
  182. /// Initializes a new instance of the <see cref="Toplevel"/> class with <see cref="LayoutStyle.Computed"/> layout,
  183. /// defaulting to full screen.
  184. /// </summary>
  185. public Toplevel () : base ()
  186. {
  187. Initialize ();
  188. Width = Dim.Fill ();
  189. Height = Dim.Fill ();
  190. }
  191. void Initialize ()
  192. {
  193. ColorScheme = Colors.TopLevel;
  194. // Things this view knows how to do
  195. AddCommand (Command.QuitToplevel, () => { QuitToplevel (); return true; });
  196. AddCommand (Command.Suspend, () => { Driver.Suspend (); ; return true; });
  197. AddCommand (Command.NextView, () => { MoveNextView (); return true; });
  198. AddCommand (Command.PreviousView, () => { MovePreviousView (); return true; });
  199. AddCommand (Command.NextViewOrTop, () => { MoveNextViewOrTop (); return true; });
  200. AddCommand (Command.PreviousViewOrTop, () => { MovePreviousViewOrTop (); return true; });
  201. AddCommand (Command.Refresh, () => { Application.Refresh (); return true; });
  202. // Default keybindings for this view
  203. AddKeyBinding (Application.QuitKey, Command.QuitToplevel);
  204. AddKeyBinding (Key.Z | Key.CtrlMask, Command.Suspend);
  205. AddKeyBinding (Key.Tab, Command.NextView);
  206. AddKeyBinding (Key.CursorRight, Command.NextView);
  207. AddKeyBinding (Key.F | Key.CtrlMask, Command.NextView);
  208. AddKeyBinding (Key.CursorDown, Command.NextView);
  209. AddKeyBinding (Key.I | Key.CtrlMask, Command.NextView); // Unix
  210. AddKeyBinding (Key.BackTab | Key.ShiftMask, Command.PreviousView);
  211. AddKeyBinding (Key.CursorLeft, Command.PreviousView);
  212. AddKeyBinding (Key.CursorUp, Command.PreviousView);
  213. AddKeyBinding (Key.B | Key.CtrlMask, Command.PreviousView);
  214. AddKeyBinding (Key.Tab | Key.CtrlMask, Command.NextViewOrTop);
  215. AddKeyBinding (Application.AlternateForwardKey, Command.NextViewOrTop); // Needed on Unix
  216. AddKeyBinding (Key.Tab | Key.ShiftMask | Key.CtrlMask, Command.PreviousViewOrTop);
  217. AddKeyBinding (Application.AlternateBackwardKey, Command.PreviousViewOrTop); // Needed on Unix
  218. AddKeyBinding (Key.L | Key.CtrlMask, Command.Refresh);
  219. }
  220. /// <summary>
  221. /// Invoked when the <see cref="Application.AlternateForwardKey"/> is changed.
  222. /// </summary>
  223. public event Action<Key> AlternateForwardKeyChanged;
  224. /// <summary>
  225. /// Virtual method to invoke the <see cref="AlternateForwardKeyChanged"/> event.
  226. /// </summary>
  227. /// <param name="oldKey"></param>
  228. public virtual void OnAlternateForwardKeyChanged (Key oldKey)
  229. {
  230. ReplaceKeyBinding (oldKey, Application.AlternateForwardKey);
  231. AlternateForwardKeyChanged?.Invoke (oldKey);
  232. }
  233. /// <summary>
  234. /// Invoked when the <see cref="Application.AlternateBackwardKey"/> is changed.
  235. /// </summary>
  236. public event Action<Key> AlternateBackwardKeyChanged;
  237. /// <summary>
  238. /// Virtual method to invoke the <see cref="AlternateBackwardKeyChanged"/> event.
  239. /// </summary>
  240. /// <param name="oldKey"></param>
  241. public virtual void OnAlternateBackwardKeyChanged (Key oldKey)
  242. {
  243. ReplaceKeyBinding (oldKey, Application.AlternateBackwardKey);
  244. AlternateBackwardKeyChanged?.Invoke (oldKey);
  245. }
  246. /// <summary>
  247. /// Invoked when the <see cref="Application.QuitKey"/> is changed.
  248. /// </summary>
  249. public event Action<Key> QuitKeyChanged;
  250. /// <summary>
  251. /// Virtual method to invoke the <see cref="QuitKeyChanged"/> event.
  252. /// </summary>
  253. /// <param name="oldKey"></param>
  254. public virtual void OnQuitKeyChanged (Key oldKey)
  255. {
  256. ReplaceKeyBinding (oldKey, Application.QuitKey);
  257. QuitKeyChanged?.Invoke (oldKey);
  258. }
  259. /// <summary>
  260. /// Convenience factory method that creates a new Toplevel with the current terminal dimensions.
  261. /// </summary>
  262. /// <returns>The created Toplevel.</returns>
  263. public static Toplevel Create ()
  264. {
  265. return new Toplevel (new Rect (0, 0, Driver.Cols, Driver.Rows));
  266. }
  267. /// <summary>
  268. /// Gets or sets a value indicating whether this <see cref="Toplevel"/> can focus.
  269. /// </summary>
  270. /// <value><c>true</c> if can focus; otherwise, <c>false</c>.</value>
  271. public override bool CanFocus {
  272. get => SuperView == null ? true : base.CanFocus;
  273. }
  274. /// <summary>
  275. /// Determines whether the <see cref="Toplevel"/> is modal or not.
  276. /// If set to <c>false</c> (the default):
  277. ///
  278. /// <list type="bullet">
  279. /// <item>
  280. /// <description><see cref="ProcessKey(KeyEvent)"/> events will propagate keys upwards.</description>
  281. /// </item>
  282. /// <item>
  283. /// <description>The Toplevel will act as an embedded view (not a modal/pop-up).</description>
  284. /// </item>
  285. /// </list>
  286. ///
  287. /// If set to <c>true</c>:
  288. ///
  289. /// <list type="bullet">
  290. /// <item>
  291. /// <description><see cref="ProcessKey(KeyEvent)"/> events will NOT propogate keys upwards.</description>
  292. /// </item>
  293. /// <item>
  294. /// <description>The Toplevel will and look like a modal (pop-up) (e.g. see <see cref="Dialog"/>.</description>
  295. /// </item>
  296. /// </list>
  297. /// </summary>
  298. public bool Modal { get; set; }
  299. /// <summary>
  300. /// Gets or sets the menu for this Toplevel.
  301. /// </summary>
  302. public virtual MenuBar MenuBar { get; set; }
  303. /// <summary>
  304. /// Gets or sets the status bar for this Toplevel.
  305. /// </summary>
  306. public virtual StatusBar StatusBar { get; set; }
  307. /// <summary>
  308. /// Gets or sets if this Toplevel is a Mdi container.
  309. /// </summary>
  310. public bool IsMdiContainer { get; set; }
  311. /// <summary>
  312. /// Gets or sets if this Toplevel is a Mdi child.
  313. /// </summary>
  314. public bool IsMdiChild {
  315. get {
  316. return Application.MdiTop != null && Application.MdiTop != this && !Modal;
  317. }
  318. }
  319. ///<inheritdoc/>
  320. public override bool OnKeyDown (KeyEvent keyEvent)
  321. {
  322. if (base.OnKeyDown (keyEvent)) {
  323. return true;
  324. }
  325. switch (keyEvent.Key) {
  326. case Key.AltMask:
  327. case Key.AltMask | Key.Space:
  328. case Key.CtrlMask | Key.Space:
  329. case Key _ when (keyEvent.Key & Key.AltMask) == Key.AltMask:
  330. return MenuBar != null && MenuBar.OnKeyDown (keyEvent);
  331. }
  332. return false;
  333. }
  334. ///<inheritdoc/>
  335. public override bool OnKeyUp (KeyEvent keyEvent)
  336. {
  337. if (base.OnKeyUp (keyEvent)) {
  338. return true;
  339. }
  340. switch (keyEvent.Key) {
  341. case Key.AltMask:
  342. case Key.AltMask | Key.Space:
  343. case Key.CtrlMask | Key.Space:
  344. if (MenuBar != null && MenuBar.OnKeyUp (keyEvent)) {
  345. return true;
  346. }
  347. break;
  348. }
  349. return false;
  350. }
  351. ///<inheritdoc/>
  352. public override bool ProcessKey (KeyEvent keyEvent)
  353. {
  354. if (base.ProcessKey (keyEvent))
  355. return true;
  356. var result = InvokeKeybindings (new KeyEvent (ShortcutHelper.GetModifiersKey (keyEvent),
  357. new KeyModifiers () { Alt = keyEvent.IsAlt, Ctrl = keyEvent.IsCtrl, Shift = keyEvent.IsShift }));
  358. if (result != null)
  359. return (bool)result;
  360. #if false
  361. if (keyEvent.Key == Key.F5) {
  362. Application.DebugDrawBounds = !Application.DebugDrawBounds;
  363. SetNeedsDisplay ();
  364. return true;
  365. }
  366. #endif
  367. return false;
  368. }
  369. private void MovePreviousViewOrTop ()
  370. {
  371. if (Application.MdiTop == null) {
  372. var top = Modal ? this : Application.Top;
  373. top.FocusPrev ();
  374. if (top.Focused == null) {
  375. top.FocusPrev ();
  376. }
  377. top.SetNeedsDisplay ();
  378. Application.EnsuresTopOnFront ();
  379. } else {
  380. MovePrevious ();
  381. }
  382. }
  383. private void MoveNextViewOrTop ()
  384. {
  385. if (Application.MdiTop == null) {
  386. var top = Modal ? this : Application.Top;
  387. top.FocusNext ();
  388. if (top.Focused == null) {
  389. top.FocusNext ();
  390. }
  391. top.SetNeedsDisplay ();
  392. Application.EnsuresTopOnFront ();
  393. } else {
  394. MoveNext ();
  395. }
  396. }
  397. private void MovePreviousView ()
  398. {
  399. var old = GetDeepestFocusedSubview (Focused);
  400. if (!FocusPrev ())
  401. FocusPrev ();
  402. if (old != Focused && old != Focused?.Focused) {
  403. old?.SetNeedsDisplay ();
  404. Focused?.SetNeedsDisplay ();
  405. } else {
  406. FocusNearestView (SuperView?.TabIndexes?.Reverse (), Direction.Backward);
  407. }
  408. }
  409. private void MoveNextView ()
  410. {
  411. var old = GetDeepestFocusedSubview (Focused);
  412. if (!FocusNext ())
  413. FocusNext ();
  414. if (old != Focused && old != Focused?.Focused) {
  415. old?.SetNeedsDisplay ();
  416. Focused?.SetNeedsDisplay ();
  417. } else {
  418. FocusNearestView (SuperView?.TabIndexes, Direction.Forward);
  419. }
  420. }
  421. private void QuitToplevel ()
  422. {
  423. if (Application.MdiTop != null) {
  424. Application.MdiTop.RequestStop ();
  425. } else {
  426. Application.RequestStop ();
  427. }
  428. }
  429. ///<inheritdoc/>
  430. public override bool ProcessColdKey (KeyEvent keyEvent)
  431. {
  432. if (base.ProcessColdKey (keyEvent)) {
  433. return true;
  434. }
  435. if (ShortcutHelper.FindAndOpenByShortcut (keyEvent, this)) {
  436. return true;
  437. }
  438. return false;
  439. }
  440. View GetDeepestFocusedSubview (View view)
  441. {
  442. if (view == null) {
  443. return null;
  444. }
  445. foreach (var v in view.Subviews) {
  446. if (v.HasFocus) {
  447. return GetDeepestFocusedSubview (v);
  448. }
  449. }
  450. return view;
  451. }
  452. void FocusNearestView (IEnumerable<View> views, Direction direction)
  453. {
  454. if (views == null) {
  455. return;
  456. }
  457. bool found = false;
  458. bool focusProcessed = false;
  459. int idx = 0;
  460. foreach (var v in views) {
  461. if (v == this) {
  462. found = true;
  463. }
  464. if (found && v != this) {
  465. if (direction == Direction.Forward) {
  466. SuperView?.FocusNext ();
  467. } else {
  468. SuperView?.FocusPrev ();
  469. }
  470. focusProcessed = true;
  471. if (SuperView.Focused != null && SuperView.Focused != this) {
  472. return;
  473. }
  474. } else if (found && !focusProcessed && idx == views.Count () - 1) {
  475. views.ToList () [0].SetFocus ();
  476. }
  477. idx++;
  478. }
  479. }
  480. ///<inheritdoc/>
  481. public override void Add (View view)
  482. {
  483. AddMenuStatusBar (view);
  484. base.Add (view);
  485. }
  486. internal void AddMenuStatusBar (View view)
  487. {
  488. if (view is MenuBar) {
  489. MenuBar = view as MenuBar;
  490. }
  491. if (view is StatusBar) {
  492. StatusBar = view as StatusBar;
  493. }
  494. }
  495. ///<inheritdoc/>
  496. public override void Remove (View view)
  497. {
  498. if (this is Toplevel toplevel && toplevel.MenuBar != null) {
  499. RemoveMenuStatusBar (view);
  500. }
  501. base.Remove (view);
  502. }
  503. ///<inheritdoc/>
  504. public override void RemoveAll ()
  505. {
  506. if (this == Application.Top) {
  507. MenuBar?.Dispose ();
  508. MenuBar = null;
  509. StatusBar?.Dispose ();
  510. StatusBar = null;
  511. }
  512. base.RemoveAll ();
  513. }
  514. internal void RemoveMenuStatusBar (View view)
  515. {
  516. if (view is MenuBar) {
  517. MenuBar?.Dispose ();
  518. MenuBar = null;
  519. }
  520. if (view is StatusBar) {
  521. StatusBar?.Dispose ();
  522. StatusBar = null;
  523. }
  524. }
  525. internal View EnsureVisibleBounds (Toplevel top, int x, int y,
  526. out int nx, out int ny, out View mb, out View sb)
  527. {
  528. int l;
  529. View superView = null;
  530. if (top?.SuperView == null || top == Application.Top || top?.SuperView == Application.Top) {
  531. l = Driver.Cols;
  532. superView = Application.Top;
  533. } else {
  534. l = top.SuperView.Frame.Width;
  535. superView = top.SuperView;
  536. }
  537. nx = Math.Max (x, 0);
  538. nx = nx + top.Frame.Width > l ? Math.Max (l - top.Frame.Width, 0) : nx;
  539. var mfLength = top.Border?.DrawMarginFrame == true ? 2 : 1;
  540. if (nx + mfLength > top.Frame.X + top.Frame.Width) {
  541. nx = Math.Max (top.Frame.Right - mfLength, 0);
  542. }
  543. //System.Diagnostics.Debug.WriteLine ($"nx:{nx}, rWidth:{rWidth}");
  544. bool m = false, s = false;
  545. mb = null; sb = null;
  546. if (!(top is Window && top == Application.Top) && (top?.SuperView == null || top == Application.Top || top?.SuperView == Application.Top)) {
  547. m = Application.Top.MenuBar?.Visible == true;
  548. mb = Application.Top.MenuBar;
  549. } else if (!(top is Window && top == Application.Top)) {
  550. var t = top.SuperView;
  551. while (!(t is Toplevel)) {
  552. t = t.SuperView;
  553. }
  554. m = ((Toplevel)t).MenuBar?.Visible == true;
  555. mb = ((Toplevel)t).MenuBar;
  556. }
  557. if (top?.SuperView == null || top == Application.Top || top?.SuperView == Application.Top) {
  558. l = m ? 1 : 0;
  559. } else {
  560. l = 0;
  561. }
  562. ny = Math.Max (y, l);
  563. if (!(top is Window && top == Application.Top) && (top?.SuperView == null || top == Application.Top || top?.SuperView == Application.Top)) {
  564. s = Application.Top.StatusBar?.Visible == true;
  565. sb = Application.Top.StatusBar;
  566. } else if (!(top is Window && top == Application.Top)) {
  567. var t = top.SuperView;
  568. while (!(t is Toplevel)) {
  569. t = t.SuperView;
  570. }
  571. s = ((Toplevel)t).StatusBar?.Visible == true;
  572. sb = ((Toplevel)t).StatusBar;
  573. }
  574. if (top?.SuperView == null || top == Application.Top || top?.SuperView == Application.Top) {
  575. l = s ? Driver.Rows - 1 : Driver.Rows;
  576. } else {
  577. l = s ? top.SuperView.Frame.Height - 1 : top.SuperView.Frame.Height;
  578. }
  579. ny = Math.Min (ny, l);
  580. ny = ny + top.Frame.Height >= l ? Math.Max (l - top.Frame.Height, m ? 1 : 0) : ny;
  581. if (ny + mfLength > top.Frame.Y + top.Frame.Height) {
  582. ny = Math.Max (top.Frame.Bottom - mfLength, 0);
  583. }
  584. //System.Diagnostics.Debug.WriteLine ($"ny:{ny}, rHeight:{rHeight}");
  585. return superView;
  586. }
  587. internal void PositionToplevels ()
  588. {
  589. PositionToplevel (this);
  590. foreach (var top in Subviews) {
  591. if (top is Toplevel) {
  592. PositionToplevel ((Toplevel)top);
  593. }
  594. }
  595. }
  596. /// <summary>
  597. /// Virtual method enabling implementation of specific positions for inherited <see cref="Toplevel"/> views.
  598. /// </summary>
  599. /// <param name="top">The toplevel.</param>
  600. public virtual void PositionToplevel (Toplevel top)
  601. {
  602. var superView = EnsureVisibleBounds (top, top.Frame.X, top.Frame.Y,
  603. out int nx, out int ny, out _, out View sb);
  604. bool layoutSubviews = false;
  605. if ((top?.SuperView != null || (top != Application.Top && top.Modal)
  606. || (top?.SuperView == null && top.IsMdiChild))
  607. && (nx > top.Frame.X || ny > top.Frame.Y) && top.LayoutStyle == LayoutStyle.Computed) {
  608. if ((top.X == null || top.X is Pos.PosAbsolute) && top.Bounds.X != nx) {
  609. top.X = nx;
  610. layoutSubviews = true;
  611. }
  612. if ((top.Y == null || top.Y is Pos.PosAbsolute) && top.Bounds.Y != ny) {
  613. top.Y = ny;
  614. layoutSubviews = true;
  615. }
  616. }
  617. if (sb != null && ny + top.Frame.Height != superView.Frame.Height - (sb.Visible ? 1 : 0)
  618. && top.Height is Dim.DimFill && -top.Height.Anchor (0) < 1) {
  619. top.Height = Dim.Fill (sb.Visible ? 1 : 0);
  620. layoutSubviews = true;
  621. }
  622. if (layoutSubviews) {
  623. superView.LayoutSubviews ();
  624. }
  625. }
  626. ///<inheritdoc/>
  627. public override void Redraw (Rect bounds)
  628. {
  629. if (!Visible) {
  630. return;
  631. }
  632. if (!NeedDisplay.IsEmpty || ChildNeedsDisplay || LayoutNeeded) {
  633. Driver.SetAttribute (GetNormalColor ());
  634. // This is the Application.Top. Clear just the region we're being asked to redraw
  635. // (the bounds passed to us).
  636. Clear ();
  637. Driver.SetAttribute (Enabled ? Colors.Base.Normal : Colors.Base.Disabled);
  638. LayoutSubviews ();
  639. PositionToplevels ();
  640. if (this == Application.MdiTop) {
  641. foreach (var top in Application.MdiChildes.AsEnumerable ().Reverse ()) {
  642. if (top.Frame.IntersectsWith (bounds)) {
  643. if (top != this && !top.IsCurrentTop && !OutsideTopFrame (top) && top.Visible) {
  644. top.SetNeedsLayout ();
  645. top.SetNeedsDisplay (top.Bounds);
  646. top.Redraw (top.Bounds);
  647. }
  648. }
  649. }
  650. }
  651. foreach (var view in Subviews) {
  652. if (view.Frame.IntersectsWith (bounds) && !OutsideTopFrame (this)) {
  653. view.SetNeedsLayout ();
  654. view.SetNeedsDisplay (view.Bounds);
  655. //view.Redraw (view.Bounds);
  656. }
  657. }
  658. ClearLayoutNeeded ();
  659. ClearNeedsDisplay ();
  660. }
  661. base.Redraw (Bounds);
  662. }
  663. bool OutsideTopFrame (Toplevel top)
  664. {
  665. if (top.Frame.X > Driver.Cols || top.Frame.Y > Driver.Rows) {
  666. return true;
  667. }
  668. return false;
  669. }
  670. internal static Point? dragPosition;
  671. Point start;
  672. ///<inheritdoc/>
  673. public override bool MouseEvent (MouseEvent mouseEvent)
  674. {
  675. if (!CanFocus) {
  676. return true;
  677. }
  678. //System.Diagnostics.Debug.WriteLine ($"dragPosition before: {dragPosition.HasValue}");
  679. int nx, ny;
  680. if (!dragPosition.HasValue && (mouseEvent.Flags == MouseFlags.Button1Pressed
  681. || mouseEvent.Flags == MouseFlags.Button2Pressed
  682. || mouseEvent.Flags == MouseFlags.Button3Pressed)) {
  683. SetFocus ();
  684. Application.EnsuresTopOnFront ();
  685. // Only start grabbing if the user clicks on the title bar.
  686. if (mouseEvent.Y == 0 && mouseEvent.Flags == MouseFlags.Button1Pressed) {
  687. start = new Point (mouseEvent.X, mouseEvent.Y);
  688. dragPosition = new Point ();
  689. nx = mouseEvent.X - mouseEvent.OfX;
  690. ny = mouseEvent.Y - mouseEvent.OfY;
  691. dragPosition = new Point (nx, ny);
  692. Application.GrabMouse (this);
  693. }
  694. //System.Diagnostics.Debug.WriteLine ($"Starting at {dragPosition}");
  695. return true;
  696. } else if (mouseEvent.Flags == (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) ||
  697. mouseEvent.Flags == MouseFlags.Button3Pressed) {
  698. if (dragPosition.HasValue) {
  699. if (SuperView == null) {
  700. // Redraw the entire app window using just our Frame. Since we are
  701. // Application.Top, and our Frame always == our Bounds (Location is always (0,0))
  702. // our Frame is actually view-relative (which is what Redraw takes).
  703. // We need to pass all the view bounds because since the windows was
  704. // moved around, we don't know exactly what was the affected region.
  705. Application.Top.SetNeedsDisplay ();
  706. } else {
  707. SuperView.SetNeedsDisplay ();
  708. }
  709. EnsureVisibleBounds (this, mouseEvent.X + (SuperView == null ? mouseEvent.OfX - start.X : Frame.X - start.X),
  710. mouseEvent.Y + (SuperView == null ? mouseEvent.OfY - start.Y : Frame.Y - start.Y),
  711. out nx, out ny, out _, out _);
  712. dragPosition = new Point (nx, ny);
  713. X = nx;
  714. Y = ny;
  715. //System.Diagnostics.Debug.WriteLine ($"Drag: nx:{nx},ny:{ny}");
  716. SetNeedsDisplay ();
  717. return true;
  718. }
  719. }
  720. if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Released) && dragPosition.HasValue) {
  721. Application.UngrabMouse ();
  722. dragPosition = null;
  723. }
  724. //System.Diagnostics.Debug.WriteLine ($"dragPosition after: {dragPosition.HasValue}");
  725. //System.Diagnostics.Debug.WriteLine ($"Toplevel: {mouseEvent}");
  726. return false;
  727. }
  728. /// <summary>
  729. /// Invoked by <see cref="Application.Begin"/> as part of <see cref="Application.Run(Toplevel, Func{Exception, bool})"/>
  730. /// after the views have been laid out, and before the views are drawn for the first time.
  731. /// </summary>
  732. public virtual void WillPresent ()
  733. {
  734. FocusFirst ();
  735. }
  736. /// <summary>
  737. /// Move to the next Mdi child from the <see cref="Application.MdiTop"/>.
  738. /// </summary>
  739. public virtual void MoveNext ()
  740. {
  741. Application.MoveNext ();
  742. }
  743. /// <summary>
  744. /// Move to the previous Mdi child from the <see cref="Application.MdiTop"/>.
  745. /// </summary>
  746. public virtual void MovePrevious ()
  747. {
  748. Application.MovePrevious ();
  749. }
  750. /// <summary>
  751. /// Stops and closes this <see cref="Toplevel"/>. If this Toplevel is the top-most Toplevel,
  752. /// <see cref="Application.RequestStop(Toplevel)"/> will be called, causing the application to exit.
  753. /// </summary>
  754. public virtual void RequestStop ()
  755. {
  756. if (IsMdiContainer && Running
  757. && (Application.Current == this
  758. || Application.Current?.Modal == false
  759. || Application.Current?.Modal == true && Application.Current?.Running == false)) {
  760. foreach (var child in Application.MdiChildes) {
  761. var ev = new ToplevelClosingEventArgs (this);
  762. if (child.OnClosing (ev)) {
  763. return;
  764. }
  765. child.Running = false;
  766. Application.RequestStop (child);
  767. }
  768. Running = false;
  769. Application.RequestStop (this);
  770. } else if (IsMdiContainer && Running && Application.Current?.Modal == true && Application.Current?.Running == true) {
  771. var ev = new ToplevelClosingEventArgs (Application.Current);
  772. if (OnClosing (ev)) {
  773. return;
  774. }
  775. Application.RequestStop (Application.Current);
  776. } else if (!IsMdiContainer && Running && (!Modal || (Modal && Application.Current != this))) {
  777. var ev = new ToplevelClosingEventArgs (this);
  778. if (OnClosing (ev)) {
  779. return;
  780. }
  781. Running = false;
  782. Application.RequestStop (this);
  783. } else {
  784. Application.RequestStop (Application.Current);
  785. }
  786. }
  787. /// <summary>
  788. /// Stops and closes the <see cref="Toplevel"/> specified by <paramref name="top"/>. If <paramref name="top"/> is the top-most Toplevel,
  789. /// <see cref="Application.RequestStop(Toplevel)"/> will be called, causing the application to exit.
  790. /// </summary>
  791. /// <param name="top">The toplevel to request stop.</param>
  792. public virtual void RequestStop (Toplevel top)
  793. {
  794. top.RequestStop ();
  795. }
  796. ///<inheritdoc/>
  797. public override void PositionCursor ()
  798. {
  799. if (!IsMdiContainer) {
  800. base.PositionCursor ();
  801. if (Focused == null) {
  802. EnsureFocus ();
  803. if (Focused == null) {
  804. Driver.SetCursorVisibility (CursorVisibility.Invisible);
  805. }
  806. }
  807. return;
  808. }
  809. if (Focused == null) {
  810. foreach (var top in Application.MdiChildes) {
  811. if (top != this && top.Visible) {
  812. top.SetFocus ();
  813. return;
  814. }
  815. }
  816. }
  817. base.PositionCursor ();
  818. if (Focused == null) {
  819. Driver.SetCursorVisibility (CursorVisibility.Invisible);
  820. }
  821. }
  822. /// <summary>
  823. /// Gets the current visible Toplevel Mdi child that matches the arguments pattern.
  824. /// </summary>
  825. /// <param name="type">The type.</param>
  826. /// <param name="exclude">The strings to exclude.</param>
  827. /// <returns>The matched view.</returns>
  828. public View GetTopMdiChild (Type type = null, string [] exclude = null)
  829. {
  830. if (Application.MdiTop == null) {
  831. return null;
  832. }
  833. foreach (var top in Application.MdiChildes) {
  834. if (type != null && top.GetType () == type
  835. && exclude?.Contains (top.Data.ToString ()) == false) {
  836. return top;
  837. } else if ((type != null && top.GetType () != type)
  838. || (exclude?.Contains (top.Data.ToString ()) == true)) {
  839. continue;
  840. }
  841. return top;
  842. }
  843. return null;
  844. }
  845. /// <summary>
  846. /// Shows the Mdi child indicated by <paramref name="top"/>, setting it as <see cref="Application.Current"/>.
  847. /// </summary>
  848. /// <param name="top">The Toplevel.</param>
  849. /// <returns><c>true</c> if the toplevel can be shown or <c>false</c> if not.</returns>
  850. public virtual bool ShowChild (Toplevel top = null)
  851. {
  852. if (Application.MdiTop != null) {
  853. return Application.ShowChild (top == null ? this : top);
  854. }
  855. return false;
  856. }
  857. ///<inheritdoc/>
  858. public override bool OnEnter (View view)
  859. {
  860. return MostFocused?.OnEnter (view) ?? base.OnEnter (view);
  861. }
  862. ///<inheritdoc/>
  863. public override bool OnLeave (View view)
  864. {
  865. return MostFocused?.OnLeave (view) ?? base.OnLeave (view);
  866. }
  867. }
  868. /// <summary>
  869. /// Implements the <see cref="IEqualityComparer{T}"/> for comparing two <see cref="Toplevel"/>s
  870. /// used by <see cref="StackExtensions"/>.
  871. /// </summary>
  872. public class ToplevelEqualityComparer : IEqualityComparer<Toplevel> {
  873. /// <summary>Determines whether the specified objects are equal.</summary>
  874. /// <param name="x">The first object of type <see cref="Toplevel" /> to compare.</param>
  875. /// <param name="y">The second object of type <see cref="Toplevel" /> to compare.</param>
  876. /// <returns>
  877. /// <see langword="true" /> if the specified objects are equal; otherwise, <see langword="false" />.</returns>
  878. public bool Equals (Toplevel x, Toplevel y)
  879. {
  880. if (y == null && x == null)
  881. return true;
  882. else if (x == null || y == null)
  883. return false;
  884. else if (x.Id == y.Id)
  885. return true;
  886. else
  887. return false;
  888. }
  889. /// <summary>Returns a hash code for the specified object.</summary>
  890. /// <param name="obj">The <see cref="Toplevel" /> for which a hash code is to be returned.</param>
  891. /// <returns>A hash code for the specified object.</returns>
  892. /// <exception cref="ArgumentNullException">The type of <paramref name="obj" />
  893. /// is a reference type and <paramref name="obj" /> is <see langword="null" />.</exception>
  894. public int GetHashCode (Toplevel obj)
  895. {
  896. if (obj == null)
  897. throw new ArgumentNullException ();
  898. int hCode = 0;
  899. if (int.TryParse (obj.Id.ToString (), out int result)) {
  900. hCode = result;
  901. }
  902. return hCode.GetHashCode ();
  903. }
  904. }
  905. /// <summary>
  906. /// Implements the <see cref="IComparer{T}"/> to sort the <see cref="Toplevel"/>
  907. /// from the <see cref="Application.MdiChildes"/> if needed.
  908. /// </summary>
  909. public sealed class ToplevelComparer : IComparer<Toplevel> {
  910. /// <summary>Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.</summary>
  911. /// <param name="x">The first object to compare.</param>
  912. /// <param name="y">The second object to compare.</param>
  913. /// <returns>A signed integer that indicates the relative values of <paramref name="x" /> and <paramref name="y" />, as shown in the following table.Value Meaning Less than zero
  914. /// <paramref name="x" /> is less than <paramref name="y" />.Zero
  915. /// <paramref name="x" /> equals <paramref name="y" />.Greater than zero
  916. /// <paramref name="x" /> is greater than <paramref name="y" />.</returns>
  917. public int Compare (Toplevel x, Toplevel y)
  918. {
  919. if (ReferenceEquals (x, y))
  920. return 0;
  921. else if (x == null)
  922. return -1;
  923. else if (y == null)
  924. return 1;
  925. else
  926. return string.Compare (x.Id.ToString (), y.Id.ToString ());
  927. }
  928. }
  929. /// <summary>
  930. /// <see cref="EventArgs"/> implementation for the <see cref="Toplevel.Closing"/> event.
  931. /// </summary>
  932. public class ToplevelClosingEventArgs : EventArgs {
  933. /// <summary>
  934. /// The toplevel requesting stop.
  935. /// </summary>
  936. public View RequestingTop { get; }
  937. /// <summary>
  938. /// Provides an event cancellation option.
  939. /// </summary>
  940. public bool Cancel { get; set; }
  941. /// <summary>
  942. /// Initializes the event arguments with the requesting toplevel.
  943. /// </summary>
  944. /// <param name="requestingTop">The <see cref="RequestingTop"/>.</param>
  945. public ToplevelClosingEventArgs (Toplevel requestingTop)
  946. {
  947. RequestingTop = requestingTop;
  948. }
  949. }
  950. }