View.cs 104 KB

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