View.cs 93 KB

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