View.cs 54 KB

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