View.cs 65 KB

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