View.cs 101 KB

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