View.cs 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773
  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. // Optimizations
  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 initialized. 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 parameter 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 typically 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. ShortcutHelper shortcutHelper;
  122. /// <summary>
  123. /// Event fired when a subview is being added to this view.
  124. /// </summary>
  125. public event Action<View> Added;
  126. /// <summary>
  127. /// Event fired when a subview is being removed from this view.
  128. /// </summary>
  129. public event Action<View> Removed;
  130. /// <summary>
  131. /// Event fired when the view gets focus.
  132. /// </summary>
  133. public event Action<FocusEventArgs> Enter;
  134. /// <summary>
  135. /// Event fired when the view looses focus.
  136. /// </summary>
  137. public event Action<FocusEventArgs> Leave;
  138. /// <summary>
  139. /// Event fired when the view receives the mouse event for the first time.
  140. /// </summary>
  141. public event Action<MouseEventArgs> MouseEnter;
  142. /// <summary>
  143. /// Event fired when the view receives a mouse event for the last time.
  144. /// </summary>
  145. public event Action<MouseEventArgs> MouseLeave;
  146. /// <summary>
  147. /// Event fired when a mouse event is generated.
  148. /// </summary>
  149. public event Action<MouseEventArgs> MouseClick;
  150. /// <summary>
  151. /// Event fired when the <see cref="CanFocus"/> value is being changed.
  152. /// </summary>
  153. public event Action CanFocusChanged;
  154. /// <summary>
  155. /// Event fired when the <see cref="Enabled"/> value is being changed.
  156. /// </summary>
  157. public event Action EnabledChanged;
  158. /// <summary>
  159. /// Event fired when the <see cref="Visible"/> value is being changed.
  160. /// </summary>
  161. public event Action VisibleChanged;
  162. /// <summary>
  163. /// Event invoked when the <see cref="HotKey"/> is changed.
  164. /// </summary>
  165. public event Action<Key> HotKeyChanged;
  166. /// <summary>
  167. /// 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.
  168. /// </summary>
  169. public virtual Key HotKey { get => TextFormatter.HotKey; set => TextFormatter.HotKey = value; }
  170. /// <summary>
  171. /// 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'.
  172. /// </summary>
  173. public virtual Rune HotKeySpecifier { get => TextFormatter.HotKeySpecifier; set => TextFormatter.HotKeySpecifier = value; }
  174. /// <summary>
  175. /// This is the global setting that can be used as a global shortcut to invoke an action if provided.
  176. /// </summary>
  177. public Key Shortcut {
  178. get => shortcutHelper.Shortcut;
  179. set {
  180. if (shortcutHelper.Shortcut != value && (ShortcutHelper.PostShortcutValidation (value) || value == Key.Null)) {
  181. shortcutHelper.Shortcut = value;
  182. }
  183. }
  184. }
  185. /// <summary>
  186. /// The keystroke combination used in the <see cref="Shortcut"/> as string.
  187. /// </summary>
  188. public ustring ShortcutTag => ShortcutHelper.GetShortcutTag (shortcutHelper.Shortcut);
  189. /// <summary>
  190. /// The action to run if the <see cref="Shortcut"/> is defined.
  191. /// </summary>
  192. public virtual Action ShortcutAction { get; set; }
  193. /// <summary>
  194. /// Gets or sets arbitrary data for the view.
  195. /// </summary>
  196. /// <remarks>This property is not used internally.</remarks>
  197. public object Data { get; set; }
  198. internal Direction FocusDirection {
  199. get => SuperView?.FocusDirection ?? focusDirection;
  200. set {
  201. if (SuperView != null)
  202. SuperView.FocusDirection = value;
  203. else
  204. focusDirection = value;
  205. }
  206. }
  207. /// <summary>
  208. /// Points to the current driver in use by the view, it is a convenience property
  209. /// for simplifying the development of new views.
  210. /// </summary>
  211. public static ConsoleDriver Driver { get { return Application.Driver; } }
  212. static IList<View> empty = new List<View> (0).AsReadOnly ();
  213. // This is null, and allocated on demand.
  214. List<View> subviews;
  215. /// <summary>
  216. /// This returns a list of the subviews contained by this view.
  217. /// </summary>
  218. /// <value>The subviews.</value>
  219. public IList<View> Subviews => subviews == null ? empty : subviews.AsReadOnly ();
  220. // Internally, we use InternalSubviews rather than subviews, as we do not expect us
  221. // to make the same mistakes our users make when they poke at the Subviews.
  222. internal IList<View> InternalSubviews => subviews ?? empty;
  223. // This is null, and allocated on demand.
  224. List<View> tabIndexes;
  225. /// <summary>
  226. /// Configurable keybindings supported by the control
  227. /// </summary>
  228. private Dictionary<Key, Command> KeyBindings { get; set; } = new Dictionary<Key, Command> ();
  229. private Dictionary<Command, Func<bool?>> CommandImplementations { get; set; } = new Dictionary<Command, Func<bool?>> ();
  230. /// <summary>
  231. /// This returns a tab index list of the subviews contained by this view.
  232. /// </summary>
  233. /// <value>The tabIndexes.</value>
  234. public IList<View> TabIndexes => tabIndexes == null ? empty : tabIndexes.AsReadOnly ();
  235. int tabIndex = -1;
  236. /// <summary>
  237. /// Indicates the index of the current <see cref="View"/> from the <see cref="TabIndexes"/> list.
  238. /// </summary>
  239. public int TabIndex {
  240. get { return tabIndex; }
  241. set {
  242. if (!CanFocus) {
  243. tabIndex = -1;
  244. return;
  245. } else if (SuperView?.tabIndexes == null || SuperView?.tabIndexes.Count == 1) {
  246. tabIndex = 0;
  247. return;
  248. } else if (tabIndex == value) {
  249. return;
  250. }
  251. tabIndex = value > SuperView.tabIndexes.Count - 1 ? SuperView.tabIndexes.Count - 1 : value < 0 ? 0 : value;
  252. tabIndex = GetTabIndex (tabIndex);
  253. if (SuperView.tabIndexes.IndexOf (this) != tabIndex) {
  254. SuperView.tabIndexes.Remove (this);
  255. SuperView.tabIndexes.Insert (tabIndex, this);
  256. SetTabIndex ();
  257. }
  258. }
  259. }
  260. int GetTabIndex (int idx)
  261. {
  262. int i = 0;
  263. foreach (var v in SuperView.tabIndexes) {
  264. if (v.tabIndex == -1 || v == this) {
  265. continue;
  266. }
  267. i++;
  268. }
  269. return Math.Min (i, idx);
  270. }
  271. void SetTabIndex ()
  272. {
  273. int i = 0;
  274. foreach (var v in SuperView.tabIndexes) {
  275. if (v.tabIndex == -1) {
  276. continue;
  277. }
  278. v.tabIndex = i;
  279. i++;
  280. }
  281. }
  282. bool tabStop = true;
  283. /// <summary>
  284. /// 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>
  285. /// </summary>
  286. public bool TabStop {
  287. get { return tabStop; }
  288. set {
  289. if (tabStop == value) {
  290. return;
  291. }
  292. tabStop = CanFocus && value;
  293. }
  294. }
  295. bool oldCanFocus;
  296. int oldTabIndex;
  297. /// <inheritdoc/>
  298. public override bool CanFocus {
  299. get => base.CanFocus;
  300. set {
  301. if (!addingView && IsInitialized && SuperView?.CanFocus == false && value) {
  302. throw new InvalidOperationException ("Cannot set CanFocus to true if the SuperView CanFocus is false!");
  303. }
  304. if (base.CanFocus != value) {
  305. base.CanFocus = value;
  306. if (!value && tabIndex > -1) {
  307. TabIndex = -1;
  308. }
  309. if (value && SuperView?.CanFocus == false && addingView) {
  310. SuperView.CanFocus = value;
  311. }
  312. if (value && tabIndex == -1) {
  313. TabIndex = SuperView != null ? SuperView.tabIndexes.IndexOf (this) : -1;
  314. }
  315. TabStop = value;
  316. if (!value && SuperView?.Focused == this) {
  317. SuperView.focused = null;
  318. }
  319. if (!value && HasFocus) {
  320. SetHasFocus (false, this);
  321. SuperView?.EnsureFocus ();
  322. if (SuperView != null && SuperView?.Focused == null) {
  323. SuperView.FocusNext ();
  324. if (SuperView.Focused == null) {
  325. Application.Current.FocusNext ();
  326. }
  327. Application.EnsuresTopOnFront ();
  328. }
  329. }
  330. if (subviews != null && IsInitialized) {
  331. foreach (var view in subviews) {
  332. if (view.CanFocus != value) {
  333. if (!value) {
  334. view.oldCanFocus = view.CanFocus;
  335. view.oldTabIndex = view.tabIndex;
  336. view.CanFocus = value;
  337. view.tabIndex = -1;
  338. } else {
  339. if (addingView) {
  340. view.addingView = true;
  341. }
  342. view.CanFocus = view.oldCanFocus;
  343. view.tabIndex = view.oldTabIndex;
  344. view.addingView = false;
  345. }
  346. }
  347. }
  348. }
  349. OnCanFocusChanged ();
  350. SetNeedsDisplay ();
  351. }
  352. }
  353. }
  354. internal Rect NeedDisplay { get; private set; } = Rect.Empty;
  355. // The frame for the object. Superview relative.
  356. Rect frame;
  357. /// <summary>
  358. /// Gets or sets an identifier for the view;
  359. /// </summary>
  360. /// <value>The identifier.</value>
  361. /// <remarks>The id should be unique across all Views that share a SuperView.</remarks>
  362. public ustring Id { get; set; } = "";
  363. /// <summary>
  364. /// Returns a value indicating if this View is currently on Top (Active)
  365. /// </summary>
  366. public bool IsCurrentTop {
  367. get {
  368. return Application.Current == this;
  369. }
  370. }
  371. /// <summary>
  372. /// Gets or sets a value indicating whether this <see cref="View"/> wants mouse position reports.
  373. /// </summary>
  374. /// <value><c>true</c> if want mouse position reports; otherwise, <c>false</c>.</value>
  375. public virtual bool WantMousePositionReports { get; set; } = false;
  376. /// <summary>
  377. /// Gets or sets a value indicating whether this <see cref="View"/> want continuous button pressed event.
  378. /// </summary>
  379. public virtual bool WantContinuousButtonPressed { get; set; } = false;
  380. /// <summary>
  381. /// Gets or sets the frame for the view. The frame is relative to the view's container (<see cref="SuperView"/>).
  382. /// </summary>
  383. /// <value>The frame.</value>
  384. /// <remarks>
  385. /// <para>
  386. /// Change the Frame when using the <see cref="LayoutStyle.Absolute"/> layout style to move or resize views.
  387. /// </para>
  388. /// <para>
  389. /// Altering the Frame of a view will trigger the redrawing of the
  390. /// view as well as the redrawing of the affected regions of the <see cref="SuperView"/>.
  391. /// </para>
  392. /// </remarks>
  393. public virtual Rect Frame {
  394. get => frame;
  395. set {
  396. if (SuperView != null) {
  397. SuperView.SetNeedsDisplay (frame);
  398. SuperView.SetNeedsDisplay (value);
  399. }
  400. frame = value;
  401. SetNeedsLayout ();
  402. SetNeedsDisplay (frame);
  403. }
  404. }
  405. ///// <summary>
  406. ///// Gets an enumerator that enumerates the subviews in this view.
  407. ///// </summary>
  408. ///// <returns>The enumerator.</returns>
  409. //public IEnumerator GetEnumerator ()
  410. //{
  411. // foreach (var v in InternalSubviews)
  412. // yield return v;
  413. //}
  414. LayoutStyle layoutStyle;
  415. /// <summary>
  416. /// Controls how the View's <see cref="Frame"/> is computed during the LayoutSubviews method, if the style is set to <see cref="LayoutStyle.Absolute"/>,
  417. /// LayoutSubviews does not change the <see cref="Frame"/>. If the style is <see cref="LayoutStyle.Computed"/> the <see cref="Frame"/> is updated using
  418. /// the <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/> properties.
  419. /// </summary>
  420. /// <value>The layout style.</value>
  421. public LayoutStyle LayoutStyle {
  422. get => layoutStyle;
  423. set {
  424. layoutStyle = value;
  425. SetNeedsLayout ();
  426. }
  427. }
  428. /// <summary>
  429. /// The bounds represent the View-relative rectangle used for this view; the area inside of the view.
  430. /// </summary>
  431. /// <value>The bounds.</value>
  432. /// <remarks>
  433. /// <para>
  434. /// Updates to the Bounds update the <see cref="Frame"/>,
  435. /// and has the same side effects as updating the <see cref="Frame"/>.
  436. /// </para>
  437. /// <para>
  438. /// Because <see cref="Bounds"/> coordinates are relative to the upper-left corner of the <see cref="View"/>,
  439. /// the coordinates of the upper-left corner of the rectangle returned by this property are (0,0).
  440. /// Use this property to obtain the size and coordinates of the client area of the
  441. /// control for tasks such as drawing on the surface of the control.
  442. /// </para>
  443. /// </remarks>
  444. public Rect Bounds {
  445. get => new Rect (Point.Empty, Frame.Size);
  446. set {
  447. Frame = new Rect (frame.Location, value.Size);
  448. }
  449. }
  450. Pos x, y;
  451. /// <summary>
  452. /// Gets or sets the X position for the view (the column). Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  453. /// </summary>
  454. /// <value>The X Position.</value>
  455. /// <remarks>
  456. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  457. /// </remarks>
  458. public Pos X {
  459. get => x;
  460. set {
  461. if (!ValidatePosDim (x, value)) {
  462. throw new ArgumentException ();
  463. }
  464. x = value;
  465. SetNeedsLayout ();
  466. if (x is Pos.PosAbsolute) {
  467. frame = new Rect (x.Anchor (0), frame.Y, frame.Width, frame.Height);
  468. }
  469. TextFormatter.Size = frame.Size;
  470. SetNeedsDisplay (frame);
  471. }
  472. }
  473. /// <summary>
  474. /// Gets or sets the Y position for the view (the row). Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  475. /// </summary>
  476. /// <value>The y position (line).</value>
  477. /// <remarks>
  478. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  479. /// </remarks>
  480. public Pos Y {
  481. get => y;
  482. set {
  483. if (!ValidatePosDim (y, value)) {
  484. throw new ArgumentException ();
  485. }
  486. y = value;
  487. SetNeedsLayout ();
  488. if (y is Pos.PosAbsolute) {
  489. frame = new Rect (frame.X, y.Anchor (0), frame.Width, frame.Height);
  490. }
  491. TextFormatter.Size = frame.Size;
  492. SetNeedsDisplay (frame);
  493. }
  494. }
  495. Dim width, height;
  496. /// <summary>
  497. /// Gets or sets the width of the view. Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  498. /// </summary>
  499. /// <value>The width.</value>
  500. /// <remarks>
  501. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  502. /// </remarks>
  503. public Dim Width {
  504. get => width;
  505. set {
  506. if (!ValidatePosDim (width, value)) {
  507. throw new ArgumentException ();
  508. }
  509. width = value;
  510. if (autoSize && value.Anchor (0) != TextFormatter.Size.Width) {
  511. autoSize = false;
  512. }
  513. SetNeedsLayout ();
  514. if (width is Dim.DimAbsolute) {
  515. frame = new Rect (frame.X, frame.Y, width.Anchor (0), frame.Height);
  516. }
  517. TextFormatter.Size = frame.Size;
  518. SetNeedsDisplay (frame);
  519. }
  520. }
  521. /// <summary>
  522. /// Gets or sets the height of the view. Only used the <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Computed"/>.
  523. /// </summary>
  524. /// <value>The height.</value>
  525. /// If <see cref="LayoutStyle"/> is <see cref="LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  526. public Dim Height {
  527. get => height;
  528. set {
  529. if (!ValidatePosDim (height, value)) {
  530. throw new ArgumentException ();
  531. }
  532. height = value;
  533. if (autoSize && value.Anchor (0) != TextFormatter.Size.Height) {
  534. autoSize = false;
  535. }
  536. SetNeedsLayout ();
  537. if (height is Dim.DimAbsolute) {
  538. frame = new Rect (frame.X, frame.Y, frame.Width, height.Anchor (0));
  539. }
  540. TextFormatter.Size = frame.Size;
  541. SetNeedsDisplay (frame);
  542. }
  543. }
  544. bool ValidatePosDim (object oldvalue, object newValue)
  545. {
  546. if (!IsInitialized || layoutStyle == LayoutStyle.Absolute || oldvalue == null || oldvalue.GetType () == newValue.GetType () || this is Toplevel) {
  547. return true;
  548. }
  549. if (layoutStyle == LayoutStyle.Computed) {
  550. if (oldvalue.GetType () != newValue.GetType () && !(newValue is Pos.PosAbsolute || newValue is Dim.DimAbsolute)) {
  551. return true;
  552. }
  553. }
  554. return false;
  555. }
  556. /// <summary>
  557. /// Gets or sets the <see cref="Terminal.Gui.TextFormatter"/> which can be handled differently by any derived class.
  558. /// </summary>
  559. public TextFormatter TextFormatter { get; set; }
  560. /// <summary>
  561. /// Returns the container for this view, or null if this view has not been added to a container.
  562. /// </summary>
  563. /// <value>The super view.</value>
  564. public View SuperView => container;
  565. /// <summary>
  566. /// Initializes a new instance of a <see cref="LayoutStyle.Absolute"/> <see cref="View"/> class with the absolute
  567. /// dimensions specified in the <c>frame</c> parameter.
  568. /// </summary>
  569. /// <param name="frame">The region covered by this view.</param>
  570. /// <remarks>
  571. /// This constructor initialize a View with a <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Absolute"/>. Use <see cref="View()"/> to
  572. /// initialize a View with <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Computed"/>
  573. /// </remarks>
  574. public View (Rect frame)
  575. {
  576. Initialize (ustring.Empty, frame, LayoutStyle.Absolute, TextDirection.LeftRight_TopBottom);
  577. }
  578. /// <summary>
  579. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Computed"/> layout.
  580. /// </summary>
  581. /// <remarks>
  582. /// <para>
  583. /// 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.
  584. /// The <see cref="Label"/> will be created using <see cref="LayoutStyle.Computed"/>
  585. /// coordinates. The initial size (<see cref="View.Frame"/> will be
  586. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  587. /// </para>
  588. /// <para>
  589. /// If <c>Height</c> is greater than one, word wrapping is provided.
  590. /// </para>
  591. /// <para>
  592. /// This constructor initialize a View with a <see cref="LayoutStyle"/> of <see cref="LayoutStyle.Computed"/>.
  593. /// 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.
  594. /// </para>
  595. /// </remarks>
  596. public View () : this (text: string.Empty, direction: TextDirection.LeftRight_TopBottom) { }
  597. /// <summary>
  598. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Absolute"/> layout.
  599. /// </summary>
  600. /// <remarks>
  601. /// <para>
  602. /// The <see cref="View"/> will be created at the given
  603. /// coordinates with the given string. The size (<see cref="View.Frame"/> will be
  604. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  605. /// </para>
  606. /// <para>
  607. /// No line wrapping is provided.
  608. /// </para>
  609. /// </remarks>
  610. /// <param name="x">column to locate the Label.</param>
  611. /// <param name="y">row to locate the Label.</param>
  612. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  613. public View (int x, int y, ustring text) : this (TextFormatter.CalcRect (x, y, text), text) { }
  614. /// <summary>
  615. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Absolute"/> layout.
  616. /// </summary>
  617. /// <remarks>
  618. /// <para>
  619. /// The <see cref="View"/> will be created at the given
  620. /// coordinates with the given string. The initial size (<see cref="View.Frame"/> will be
  621. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  622. /// </para>
  623. /// <para>
  624. /// If <c>rect.Height</c> is greater than one, word wrapping is provided.
  625. /// </para>
  626. /// </remarks>
  627. /// <param name="rect">Location.</param>
  628. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  629. /// <param name="border">The <see cref="Border"/>.</param>
  630. public View (Rect rect, ustring text, Border border = null)
  631. {
  632. Initialize (text, rect, LayoutStyle.Absolute, TextDirection.LeftRight_TopBottom, border);
  633. }
  634. /// <summary>
  635. /// Initializes a new instance of <see cref="View"/> using <see cref="LayoutStyle.Computed"/> layout.
  636. /// </summary>
  637. /// <remarks>
  638. /// <para>
  639. /// The <see cref="View"/> will be created using <see cref="LayoutStyle.Computed"/>
  640. /// coordinates with the given string. The initial size (<see cref="View.Frame"/> will be
  641. /// adjusted to fit the contents of <see cref="Text"/>, including newlines ('\n') for multiple lines.
  642. /// </para>
  643. /// <para>
  644. /// If <c>Height</c> is greater than one, word wrapping is provided.
  645. /// </para>
  646. /// </remarks>
  647. /// <param name="text">text to initialize the <see cref="Text"/> property with.</param>
  648. /// <param name="direction">The text direction.</param>
  649. /// <param name="border">The <see cref="Border"/>.</param>
  650. public View (ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom, Border border = null)
  651. {
  652. Initialize (text, Rect.Empty, LayoutStyle.Computed, direction, border);
  653. }
  654. void Initialize (ustring text, Rect rect, LayoutStyle layoutStyle = LayoutStyle.Computed,
  655. TextDirection direction = TextDirection.LeftRight_TopBottom, Border border = null)
  656. {
  657. TextFormatter = new TextFormatter ();
  658. TextFormatter.HotKeyChanged += TextFormatter_HotKeyChanged;
  659. TextDirection = direction;
  660. Border = border;
  661. if (Border != null) {
  662. Border.Child = this;
  663. }
  664. shortcutHelper = new ShortcutHelper ();
  665. CanFocus = false;
  666. TabIndex = -1;
  667. TabStop = false;
  668. LayoutStyle = layoutStyle;
  669. // BUGBUG: CalcRect doesn't account for line wrapping
  670. Rect r;
  671. if (rect.IsEmpty) {
  672. r = TextFormatter.CalcRect (0, 0, text, direction);
  673. } else {
  674. r = rect;
  675. }
  676. x = Pos.At (r.X);
  677. y = Pos.At (r.Y);
  678. Width = r.Width;
  679. Height = r.Height;
  680. Frame = r;
  681. Text = text;
  682. }
  683. private void TextFormatter_HotKeyChanged (Key obj)
  684. {
  685. HotKeyChanged?.Invoke (obj);
  686. }
  687. /// <summary>
  688. /// Sets a flag indicating this view needs to be redisplayed because its state has changed.
  689. /// </summary>
  690. public void SetNeedsDisplay ()
  691. {
  692. SetNeedsDisplay (Bounds);
  693. }
  694. internal bool LayoutNeeded { get; private set; } = true;
  695. internal void SetNeedsLayout ()
  696. {
  697. if (LayoutNeeded)
  698. return;
  699. LayoutNeeded = true;
  700. if (SuperView == null)
  701. return;
  702. SuperView.SetNeedsLayout ();
  703. foreach (var view in Subviews) {
  704. view.SetNeedsLayout ();
  705. }
  706. TextFormatter.NeedsFormat = true;
  707. }
  708. /// <summary>
  709. /// Removes the <see cref="SetNeedsLayout"/> setting on this view.
  710. /// </summary>
  711. protected void ClearLayoutNeeded ()
  712. {
  713. LayoutNeeded = false;
  714. }
  715. /// <summary>
  716. /// Flags the view-relative region on this View as needing to be repainted.
  717. /// </summary>
  718. /// <param name="region">The view-relative region that must be flagged for repaint.</param>
  719. public void SetNeedsDisplay (Rect region)
  720. {
  721. if (NeedDisplay.IsEmpty)
  722. NeedDisplay = region;
  723. else {
  724. var x = Math.Min (NeedDisplay.X, region.X);
  725. var y = Math.Min (NeedDisplay.Y, region.Y);
  726. var w = Math.Max (NeedDisplay.Width, region.Width);
  727. var h = Math.Max (NeedDisplay.Height, region.Height);
  728. NeedDisplay = new Rect (x, y, w, h);
  729. }
  730. if (container != null)
  731. container.SetChildNeedsDisplay ();
  732. if (subviews == null)
  733. return;
  734. foreach (var view in subviews)
  735. if (view.Frame.IntersectsWith (region)) {
  736. var childRegion = Rect.Intersect (view.Frame, region);
  737. childRegion.X -= view.Frame.X;
  738. childRegion.Y -= view.Frame.Y;
  739. view.SetNeedsDisplay (childRegion);
  740. }
  741. }
  742. internal bool ChildNeedsDisplay { get; private set; }
  743. /// <summary>
  744. /// Indicates that any child views (in the <see cref="Subviews"/> list) need to be repainted.
  745. /// </summary>
  746. public void SetChildNeedsDisplay ()
  747. {
  748. ChildNeedsDisplay = true;
  749. if (container != null)
  750. container.SetChildNeedsDisplay ();
  751. }
  752. internal bool addingView = false;
  753. /// <summary>
  754. /// Adds a subview (child) to this view.
  755. /// </summary>
  756. /// <remarks>
  757. /// 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"/>
  758. /// </remarks>
  759. public virtual void Add (View view)
  760. {
  761. if (view == null)
  762. return;
  763. if (subviews == null) {
  764. subviews = new List<View> ();
  765. }
  766. if (tabIndexes == null) {
  767. tabIndexes = new List<View> ();
  768. }
  769. subviews.Add (view);
  770. tabIndexes.Add (view);
  771. view.container = this;
  772. if (view.CanFocus) {
  773. addingView = true;
  774. if (SuperView?.CanFocus == false) {
  775. SuperView.addingView = true;
  776. SuperView.CanFocus = true;
  777. SuperView.addingView = false;
  778. }
  779. CanFocus = true;
  780. view.tabIndex = tabIndexes.IndexOf (view);
  781. addingView = false;
  782. }
  783. SetNeedsLayout ();
  784. SetNeedsDisplay ();
  785. OnAdded (view);
  786. if (IsInitialized) {
  787. view.BeginInit ();
  788. view.EndInit ();
  789. }
  790. }
  791. /// <summary>
  792. /// Adds the specified views (children) to the view.
  793. /// </summary>
  794. /// <param name="views">Array of one or more views (can be optional parameter).</param>
  795. /// <remarks>
  796. /// 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"/>
  797. /// </remarks>
  798. public void Add (params View [] views)
  799. {
  800. if (views == null)
  801. return;
  802. foreach (var view in views)
  803. Add (view);
  804. }
  805. /// <summary>
  806. /// Removes all subviews (children) added via <see cref="Add(View)"/> or <see cref="Add(View[])"/> from this View.
  807. /// </summary>
  808. public virtual void RemoveAll ()
  809. {
  810. if (subviews == null)
  811. return;
  812. while (subviews.Count > 0) {
  813. Remove (subviews [0]);
  814. }
  815. }
  816. /// <summary>
  817. /// Removes a subview added via <see cref="Add(View)"/> or <see cref="Add(View[])"/> from this View.
  818. /// </summary>
  819. /// <remarks>
  820. /// </remarks>
  821. public virtual void Remove (View view)
  822. {
  823. if (view == null || subviews == null)
  824. return;
  825. SetNeedsLayout ();
  826. SetNeedsDisplay ();
  827. var touched = view.Frame;
  828. subviews.Remove (view);
  829. tabIndexes.Remove (view);
  830. view.container = null;
  831. view.tabIndex = -1;
  832. if (subviews.Count < 1) {
  833. CanFocus = false;
  834. }
  835. foreach (var v in subviews) {
  836. if (v.Frame.IntersectsWith (touched))
  837. view.SetNeedsDisplay ();
  838. }
  839. OnRemoved (view);
  840. if (focused == view) {
  841. focused = null;
  842. }
  843. }
  844. void PerformActionForSubview (View subview, Action<View> action)
  845. {
  846. if (subviews.Contains (subview)) {
  847. action (subview);
  848. }
  849. SetNeedsDisplay ();
  850. subview.SetNeedsDisplay ();
  851. }
  852. /// <summary>
  853. /// Brings the specified subview to the front so it is drawn on top of any other views.
  854. /// </summary>
  855. /// <param name="subview">The subview to send to the front</param>
  856. /// <remarks>
  857. /// <seealso cref="SendSubviewToBack"/>.
  858. /// </remarks>
  859. public void BringSubviewToFront (View subview)
  860. {
  861. PerformActionForSubview (subview, x => {
  862. subviews.Remove (x);
  863. subviews.Add (x);
  864. });
  865. }
  866. /// <summary>
  867. /// Sends the specified subview to the front so it is the first view drawn
  868. /// </summary>
  869. /// <param name="subview">The subview to send to the front</param>
  870. /// <remarks>
  871. /// <seealso cref="BringSubviewToFront(View)"/>.
  872. /// </remarks>
  873. public void SendSubviewToBack (View subview)
  874. {
  875. PerformActionForSubview (subview, x => {
  876. subviews.Remove (x);
  877. subviews.Insert (0, subview);
  878. });
  879. }
  880. /// <summary>
  881. /// Moves the subview backwards in the hierarchy, only one step
  882. /// </summary>
  883. /// <param name="subview">The subview to send backwards</param>
  884. /// <remarks>
  885. /// If you want to send the view all the way to the back use SendSubviewToBack.
  886. /// </remarks>
  887. public void SendSubviewBackwards (View subview)
  888. {
  889. PerformActionForSubview (subview, x => {
  890. var idx = subviews.IndexOf (x);
  891. if (idx > 0) {
  892. subviews.Remove (x);
  893. subviews.Insert (idx - 1, x);
  894. }
  895. });
  896. }
  897. /// <summary>
  898. /// Moves the subview backwards in the hierarchy, only one step
  899. /// </summary>
  900. /// <param name="subview">The subview to send backwards</param>
  901. /// <remarks>
  902. /// If you want to send the view all the way to the back use SendSubviewToBack.
  903. /// </remarks>
  904. public void BringSubviewForward (View subview)
  905. {
  906. PerformActionForSubview (subview, x => {
  907. var idx = subviews.IndexOf (x);
  908. if (idx + 1 < subviews.Count) {
  909. subviews.Remove (x);
  910. subviews.Insert (idx + 1, x);
  911. }
  912. });
  913. }
  914. /// <summary>
  915. /// Clears the view region with the current color.
  916. /// </summary>
  917. /// <remarks>
  918. /// <para>
  919. /// This clears the entire region used by this view.
  920. /// </para>
  921. /// </remarks>
  922. public void Clear ()
  923. {
  924. var h = Frame.Height;
  925. var w = Frame.Width;
  926. for (int line = 0; line < h; line++) {
  927. Move (0, line);
  928. for (int col = 0; col < w; col++)
  929. Driver.AddRune (' ');
  930. }
  931. }
  932. /// <summary>
  933. /// Clears the specified region with the current color.
  934. /// </summary>
  935. /// <remarks>
  936. /// </remarks>
  937. /// <param name="regionScreen">The screen-relative region to clear.</param>
  938. public void Clear (Rect regionScreen)
  939. {
  940. var h = regionScreen.Height;
  941. var w = regionScreen.Width;
  942. for (int line = regionScreen.Y; line < regionScreen.Y + h; line++) {
  943. Driver.Move (regionScreen.X, line);
  944. for (int col = 0; col < w; col++)
  945. Driver.AddRune (' ');
  946. }
  947. }
  948. /// <summary>
  949. /// Converts a view-relative (col,row) position to a screen-relative position (col,row). The values are optionally clamped to the screen dimensions.
  950. /// </summary>
  951. /// <param name="col">View-relative column.</param>
  952. /// <param name="row">View-relative row.</param>
  953. /// <param name="rcol">Absolute column; screen-relative.</param>
  954. /// <param name="rrow">Absolute row; screen-relative.</param>
  955. /// <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>
  956. internal void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true)
  957. {
  958. // Computes the real row, col relative to the screen.
  959. rrow = row + frame.Y;
  960. rcol = col + frame.X;
  961. var ccontainer = container;
  962. while (ccontainer != null) {
  963. rrow += ccontainer.frame.Y;
  964. rcol += ccontainer.frame.X;
  965. ccontainer = ccontainer.container;
  966. }
  967. // The following ensures that the cursor is always in the screen boundaries.
  968. if (clipped) {
  969. rrow = Math.Min (rrow, Driver.Rows - 1);
  970. rcol = Math.Min (rcol, Driver.Cols - 1);
  971. }
  972. }
  973. /// <summary>
  974. /// Converts a point from screen-relative coordinates to view-relative coordinates.
  975. /// </summary>
  976. /// <returns>The mapped point.</returns>
  977. /// <param name="x">X screen-coordinate point.</param>
  978. /// <param name="y">Y screen-coordinate point.</param>
  979. public Point ScreenToView (int x, int y)
  980. {
  981. if (SuperView == null) {
  982. return new Point (x - Frame.X, y - frame.Y);
  983. } else {
  984. var parent = SuperView.ScreenToView (x, y);
  985. return new Point (parent.X - frame.X, parent.Y - frame.Y);
  986. }
  987. }
  988. /// <summary>
  989. /// Converts a region in view-relative coordinates to screen-relative coordinates.
  990. /// </summary>
  991. internal Rect ViewToScreen (Rect region)
  992. {
  993. ViewToScreen (region.X, region.Y, out var x, out var y, clipped: false);
  994. return new Rect (x, y, region.Width, region.Height);
  995. }
  996. // Clips a rectangle in screen coordinates to the dimensions currently available on the screen
  997. internal Rect ScreenClip (Rect regionScreen)
  998. {
  999. var x = regionScreen.X < 0 ? 0 : regionScreen.X;
  1000. var y = regionScreen.Y < 0 ? 0 : regionScreen.Y;
  1001. var w = regionScreen.X + regionScreen.Width >= Driver.Cols ? Driver.Cols - regionScreen.X : regionScreen.Width;
  1002. var h = regionScreen.Y + regionScreen.Height >= Driver.Rows ? Driver.Rows - regionScreen.Y : regionScreen.Height;
  1003. return new Rect (x, y, w, h);
  1004. }
  1005. /// <summary>
  1006. /// Sets the <see cref="ConsoleDriver"/>'s clip region to the current View's <see cref="Bounds"/>.
  1007. /// </summary>
  1008. /// <returns>The existing driver's clip region, which can be then re-applied by setting <c><see cref="Driver"/>.Clip</c> (<see cref="ConsoleDriver.Clip"/>).</returns>
  1009. /// <remarks>
  1010. /// <see cref="Bounds"/> is View-relative.
  1011. /// </remarks>
  1012. public Rect ClipToBounds ()
  1013. {
  1014. return SetClip (Bounds);
  1015. }
  1016. /// <summary>
  1017. /// Sets the clip region to the specified view-relative region.
  1018. /// </summary>
  1019. /// <returns>The previous screen-relative clip region.</returns>
  1020. /// <param name="region">View-relative clip region.</param>
  1021. public Rect SetClip (Rect region)
  1022. {
  1023. var previous = Driver.Clip;
  1024. Driver.Clip = Rect.Intersect (previous, ViewToScreen (region));
  1025. return previous;
  1026. }
  1027. /// <summary>
  1028. /// Draws a frame in the current view, clipped by the boundary of this view
  1029. /// </summary>
  1030. /// <param name="region">View-relative region for the frame to be drawn.</param>
  1031. /// <param name="padding">The padding to add around the outside of the drawn frame.</param>
  1032. /// <param name="fill">If set to <c>true</c> it fill will the contents.</param>
  1033. public void DrawFrame (Rect region, int padding = 0, bool fill = false)
  1034. {
  1035. var scrRect = ViewToScreen (region);
  1036. var savedClip = ClipToBounds ();
  1037. Driver.DrawWindowFrame (scrRect, padding + 1, padding + 1, padding + 1, padding + 1, border: true, fill: fill);
  1038. Driver.Clip = savedClip;
  1039. }
  1040. /// <summary>
  1041. /// Utility function to draw strings that contain a hotkey.
  1042. /// </summary>
  1043. /// <param name="text">String to display, the hotkey specifier before a letter flags the next letter as the hotkey.</param>
  1044. /// <param name="hotColor">Hot color.</param>
  1045. /// <param name="normalColor">Normal color.</param>
  1046. /// <remarks>
  1047. /// <para>The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default.</para>
  1048. /// <para>The hotkey specifier can be changed via <see cref="HotKeySpecifier"/></para>
  1049. /// </remarks>
  1050. public void DrawHotString (ustring text, Attribute hotColor, Attribute normalColor)
  1051. {
  1052. var hotkeySpec = HotKeySpecifier == (Rune)0xffff ? (Rune)'_' : HotKeySpecifier;
  1053. Application.Driver.SetAttribute (normalColor);
  1054. foreach (var rune in text) {
  1055. if (rune == hotkeySpec) {
  1056. Application.Driver.SetAttribute (hotColor);
  1057. continue;
  1058. }
  1059. Application.Driver.AddRune (rune);
  1060. Application.Driver.SetAttribute (normalColor);
  1061. }
  1062. }
  1063. /// <summary>
  1064. /// Utility function to draw strings that contains a hotkey using a <see cref="ColorScheme"/> and the "focused" state.
  1065. /// </summary>
  1066. /// <param name="text">String to display, the underscore before a letter flags the next letter as the hotkey.</param>
  1067. /// <param name="focused">If set to <c>true</c> this uses the focused colors from the color scheme, otherwise the regular ones.</param>
  1068. /// <param name="scheme">The color scheme to use.</param>
  1069. public void DrawHotString (ustring text, bool focused, ColorScheme scheme)
  1070. {
  1071. if (focused)
  1072. DrawHotString (text, scheme.HotFocus, scheme.Focus);
  1073. else
  1074. DrawHotString (text, Enabled ? scheme.HotNormal : scheme.Disabled, Enabled ? scheme.Normal : scheme.Disabled);
  1075. }
  1076. /// <summary>
  1077. /// This moves the cursor to the specified column and row in the view.
  1078. /// </summary>
  1079. /// <returns>The move.</returns>
  1080. /// <param name="col">Col.</param>
  1081. /// <param name="row">Row.</param>
  1082. /// <param name="clipped">Whether to clip the result of the ViewToScreen method,
  1083. /// if set to <c>true</c>, the col, row values are clamped to the screen (terminal) dimensions (0..TerminalDim-1).</param>
  1084. public void Move (int col, int row, bool clipped = true)
  1085. {
  1086. if (Driver.Rows == 0) {
  1087. return;
  1088. }
  1089. ViewToScreen (col, row, out var rcol, out var rrow, clipped);
  1090. Driver.Move (rcol, rrow);
  1091. }
  1092. /// <summary>
  1093. /// Positions the cursor in the right position based on the currently focused view in the chain.
  1094. /// </summary>
  1095. /// Views that are focusable should override <see cref="PositionCursor"/> to ensure
  1096. /// the cursor is placed in a location that makes sense. Unix terminals do not have
  1097. /// a way of hiding the cursor, so it can be distracting to have the cursor left at
  1098. /// the last focused view. Views should make sure that they place the cursor
  1099. /// in a visually sensible place.
  1100. public virtual void PositionCursor ()
  1101. {
  1102. if (!CanBeVisible (this) || !Enabled) {
  1103. return;
  1104. }
  1105. if (focused?.Visible == true && focused?.Enabled == true && focused?.Frame.Width > 0 && focused.Frame.Height > 0) {
  1106. focused.PositionCursor ();
  1107. } else {
  1108. if (CanFocus && HasFocus && Visible && Frame.Width > 0 && Frame.Height > 0) {
  1109. Move (TextFormatter.HotKeyPos == -1 ? 0 : TextFormatter.CursorPosition, 0);
  1110. } else {
  1111. Move (frame.X, frame.Y);
  1112. }
  1113. }
  1114. }
  1115. bool hasFocus;
  1116. /// <inheritdoc/>
  1117. public override bool HasFocus {
  1118. get {
  1119. return hasFocus;
  1120. }
  1121. }
  1122. void SetHasFocus (bool value, View view, bool force = false)
  1123. {
  1124. if (hasFocus != value || force) {
  1125. hasFocus = value;
  1126. if (value) {
  1127. OnEnter (view);
  1128. } else {
  1129. OnLeave (view);
  1130. }
  1131. SetNeedsDisplay ();
  1132. }
  1133. // Remove focus down the chain of subviews if focus is removed
  1134. if (!value && focused != null) {
  1135. focused.OnLeave (view);
  1136. focused.SetHasFocus (false, view);
  1137. focused = null;
  1138. }
  1139. }
  1140. /// <summary>
  1141. /// Defines the event arguments for <see cref="SetFocus(View)"/>
  1142. /// </summary>
  1143. public class FocusEventArgs : EventArgs {
  1144. /// <summary>
  1145. /// Constructs.
  1146. /// </summary>
  1147. /// <param name="view">The view that gets or loses focus.</param>
  1148. public FocusEventArgs (View view) { View = view; }
  1149. /// <summary>
  1150. /// Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber.
  1151. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1152. /// </summary>
  1153. public bool Handled { get; set; }
  1154. /// <summary>
  1155. /// Indicates the current view that gets or loses focus.
  1156. /// </summary>
  1157. public View View { get; set; }
  1158. }
  1159. /// <summary>
  1160. /// Method invoked when a subview is being added to this view.
  1161. /// </summary>
  1162. /// <param name="view">The subview being added.</param>
  1163. public virtual void OnAdded (View view)
  1164. {
  1165. view.Added?.Invoke (this);
  1166. }
  1167. /// <summary>
  1168. /// Method invoked when a subview is being removed from this view.
  1169. /// </summary>
  1170. /// <param name="view">The subview being removed.</param>
  1171. public virtual void OnRemoved (View view)
  1172. {
  1173. view.Removed?.Invoke (this);
  1174. }
  1175. /// <inheritdoc/>
  1176. public override bool OnEnter (View view)
  1177. {
  1178. FocusEventArgs args = new FocusEventArgs (view);
  1179. Enter?.Invoke (args);
  1180. if (args.Handled)
  1181. return true;
  1182. if (base.OnEnter (view))
  1183. return true;
  1184. return false;
  1185. }
  1186. /// <inheritdoc/>
  1187. public override bool OnLeave (View view)
  1188. {
  1189. FocusEventArgs args = new FocusEventArgs (view);
  1190. Leave?.Invoke (args);
  1191. if (args.Handled)
  1192. return true;
  1193. if (base.OnLeave (view))
  1194. return true;
  1195. return false;
  1196. }
  1197. /// <summary>
  1198. /// Returns the currently focused view inside this view, or null if nothing is focused.
  1199. /// </summary>
  1200. /// <value>The focused.</value>
  1201. public View Focused => focused;
  1202. /// <summary>
  1203. /// Returns the most focused view in the chain of subviews (the leaf view that has the focus).
  1204. /// </summary>
  1205. /// <value>The most focused.</value>
  1206. public View MostFocused {
  1207. get {
  1208. if (Focused == null)
  1209. return null;
  1210. var most = Focused.MostFocused;
  1211. if (most != null)
  1212. return most;
  1213. return Focused;
  1214. }
  1215. }
  1216. ColorScheme colorScheme;
  1217. /// <summary>
  1218. /// The color scheme for this view, if it is not defined, it returns the <see cref="SuperView"/>'s
  1219. /// color scheme.
  1220. /// </summary>
  1221. public virtual ColorScheme ColorScheme {
  1222. get {
  1223. if (colorScheme == null)
  1224. return SuperView?.ColorScheme;
  1225. return colorScheme;
  1226. }
  1227. set {
  1228. if (colorScheme != value) {
  1229. colorScheme = value;
  1230. SetNeedsDisplay ();
  1231. }
  1232. }
  1233. }
  1234. /// <summary>
  1235. /// Displays the specified character in the specified column and row of the View.
  1236. /// </summary>
  1237. /// <param name="col">Column (view-relative).</param>
  1238. /// <param name="row">Row (view-relative).</param>
  1239. /// <param name="ch">Ch.</param>
  1240. public void AddRune (int col, int row, Rune ch)
  1241. {
  1242. if (row < 0 || col < 0)
  1243. return;
  1244. if (row > frame.Height - 1 || col > frame.Width - 1)
  1245. return;
  1246. Move (col, row);
  1247. Driver.AddRune (ch);
  1248. }
  1249. /// <summary>
  1250. /// Removes the <see cref="SetNeedsDisplay()"/> and the <see cref="ChildNeedsDisplay"/> setting on this view.
  1251. /// </summary>
  1252. protected void ClearNeedsDisplay ()
  1253. {
  1254. NeedDisplay = Rect.Empty;
  1255. ChildNeedsDisplay = false;
  1256. }
  1257. /// <summary>
  1258. /// Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1259. /// </summary>
  1260. /// <param name="bounds">The bounds (view-relative region) to redraw.</param>
  1261. /// <remarks>
  1262. /// <para>
  1263. /// Always use <see cref="Bounds"/> (view-relative) when calling <see cref="Redraw(Rect)"/>, NOT <see cref="Frame"/> (superview-relative).
  1264. /// </para>
  1265. /// <para>
  1266. /// Views should set the color that they want to use on entry, as otherwise this will inherit
  1267. /// the last color that was set globally on the driver.
  1268. /// </para>
  1269. /// <para>
  1270. /// Overrides of <see cref="Redraw"/> must ensure they do not set <c>Driver.Clip</c> to a clip region
  1271. /// larger than the <c>region</c> parameter.
  1272. /// </para>
  1273. /// </remarks>
  1274. public virtual void Redraw (Rect bounds)
  1275. {
  1276. if (!CanBeVisible (this)) {
  1277. return;
  1278. }
  1279. var clipRect = new Rect (Point.Empty, frame.Size);
  1280. //if (ColorScheme != null && !(this is Toplevel)) {
  1281. if (ColorScheme != null) {
  1282. Driver.SetAttribute (HasFocus ? ColorScheme.Focus : ColorScheme.Normal);
  1283. }
  1284. if (Border != null) {
  1285. Border.DrawContent (this);
  1286. }
  1287. if (!ustring.IsNullOrEmpty (TextFormatter.Text) || (this is Label && !AutoSize)) {
  1288. Clear ();
  1289. // Draw any Text
  1290. if (TextFormatter != null) {
  1291. TextFormatter.NeedsFormat = true;
  1292. }
  1293. var containerBounds = SuperView == null ? default : SuperView.ViewToScreen (SuperView.Bounds);
  1294. containerBounds.X = Math.Max (containerBounds.X, Driver.Clip.X);
  1295. containerBounds.Y = Math.Max (containerBounds.Y, Driver.Clip.Y);
  1296. containerBounds.Width = Math.Min (containerBounds.Width, Driver.Clip.Width);
  1297. containerBounds.Height = Math.Min (containerBounds.Height, Driver.Clip.Height);
  1298. TextFormatter?.Draw (ViewToScreen (Bounds), HasFocus ? ColorScheme.Focus : GetNormalColor (),
  1299. HasFocus ? ColorScheme.HotFocus : Enabled ? ColorScheme.HotNormal : ColorScheme.Disabled,
  1300. containerBounds);
  1301. }
  1302. // Invoke DrawContentEvent
  1303. OnDrawContent (bounds);
  1304. if (subviews != null) {
  1305. foreach (var view in subviews) {
  1306. if (!view.NeedDisplay.IsEmpty || view.ChildNeedsDisplay || view.LayoutNeeded) {
  1307. if (view.Frame.IntersectsWith (clipRect) && (view.Frame.IntersectsWith (bounds) || bounds.X < 0 || bounds.Y < 0)) {
  1308. if (view.LayoutNeeded)
  1309. view.LayoutSubviews ();
  1310. // Draw the subview
  1311. // Use the view's bounds (view-relative; Location will always be (0,0)
  1312. if (view.Visible && view.Frame.Width > 0 && view.Frame.Height > 0) {
  1313. var rect = new Rect () {
  1314. X = Math.Min (view.Bounds.X, view.NeedDisplay.X),
  1315. Y = Math.Min (view.Bounds.Y, view.NeedDisplay.Y),
  1316. Width = Math.Max (view.Bounds.Width, view.NeedDisplay.Width),
  1317. Height = Math.Max (view.Bounds.Height, view.NeedDisplay.Height)
  1318. };
  1319. view.OnDrawContent (rect);
  1320. view.Redraw (rect);
  1321. }
  1322. }
  1323. view.NeedDisplay = Rect.Empty;
  1324. view.ChildNeedsDisplay = false;
  1325. }
  1326. }
  1327. }
  1328. // Invoke DrawContentCompleteEvent
  1329. OnDrawContentComplete (bounds);
  1330. ClearLayoutNeeded ();
  1331. ClearNeedsDisplay ();
  1332. }
  1333. /// <summary>
  1334. /// Event invoked when the content area of the View is to be drawn.
  1335. /// </summary>
  1336. /// <remarks>
  1337. /// <para>
  1338. /// Will be invoked before any subviews added with <see cref="Add(View)"/> have been drawn.
  1339. /// </para>
  1340. /// <para>
  1341. /// Rect provides the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.
  1342. /// </para>
  1343. /// </remarks>
  1344. public event Action<Rect> DrawContent;
  1345. /// <summary>
  1346. /// Enables overrides to draw infinitely scrolled content and/or a background behind added controls.
  1347. /// </summary>
  1348. /// <param name="viewport">The view-relative rectangle describing the currently visible viewport into the <see cref="View"/></param>
  1349. /// <remarks>
  1350. /// This method will be called before any subviews added with <see cref="Add(View)"/> have been drawn.
  1351. /// </remarks>
  1352. public virtual void OnDrawContent (Rect viewport)
  1353. {
  1354. DrawContent?.Invoke (viewport);
  1355. }
  1356. /// <summary>
  1357. /// Event invoked when the content area of the View is completed drawing.
  1358. /// </summary>
  1359. /// <remarks>
  1360. /// <para>
  1361. /// Will be invoked after any subviews removed with <see cref="Remove(View)"/> have been completed drawing.
  1362. /// </para>
  1363. /// <para>
  1364. /// Rect provides the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.
  1365. /// </para>
  1366. /// </remarks>
  1367. public event Action<Rect> DrawContentComplete;
  1368. /// <summary>
  1369. /// Enables overrides after completed drawing infinitely scrolled content and/or a background behind removed controls.
  1370. /// </summary>
  1371. /// <param name="viewport">The view-relative rectangle describing the currently visible viewport into the <see cref="View"/></param>
  1372. /// <remarks>
  1373. /// This method will be called after any subviews removed with <see cref="Remove(View)"/> have been completed drawing.
  1374. /// </remarks>
  1375. public virtual void OnDrawContentComplete (Rect viewport)
  1376. {
  1377. DrawContentComplete?.Invoke (viewport);
  1378. }
  1379. /// <summary>
  1380. /// Causes the specified subview to have focus.
  1381. /// </summary>
  1382. /// <param name="view">View.</param>
  1383. void SetFocus (View view)
  1384. {
  1385. if (view == null)
  1386. return;
  1387. //Console.WriteLine ($"Request to focus {view}");
  1388. if (!view.CanFocus || !view.Visible || !view.Enabled)
  1389. return;
  1390. if (focused?.hasFocus == true && focused == view)
  1391. return;
  1392. // Make sure that this view is a subview
  1393. View c;
  1394. for (c = view.container; c != null; c = c.container)
  1395. if (c == this)
  1396. break;
  1397. if (c == null)
  1398. throw new ArgumentException ("the specified view is not part of the hierarchy of this view");
  1399. if (focused != null)
  1400. focused.SetHasFocus (false, view);
  1401. var f = focused;
  1402. focused = view;
  1403. focused.SetHasFocus (true, f);
  1404. focused.EnsureFocus ();
  1405. // Send focus upwards
  1406. SuperView?.SetFocus (this);
  1407. }
  1408. /// <summary>
  1409. /// Causes the specified view and the entire parent hierarchy to have the focused order updated.
  1410. /// </summary>
  1411. public void SetFocus ()
  1412. {
  1413. if (!CanBeVisible (this) || !Enabled) {
  1414. if (HasFocus) {
  1415. SetHasFocus (false, this);
  1416. }
  1417. return;
  1418. }
  1419. SuperView?.SetFocus (this);
  1420. }
  1421. /// <summary>
  1422. /// Defines the event arguments for <see cref="KeyEvent"/>
  1423. /// </summary>
  1424. public class KeyEventEventArgs : EventArgs {
  1425. /// <summary>
  1426. /// Constructs.
  1427. /// </summary>
  1428. /// <param name="ke"></param>
  1429. public KeyEventEventArgs (KeyEvent ke) => KeyEvent = ke;
  1430. /// <summary>
  1431. /// The <see cref="KeyEvent"/> for the event.
  1432. /// </summary>
  1433. public KeyEvent KeyEvent { get; set; }
  1434. /// <summary>
  1435. /// Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber.
  1436. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  1437. /// </summary>
  1438. public bool Handled { get; set; } = false;
  1439. }
  1440. /// <summary>
  1441. /// Invoked when a character key is pressed and occurs after the key up event.
  1442. /// </summary>
  1443. public event Action<KeyEventEventArgs> KeyPress;
  1444. /// <inheritdoc/>
  1445. public override bool ProcessKey (KeyEvent keyEvent)
  1446. {
  1447. if (!Enabled) {
  1448. return false;
  1449. }
  1450. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1451. KeyPress?.Invoke (args);
  1452. if (args.Handled)
  1453. return true;
  1454. if (Focused?.Enabled == true) {
  1455. Focused?.KeyPress?.Invoke (args);
  1456. if (args.Handled)
  1457. return true;
  1458. }
  1459. if (Focused?.Enabled == true && Focused?.ProcessKey (keyEvent) == true)
  1460. return true;
  1461. return false;
  1462. }
  1463. /// <summary>
  1464. /// Invokes any binding that is registered on this <see cref="View"/>
  1465. /// and matches the <paramref name="keyEvent"/>
  1466. /// </summary>
  1467. /// <param name="keyEvent">The key event passed.</param>
  1468. protected bool? InvokeKeybindings (KeyEvent keyEvent)
  1469. {
  1470. if (KeyBindings.ContainsKey (keyEvent.Key)) {
  1471. var command = KeyBindings [keyEvent.Key];
  1472. if (!CommandImplementations.ContainsKey (command)) {
  1473. throw new NotSupportedException ($"A KeyBinding was set up for the command {command} ({keyEvent.Key}) but that command is not supported by this View ({GetType ().Name})");
  1474. }
  1475. return CommandImplementations [command] ();
  1476. }
  1477. return null;
  1478. }
  1479. /// <summary>
  1480. /// <para>Adds a new key combination that will trigger the given <paramref name="command"/>
  1481. /// (if supported by the View - see <see cref="GetSupportedCommands"/>)
  1482. /// </para>
  1483. /// <para>If the key is already bound to a different <see cref="Command"/> it will be
  1484. /// rebound to this one</para>
  1485. /// </summary>
  1486. /// <param name="key"></param>
  1487. /// <param name="command"></param>
  1488. public void AddKeyBinding (Key key, Command command)
  1489. {
  1490. if (KeyBindings.ContainsKey (key)) {
  1491. KeyBindings [key] = command;
  1492. } else {
  1493. KeyBindings.Add (key, command);
  1494. }
  1495. }
  1496. /// <summary>
  1497. /// Replaces a key combination already bound to <see cref="Command"/>.
  1498. /// </summary>
  1499. /// <param name="fromKey">The key to be replaced.</param>
  1500. /// <param name="toKey">The new key to be used.</param>
  1501. protected void ReplaceKeyBinding (Key fromKey, Key toKey)
  1502. {
  1503. if (KeyBindings.ContainsKey (fromKey)) {
  1504. Command value = KeyBindings [fromKey];
  1505. KeyBindings.Remove (fromKey);
  1506. KeyBindings [toKey] = value;
  1507. }
  1508. }
  1509. /// <summary>
  1510. /// Checks if key combination already exist.
  1511. /// </summary>
  1512. /// <param name="key">The key to check.</param>
  1513. /// <returns><c>true</c> If the key already exist, <c>false</c>otherwise.</returns>
  1514. public bool ContainsKeyBinding (Key key)
  1515. {
  1516. return KeyBindings.ContainsKey (key);
  1517. }
  1518. /// <summary>
  1519. /// Removes all bound keys from the View making including the default
  1520. /// key combinations such as cursor navigation, scrolling etc
  1521. /// </summary>
  1522. public void ClearKeybindings ()
  1523. {
  1524. KeyBindings.Clear ();
  1525. }
  1526. /// <summary>
  1527. /// Clears the existing keybinding (if any) for the given <paramref name="key"/>
  1528. /// </summary>
  1529. /// <param name="key"></param>
  1530. public void ClearKeybinding (Key key)
  1531. {
  1532. KeyBindings.Remove (key);
  1533. }
  1534. /// <summary>
  1535. /// Removes all key bindings that trigger the given command. Views can have multiple different
  1536. /// keys bound to the same command and this method will clear all of them.
  1537. /// </summary>
  1538. /// <param name="command"></param>
  1539. public void ClearKeybinding (Command command)
  1540. {
  1541. foreach (var kvp in KeyBindings.Where (kvp => kvp.Value == command).ToArray ()) {
  1542. KeyBindings.Remove (kvp.Key);
  1543. }
  1544. }
  1545. /// <summary>
  1546. /// <para>States that the given <see cref="View"/> supports a given <paramref name="command"/>
  1547. /// and what <paramref name="f"/> to perform to make that command happen
  1548. /// </para>
  1549. /// <para>If the <paramref name="command"/> already has an implementation the <paramref name="f"/>
  1550. /// will replace the old one</para>
  1551. /// </summary>
  1552. /// <param name="command">The command.</param>
  1553. /// <param name="f">The function.</param>
  1554. protected void AddCommand (Command command, Func<bool?> f)
  1555. {
  1556. // if there is already an implementation of this command
  1557. if (CommandImplementations.ContainsKey (command)) {
  1558. // replace that implementation
  1559. CommandImplementations [command] = f;
  1560. } else {
  1561. // else record how to perform the action (this should be the normal case)
  1562. CommandImplementations.Add (command, f);
  1563. }
  1564. }
  1565. /// <summary>
  1566. /// Returns all commands that are supported by this <see cref="View"/>
  1567. /// </summary>
  1568. /// <returns></returns>
  1569. public IEnumerable<Command> GetSupportedCommands ()
  1570. {
  1571. return CommandImplementations.Keys;
  1572. }
  1573. /// <summary>
  1574. /// Gets the key used by a command.
  1575. /// </summary>
  1576. /// <param name="command">The command to search.</param>
  1577. /// <returns>The <see cref="Key"/> used by a <see cref="Command"/></returns>
  1578. public Key GetKeyFromCommand (Command command)
  1579. {
  1580. return KeyBindings.First (x => x.Value == command).Key;
  1581. }
  1582. /// <inheritdoc/>
  1583. public override bool ProcessHotKey (KeyEvent keyEvent)
  1584. {
  1585. if (!Enabled) {
  1586. return false;
  1587. }
  1588. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1589. if (MostFocused?.Enabled == true) {
  1590. MostFocused?.KeyPress?.Invoke (args);
  1591. if (args.Handled)
  1592. return true;
  1593. }
  1594. if (MostFocused?.Enabled == true && MostFocused?.ProcessKey (keyEvent) == true)
  1595. return true;
  1596. if (subviews == null || subviews.Count == 0)
  1597. return false;
  1598. foreach (var view in subviews)
  1599. if (view.Enabled && view.ProcessHotKey (keyEvent))
  1600. return true;
  1601. return false;
  1602. }
  1603. /// <inheritdoc/>
  1604. public override bool ProcessColdKey (KeyEvent keyEvent)
  1605. {
  1606. if (!Enabled) {
  1607. return false;
  1608. }
  1609. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1610. KeyPress?.Invoke (args);
  1611. if (args.Handled)
  1612. return true;
  1613. if (MostFocused?.Enabled == true) {
  1614. MostFocused?.KeyPress?.Invoke (args);
  1615. if (args.Handled)
  1616. return true;
  1617. }
  1618. if (MostFocused?.Enabled == true && MostFocused?.ProcessKey (keyEvent) == true)
  1619. return true;
  1620. if (subviews == null || subviews.Count == 0)
  1621. return false;
  1622. foreach (var view in subviews)
  1623. if (view.Enabled && view.ProcessColdKey (keyEvent))
  1624. return true;
  1625. return false;
  1626. }
  1627. /// <summary>
  1628. /// Invoked when a key is pressed
  1629. /// </summary>
  1630. public event Action<KeyEventEventArgs> KeyDown;
  1631. /// <inheritdoc/>
  1632. public override bool OnKeyDown (KeyEvent keyEvent)
  1633. {
  1634. if (!Enabled) {
  1635. return false;
  1636. }
  1637. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1638. KeyDown?.Invoke (args);
  1639. if (args.Handled) {
  1640. return true;
  1641. }
  1642. if (Focused?.Enabled == true && Focused?.OnKeyDown (keyEvent) == true) {
  1643. return true;
  1644. }
  1645. return false;
  1646. }
  1647. /// <summary>
  1648. /// Invoked when a key is released
  1649. /// </summary>
  1650. public event Action<KeyEventEventArgs> KeyUp;
  1651. /// <inheritdoc/>
  1652. public override bool OnKeyUp (KeyEvent keyEvent)
  1653. {
  1654. if (!Enabled) {
  1655. return false;
  1656. }
  1657. KeyEventEventArgs args = new KeyEventEventArgs (keyEvent);
  1658. KeyUp?.Invoke (args);
  1659. if (args.Handled) {
  1660. return true;
  1661. }
  1662. if (Focused?.Enabled == true && Focused?.OnKeyUp (keyEvent) == true) {
  1663. return true;
  1664. }
  1665. return false;
  1666. }
  1667. /// <summary>
  1668. /// Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
  1669. /// </summary>
  1670. public void EnsureFocus ()
  1671. {
  1672. if (focused == null && subviews?.Count > 0) {
  1673. if (FocusDirection == Direction.Forward) {
  1674. FocusFirst ();
  1675. } else {
  1676. FocusLast ();
  1677. }
  1678. }
  1679. }
  1680. /// <summary>
  1681. /// Focuses the first focusable subview if one exists.
  1682. /// </summary>
  1683. public void FocusFirst ()
  1684. {
  1685. if (!CanBeVisible (this)) {
  1686. return;
  1687. }
  1688. if (tabIndexes == null) {
  1689. SuperView?.SetFocus (this);
  1690. return;
  1691. }
  1692. foreach (var view in tabIndexes) {
  1693. if (view.CanFocus && view.tabStop && view.Visible && view.Enabled) {
  1694. SetFocus (view);
  1695. return;
  1696. }
  1697. }
  1698. }
  1699. /// <summary>
  1700. /// Focuses the last focusable subview if one exists.
  1701. /// </summary>
  1702. public void FocusLast ()
  1703. {
  1704. if (!CanBeVisible (this)) {
  1705. return;
  1706. }
  1707. if (tabIndexes == null) {
  1708. SuperView?.SetFocus (this);
  1709. return;
  1710. }
  1711. for (int i = tabIndexes.Count; i > 0;) {
  1712. i--;
  1713. View v = tabIndexes [i];
  1714. if (v.CanFocus && v.tabStop && v.Visible && v.Enabled) {
  1715. SetFocus (v);
  1716. return;
  1717. }
  1718. }
  1719. }
  1720. /// <summary>
  1721. /// Focuses the previous view.
  1722. /// </summary>
  1723. /// <returns><c>true</c>, if previous was focused, <c>false</c> otherwise.</returns>
  1724. public bool FocusPrev ()
  1725. {
  1726. if (!CanBeVisible (this)) {
  1727. return false;
  1728. }
  1729. FocusDirection = Direction.Backward;
  1730. if (tabIndexes == null || tabIndexes.Count == 0)
  1731. return false;
  1732. if (focused == null) {
  1733. FocusLast ();
  1734. return focused != null;
  1735. }
  1736. int focused_idx = -1;
  1737. for (int i = tabIndexes.Count; i > 0;) {
  1738. i--;
  1739. View w = tabIndexes [i];
  1740. if (w.HasFocus) {
  1741. if (w.FocusPrev ())
  1742. return true;
  1743. focused_idx = i;
  1744. continue;
  1745. }
  1746. if (w.CanFocus && focused_idx != -1 && w.tabStop && w.Visible && w.Enabled) {
  1747. focused.SetHasFocus (false, w);
  1748. if (w != null && w.CanFocus && w.tabStop && w.Visible && w.Enabled)
  1749. w.FocusLast ();
  1750. SetFocus (w);
  1751. return true;
  1752. }
  1753. }
  1754. if (focused != null) {
  1755. focused.SetHasFocus (false, this);
  1756. focused = null;
  1757. }
  1758. return false;
  1759. }
  1760. /// <summary>
  1761. /// Focuses the next view.
  1762. /// </summary>
  1763. /// <returns><c>true</c>, if next was focused, <c>false</c> otherwise.</returns>
  1764. public bool FocusNext ()
  1765. {
  1766. if (!CanBeVisible (this)) {
  1767. return false;
  1768. }
  1769. FocusDirection = Direction.Forward;
  1770. if (tabIndexes == null || tabIndexes.Count == 0)
  1771. return false;
  1772. if (focused == null) {
  1773. FocusFirst ();
  1774. return focused != null;
  1775. }
  1776. int n = tabIndexes.Count;
  1777. int focused_idx = -1;
  1778. for (int i = 0; i < n; i++) {
  1779. View w = tabIndexes [i];
  1780. if (w.HasFocus) {
  1781. if (w.FocusNext ())
  1782. return true;
  1783. focused_idx = i;
  1784. continue;
  1785. }
  1786. if (w.CanFocus && focused_idx != -1 && w.tabStop && w.Visible && w.Enabled) {
  1787. focused.SetHasFocus (false, w);
  1788. if (w != null && w.CanFocus && w.tabStop && w.Visible && w.Enabled)
  1789. w.FocusFirst ();
  1790. SetFocus (w);
  1791. return true;
  1792. }
  1793. }
  1794. if (focused != null) {
  1795. focused.SetHasFocus (false, this);
  1796. focused = null;
  1797. }
  1798. return false;
  1799. }
  1800. View GetMostFocused (View view)
  1801. {
  1802. if (view == null) {
  1803. return view;
  1804. }
  1805. if (view.focused != null) {
  1806. return GetMostFocused (view.focused);
  1807. } else {
  1808. return view;
  1809. }
  1810. }
  1811. /// <summary>
  1812. /// Sets the View's <see cref="Frame"/> to the relative coordinates if its container, given the <see cref="Frame"/> for its container.
  1813. /// </summary>
  1814. /// <param name="hostFrame">The screen-relative frame for the host.</param>
  1815. /// <remarks>
  1816. /// Reminder: <see cref="Frame"/> is superview-relative; <see cref="Bounds"/> is view-relative.
  1817. /// </remarks>
  1818. internal void SetRelativeLayout (Rect hostFrame)
  1819. {
  1820. int w, h, _x, _y;
  1821. if (x is Pos.PosCenter) {
  1822. if (width == null)
  1823. w = hostFrame.Width;
  1824. else
  1825. w = width.Anchor (hostFrame.Width);
  1826. _x = x.Anchor (hostFrame.Width - w);
  1827. } else {
  1828. if (x == null)
  1829. _x = 0;
  1830. else
  1831. _x = x.Anchor (hostFrame.Width);
  1832. if (width == null)
  1833. w = hostFrame.Width;
  1834. else if (width is Dim.DimFactor && !((Dim.DimFactor)width).IsFromRemaining ())
  1835. w = width.Anchor (hostFrame.Width);
  1836. else
  1837. w = Math.Max (width.Anchor (hostFrame.Width - _x), 0);
  1838. }
  1839. if (y is Pos.PosCenter) {
  1840. if (height == null)
  1841. h = hostFrame.Height;
  1842. else
  1843. h = height.Anchor (hostFrame.Height);
  1844. _y = y.Anchor (hostFrame.Height - h);
  1845. } else {
  1846. if (y == null)
  1847. _y = 0;
  1848. else
  1849. _y = y.Anchor (hostFrame.Height);
  1850. if (height == null)
  1851. h = hostFrame.Height;
  1852. else if (height is Dim.DimFactor && !((Dim.DimFactor)height).IsFromRemaining ())
  1853. h = height.Anchor (hostFrame.Height);
  1854. else
  1855. h = Math.Max (height.Anchor (hostFrame.Height - _y), 0);
  1856. }
  1857. var r = new Rect (_x, _y, w, h);
  1858. if (Frame != r) {
  1859. Frame = new Rect (_x, _y, w, h);
  1860. }
  1861. }
  1862. // https://en.wikipedia.org/wiki/Topological_sorting
  1863. List<View> TopologicalSort (HashSet<View> nodes, HashSet<(View From, View To)> edges)
  1864. {
  1865. var result = new List<View> ();
  1866. // Set of all nodes with no incoming edges
  1867. var S = new HashSet<View> (nodes.Where (n => edges.All (e => !e.To.Equals (n))));
  1868. while (S.Any ()) {
  1869. // remove a node n from S
  1870. var n = S.First ();
  1871. S.Remove (n);
  1872. // add n to tail of L
  1873. if (n != this?.SuperView)
  1874. result.Add (n);
  1875. // for each node m with an edge e from n to m do
  1876. foreach (var e in edges.Where (e => e.From.Equals (n)).ToArray ()) {
  1877. var m = e.To;
  1878. // remove edge e from the graph
  1879. edges.Remove (e);
  1880. // if m has no other incoming edges then
  1881. if (edges.All (me => !me.To.Equals (m)) && m != this?.SuperView) {
  1882. // insert m into S
  1883. S.Add (m);
  1884. }
  1885. }
  1886. }
  1887. if (edges.Any ()) {
  1888. var (from, to) = edges.First ();
  1889. if (from != Application.Top) {
  1890. if (!ReferenceEquals (from, to)) {
  1891. throw new InvalidOperationException ($"TopologicalSort (for Pos/Dim) cannot find {from} linked with {to}. Did you forget to add it to {this}?");
  1892. } else {
  1893. throw new InvalidOperationException ("TopologicalSort encountered a recursive cycle in the relative Pos/Dim in the views of " + this);
  1894. }
  1895. }
  1896. }
  1897. // return L (a topologically sorted order)
  1898. return result;
  1899. }
  1900. /// <summary>
  1901. /// Event arguments for the <see cref="LayoutComplete"/> event.
  1902. /// </summary>
  1903. public class LayoutEventArgs : EventArgs {
  1904. /// <summary>
  1905. /// The view-relative bounds of the <see cref="View"/> before it was laid out.
  1906. /// </summary>
  1907. public Rect OldBounds { get; set; }
  1908. }
  1909. /// <summary>
  1910. /// Fired after the Views's <see cref="LayoutSubviews"/> method has completed.
  1911. /// </summary>
  1912. /// <remarks>
  1913. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  1914. /// </remarks>
  1915. public event Action<LayoutEventArgs> LayoutStarted;
  1916. /// <summary>
  1917. /// Raises the <see cref="LayoutStarted"/> event. Called from <see cref="LayoutSubviews"/> before any subviews have been laid out.
  1918. /// </summary>
  1919. internal virtual void OnLayoutStarted (LayoutEventArgs args)
  1920. {
  1921. LayoutStarted?.Invoke (args);
  1922. }
  1923. /// <summary>
  1924. /// Fired after the Views's <see cref="LayoutSubviews"/> method has completed.
  1925. /// </summary>
  1926. /// <remarks>
  1927. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  1928. /// </remarks>
  1929. public event Action<LayoutEventArgs> LayoutComplete;
  1930. /// <summary>
  1931. /// Event called only once when the <see cref="View"/> is being initialized for the first time.
  1932. /// Allows configurations and assignments to be performed before the <see cref="View"/> being shown.
  1933. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  1934. /// </summary>
  1935. public event EventHandler Initialized;
  1936. /// <summary>
  1937. /// Raises the <see cref="LayoutComplete"/> event. Called from <see cref="LayoutSubviews"/> before all sub-views have been laid out.
  1938. /// </summary>
  1939. internal virtual void OnLayoutComplete (LayoutEventArgs args)
  1940. {
  1941. LayoutComplete?.Invoke (args);
  1942. }
  1943. /// <summary>
  1944. /// Invoked when a view starts executing or when the dimensions of the view have changed, for example in
  1945. /// response to the container view or terminal resizing.
  1946. /// </summary>
  1947. /// <remarks>
  1948. /// Calls <see cref="OnLayoutComplete"/> (which raises the <see cref="LayoutComplete"/> event) before it returns.
  1949. /// </remarks>
  1950. public virtual void LayoutSubviews ()
  1951. {
  1952. if (!LayoutNeeded) {
  1953. return;
  1954. }
  1955. Rect oldBounds = Bounds;
  1956. OnLayoutStarted (new LayoutEventArgs () { OldBounds = oldBounds });
  1957. TextFormatter.Size = Bounds.Size;
  1958. // Sort out the dependencies of the X, Y, Width, Height properties
  1959. var nodes = new HashSet<View> ();
  1960. var edges = new HashSet<(View, View)> ();
  1961. void CollectPos (Pos pos, View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  1962. {
  1963. if (pos is Pos.PosView pv) {
  1964. if (pv.Target != this) {
  1965. nEdges.Add ((pv.Target, from));
  1966. }
  1967. foreach (var v in from.InternalSubviews) {
  1968. CollectAll (v, ref nNodes, ref nEdges);
  1969. }
  1970. return;
  1971. }
  1972. if (pos is Pos.PosCombine pc) {
  1973. foreach (var v in from.InternalSubviews) {
  1974. CollectPos (pc.left, from, ref nNodes, ref nEdges);
  1975. CollectPos (pc.right, from, ref nNodes, ref nEdges);
  1976. }
  1977. }
  1978. }
  1979. void CollectDim (Dim dim, View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  1980. {
  1981. if (dim is Dim.DimView dv) {
  1982. if (dv.Target != this) {
  1983. nEdges.Add ((dv.Target, from));
  1984. }
  1985. foreach (var v in from.InternalSubviews) {
  1986. CollectAll (v, ref nNodes, ref nEdges);
  1987. }
  1988. return;
  1989. }
  1990. if (dim is Dim.DimCombine dc) {
  1991. foreach (var v in from.InternalSubviews) {
  1992. CollectDim (dc.left, from, ref nNodes, ref nEdges);
  1993. CollectDim (dc.right, from, ref nNodes, ref nEdges);
  1994. }
  1995. }
  1996. }
  1997. void CollectAll (View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  1998. {
  1999. foreach (var v in from.InternalSubviews) {
  2000. nNodes.Add (v);
  2001. if (v.layoutStyle != LayoutStyle.Computed) {
  2002. continue;
  2003. }
  2004. CollectPos (v.X, v, ref nNodes, ref nEdges);
  2005. CollectPos (v.Y, v, ref nNodes, ref nEdges);
  2006. CollectDim (v.Width, v, ref nNodes, ref nEdges);
  2007. CollectDim (v.Height, v, ref nNodes, ref nEdges);
  2008. }
  2009. }
  2010. CollectAll (this, ref nodes, ref edges);
  2011. var ordered = TopologicalSort (nodes, edges);
  2012. foreach (var v in ordered) {
  2013. if (v.LayoutStyle == LayoutStyle.Computed) {
  2014. v.SetRelativeLayout (Frame);
  2015. }
  2016. v.LayoutSubviews ();
  2017. v.LayoutNeeded = false;
  2018. }
  2019. if (SuperView != null && SuperView == Application.Top && LayoutNeeded
  2020. && ordered.Count == 0 && LayoutStyle == LayoutStyle.Computed) {
  2021. SetRelativeLayout (SuperView.Frame);
  2022. }
  2023. LayoutNeeded = false;
  2024. OnLayoutComplete (new LayoutEventArgs () { OldBounds = oldBounds });
  2025. }
  2026. /// <summary>
  2027. /// The text displayed by the <see cref="View"/>.
  2028. /// </summary>
  2029. /// <remarks>
  2030. /// <para>
  2031. /// If provided, the text will be drawn before any subviews are drawn.
  2032. /// </para>
  2033. /// <para>
  2034. /// The text will be drawn starting at the view origin (0, 0) and will be formatted according
  2035. /// to the <see cref="TextAlignment"/> property. If the view's height is greater than 1, the
  2036. /// text will word-wrap to additional lines if it does not fit horizontally. If the view's height
  2037. /// is 1, the text will be clipped.
  2038. /// </para>
  2039. /// <para>
  2040. /// Set the <see cref="HotKeySpecifier"/> to enable hotkey support. To disable hotkey support set <see cref="HotKeySpecifier"/> to
  2041. /// <c>(Rune)0xffff</c>.
  2042. /// </para>
  2043. /// </remarks>
  2044. public virtual ustring Text {
  2045. get => TextFormatter.Text;
  2046. set {
  2047. TextFormatter.Text = value;
  2048. var prevSize = frame.Size;
  2049. var canResize = ResizeView (autoSize);
  2050. if (canResize && TextFormatter.Size != Bounds.Size) {
  2051. Bounds = new Rect (new Point (Bounds.X, Bounds.Y), TextFormatter.Size);
  2052. } else if (!canResize && TextFormatter.Size != Bounds.Size) {
  2053. TextFormatter.Size = Bounds.Size;
  2054. }
  2055. SetNeedsLayout ();
  2056. SetNeedsDisplay (new Rect (new Point (0, 0),
  2057. new Size (Math.Max (frame.Width, prevSize.Width), Math.Max (frame.Height, prevSize.Height))));
  2058. }
  2059. }
  2060. /// <summary>
  2061. /// Used by <see cref="Text"/> to resize the view's <see cref="Bounds"/> with the <see cref="TextFormatter.Size"/>.
  2062. /// Setting <see cref="AutoSize"/> to true only work if the <see cref="Width"/> and <see cref="Height"/> are null or
  2063. /// <see cref="LayoutStyle.Absolute"/> values and doesn't work with <see cref="LayoutStyle.Computed"/> layout,
  2064. /// to avoid breaking the <see cref="Pos"/> and <see cref="Dim"/> settings.
  2065. /// </summary>
  2066. public virtual bool AutoSize {
  2067. get => autoSize;
  2068. set {
  2069. var v = ResizeView (value);
  2070. TextFormatter.AutoSize = v;
  2071. if (autoSize != v) {
  2072. autoSize = v;
  2073. TextFormatter.NeedsFormat = true;
  2074. SetNeedsLayout ();
  2075. SetNeedsDisplay ();
  2076. }
  2077. }
  2078. }
  2079. /// <summary>
  2080. /// Gets or sets how the View's <see cref="Text"/> is aligned horizontally when drawn. Changing this property will redisplay the <see cref="View"/>.
  2081. /// </summary>
  2082. /// <value>The text alignment.</value>
  2083. public virtual TextAlignment TextAlignment {
  2084. get => TextFormatter.Alignment;
  2085. set {
  2086. TextFormatter.Alignment = value;
  2087. SetNeedsDisplay ();
  2088. }
  2089. }
  2090. /// <summary>
  2091. /// Gets or sets how the View's <see cref="Text"/> is aligned verticaly when drawn. Changing this property will redisplay the <see cref="View"/>.
  2092. /// </summary>
  2093. /// <value>The text alignment.</value>
  2094. public virtual VerticalTextAlignment VerticalTextAlignment {
  2095. get => TextFormatter.VerticalAlignment;
  2096. set {
  2097. TextFormatter.VerticalAlignment = value;
  2098. SetNeedsDisplay ();
  2099. }
  2100. }
  2101. /// <summary>
  2102. /// Gets or sets the direction of the View's <see cref="Text"/>. Changing this property will redisplay the <see cref="View"/>.
  2103. /// </summary>
  2104. /// <value>The text alignment.</value>
  2105. public virtual TextDirection TextDirection {
  2106. get => TextFormatter.Direction;
  2107. set {
  2108. if (TextFormatter.Direction != value) {
  2109. TextFormatter.Direction = value;
  2110. if (AutoSize) {
  2111. ResizeView (true);
  2112. } else if (IsInitialized) {
  2113. var b = new Rect (Bounds.X, Bounds.Y, Bounds.Height, Bounds.Width);
  2114. SetWidthHeight (b);
  2115. }
  2116. TextFormatter.Size = Bounds.Size;
  2117. SetNeedsDisplay ();
  2118. }
  2119. }
  2120. }
  2121. /// <summary>
  2122. /// Get or sets if the <see cref="View"/> was already initialized.
  2123. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  2124. /// </summary>
  2125. public virtual bool IsInitialized { get; set; }
  2126. bool oldEnabled;
  2127. /// <inheritdoc/>
  2128. public override bool Enabled {
  2129. get => base.Enabled;
  2130. set {
  2131. if (base.Enabled != value) {
  2132. base.Enabled = value;
  2133. if (!value && HasFocus) {
  2134. SetHasFocus (false, this);
  2135. }
  2136. OnEnabledChanged ();
  2137. SetNeedsDisplay ();
  2138. if (subviews != null) {
  2139. foreach (var view in subviews) {
  2140. if (!value) {
  2141. view.oldEnabled = view.Enabled;
  2142. view.Enabled = value;
  2143. } else {
  2144. view.Enabled = view.oldEnabled;
  2145. view.addingView = false;
  2146. }
  2147. }
  2148. }
  2149. }
  2150. }
  2151. }
  2152. /// <inheritdoc/>>
  2153. public override bool Visible {
  2154. get => base.Visible;
  2155. set {
  2156. if (base.Visible != value) {
  2157. base.Visible = value;
  2158. if (!value && HasFocus) {
  2159. SetHasFocus (false, this);
  2160. }
  2161. OnVisibleChanged ();
  2162. SetNeedsDisplay ();
  2163. }
  2164. }
  2165. }
  2166. Border border;
  2167. /// <inheritdoc/>
  2168. public virtual Border Border {
  2169. get => border;
  2170. set {
  2171. if (border != value) {
  2172. border = value;
  2173. SetNeedsDisplay ();
  2174. }
  2175. }
  2176. }
  2177. /// <summary>
  2178. /// Pretty prints the View
  2179. /// </summary>
  2180. /// <returns></returns>
  2181. public override string ToString ()
  2182. {
  2183. return $"{GetType ().Name}({Id})({Frame})";
  2184. }
  2185. bool ResizeView (bool autoSize)
  2186. {
  2187. if (!autoSize) {
  2188. return false;
  2189. }
  2190. var aSize = autoSize;
  2191. Rect nBounds = TextFormatter.CalcRect (Bounds.X, Bounds.Y, Text, TextFormatter.Direction);
  2192. if (TextFormatter.Size != nBounds.Size) {
  2193. TextFormatter.Size = nBounds.Size;
  2194. }
  2195. if ((TextFormatter.Size != Bounds.Size || TextFormatter.Size != nBounds.Size)
  2196. && (((width == null || width is Dim.DimAbsolute) && (Bounds.Width == 0
  2197. || autoSize && Bounds.Width != nBounds.Width))
  2198. || ((height == null || height is Dim.DimAbsolute) && (Bounds.Height == 0
  2199. || autoSize && Bounds.Height != nBounds.Height)))) {
  2200. aSize = SetWidthHeight (nBounds);
  2201. }
  2202. return aSize;
  2203. }
  2204. bool SetWidthHeight (Rect nBounds)
  2205. {
  2206. bool aSize = false;
  2207. var canSizeW = SetWidth (nBounds.Width, out int rW);
  2208. var canSizeH = SetHeight (nBounds.Height, out int rH);
  2209. if (canSizeW) {
  2210. aSize = true;
  2211. width = rW;
  2212. }
  2213. if (canSizeH) {
  2214. aSize = true;
  2215. height = rH;
  2216. }
  2217. if (aSize) {
  2218. Bounds = new Rect (Bounds.X, Bounds.Y, canSizeW ? rW : Bounds.Width, canSizeH ? rH : Bounds.Height);
  2219. TextFormatter.Size = Bounds.Size;
  2220. }
  2221. return aSize;
  2222. }
  2223. /// <summary>
  2224. /// Specifies the event arguments for <see cref="MouseEvent"/>
  2225. /// </summary>
  2226. public class MouseEventArgs : EventArgs {
  2227. /// <summary>
  2228. /// Constructs.
  2229. /// </summary>
  2230. /// <param name="me"></param>
  2231. public MouseEventArgs (MouseEvent me) => MouseEvent = me;
  2232. /// <summary>
  2233. /// The <see cref="MouseEvent"/> for the event.
  2234. /// </summary>
  2235. public MouseEvent MouseEvent { get; set; }
  2236. /// <summary>
  2237. /// Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.
  2238. /// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
  2239. /// </summary>
  2240. public bool Handled { get; set; }
  2241. }
  2242. /// <inheritdoc/>
  2243. public override bool OnMouseEnter (MouseEvent mouseEvent)
  2244. {
  2245. if (!Enabled) {
  2246. return true;
  2247. }
  2248. if (!CanBeVisible (this)) {
  2249. return false;
  2250. }
  2251. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  2252. MouseEnter?.Invoke (args);
  2253. if (args.Handled)
  2254. return true;
  2255. if (base.OnMouseEnter (mouseEvent))
  2256. return true;
  2257. return false;
  2258. }
  2259. /// <inheritdoc/>
  2260. public override bool OnMouseLeave (MouseEvent mouseEvent)
  2261. {
  2262. if (!Enabled) {
  2263. return true;
  2264. }
  2265. if (!CanBeVisible (this)) {
  2266. return false;
  2267. }
  2268. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  2269. MouseLeave?.Invoke (args);
  2270. if (args.Handled)
  2271. return true;
  2272. if (base.OnMouseLeave (mouseEvent))
  2273. return true;
  2274. return false;
  2275. }
  2276. /// <summary>
  2277. /// Method invoked when a mouse event is generated
  2278. /// </summary>
  2279. /// <param name="mouseEvent"></param>
  2280. /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  2281. public virtual bool OnMouseEvent (MouseEvent mouseEvent)
  2282. {
  2283. if (!Enabled) {
  2284. return true;
  2285. }
  2286. if (!CanBeVisible (this)) {
  2287. return false;
  2288. }
  2289. MouseEventArgs args = new MouseEventArgs (mouseEvent);
  2290. if (OnMouseClick (args))
  2291. return true;
  2292. if (MouseEvent (mouseEvent))
  2293. return true;
  2294. if (mouseEvent.Flags == MouseFlags.Button1Clicked) {
  2295. if (CanFocus && !HasFocus && SuperView != null) {
  2296. SuperView.SetFocus (this);
  2297. SetNeedsDisplay ();
  2298. }
  2299. return true;
  2300. }
  2301. return false;
  2302. }
  2303. /// <summary>
  2304. /// Invokes the MouseClick event.
  2305. /// </summary>
  2306. protected bool OnMouseClick (MouseEventArgs args)
  2307. {
  2308. if (!Enabled) {
  2309. return true;
  2310. }
  2311. MouseClick?.Invoke (args);
  2312. return args.Handled;
  2313. }
  2314. /// <inheritdoc/>
  2315. public override void OnCanFocusChanged () => CanFocusChanged?.Invoke ();
  2316. /// <inheritdoc/>
  2317. public override void OnEnabledChanged () => EnabledChanged?.Invoke ();
  2318. /// <inheritdoc/>
  2319. public override void OnVisibleChanged () => VisibleChanged?.Invoke ();
  2320. /// <inheritdoc/>
  2321. protected override void Dispose (bool disposing)
  2322. {
  2323. for (int i = InternalSubviews.Count - 1; i >= 0; i--) {
  2324. View subview = InternalSubviews [i];
  2325. Remove (subview);
  2326. subview.Dispose ();
  2327. }
  2328. base.Dispose (disposing);
  2329. }
  2330. /// <summary>
  2331. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are beginning initialized.
  2332. /// </summary>
  2333. public void BeginInit ()
  2334. {
  2335. if (!IsInitialized) {
  2336. oldCanFocus = CanFocus;
  2337. oldTabIndex = tabIndex;
  2338. }
  2339. if (subviews?.Count > 0) {
  2340. foreach (var view in subviews) {
  2341. if (!view.IsInitialized) {
  2342. view.BeginInit ();
  2343. }
  2344. }
  2345. }
  2346. }
  2347. /// <summary>
  2348. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are ending initialized.
  2349. /// </summary>
  2350. public void EndInit ()
  2351. {
  2352. IsInitialized = true;
  2353. if (subviews?.Count > 0) {
  2354. foreach (var view in subviews) {
  2355. if (!view.IsInitialized) {
  2356. view.EndInit ();
  2357. }
  2358. }
  2359. }
  2360. Initialized?.Invoke (this, EventArgs.Empty);
  2361. }
  2362. bool CanBeVisible (View view)
  2363. {
  2364. if (!view.Visible) {
  2365. return false;
  2366. }
  2367. for (var c = view.SuperView; c != null; c = c.SuperView) {
  2368. if (!c.Visible) {
  2369. return false;
  2370. }
  2371. }
  2372. return true;
  2373. }
  2374. bool CanSetWidth (int desiredWidth, out int resultWidth)
  2375. {
  2376. int w = desiredWidth;
  2377. bool canSetWidth;
  2378. if (Width is Dim.DimCombine || Width is Dim.DimView || Width is Dim.DimFill) {
  2379. // It's a Dim.DimCombine and so can't be assigned. Let it have it's width anchored.
  2380. w = Width.Anchor (w);
  2381. canSetWidth = false;
  2382. } else if (Width is Dim.DimFactor factor) {
  2383. // Tries to get the SuperView width otherwise the view width.
  2384. var sw = SuperView != null ? SuperView.Frame.Width : w;
  2385. if (factor.IsFromRemaining ()) {
  2386. sw -= Frame.X;
  2387. }
  2388. w = Width.Anchor (sw);
  2389. canSetWidth = false;
  2390. } else {
  2391. canSetWidth = true;
  2392. }
  2393. resultWidth = w;
  2394. return canSetWidth;
  2395. }
  2396. bool CanSetHeight (int desiredHeight, out int resultHeight)
  2397. {
  2398. int h = desiredHeight;
  2399. bool canSetHeight;
  2400. if (Height is Dim.DimCombine || Height is Dim.DimView || Height is Dim.DimFill) {
  2401. // It's a Dim.DimCombine and so can't be assigned. Let it have it's height anchored.
  2402. h = Height.Anchor (h);
  2403. canSetHeight = false;
  2404. } else if (Height is Dim.DimFactor factor) {
  2405. // Tries to get the SuperView height otherwise the view height.
  2406. var sh = SuperView != null ? SuperView.Frame.Height : h;
  2407. if (factor.IsFromRemaining ()) {
  2408. sh -= Frame.Y;
  2409. }
  2410. h = Height.Anchor (sh);
  2411. canSetHeight = false;
  2412. } else {
  2413. canSetHeight = true;
  2414. }
  2415. resultHeight = h;
  2416. return canSetHeight;
  2417. }
  2418. /// <summary>
  2419. /// Calculate the width based on the <see cref="Width"/> settings.
  2420. /// </summary>
  2421. /// <param name="desiredWidth">The desired width.</param>
  2422. /// <param name="resultWidth">The real result width.</param>
  2423. /// <returns><c>true</c> if the width can be directly assigned, <c>false</c> otherwise.</returns>
  2424. public bool SetWidth (int desiredWidth, out int resultWidth)
  2425. {
  2426. return CanSetWidth (desiredWidth, out resultWidth);
  2427. }
  2428. /// <summary>
  2429. /// Calculate the height based on the <see cref="Height"/> settings.
  2430. /// </summary>
  2431. /// <param name="desiredHeight">The desired height.</param>
  2432. /// <param name="resultHeight">The real result height.</param>
  2433. /// <returns><c>true</c> if the height can be directly assigned, <c>false</c> otherwise.</returns>
  2434. public bool SetHeight (int desiredHeight, out int resultHeight)
  2435. {
  2436. return CanSetHeight (desiredHeight, out resultHeight);
  2437. }
  2438. /// <summary>
  2439. /// Gets the current width based on the <see cref="Width"/> settings.
  2440. /// </summary>
  2441. /// <param name="currentWidth">The real current width.</param>
  2442. /// <returns><c>true</c> if the width can be directly assigned, <c>false</c> otherwise.</returns>
  2443. public bool GetCurrentWidth (out int currentWidth)
  2444. {
  2445. SetRelativeLayout (SuperView == null ? Frame : SuperView.Frame);
  2446. currentWidth = Frame.Width;
  2447. return CanSetWidth (0, out _);
  2448. }
  2449. /// <summary>
  2450. /// Calculate the height based on the <see cref="Height"/> settings.
  2451. /// </summary>
  2452. /// <param name="currentHeight">The real current height.</param>
  2453. /// <returns><c>true</c> if the height can be directly assigned, <c>false</c> otherwise.</returns>
  2454. public bool GetCurrentHeight (out int currentHeight)
  2455. {
  2456. SetRelativeLayout (SuperView == null ? Frame : SuperView.Frame);
  2457. currentHeight = Frame.Height;
  2458. return CanSetHeight (0, out _);
  2459. }
  2460. /// <summary>
  2461. /// Determines the current <see cref="ColorScheme"/> based on the <see cref="Enabled"/> value.
  2462. /// </summary>
  2463. /// <returns><see cref="ColorScheme.Normal"/> if <see cref="Enabled"/> is <see langword="true"/>
  2464. /// or <see cref="ColorScheme.Disabled"/> if <see cref="Enabled"/> is <see langword="false"/></returns>
  2465. public Attribute GetNormalColor ()
  2466. {
  2467. return Enabled ? ColorScheme.Normal : ColorScheme.Disabled;
  2468. }
  2469. /// <summary>
  2470. /// Get the top superview of a given <see cref="View"/>.
  2471. /// </summary>
  2472. /// <returns>The superview view.</returns>
  2473. public View GetTopSuperView ()
  2474. {
  2475. View top = Application.Top;
  2476. for (var v = this?.SuperView; v != null; v = v.SuperView) {
  2477. if (v != null) {
  2478. top = v;
  2479. }
  2480. }
  2481. return top;
  2482. }
  2483. }
  2484. }