View.cs 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311
  1. //
  2. // Authors:
  3. // Miguel de Icaza ([email protected])
  4. //
  5. // Pending:
  6. // - Check for NeedDisplay on the hierarchy and repaint
  7. // - Layout support
  8. // - "Colors" type or "Attributes" type?
  9. // - What to surface as "BackgroundCOlor" when clearing a window, an attribute or colors?
  10. //
  11. // Optimizations
  12. // - Add rendering limitation to the exposed area
  13. using System;
  14. using System.Collections;
  15. using System.Collections.Generic;
  16. using System.ComponentModel;
  17. using System.Diagnostics;
  18. using System.Linq;
  19. using NStack;
  20. namespace Terminal.Gui {
  21. /// <summary>
  22. /// Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the
  23. /// value from the Frame will be used, if the value is Computed, then the Frame
  24. /// will be updated from the X, Y Pos objects and the Width and Height Dim objects.
  25. /// </summary>
  26. public enum LayoutStyle {
  27. /// <summary>
  28. /// The position and size of the view are based on the Frame value.
  29. /// </summary>
  30. Absolute,
  31. /// <summary>
  32. /// The position and size of the view will be computed based on the
  33. /// X, Y, Width and Height properties and set on the Frame.
  34. /// </summary>
  35. Computed
  36. }
  37. /// <summary>
  38. /// 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.
  39. /// </summary>
  40. /// <remarks>
  41. /// <para>
  42. /// The View defines the base functionality for user interface elements in Terminal.Gui. Views
  43. /// can contain one or more subviews, can respond to user input and render themselves on the screen.
  44. /// </para>
  45. /// <para>
  46. /// Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View
  47. /// is determined when the View is initialized. To create a View using Absolute layout, call a constructor that takes a
  48. /// Rect parameter to specify the absolute position and size (the <c>View.<see cref="Frame "/></c>)/. To create a View
  49. /// using Computed layout use a constructor that does not take a Rect parameter and set the X, Y, Width and Height
  50. /// properties on the view. Both approaches use coordinates that are relative to the container they are being added to.
  51. /// </para>
  52. /// <para>
  53. /// To switch between Absolute and Computed layout, use the <see cref="LayoutStyle"/> property.
  54. /// </para>
  55. /// <para>
  56. /// Computed layout is more flexible and supports dynamic console apps where controls adjust layout
  57. /// as the terminal resizes or other Views change size or position. The X, Y, Width and Height
  58. /// properties are Dim and Pos objects that dynamically update the position of a view.
  59. /// The X and Y properties are of type <see cref="Pos"/>
  60. /// and you can use either absolute positions, percentages or anchor
  61. /// points. The Width and Height properties are of type
  62. /// <see cref="Dim"/> and can use absolute position,
  63. /// percentages and anchors. These are useful as they will take
  64. /// care of repositioning views when view's frames are resized or
  65. /// if the terminal size changes.
  66. /// </para>
  67. /// <para>
  68. /// Absolute layout requires specifying coordinates and sizes of Views explicitly, and the
  69. /// View will typically stay in a fixed position and size. To change the position and size use the
  70. /// <see cref="Frame"/> property.
  71. /// </para>
  72. /// <para>
  73. /// Subviews (child views) can be added to a View by calling the <see cref="Add(View)"/> method.
  74. /// The container of a View can be accessed with the <see cref="SuperView"/> property.
  75. /// </para>
  76. /// <para>
  77. /// To flag a region of the View's <see cref="Bounds"/> to be redrawn call <see cref="SetNeedsDisplay(Rect)"/>. To flag the entire view
  78. /// for redraw call <see cref="SetNeedsDisplay()"/>.
  79. /// </para>
  80. /// <para>
  81. /// Views have a <see cref="ColorScheme"/> property that defines the default colors that subviews
  82. /// should use for rendering. This ensures that the views fit in the context where
  83. /// they are being used, and allows for themes to be plugged in. For example, the
  84. /// default colors for windows and toplevels uses a blue background, while it uses
  85. /// a white background for dialog boxes and a red background for errors.
  86. /// </para>
  87. /// <para>
  88. /// Subclasses should not rely on <see cref="ColorScheme"/> being
  89. /// set at construction time. If a <see cref="ColorScheme"/> is not set on a view, the view will inherit the
  90. /// value from its <see cref="SuperView"/> and the value might only be valid once a view has been
  91. /// added to a SuperView.
  92. /// </para>
  93. /// <para>
  94. /// By using <see cref="ColorScheme"/> applications will work both
  95. /// in color as well as black and white displays.
  96. /// </para>
  97. /// <para>
  98. /// Views that are focusable should implement the <see cref="PositionCursor"/> to make sure that
  99. /// the cursor is placed in a location that makes sense. Unix terminals do not have
  100. /// a way of hiding the cursor, so it can be distracting to have the cursor left at
  101. /// the last focused view. So views should make sure that they place the cursor
  102. /// in a visually sensible place.
  103. /// </para>
  104. /// <para>
  105. /// The <see cref="LayoutSubviews"/> method is invoked when the size or layout of a view has
  106. /// changed. The default processing system will keep the size and dimensions
  107. /// for views that use the <see cref="LayoutStyle.Absolute"/>, and will recompute the
  108. /// frames for the vies that use <see cref="LayoutStyle.Computed"/>.
  109. /// </para>
  110. /// </remarks>
  111. public partial class View : Responder, ISupportInitializeNotification {
  112. internal enum Direction {
  113. Forward,
  114. Backward
  115. }
  116. // container == SuperView
  117. View container = null;
  118. View focused = null;
  119. Direction focusDirection;
  120. bool autoSize;
  121. TextFormatter textFormatter;
  122. ShortcutHelper shortcutHelper;
  123. /// <summary>
  124. /// Event fired when a subview is being added to this view.
  125. /// </summary>
  126. public event Action<View> Added;
  127. /// <summary>
  128. /// Event fired when a subview is being removed from this view.
  129. /// </summary>
  130. public event Action<View> Removed;
  131. /// <summary>
  132. /// Event fired when the view gets focus.
  133. /// </summary>
  134. public event Action<FocusEventArgs> Enter;
  135. /// <summary>
  136. /// Event fired when the view looses focus.
  137. /// </summary>
  138. public event Action<FocusEventArgs> Leave;
  139. /// <summary>
  140. /// Event fired when the view receives the mouse event for the first time.
  141. /// </summary>
  142. public event Action<MouseEventArgs> MouseEnter;
  143. /// <summary>
  144. /// Event fired when the view receives a mouse event for the last time.
  145. /// </summary>
  146. public event Action<MouseEventArgs> MouseLeave;
  147. /// <summary>
  148. /// Event fired when a mouse event is generated.
  149. /// </summary>
  150. public event Action<MouseEventArgs> MouseClick;
  151. /// <summary>
  152. /// Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire.
  153. /// </summary>
  154. public Key HotKey { get => textFormatter.HotKey; set => textFormatter.HotKey = value; }
  155. /// <summary>
  156. /// Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'.
  157. /// </summary>
  158. public Rune HotKeySpecifier { get => textFormatter.HotKeySpecifier; set => textFormatter.HotKeySpecifier = value; }
  159. /// <summary>
  160. /// This is the global setting that can be used as a global shortcut to invoke an action if provided.
  161. /// </summary>
  162. public Key Shortcut {
  163. get => shortcutHelper.Shortcut;
  164. set {
  165. if (shortcutHelper.Shortcut != value && (ShortcutHelper.PostShortcutValidation (value) || value == Key.Null)) {
  166. shortcutHelper.Shortcut = value;
  167. }
  168. }
  169. }
  170. /// <summary>
  171. /// The keystroke combination used in the <see cref="Shortcut"/> as string.
  172. /// </summary>
  173. public ustring ShortcutTag => ShortcutHelper.GetShortcutTag (shortcutHelper.Shortcut);
  174. /// <summary>
  175. /// The action to run if the <see cref="Shortcut"/> is defined.
  176. /// </summary>
  177. public virtual Action ShortcutAction { get; set; }
  178. /// <summary>
  179. /// Gets or sets arbitrary data for the view.
  180. /// </summary>
  181. /// <remarks>This property is not used internally.</remarks>
  182. public object Data { get; set; }
  183. internal Direction FocusDirection {
  184. get => SuperView?.FocusDirection ?? focusDirection;
  185. set {
  186. if (SuperView != null)
  187. SuperView.FocusDirection = value;
  188. else
  189. focusDirection = value;
  190. }
  191. }
  192. /// <summary>
  193. /// Points to the current driver in use by the view, it is a convenience property
  194. /// for simplifying the development of new views.
  195. /// </summary>
  196. public static ConsoleDriver Driver { get { return Application.Driver; } }
  197. static IList<View> empty = new List<View> (0).AsReadOnly ();
  198. // This is null, and allocated on demand.
  199. List<View> subviews;
  200. /// <summary>
  201. /// This returns a list of the subviews contained by this view.
  202. /// </summary>
  203. /// <value>The subviews.</value>
  204. public IList<View> Subviews => subviews == null ? empty : subviews.AsReadOnly ();
  205. // Internally, we use InternalSubviews rather than subviews, as we do not expect us
  206. // to make the same mistakes our users make when they poke at the Subviews.
  207. internal IList<View> InternalSubviews => subviews ?? empty;
  208. // This is null, and allocated on demand.
  209. List<View> tabIndexes;
  210. /// <summary>
  211. /// This returns a tab index list of the subviews contained by this view.
  212. /// </summary>
  213. /// <value>The tabIndexes.</value>
  214. public IList<View> TabIndexes => tabIndexes == null ? empty : tabIndexes.AsReadOnly ();
  215. int tabIndex = -1;
  216. /// <summary>
  217. /// Indicates the index of the current <see cref="View"/> from the <see cref="TabIndexes"/> list.
  218. /// </summary>
  219. public int TabIndex {
  220. get { return tabIndex; }
  221. set {
  222. if (!CanFocus) {
  223. tabIndex = -1;
  224. return;
  225. } else if (SuperView?.tabIndexes == null || SuperView?.tabIndexes.Count == 1) {
  226. tabIndex = 0;
  227. return;
  228. } else if (tabIndex == value) {
  229. return;
  230. }
  231. tabIndex = value > SuperView.tabIndexes.Count - 1 ? SuperView.tabIndexes.Count - 1 : value < 0 ? 0 : value;
  232. tabIndex = GetTabIndex (tabIndex);
  233. if (SuperView.tabIndexes.IndexOf (this) != tabIndex) {
  234. SuperView.tabIndexes.Remove (this);
  235. SuperView.tabIndexes.Insert (tabIndex, this);
  236. SetTabIndex ();
  237. }
  238. }
  239. }
  240. private int GetTabIndex (int idx)
  241. {
  242. int i = 0;
  243. foreach (var v in SuperView.tabIndexes) {
  244. if (v.tabIndex == -1 || v == this) {
  245. continue;
  246. }
  247. i++;
  248. }
  249. return Math.Min (i, idx);
  250. }
  251. private void SetTabIndex ()
  252. {
  253. int i = 0;
  254. foreach (var v in SuperView.tabIndexes) {
  255. if (v.tabIndex == -1) {
  256. continue;
  257. }
  258. v.tabIndex = i;
  259. i++;
  260. }
  261. }
  262. bool tabStop = true;
  263. /// <summary>
  264. /// This only be <c>true</c> if the <see cref="CanFocus"/> is also <c>true</c> and the focus can be avoided by setting this to <c>false</c>
  265. /// </summary>
  266. public bool TabStop {
  267. get { return tabStop; }
  268. set {
  269. if (tabStop == value) {
  270. return;
  271. }
  272. tabStop = CanFocus && value;
  273. }
  274. }
  275. bool oldCanFocus;
  276. int oldTabIndex;
  277. /// <inheritdoc/>
  278. public override bool CanFocus {
  279. get => base.CanFocus;
  280. set {
  281. if (!addingView && IsInitialized && SuperView?.CanFocus == false && value) {
  282. throw new InvalidOperationException ("Cannot set CanFocus to true if the SuperView CanFocus is false!");
  283. }
  284. if (base.CanFocus != value) {
  285. base.CanFocus = value;
  286. if (!value && tabIndex > -1) {
  287. TabIndex = -1;
  288. }
  289. if (value && SuperView?.CanFocus == false && addingView) {
  290. SuperView.CanFocus = value;
  291. }
  292. if (value && tabIndex == -1) {
  293. TabIndex = SuperView != null ? SuperView.tabIndexes.IndexOf (this) : -1;
  294. }
  295. TabStop = value;
  296. }
  297. if (subviews != null && IsInitialized) {
  298. foreach (var view in subviews) {
  299. if (view.CanFocus != value) {
  300. if (!value) {
  301. view.oldCanFocus = view.CanFocus;
  302. view.oldTabIndex = view.tabIndex;
  303. view.CanFocus = value;
  304. view.tabIndex = -1;
  305. } else {
  306. if (addingView) {
  307. view.addingView = true;
  308. }
  309. view.CanFocus = view.oldCanFocus;
  310. view.tabIndex = view.oldTabIndex;
  311. view.addingView = false;
  312. }
  313. }
  314. }
  315. }
  316. }
  317. }
  318. internal Rect NeedDisplay { get; private set; } = Rect.Empty;
  319. // The frame for the object. Superview relative.
  320. Rect frame;
  321. /// <summary>
  322. /// Gets or sets an identifier for the view;
  323. /// </summary>
  324. /// <value>The identifier.</value>
  325. /// <remarks>The id should be unique across all Views that share a SuperView.</remarks>
  326. public ustring Id { get; set; } = "";
  327. /// <summary>
  328. /// Returns a value indicating if this View is currently on Top (Active)
  329. /// </summary>
  330. public bool IsCurrentTop {
  331. get {
  332. return Application.Current == this;
  333. }
  334. }
  335. /// <summary>
  336. /// Gets or sets a value indicating whether this <see cref="View"/> wants mouse position reports.
  337. /// </summary>
  338. /// <value><c>true</c> if want mouse position reports; otherwise, <c>false</c>.</value>
  339. public virtual bool WantMousePositionReports { get; set; } = false;
  340. /// <summary>
  341. /// Gets or sets a value indicating whether this <see cref="View"/> want continuous button pressed event.
  342. /// </summary>
  343. public virtual bool WantContinuousButtonPressed { get; set; } = false;
  344. /// <summary>
  345. /// Gets or sets the frame for the view. The frame is relative to the view's container (<see cref="SuperView"/>).
  346. /// </summary>
  347. /// <value>The frame.</value>
  348. /// <remarks>
  349. /// <para>
  350. /// Change the Frame when using the <see cref="LayoutStyle.Absolute"/> layout style to move or resize views.
  351. /// </para>
  352. /// <para>
  353. /// Altering the Frame of a view will trigger the redrawing of the
  354. /// view as well as the redrawing of the affected regions of the <see cref="SuperView"/>.
  355. /// </para>
  356. /// </remarks>
  357. public virtual Rect Frame {
  358. get => frame;
  359. set {
  360. if (SuperView != null) {
  361. SuperView.SetNeedsDisplay (frame);
  362. SuperView.SetNeedsDisplay (value);
  363. }
  364. frame = value;
  365. SetNeedsLayout ();
  366. SetNeedsDisplay (frame);
  367. }
  368. }
  369. ///// <summary>
  370. ///// Gets an enumerator that enumerates the subviews in this view.
  371. ///// </summary>
  372. ///// <returns>The enumerator.</returns>
  373. //public IEnumerator GetEnumerator ()
  374. //{
  375. // foreach (var v in InternalSubviews)
  376. // yield return v;
  377. //}
  378. LayoutStyle layoutStyle;
  379. /// <summary>
  380. /// Controls how the View's <see cref="Frame"/> is computed during the LayoutSubviews method, if the style is set to <see cref="LayoutStyle.Absolute"/>,
  381. /// LayoutSubviews does not change the <see cref="Frame"/>. If the style is <see cref="LayoutStyle.Computed"/> the <see cref="Frame"/> is updated using
  382. /// the <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/> properties.
  383. /// </summary>
  384. /// <value>The layout style.</value>
  385. public LayoutStyle LayoutStyle {
  386. get => layoutStyle;
  387. set {
  388. layoutStyle = value;
  389. SetNeedsLayout ();
  390. }
  391. }
  392. /// <summary>
  393. /// The bounds represent the View-relative rectangle used for this view; the area inside of the view.
  394. /// </summary>
  395. /// <value>The bounds.</value>
  396. /// <remarks>
  397. /// <para>
  398. /// Updates to the Bounds update the <see cref="Frame"/>,
  399. /// and has the same side effects as updating the <see cref="Frame"/>.
  400. /// </para>
  401. /// <para>
  402. /// Because <see cref="Bounds"/> coordinates are relative to the upper-left corner of the <see cref="View"/>,
  403. /// the coordinates of the upper-left corner of the rectangle returned by this property are (0,0).
  404. /// Use this property to obtain the size and coordinates of the client area of the
  405. /// control for tasks such as drawing on the surface of the control.
  406. /// </para>
  407. /// </remarks>
  408. public Rect Bounds {
  409. get => new Rect (Point.Empty, Frame.Size);
  410. set {
  411. Frame = new Rect (frame.Location, value.Size);
  412. }
  413. }
  414. Pos x, y;
  415. /// <summary>
  416. /// Gets or sets the X position for the view (the column). Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  417. /// </summary>
  418. /// <value>The X Position.</value>
  419. /// <remarks>
  420. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  421. /// </remarks>
  422. public Pos X {
  423. get => x;
  424. set {
  425. if (!ValidatePosDim (x, value)) {
  426. throw new ArgumentException ();
  427. }
  428. x = value;
  429. SetNeedsLayout ();
  430. SetNeedsDisplay (frame);
  431. }
  432. }
  433. /// <summary>
  434. /// Gets or sets the Y position for the view (the row). Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  435. /// </summary>
  436. /// <value>The y position (line).</value>
  437. /// <remarks>
  438. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  439. /// </remarks>
  440. public Pos Y {
  441. get => y;
  442. set {
  443. if (!ValidatePosDim (y, value)) {
  444. throw new ArgumentException ();
  445. }
  446. y = value;
  447. SetNeedsLayout ();
  448. SetNeedsDisplay (frame);
  449. }
  450. }
  451. Dim width, height;
  452. /// <summary>
  453. /// Gets or sets the width of the view. Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  454. /// </summary>
  455. /// <value>The width.</value>
  456. /// <remarks>
  457. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  458. /// </remarks>
  459. public Dim Width {
  460. get => width;
  461. set {
  462. if (!ValidatePosDim (width, value)) {
  463. throw new ArgumentException ();
  464. }
  465. width = value;
  466. SetNeedsLayout ();
  467. SetNeedsDisplay (frame);
  468. }
  469. }
  470. /// <summary>
  471. /// Gets or sets the height of the view. Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  472. /// </summary>
  473. /// <value>The height.</value>
  474. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  475. public Dim Height {
  476. get => height;
  477. set {
  478. if (!ValidatePosDim (height, value)) {
  479. throw new ArgumentException ();
  480. }
  481. height = value;
  482. SetNeedsLayout ();
  483. SetNeedsDisplay (frame);
  484. }
  485. }
  486. bool ValidatePosDim (object oldvalue, object newValue)
  487. {
  488. if (!IsInitialized || layoutStyle == LayoutStyle.Absolute || oldvalue == null || oldvalue.GetType () == newValue.GetType () || this is Toplevel) {
  489. return true;
  490. }
  491. if (layoutStyle == LayoutStyle.Computed) {
  492. if (oldvalue.GetType () != newValue.GetType () && !(newValue is Pos.PosAbsolute || newValue is Dim.DimAbsolute)) {
  493. return true;
  494. }
  495. }
  496. return false;
  497. }
  498. /// <summary>
  499. /// Returns the container for this view, or null if this view has not been added to a container.
  500. /// </summary>
  501. /// <value>The super view.</value>
  502. public View SuperView => container;
  503. /// <summary>
  504. /// Initializes a new instance of a <see cref="LayoutStyle.Absolute"/> <see cref="View"/> class with the absolute
  505. /// dimensions specified in the <c>frame</c> parameter.
  506. /// </summary>
  507. /// <param name="frame">The region covered by this view.</param>
  508. /// <remarks>
  509. /// This constructor initialize a View with a <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Absolute"/>. Use <see cref="View()"/> to
  510. /// initialize a View with <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Computed"/>
  511. /// </remarks>
  512. public View (Rect frame)
  513. {
  514. Initialize (ustring.Empty, frame, LayoutStyle.Absolute);
  515. }
  516. /// <summary>
  517. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Computed"/> layout.
  518. /// </summary>
  519. /// <remarks>
  520. /// <para>
  521. /// Use <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/> properties to dynamically control the size and location of the view.
  522. /// The <see cref="Label"/> will be created using <see cref="LayoutStyle.Computed"/>
  523. /// coordinates. The initial size (<see cref="View.Frame"/> will be
  524. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  525. /// </para>
  526. /// <para>
  527. /// If <c>Height</c> is greater than one, word wrapping is provided.
  528. /// </para>
  529. /// <para>
  530. /// This constructor initialize a View with a <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Computed"/>.
  531. /// Use <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/> properties to dynamically control the size and location of the view.
  532. /// </para>
  533. /// </remarks>
  534. public View () : this (text: string.Empty) { }
  535. /// <summary>
  536. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Absolute"/> layout.
  537. /// </summary>
  538. /// <remarks>
  539. /// <para>
  540. /// The <see cref="View"/> will be created at the given
  541. /// coordinates with the given string. The size (<see cref="View.Frame"/> will be
  542. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  543. /// </para>
  544. /// <para>
  545. /// No line wrapping is provided.
  546. /// </para>
  547. /// </remarks>
  548. /// <param name="x">column to locate the Label.</param>
  549. /// <param name="y">row to locate the Label.</param>
  550. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  551. public View (int x, int y, ustring text) : this (TextFormatter.CalcRect (x, y, text), text) { }
  552. /// <summary>
  553. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Absolute"/> layout.
  554. /// </summary>
  555. /// <remarks>
  556. /// <para>
  557. /// The <see cref="View"/> will be created at the given
  558. /// coordinates with the given string. The initial size (<see cref="View.Frame"/> will be
  559. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  560. /// </para>
  561. /// <para>
  562. /// If <c>rect.Height</c> is greater than one, word wrapping is provided.
  563. /// </para>
  564. /// </remarks>
  565. /// <param name="rect">Location.</param>
  566. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  567. public View (Rect rect, ustring text)
  568. {
  569. Initialize (text, rect, LayoutStyle.Absolute);
  570. }
  571. /// <summary>
  572. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Computed"/> layout.
  573. /// </summary>
  574. /// <remarks>
  575. /// <para>
  576. /// The <see cref="View"/> will be created using <see cref="LayoutStyle.Computed"/>
  577. /// coordinates with the given string. The initial size (<see cref="View.Frame"/> will be
  578. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  579. /// </para>
  580. /// <para>
  581. /// If <c>Height</c> is greater than one, word wrapping is provided.
  582. /// </para>
  583. /// </remarks>
  584. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  585. public View (ustring text)
  586. {
  587. Initialize (text, Rect.Empty);
  588. }
  589. void Initialize (ustring text, Rect rect, LayoutStyle layoutStyle = LayoutStyle.Computed)
  590. {
  591. textFormatter = new TextFormatter ();
  592. Text = text;
  593. shortcutHelper = new ShortcutHelper ();
  594. CanFocus = false;
  595. TabIndex = -1;
  596. TabStop = false;
  597. LayoutStyle = layoutStyle;
  598. // BUGBUG: CalcRect doesn't account for line wrapping
  599. Rect r;
  600. if (rect.IsEmpty) {
  601. r = TextFormatter.CalcRect (0, 0, text);
  602. } else {
  603. r = rect;
  604. }
  605. x = Pos.At (r.X);
  606. y = Pos.At (r.Y);
  607. Width = r.Width;
  608. Height = r.Height;
  609. Frame = r;
  610. }
  611. /// <summary>
  612. /// Sets a flag indicating this view needs to be redisplayed because its state has changed.
  613. /// </summary>
  614. public void SetNeedsDisplay ()
  615. {
  616. SetNeedsDisplay (Bounds);
  617. }
  618. internal bool LayoutNeeded { get; private set; } = true;
  619. internal void SetNeedsLayout ()
  620. {
  621. if (LayoutNeeded)
  622. return;
  623. LayoutNeeded = true;
  624. if (SuperView == null)
  625. return;
  626. SuperView.SetNeedsLayout ();
  627. textFormatter.NeedsFormat = true;
  628. }
  629. /// <summary>
  630. /// Removes the <see cref="SetNeedsLayout"/> setting on this view.
  631. /// </summary>
  632. protected void ClearLayoutNeeded ()
  633. {
  634. LayoutNeeded = false;
  635. }
  636. /// <summary>
  637. /// Flags the view-relative region on this View as needing to be repainted.
  638. /// </summary>
  639. /// <param name="region">The view-relative region that must be flagged for repaint.</param>
  640. public void SetNeedsDisplay (Rect region)
  641. {
  642. if (NeedDisplay.IsEmpty)
  643. NeedDisplay = region;
  644. else {
  645. var x = Math.Min (NeedDisplay.X, region.X);
  646. var y = Math.Min (NeedDisplay.Y, region.Y);
  647. var w = Math.Max (NeedDisplay.Width, region.Width);
  648. var h = Math.Max (NeedDisplay.Height, region.Height);
  649. NeedDisplay = new Rect (x, y, w, h);
  650. }
  651. if (container != null)
  652. container.SetChildNeedsDisplay ();
  653. if (subviews == null)
  654. return;
  655. foreach (var view in subviews)
  656. if (view.Frame.IntersectsWith (region)) {
  657. var childRegion = Rect.Intersect (view.Frame, region);
  658. childRegion.X -= view.Frame.X;
  659. childRegion.Y -= view.Frame.Y;
  660. view.SetNeedsDisplay (childRegion);
  661. }
  662. }
  663. internal bool ChildNeedsDisplay { get; private set; }
  664. /// <summary>
  665. /// Indicates that any child views (in the <see cref="Subviews"/> list) need to be repainted.
  666. /// </summary>
  667. public void SetChildNeedsDisplay ()
  668. {
  669. ChildNeedsDisplay = true;
  670. if (container != null)
  671. container.SetChildNeedsDisplay ();
  672. }
  673. internal bool addingView = false;
  674. /// <summary>
  675. /// Adds a subview (child) to this view.
  676. /// </summary>
  677. /// <remarks>
  678. /// The Views that have been added to this view can be retrieved via the <see cref="Subviews"/> property. See also <seealso cref="Remove(View)"/> <seealso cref="RemoveAll"/>
  679. /// </remarks>
  680. public virtual void Add (View view)
  681. {
  682. if (view == null)
  683. return;
  684. if (subviews == null) {
  685. subviews = new List<View> ();
  686. }
  687. if (tabIndexes == null) {
  688. tabIndexes = new List<View> ();
  689. }
  690. subviews.Add (view);
  691. tabIndexes.Add (view);
  692. view.container = this;
  693. if (view.CanFocus) {
  694. addingView = true;
  695. if (SuperView?.CanFocus == false) {
  696. SuperView.addingView = true;
  697. SuperView.CanFocus = true;
  698. SuperView.addingView = false;
  699. }
  700. CanFocus = true;
  701. view.tabIndex = tabIndexes.IndexOf (view);
  702. addingView = false;
  703. }
  704. SetNeedsLayout ();
  705. SetNeedsDisplay ();
  706. OnAdded (view);
  707. if (IsInitialized) {
  708. view.BeginInit ();
  709. view.EndInit ();
  710. }
  711. }
  712. /// <summary>
  713. /// Adds the specified views (children) to the view.
  714. /// </summary>
  715. /// <param name="views">Array of one or more views (can be optional parameter).</param>
  716. /// <remarks>
  717. /// The Views that have been added to this view can be retrieved via the <see cref="Subviews"/> property. See also <seealso cref="Remove(View)"/> <seealso cref="RemoveAll"/>
  718. /// </remarks>
  719. public void Add (params View [] views)
  720. {
  721. if (views == null)
  722. return;
  723. foreach (var view in views)
  724. Add (view);
  725. }
  726. /// <summary>
  727. /// Removes all subviews (children) added via <see cref="Add(View)"/> or <see cref="Add(View[])"/> from this View.
  728. /// </summary>
  729. public virtual void RemoveAll ()
  730. {
  731. if (subviews == null)
  732. return;
  733. while (subviews.Count > 0) {
  734. Remove (subviews [0]);
  735. }
  736. }
  737. /// <summary>
  738. /// Removes a subview added via <see cref="Add(View)"/> or <see cref="Add(View[])"/> from this View.
  739. /// </summary>
  740. /// <remarks>
  741. /// </remarks>
  742. public virtual void Remove (View view)
  743. {
  744. if (view == null || subviews == null)
  745. return;
  746. SetNeedsLayout ();
  747. SetNeedsDisplay ();
  748. var touched = view.Frame;
  749. subviews.Remove (view);
  750. tabIndexes.Remove (view);
  751. view.container = null;
  752. view.tabIndex = -1;
  753. if (subviews.Count < 1) {
  754. CanFocus = false;
  755. }
  756. foreach (var v in subviews) {
  757. if (v.Frame.IntersectsWith (touched))
  758. view.SetNeedsDisplay ();
  759. }
  760. OnRemoved (view);
  761. if (focused == view) {
  762. focused = null;
  763. }
  764. }
  765. void PerformActionForSubview (View subview, Action<View> action)
  766. {
  767. if (subviews.Contains (subview)) {
  768. action (subview);
  769. }
  770. SetNeedsDisplay ();
  771. subview.SetNeedsDisplay ();
  772. }
  773. /// <summary>
  774. /// Brings the specified subview to the front so it is drawn on top of any other views.
  775. /// </summary>
  776. /// <param name="subview">The subview to send to the front</param>
  777. /// <remarks>
  778. /// <seealso cref="SendSubviewToBack"/>.
  779. /// </remarks>
  780. public void BringSubviewToFront (View subview)
  781. {
  782. PerformActionForSubview (subview, x => {
  783. subviews.Remove (x);
  784. subviews.Add (x);
  785. });
  786. }
  787. /// <summary>
  788. /// Sends the specified subview to the front so it is the first view drawn
  789. /// </summary>
  790. /// <param name="subview">The subview to send to the front</param>
  791. /// <remarks>
  792. /// <seealso cref="BringSubviewToFront(View)"/>.
  793. /// </remarks>
  794. public void SendSubviewToBack (View subview)
  795. {
  796. PerformActionForSubview (subview, x => {
  797. subviews.Remove (x);
  798. subviews.Insert (0, subview);
  799. });
  800. }
  801. /// <summary>
  802. /// Moves the subview backwards in the hierarchy, only one step
  803. /// </summary>
  804. /// <param name="subview">The subview to send backwards</param>
  805. /// <remarks>
  806. /// If you want to send the view all the way to the back use SendSubviewToBack.
  807. /// </remarks>
  808. public void SendSubviewBackwards (View subview)
  809. {
  810. PerformActionForSubview (subview, x => {
  811. var idx = subviews.IndexOf (x);
  812. if (idx > 0) {
  813. subviews.Remove (x);
  814. subviews.Insert (idx - 1, x);
  815. }
  816. });
  817. }
  818. /// <summary>
  819. /// Moves the subview backwards in the hierarchy, only one step
  820. /// </summary>
  821. /// <param name="subview">The subview to send backwards</param>
  822. /// <remarks>
  823. /// If you want to send the view all the way to the back use SendSubviewToBack.
  824. /// </remarks>
  825. public void BringSubviewForward (View subview)
  826. {
  827. PerformActionForSubview (subview, x => {
  828. var idx = subviews.IndexOf (x);
  829. if (idx + 1 < subviews.Count) {
  830. subviews.Remove (x);
  831. subviews.Insert (idx + 1, x);
  832. }
  833. });
  834. }
  835. /// <summary>
  836. /// Clears the view region with the current color.
  837. /// </summary>
  838. /// <remarks>
  839. /// <para>
  840. /// This clears the entire region used by this view.
  841. /// </para>
  842. /// </remarks>
  843. public void Clear ()
  844. {
  845. var h = Frame.Height;
  846. var w = Frame.Width;
  847. for (int line = 0; line < h; line++) {
  848. Move (0, line);
  849. for (int col = 0; col < w; col++)
  850. Driver.AddRune (' ');
  851. }
  852. }
  853. /// <summary>
  854. /// Clears the specified region with the current color.
  855. /// </summary>
  856. /// <remarks>
  857. /// </remarks>
  858. /// <param name="regionScreen">The screen-relative region to clear.</param>
  859. public void Clear (Rect regionScreen)
  860. {
  861. var h = regionScreen.Height;
  862. var w = regionScreen.Width;
  863. for (int line = regionScreen.Y; line < regionScreen.Y + h; line++) {
  864. Driver.Move (regionScreen.X, line);
  865. for (int col = 0; col < w; col++)
  866. Driver.AddRune (' ');
  867. }
  868. }
  869. /// <summary>
  870. /// Converts a view-relative (col,row) position to a screen-relative position (col,row). The values are optionally clamped to the screen dimensions.
  871. /// </summary>
  872. /// <param name="col">View-relative column.</param>
  873. /// <param name="row">View-relative row.</param>
  874. /// <param name="rcol">Absolute column; screen-relative.</param>
  875. /// <param name="rrow">Absolute row; screen-relative.</param>
  876. /// <param name="clipped">Whether to clip the result of the ViewToScreen method, if set to <c>true</c>, the rcol, rrow values are clamped to the screen (terminal) dimensions (0..TerminalDim-1).</param>
  877. internal void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true)
  878. {
  879. // Computes the real row, col relative to the screen.
  880. rrow = row + frame.Y;
  881. rcol = col + frame.X;
  882. var ccontainer = container;
  883. while (ccontainer != null) {
  884. rrow += ccontainer.frame.Y;
  885. rcol += ccontainer.frame.X;
  886. ccontainer = ccontainer.container;
  887. }
  888. // The following ensures that the cursor is always in the screen boundaries.
  889. if (clipped) {
  890. rrow = Math.Min (rrow, Driver.Rows - 1);
  891. rcol = Math.Min (rcol, Driver.Cols - 1);
  892. }
  893. }
  894. /// <summary>
  895. /// Converts a point from screen-relative coordinates to view-relative coordinates.
  896. /// </summary>
  897. /// <returns>The mapped point.</returns>
  898. /// <param name="x">X screen-coordinate point.</param>
  899. /// <param name="y">Y screen-coordinate point.</param>
  900. public Point ScreenToView (int x, int y)
  901. {
  902. if (SuperView == null) {
  903. return new Point (x - Frame.X, y - frame.Y);
  904. } else {
  905. var parent = SuperView.ScreenToView (x, y);
  906. return new Point (parent.X - frame.X, parent.Y - frame.Y);
  907. }
  908. }
  909. /// <summary>
  910. /// Converts a region in view-relative coordinates to screen-relative coordinates.
  911. /// </summary>
  912. internal Rect ViewToScreen (Rect region)
  913. {
  914. ViewToScreen (region.X, region.Y, out var x, out var y, clipped: false);
  915. return new Rect (x, y, region.Width, region.Height);
  916. }
  917. // Clips a rectangle in screen coordinates to the dimensions currently available on the screen
  918. internal Rect ScreenClip (Rect regionScreen)
  919. {
  920. var x = regionScreen.X < 0 ? 0 : regionScreen.X;
  921. var y = regionScreen.Y < 0 ? 0 : regionScreen.Y;
  922. var w = regionScreen.X + regionScreen.Width >= Driver.Cols ? Driver.Cols - regionScreen.X : regionScreen.Width;
  923. var h = regionScreen.Y + regionScreen.Height >= Driver.Rows ? Driver.Rows - regionScreen.Y : regionScreen.Height;
  924. return new Rect (x, y, w, h);
  925. }
  926. /// <summary>
  927. /// Sets the <see cref="ConsoleDriver"/>'s clip region to the current View's <see cref="Bounds"/>.
  928. /// </summary>
  929. /// <returns>The existing driver's clip region, which can be then re-applied by setting <c><see cref="Driver"/>.Clip</c> (<see cref="ConsoleDriver.Clip"/>).</returns>
  930. /// <remarks>
  931. /// <see cref="Bounds"/> is View-relative.
  932. /// </remarks>
  933. public Rect ClipToBounds ()
  934. {
  935. return SetClip (Bounds);
  936. }
  937. /// <summary>
  938. /// Sets the clip region to the specified view-relative region.
  939. /// </summary>
  940. /// <returns>The previous screen-relative clip region.</returns>
  941. /// <param name="region">View-relative clip region.</param>
  942. public Rect SetClip (Rect region)
  943. {
  944. var previous = Driver.Clip;
  945. Driver.Clip = Rect.Intersect (previous, ViewToScreen (region));
  946. return previous;
  947. }
  948. /// <summary>
  949. /// Draws a frame in the current view, clipped by the boundary of this view
  950. /// </summary>
  951. /// <param name="region">View-relative region for the frame to be drawn.</param>
  952. /// <param name="padding">The padding to add around the outside of the drawn frame.</param>
  953. /// <param name="fill">If set to <c>true</c> it fill will the contents.</param>
  954. public void DrawFrame (Rect region, int padding = 0, bool fill = false)
  955. {
  956. var scrRect = ViewToScreen (region);
  957. var savedClip = ClipToBounds ();
  958. Driver.DrawWindowFrame (scrRect, padding + 1, padding + 1, padding + 1, padding + 1, border: true, fill: fill);
  959. Driver.Clip = savedClip;
  960. }
  961. /// <summary>
  962. /// Utility function to draw strings that contain a hotkey.
  963. /// </summary>
  964. /// <param name="text">String to display, the hotkey specifier before a letter flags the next letter as the hotkey.</param>
  965. /// <param name="hotColor">Hot color.</param>
  966. /// <param name="normalColor">Normal color.</param>
  967. /// <remarks>
  968. /// <para>The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default.</para>
  969. /// <para>The hotkey specifier can be changed via <see cref="HotKeySpecifier"/></para>
  970. /// </remarks>
  971. public void DrawHotString (ustring text, Attribute hotColor, Attribute normalColor)
  972. {
  973. var hotkeySpec = HotKeySpecifier == (Rune)0xffff ? (Rune)'_' : HotKeySpecifier;
  974. Application.Driver.SetAttribute (normalColor);
  975. foreach (var rune in text) {
  976. if (rune == hotkeySpec) {
  977. Application.Driver.SetAttribute (hotColor);
  978. continue;
  979. }
  980. Application.Driver.AddRune (rune);
  981. Application.Driver.SetAttribute (normalColor);
  982. }
  983. }
  984. /// <summary>
  985. /// Utility function to draw strings that contains a hotkey using a <see cref="ColorScheme"/> and the "focused" state.
  986. /// </summary>
  987. /// <param name="text">String to display, the underscore before a letter flags the next letter as the hotkey.</param>
  988. /// <param name="focused">If set to <c>true</c> this uses the focused colors from the color scheme, otherwise the regular ones.</param>
  989. /// <param name="scheme">The color scheme to use.</param>
  990. public void DrawHotString (ustring text, bool focused, ColorScheme scheme)
  991. {
  992. if (focused)
  993. DrawHotString (text, scheme.HotFocus, scheme.Focus);
  994. else
  995. DrawHotString (text, scheme.HotNormal, scheme.Normal);
  996. }
  997. /// <summary>
  998. /// This moves the cursor to the specified column and row in the view.
  999. /// </summary>
  1000. /// <returns>The move.</returns>
  1001. /// <param name="col">Col.</param>
  1002. /// <param name="row">Row.</param>
  1003. public void Move (int col, int row)
  1004. {
  1005. if (Driver.Rows == 0) {
  1006. return;
  1007. }
  1008. ViewToScreen (col, row, out var rcol, out var rrow);
  1009. Driver.Move (rcol, rrow);
  1010. }
  1011. /// <summary>
  1012. /// Positions the cursor in the right position based on the currently focused view in the chain.
  1013. /// </summary>
  1014. /// Views that are focusable should override <see cref="PositionCursor"/> to ensure
  1015. /// the cursor is placed in a location that makes sense. Unix terminals do not have
  1016. /// a way of hiding the cursor, so it can be distracting to have the cursor left at
  1017. /// the last focused view. Views should make sure that they place the cursor
  1018. /// in a visually sensible place.
  1019. public virtual void PositionCursor ()
  1020. {
  1021. if (!CanBeVisible (this)) {
  1022. return;
  1023. }
  1024. if (focused?.Frame.Width > 0 && focused.Frame.Height > 0) {
  1025. focused.PositionCursor ();
  1026. } else {
  1027. if (CanFocus && HasFocus && Visible && Frame.Width > 0 && Frame.Height > 0) {
  1028. Move (textFormatter.HotKeyPos == -1 ? 0 : textFormatter.CursorPosition, 0);
  1029. } else {
  1030. Move (frame.X, frame.Y);
  1031. }
  1032. }
  1033. }
  1034. bool hasFocus;
  1035. /// <inheritdoc/>
  1036. public override bool HasFocus {
  1037. get {
  1038. return hasFocus;
  1039. }
  1040. }
  1041. void SetHasFocus (bool value, View view)
  1042. {
  1043. if (hasFocus != value) {
  1044. hasFocus = value;
  1045. if (value) {
  1046. OnEnter (view);
  1047. } else {
  1048. OnLeave (view);
  1049. }
  1050. SetNeedsDisplay ();
  1051. }
  1052. // Remove focus down the chain of subviews if focus is removed
  1053. if (!value && focused != null) {
  1054. focused.OnLeave (view);
  1055. focused.SetHasFocus (false, view);
  1056. focused = null;
  1057. }
  1058. }
  1059. /// <summary>
  1060. /// Defines the event arguments for <see cref="SetFocus(View)"/>
  1061. /// </summary>
  1062. public class FocusEventArgs : EventArgs {
  1063. /// <summary>
  1064. /// Constructs.
  1065. /// </summary>
  1066. /// <param name="view">The view that gets or loses focus.</param>
  1067. public FocusEventArgs (View view) { View = view; }
  1068. /// <summary>
  1069. /// Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber.
  1070. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1071. /// </summary>
  1072. public bool Handled { get; set; }
  1073. /// <summary>
  1074. /// Indicates the current view that gets or loses focus.
  1075. /// </summary>
  1076. public View View { get; set; }
  1077. }
  1078. /// <summary>
  1079. /// Method invoked when a subview is being added to this view.
  1080. /// </summary>
  1081. /// <param name="view">The subview being added.</param>
  1082. public virtual void OnAdded (View view)
  1083. {
  1084. view.Added?.Invoke (this);
  1085. }
  1086. /// <summary>
  1087. /// Method invoked when a subview is being removed from this view.
  1088. /// </summary>
  1089. /// <param name="view">The subview being removed.</param>
  1090. public virtual void OnRemoved (View view)
  1091. {
  1092. view.Removed?.Invoke (this);
  1093. }
  1094. /// <inheritdoc/>
  1095. public override bool OnEnter (View view)
  1096. {
  1097. FocusEventArgs args = new FocusEventArgs (view);
  1098. Enter?.Invoke (args);
  1099. if (args.Handled)
  1100. return true;
  1101. if (base.OnEnter (view))
  1102. return true;
  1103. return false;
  1104. }
  1105. /// <inheritdoc/>
  1106. public override bool OnLeave (View view)
  1107. {
  1108. FocusEventArgs args = new FocusEventArgs (view);
  1109. Leave?.Invoke (args);
  1110. if (args.Handled)
  1111. return true;
  1112. if (base.OnLeave (view))
  1113. return true;
  1114. return false;
  1115. }
  1116. /// <summary>
  1117. /// Returns the currently focused view inside this view, or null if nothing is focused.
  1118. /// </summary>
  1119. /// <value>The focused.</value>
  1120. public View Focused => focused;
  1121. /// <summary>
  1122. /// Returns the most focused view in the chain of subviews (the leaf view that has the focus).
  1123. /// </summary>
  1124. /// <value>The most focused.</value>
  1125. public View MostFocused {
  1126. get {
  1127. if (Focused == null)
  1128. return null;
  1129. var most = Focused.MostFocused;
  1130. if (most != null)
  1131. return most;
  1132. return Focused;
  1133. }
  1134. }
  1135. /// <summary>
  1136. /// The color scheme for this view, if it is not defined, it returns the <see cref="SuperView"/>'s
  1137. /// color scheme.
  1138. /// </summary>
  1139. public ColorScheme ColorScheme {
  1140. get {
  1141. if (colorScheme == null)
  1142. return SuperView?.ColorScheme;
  1143. return colorScheme;
  1144. }
  1145. set {
  1146. colorScheme = value;
  1147. }
  1148. }
  1149. ColorScheme colorScheme;
  1150. /// <summary>
  1151. /// Displays the specified character in the specified column and row of the View.
  1152. /// </summary>
  1153. /// <param name="col">Column (view-relative).</param>
  1154. /// <param name="row">Row (view-relative).</param>
  1155. /// <param name="ch">Ch.</param>
  1156. public void AddRune (int col, int row, Rune ch)
  1157. {
  1158. if (row < 0 || col < 0)
  1159. return;
  1160. if (row > frame.Height - 1 || col > frame.Width - 1)
  1161. return;
  1162. Move (col, row);
  1163. Driver.AddRune (ch);
  1164. }
  1165. /// <summary>
  1166. /// Removes the <see cref="SetNeedsDisplay()"/> and the <see cref="ChildNeedsDisplay"/> setting on this view.
  1167. /// </summary>
  1168. protected void ClearNeedsDisplay ()
  1169. {
  1170. NeedDisplay = Rect.Empty;
  1171. ChildNeedsDisplay = false;
  1172. }
  1173. /// <summary>
  1174. /// Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1175. /// </summary>
  1176. /// <param name="bounds">The bounds (view-relative region) to redraw.</param>
  1177. /// <remarks>
  1178. /// <para>
  1179. /// Always use <see cref="Bounds"/> (view-relative) when calling <see cref="Redraw(Rect)"/>, NOT <see cref="Frame"/> (superview-relative).
  1180. /// </para>
  1181. /// <para>
  1182. /// Views should set the color that they want to use on entry, as otherwise this will inherit
  1183. /// the last color that was set globally on the driver.
  1184. /// </para>
  1185. /// <para>
  1186. /// Overrides of <see cref="Redraw"/> must ensure they do not set <c>Driver.Clip</c> to a clip region
  1187. /// larger than the <c>region</c> parameter.
  1188. /// </para>
  1189. /// </remarks>
  1190. public virtual void Redraw (Rect bounds)
  1191. {
  1192. if (!CanBeVisible (this)) {
  1193. return;
  1194. }
  1195. var clipRect = new Rect (Point.Empty, frame.Size);
  1196. if (ColorScheme != null) {
  1197. Driver.SetAttribute (HasFocus ? ColorScheme.Focus : ColorScheme.Normal);
  1198. }
  1199. if (!ustring.IsNullOrEmpty (Text)) {
  1200. Clear ();
  1201. // Draw any Text
  1202. if (textFormatter != null) {
  1203. textFormatter.NeedsFormat = true;
  1204. }
  1205. textFormatter?.Draw (ViewToScreen (Bounds), HasFocus ? ColorScheme.Focus : ColorScheme.Normal, HasFocus ? ColorScheme.HotFocus : ColorScheme.HotNormal);
  1206. }
  1207. // Invoke DrawContentEvent
  1208. OnDrawContent (bounds);
  1209. if (subviews != null) {
  1210. foreach (var view in subviews) {
  1211. if (!view.NeedDisplay.IsEmpty || view.ChildNeedsDisplay || view.LayoutNeeded) {
  1212. if (view.Frame.IntersectsWith (clipRect) && (view.Frame.IntersectsWith (bounds) || bounds.X < 0 || bounds.Y < 0)) {
  1213. if (view.LayoutNeeded)
  1214. view.LayoutSubviews ();
  1215. // Draw the subview
  1216. // Use the view's bounds (view-relative; Location will always be (0,0)
  1217. if (view.Visible && view.Frame.Width > 0 && view.Frame.Height > 0) {
  1218. view.OnDrawContent (view.Bounds);
  1219. view.Redraw (view.Bounds);
  1220. }
  1221. }
  1222. view.NeedDisplay = Rect.Empty;
  1223. view.ChildNeedsDisplay = false;
  1224. }
  1225. }
  1226. }
  1227. ClearLayoutNeeded ();
  1228. ClearNeedsDisplay ();
  1229. }
  1230. /// <summary>
  1231. /// Event invoked when the content area of the View is to be drawn.
  1232. /// </summary>
  1233. /// <remarks>
  1234. /// <para>
  1235. /// Will be invoked before any subviews added with <see cref="Add(View)"/> have been drawn.
  1236. /// </para>
  1237. /// <para>
  1238. /// Rect provides the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.
  1239. /// </para>
  1240. /// </remarks>
  1241. public event Action<Rect> DrawContent;
  1242. /// <summary>
  1243. /// Enables overrides to draw infinitely scrolled content and/or a background behind added controls.
  1244. /// </summary>
  1245. /// <param name="viewport">The view-relative rectangle describing the currently visible viewport into the <see cref="View"/></param>
  1246. /// <remarks>
  1247. /// This method will be called before any subviews added with <see cref="Add(View)"/> have been drawn.
  1248. /// </remarks>
  1249. public virtual void OnDrawContent (Rect viewport)
  1250. {
  1251. DrawContent?.Invoke (viewport);
  1252. }
  1253. /// <summary>
  1254. /// Causes the specified subview to have focus.
  1255. /// </summary>
  1256. /// <param name="view">View.</param>
  1257. void SetFocus (View view)
  1258. {
  1259. if (view == null)
  1260. return;
  1261. //Console.WriteLine ($"Request to focus {view}");
  1262. if (!view.CanFocus || !view.Visible)
  1263. return;
  1264. if (focused?.hasFocus == true && focused == view)
  1265. return;
  1266. // Make sure that this view is a subview
  1267. View c;
  1268. for (c = view.container; c != null; c = c.container)
  1269. if (c == this)
  1270. break;
  1271. if (c == null)
  1272. throw new ArgumentException ("the specified view is not part of the hierarchy of this view");
  1273. if (focused != null)
  1274. focused.SetHasFocus (false, view);
  1275. var f = focused;
  1276. focused = view;
  1277. focused.SetHasFocus (true, f);
  1278. focused.EnsureFocus ();
  1279. // Send focus upwards
  1280. SuperView?.SetFocus (this);
  1281. }
  1282. /// <summary>
  1283. /// Causes the specified view and the entire parent hierarchy to have the focused order updated.
  1284. /// </summary>
  1285. public void SetFocus ()
  1286. {
  1287. if (!CanBeVisible (this)) {
  1288. return;
  1289. }
  1290. SuperView?.SetFocus (this);
  1291. }
  1292. /// <summary>
  1293. /// Defines the event arguments for <see cref="KeyEvent"/>
  1294. /// </summary>
  1295. public class KeyEventEventArgs : EventArgs {
  1296. /// <summary>
  1297. /// Constructs.
  1298. /// </summary>
  1299. /// <param name="ke"></param>
  1300. public KeyEventEventArgs (KeyEvent ke) => KeyEvent = ke;
  1301. /// <summary>
  1302. /// The <see cref="KeyEvent"/> for the event.
  1303. /// </summary>
  1304. public KeyEvent KeyEvent { get; set; }
  1305. /// <summary>
  1306. /// Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber.
  1307. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1308. /// </summary>
  1309. public bool Handled { get; set; } = false;
  1310. }
  1311. /// <summary>
  1312. /// Invoked when a character key is pressed and occurs after the key up event.
  1313. /// </summary>
  1314. public event Action<KeyEventEventArgs> KeyPress;
  1315. /// <inheritdoc/>
  1316. public override bool ProcessKey (KeyEvent keyEvent)
  1317. {
  1318. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1319. KeyPress?.Invoke (args);
  1320. if (args.Handled)
  1321. return true;
  1322. if (Focused?.ProcessKey (keyEvent) == true)
  1323. return true;
  1324. return false;
  1325. }
  1326. /// <inheritdoc/>
  1327. public override bool ProcessHotKey (KeyEvent keyEvent)
  1328. {
  1329. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1330. KeyPress?.Invoke (args);
  1331. if (args.Handled)
  1332. return true;
  1333. if (Focused?.ProcessKey (keyEvent) == true)
  1334. return true;
  1335. if (subviews == null || subviews.Count == 0)
  1336. return false;
  1337. foreach (var view in subviews)
  1338. if (view.ProcessHotKey (keyEvent))
  1339. return true;
  1340. return false;
  1341. }
  1342. /// <inheritdoc/>
  1343. public override bool ProcessColdKey (KeyEvent keyEvent)
  1344. {
  1345. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1346. KeyPress?.Invoke (args);
  1347. if (args.Handled)
  1348. return true;
  1349. if (Focused?.ProcessKey (keyEvent) == true)
  1350. return true;
  1351. if (subviews == null || subviews.Count == 0)
  1352. return false;
  1353. foreach (var view in subviews)
  1354. if (view.ProcessColdKey (keyEvent))
  1355. return true;
  1356. return false;
  1357. }
  1358. /// <summary>
  1359. /// Invoked when a key is pressed
  1360. /// </summary>
  1361. public event Action<KeyEventEventArgs> KeyDown;
  1362. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  1363. public override bool OnKeyDown (KeyEvent keyEvent)
  1364. {
  1365. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1366. KeyDown?.Invoke (args);
  1367. if (args.Handled) {
  1368. return true;
  1369. }
  1370. if (Focused?.OnKeyDown (keyEvent) == true) {
  1371. return true;
  1372. }
  1373. return false;
  1374. }
  1375. /// <summary>
  1376. /// Invoked when a key is released
  1377. /// </summary>
  1378. public event Action<KeyEventEventArgs> KeyUp;
  1379. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  1380. public override bool OnKeyUp (KeyEvent keyEvent)
  1381. {
  1382. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1383. KeyUp?.Invoke (args);
  1384. if (args.Handled) {
  1385. return true;
  1386. }
  1387. if (Focused?.OnKeyUp (keyEvent) == true) {
  1388. return true;
  1389. }
  1390. return false;
  1391. }
  1392. /// <summary>
  1393. /// Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
  1394. /// </summary>
  1395. public void EnsureFocus ()
  1396. {
  1397. if (focused == null && subviews?.Count > 0) {
  1398. if (FocusDirection == Direction.Forward) {
  1399. FocusFirst ();
  1400. } else {
  1401. FocusLast ();
  1402. }
  1403. }
  1404. }
  1405. /// <summary>
  1406. /// Focuses the first focusable subview if one exists.
  1407. /// </summary>
  1408. public void FocusFirst ()
  1409. {
  1410. if (!CanBeVisible (this)) {
  1411. return;
  1412. }
  1413. if (tabIndexes == null) {
  1414. SuperView?.SetFocus (this);
  1415. return;
  1416. }
  1417. foreach (var view in tabIndexes) {
  1418. if (view.CanFocus && view.tabStop && view.Visible) {
  1419. SetFocus (view);
  1420. return;
  1421. }
  1422. }
  1423. }
  1424. /// <summary>
  1425. /// Focuses the last focusable subview if one exists.
  1426. /// </summary>
  1427. public void FocusLast ()
  1428. {
  1429. if (!CanBeVisible (this)) {
  1430. return;
  1431. }
  1432. if (tabIndexes == null) {
  1433. SuperView?.SetFocus (this);
  1434. return;
  1435. }
  1436. for (int i = tabIndexes.Count; i > 0;) {
  1437. i--;
  1438. View v = tabIndexes [i];
  1439. if (v.CanFocus && v.tabStop && v.Visible) {
  1440. SetFocus (v);
  1441. return;
  1442. }
  1443. }
  1444. }
  1445. /// <summary>
  1446. /// Focuses the previous view.
  1447. /// </summary>
  1448. /// <returns><c>true</c>, if previous was focused, <c>false</c> otherwise.</returns>
  1449. public bool FocusPrev ()
  1450. {
  1451. if (!CanBeVisible (this)) {
  1452. return false;
  1453. }
  1454. FocusDirection = Direction.Backward;
  1455. if (tabIndexes == null || tabIndexes.Count == 0)
  1456. return false;
  1457. if (focused == null) {
  1458. FocusLast ();
  1459. return focused != null;
  1460. }
  1461. int focused_idx = -1;
  1462. for (int i = tabIndexes.Count; i > 0;) {
  1463. i--;
  1464. View w = tabIndexes [i];
  1465. if (w.HasFocus) {
  1466. if (w.FocusPrev ())
  1467. return true;
  1468. focused_idx = i;
  1469. continue;
  1470. }
  1471. if (w.CanFocus && focused_idx != -1 && w.tabStop && w.Visible) {
  1472. focused.SetHasFocus (false, w);
  1473. if (w != null && w.CanFocus && w.tabStop && w.Visible)
  1474. w.FocusLast ();
  1475. SetFocus (w);
  1476. return true;
  1477. }
  1478. }
  1479. if (focused != null) {
  1480. focused.SetHasFocus (false, this);
  1481. focused = null;
  1482. }
  1483. return false;
  1484. }
  1485. /// <summary>
  1486. /// Focuses the next view.
  1487. /// </summary>
  1488. /// <returns><c>true</c>, if next was focused, <c>false</c> otherwise.</returns>
  1489. public bool FocusNext ()
  1490. {
  1491. if (!CanBeVisible (this)) {
  1492. return false;
  1493. }
  1494. FocusDirection = Direction.Forward;
  1495. if (tabIndexes == null || tabIndexes.Count == 0)
  1496. return false;
  1497. if (focused == null) {
  1498. FocusFirst ();
  1499. return focused != null;
  1500. }
  1501. int n = tabIndexes.Count;
  1502. int focused_idx = -1;
  1503. for (int i = 0; i < n; i++) {
  1504. View w = tabIndexes [i];
  1505. if (w.HasFocus) {
  1506. if (w.FocusNext ())
  1507. return true;
  1508. focused_idx = i;
  1509. continue;
  1510. }
  1511. if (w.CanFocus && focused_idx != -1 && w.tabStop && w.Visible) {
  1512. focused.SetHasFocus (false, w);
  1513. if (w != null && w.CanFocus && w.tabStop && w.Visible)
  1514. w.FocusFirst ();
  1515. SetFocus (w);
  1516. return true;
  1517. }
  1518. }
  1519. if (focused != null) {
  1520. focused.SetHasFocus (false, this);
  1521. focused = null;
  1522. }
  1523. return false;
  1524. }
  1525. /// <summary>
  1526. /// Sets the View's <see cref="Frame"/> to the relative coordinates if its container, given the <see cref="Frame"/> for its container.
  1527. /// </summary>
  1528. /// <param name="hostFrame">The screen-relative frame for the host.</param>
  1529. /// <remarks>
  1530. /// Reminder: <see cref="Frame"/> is superview-relative; <see cref="Bounds"/> is view-relative.
  1531. /// </remarks>
  1532. internal void SetRelativeLayout (Rect hostFrame)
  1533. {
  1534. int w, h, _x, _y;
  1535. if (x is Pos.PosCenter) {
  1536. if (width == null)
  1537. w = hostFrame.Width;
  1538. else
  1539. w = width.Anchor (hostFrame.Width);
  1540. _x = x.Anchor (hostFrame.Width - w);
  1541. } else {
  1542. if (x == null)
  1543. _x = 0;
  1544. else
  1545. _x = x.Anchor (hostFrame.Width);
  1546. if (width == null)
  1547. w = hostFrame.Width;
  1548. else if (width is Dim.DimFactor && !((Dim.DimFactor)width).IsFromRemaining ())
  1549. w = width.Anchor (hostFrame.Width);
  1550. else
  1551. w = Math.Max (width.Anchor (hostFrame.Width - _x), 0);
  1552. }
  1553. if (y is Pos.PosCenter) {
  1554. if (height == null)
  1555. h = hostFrame.Height;
  1556. else
  1557. h = height.Anchor (hostFrame.Height);
  1558. _y = y.Anchor (hostFrame.Height - h);
  1559. } else {
  1560. if (y == null)
  1561. _y = 0;
  1562. else
  1563. _y = y.Anchor (hostFrame.Height);
  1564. if (height == null)
  1565. h = hostFrame.Height;
  1566. else if (height is Dim.DimFactor && !((Dim.DimFactor)height).IsFromRemaining ())
  1567. h = height.Anchor (hostFrame.Height);
  1568. else
  1569. h = Math.Max (height.Anchor (hostFrame.Height - _y), 0);
  1570. }
  1571. var r = new Rect (_x, _y, w, h);
  1572. if (Frame != r) {
  1573. Frame = new Rect (_x, _y, w, h);
  1574. }
  1575. }
  1576. // https://en.wikipedia.org/wiki/Topological_sorting
  1577. List<View> TopologicalSort (HashSet<View> nodes, HashSet<(View From, View To)> edges)
  1578. {
  1579. var result = new List<View> ();
  1580. // Set of all nodes with no incoming edges
  1581. var S = new HashSet<View> (nodes.Where (n => edges.All (e => !e.To.Equals (n))));
  1582. while (S.Any ()) {
  1583. // remove a node n from S
  1584. var n = S.First ();
  1585. S.Remove (n);
  1586. // add n to tail of L
  1587. if (n != this?.SuperView)
  1588. result.Add (n);
  1589. // for each node m with an edge e from n to m do
  1590. foreach (var e in edges.Where (e => e.From.Equals (n)).ToArray ()) {
  1591. var m = e.To;
  1592. // remove edge e from the graph
  1593. edges.Remove (e);
  1594. // if m has no other incoming edges then
  1595. if (edges.All (me => !me.To.Equals (m)) && m != this?.SuperView) {
  1596. // insert m into S
  1597. S.Add (m);
  1598. }
  1599. }
  1600. }
  1601. if (edges.Any () && edges.First ().From != Application.Top) {
  1602. if (!ReferenceEquals (edges.First ().From, edges.First ().To)) {
  1603. throw new InvalidOperationException ($"TopologicalSort (for Pos/Dim) cannot find {edges.First ().From}. Did you forget to add it to {this}?");
  1604. } else {
  1605. throw new InvalidOperationException ("TopologicalSort encountered a recursive cycle in the relative Pos/Dim in the views of " + this);
  1606. }
  1607. } else {
  1608. // return L (a topologically sorted order)
  1609. return result;
  1610. }
  1611. }
  1612. /// <summary>
  1613. /// Event arguments for the <see cref="LayoutComplete"/> event.
  1614. /// </summary>
  1615. public class LayoutEventArgs : EventArgs {
  1616. /// <summary>
  1617. /// The view-relative bounds of the <see cref="View"/> before it was laid out.
  1618. /// </summary>
  1619. public Rect OldBounds { get; set; }
  1620. }
  1621. /// <summary>
  1622. /// Fired after the Views's <see cref="LayoutSubviews"/> method has completed.
  1623. /// </summary>
  1624. /// <remarks>
  1625. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  1626. /// </remarks>
  1627. public event Action<LayoutEventArgs> LayoutStarted;
  1628. /// <summary>
  1629. /// Raises the <see cref="LayoutStarted"/> event. Called from <see cref="LayoutSubviews"/> before any subviews have been laid out.
  1630. /// </summary>
  1631. internal virtual void OnLayoutStarted (LayoutEventArgs args)
  1632. {
  1633. LayoutStarted?.Invoke (args);
  1634. }
  1635. /// <summary>
  1636. /// Fired after the Views's <see cref="LayoutSubviews"/> method has completed.
  1637. /// </summary>
  1638. /// <remarks>
  1639. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  1640. /// </remarks>
  1641. public event Action<LayoutEventArgs> LayoutComplete;
  1642. /// <summary>
  1643. /// Event called only once when the <see cref="View"/> is being initialized for the first time.
  1644. /// Allows configurations and assignments to be performed before the <see cref="View"/> being shown.
  1645. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  1646. /// </summary>
  1647. public event EventHandler Initialized;
  1648. /// <summary>
  1649. /// Raises the <see cref="LayoutComplete"/> event. Called from <see cref="LayoutSubviews"/> before all sub-views have been laid out.
  1650. /// </summary>
  1651. internal virtual void OnLayoutComplete (LayoutEventArgs args)
  1652. {
  1653. LayoutComplete?.Invoke (args);
  1654. }
  1655. /// <summary>
  1656. /// Invoked when a view starts executing or when the dimensions of the view have changed, for example in
  1657. /// response to the container view or terminal resizing.
  1658. /// </summary>
  1659. /// <remarks>
  1660. /// Calls <see cref="OnLayoutComplete"/> (which raises the <see cref="LayoutComplete"/> event) before it returns.
  1661. /// </remarks>
  1662. public virtual void LayoutSubviews ()
  1663. {
  1664. if (!LayoutNeeded) {
  1665. return;
  1666. }
  1667. Rect oldBounds = Bounds;
  1668. OnLayoutStarted (new LayoutEventArgs () { OldBounds = oldBounds });
  1669. textFormatter.Size = Bounds.Size;
  1670. // Sort out the dependencies of the X, Y, Width, Height properties
  1671. var nodes = new HashSet<View> ();
  1672. var edges = new HashSet<(View, View)> ();
  1673. void CollectPos (Pos pos, View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  1674. {
  1675. if (pos is Pos.PosView pv) {
  1676. if (pv.Target != this) {
  1677. nEdges.Add ((pv.Target, from));
  1678. }
  1679. foreach (var v in from.InternalSubviews) {
  1680. CollectAll (v, ref nNodes, ref nEdges);
  1681. }
  1682. return;
  1683. }
  1684. if (pos is Pos.PosCombine pc) {
  1685. foreach (var v in from.InternalSubviews) {
  1686. CollectPos (pc.left, from, ref nNodes, ref nEdges);
  1687. CollectPos (pc.right, from, ref nNodes, ref nEdges);
  1688. }
  1689. }
  1690. }
  1691. void CollectDim (Dim dim, View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  1692. {
  1693. if (dim is Dim.DimView dv) {
  1694. if (dv.Target != this) {
  1695. nEdges.Add ((dv.Target, from));
  1696. }
  1697. foreach (var v in from.InternalSubviews) {
  1698. CollectAll (v, ref nNodes, ref nEdges);
  1699. }
  1700. return;
  1701. }
  1702. if (dim is Dim.DimCombine dc) {
  1703. foreach (var v in from.InternalSubviews) {
  1704. CollectDim (dc.left, from, ref nNodes, ref nEdges);
  1705. CollectDim (dc.right, from, ref nNodes, ref nEdges);
  1706. }
  1707. }
  1708. }
  1709. void CollectAll (View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  1710. {
  1711. foreach (var v in from.InternalSubviews) {
  1712. nNodes.Add (v);
  1713. if (v.layoutStyle != LayoutStyle.Computed) {
  1714. continue;
  1715. }
  1716. CollectPos (v.X, v, ref nNodes, ref nEdges);
  1717. CollectPos (v.Y, v, ref nNodes, ref nEdges);
  1718. CollectDim (v.Width, v, ref nNodes, ref nEdges);
  1719. CollectDim (v.Height, v, ref nNodes, ref nEdges);
  1720. }
  1721. }
  1722. CollectAll (this, ref nodes, ref edges);
  1723. var ordered = TopologicalSort (nodes, edges);
  1724. foreach (var v in ordered) {
  1725. if (v.LayoutStyle == LayoutStyle.Computed) {
  1726. v.SetRelativeLayout (Frame);
  1727. }
  1728. v.LayoutSubviews ();
  1729. v.LayoutNeeded = false;
  1730. }
  1731. if (SuperView == Application.Top && LayoutNeeded && ordered.Count == 0 && LayoutStyle == LayoutStyle.Computed) {
  1732. SetRelativeLayout (Frame);
  1733. }
  1734. LayoutNeeded = false;
  1735. OnLayoutComplete (new LayoutEventArgs () { OldBounds = oldBounds });
  1736. }
  1737. /// <summary>
  1738. /// The text displayed by the <see cref="View"/>.
  1739. /// </summary>
  1740. /// <remarks>
  1741. /// <para>
  1742. /// If provided, the text will be drawn before any subviews are drawn.
  1743. /// </para>
  1744. /// <para>
  1745. /// The text will be drawn starting at the view origin (0, 0) and will be formatted according
  1746. /// to the <see cref="TextAlignment"/> property. If the view's height is greater than 1, the
  1747. /// text will word-wrap to additional lines if it does not fit horizontally. If the view's height
  1748. /// is 1, the text will be clipped.
  1749. /// </para>
  1750. /// <para>
  1751. /// Set the <see cref="HotKeySpecifier"/> to enable hotkey support. To disable hotkey support set <see cref="HotKeySpecifier"/> to
  1752. /// <c>(Rune)0xffff</c>.
  1753. /// </para>
  1754. /// </remarks>
  1755. public virtual ustring Text {
  1756. get => textFormatter.Text;
  1757. set {
  1758. textFormatter.Text = value;
  1759. ResizeView (autoSize);
  1760. SetNeedsLayout ();
  1761. SetNeedsDisplay ();
  1762. }
  1763. }
  1764. /// <summary>
  1765. /// Used by <see cref="Text"/> to resize the view's <see cref="Bounds"/> with the <see cref="TextFormatter.Size"/>.
  1766. /// Setting <see cref="AutoSize"/> to true only work if the <see cref="Width"/> and <see cref="Height"/> are null or
  1767. /// <see cref="LayoutStyle.Absolute"/> values and doesn't work with <see cref="LayoutStyle.Computed"/> layout,
  1768. /// to avoid breaking the <see cref="Pos"/> and <see cref="Dim"/> settings.
  1769. /// </summary>
  1770. public virtual bool AutoSize {
  1771. get => autoSize;
  1772. set {
  1773. var v = ResizeView (value);
  1774. if (autoSize != v) {
  1775. autoSize = v;
  1776. SetNeedsLayout ();
  1777. SetNeedsDisplay ();
  1778. }
  1779. }
  1780. }
  1781. /// <summary>
  1782. /// Gets or sets how the View's <see cref="Text"/> is aligned horizontally when drawn. Changing this property will redisplay the <see cref="View"/>.
  1783. /// </summary>
  1784. /// <value>The text alignment.</value>
  1785. public virtual TextAlignment TextAlignment {
  1786. get => textFormatter.Alignment;
  1787. set {
  1788. textFormatter.Alignment = value;
  1789. SetNeedsDisplay ();
  1790. }
  1791. }
  1792. /// <summary>
  1793. /// Gets or sets how the View's <see cref="Text"/> is aligned verticaly when drawn. Changing this property will redisplay the <see cref="View"/>.
  1794. /// </summary>
  1795. /// <value>The text alignment.</value>
  1796. public virtual VerticalTextAlignment VerticalTextAlignment {
  1797. get => textFormatter.VerticalAlignment;
  1798. set {
  1799. textFormatter.VerticalAlignment = value;
  1800. SetNeedsDisplay ();
  1801. }
  1802. }
  1803. /// <summary>
  1804. /// Gets or sets the direction of the View's <see cref="Text"/>. Changing this property will redisplay the <see cref="View"/>.
  1805. /// </summary>
  1806. /// <value>The text alignment.</value>
  1807. public virtual TextDirection TextDirection {
  1808. get => textFormatter.Direction;
  1809. set {
  1810. textFormatter.Direction = value;
  1811. SetNeedsDisplay ();
  1812. }
  1813. }
  1814. /// <summary>
  1815. /// Get or sets if the <see cref="View"/> was already initialized.
  1816. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  1817. /// </summary>
  1818. public bool IsInitialized { get; set; }
  1819. /// <summary>
  1820. /// Pretty prints the View
  1821. /// </summary>
  1822. /// <returns></returns>
  1823. public override string ToString ()
  1824. {
  1825. return $"{GetType ().Name}({Id})({Frame})";
  1826. }
  1827. bool ResizeView (bool autoSize)
  1828. {
  1829. var aSize = autoSize;
  1830. if (textFormatter.Size != Bounds.Size && (((width == null || width is Dim.DimAbsolute) && (Bounds.Width == 0
  1831. || autoSize && Bounds.Width != textFormatter.Size.Width))
  1832. || ((height == null || height is Dim.DimAbsolute) && (Bounds.Height == 0
  1833. || autoSize && Bounds.Height != textFormatter.Size.Height)))) {
  1834. Bounds = new Rect (Bounds.X, Bounds.Y, textFormatter.Size.Width, textFormatter.Size.Height);
  1835. if (width == null) {
  1836. width = Bounds.Width;
  1837. } else if (width is Dim.DimAbsolute) {
  1838. width = Math.Max (Bounds.Width, height.Anchor (Bounds.Width));
  1839. } else {
  1840. aSize = false;
  1841. }
  1842. if (height == null) {
  1843. height = Bounds.Height;
  1844. } else if (height is Dim.DimAbsolute) {
  1845. height = Math.Max (Bounds.Height, height.Anchor (Bounds.Height));
  1846. } else {
  1847. aSize = false;
  1848. }
  1849. }
  1850. return aSize;
  1851. }
  1852. /// <summary>
  1853. /// Specifies the event arguments for <see cref="MouseEvent"/>
  1854. /// </summary>
  1855. public class MouseEventArgs : EventArgs {
  1856. /// <summary>
  1857. /// Constructs.
  1858. /// </summary>
  1859. /// <param name="me"></param>
  1860. public MouseEventArgs (MouseEvent me) => MouseEvent = me;
  1861. /// <summary>
  1862. /// The <see cref="MouseEvent"/> for the event.
  1863. /// </summary>
  1864. public MouseEvent MouseEvent { get; set; }
  1865. /// <summary>
  1866. /// Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.
  1867. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1868. /// </summary>
  1869. public bool Handled { get; set; }
  1870. }
  1871. /// <inheritdoc/>
  1872. public override bool OnMouseEnter (MouseEvent mouseEvent)
  1873. {
  1874. if (!CanBeVisible (this)) {
  1875. return false;
  1876. }
  1877. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  1878. MouseEnter?.Invoke (args);
  1879. if (args.Handled)
  1880. return true;
  1881. if (base.OnMouseEnter (mouseEvent))
  1882. return true;
  1883. return false;
  1884. }
  1885. /// <inheritdoc/>
  1886. public override bool OnMouseLeave (MouseEvent mouseEvent)
  1887. {
  1888. if (!CanBeVisible (this)) {
  1889. return false;
  1890. }
  1891. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  1892. MouseLeave?.Invoke (args);
  1893. if (args.Handled)
  1894. return true;
  1895. if (base.OnMouseLeave (mouseEvent))
  1896. return true;
  1897. return false;
  1898. }
  1899. /// <summary>
  1900. /// Method invoked when a mouse event is generated
  1901. /// </summary>
  1902. /// <param name="mouseEvent"></param>
  1903. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  1904. public virtual bool OnMouseEvent (MouseEvent mouseEvent)
  1905. {
  1906. if (!CanBeVisible (this)) {
  1907. return false;
  1908. }
  1909. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  1910. OnMouseClick (args);
  1911. if (args.Handled)
  1912. return true;
  1913. if (MouseEvent (mouseEvent))
  1914. return true;
  1915. if (mouseEvent.Flags == MouseFlags.Button1Clicked) {
  1916. if (CanFocus && !HasFocus && SuperView != null) {
  1917. SuperView.SetFocus (this);
  1918. SetNeedsDisplay ();
  1919. }
  1920. return true;
  1921. }
  1922. return false;
  1923. }
  1924. /// <summary>
  1925. /// Invokes the MouseClick event.
  1926. /// </summary>
  1927. protected void OnMouseClick (MouseEventArgs args) => MouseClick?.Invoke (args);
  1928. /// <inheritdoc/>
  1929. protected override void Dispose (bool disposing)
  1930. {
  1931. for (int i = InternalSubviews.Count - 1; i >= 0; i--) {
  1932. View subview = InternalSubviews [i];
  1933. Remove (subview);
  1934. subview.Dispose ();
  1935. }
  1936. base.Dispose (disposing);
  1937. }
  1938. /// <summary>
  1939. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are beginning initialized.
  1940. /// </summary>
  1941. public void BeginInit ()
  1942. {
  1943. if (!IsInitialized) {
  1944. oldCanFocus = CanFocus;
  1945. oldTabIndex = tabIndex;
  1946. }
  1947. if (subviews?.Count > 0) {
  1948. foreach (var view in subviews) {
  1949. if (!view.IsInitialized) {
  1950. view.BeginInit ();
  1951. }
  1952. }
  1953. }
  1954. }
  1955. /// <summary>
  1956. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are ending initialized.
  1957. /// </summary>
  1958. public void EndInit ()
  1959. {
  1960. IsInitialized = true;
  1961. if (subviews?.Count > 0) {
  1962. foreach (var view in subviews) {
  1963. if (!view.IsInitialized) {
  1964. view.EndInit ();
  1965. }
  1966. }
  1967. }
  1968. Initialized?.Invoke (this, EventArgs.Empty);
  1969. }
  1970. /// <summary>
  1971. /// Gets or sets the view visibility.
  1972. /// </summary>
  1973. public bool Visible { get; set; } = true;
  1974. bool CanBeVisible (View view)
  1975. {
  1976. if (!view.Visible) {
  1977. return false;
  1978. }
  1979. for (var c = view.SuperView; c != null; c = c.SuperView) {
  1980. if (!c.Visible) {
  1981. return false;
  1982. }
  1983. }
  1984. return true;
  1985. }
  1986. bool CanSetWidth (int desiredWidth, out int resultWidth, out int currentWidth)
  1987. {
  1988. int w = desiredWidth;
  1989. currentWidth = Width != null ? Width.Anchor (0) : 0;
  1990. bool canSetWidth;
  1991. if (Width is Dim.DimCombine || Width is Dim.DimView || Width is Dim.DimFill) {
  1992. // It's a Dim.DimCombine and so can't be assigned. Let it have it's width anchored.
  1993. w = Width.Anchor (w);
  1994. currentWidth = Width.Anchor (w);
  1995. canSetWidth = false;
  1996. } else if (Width is Dim.DimFactor factor) {
  1997. // Tries to get the SuperView width otherwise the view width.
  1998. var sw = SuperView != null ? SuperView.Frame.Width : w;
  1999. if (factor.IsFromRemaining ()) {
  2000. sw -= Frame.X;
  2001. }
  2002. w = Width.Anchor (sw);
  2003. currentWidth = Width.Anchor (sw);
  2004. canSetWidth = false;
  2005. } else {
  2006. canSetWidth = true;
  2007. }
  2008. resultWidth = w;
  2009. return canSetWidth;
  2010. }
  2011. bool CanSetHeight (int desiredHeight, out int resultHeight, out int currentHeight)
  2012. {
  2013. int h = desiredHeight;
  2014. currentHeight = Height != null ? Height.Anchor (0) : 0;
  2015. bool canSetHeight;
  2016. if (Height is Dim.DimCombine || Height is Dim.DimView || Height is Dim.DimFill) {
  2017. // It's a Dim.DimCombine and so can't be assigned. Let it have it's height anchored.
  2018. h = Height.Anchor (h);
  2019. currentHeight = Height.Anchor (h);
  2020. canSetHeight = false;
  2021. } else if (Height is Dim.DimFactor factor) {
  2022. // Tries to get the SuperView height otherwise the view height.
  2023. var sh = SuperView != null ? SuperView.Frame.Height : h;
  2024. if (factor.IsFromRemaining ()) {
  2025. sh -= Frame.Y;
  2026. }
  2027. h = Height.Anchor (sh);
  2028. currentHeight = Height.Anchor (sh);
  2029. canSetHeight = false;
  2030. } else {
  2031. canSetHeight = true;
  2032. }
  2033. resultHeight = h;
  2034. return canSetHeight;
  2035. }
  2036. /// <summary>
  2037. /// Calculate the width based on the <see cref="Width"/> settings.
  2038. /// </summary>
  2039. /// <param name="desiredWidth">The desired width.</param>
  2040. /// <param name="resultWidth">The real result width.</param>
  2041. /// <returns><c>true</c> if the width can be directly assigned, <c>false</c> otherwise.</returns>
  2042. public bool SetWidth (int desiredWidth, out int resultWidth)
  2043. {
  2044. return CanSetWidth (desiredWidth, out resultWidth, out _);
  2045. }
  2046. /// <summary>
  2047. /// Calculate the height based on the <see cref="Height"/> settings.
  2048. /// </summary>
  2049. /// <param name="desiredHeight">The desired height.</param>
  2050. /// <param name="resultHeight">The real result height.</param>
  2051. /// <returns><c>true</c> if the height can be directly assigned, <c>false</c> otherwise.</returns>
  2052. public bool SetHeight (int desiredHeight, out int resultHeight)
  2053. {
  2054. return CanSetHeight (desiredHeight, out resultHeight, out _);
  2055. }
  2056. /// <summary>
  2057. /// Gets the current width based on the <see cref="Width"/> settings.
  2058. /// </summary>
  2059. /// <param name="currentWidth">The real current width.</param>
  2060. /// <returns><c>true</c> if the width can be directly assigned, <c>false</c> otherwise.</returns>
  2061. public bool GetCurrentWidth (out int currentWidth)
  2062. {
  2063. return CanSetWidth (0, out _, out currentWidth);
  2064. }
  2065. /// <summary>
  2066. /// Calculate the height based on the <see cref="Height"/> settings.
  2067. /// </summary>
  2068. /// <param name="currentHeight">The real current height.</param>
  2069. /// <returns><c>true</c> if the height can be directly assigned, <c>false</c> otherwise.</returns>
  2070. public bool GetCurrentHeight (out int currentHeight)
  2071. {
  2072. return CanSetHeight (0, out _, out currentHeight);
  2073. }
  2074. }
  2075. }