View.cs 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954
  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. // Optimziations
  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 initizlied. 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 parametr 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 coordiantes and sizes of Views explicitly, and the
  69. /// View will typcialy 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, IEnumerable, 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. TextFormatter textFormatter;
  121. /// <summary>
  122. /// Event fired when a subview is being added to this view.
  123. /// </summary>
  124. public Action<View> Added;
  125. /// <summary>
  126. /// Event fired when a subview is being removed from this view.
  127. /// </summary>
  128. public Action<View> Removed;
  129. /// <summary>
  130. /// Event fired when the view gets focus.
  131. /// </summary>
  132. public Action<FocusEventArgs> Enter;
  133. /// <summary>
  134. /// Event fired when the view looses focus.
  135. /// </summary>
  136. public Action<FocusEventArgs> Leave;
  137. /// <summary>
  138. /// Event fired when the view receives the mouse event for the first time.
  139. /// </summary>
  140. public Action<MouseEventArgs> MouseEnter;
  141. /// <summary>
  142. /// Event fired when the view receives a mouse event for the last time.
  143. /// </summary>
  144. public Action<MouseEventArgs> MouseLeave;
  145. /// <summary>
  146. /// Event fired when a mouse event is generated.
  147. /// </summary>
  148. public Action<MouseEventArgs> MouseClick;
  149. /// <summary>
  150. /// 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.
  151. /// </summary>
  152. public Key HotKey { get => textFormatter.HotKey; set => textFormatter.HotKey = value; }
  153. /// <summary>
  154. /// 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'.
  155. /// </summary>
  156. public Rune HotKeySpecifier { get => textFormatter.HotKeySpecifier; set => textFormatter.HotKeySpecifier = value; }
  157. internal Direction FocusDirection {
  158. get => SuperView?.FocusDirection ?? focusDirection;
  159. set {
  160. if (SuperView != null)
  161. SuperView.FocusDirection = value;
  162. else
  163. focusDirection = value;
  164. }
  165. }
  166. /// <summary>
  167. /// Points to the current driver in use by the view, it is a convenience property
  168. /// for simplifying the development of new views.
  169. /// </summary>
  170. public static ConsoleDriver Driver { get { return Application.Driver; } }
  171. static IList<View> empty = new List<View> (0).AsReadOnly ();
  172. // This is null, and allocated on demand.
  173. List<View> subviews;
  174. /// <summary>
  175. /// This returns a list of the subviews contained by this view.
  176. /// </summary>
  177. /// <value>The subviews.</value>
  178. public IList<View> Subviews => subviews == null ? empty : subviews.AsReadOnly ();
  179. // Internally, we use InternalSubviews rather than subviews, as we do not expect us
  180. // to make the same mistakes our users make when they poke at the Subviews.
  181. internal IList<View> InternalSubviews => subviews ?? empty;
  182. // This is null, and allocated on demand.
  183. List<View> tabIndexes;
  184. /// <summary>
  185. /// This returns a tab index list of the subviews contained by this view.
  186. /// </summary>
  187. /// <value>The tabIndexes.</value>
  188. public IList<View> TabIndexes => tabIndexes == null ? empty : tabIndexes.AsReadOnly ();
  189. int tabIndex = -1;
  190. /// <summary>
  191. /// Indicates the index of the current <see cref="View"/> from the <see cref="TabIndexes"/> list.
  192. /// </summary>
  193. public int TabIndex {
  194. get { return tabIndex; }
  195. set {
  196. if (!CanFocus) {
  197. tabIndex = -1;
  198. return;
  199. } else if (SuperView?.tabIndexes == null || SuperView?.tabIndexes.Count == 1) {
  200. tabIndex = 0;
  201. return;
  202. } else if (tabIndex == value) {
  203. return;
  204. }
  205. tabIndex = value > SuperView.tabIndexes.Count - 1 ? SuperView.tabIndexes.Count - 1 : value < 0 ? 0 : value;
  206. tabIndex = GetTabIndex (tabIndex);
  207. if (SuperView.tabIndexes.IndexOf (this) != tabIndex) {
  208. SuperView.tabIndexes.Remove (this);
  209. SuperView.tabIndexes.Insert (tabIndex, this);
  210. SetTabIndex ();
  211. }
  212. }
  213. }
  214. private int GetTabIndex (int idx)
  215. {
  216. int i = 0;
  217. foreach (var v in SuperView.tabIndexes) {
  218. if (v.tabIndex == -1 || v == this) {
  219. continue;
  220. }
  221. i++;
  222. }
  223. return Math.Min (i, idx);
  224. }
  225. private void SetTabIndex ()
  226. {
  227. int i = 0;
  228. foreach (var v in SuperView.tabIndexes) {
  229. if (v.tabIndex == -1) {
  230. continue;
  231. }
  232. v.tabIndex = i;
  233. i++;
  234. }
  235. }
  236. bool tabStop = true;
  237. /// <summary>
  238. /// 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>
  239. /// </summary>
  240. public bool TabStop {
  241. get { return tabStop; }
  242. set {
  243. if (tabStop == value) {
  244. return;
  245. }
  246. tabStop = CanFocus && value;
  247. }
  248. }
  249. bool oldCanFocus;
  250. int oldTabIndex;
  251. /// <inheritdoc/>
  252. public override bool CanFocus {
  253. get => base.CanFocus;
  254. set {
  255. if (base.CanFocus != value) {
  256. base.CanFocus = value;
  257. if (!value && tabIndex > -1) {
  258. TabIndex = -1;
  259. }
  260. if (value && SuperView != null && !SuperView.CanFocus) {
  261. SuperView.CanFocus = value;
  262. }
  263. if (value && tabIndex == -1) {
  264. TabIndex = SuperView != null ? SuperView.tabIndexes.IndexOf (this) : -1;
  265. }
  266. TabStop = value;
  267. }
  268. if (subviews != null && IsInitialized) {
  269. foreach (var view in subviews) {
  270. if (view.CanFocus != value) {
  271. if (!value) {
  272. view.oldCanFocus = view.CanFocus;
  273. view.oldTabIndex = view.tabIndex;
  274. view.CanFocus = value;
  275. view.tabIndex = -1;
  276. } else {
  277. view.CanFocus = view.oldCanFocus;
  278. view.tabIndex = view.oldTabIndex;
  279. }
  280. }
  281. }
  282. }
  283. }
  284. }
  285. internal Rect NeedDisplay { get; private set; } = Rect.Empty;
  286. // The frame for the object. Superview relative.
  287. Rect frame;
  288. /// <summary>
  289. /// Gets or sets an identifier for the view;
  290. /// </summary>
  291. /// <value>The identifier.</value>
  292. /// <remarks>The id should be unique across all Views that share a SuperView.</remarks>
  293. public ustring Id { get; set; } = "";
  294. /// <summary>
  295. /// Returns a value indicating if this View is currently on Top (Active)
  296. /// </summary>
  297. public bool IsCurrentTop {
  298. get {
  299. return Application.Current == this;
  300. }
  301. }
  302. /// <summary>
  303. /// Gets or sets a value indicating whether this <see cref="View"/> wants mouse position reports.
  304. /// </summary>
  305. /// <value><c>true</c> if want mouse position reports; otherwise, <c>false</c>.</value>
  306. public virtual bool WantMousePositionReports { get; set; } = false;
  307. /// <summary>
  308. /// Gets or sets a value indicating whether this <see cref="View"/> want continuous button pressed event.
  309. /// </summary>
  310. public virtual bool WantContinuousButtonPressed { get; set; } = false;
  311. /// <summary>
  312. /// Gets or sets the frame for the view. The frame is relative to the view's container (<see cref="SuperView"/>).
  313. /// </summary>
  314. /// <value>The frame.</value>
  315. /// <remarks>
  316. /// <para>
  317. /// Change the Frame when using the <see cref="LayoutStyle.Absolute"/> layout style to move or resize views.
  318. /// </para>
  319. /// <para>
  320. /// Altering the Frame of a view will trigger the redrawing of the
  321. /// view as well as the redrawing of the affected regions of the <see cref="SuperView"/>.
  322. /// </para>
  323. /// </remarks>
  324. public virtual Rect Frame {
  325. get => frame;
  326. set {
  327. if (SuperView != null) {
  328. SuperView.SetNeedsDisplay (frame);
  329. SuperView.SetNeedsDisplay (value);
  330. }
  331. frame = value;
  332. SetNeedsLayout ();
  333. SetNeedsDisplay (frame);
  334. }
  335. }
  336. /// <summary>
  337. /// Gets an enumerator that enumerates the subviews in this view.
  338. /// </summary>
  339. /// <returns>The enumerator.</returns>
  340. public IEnumerator GetEnumerator ()
  341. {
  342. foreach (var v in InternalSubviews)
  343. yield return v;
  344. }
  345. LayoutStyle layoutStyle;
  346. /// <summary>
  347. /// Controls how the View's <see cref="Frame"/> is computed during the LayoutSubviews method, if the style is set to <see cref="LayoutStyle.Absolute"/>,
  348. /// LayoutSubviews does not change the <see cref="Frame"/>. If the style is <see cref="LayoutStyle.Computed"/> the <see cref="Frame"/> is updated using
  349. /// the <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/> properties.
  350. /// </summary>
  351. /// <value>The layout style.</value>
  352. public LayoutStyle LayoutStyle {
  353. get => layoutStyle;
  354. set {
  355. layoutStyle = value;
  356. SetNeedsLayout ();
  357. }
  358. }
  359. /// <summary>
  360. /// The bounds represent the View-relative rectangle used for this view; the area inside of the view.
  361. /// </summary>
  362. /// <value>The bounds.</value>
  363. /// <remarks>
  364. /// <para>
  365. /// Updates to the Bounds update the <see cref="Frame"/>,
  366. /// and has the same side effects as updating the <see cref="Frame"/>.
  367. /// </para>
  368. /// <para>
  369. /// Because <see cref="Bounds"/> coordinates are relative to the upper-left corner of the <see cref="View"/>,
  370. /// the coordinates of the upper-left corner of the rectangle returned by this property are (0,0).
  371. /// Use this property to obtain the size and coordinates of the client area of the
  372. /// control for tasks such as drawing on the surface of the control.
  373. /// </para>
  374. /// </remarks>
  375. public Rect Bounds {
  376. get => new Rect (Point.Empty, Frame.Size);
  377. set {
  378. Frame = new Rect (frame.Location, value.Size);
  379. }
  380. }
  381. Pos x, y;
  382. /// <summary>
  383. /// Gets or sets the X position for the view (the column). Only used whe <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  384. /// </summary>
  385. /// <value>The X Position.</value>
  386. /// <remarks>
  387. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  388. /// </remarks>
  389. public Pos X {
  390. get => x;
  391. set {
  392. if (!ValidatePosDim (x, value)) {
  393. throw new ArgumentException ();
  394. }
  395. x = value;
  396. SetNeedsLayout ();
  397. SetNeedsDisplay (frame);
  398. }
  399. }
  400. /// <summary>
  401. /// Gets or sets the Y position for the view (the row). Only used whe <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  402. /// </summary>
  403. /// <value>The y position (line).</value>
  404. /// <remarks>
  405. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  406. /// </remarks>
  407. public Pos Y {
  408. get => y;
  409. set {
  410. if (!ValidatePosDim (y, value)) {
  411. throw new ArgumentException ();
  412. }
  413. y = value;
  414. SetNeedsLayout ();
  415. SetNeedsDisplay (frame);
  416. }
  417. }
  418. Dim width, height;
  419. /// <summary>
  420. /// Gets or sets the width of the view. Only used whe <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  421. /// </summary>
  422. /// <value>The width.</value>
  423. /// <remarks>
  424. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  425. /// </remarks>
  426. public Dim Width {
  427. get => width;
  428. set {
  429. if (!ValidatePosDim (width, value)) {
  430. throw new ArgumentException ();
  431. }
  432. width = value;
  433. SetNeedsLayout ();
  434. SetNeedsDisplay (frame);
  435. }
  436. }
  437. /// <summary>
  438. /// Gets or sets the height of the view. Only used whe <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  439. /// </summary>
  440. /// <value>The height.</value>
  441. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  442. public Dim Height {
  443. get => height;
  444. set {
  445. if (!ValidatePosDim (height, value)) {
  446. throw new ArgumentException ();
  447. }
  448. height = value;
  449. SetNeedsLayout ();
  450. SetNeedsDisplay (frame);
  451. }
  452. }
  453. bool ValidatePosDim (object oldvalue, object newValue)
  454. {
  455. if (!IsInitialized || layoutStyle == LayoutStyle.Absolute || oldvalue == null || oldvalue.GetType () == newValue.GetType () || this is Toplevel) {
  456. return true;
  457. }
  458. if (layoutStyle == LayoutStyle.Computed) {
  459. if (oldvalue.GetType () != newValue.GetType () && !(newValue is Pos.PosAbsolute || newValue is Dim.DimAbsolute)) {
  460. return true;
  461. }
  462. }
  463. return false;
  464. }
  465. /// <summary>
  466. /// Returns the container for this view, or null if this view has not been added to a container.
  467. /// </summary>
  468. /// <value>The super view.</value>
  469. public View SuperView => container;
  470. /// <summary>
  471. /// Initializes a new instance of a <see cref="LayoutStyle.Absolute"/> <see cref="View"/> class with the absolute
  472. /// dimensions specified in the <c>frame</c> parameter.
  473. /// </summary>
  474. /// <param name="frame">The region covered by this view.</param>
  475. /// <remarks>
  476. /// This constructor intitalize a View with a <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Absolute"/>. Use <see cref="View()"/> to
  477. /// initialize a View with <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Computed"/>
  478. /// </remarks>
  479. public View (Rect frame)
  480. {
  481. textFormatter = new TextFormatter ();
  482. this.Text = ustring.Empty;
  483. this.Frame = frame;
  484. LayoutStyle = LayoutStyle.Absolute;
  485. }
  486. /// <summary>
  487. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Computed"/> layout.
  488. /// </summary>
  489. /// <remarks>
  490. /// <para>
  491. /// 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.
  492. /// The <see cref="Label"/> will be created using <see cref="LayoutStyle.Computed"/>
  493. /// coordinates. The initial size (<see cref="View.Frame"/> will be
  494. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  495. /// </para>
  496. /// <para>
  497. /// If <c>Height</c> is greater than one, word wrapping is provided.
  498. /// </para>
  499. /// <para>
  500. /// This constructor intitalize a View with a <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Computed"/>.
  501. /// 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.
  502. /// </para>
  503. /// </remarks>
  504. public View () : this (text: string.Empty) { }
  505. /// <summary>
  506. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Absolute"/> layout.
  507. /// </summary>
  508. /// <remarks>
  509. /// <para>
  510. /// The <see cref="View"/> will be created at the given
  511. /// coordinates with the given string. The size (<see cref="View.Frame"/> will be
  512. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  513. /// </para>
  514. /// <para>
  515. /// No line wrapping is provided.
  516. /// </para>
  517. /// </remarks>
  518. /// <param name="x">column to locate the Label.</param>
  519. /// <param name="y">row to locate the Label.</param>
  520. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  521. public View (int x, int y, ustring text) : this (TextFormatter.CalcRect (x, y, text), text) { }
  522. /// <summary>
  523. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Absolute"/> layout.
  524. /// </summary>
  525. /// <remarks>
  526. /// <para>
  527. /// The <see cref="View"/> will be created at the given
  528. /// coordinates with the given string. The initial size (<see cref="View.Frame"/> will be
  529. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  530. /// </para>
  531. /// <para>
  532. /// If <c>rect.Height</c> is greater than one, word wrapping is provided.
  533. /// </para>
  534. /// </remarks>
  535. /// <param name="rect">Location.</param>
  536. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  537. public View (Rect rect, ustring text) : this (rect)
  538. {
  539. textFormatter = new TextFormatter ();
  540. this.Text = text;
  541. }
  542. /// <summary>
  543. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Computed"/> layout.
  544. /// </summary>
  545. /// <remarks>
  546. /// <para>
  547. /// The <see cref="View"/> will be created using <see cref="LayoutStyle.Computed"/>
  548. /// coordinates with the given string. The initial size (<see cref="View.Frame"/> will be
  549. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  550. /// </para>
  551. /// <para>
  552. /// If <c>Height</c> is greater than one, word wrapping is provided.
  553. /// </para>
  554. /// </remarks>
  555. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  556. public View (ustring text) : base ()
  557. {
  558. textFormatter = new TextFormatter ();
  559. this.Text = text;
  560. CanFocus = false;
  561. TabIndex = -1;
  562. TabStop = false;
  563. LayoutStyle = LayoutStyle.Computed;
  564. // BUGBUG: CalcRect doesn't account for line wrapping
  565. var r = TextFormatter.CalcRect (0, 0, text);
  566. x = Pos.At (0);
  567. y = Pos.At (0);
  568. Width = r.Width;
  569. Height = r.Height;
  570. }
  571. /// <summary>
  572. /// Sets a flag indicating this view needs to be redisplayed because its state has changed.
  573. /// </summary>
  574. public void SetNeedsDisplay ()
  575. {
  576. SetNeedsDisplay (Bounds);
  577. }
  578. internal bool layoutNeeded = true;
  579. internal void SetNeedsLayout ()
  580. {
  581. if (layoutNeeded)
  582. return;
  583. layoutNeeded = true;
  584. if (SuperView == null)
  585. return;
  586. SuperView.SetNeedsLayout ();
  587. textFormatter.NeedsFormat = true;
  588. }
  589. /// <summary>
  590. /// Flags the view-relative region on this View as needing to be repainted.
  591. /// </summary>
  592. /// <param name="region">The view-relative region that must be flagged for repaint.</param>
  593. public void SetNeedsDisplay (Rect region)
  594. {
  595. if (NeedDisplay == null || NeedDisplay.IsEmpty)
  596. NeedDisplay = region;
  597. else {
  598. var x = Math.Min (NeedDisplay.X, region.X);
  599. var y = Math.Min (NeedDisplay.Y, region.Y);
  600. var w = Math.Max (NeedDisplay.Width, region.Width);
  601. var h = Math.Max (NeedDisplay.Height, region.Height);
  602. NeedDisplay = new Rect (x, y, w, h);
  603. }
  604. if (container != null)
  605. container.ChildNeedsDisplay ();
  606. if (subviews == null)
  607. return;
  608. foreach (var view in subviews)
  609. if (view.Frame.IntersectsWith (region)) {
  610. var childRegion = Rect.Intersect (view.Frame, region);
  611. childRegion.X -= view.Frame.X;
  612. childRegion.Y -= view.Frame.Y;
  613. view.SetNeedsDisplay (childRegion);
  614. }
  615. }
  616. internal bool childNeedsDisplay;
  617. /// <summary>
  618. /// Indicates that any child views (in the <see cref="Subviews"/> list) need to be repainted.
  619. /// </summary>
  620. public void ChildNeedsDisplay ()
  621. {
  622. childNeedsDisplay = true;
  623. if (container != null)
  624. container.ChildNeedsDisplay ();
  625. }
  626. /// <summary>
  627. /// Adds a subview (child) to this view.
  628. /// </summary>
  629. /// <remarks>
  630. /// 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"/>
  631. /// </remarks>
  632. public virtual void Add (View view)
  633. {
  634. if (view == null)
  635. return;
  636. if (subviews == null) {
  637. subviews = new List<View> ();
  638. }
  639. if (tabIndexes == null) {
  640. tabIndexes = new List<View> ();
  641. }
  642. subviews.Add (view);
  643. tabIndexes.Add (view);
  644. view.container = this;
  645. if (view.CanFocus) {
  646. CanFocus = true;
  647. view.tabIndex = tabIndexes.IndexOf (view);
  648. }
  649. SetNeedsLayout ();
  650. SetNeedsDisplay ();
  651. OnAdded (view);
  652. if (IsInitialized) {
  653. view.BeginInit ();
  654. }
  655. }
  656. /// <summary>
  657. /// Adds the specified views (children) to the view.
  658. /// </summary>
  659. /// <param name="views">Array of one or more views (can be optional parameter).</param>
  660. /// <remarks>
  661. /// 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"/>
  662. /// </remarks>
  663. public void Add (params View [] views)
  664. {
  665. if (views == null)
  666. return;
  667. foreach (var view in views)
  668. Add (view);
  669. }
  670. /// <summary>
  671. /// Removes all subviews (children) added via <see cref="Add(View)"/> or <see cref="Add(View[])"/> from this View.
  672. /// </summary>
  673. public virtual void RemoveAll ()
  674. {
  675. if (subviews == null)
  676. return;
  677. while (subviews.Count > 0) {
  678. Remove (subviews [0]);
  679. }
  680. }
  681. /// <summary>
  682. /// Removes a subview added via <see cref="Add(View)"/> or <see cref="Add(View[])"/> from this View.
  683. /// </summary>
  684. /// <remarks>
  685. /// </remarks>
  686. public virtual void Remove (View view)
  687. {
  688. if (view == null || subviews == null)
  689. return;
  690. SetNeedsLayout ();
  691. SetNeedsDisplay ();
  692. var touched = view.Frame;
  693. subviews.Remove (view);
  694. tabIndexes.Remove (view);
  695. view.container = null;
  696. view.tabIndex = -1;
  697. if (subviews.Count < 1) {
  698. CanFocus = false;
  699. }
  700. foreach (var v in subviews) {
  701. if (v.Frame.IntersectsWith (touched))
  702. view.SetNeedsDisplay ();
  703. }
  704. OnRemoved (view);
  705. if (focused == view) {
  706. focused = null;
  707. }
  708. }
  709. void PerformActionForSubview (View subview, Action<View> action)
  710. {
  711. if (subviews.Contains (subview)) {
  712. action (subview);
  713. }
  714. SetNeedsDisplay ();
  715. subview.SetNeedsDisplay ();
  716. }
  717. /// <summary>
  718. /// Brings the specified subview to the front so it is drawn on top of any other views.
  719. /// </summary>
  720. /// <param name="subview">The subview to send to the front</param>
  721. /// <remarks>
  722. /// <seealso cref="SendSubviewToBack"/>.
  723. /// </remarks>
  724. public void BringSubviewToFront (View subview)
  725. {
  726. PerformActionForSubview (subview, x => {
  727. subviews.Remove (x);
  728. subviews.Add (x);
  729. });
  730. }
  731. /// <summary>
  732. /// Sends the specified subview to the front so it is the first view drawn
  733. /// </summary>
  734. /// <param name="subview">The subview to send to the front</param>
  735. /// <remarks>
  736. /// <seealso cref="BringSubviewToFront(View)"/>.
  737. /// </remarks>
  738. public void SendSubviewToBack (View subview)
  739. {
  740. PerformActionForSubview (subview, x => {
  741. subviews.Remove (x);
  742. subviews.Insert (0, subview);
  743. });
  744. }
  745. /// <summary>
  746. /// Moves the subview backwards in the hierarchy, only one step
  747. /// </summary>
  748. /// <param name="subview">The subview to send backwards</param>
  749. /// <remarks>
  750. /// If you want to send the view all the way to the back use SendSubviewToBack.
  751. /// </remarks>
  752. public void SendSubviewBackwards (View subview)
  753. {
  754. PerformActionForSubview (subview, x => {
  755. var idx = subviews.IndexOf (x);
  756. if (idx > 0) {
  757. subviews.Remove (x);
  758. subviews.Insert (idx - 1, x);
  759. }
  760. });
  761. }
  762. /// <summary>
  763. /// Moves the subview backwards in the hierarchy, only one step
  764. /// </summary>
  765. /// <param name="subview">The subview to send backwards</param>
  766. /// <remarks>
  767. /// If you want to send the view all the way to the back use SendSubviewToBack.
  768. /// </remarks>
  769. public void BringSubviewForward (View subview)
  770. {
  771. PerformActionForSubview (subview, x => {
  772. var idx = subviews.IndexOf (x);
  773. if (idx + 1 < subviews.Count) {
  774. subviews.Remove (x);
  775. subviews.Insert (idx + 1, x);
  776. }
  777. });
  778. }
  779. /// <summary>
  780. /// Clears the view region with the current color.
  781. /// </summary>
  782. /// <remarks>
  783. /// <para>
  784. /// This clears the entire region used by this view.
  785. /// </para>
  786. /// </remarks>
  787. public void Clear ()
  788. {
  789. var h = Frame.Height;
  790. var w = Frame.Width;
  791. for (int line = 0; line < h; line++) {
  792. Move (0, line);
  793. for (int col = 0; col < w; col++)
  794. Driver.AddRune (' ');
  795. }
  796. }
  797. /// <summary>
  798. /// Clears the specified region with the current color.
  799. /// </summary>
  800. /// <remarks>
  801. /// </remarks>
  802. /// <param name="regionScreen">The screen-relative region to clear.</param>
  803. public void Clear (Rect regionScreen)
  804. {
  805. var h = regionScreen.Height;
  806. var w = regionScreen.Width;
  807. for (int line = regionScreen.Y; line < regionScreen.Y + h; line++) {
  808. Driver.Move (regionScreen.X, line);
  809. for (int col = 0; col < w; col++)
  810. Driver.AddRune (' ');
  811. }
  812. }
  813. /// <summary>
  814. /// Converts a view-relative (col,row) position to a screen-relative position (col,row). The values are optionally clamped to the screen dimensions.
  815. /// </summary>
  816. /// <param name="col">View-relative column.</param>
  817. /// <param name="row">View-relative row.</param>
  818. /// <param name="rcol">Absolute column; screen-relative.</param>
  819. /// <param name="rrow">Absolute row; screen-relative.</param>
  820. /// <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>
  821. internal void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true)
  822. {
  823. // Computes the real row, col relative to the screen.
  824. rrow = row + frame.Y;
  825. rcol = col + frame.X;
  826. var ccontainer = container;
  827. while (ccontainer != null) {
  828. rrow += ccontainer.frame.Y;
  829. rcol += ccontainer.frame.X;
  830. ccontainer = ccontainer.container;
  831. }
  832. // The following ensures that the cursor is always in the screen boundaries.
  833. if (clipped) {
  834. rrow = Math.Min (rrow, Driver.Rows - 1);
  835. rcol = Math.Min (rcol, Driver.Cols - 1);
  836. }
  837. }
  838. /// <summary>
  839. /// Converts a point from screen-relative coordinates to view-relative coordinates.
  840. /// </summary>
  841. /// <returns>The mapped point.</returns>
  842. /// <param name="x">X screen-coordinate point.</param>
  843. /// <param name="y">Y screen-coordinate point.</param>
  844. public Point ScreenToView (int x, int y)
  845. {
  846. if (SuperView == null) {
  847. return new Point (x - Frame.X, y - frame.Y);
  848. } else {
  849. var parent = SuperView.ScreenToView (x, y);
  850. return new Point (parent.X - frame.X, parent.Y - frame.Y);
  851. }
  852. }
  853. /// <summary>
  854. /// Converts a region in view-relative coordinates to screen-relative coordinates.
  855. /// </summary>
  856. internal Rect ViewToScreen (Rect region)
  857. {
  858. ViewToScreen (region.X, region.Y, out var x, out var y, clipped: false);
  859. return new Rect (x, y, region.Width, region.Height);
  860. }
  861. // Clips a rectangle in screen coordinates to the dimensions currently available on the screen
  862. internal Rect ScreenClip (Rect regionScreen)
  863. {
  864. var x = regionScreen.X < 0 ? 0 : regionScreen.X;
  865. var y = regionScreen.Y < 0 ? 0 : regionScreen.Y;
  866. var w = regionScreen.X + regionScreen.Width >= Driver.Cols ? Driver.Cols - regionScreen.X : regionScreen.Width;
  867. var h = regionScreen.Y + regionScreen.Height >= Driver.Rows ? Driver.Rows - regionScreen.Y : regionScreen.Height;
  868. return new Rect (x, y, w, h);
  869. }
  870. /// <summary>
  871. /// Sets the <see cref="ConsoleDriver"/>'s clip region to the current View's <see cref="Bounds"/>.
  872. /// </summary>
  873. /// <returns>The existing driver's clip region, which can be then re-eapplied by setting <c><see cref="Driver"/>.Clip</c> (<see cref="ConsoleDriver.Clip"/>).</returns>
  874. /// <remarks>
  875. /// <see cref="Bounds"/> is View-relative.
  876. /// </remarks>
  877. public Rect ClipToBounds ()
  878. {
  879. return SetClip (Bounds);
  880. }
  881. /// <summary>
  882. /// Sets the clip region to the specified view-relative region.
  883. /// </summary>
  884. /// <returns>The previous screen-relative clip region.</returns>
  885. /// <param name="region">View-relative clip region.</param>
  886. public Rect SetClip (Rect region)
  887. {
  888. var previous = Driver.Clip;
  889. Driver.Clip = Rect.Intersect (previous, ViewToScreen (region));
  890. return previous;
  891. }
  892. /// <summary>
  893. /// Draws a frame in the current view, clipped by the boundary of this view
  894. /// </summary>
  895. /// <param name="region">View-relative region for the frame to be drawn.</param>
  896. /// <param name="padding">The padding to add around the outside of the drawn frame.</param>
  897. /// <param name="fill">If set to <c>true</c> it fill will the contents.</param>
  898. public void DrawFrame (Rect region, int padding = 0, bool fill = false)
  899. {
  900. var scrRect = ViewToScreen (region);
  901. var savedClip = ClipToBounds ();
  902. Driver.DrawWindowFrame (scrRect, padding + 1, padding + 1, padding + 1, padding + 1, border: true, fill: fill);
  903. Driver.Clip = savedClip;
  904. }
  905. /// <summary>
  906. /// Utility function to draw strings that contain a hotkey.
  907. /// </summary>
  908. /// <param name="text">String to display, the hotkey specifier before a letter flags the next letter as the hotkey.</param>
  909. /// <param name="hotColor">Hot color.</param>
  910. /// <param name="normalColor">Normal color.</param>
  911. /// <remarks>
  912. /// <para>The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default.</para>
  913. /// <para>The hotkey specifier can be changed via <see cref="HotKeySpecifier"/></para>
  914. /// </remarks>
  915. public void DrawHotString (ustring text, Attribute hotColor, Attribute normalColor)
  916. {
  917. var hotkeySpec = HotKeySpecifier == (Rune)0xffff ? (Rune)'_' : HotKeySpecifier;
  918. Application.Driver.SetAttribute (normalColor);
  919. foreach (var rune in text) {
  920. if (rune == hotkeySpec) {
  921. Application.Driver.SetAttribute (hotColor);
  922. continue;
  923. }
  924. Application.Driver.AddRune (rune);
  925. Application.Driver.SetAttribute (normalColor);
  926. }
  927. }
  928. /// <summary>
  929. /// Utility function to draw strings that contains a hotkey using a <see cref="ColorScheme"/> and the "focused" state.
  930. /// </summary>
  931. /// <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
  932. /// <param name="focused">If set to <c>true</c> this uses the focused colors from the color scheme, otherwise the regular ones.</param>
  933. /// <param name="scheme">The color scheme to use.</param>
  934. public void DrawHotString (ustring text, bool focused, ColorScheme scheme)
  935. {
  936. if (focused)
  937. DrawHotString (text, scheme.HotFocus, scheme.Focus);
  938. else
  939. DrawHotString (text, scheme.HotNormal, scheme.Normal);
  940. }
  941. /// <summary>
  942. /// This moves the cursor to the specified column and row in the view.
  943. /// </summary>
  944. /// <returns>The move.</returns>
  945. /// <param name="col">Col.</param>
  946. /// <param name="row">Row.</param>
  947. public void Move (int col, int row)
  948. {
  949. ViewToScreen (col, row, out var rcol, out var rrow);
  950. Driver.Move (rcol, rrow);
  951. }
  952. /// <summary>
  953. /// Positions the cursor in the right position based on the currently focused view in the chain.
  954. /// </summary>
  955. /// Views that are focusable should override <see cref="PositionCursor"/> to ensure
  956. /// the cursor is placed in a location that makes sense. Unix terminals do not have
  957. /// a way of hiding the cursor, so it can be distracting to have the cursor left at
  958. /// the last focused view. Views should make sure that they place the cursor
  959. /// in a visually sensible place.
  960. public virtual void PositionCursor ()
  961. {
  962. if (focused != null)
  963. focused.PositionCursor ();
  964. else {
  965. if (CanFocus && HasFocus) {
  966. Move (textFormatter.HotKeyPos == -1 ? 0 : textFormatter.HotKeyPos, 0);
  967. } else {
  968. Move (frame.X, frame.Y);
  969. }
  970. }
  971. }
  972. bool hasFocus;
  973. /// <inheritdoc/>
  974. public override bool HasFocus {
  975. get {
  976. return hasFocus;
  977. }
  978. }
  979. void SetHasFocus (bool value, View view)
  980. {
  981. if (hasFocus != value) {
  982. hasFocus = value;
  983. }
  984. if (value) {
  985. OnEnter (view);
  986. } else {
  987. OnLeave (view);
  988. }
  989. SetNeedsDisplay ();
  990. // Remove focus down the chain of subviews if focus is removed
  991. if (!value && focused != null) {
  992. focused.OnLeave (view);
  993. focused.SetHasFocus (false, view);
  994. focused = null;
  995. }
  996. }
  997. /// <summary>
  998. /// Defines the event arguments for <see cref="SetFocus(View)"/>
  999. /// </summary>
  1000. public class FocusEventArgs : EventArgs {
  1001. /// <summary>
  1002. /// Constructs.
  1003. /// </summary>
  1004. /// <param name="view">The view that gets or loses focus.</param>
  1005. public FocusEventArgs (View view) { View = view; }
  1006. /// <summary>
  1007. /// Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber.
  1008. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1009. /// </summary>
  1010. public bool Handled { get; set; }
  1011. /// <summary>
  1012. /// Indicates the current view that gets or loses focus.
  1013. /// </summary>
  1014. public View View { get; set; }
  1015. }
  1016. /// <summary>
  1017. /// Method invoked when a subview is being added to this view.
  1018. /// </summary>
  1019. /// <param name="view">The subview being added.</param>
  1020. public virtual void OnAdded (View view)
  1021. {
  1022. view.Added?.Invoke (this);
  1023. }
  1024. /// <summary>
  1025. /// Method invoked when a subview is being removed from this view.
  1026. /// </summary>
  1027. /// <param name="view">The subview being removed.</param>
  1028. public virtual void OnRemoved (View view)
  1029. {
  1030. view.Removed?.Invoke (this);
  1031. }
  1032. /// <inheritdoc/>
  1033. public override bool OnEnter (View view)
  1034. {
  1035. FocusEventArgs args = new FocusEventArgs (view);
  1036. Enter?.Invoke (args);
  1037. if (args.Handled)
  1038. return true;
  1039. if (base.OnEnter (view))
  1040. return true;
  1041. return false;
  1042. }
  1043. /// <inheritdoc/>
  1044. public override bool OnLeave (View view)
  1045. {
  1046. FocusEventArgs args = new FocusEventArgs (view);
  1047. Leave?.Invoke (args);
  1048. if (args.Handled)
  1049. return true;
  1050. if (base.OnLeave (view))
  1051. return true;
  1052. return false;
  1053. }
  1054. /// <summary>
  1055. /// Returns the currently focused view inside this view, or null if nothing is focused.
  1056. /// </summary>
  1057. /// <value>The focused.</value>
  1058. public View Focused => focused;
  1059. /// <summary>
  1060. /// Returns the most focused view in the chain of subviews (the leaf view that has the focus).
  1061. /// </summary>
  1062. /// <value>The most focused.</value>
  1063. public View MostFocused {
  1064. get {
  1065. if (Focused == null)
  1066. return null;
  1067. var most = Focused.MostFocused;
  1068. if (most != null)
  1069. return most;
  1070. return Focused;
  1071. }
  1072. }
  1073. /// <summary>
  1074. /// The color scheme for this view, if it is not defined, it returns the <see cref="SuperView"/>'s
  1075. /// color scheme.
  1076. /// </summary>
  1077. public ColorScheme ColorScheme {
  1078. get {
  1079. if (colorScheme == null)
  1080. return SuperView?.ColorScheme;
  1081. return colorScheme;
  1082. }
  1083. set {
  1084. colorScheme = value;
  1085. }
  1086. }
  1087. ColorScheme colorScheme;
  1088. /// <summary>
  1089. /// Displays the specified character in the specified column and row of the View.
  1090. /// </summary>
  1091. /// <param name="col">Column (view-relative).</param>
  1092. /// <param name="row">Row (view-relative).</param>
  1093. /// <param name="ch">Ch.</param>
  1094. public void AddRune (int col, int row, Rune ch)
  1095. {
  1096. if (row < 0 || col < 0)
  1097. return;
  1098. if (row > frame.Height - 1 || col > frame.Width - 1)
  1099. return;
  1100. Move (col, row);
  1101. Driver.AddRune (ch);
  1102. }
  1103. /// <summary>
  1104. /// Removes the <see cref="SetNeedsDisplay()"/> and the <see cref="ChildNeedsDisplay"/> setting on this view.
  1105. /// </summary>
  1106. protected void ClearNeedsDisplay ()
  1107. {
  1108. NeedDisplay = Rect.Empty;
  1109. childNeedsDisplay = false;
  1110. }
  1111. /// <summary>
  1112. /// Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1113. /// </summary>
  1114. /// <param name="bounds">The bounds (view-relative region) to redraw.</param>
  1115. /// <remarks>
  1116. /// <para>
  1117. /// Always use <see cref="Bounds"/> (view-relative) when calling <see cref="Redraw(Rect)"/>, NOT <see cref="Frame"/> (superview-relative).
  1118. /// </para>
  1119. /// <para>
  1120. /// Views should set the color that they want to use on entry, as otherwise this will inherit
  1121. /// the last color that was set globaly on the driver.
  1122. /// </para>
  1123. /// <para>
  1124. /// Overrides of <see cref="Redraw"/> must ensure they do not set <c>Driver.Clip</c> to a clip region
  1125. /// larger than the <c>region</c> parameter.
  1126. /// </para>
  1127. /// </remarks>
  1128. public virtual void Redraw (Rect bounds)
  1129. {
  1130. var clipRect = new Rect (Point.Empty, frame.Size);
  1131. if (ColorScheme != null)
  1132. Driver.SetAttribute (HasFocus ? ColorScheme.Focus : ColorScheme.Normal);
  1133. if (!ustring.IsNullOrEmpty (Text)) {
  1134. Clear ();
  1135. // Draw any Text
  1136. if (textFormatter != null) {
  1137. textFormatter.NeedsFormat = true;
  1138. }
  1139. textFormatter?.Draw (ViewToScreen (Bounds), HasFocus ? ColorScheme.Focus : ColorScheme.Normal, HasFocus ? ColorScheme.HotFocus : ColorScheme.HotNormal);
  1140. }
  1141. // Invoke DrawContentEvent
  1142. OnDrawContent (bounds);
  1143. if (subviews != null) {
  1144. foreach (var view in subviews) {
  1145. if (view.NeedDisplay != null && (!view.NeedDisplay.IsEmpty || view.childNeedsDisplay)) {
  1146. if (view.Frame.IntersectsWith (clipRect) && (view.Frame.IntersectsWith (bounds) || bounds.X < 0 || bounds.Y < 0)) {
  1147. if (view.layoutNeeded)
  1148. view.LayoutSubviews ();
  1149. Application.CurrentView = view;
  1150. // Draw the subview
  1151. // Use the view's bounds (view-relative; Location will always be (0,0) because
  1152. view.Redraw (view.Bounds);
  1153. }
  1154. view.NeedDisplay = Rect.Empty;
  1155. view.childNeedsDisplay = false;
  1156. }
  1157. }
  1158. }
  1159. ClearNeedsDisplay ();
  1160. }
  1161. /// <summary>
  1162. /// Event invoked when the content area of the View is to be drawn.
  1163. /// </summary>
  1164. /// <remarks>
  1165. /// <para>
  1166. /// Will be invoked before any subviews added with <see cref="Add(View)"/> have been drawn.
  1167. /// </para>
  1168. /// <para>
  1169. /// Rect provides the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.
  1170. /// </para>
  1171. /// </remarks>
  1172. public Action<Rect> DrawContent;
  1173. /// <summary>
  1174. /// Enables overrides to draw infinitely scrolled content and/or a background behind added controls.
  1175. /// </summary>
  1176. /// <param name="viewport">The view-relative rectangle describing the currently visible viewport into the <see cref="View"/></param>
  1177. /// <remarks>
  1178. /// This method will be called before any subviews added with <see cref="Add(View)"/> have been drawn.
  1179. /// </remarks>
  1180. public virtual void OnDrawContent (Rect viewport)
  1181. {
  1182. DrawContent?.Invoke (viewport);
  1183. }
  1184. /// <summary>
  1185. /// Causes the specified subview to have focus.
  1186. /// </summary>
  1187. /// <param name="view">View.</param>
  1188. public void SetFocus (View view)
  1189. {
  1190. if (view == null)
  1191. return;
  1192. //Console.WriteLine ($"Request to focus {view}");
  1193. if (!view.CanFocus)
  1194. return;
  1195. if (focused == view)
  1196. return;
  1197. // Make sure that this view is a subview
  1198. View c;
  1199. for (c = view.container; c != null; c = c.container)
  1200. if (c == this)
  1201. break;
  1202. if (c == null)
  1203. throw new ArgumentException ("the specified view is not part of the hierarchy of this view");
  1204. if (focused != null)
  1205. focused.SetHasFocus (false, view);
  1206. var f = focused;
  1207. focused = view;
  1208. focused.SetHasFocus (true, f);
  1209. focused.EnsureFocus ();
  1210. // Send focus upwards
  1211. SuperView?.SetFocus (this);
  1212. }
  1213. /// <summary>
  1214. /// Defines the event arguments for <see cref="KeyEvent"/>
  1215. /// </summary>
  1216. public class KeyEventEventArgs : EventArgs {
  1217. /// <summary>
  1218. /// Constructs.
  1219. /// </summary>
  1220. /// <param name="ke"></param>
  1221. public KeyEventEventArgs (KeyEvent ke) => KeyEvent = ke;
  1222. /// <summary>
  1223. /// The <see cref="KeyEvent"/> for the event.
  1224. /// </summary>
  1225. public KeyEvent KeyEvent { get; set; }
  1226. /// <summary>
  1227. /// Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber.
  1228. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1229. /// </summary>
  1230. public bool Handled { get; set; } = false;
  1231. }
  1232. /// <summary>
  1233. /// Invoked when a character key is pressed and occurs after the key up event.
  1234. /// </summary>
  1235. public Action<KeyEventEventArgs> KeyPress;
  1236. /// <inheritdoc/>
  1237. public override bool ProcessKey (KeyEvent keyEvent)
  1238. {
  1239. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1240. KeyPress?.Invoke (args);
  1241. if (args.Handled)
  1242. return true;
  1243. if (Focused?.ProcessKey (keyEvent) == true)
  1244. return true;
  1245. return false;
  1246. }
  1247. /// <inheritdoc/>
  1248. public override bool ProcessHotKey (KeyEvent keyEvent)
  1249. {
  1250. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1251. KeyPress?.Invoke (args);
  1252. if (args.Handled)
  1253. return true;
  1254. if (subviews == null || subviews.Count == 0)
  1255. return false;
  1256. foreach (var view in subviews)
  1257. if (view.ProcessHotKey (keyEvent))
  1258. return true;
  1259. return false;
  1260. }
  1261. /// <inheritdoc/>
  1262. public override bool ProcessColdKey (KeyEvent keyEvent)
  1263. {
  1264. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1265. KeyPress?.Invoke (args);
  1266. if (args.Handled)
  1267. return true;
  1268. if (subviews == null || subviews.Count == 0)
  1269. return false;
  1270. foreach (var view in subviews)
  1271. if (view.ProcessColdKey (keyEvent))
  1272. return true;
  1273. return false;
  1274. }
  1275. /// <summary>
  1276. /// Invoked when a key is pressed
  1277. /// </summary>
  1278. public Action<KeyEventEventArgs> KeyDown;
  1279. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  1280. public override bool OnKeyDown (KeyEvent keyEvent)
  1281. {
  1282. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1283. KeyDown?.Invoke (args);
  1284. if (args.Handled) {
  1285. return true;
  1286. }
  1287. if (Focused?.OnKeyDown (keyEvent) == true) {
  1288. return true;
  1289. }
  1290. return false;
  1291. }
  1292. /// <summary>
  1293. /// Invoked when a key is released
  1294. /// </summary>
  1295. public Action<KeyEventEventArgs> KeyUp;
  1296. /// <param name="keyEvent">Contains the details about the key that produced the event.</param>
  1297. public override bool OnKeyUp (KeyEvent keyEvent)
  1298. {
  1299. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1300. KeyUp?.Invoke (args);
  1301. if (args.Handled) {
  1302. return true;
  1303. }
  1304. if (Focused?.OnKeyUp (keyEvent) == true) {
  1305. return true;
  1306. }
  1307. return false;
  1308. }
  1309. /// <summary>
  1310. /// Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
  1311. /// </summary>
  1312. public void EnsureFocus ()
  1313. {
  1314. if (focused == null)
  1315. if (FocusDirection == Direction.Forward)
  1316. FocusFirst ();
  1317. else
  1318. FocusLast ();
  1319. }
  1320. /// <summary>
  1321. /// Focuses the first focusable subview if one exists.
  1322. /// </summary>
  1323. public void FocusFirst ()
  1324. {
  1325. if (tabIndexes == null) {
  1326. SuperView?.SetFocus (this);
  1327. return;
  1328. }
  1329. foreach (var view in tabIndexes) {
  1330. if (view.CanFocus && view.tabStop) {
  1331. SetFocus (view);
  1332. return;
  1333. }
  1334. }
  1335. }
  1336. /// <summary>
  1337. /// Focuses the last focusable subview if one exists.
  1338. /// </summary>
  1339. public void FocusLast ()
  1340. {
  1341. if (tabIndexes == null) {
  1342. SuperView?.SetFocus (this);
  1343. return;
  1344. }
  1345. for (int i = tabIndexes.Count; i > 0;) {
  1346. i--;
  1347. View v = tabIndexes [i];
  1348. if (v.CanFocus && v.tabStop) {
  1349. SetFocus (v);
  1350. return;
  1351. }
  1352. }
  1353. }
  1354. /// <summary>
  1355. /// Focuses the previous view.
  1356. /// </summary>
  1357. /// <returns><c>true</c>, if previous was focused, <c>false</c> otherwise.</returns>
  1358. public bool FocusPrev ()
  1359. {
  1360. FocusDirection = Direction.Backward;
  1361. if (tabIndexes == null || tabIndexes.Count == 0)
  1362. return false;
  1363. if (focused == null) {
  1364. FocusLast ();
  1365. return focused != null;
  1366. }
  1367. int focused_idx = -1;
  1368. for (int i = tabIndexes.Count; i > 0;) {
  1369. i--;
  1370. View w = tabIndexes [i];
  1371. if (w.HasFocus) {
  1372. if (w.FocusPrev ())
  1373. return true;
  1374. focused_idx = i;
  1375. continue;
  1376. }
  1377. if (w.CanFocus && focused_idx != -1 && w.tabStop) {
  1378. focused.SetHasFocus (false, w);
  1379. if (w != null && w.CanFocus && w.tabStop)
  1380. w.FocusLast ();
  1381. SetFocus (w);
  1382. return true;
  1383. }
  1384. }
  1385. if (focused != null) {
  1386. focused.SetHasFocus (false, this);
  1387. focused = null;
  1388. }
  1389. return false;
  1390. }
  1391. /// <summary>
  1392. /// Focuses the next view.
  1393. /// </summary>
  1394. /// <returns><c>true</c>, if next was focused, <c>false</c> otherwise.</returns>
  1395. public bool FocusNext ()
  1396. {
  1397. FocusDirection = Direction.Forward;
  1398. if (tabIndexes == null || tabIndexes.Count == 0)
  1399. return false;
  1400. if (focused == null) {
  1401. FocusFirst ();
  1402. return focused != null;
  1403. }
  1404. int n = tabIndexes.Count;
  1405. int focused_idx = -1;
  1406. for (int i = 0; i < n; i++) {
  1407. View w = tabIndexes [i];
  1408. if (w.HasFocus) {
  1409. if (w.FocusNext ())
  1410. return true;
  1411. focused_idx = i;
  1412. continue;
  1413. }
  1414. if (w.CanFocus && focused_idx != -1 && w.tabStop) {
  1415. focused.SetHasFocus (false, w);
  1416. if (w != null && w.CanFocus && w.tabStop)
  1417. w.FocusFirst ();
  1418. SetFocus (w);
  1419. return true;
  1420. }
  1421. }
  1422. if (focused != null) {
  1423. focused.SetHasFocus (false, this);
  1424. focused = null;
  1425. }
  1426. return false;
  1427. }
  1428. /// <summary>
  1429. /// Sets the View's <see cref="Frame"/> to the relative coordinates if its container, given the <see cref="Frame"/> for its container.
  1430. /// </summary>
  1431. /// <param name="hostFrame">The screen-relative frame for the host.</param>
  1432. /// <remarks>
  1433. /// Reminder: <see cref="Frame"/> is superview-relative; <see cref="Bounds"/> is view-relative.
  1434. /// </remarks>
  1435. internal void SetRelativeLayout (Rect hostFrame)
  1436. {
  1437. int w, h, _x, _y;
  1438. if (x is Pos.PosCenter) {
  1439. if (width == null)
  1440. w = hostFrame.Width;
  1441. else
  1442. w = width.Anchor (hostFrame.Width);
  1443. _x = x.Anchor (hostFrame.Width - w);
  1444. } else {
  1445. if (x == null)
  1446. _x = 0;
  1447. else
  1448. _x = x.Anchor (hostFrame.Width);
  1449. if (width == null)
  1450. w = hostFrame.Width;
  1451. else if (width is Dim.DimFactor && !((Dim.DimFactor)width).IsFromRemaining ())
  1452. w = width.Anchor (hostFrame.Width);
  1453. else
  1454. w = Math.Max (width.Anchor (hostFrame.Width - _x), 0);
  1455. }
  1456. if (y is Pos.PosCenter) {
  1457. if (height == null)
  1458. h = hostFrame.Height;
  1459. else
  1460. h = height.Anchor (hostFrame.Height);
  1461. _y = y.Anchor (hostFrame.Height - h);
  1462. } else {
  1463. if (y == null)
  1464. _y = 0;
  1465. else
  1466. _y = y.Anchor (hostFrame.Height);
  1467. if (height == null)
  1468. h = hostFrame.Height;
  1469. else if (height is Dim.DimFactor && !((Dim.DimFactor)height).IsFromRemaining ())
  1470. h = height.Anchor (hostFrame.Height);
  1471. else
  1472. h = Math.Max (height.Anchor (hostFrame.Height - _y), 0);
  1473. }
  1474. Frame = new Rect (_x, _y, w, h);
  1475. }
  1476. // https://en.wikipedia.org/wiki/Topological_sorting
  1477. List<View> TopologicalSort (HashSet<View> nodes, HashSet<(View From, View To)> edges)
  1478. {
  1479. var result = new List<View> ();
  1480. // Set of all nodes with no incoming edges
  1481. var S = new HashSet<View> (nodes.Where (n => edges.All (e => e.To.Equals (n) == false)));
  1482. while (S.Any ()) {
  1483. // remove a node n from S
  1484. var n = S.First ();
  1485. S.Remove (n);
  1486. // add n to tail of L
  1487. if (n != this?.SuperView)
  1488. result.Add (n);
  1489. // for each node m with an edge e from n to m do
  1490. foreach (var e in edges.Where (e => e.From.Equals (n)).ToArray ()) {
  1491. var m = e.To;
  1492. // remove edge e from the graph
  1493. edges.Remove (e);
  1494. // if m has no other incoming edges then
  1495. if (edges.All (me => me.To.Equals (m) == false) && m != this?.SuperView) {
  1496. // insert m into S
  1497. S.Add (m);
  1498. }
  1499. }
  1500. }
  1501. if (edges.Any ()) {
  1502. if (!object.ReferenceEquals (edges.First ().From, edges.First ().To)) {
  1503. throw new InvalidOperationException ($"TopologicalSort (for Pos/Dim) cannot find {edges.First ().From}. Did you forget to add it to {this}?");
  1504. } else {
  1505. throw new InvalidOperationException ("TopologicalSort encountered a recursive cycle in the relative Pos/Dim in the views of " + this);
  1506. }
  1507. } else {
  1508. // return L (a topologically sorted order)
  1509. return result;
  1510. }
  1511. }
  1512. /// <summary>
  1513. /// Event arguments for the <see cref="LayoutComplete"/> event.
  1514. /// </summary>
  1515. public class LayoutEventArgs : EventArgs {
  1516. /// <summary>
  1517. /// The view-relative bounds of the <see cref="View"/> before it was laid out.
  1518. /// </summary>
  1519. public Rect OldBounds { get; set; }
  1520. }
  1521. /// <summary>
  1522. /// Fired after the Views's <see cref="LayoutSubviews"/> method has completed.
  1523. /// </summary>
  1524. /// <remarks>
  1525. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  1526. /// </remarks>
  1527. public Action<LayoutEventArgs> LayoutStarted;
  1528. /// <summary>
  1529. /// Raises the <see cref="LayoutStarted"/> event. Called from <see cref="LayoutSubviews"/> before any subviews have been laid out.
  1530. /// </summary>
  1531. internal virtual void OnLayoutStarted (LayoutEventArgs args)
  1532. {
  1533. LayoutStarted?.Invoke (args);
  1534. }
  1535. /// <summary>
  1536. /// Fired after the Views's <see cref="LayoutSubviews"/> method has completed.
  1537. /// </summary>
  1538. /// <remarks>
  1539. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  1540. /// </remarks>
  1541. public Action<LayoutEventArgs> LayoutComplete;
  1542. /// <summary>
  1543. /// Event called only once when the <see cref="View"/> is being initialized for the first time.
  1544. /// Allows configurations and assignments to be performed before the <see cref="View"/> being shown.
  1545. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  1546. /// </summary>
  1547. public event EventHandler Initialized;
  1548. /// <summary>
  1549. /// Raises the <see cref="LayoutComplete"/> event. Called from <see cref="LayoutSubviews"/> before all sub-views have been laid out.
  1550. /// </summary>
  1551. internal virtual void OnLayoutComplete (LayoutEventArgs args)
  1552. {
  1553. LayoutComplete?.Invoke (args);
  1554. }
  1555. /// <summary>
  1556. /// Invoked when a view starts executing or when the dimensions of the view have changed, for example in
  1557. /// response to the container view or terminal resizing.
  1558. /// </summary>
  1559. /// <remarks>
  1560. /// Calls <see cref="OnLayoutComplete"/> (which raises the <see cref="LayoutComplete"/> event) before it returns.
  1561. /// </remarks>
  1562. public virtual void LayoutSubviews ()
  1563. {
  1564. if (!layoutNeeded) {
  1565. return;
  1566. }
  1567. Rect oldBounds = Bounds;
  1568. OnLayoutStarted (new LayoutEventArgs () { OldBounds = oldBounds });
  1569. textFormatter.Size = Bounds.Size;
  1570. // Sort out the dependencies of the X, Y, Width, Height properties
  1571. var nodes = new HashSet<View> ();
  1572. var edges = new HashSet<(View, View)> ();
  1573. foreach (var v in InternalSubviews) {
  1574. nodes.Add (v);
  1575. if (v.LayoutStyle == LayoutStyle.Computed) {
  1576. if (v.X is Pos.PosView vX)
  1577. edges.Add ((vX.Target, v));
  1578. if (v.Y is Pos.PosView vY)
  1579. edges.Add ((vY.Target, v));
  1580. if (v.Width is Dim.DimView vWidth)
  1581. edges.Add ((vWidth.Target, v));
  1582. if (v.Height is Dim.DimView vHeight)
  1583. edges.Add ((vHeight.Target, v));
  1584. }
  1585. }
  1586. var ordered = TopologicalSort (nodes, edges);
  1587. foreach (var v in ordered) {
  1588. if (v.LayoutStyle == LayoutStyle.Computed) {
  1589. v.SetRelativeLayout (Frame);
  1590. }
  1591. v.LayoutSubviews ();
  1592. v.layoutNeeded = false;
  1593. }
  1594. if (SuperView == Application.Top && layoutNeeded && ordered.Count == 0 && LayoutStyle == LayoutStyle.Computed) {
  1595. SetRelativeLayout (Frame);
  1596. }
  1597. layoutNeeded = false;
  1598. OnLayoutComplete (new LayoutEventArgs () { OldBounds = oldBounds });
  1599. }
  1600. /// <summary>
  1601. /// The text displayed by the <see cref="View"/>.
  1602. /// </summary>
  1603. /// <remarks>
  1604. /// <para>
  1605. /// If provided, the text will be drawn before any subviews are drawn.
  1606. /// </para>
  1607. /// <para>
  1608. /// The text will be drawn starting at the view origin (0, 0) and will be formatted according
  1609. /// to the <see cref="TextAlignment"/> property. If the view's height is greater than 1, the
  1610. /// text will word-wrap to additional lines if it does not fit horizontally. If the view's height
  1611. /// is 1, the text will be clipped.
  1612. /// </para>
  1613. /// <para>
  1614. /// Set the <see cref="HotKeySpecifier"/> to enable hotkey support. To disable hotkey support set <see cref="HotKeySpecifier"/> to
  1615. /// <c>(Rune)0xffff</c>.
  1616. /// </para>
  1617. /// </remarks>
  1618. public virtual ustring Text {
  1619. get => textFormatter.Text;
  1620. set {
  1621. textFormatter.Text = value;
  1622. SetNeedsDisplay ();
  1623. }
  1624. }
  1625. /// <summary>
  1626. /// Gets or sets how the View's <see cref="Text"/> is aligned horizontally when drawn. Changing this property will redisplay the <see cref="View"/>.
  1627. /// </summary>
  1628. /// <value>The text alignment.</value>
  1629. public virtual TextAlignment TextAlignment {
  1630. get => textFormatter.Alignment;
  1631. set {
  1632. textFormatter.Alignment = value;
  1633. SetNeedsDisplay ();
  1634. }
  1635. }
  1636. /// <summary>
  1637. /// Get or sets if the <see cref="View"/> was already initialized.
  1638. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  1639. /// </summary>
  1640. public bool IsInitialized { get; set; }
  1641. /// <summary>
  1642. /// Pretty prints the View
  1643. /// </summary>
  1644. /// <returns></returns>
  1645. public override string ToString ()
  1646. {
  1647. return $"{GetType ().Name}({Id})({Frame})";
  1648. }
  1649. /// <summary>
  1650. /// Specifies the event arguments for <see cref="MouseEvent"/>
  1651. /// </summary>
  1652. public class MouseEventArgs : EventArgs {
  1653. /// <summary>
  1654. /// Constructs.
  1655. /// </summary>
  1656. /// <param name="me"></param>
  1657. public MouseEventArgs (MouseEvent me) => MouseEvent = me;
  1658. /// <summary>
  1659. /// The <see cref="MouseEvent"/> for the event.
  1660. /// </summary>
  1661. public MouseEvent MouseEvent { get; set; }
  1662. /// <summary>
  1663. /// Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.
  1664. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1665. /// </summary>
  1666. public bool Handled { get; set; }
  1667. }
  1668. /// <inheritdoc/>
  1669. public override bool OnMouseEnter (MouseEvent mouseEvent)
  1670. {
  1671. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  1672. MouseEnter?.Invoke (args);
  1673. if (args.Handled)
  1674. return true;
  1675. if (base.OnMouseEnter (mouseEvent))
  1676. return true;
  1677. return false;
  1678. }
  1679. /// <inheritdoc/>
  1680. public override bool OnMouseLeave (MouseEvent mouseEvent)
  1681. {
  1682. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  1683. MouseLeave?.Invoke (args);
  1684. if (args.Handled)
  1685. return true;
  1686. if (base.OnMouseLeave (mouseEvent))
  1687. return true;
  1688. return false;
  1689. }
  1690. /// <summary>
  1691. /// Method invoked when a mouse event is generated
  1692. /// </summary>
  1693. /// <param name="mouseEvent"></param>
  1694. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  1695. public virtual bool OnMouseEvent (MouseEvent mouseEvent)
  1696. {
  1697. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  1698. MouseClick?.Invoke (args);
  1699. if (args.Handled)
  1700. return true;
  1701. if (MouseEvent (mouseEvent))
  1702. return true;
  1703. if (mouseEvent.Flags == MouseFlags.Button1Clicked) {
  1704. if (!HasFocus && SuperView != null) {
  1705. SuperView.SetFocus (this);
  1706. SetNeedsDisplay ();
  1707. }
  1708. return true;
  1709. }
  1710. return false;
  1711. }
  1712. /// <inheritdoc/>
  1713. protected override void Dispose (bool disposing)
  1714. {
  1715. for (int i = InternalSubviews.Count - 1; i >= 0; i--) {
  1716. View subview = InternalSubviews [i];
  1717. Remove (subview);
  1718. subview.Dispose ();
  1719. }
  1720. base.Dispose (disposing);
  1721. }
  1722. /// <summary>
  1723. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are beginning initialized.
  1724. /// </summary>
  1725. public void BeginInit ()
  1726. {
  1727. if (!IsInitialized) {
  1728. oldCanFocus = CanFocus;
  1729. oldTabIndex = tabIndex;
  1730. Initialized?.Invoke (this, EventArgs.Empty);
  1731. }
  1732. if (subviews?.Count > 0) {
  1733. foreach (var view in subviews) {
  1734. if (!view.IsInitialized) {
  1735. view.BeginInit ();
  1736. }
  1737. }
  1738. }
  1739. }
  1740. /// <summary>
  1741. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are ending initialized.
  1742. /// </summary>
  1743. public void EndInit ()
  1744. {
  1745. IsInitialized = true;
  1746. if (subviews?.Count > 0) {
  1747. foreach (var view in subviews) {
  1748. if (!view.IsInitialized) {
  1749. view.EndInit ();
  1750. }
  1751. }
  1752. }
  1753. }
  1754. }
  1755. }