View.cs 84 KB

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