View.cs 96 KB

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