Core.cs 73 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575
  1. //
  2. // Core.cs: The core engine for gui.cs
  3. //
  4. // Authors:
  5. // Miguel de Icaza ([email protected])
  6. //
  7. // Pending:
  8. // - Check for NeedDisplay on the hierarchy and repaint
  9. // - Layout support
  10. // - "Colors" type or "Attributes" type?
  11. // - What to surface as "BackgroundCOlor" when clearing a window, an attribute or colors?
  12. //
  13. // Optimziations
  14. // - Add rendering limitation to the exposed area
  15. using System;
  16. using System.Collections;
  17. using System.Collections.Generic;
  18. using System.Threading;
  19. using System.Linq;
  20. using NStack;
  21. using System.ComponentModel;
  22. namespace Terminal.Gui {
  23. /// <summary>
  24. /// Responder base class implemented by objects that want to participate on keyboard and mouse input.
  25. /// </summary>
  26. public class Responder {
  27. /// <summary>
  28. /// Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.Responder"/> can focus.
  29. /// </summary>
  30. /// <value><c>true</c> if can focus; otherwise, <c>false</c>.</value>
  31. public virtual bool CanFocus { get; set; }
  32. /// <summary>
  33. /// Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.Responder"/> has focus.
  34. /// </summary>
  35. /// <value><c>true</c> if has focus; otherwise, <c>false</c>.</value>
  36. public virtual bool HasFocus { get; internal set; }
  37. // Key handling
  38. /// <summary>
  39. /// This method can be overwritten by view that
  40. /// want to provide accelerator functionality
  41. /// (Alt-key for example).
  42. /// </summary>
  43. /// <remarks>
  44. /// <para>
  45. /// Before keys are sent to the subview on the
  46. /// current view, all the views are
  47. /// processed and the key is passed to the widgets
  48. /// to allow some of them to process the keystroke
  49. /// as a hot-key. </para>
  50. /// <para>
  51. /// For example, if you implement a button that
  52. /// has a hotkey ok "o", you would catch the
  53. /// combination Alt-o here. If the event is
  54. /// caught, you must return true to stop the
  55. /// keystroke from being dispatched to other
  56. /// views.
  57. /// </para>
  58. /// </remarks>
  59. public virtual bool ProcessHotKey (KeyEvent kb)
  60. {
  61. return false;
  62. }
  63. /// <summary>
  64. /// If the view is focused, gives the view a
  65. /// chance to process the keystroke.
  66. /// </summary>
  67. /// <remarks>
  68. /// <para>
  69. /// Views can override this method if they are
  70. /// interested in processing the given keystroke.
  71. /// If they consume the keystroke, they must
  72. /// return true to stop the keystroke from being
  73. /// processed by other widgets or consumed by the
  74. /// widget engine. If they return false, the
  75. /// keystroke will be passed using the ProcessColdKey
  76. /// method to other views to process.
  77. /// </para>
  78. /// <para>
  79. /// The View implementation does nothing but return false,
  80. /// so it is not necessary to call base.ProcessKey if you
  81. /// derive directly from View, but you should if you derive
  82. /// other View subclasses.
  83. /// </para>
  84. /// </remarks>
  85. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  86. public virtual bool ProcessKey (KeyEvent keyEvent)
  87. {
  88. return false;
  89. }
  90. /// <summary>
  91. /// This method can be overwritten by views that
  92. /// want to provide accelerator functionality
  93. /// (Alt-key for example), but without
  94. /// interefering with normal ProcessKey behavior.
  95. /// </summary>
  96. /// <remarks>
  97. /// <para>
  98. /// After keys are sent to the subviews on the
  99. /// current view, all the view are
  100. /// processed and the key is passed to the views
  101. /// to allow some of them to process the keystroke
  102. /// as a cold-key. </para>
  103. /// <para>
  104. /// This functionality is used, for example, by
  105. /// default buttons to act on the enter key.
  106. /// Processing this as a hot-key would prevent
  107. /// non-default buttons from consuming the enter
  108. /// keypress when they have the focus.
  109. /// </para>
  110. /// </remarks>
  111. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  112. public virtual bool ProcessColdKey (KeyEvent keyEvent)
  113. {
  114. return false;
  115. }
  116. /// <summary>
  117. /// Method invoked when a key is pressed.
  118. /// </summary>
  119. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  120. /// <returns>true if the event was handled</returns>
  121. public virtual bool OnKeyDown (KeyEvent keyEvent)
  122. {
  123. return false;
  124. }
  125. /// <summary>
  126. /// Method invoked when a key is released.
  127. /// </summary>
  128. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  129. /// <returns>true if the event was handled</returns>
  130. public virtual bool OnKeyUp (KeyEvent keyEvent)
  131. {
  132. return false;
  133. }
  134. /// <summary>
  135. /// Method invoked when a mouse event is generated
  136. /// </summary>
  137. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  138. /// <param name="mouseEvent">Contains the details about the mouse event.</param>
  139. public virtual bool MouseEvent (MouseEvent mouseEvent)
  140. {
  141. return false;
  142. }
  143. /// <summary>
  144. /// Method invoked when a mouse event is generated for the first time.
  145. /// </summary>
  146. /// <param name="mouseEvent"></param>
  147. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  148. public virtual bool OnMouseEnter (MouseEvent mouseEvent)
  149. {
  150. return false;
  151. }
  152. /// <summary>
  153. /// Method invoked when a mouse event is generated for the last time.
  154. /// </summary>
  155. /// <param name="mouseEvent"></param>
  156. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  157. public virtual bool OnMouseLeave (MouseEvent mouseEvent)
  158. {
  159. return false;
  160. }
  161. /// <summary>
  162. /// Method invoked when a view gets focus.
  163. /// </summary>
  164. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  165. public virtual bool OnEnter ()
  166. {
  167. return false;
  168. }
  169. /// <summary>
  170. /// Method invoked when a view loses focus.
  171. /// </summary>
  172. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  173. public virtual bool OnLeave ()
  174. {
  175. return false;
  176. }
  177. }
  178. /// <summary>
  179. /// Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  180. /// value from the Frame will be used, if the value is Computer, then the Frame
  181. /// will be updated from the X, Y Pos objects and the Width and Height Dim objects.
  182. /// </summary>
  183. public enum LayoutStyle {
  184. /// <summary>
  185. /// The position and size of the view are based on the Frame value.
  186. /// </summary>
  187. Absolute,
  188. /// <summary>
  189. /// The position and size of the view will be computed based on the
  190. /// X, Y, Width and Height properties and set on the Frame.
  191. /// </summary>
  192. Computed
  193. }
  194. /// <summary>
  195. /// View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
  196. /// </summary>
  197. /// <remarks>
  198. /// <para>
  199. /// The View defines the base functionality for user interface elements in Terminal/gui.cs. Views
  200. /// can contain one or more subviews, can respond to user input and render themselves on the screen.
  201. /// </para>
  202. /// <para>
  203. /// Views can either be created with an absolute position, by calling the constructor that takes a
  204. /// Rect parameter to specify the absolute position and size (the Frame of the View) or by setting the
  205. /// X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative
  206. /// to the container they are being added to.
  207. /// </para>
  208. /// <para>
  209. /// When you do not specify a Rect frame you can use the more flexible
  210. /// Dim and Pos objects that can dynamically update the position of a view.
  211. /// The X and Y properties are of type <see cref="T:Terminal.Gui.Pos"/>
  212. /// and you can use either absolute positions, percentages or anchor
  213. /// points. The Width and Height properties are of type
  214. /// <see cref="T:Terminal.Gui.Dim"/> and can use absolute position,
  215. /// percentages and anchors. These are useful as they will take
  216. /// care of repositioning your views if your view's frames are resized
  217. /// or if the terminal size changes.
  218. /// </para>
  219. /// <para>
  220. /// When you specify the Rect parameter to a view, you are setting the LayoutStyle to Absolute, and the
  221. /// view will always stay in the position that you placed it. To change the position change the
  222. /// Frame property to the new position.
  223. /// </para>
  224. /// <para>
  225. /// Subviews can be added to a View by calling the Add method. The container of a view is the
  226. /// Superview.
  227. /// </para>
  228. /// <para>
  229. /// Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view
  230. /// as requiring to be redrawn.
  231. /// </para>
  232. /// <para>
  233. /// Views have a ColorScheme property that defines the default colors that subviews
  234. /// should use for rendering. This ensures that the views fit in the context where
  235. /// they are being used, and allows for themes to be plugged in. For example, the
  236. /// default colors for windows and toplevels uses a blue background, while it uses
  237. /// a white background for dialog boxes and a red background for errors.
  238. /// </para>
  239. /// <para>
  240. /// If a ColorScheme is not set on a view, the result of the ColorScheme is the
  241. /// value of the SuperView and the value might only be valid once a view has been
  242. /// added to a SuperView, so your subclasses should not rely on ColorScheme being
  243. /// set at construction time.
  244. /// </para>
  245. /// <para>
  246. /// Using ColorSchemes has the advantage that your application will work both
  247. /// in color as well as black and white displays.
  248. /// </para>
  249. /// <para>
  250. /// Views that are focusable should implement the PositionCursor to make sure that
  251. /// the cursor is placed in a location that makes sense. Unix terminals do not have
  252. /// a way of hiding the cursor, so it can be distracting to have the cursor left at
  253. /// the last focused view. So views should make sure that they place the cursor
  254. /// in a visually sensible place.
  255. /// </para>
  256. /// <para>
  257. /// The metnod LayoutSubviews is invoked when the size or layout of a view has
  258. /// changed. The default processing system will keep the size and dimensions
  259. /// for views that use the LayoutKind.Absolute, and will recompute the
  260. /// frames for the vies that use LayoutKind.Computed.
  261. /// </para>
  262. /// </remarks>
  263. public class View : Responder, IEnumerable {
  264. internal enum Direction {
  265. Forward,
  266. Backward
  267. }
  268. View container = null;
  269. View focused = null;
  270. Direction focusDirection;
  271. /// <summary>
  272. /// Event fired when the view get focus.
  273. /// </summary>
  274. public event EventHandler Enter;
  275. /// <summary>
  276. /// Event fired when the view lost focus.
  277. /// </summary>
  278. public event EventHandler Leave;
  279. /// <summary>
  280. /// Event fired when the view receives the mouse event for the first time.
  281. /// </summary>
  282. public event EventHandler<MouseEvent> MouseEnter;
  283. /// <summary>
  284. /// Event fired when the view loses mouse event for the last time.
  285. /// </summary>
  286. public event EventHandler<MouseEvent> MouseLeave;
  287. internal Direction FocusDirection {
  288. get => SuperView?.FocusDirection ?? focusDirection;
  289. set {
  290. if (SuperView != null)
  291. SuperView.FocusDirection = value;
  292. else
  293. focusDirection = value;
  294. }
  295. }
  296. /// <summary>
  297. /// Points to the current driver in use by the view, it is a convenience property
  298. /// for simplifying the development of new views.
  299. /// </summary>
  300. public static ConsoleDriver Driver { get { return Application.Driver; } }
  301. static IList<View> empty = new List<View> (0).AsReadOnly ();
  302. // This is null, and allocated on demand.
  303. List<View> subviews;
  304. /// <summary>
  305. /// This returns a list of the subviews contained by this view.
  306. /// </summary>
  307. /// <value>The subviews.</value>
  308. public IList<View> Subviews => subviews == null ? empty : subviews.AsReadOnly ();
  309. // Internally, we use InternalSubviews rather than subviews, as we do not expect us
  310. // to make the same mistakes our users make when they poke at the Subviews.
  311. internal IList<View> InternalSubviews => subviews ?? empty;
  312. internal Rect NeedDisplay { get; private set; } = Rect.Empty;
  313. // The frame for the object
  314. Rect frame;
  315. /// <summary>
  316. /// Gets or sets an identifier for the view;
  317. /// </summary>
  318. /// <value>The identifier.</value>
  319. public ustring Id { get; set; } = "";
  320. /// <summary>
  321. /// Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.View"/> want mouse position reports.
  322. /// </summary>
  323. /// <value><c>true</c> if want mouse position reports; otherwise, <c>false</c>.</value>
  324. public virtual bool WantMousePositionReports { get; set; } = false;
  325. /// <summary>
  326. /// Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.View"/> want continuous button pressed event.
  327. /// </summary>
  328. public virtual bool WantContinuousButtonPressed { get; set; } = false;
  329. /// <summary>
  330. /// Gets or sets the frame for the view.
  331. /// </summary>
  332. /// <value>The frame.</value>
  333. /// <remarks>
  334. /// Altering the Frame of a view will trigger the redrawing of the
  335. /// view as well as the redrawing of the affected regions in the superview.
  336. /// </remarks>
  337. public virtual Rect Frame {
  338. get => frame;
  339. set {
  340. if (SuperView != null) {
  341. SuperView.SetNeedsDisplay (frame);
  342. SuperView.SetNeedsDisplay (value);
  343. }
  344. frame = value;
  345. SetNeedsLayout ();
  346. SetNeedsDisplay (frame);
  347. }
  348. }
  349. /// <summary>
  350. /// Gets an enumerator that enumerates the subviews in this view.
  351. /// </summary>
  352. /// <returns>The enumerator.</returns>
  353. public IEnumerator GetEnumerator ()
  354. {
  355. foreach (var v in InternalSubviews)
  356. yield return v;
  357. }
  358. LayoutStyle layoutStyle;
  359. /// <summary>
  360. /// Controls how the view's Frame is computed during the LayoutSubviews method, if Absolute, then
  361. /// LayoutSubviews does not change the Frame properties, otherwise the Frame is updated from the
  362. /// values in X, Y, Width and Height properties.
  363. /// </summary>
  364. /// <value>The layout style.</value>
  365. public LayoutStyle LayoutStyle {
  366. get => layoutStyle;
  367. set {
  368. layoutStyle = value;
  369. SetNeedsLayout ();
  370. }
  371. }
  372. /// <summary>
  373. /// The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame.
  374. /// </summary>
  375. /// <value>The bounds.</value>
  376. public Rect Bounds {
  377. get => new Rect (Point.Empty, Frame.Size);
  378. set {
  379. Frame = new Rect (frame.Location, value.Size);
  380. }
  381. }
  382. Pos x, y;
  383. /// <summary>
  384. /// Gets or sets the X position for the view (the column). This is only used when the LayoutStyle is Computed, if the
  385. /// LayoutStyle is set to Absolute, this value is ignored.
  386. /// </summary>
  387. /// <value>The X Position.</value>
  388. public Pos X {
  389. get => x;
  390. set {
  391. x = value;
  392. SetNeedsLayout ();
  393. }
  394. }
  395. /// <summary>
  396. /// Gets or sets the Y position for the view (line). This is only used when the LayoutStyle is Computed, if the
  397. /// LayoutStyle is set to Absolute, this value is ignored.
  398. /// </summary>
  399. /// <value>The y position (line).</value>
  400. public Pos Y {
  401. get => y;
  402. set {
  403. y = value;
  404. SetNeedsLayout ();
  405. }
  406. }
  407. Dim width, height;
  408. /// <summary>
  409. /// Gets or sets the width for the view. This is only used when the LayoutStyle is Computed, if the
  410. /// LayoutStyle is set to Absolute, this value is ignored.
  411. /// </summary>
  412. /// <value>The width.</value>
  413. public Dim Width {
  414. get => width;
  415. set {
  416. width = value;
  417. SetNeedsLayout ();
  418. }
  419. }
  420. /// <summary>
  421. /// Gets or sets the height for the view. This is only used when the LayoutStyle is Computed, if the
  422. /// LayoutStyle is set to Absolute, this value is ignored.
  423. /// </summary>
  424. /// <value>The height.</value>
  425. public Dim Height {
  426. get => height;
  427. set {
  428. height = value;
  429. SetNeedsLayout ();
  430. }
  431. }
  432. /// <summary>
  433. /// Returns the container for this view, or null if this view has not been added to a container.
  434. /// </summary>
  435. /// <value>The super view.</value>
  436. public View SuperView => container;
  437. /// <summary>
  438. /// Initializes a new instance of the <see cref="T:Terminal.Gui.View"/> class with the absolute
  439. /// dimensions specified in the frame. If you want to have Views that can be positioned with
  440. /// Pos and Dim properties on X, Y, Width and Height, use the empty constructor.
  441. /// </summary>
  442. /// <param name="frame">The region covered by this view.</param>
  443. public View (Rect frame)
  444. {
  445. this.Frame = frame;
  446. CanFocus = false;
  447. LayoutStyle = LayoutStyle.Absolute;
  448. }
  449. /// <summary>
  450. /// Initializes a new instance of the <see cref="T:Terminal.Gui.View"/> class and sets the
  451. /// view up for Computed layout, which will use the values in X, Y, Width and Height to
  452. /// compute the View's Frame.
  453. /// </summary>
  454. public View ()
  455. {
  456. CanFocus = false;
  457. LayoutStyle = LayoutStyle.Computed;
  458. }
  459. /// <summary>
  460. /// Invoke to flag that this view needs to be redisplayed, by any code
  461. /// that alters the state of the view.
  462. /// </summary>
  463. public void SetNeedsDisplay ()
  464. {
  465. SetNeedsDisplay (Bounds);
  466. }
  467. internal bool layoutNeeded = true;
  468. internal void SetNeedsLayout ()
  469. {
  470. if (layoutNeeded)
  471. return;
  472. layoutNeeded = true;
  473. if (SuperView == null)
  474. return;
  475. SuperView.SetNeedsLayout ();
  476. }
  477. /// <summary>
  478. /// Flags the specified rectangle region on this view as needing to be repainted.
  479. /// </summary>
  480. /// <param name="region">The region that must be flagged for repaint.</param>
  481. public void SetNeedsDisplay (Rect region)
  482. {
  483. if (NeedDisplay.IsEmpty)
  484. NeedDisplay = region;
  485. else {
  486. var x = Math.Min (NeedDisplay.X, region.X);
  487. var y = Math.Min (NeedDisplay.Y, region.Y);
  488. var w = Math.Max (NeedDisplay.Width, region.Width);
  489. var h = Math.Max (NeedDisplay.Height, region.Height);
  490. NeedDisplay = new Rect (x, y, w, h);
  491. }
  492. if (container != null)
  493. container.ChildNeedsDisplay ();
  494. if (subviews == null)
  495. return;
  496. foreach (var view in subviews)
  497. if (view.Frame.IntersectsWith (region)) {
  498. var childRegion = Rect.Intersect (view.Frame, region);
  499. childRegion.X -= view.Frame.X;
  500. childRegion.Y -= view.Frame.Y;
  501. view.SetNeedsDisplay (childRegion);
  502. }
  503. }
  504. internal bool childNeedsDisplay;
  505. /// <summary>
  506. /// Flags this view for requiring the children views to be repainted.
  507. /// </summary>
  508. public void ChildNeedsDisplay ()
  509. {
  510. childNeedsDisplay = true;
  511. if (container != null)
  512. container.ChildNeedsDisplay ();
  513. }
  514. /// <summary>
  515. /// Adds a subview to this view.
  516. /// </summary>
  517. /// <remarks>
  518. /// </remarks>
  519. public virtual void Add (View view)
  520. {
  521. if (view == null)
  522. return;
  523. if (subviews == null)
  524. subviews = new List<View> ();
  525. subviews.Add (view);
  526. view.container = this;
  527. if (view.CanFocus)
  528. CanFocus = true;
  529. SetNeedsLayout ();
  530. SetNeedsDisplay ();
  531. }
  532. /// <summary>
  533. /// Adds the specified views to the view.
  534. /// </summary>
  535. /// <param name="views">Array of one or more views (can be optional parameter).</param>
  536. public void Add (params View [] views)
  537. {
  538. if (views == null)
  539. return;
  540. foreach (var view in views)
  541. Add (view);
  542. }
  543. /// <summary>
  544. /// Removes all the widgets from this container.
  545. /// </summary>
  546. /// <remarks>
  547. /// </remarks>
  548. public virtual void RemoveAll ()
  549. {
  550. if (subviews == null)
  551. return;
  552. while (subviews.Count > 0) {
  553. Remove (subviews [0]);
  554. }
  555. }
  556. /// <summary>
  557. /// Removes a widget from this container.
  558. /// </summary>
  559. /// <remarks>
  560. /// </remarks>
  561. public virtual void Remove (View view)
  562. {
  563. if (view == null || subviews == null)
  564. return;
  565. SetNeedsLayout ();
  566. SetNeedsDisplay ();
  567. var touched = view.Frame;
  568. subviews.Remove (view);
  569. view.container = null;
  570. if (subviews.Count < 1)
  571. this.CanFocus = false;
  572. foreach (var v in subviews) {
  573. if (v.Frame.IntersectsWith (touched))
  574. view.SetNeedsDisplay ();
  575. }
  576. }
  577. void PerformActionForSubview (View subview, Action<View> action)
  578. {
  579. if (subviews.Contains (subview)) {
  580. action (subview);
  581. }
  582. SetNeedsDisplay ();
  583. subview.SetNeedsDisplay ();
  584. }
  585. /// <summary>
  586. /// Brings the specified subview to the front so it is drawn on top of any other views.
  587. /// </summary>
  588. /// <param name="subview">The subview to send to the front</param>
  589. /// <remarks>
  590. /// <seealso cref="SendSubviewToBack"/>.
  591. /// </remarks>
  592. public void BringSubviewToFront (View subview)
  593. {
  594. PerformActionForSubview (subview, x => {
  595. subviews.Remove (x);
  596. subviews.Add (x);
  597. });
  598. }
  599. /// <summary>
  600. /// Sends the specified subview to the front so it is the first view drawn
  601. /// </summary>
  602. /// <param name="subview">The subview to send to the front</param>
  603. /// <remarks>
  604. /// <seealso cref="BringSubviewToFront(View)"/>.
  605. /// </remarks>
  606. public void SendSubviewToBack (View subview)
  607. {
  608. PerformActionForSubview (subview, x => {
  609. subviews.Remove (x);
  610. subviews.Insert (0, subview);
  611. });
  612. }
  613. /// <summary>
  614. /// Moves the subview backwards in the hierarchy, only one step
  615. /// </summary>
  616. /// <param name="subview">The subview to send backwards</param>
  617. /// <remarks>
  618. /// If you want to send the view all the way to the back use SendSubviewToBack.
  619. /// </remarks>
  620. public void SendSubviewBackwards (View subview)
  621. {
  622. PerformActionForSubview (subview, x => {
  623. var idx = subviews.IndexOf (x);
  624. if (idx > 0) {
  625. subviews.Remove (x);
  626. subviews.Insert (idx - 1, x);
  627. }
  628. });
  629. }
  630. /// <summary>
  631. /// Moves the subview backwards in the hierarchy, only one step
  632. /// </summary>
  633. /// <param name="subview">The subview to send backwards</param>
  634. /// <remarks>
  635. /// If you want to send the view all the way to the back use SendSubviewToBack.
  636. /// </remarks>
  637. public void BringSubviewForward (View subview)
  638. {
  639. PerformActionForSubview (subview, x => {
  640. var idx = subviews.IndexOf (x);
  641. if (idx + 1 < subviews.Count) {
  642. subviews.Remove (x);
  643. subviews.Insert (idx + 1, x);
  644. }
  645. });
  646. }
  647. /// <summary>
  648. /// Clears the view region with the current color.
  649. /// </summary>
  650. /// <remarks>
  651. /// <para>
  652. /// This clears the entire region used by this view.
  653. /// </para>
  654. /// </remarks>
  655. public void Clear ()
  656. {
  657. var h = Frame.Height;
  658. var w = Frame.Width;
  659. for (int line = 0; line < h; line++) {
  660. Move (0, line);
  661. for (int col = 0; col < w; col++)
  662. Driver.AddRune (' ');
  663. }
  664. }
  665. /// <summary>
  666. /// Clears the specified rectangular region with the current color
  667. /// </summary>
  668. public void Clear (Rect r)
  669. {
  670. var h = r.Height;
  671. var w = r.Width;
  672. for (int line = r.Y; line < r.Y + h; line++) {
  673. Driver.Move (r.X, line);
  674. for (int col = 0; col < w; col++)
  675. Driver.AddRune (' ');
  676. }
  677. }
  678. /// <summary>
  679. /// Converts the (col,row) position from the view into a screen (col,row). The values are clamped to (0..ScreenDim-1)
  680. /// </summary>
  681. /// <param name="col">View-based column.</param>
  682. /// <param name="row">View-based row.</param>
  683. /// <param name="rcol">Absolute column, display relative.</param>
  684. /// <param name="rrow">Absolute row, display relative.</param>
  685. /// <param name="clipped">Whether to clip the result of the ViewToScreen method, if set to true, the rcol, rrow values are clamped to the screen dimensions.</param>
  686. internal void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true)
  687. {
  688. // Computes the real row, col relative to the screen.
  689. rrow = row + frame.Y;
  690. rcol = col + frame.X;
  691. var ccontainer = container;
  692. while (ccontainer != null) {
  693. rrow += ccontainer.frame.Y;
  694. rcol += ccontainer.frame.X;
  695. ccontainer = ccontainer.container;
  696. }
  697. // The following ensures that the cursor is always in the screen boundaries.
  698. if (clipped) {
  699. rrow = Math.Max (0, Math.Min (rrow, Driver.Rows - 1));
  700. rcol = Math.Max (0, Math.Min (rcol, Driver.Cols - 1));
  701. }
  702. }
  703. /// <summary>
  704. /// Converts a point from screen coordinates into the view coordinate space.
  705. /// </summary>
  706. /// <returns>The mapped point.</returns>
  707. /// <param name="x">X screen-coordinate point.</param>
  708. /// <param name="y">Y screen-coordinate point.</param>
  709. public Point ScreenToView (int x, int y)
  710. {
  711. if (SuperView == null) {
  712. return new Point (x - Frame.X, y - frame.Y);
  713. } else {
  714. var parent = SuperView.ScreenToView (x, y);
  715. return new Point (parent.X - frame.X, parent.Y - frame.Y);
  716. }
  717. }
  718. // Converts a rectangle in view coordinates to screen coordinates.
  719. Rect RectToScreen (Rect rect)
  720. {
  721. ViewToScreen (rect.X, rect.Y, out var x, out var y, clipped: false);
  722. return new Rect (x, y, rect.Width, rect.Height);
  723. }
  724. // Clips a rectangle in screen coordinates to the dimensions currently available on the screen
  725. Rect ScreenClip (Rect rect)
  726. {
  727. var x = rect.X < 0 ? 0 : rect.X;
  728. var y = rect.Y < 0 ? 0 : rect.Y;
  729. var w = rect.X + rect.Width >= Driver.Cols ? Driver.Cols - rect.X : rect.Width;
  730. var h = rect.Y + rect.Height >= Driver.Rows ? Driver.Rows - rect.Y : rect.Height;
  731. return new Rect (x, y, w, h);
  732. }
  733. /// <summary>
  734. /// Sets the Console driver's clip region to the current View's Bounds.
  735. /// </summary>
  736. /// <returns>The existing driver's Clip region, which can be then set by setting the Driver.Clip property.</returns>
  737. public Rect ClipToBounds ()
  738. {
  739. return SetClip (Bounds);
  740. }
  741. /// <summary>
  742. /// Sets the clipping region to the specified region, the region is view-relative
  743. /// </summary>
  744. /// <returns>The previous clip region.</returns>
  745. /// <param name="rect">Rectangle region to clip into, the region is view-relative.</param>
  746. public Rect SetClip (Rect rect)
  747. {
  748. var bscreen = RectToScreen (rect);
  749. var previous = Driver.Clip;
  750. Driver.Clip = ScreenClip (RectToScreen (Bounds));
  751. return previous;
  752. }
  753. /// <summary>
  754. /// Draws a frame in the current view, clipped by the boundary of this view
  755. /// </summary>
  756. /// <param name="rect">Rectangular region for the frame to be drawn.</param>
  757. /// <param name="padding">The padding to add to the drawn frame.</param>
  758. /// <param name="fill">If set to <c>true</c> it fill will the contents.</param>
  759. public void DrawFrame (Rect rect, int padding = 0, bool fill = false)
  760. {
  761. var scrRect = RectToScreen (rect);
  762. var savedClip = Driver.Clip;
  763. Driver.Clip = ScreenClip (RectToScreen (Bounds));
  764. Driver.DrawFrame (scrRect, padding, fill);
  765. Driver.Clip = savedClip;
  766. }
  767. /// <summary>
  768. /// Utility function to draw strings that contain a hotkey
  769. /// </summary>
  770. /// <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
  771. /// <param name="hotColor">Hot color.</param>
  772. /// <param name="normalColor">Normal color.</param>
  773. public void DrawHotString (ustring text, Attribute hotColor, Attribute normalColor)
  774. {
  775. Driver.SetAttribute (normalColor);
  776. foreach (var rune in text) {
  777. if (rune == '_') {
  778. Driver.SetAttribute (hotColor);
  779. continue;
  780. }
  781. Driver.AddRune (rune);
  782. Driver.SetAttribute (normalColor);
  783. }
  784. }
  785. /// <summary>
  786. /// Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.
  787. /// </summary>
  788. /// <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
  789. /// <param name="focused">If set to <c>true</c> this uses the focused colors from the color scheme, otherwise the regular ones.</param>
  790. /// <param name="scheme">The color scheme to use.</param>
  791. public void DrawHotString (ustring text, bool focused, ColorScheme scheme)
  792. {
  793. if (focused)
  794. DrawHotString (text, scheme.HotFocus, scheme.Focus);
  795. else
  796. DrawHotString (text, scheme.HotNormal, scheme.Normal);
  797. }
  798. /// <summary>
  799. /// This moves the cursor to the specified column and row in the view.
  800. /// </summary>
  801. /// <returns>The move.</returns>
  802. /// <param name="col">Col.</param>
  803. /// <param name="row">Row.</param>
  804. public void Move (int col, int row)
  805. {
  806. ViewToScreen (col, row, out var rcol, out var rrow);
  807. Driver.Move (rcol, rrow);
  808. }
  809. /// <summary>
  810. /// Positions the cursor in the right position based on the currently focused view in the chain.
  811. /// </summary>
  812. public virtual void PositionCursor ()
  813. {
  814. if (focused != null)
  815. focused.PositionCursor ();
  816. else
  817. Move (frame.X, frame.Y);
  818. }
  819. /// <inheritdoc cref="HasFocus"/>
  820. public override bool HasFocus {
  821. get {
  822. return base.HasFocus;
  823. }
  824. internal set {
  825. if (base.HasFocus != value)
  826. if (value)
  827. OnEnter ();
  828. else
  829. OnLeave ();
  830. SetNeedsDisplay ();
  831. base.HasFocus = value;
  832. // Remove focus down the chain of subviews if focus is removed
  833. if (!value && focused != null) {
  834. focused.OnLeave ();
  835. focused.HasFocus = false;
  836. focused = null;
  837. }
  838. }
  839. }
  840. /// <inheritdoc cref="OnEnter"/>
  841. public override bool OnEnter ()
  842. {
  843. Enter?.Invoke (this, new EventArgs ());
  844. return base.OnEnter ();
  845. }
  846. /// <inheritdoc cref="OnLeave"/>
  847. public override bool OnLeave ()
  848. {
  849. Leave?.Invoke (this, new EventArgs ());
  850. return base.OnLeave ();
  851. }
  852. /// <summary>
  853. /// Returns the currently focused view inside this view, or null if nothing is focused.
  854. /// </summary>
  855. /// <value>The focused.</value>
  856. public View Focused => focused;
  857. /// <summary>
  858. /// Returns the most focused view in the chain of subviews (the leaf view that has the focus).
  859. /// </summary>
  860. /// <value>The most focused.</value>
  861. public View MostFocused {
  862. get {
  863. if (Focused == null)
  864. return null;
  865. var most = Focused.MostFocused;
  866. if (most != null)
  867. return most;
  868. return Focused;
  869. }
  870. }
  871. /// <summary>
  872. /// The color scheme for this view, if it is not defined, it returns the parent's
  873. /// color scheme.
  874. /// </summary>
  875. public ColorScheme ColorScheme {
  876. get {
  877. if (colorScheme == null)
  878. return SuperView?.ColorScheme;
  879. return colorScheme;
  880. }
  881. set {
  882. colorScheme = value;
  883. }
  884. }
  885. ColorScheme colorScheme;
  886. /// <summary>
  887. /// Displays the specified character in the specified column and row.
  888. /// </summary>
  889. /// <param name="col">Col.</param>
  890. /// <param name="row">Row.</param>
  891. /// <param name="ch">Ch.</param>
  892. public void AddRune (int col, int row, Rune ch)
  893. {
  894. if (row < 0 || col < 0)
  895. return;
  896. if (row > frame.Height - 1 || col > frame.Width - 1)
  897. return;
  898. Move (col, row);
  899. Driver.AddRune (ch);
  900. }
  901. /// <summary>
  902. /// Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.
  903. /// </summary>
  904. protected void ClearNeedsDisplay ()
  905. {
  906. NeedDisplay = Rect.Empty;
  907. childNeedsDisplay = false;
  908. }
  909. /// <summary>
  910. /// Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.
  911. /// </summary>
  912. /// <param name="region">The region to redraw, this is relative to the view itself.</param>
  913. /// <remarks>
  914. /// <para>
  915. /// Views should set the color that they want to use on entry, as otherwise this will inherit
  916. /// the last color that was set globaly on the driver.
  917. /// </para>
  918. /// </remarks>
  919. public virtual void Redraw (Rect region)
  920. {
  921. var clipRect = new Rect (Point.Empty, frame.Size);
  922. if (subviews != null) {
  923. foreach (var view in subviews) {
  924. if (!view.NeedDisplay.IsEmpty || view.childNeedsDisplay) {
  925. if (view.Frame.IntersectsWith (clipRect) && view.Frame.IntersectsWith (region)) {
  926. // FIXED: optimize this by computing the intersection of region and view.Bounds
  927. if (view.layoutNeeded)
  928. view.LayoutSubviews ();
  929. Application.CurrentView = view;
  930. view.Redraw (view.Bounds);
  931. }
  932. view.NeedDisplay = Rect.Empty;
  933. view.childNeedsDisplay = false;
  934. }
  935. }
  936. }
  937. ClearNeedsDisplay ();
  938. }
  939. /// <summary>
  940. /// Focuses the specified sub-view.
  941. /// </summary>
  942. /// <param name="view">View.</param>
  943. public void SetFocus (View view)
  944. {
  945. if (view == null)
  946. return;
  947. //Console.WriteLine ($"Request to focus {view}");
  948. if (!view.CanFocus)
  949. return;
  950. if (focused == view)
  951. return;
  952. // Make sure that this view is a subview
  953. View c;
  954. for (c = view.container; c != null; c = c.container)
  955. if (c == this)
  956. break;
  957. if (c == null)
  958. throw new ArgumentException ("the specified view is not part of the hierarchy of this view");
  959. if (focused != null)
  960. focused.HasFocus = false;
  961. focused = view;
  962. focused.HasFocus = true;
  963. focused.EnsureFocus ();
  964. // Send focus upwards
  965. SuperView?.SetFocus (this);
  966. }
  967. public class KeyEventEventArgs : EventArgs {
  968. public KeyEventEventArgs(KeyEvent ke) => KeyEvent = ke;
  969. public KeyEvent KeyEvent { get; set; }
  970. }
  971. /// <summary>
  972. /// Invoked when a character key is pressed and occurs after the key up event.
  973. /// </summary>
  974. public event EventHandler<KeyEventEventArgs> KeyPress;
  975. /// <inheritdoc cref="ProcessKey"/>
  976. public override bool ProcessKey (KeyEvent keyEvent)
  977. {
  978. KeyPress?.Invoke (this, new KeyEventEventArgs(keyEvent));
  979. if (Focused?.ProcessKey (keyEvent) == true)
  980. return true;
  981. return false;
  982. }
  983. /// <inheritdoc cref="ProcessHotKey"/>
  984. public override bool ProcessHotKey (KeyEvent keyEvent)
  985. {
  986. KeyPress?.Invoke (this, new KeyEventEventArgs (keyEvent));
  987. if (subviews == null || subviews.Count == 0)
  988. return false;
  989. foreach (var view in subviews)
  990. if (view.ProcessHotKey (keyEvent))
  991. return true;
  992. return false;
  993. }
  994. /// <inheritdoc cref="ProcessColdKey"/>
  995. public override bool ProcessColdKey (KeyEvent keyEvent)
  996. {
  997. KeyPress?.Invoke (this, new KeyEventEventArgs(keyEvent));
  998. if (subviews == null || subviews.Count == 0)
  999. return false;
  1000. foreach (var view in subviews)
  1001. if (view.ProcessColdKey (keyEvent))
  1002. return true;
  1003. return false;
  1004. }
  1005. /// <summary>
  1006. /// Invoked when a key is pressed
  1007. /// </summary>
  1008. public event EventHandler<KeyEventEventArgs> KeyDown;
  1009. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  1010. public override bool OnKeyDown (KeyEvent keyEvent)
  1011. {
  1012. KeyDown?.Invoke (this, new KeyEventEventArgs (keyEvent));
  1013. if (subviews == null || subviews.Count == 0)
  1014. return false;
  1015. foreach (var view in subviews)
  1016. if (view.OnKeyDown (keyEvent))
  1017. return true;
  1018. return false;
  1019. }
  1020. /// <summary>
  1021. /// Invoked when a key is released
  1022. /// </summary>
  1023. public event EventHandler<KeyEventEventArgs> KeyUp;
  1024. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  1025. public override bool OnKeyUp (KeyEvent keyEvent)
  1026. {
  1027. KeyUp?.Invoke (this, new KeyEventEventArgs (keyEvent));
  1028. if (subviews == null || subviews.Count == 0)
  1029. return false;
  1030. foreach (var view in subviews)
  1031. if (view.OnKeyUp (keyEvent))
  1032. return true;
  1033. return false;
  1034. }
  1035. /// <summary>
  1036. /// Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
  1037. /// </summary>
  1038. public void EnsureFocus ()
  1039. {
  1040. if (focused == null)
  1041. if (FocusDirection == Direction.Forward)
  1042. FocusFirst ();
  1043. else
  1044. FocusLast ();
  1045. }
  1046. /// <summary>
  1047. /// Focuses the first focusable subview if one exists.
  1048. /// </summary>
  1049. public void FocusFirst ()
  1050. {
  1051. if (subviews == null) {
  1052. SuperView?.SetFocus (this);
  1053. return;
  1054. }
  1055. foreach (var view in subviews) {
  1056. if (view.CanFocus) {
  1057. SetFocus (view);
  1058. return;
  1059. }
  1060. }
  1061. }
  1062. /// <summary>
  1063. /// Focuses the last focusable subview if one exists.
  1064. /// </summary>
  1065. public void FocusLast ()
  1066. {
  1067. if (subviews == null) {
  1068. SuperView?.SetFocus (this);
  1069. return;
  1070. }
  1071. for (int i = subviews.Count; i > 0;) {
  1072. i--;
  1073. View v = subviews [i];
  1074. if (v.CanFocus) {
  1075. SetFocus (v);
  1076. return;
  1077. }
  1078. }
  1079. }
  1080. /// <summary>
  1081. /// Focuses the previous view.
  1082. /// </summary>
  1083. /// <returns><c>true</c>, if previous was focused, <c>false</c> otherwise.</returns>
  1084. public bool FocusPrev ()
  1085. {
  1086. FocusDirection = Direction.Backward;
  1087. if (subviews == null || subviews.Count == 0)
  1088. return false;
  1089. if (focused == null) {
  1090. FocusLast ();
  1091. return focused != null;
  1092. }
  1093. int focused_idx = -1;
  1094. for (int i = subviews.Count; i > 0;) {
  1095. i--;
  1096. View w = subviews [i];
  1097. if (w.HasFocus) {
  1098. if (w.FocusPrev ())
  1099. return true;
  1100. focused_idx = i;
  1101. continue;
  1102. }
  1103. if (w.CanFocus && focused_idx != -1) {
  1104. focused.HasFocus = false;
  1105. if (w != null && w.CanFocus)
  1106. w.FocusLast ();
  1107. SetFocus (w);
  1108. return true;
  1109. }
  1110. }
  1111. if (focused != null) {
  1112. focused.HasFocus = false;
  1113. focused = null;
  1114. }
  1115. return false;
  1116. }
  1117. /// <summary>
  1118. /// Focuses the next view.
  1119. /// </summary>
  1120. /// <returns><c>true</c>, if next was focused, <c>false</c> otherwise.</returns>
  1121. public bool FocusNext ()
  1122. {
  1123. FocusDirection = Direction.Forward;
  1124. if (subviews == null || subviews.Count == 0)
  1125. return false;
  1126. if (focused == null) {
  1127. FocusFirst ();
  1128. return focused != null;
  1129. }
  1130. int n = subviews.Count;
  1131. int focused_idx = -1;
  1132. for (int i = 0; i < n; i++) {
  1133. View w = subviews [i];
  1134. if (w.HasFocus) {
  1135. if (w.FocusNext ())
  1136. return true;
  1137. focused_idx = i;
  1138. continue;
  1139. }
  1140. if (w.CanFocus && focused_idx != -1) {
  1141. focused.HasFocus = false;
  1142. if (w != null && w.CanFocus)
  1143. w.FocusFirst ();
  1144. SetFocus (w);
  1145. return true;
  1146. }
  1147. }
  1148. if (focused != null) {
  1149. focused.HasFocus = false;
  1150. focused = null;
  1151. }
  1152. return false;
  1153. }
  1154. /// <summary>
  1155. /// Computes the RelativeLayout for the view, given the frame for its container.
  1156. /// </summary>
  1157. /// <param name="hostFrame">The Frame for the host.</param>
  1158. internal void RelativeLayout (Rect hostFrame)
  1159. {
  1160. int w, h, _x, _y;
  1161. if (x is Pos.PosCenter) {
  1162. if (width == null)
  1163. w = hostFrame.Width;
  1164. else
  1165. w = width.Anchor (hostFrame.Width);
  1166. _x = x.Anchor (hostFrame.Width - w);
  1167. } else {
  1168. if (x == null)
  1169. _x = 0;
  1170. else
  1171. _x = x.Anchor (hostFrame.Width);
  1172. if (width == null)
  1173. w = hostFrame.Width;
  1174. else
  1175. w = width.Anchor (hostFrame.Width - _x);
  1176. }
  1177. if (y is Pos.PosCenter) {
  1178. if (height == null)
  1179. h = hostFrame.Height;
  1180. else
  1181. h = height.Anchor (hostFrame.Height);
  1182. _y = y.Anchor (hostFrame.Height - h);
  1183. } else {
  1184. if (y == null)
  1185. _y = 0;
  1186. else
  1187. _y = y.Anchor (hostFrame.Height);
  1188. if (height == null)
  1189. h = hostFrame.Height;
  1190. else
  1191. h = height.Anchor (hostFrame.Height - _y);
  1192. }
  1193. Frame = new Rect (_x, _y, w, h);
  1194. // layoutNeeded = false;
  1195. }
  1196. // https://en.wikipedia.org/wiki/Topological_sorting
  1197. List<View> TopologicalSort (HashSet<View> nodes, HashSet<(View From, View To)> edges)
  1198. {
  1199. var result = new List<View> ();
  1200. // Set of all nodes with no incoming edges
  1201. var S = new HashSet<View> (nodes.Where (n => edges.All (e => e.To.Equals (n) == false)));
  1202. while (S.Any ()) {
  1203. // remove a node n from S
  1204. var n = S.First ();
  1205. S.Remove (n);
  1206. // add n to tail of L
  1207. if (n != this?.SuperView)
  1208. result.Add (n);
  1209. // for each node m with an edge e from n to m do
  1210. foreach (var e in edges.Where (e => e.From.Equals (n)).ToArray ()) {
  1211. var m = e.To;
  1212. // remove edge e from the graph
  1213. edges.Remove (e);
  1214. // if m has no other incoming edges then
  1215. if (edges.All (me => me.To.Equals (m) == false) && m != this?.SuperView) {
  1216. // insert m into S
  1217. S.Add (m);
  1218. }
  1219. }
  1220. }
  1221. // if graph has edges then
  1222. if (edges.Any ()) {
  1223. // return error (graph has at least one cycle)
  1224. return null;
  1225. } else {
  1226. // return L (a topologically sorted order)
  1227. return result;
  1228. }
  1229. }
  1230. /// <summary>
  1231. /// This virtual method is invoked when a view starts executing or
  1232. /// when the dimensions of the view have changed, for example in
  1233. /// response to the container view or terminal resizing.
  1234. /// </summary>
  1235. public virtual void LayoutSubviews ()
  1236. {
  1237. if (!layoutNeeded)
  1238. return;
  1239. // Sort out the dependencies of the X, Y, Width, Height properties
  1240. var nodes = new HashSet<View> ();
  1241. var edges = new HashSet<(View, View)> ();
  1242. foreach (var v in InternalSubviews) {
  1243. nodes.Add (v);
  1244. if (v.LayoutStyle == LayoutStyle.Computed) {
  1245. if (v.X is Pos.PosView vX)
  1246. edges.Add ((vX.Target, v));
  1247. if (v.Y is Pos.PosView vY)
  1248. edges.Add ((vY.Target, v));
  1249. if (v.Width is Dim.DimView vWidth)
  1250. edges.Add ((vWidth.Target, v));
  1251. if (v.Height is Dim.DimView vHeight)
  1252. edges.Add ((vHeight.Target, v));
  1253. }
  1254. }
  1255. var ordered = TopologicalSort (nodes, edges);
  1256. if (ordered == null)
  1257. throw new Exception ("There is a recursive cycle in the relative Pos/Dim in the views of " + this);
  1258. foreach (var v in ordered) {
  1259. if (v.LayoutStyle == LayoutStyle.Computed)
  1260. v.RelativeLayout (Frame);
  1261. v.LayoutSubviews ();
  1262. v.layoutNeeded = false;
  1263. }
  1264. if (SuperView == Application.Top && layoutNeeded && ordered.Count == 0 && LayoutStyle == LayoutStyle.Computed) {
  1265. RelativeLayout (Frame);
  1266. }
  1267. layoutNeeded = false;
  1268. }
  1269. /// <inheritdoc cref="ToString"/>
  1270. public override string ToString ()
  1271. {
  1272. return $"{GetType ().Name}({Id})({Frame})";
  1273. }
  1274. /// <inheritdoc cref="OnMouseEnter(Gui.MouseEvent)"/>
  1275. public override bool OnMouseEnter (MouseEvent mouseEvent)
  1276. {
  1277. if (!base.OnMouseEnter (mouseEvent)) {
  1278. MouseEnter?.Invoke (this, mouseEvent);
  1279. return false;
  1280. }
  1281. return true;
  1282. }
  1283. /// <inheritdoc cref="OnMouseLeave(Gui.MouseEvent)"/>
  1284. public override bool OnMouseLeave (MouseEvent mouseEvent)
  1285. {
  1286. if (!base.OnMouseLeave (mouseEvent)) {
  1287. MouseLeave?.Invoke (this, mouseEvent);
  1288. return false;
  1289. }
  1290. return true;
  1291. }
  1292. }
  1293. /// <summary>
  1294. /// Toplevel views can be modally executed.
  1295. /// </summary>
  1296. /// <remarks>
  1297. /// <para>
  1298. /// Toplevels can be modally executing views, and they return control
  1299. /// to the caller when the "Running" property is set to false, or
  1300. /// by calling <see cref="M:Terminal.Gui.Application.RequestStop()"/>
  1301. /// </para>
  1302. /// <para>
  1303. /// There will be a toplevel created for you on the first time use
  1304. /// and can be accessed from the property <see cref="P:Terminal.Gui.Application.Top"/>,
  1305. /// but new toplevels can be created and ran on top of it. To run, create the
  1306. /// toplevel and then invoke <see cref="M:Terminal.Gui.Application.Run"/> with the
  1307. /// new toplevel.
  1308. /// </para>
  1309. /// <para>
  1310. /// TopLevels can also opt-in to more sophisticated initialization
  1311. /// by implementing <see cref="ISupportInitialize"/>. When they do
  1312. /// so, the <see cref="ISupportInitialize.BeginInit"/> and
  1313. /// <see cref="ISupportInitialize.EndInit"/> methods will be called
  1314. /// before running the view.
  1315. /// If first-run-only initialization is preferred, the <see cref="ISupportInitializeNotification"/>
  1316. /// can be implemented too, in which case the <see cref="ISupportInitialize"/>
  1317. /// methods will only be called if <see cref="ISupportInitializeNotification.IsInitialized"/>
  1318. /// is <see langword="false"/>. This allows proper View inheritance hierarchies
  1319. /// to override base class layout code optimally by doing so only on first run,
  1320. /// instead of on every run.
  1321. /// </para>
  1322. /// </remarks>
  1323. public class Toplevel : View {
  1324. /// <summary>
  1325. /// Gets or sets whether the <see cref="T:Terminal.Gui.MainLoop"/> for this <see cref="T:Terminal.Gui.Toplevel"/> is running or not. Setting
  1326. /// this property to false will cause the MainLoop to exit.
  1327. /// </summary>
  1328. public bool Running { get; set; }
  1329. /// <summary>
  1330. /// Fired once the Toplevel's <see cref="T:Terminal.Gui.MainLoop"/> has started it's first iteration.
  1331. /// Subscribe to this event to perform tasks when the <see cref="T:Terminal.Gui.Toplevel"/> has been laid out and focus has been set.
  1332. /// changes. A Ready event handler is a good place to finalize initialization after calling `<see cref="T:Terminal.Gui.Application.Run"/>(topLevel)`.
  1333. /// </summary>
  1334. public event EventHandler Ready;
  1335. /// <summary>
  1336. /// Called from Application.RunLoop after the <see cref="T:Terminal.Gui.Toplevel"/> has entered it's first iteration of the loop.
  1337. /// </summary>
  1338. internal virtual void OnReady ()
  1339. {
  1340. Ready?.Invoke (this, EventArgs.Empty);
  1341. }
  1342. /// <summary>
  1343. /// Initializes a new instance of the <see cref="T:Terminal.Gui.Toplevel"/> class with the specified absolute layout.
  1344. /// </summary>
  1345. /// <param name="frame">Frame.</param>
  1346. public Toplevel (Rect frame) : base (frame)
  1347. {
  1348. Initialize ();
  1349. }
  1350. /// <summary>
  1351. /// Initializes a new instance of the <see cref="T:Terminal.Gui.Toplevel"/> class with Computed layout, defaulting to <see langword="async"/> full screen.
  1352. /// </summary>
  1353. public Toplevel () : base ()
  1354. {
  1355. Initialize ();
  1356. Width = Dim.Fill ();
  1357. Height = Dim.Fill ();
  1358. }
  1359. void Initialize ()
  1360. {
  1361. ColorScheme = Colors.Base;
  1362. }
  1363. /// <summary>
  1364. /// Convenience factory method that creates a new toplevel with the current terminal dimensions.
  1365. /// </summary>
  1366. /// <returns>The create.</returns>
  1367. public static Toplevel Create ()
  1368. {
  1369. return new Toplevel (new Rect (0, 0, Driver.Cols, Driver.Rows));
  1370. }
  1371. /// <summary>
  1372. /// Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.Toplevel"/> can focus.
  1373. /// </summary>
  1374. /// <value><c>true</c> if can focus; otherwise, <c>false</c>.</value>
  1375. public override bool CanFocus {
  1376. get => true;
  1377. }
  1378. /// <summary>
  1379. /// Determines whether the <see cref="Toplevel"/> is modal or not.
  1380. /// Causes <see cref="ProcessKey(KeyEvent)"/> to propagate keys upwards
  1381. /// by default unless set to <see langword="true"/>.
  1382. /// </summary>
  1383. public bool Modal { get; set; }
  1384. /// <summary>
  1385. /// Check id current toplevel has menu bar
  1386. /// </summary>
  1387. public bool HasMenuBar { get; set; }
  1388. /// <summary>
  1389. /// Check id current toplevel has status bar
  1390. /// </summary>
  1391. public bool HasStatusBar { get; set; }
  1392. ///<inheritdoc cref="ProcessKey"/>
  1393. public override bool ProcessKey (KeyEvent keyEvent)
  1394. {
  1395. if (base.ProcessKey (keyEvent))
  1396. return true;
  1397. switch (keyEvent.Key) {
  1398. case Key.ControlQ:
  1399. // FIXED: stop current execution of this container
  1400. Application.RequestStop ();
  1401. break;
  1402. case Key.ControlZ:
  1403. Driver.Suspend ();
  1404. return true;
  1405. #if false
  1406. case Key.F5:
  1407. Application.DebugDrawBounds = !Application.DebugDrawBounds;
  1408. SetNeedsDisplay ();
  1409. return true;
  1410. #endif
  1411. case Key.Tab:
  1412. case Key.CursorRight:
  1413. case Key.CursorDown:
  1414. case Key.ControlI: // Unix
  1415. var old = Focused;
  1416. if (!FocusNext ())
  1417. FocusNext ();
  1418. if (old != Focused) {
  1419. old?.SetNeedsDisplay ();
  1420. Focused?.SetNeedsDisplay ();
  1421. }
  1422. return true;
  1423. case Key.CursorLeft:
  1424. case Key.CursorUp:
  1425. case Key.BackTab:
  1426. old = Focused;
  1427. if (!FocusPrev ())
  1428. FocusPrev ();
  1429. if (old != Focused) {
  1430. old?.SetNeedsDisplay ();
  1431. Focused?.SetNeedsDisplay ();
  1432. }
  1433. return true;
  1434. case Key.ControlL:
  1435. Application.Refresh ();
  1436. return true;
  1437. }
  1438. return false;
  1439. }
  1440. ///<inheritdoc cref="Add"/>
  1441. public override void Add (View view)
  1442. {
  1443. if (this == Application.Top) {
  1444. if (view is MenuBar)
  1445. HasMenuBar = true;
  1446. if (view is StatusBar)
  1447. HasStatusBar = true;
  1448. }
  1449. base.Add (view);
  1450. }
  1451. ///<inheritdoc cref="Remove"/>
  1452. public override void Remove (View view)
  1453. {
  1454. if (this == Application.Top) {
  1455. if (view is MenuBar)
  1456. HasMenuBar = true;
  1457. if (view is StatusBar)
  1458. HasStatusBar = true;
  1459. }
  1460. base.Remove (view);
  1461. }
  1462. ///<inheritdoc cref="RemoveAll"/>
  1463. public override void RemoveAll ()
  1464. {
  1465. if (this == Application.Top) {
  1466. HasMenuBar = false;
  1467. HasStatusBar = false;
  1468. }
  1469. base.RemoveAll ();
  1470. }
  1471. internal void EnsureVisibleBounds (Toplevel top, int x, int y, out int nx, out int ny)
  1472. {
  1473. nx = Math.Max (x, 0);
  1474. nx = nx + top.Frame.Width > Driver.Cols ? Math.Max (Driver.Cols - top.Frame.Width, 0) : nx;
  1475. bool m, s;
  1476. if (SuperView == null || SuperView.GetType() != typeof(Toplevel))
  1477. m = Application.Top.HasMenuBar;
  1478. else
  1479. m = ((Toplevel)SuperView).HasMenuBar;
  1480. int l = m ? 1 : 0;
  1481. ny = Math.Max (y, l);
  1482. if (SuperView == null)
  1483. s = Application.Top.HasStatusBar;
  1484. else
  1485. s = ((Toplevel)SuperView).HasStatusBar;
  1486. l = s ? Driver.Rows - 1 : Driver.Rows;
  1487. ny = Math.Min (ny, l);
  1488. ny = ny + top.Frame.Height > l ? Math.Max (l - top.Frame.Height, m ? 1 : 0) : ny;
  1489. }
  1490. internal void PositionToplevels ()
  1491. {
  1492. if (this != Application.Top) {
  1493. EnsureVisibleBounds (this, Frame.X, Frame.Y, out int nx, out int ny);
  1494. if ((nx != Frame.X || ny != Frame.Y) && LayoutStyle != LayoutStyle.Computed) {
  1495. X = nx;
  1496. Y = ny;
  1497. }
  1498. } else {
  1499. foreach (var top in Subviews) {
  1500. if (top is Toplevel) {
  1501. EnsureVisibleBounds ((Toplevel)top, top.Frame.X, top.Frame.Y, out int nx, out int ny);
  1502. if ((nx != top.Frame.X || ny != top.Frame.Y) && top.LayoutStyle != LayoutStyle.Computed) {
  1503. top.X = nx;
  1504. top.Y = ny;
  1505. }
  1506. if (HasStatusBar && ny + top.Frame.Height > Driver.Rows - 1) {
  1507. if (top.Height is Dim.DimFill)
  1508. top.Height = Dim.Fill () - 1;
  1509. }
  1510. }
  1511. }
  1512. }
  1513. }
  1514. ///<inheritdoc cref="Redraw"/>
  1515. public override void Redraw (Rect region)
  1516. {
  1517. Application.CurrentView = this;
  1518. if (this == Application.Top) {
  1519. if (!NeedDisplay.IsEmpty) {
  1520. Driver.SetAttribute (Colors.TopLevel.Normal);
  1521. Clear (region);
  1522. Driver.SetAttribute (Colors.Base.Normal);
  1523. }
  1524. foreach (var view in Subviews) {
  1525. if (view.Frame.IntersectsWith (region)) {
  1526. view.SetNeedsLayout ();
  1527. view.SetNeedsDisplay (view.Bounds);
  1528. }
  1529. }
  1530. ClearNeedsDisplay ();
  1531. }
  1532. base.Redraw (base.Bounds);
  1533. }
  1534. /// <summary>
  1535. /// This method is invoked by Application.Begin as part of the Application.Run after
  1536. /// the views have been laid out, and before the views are drawn for the first time.
  1537. /// </summary>
  1538. public virtual void WillPresent ()
  1539. {
  1540. FocusFirst ();
  1541. }
  1542. }
  1543. /// <summary>
  1544. /// A toplevel view that draws a frame around its region and has a "ContentView" subview where the contents are added.
  1545. /// </summary>
  1546. public class Window : Toplevel, IEnumerable {
  1547. View contentView;
  1548. ustring title;
  1549. /// <summary>
  1550. /// The title to be displayed for this window.
  1551. /// </summary>
  1552. /// <value>The title.</value>
  1553. public ustring Title {
  1554. get => title;
  1555. set {
  1556. title = value;
  1557. SetNeedsDisplay ();
  1558. }
  1559. }
  1560. class ContentView : View {
  1561. public ContentView (Rect frame) : base (frame) { }
  1562. public ContentView () : base () { }
  1563. #if false
  1564. public override void Redraw (Rect region)
  1565. {
  1566. Driver.SetAttribute (ColorScheme.Focus);
  1567. for (int y = 0; y < Frame.Height; y++) {
  1568. Move (0, y);
  1569. for (int x = 0; x < Frame.Width; x++) {
  1570. Driver.AddRune ('x');
  1571. }
  1572. }
  1573. }
  1574. #endif
  1575. }
  1576. /// <summary>
  1577. /// Initializes a new instance of the <see cref="T:Terminal.Gui.Gui.Window"/> class with an optional title and a set frame.
  1578. /// </summary>
  1579. /// <param name="frame">Frame.</param>
  1580. /// <param name="title">Title.</param>
  1581. public Window (Rect frame, ustring title = null) : this (frame, title, padding: 0)
  1582. {
  1583. }
  1584. /// <summary>
  1585. /// Initializes a new instance of the <see cref="T:Terminal.Gui.Window"/> class with an optional title.
  1586. /// </summary>
  1587. /// <param name="title">Title.</param>
  1588. public Window (ustring title = null) : this (title, padding: 0)
  1589. {
  1590. }
  1591. int padding;
  1592. /// <summary>
  1593. /// Initializes a new instance of the <see cref="T:Terminal.Gui.Window"/> with
  1594. /// the specified frame for its location, with the specified border
  1595. /// an optional title.
  1596. /// </summary>
  1597. /// <param name="frame">Frame.</param>
  1598. /// <param name="padding">Number of characters to use for padding of the drawn frame.</param>
  1599. /// <param name="title">Title.</param>
  1600. public Window (Rect frame, ustring title = null, int padding = 0) : base (frame)
  1601. {
  1602. this.Title = title;
  1603. int wb = 2 * (1 + padding);
  1604. this.padding = padding;
  1605. var cFrame = new Rect (1 + padding, 1 + padding, frame.Width - wb, frame.Height - wb);
  1606. contentView = new ContentView (cFrame);
  1607. base.Add (contentView);
  1608. }
  1609. /// <summary>
  1610. /// Initializes a new instance of the <see cref="T:Terminal.Gui.Window"/> with
  1611. /// the specified frame for its location, with the specified border
  1612. /// an optional title.
  1613. /// </summary>
  1614. /// <param name="padding">Number of characters to use for padding of the drawn frame.</param>
  1615. /// <param name="title">Title.</param>
  1616. public Window (ustring title = null, int padding = 0) : base ()
  1617. {
  1618. this.Title = title;
  1619. int wb = 1 + padding;
  1620. this.padding = padding;
  1621. contentView = new ContentView () {
  1622. X = wb,
  1623. Y = wb,
  1624. Width = Dim.Fill (wb),
  1625. Height = Dim.Fill (wb)
  1626. };
  1627. base.Add (contentView);
  1628. }
  1629. /// <summary>
  1630. /// Enumerates the various views in the ContentView.
  1631. /// </summary>
  1632. /// <returns>The enumerator.</returns>
  1633. public new IEnumerator GetEnumerator ()
  1634. {
  1635. return contentView.GetEnumerator ();
  1636. }
  1637. void DrawFrame (bool fill = true)
  1638. {
  1639. DrawFrame (new Rect (0, 0, Frame.Width, Frame.Height), padding, fill: fill);
  1640. }
  1641. /// <summary>
  1642. /// Add the specified view to the ContentView.
  1643. /// </summary>
  1644. /// <param name="view">View to add to the window.</param>
  1645. public override void Add (View view)
  1646. {
  1647. contentView.Add (view);
  1648. if (view.CanFocus)
  1649. CanFocus = true;
  1650. }
  1651. /// <summary>
  1652. /// Removes a widget from this container.
  1653. /// </summary>
  1654. /// <remarks>
  1655. /// </remarks>
  1656. public override void Remove (View view)
  1657. {
  1658. if (view == null)
  1659. return;
  1660. SetNeedsDisplay ();
  1661. var touched = view.Frame;
  1662. contentView.Remove (view);
  1663. if (contentView.InternalSubviews.Count < 1)
  1664. this.CanFocus = false;
  1665. }
  1666. /// <summary>
  1667. /// Removes all widgets from this container.
  1668. /// </summary>
  1669. /// <remarks>
  1670. /// </remarks>
  1671. public override void RemoveAll ()
  1672. {
  1673. contentView.RemoveAll ();
  1674. }
  1675. ///<inheritdoc cref="Redraw"/>
  1676. public override void Redraw (Rect bounds)
  1677. {
  1678. Application.CurrentView = this;
  1679. if (!NeedDisplay.IsEmpty) {
  1680. DrawFrameWindow ();
  1681. }
  1682. contentView.Redraw (contentView.Bounds);
  1683. ClearNeedsDisplay ();
  1684. DrawFrameWindow (false);
  1685. void DrawFrameWindow (bool fill = true)
  1686. {
  1687. Driver.SetAttribute (ColorScheme.Normal);
  1688. DrawFrame (fill);
  1689. if (HasFocus)
  1690. Driver.SetAttribute (ColorScheme.HotNormal);
  1691. var width = Frame.Width - (padding + 2) * 2;
  1692. if (Title != null && width > 4) {
  1693. Move (1 + padding, padding);
  1694. Driver.AddRune (' ');
  1695. var str = Title.Length >= width ? Title [0, width - 2] : Title;
  1696. Driver.AddStr (str);
  1697. Driver.AddRune (' ');
  1698. }
  1699. Driver.SetAttribute (ColorScheme.Normal);
  1700. }
  1701. }
  1702. //
  1703. // FIXED:It does not look like the event is raised on clicked-drag
  1704. // need to figure that out.
  1705. //
  1706. internal static Point? dragPosition;
  1707. Point start;
  1708. ///<inheritdoc cref="MouseEvent(Gui.MouseEvent)"/>
  1709. public override bool MouseEvent (MouseEvent mouseEvent)
  1710. {
  1711. // FIXED:The code is currently disabled, because the
  1712. // Driver.UncookMouse does not seem to have an effect if there is
  1713. // a pending mouse event activated.
  1714. int nx, ny;
  1715. if ((mouseEvent.Flags == (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) ||
  1716. mouseEvent.Flags == MouseFlags.Button3Pressed)) {
  1717. if (dragPosition.HasValue) {
  1718. if (SuperView == null) {
  1719. Application.Top.SetNeedsDisplay (Frame);
  1720. Application.Top.Redraw (Frame);
  1721. } else {
  1722. SuperView.SetNeedsDisplay (Frame);
  1723. }
  1724. EnsureVisibleBounds (this, mouseEvent.X + mouseEvent.OfX - start.X,
  1725. mouseEvent.Y + mouseEvent.OfY, out nx, out ny);
  1726. dragPosition = new Point (nx, ny);
  1727. Frame = new Rect (nx, ny, Frame.Width, Frame.Height);
  1728. X = nx;
  1729. Y = ny;
  1730. //Demo.ml2.Text = $"{dx},{dy}";
  1731. // FIXED: optimize, only SetNeedsDisplay on the before/after regions.
  1732. SetNeedsDisplay ();
  1733. return true;
  1734. } else {
  1735. // Only start grabbing if the user clicks on the title bar.
  1736. if (mouseEvent.Y == 0) {
  1737. start = new Point (mouseEvent.X, mouseEvent.Y);
  1738. dragPosition = new Point ();
  1739. nx = mouseEvent.X - mouseEvent.OfX;
  1740. ny = mouseEvent.Y - mouseEvent.OfY;
  1741. dragPosition = new Point (nx, ny);
  1742. Application.GrabMouse (this);
  1743. }
  1744. //Demo.ml2.Text = $"Starting at {dragPosition}";
  1745. return true;
  1746. }
  1747. }
  1748. if (mouseEvent.Flags == MouseFlags.Button1Released && dragPosition.HasValue) {
  1749. Application.UngrabMouse ();
  1750. Driver.UncookMouse ();
  1751. dragPosition = null;
  1752. }
  1753. //Demo.ml.Text = me.ToString ();
  1754. return false;
  1755. }
  1756. }
  1757. /// <summary>
  1758. /// The application driver for gui.cs
  1759. /// </summary>
  1760. /// <remarks>
  1761. /// <para>
  1762. /// You can hook up to the Iteration event to have your method
  1763. /// invoked on each iteration of the mainloop.
  1764. /// </para>
  1765. /// <para>
  1766. /// Creates a mainloop to process input events, handle timers and
  1767. /// other sources of data. It is accessible via the MainLoop property.
  1768. /// </para>
  1769. /// <para>
  1770. /// When invoked sets the SynchronizationContext to one that is tied
  1771. /// to the mainloop, allowing user code to use async/await.
  1772. /// </para>
  1773. /// </remarks>
  1774. public static class Application {
  1775. /// <summary>
  1776. /// The current Console Driver in use.
  1777. /// </summary>
  1778. public static ConsoleDriver Driver;
  1779. /// <summary>
  1780. /// The Toplevel object used for the application on startup.
  1781. /// </summary>
  1782. /// <value>The top.</value>
  1783. public static Toplevel Top { get; private set; }
  1784. /// <summary>
  1785. /// The current toplevel object. This is updated when Application.Run enters and leaves and points to the current toplevel.
  1786. /// </summary>
  1787. /// <value>The current.</value>
  1788. public static Toplevel Current { get; private set; }
  1789. /// <summary>
  1790. /// TThe current view object being redrawn.
  1791. /// </summary>
  1792. /// /// <value>The current.</value>
  1793. public static View CurrentView { get; set; }
  1794. /// <summary>
  1795. /// The mainloop driver for the applicaiton
  1796. /// </summary>
  1797. /// <value>The main loop.</value>
  1798. public static Mono.Terminal.MainLoop MainLoop { get; private set; }
  1799. static Stack<Toplevel> toplevels = new Stack<Toplevel> ();
  1800. /// <summary>
  1801. /// This event is raised on each iteration of the
  1802. /// main loop.
  1803. /// </summary>
  1804. /// <remarks>
  1805. /// See also <see cref="Timeout"/>
  1806. /// </remarks>
  1807. public static event EventHandler Iteration;
  1808. /// <summary>
  1809. /// Returns a rectangle that is centered in the screen for the provided size.
  1810. /// </summary>
  1811. /// <returns>The centered rect.</returns>
  1812. /// <param name="size">Size for the rectangle.</param>
  1813. public static Rect MakeCenteredRect (Size size)
  1814. {
  1815. return new Rect (new Point ((Driver.Cols - size.Width) / 2, (Driver.Rows - size.Height) / 2), size);
  1816. }
  1817. //
  1818. // provides the sync context set while executing code in gui.cs, to let
  1819. // users use async/await on their code
  1820. //
  1821. class MainLoopSyncContext : SynchronizationContext {
  1822. Mono.Terminal.MainLoop mainLoop;
  1823. public MainLoopSyncContext (Mono.Terminal.MainLoop mainLoop)
  1824. {
  1825. this.mainLoop = mainLoop;
  1826. }
  1827. public override SynchronizationContext CreateCopy ()
  1828. {
  1829. return new MainLoopSyncContext (MainLoop);
  1830. }
  1831. public override void Post (SendOrPostCallback d, object state)
  1832. {
  1833. mainLoop.AddIdle (() => {
  1834. d (state);
  1835. return false;
  1836. });
  1837. mainLoop.Driver.Wakeup ();
  1838. }
  1839. public override void Send (SendOrPostCallback d, object state)
  1840. {
  1841. mainLoop.Invoke (() => {
  1842. d (state);
  1843. });
  1844. }
  1845. }
  1846. /// <summary>
  1847. /// If set, it forces the use of the System.Console-based driver.
  1848. /// </summary>
  1849. public static bool UseSystemConsole;
  1850. /// <summary>
  1851. /// Initializes the Application
  1852. /// </summary>
  1853. public static void Init () => Init (() => Toplevel.Create ());
  1854. internal static bool _initialized = false;
  1855. /// <summary>
  1856. /// Initializes the Application
  1857. /// </summary>
  1858. static void Init (Func<Toplevel> topLevelFactory)
  1859. {
  1860. if (_initialized) return;
  1861. var p = Environment.OSVersion.Platform;
  1862. Mono.Terminal.IMainLoopDriver mainLoopDriver;
  1863. if (UseSystemConsole) {
  1864. mainLoopDriver = new Mono.Terminal.NetMainLoop ();
  1865. Driver = new NetDriver ();
  1866. } else if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows) {
  1867. var windowsDriver = new WindowsDriver ();
  1868. mainLoopDriver = windowsDriver;
  1869. Driver = windowsDriver;
  1870. } else {
  1871. mainLoopDriver = new Mono.Terminal.UnixMainLoop ();
  1872. Driver = new CursesDriver ();
  1873. }
  1874. Driver.Init (TerminalResized);
  1875. MainLoop = new Mono.Terminal.MainLoop (mainLoopDriver);
  1876. SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
  1877. Top = topLevelFactory ();
  1878. Current = Top;
  1879. CurrentView = Top;
  1880. _initialized = true;
  1881. }
  1882. /// <summary>
  1883. /// Captures the execution state for the provided TopLevel view.
  1884. /// </summary>
  1885. public class RunState : IDisposable {
  1886. internal RunState (Toplevel view)
  1887. {
  1888. Toplevel = view;
  1889. }
  1890. internal Toplevel Toplevel;
  1891. /// <summary>
  1892. /// Releases alTop = l resource used by the <see cref="T:Terminal.Gui.Application.RunState"/> object.
  1893. /// </summary>
  1894. /// <remarks>Call <see cref="Dispose()"/> when you are finished using the <see cref="T:Terminal.Gui.Application.RunState"/>. The
  1895. /// <see cref="Dispose()"/> method leaves the <see cref="T:Terminal.Gui.Application.RunState"/> in an unusable state. After
  1896. /// calling <see cref="Dispose()"/>, you must release all references to the
  1897. /// <see cref="T:Terminal.Gui.Application.RunState"/> so the garbage collector can reclaim the memory that the
  1898. /// <see cref="T:Terminal.Gui.Application.RunState"/> was occupying.</remarks>
  1899. public void Dispose ()
  1900. {
  1901. Dispose (true);
  1902. GC.SuppressFinalize (this);
  1903. }
  1904. /// <summary>
  1905. /// Dispose the specified disposing.
  1906. /// </summary>
  1907. /// <returns>The dispose.</returns>
  1908. /// <param name="disposing">If set to <c>true</c> disposing.</param>
  1909. protected virtual void Dispose (bool disposing)
  1910. {
  1911. if (Toplevel != null) {
  1912. End (Toplevel);
  1913. Toplevel = null;
  1914. }
  1915. }
  1916. }
  1917. static void ProcessKeyEvent (KeyEvent ke)
  1918. {
  1919. var chain = toplevels.ToList ();
  1920. foreach (var topLevel in chain) {
  1921. if (topLevel.ProcessHotKey (ke))
  1922. return;
  1923. if (topLevel.Modal)
  1924. break;
  1925. }
  1926. foreach (var topLevel in chain) {
  1927. if (topLevel.ProcessKey (ke))
  1928. return;
  1929. if (topLevel.Modal)
  1930. break;
  1931. }
  1932. foreach (var topLevel in chain) {
  1933. // Process the key normally
  1934. if (topLevel.ProcessColdKey (ke))
  1935. return;
  1936. if (topLevel.Modal)
  1937. break;
  1938. }
  1939. }
  1940. static void ProcessKeyDownEvent (KeyEvent ke)
  1941. {
  1942. var chain = toplevels.ToList ();
  1943. foreach (var topLevel in chain) {
  1944. if (topLevel.OnKeyDown (ke))
  1945. return;
  1946. if (topLevel.Modal)
  1947. break;
  1948. }
  1949. }
  1950. static void ProcessKeyUpEvent (KeyEvent ke)
  1951. {
  1952. var chain = toplevels.ToList ();
  1953. foreach (var topLevel in chain) {
  1954. if (topLevel.OnKeyUp (ke))
  1955. return;
  1956. if (topLevel.Modal)
  1957. break;
  1958. }
  1959. }
  1960. static View FindDeepestView (View start, int x, int y, out int resx, out int resy)
  1961. {
  1962. var startFrame = start.Frame;
  1963. if (!startFrame.Contains (x, y)) {
  1964. resx = 0;
  1965. resy = 0;
  1966. return null;
  1967. }
  1968. if (start.InternalSubviews != null) {
  1969. int count = start.InternalSubviews.Count;
  1970. if (count > 0) {
  1971. var rx = x - startFrame.X;
  1972. var ry = y - startFrame.Y;
  1973. for (int i = count - 1; i >= 0; i--) {
  1974. View v = start.InternalSubviews [i];
  1975. if (v.Frame.Contains (rx, ry)) {
  1976. var deep = FindDeepestView (v, rx, ry, out resx, out resy);
  1977. if (deep == null)
  1978. return v;
  1979. return deep;
  1980. }
  1981. }
  1982. }
  1983. }
  1984. resx = x - startFrame.X;
  1985. resy = y - startFrame.Y;
  1986. return start;
  1987. }
  1988. internal static View mouseGrabView;
  1989. /// <summary>
  1990. /// Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called.
  1991. /// </summary>
  1992. /// <returns>The grab.</returns>
  1993. /// <param name="view">View that will receive all mouse events until UngrabMouse is invoked.</param>
  1994. public static void GrabMouse (View view)
  1995. {
  1996. if (view == null)
  1997. return;
  1998. mouseGrabView = view;
  1999. Driver.UncookMouse ();
  2000. }
  2001. /// <summary>
  2002. /// Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.
  2003. /// </summary>
  2004. public static void UngrabMouse ()
  2005. {
  2006. mouseGrabView = null;
  2007. Driver.CookMouse ();
  2008. }
  2009. /// <summary>
  2010. /// Merely a debugging aid to see the raw mouse events
  2011. /// </summary>
  2012. public static Action<MouseEvent> RootMouseEvent;
  2013. internal static View wantContinuousButtonPressedView;
  2014. static View lastMouseOwnerView;
  2015. static void ProcessMouseEvent (MouseEvent me)
  2016. {
  2017. var view = FindDeepestView (Current, me.X, me.Y, out int rx, out int ry);
  2018. if (view != null && view.WantContinuousButtonPressed)
  2019. wantContinuousButtonPressedView = view;
  2020. else
  2021. wantContinuousButtonPressedView = null;
  2022. RootMouseEvent?.Invoke (me);
  2023. if (mouseGrabView != null) {
  2024. var newxy = mouseGrabView.ScreenToView (me.X, me.Y);
  2025. var nme = new MouseEvent () {
  2026. X = newxy.X,
  2027. Y = newxy.Y,
  2028. Flags = me.Flags,
  2029. OfX = me.X - newxy.X,
  2030. OfY = me.Y - newxy.Y,
  2031. View = view
  2032. };
  2033. if (OutsideFrame (new Point (nme.X, nme.Y), mouseGrabView.Frame))
  2034. lastMouseOwnerView.OnMouseLeave (me);
  2035. if (mouseGrabView != null) {
  2036. mouseGrabView.MouseEvent (nme);
  2037. return;
  2038. }
  2039. }
  2040. if (view != null) {
  2041. var nme = new MouseEvent () {
  2042. X = rx,
  2043. Y = ry,
  2044. Flags = me.Flags,
  2045. OfX = rx,
  2046. OfY = ry,
  2047. View = view
  2048. };
  2049. if (lastMouseOwnerView == null) {
  2050. lastMouseOwnerView = view;
  2051. view.OnMouseEnter (nme);
  2052. } else if (lastMouseOwnerView != view) {
  2053. lastMouseOwnerView.OnMouseLeave (nme);
  2054. view.OnMouseEnter (nme);
  2055. lastMouseOwnerView = view;
  2056. }
  2057. if (!view.WantMousePositionReports && me.Flags == MouseFlags.ReportMousePosition)
  2058. return;
  2059. if (view.WantContinuousButtonPressed)
  2060. wantContinuousButtonPressedView = view;
  2061. else
  2062. wantContinuousButtonPressedView = null;
  2063. // Should we bubbled up the event, if it is not handled?
  2064. view.MouseEvent (nme);
  2065. }
  2066. }
  2067. static bool OutsideFrame (Point p, Rect r)
  2068. {
  2069. return p.X < 0 || p.X > r.Width - 1 || p.Y < 0 || p.Y > r.Height - 1;
  2070. }
  2071. /// <summary>
  2072. /// This event is fired once when the application is first loaded. The dimensions of the
  2073. /// terminal are provided.
  2074. /// </summary>
  2075. public static event EventHandler<ResizedEventArgs> Loaded;
  2076. /// <summary>
  2077. /// Building block API: Prepares the provided toplevel for execution.
  2078. /// </summary>
  2079. /// <returns>The runstate handle that needs to be passed to the End() method upon completion.</returns>
  2080. /// <param name="toplevel">Toplevel to prepare execution for.</param>
  2081. /// <remarks>
  2082. /// This method prepares the provided toplevel for running with the focus,
  2083. /// it adds this to the list of toplevels, sets up the mainloop to process the
  2084. /// event, lays out the subviews, focuses the first element, and draws the
  2085. /// toplevel in the screen. This is usually followed by executing
  2086. /// the <see cref="RunLoop"/> method, and then the <see cref="End(RunState)"/> method upon termination which will
  2087. /// undo these changes.
  2088. /// </remarks>
  2089. public static RunState Begin (Toplevel toplevel)
  2090. {
  2091. if (toplevel == null)
  2092. throw new ArgumentNullException (nameof (toplevel));
  2093. var rs = new RunState (toplevel);
  2094. Init ();
  2095. if (toplevel is ISupportInitializeNotification initializableNotification &&
  2096. !initializableNotification.IsInitialized) {
  2097. initializableNotification.BeginInit ();
  2098. initializableNotification.EndInit ();
  2099. } else if (toplevel is ISupportInitialize initializable) {
  2100. initializable.BeginInit ();
  2101. initializable.EndInit ();
  2102. }
  2103. toplevels.Push (toplevel);
  2104. Current = toplevel;
  2105. Driver.PrepareToRun (MainLoop, ProcessKeyEvent, ProcessKeyDownEvent, ProcessKeyUpEvent, ProcessMouseEvent);
  2106. if (toplevel.LayoutStyle == LayoutStyle.Computed)
  2107. toplevel.RelativeLayout (new Rect (0, 0, Driver.Cols, Driver.Rows));
  2108. toplevel.LayoutSubviews ();
  2109. Loaded?.Invoke (null, new ResizedEventArgs () { Rows = Driver.Rows, Cols = Driver.Cols } );
  2110. toplevel.WillPresent ();
  2111. Redraw (toplevel);
  2112. toplevel.PositionCursor ();
  2113. Driver.Refresh ();
  2114. return rs;
  2115. }
  2116. /// <summary>
  2117. /// Building block API: completes the execution of a Toplevel that was started with Begin.
  2118. /// </summary>
  2119. /// <param name="runState">The runstate returned by the <see cref="Begin(Toplevel)"/> method.</param>
  2120. public static void End (RunState runState)
  2121. {
  2122. if (runState == null)
  2123. throw new ArgumentNullException (nameof (runState));
  2124. runState.Dispose ();
  2125. }
  2126. /// <summary>
  2127. /// Finalize the driver.
  2128. /// </summary>
  2129. public static void Shutdown ()
  2130. {
  2131. Driver.End ();
  2132. _initialized = false;
  2133. }
  2134. static void Redraw (View view)
  2135. {
  2136. Application.CurrentView = view;
  2137. view.Redraw (view.Bounds);
  2138. Driver.Refresh ();
  2139. }
  2140. static void Refresh (View view)
  2141. {
  2142. view.Redraw (view.Bounds);
  2143. Driver.Refresh ();
  2144. }
  2145. /// <summary>
  2146. /// Triggers a refresh of the entire display.
  2147. /// </summary>
  2148. public static void Refresh ()
  2149. {
  2150. Driver.UpdateScreen ();
  2151. View last = null;
  2152. foreach (var v in toplevels.Reverse ()) {
  2153. v.SetNeedsDisplay ();
  2154. v.Redraw (v.Bounds);
  2155. last = v;
  2156. }
  2157. last?.PositionCursor ();
  2158. Driver.Refresh ();
  2159. }
  2160. internal static void End (View view)
  2161. {
  2162. if (toplevels.Peek () != view)
  2163. throw new ArgumentException ("The view that you end with must be balanced");
  2164. toplevels.Pop ();
  2165. if (toplevels.Count == 0)
  2166. Shutdown ();
  2167. else {
  2168. Current = toplevels.Peek ();
  2169. Refresh ();
  2170. }
  2171. }
  2172. /// <summary>
  2173. /// Building block API: Runs the main loop for the created dialog
  2174. /// </summary>
  2175. /// <remarks>
  2176. /// Use the wait parameter to control whether this is a
  2177. /// blocking or non-blocking call.
  2178. /// </remarks>
  2179. /// <param name="state">The state returned by the Begin method.</param>
  2180. /// <param name="wait">By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.</param>
  2181. public static void RunLoop (RunState state, bool wait = true)
  2182. {
  2183. if (state == null)
  2184. throw new ArgumentNullException (nameof (state));
  2185. if (state.Toplevel == null)
  2186. throw new ObjectDisposedException ("state");
  2187. bool firstIteration = true;
  2188. for (state.Toplevel.Running = true; state.Toplevel.Running;) {
  2189. if (MainLoop.EventsPending (wait)) {
  2190. // Notify Toplevel it's ready
  2191. if (firstIteration) {
  2192. state.Toplevel.OnReady ();
  2193. }
  2194. firstIteration = false;
  2195. MainLoop.MainIteration ();
  2196. Iteration?.Invoke (null, EventArgs.Empty);
  2197. } else if (wait == false)
  2198. return;
  2199. if (!state.Toplevel.NeedDisplay.IsEmpty || state.Toplevel.childNeedsDisplay) {
  2200. state.Toplevel.Redraw (state.Toplevel.Bounds);
  2201. if (DebugDrawBounds)
  2202. DrawBounds (state.Toplevel);
  2203. state.Toplevel.PositionCursor ();
  2204. Driver.Refresh ();
  2205. } else
  2206. Driver.UpdateCursor ();
  2207. }
  2208. }
  2209. internal static bool DebugDrawBounds = false;
  2210. // Need to look into why this does not work properly.
  2211. static void DrawBounds (View v)
  2212. {
  2213. v.DrawFrame (v.Frame, padding: 0, fill: false);
  2214. if (v.InternalSubviews != null && v.InternalSubviews.Count > 0)
  2215. foreach (var sub in v.InternalSubviews)
  2216. DrawBounds (sub);
  2217. }
  2218. /// <summary>
  2219. /// Runs the application with the built-in toplevel view
  2220. /// </summary>
  2221. public static void Run ()
  2222. {
  2223. Run (Top);
  2224. }
  2225. /// <summary>
  2226. /// Runs the application with a new instance of the specified toplevel view
  2227. /// </summary>
  2228. public static void Run<T> () where T : Toplevel, new()
  2229. {
  2230. Init (() => new T ());
  2231. Run (Top);
  2232. }
  2233. /// <summary>
  2234. /// Runs the main loop on the given container.
  2235. /// </summary>
  2236. /// <remarks>
  2237. /// <para>
  2238. /// This method is used to start processing events
  2239. /// for the main application, but it is also used to
  2240. /// run modal dialog boxes.
  2241. /// </para>
  2242. /// <para>
  2243. /// To make a toplevel stop execution, set the "Running"
  2244. /// property to false.
  2245. /// </para>
  2246. /// <para>
  2247. /// This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the
  2248. /// returned value, and then calling end on the return value.
  2249. /// </para>
  2250. /// <para>
  2251. /// Alternatively, if your program needs to control the main loop and needs to
  2252. /// process events manually, you can invoke Begin to set things up manually and then
  2253. /// repeatedly call RunLoop with the wait parameter set to false. By doing this
  2254. /// the RunLoop method will only process any pending events, timers, idle handlers and
  2255. /// then return control immediately.
  2256. /// </para>
  2257. /// </remarks>
  2258. public static void Run (Toplevel view)
  2259. {
  2260. var runToken = Begin (view);
  2261. RunLoop (runToken);
  2262. End (runToken);
  2263. }
  2264. /// <summary>
  2265. /// Stops running the most recent toplevel
  2266. /// </summary>
  2267. public static void RequestStop ()
  2268. {
  2269. Current.Running = false;
  2270. }
  2271. /// <summary>
  2272. /// Event arguments for the <see cref="T:Terminal.Gui.Application.Resized"/> event.
  2273. /// </summary>
  2274. public class ResizedEventArgs : EventArgs {
  2275. /// <summary>
  2276. /// The number of rows in the resized terminal.
  2277. /// </summary>
  2278. public int Rows { get; set; }
  2279. /// <summary>
  2280. /// The number of columns in the resized terminal.
  2281. /// </summary>
  2282. public int Cols { get; set; }
  2283. }
  2284. /// <summary>
  2285. /// Invoked when the terminal was resized. The new size of the terminal is provided.
  2286. /// </summary>
  2287. public static event EventHandler<ResizedEventArgs> Resized;
  2288. static void TerminalResized ()
  2289. {
  2290. var full = new Rect (0, 0, Driver.Cols, Driver.Rows);
  2291. Resized?.Invoke (null, new ResizedEventArgs () { Cols = full.Width, Rows = full.Height });
  2292. Driver.Clip = full;
  2293. foreach (var t in toplevels) {
  2294. t.PositionToplevels ();
  2295. t.RelativeLayout (full);
  2296. t.LayoutSubviews ();
  2297. }
  2298. Refresh ();
  2299. }
  2300. }
  2301. }