2
0

View.cs 57 KB

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