View.cs 98 KB

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