View.cs 105 KB

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