View.cs 100 KB

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