View.cs 76 KB

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