View.cs 101 KB

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