2
0

View.cs 59 KB

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