View.cs 76 KB

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