12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class View
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class View
- ">
- <meta name="generator" content="docfx 2.56.7.0">
-
- <link rel="shortcut icon" href="../../favicon.ico">
- <link rel="stylesheet" href="../../styles/docfx.vendor.css">
- <link rel="stylesheet" href="../../styles/docfx.css">
- <link rel="stylesheet" href="../../styles/main.css">
- <meta property="docfx:navrel" content="../../toc.html">
- <meta property="docfx:tocrel" content="toc.html">
-
- <meta property="docfx:rel" content="../../">
-
- </head>
- <body data-spy="scroll" data-target="#affix" data-offset="120">
- <div id="wrapper">
- <header>
-
- <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
- <div class="container">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a class="navbar-brand" href="../../index.html">
- <img id="logo" class="svg" src="../../images/logo48.png" alt="">
- </a>
- </div>
- <div class="collapse navbar-collapse" id="navbar">
- <form class="navbar-form navbar-right" role="search" id="search">
- <div class="form-group">
- <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
- </div>
- </form>
- </div>
- </div>
- </nav>
-
- <div class="subnav navbar navbar-default">
- <div class="container hide-when-search" id="breadcrumb">
- <ul class="breadcrumb">
- <li></li>
- </ul>
- </div>
- </div>
- </header>
- <div class="container body-content">
-
- <div id="search-results">
- <div class="search-list">Search Results for <span></span></div>
- <div class="sr-items">
- <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
- </div>
- <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
- </div>
- </div>
- <div role="main" class="container body-content hide-when-search">
-
- <div class="sidenav hide-when-search">
- <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
- <div class="sidetoggle collapse" id="sidetoggle">
- <div id="sidetoc"></div>
- </div>
- </div>
- <div class="article row grid-right">
- <div class="col-md-10">
- <article class="content wrap" id="_content" data-uid="Terminal.Gui.View">
-
-
- <h1 id="Terminal_Gui_View" data-uid="Terminal.Gui.View" class="text-break">Class View
- </h1>
- <div class="markdown level0 summary">
- View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
- </div>
- <div class="markdown level0 conceptual"></div>
- <div class="inheritance">
- <h5>Inheritance</h5>
- <div class="level0"><span class="xref">System.Object</span></div>
- <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
- <div class="level2"><span class="xref">View</span></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.Button.html">Button</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.Label.html">Label</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView<T></a></div>
- </div>
- <div classs="implements">
- <h5>Implements</h5>
- <div><span class="xref">System.IDisposable</span></div>
- <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
- <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
- </div>
- <div class="inheritedMembers">
- <h5>Inherited Members</h5>
- <div>
- <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
- </div>
- <div>
- <span class="xref">System.Object.Equals(System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
- </div>
- <div>
- <span class="xref">System.Object.GetHashCode()</span>
- </div>
- <div>
- <span class="xref">System.Object.GetType()</span>
- </div>
- <div>
- <span class="xref">System.Object.MemberwiseClone()</span>
- </div>
- <div>
- <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
- </div>
- </div>
- <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
- <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
- <h5 id="Terminal_Gui_View_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
- </div>
- <h5 id="Terminal_Gui_View_remarks"><strong>Remarks</strong></h5>
- <div class="markdown level0 remarks">
- <p>
- The View defines the base functionality for user interface elements in Terminal.Gui. Views
- can contain one or more subviews, can respond to user input and render themselves on the screen.
- </p>
- <p>
- Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View
- is determined when the View is initizlied. To create a View using Absolute layout, call a constructor that takes a
- Rect parameter to specify the absolute position and size (the <code>View.<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a></code>)/. To create a View
- using Computed layout use a constructor that does not take a Rect parametr and set the X, Y, Width and Height
- properties on the view. Both approaches use coordinates that are relative to the container they are being added to.
- </p>
- <p>
- To switch between Absolute and Computed layout, use the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> property.
- </p>
- <p>
- Computed layout is more flexible and supports dynamic console apps where controls adjust layout
- as the terminal resizes or other Views change size or position. The X, Y, Width and Height
- properties are Dim and Pos objects that dynamically update the position of a view.
- The X and Y properties are of type <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>
- and you can use either absolute positions, percentages or anchor
- points. The Width and Height properties are of type
- <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> and can use absolute position,
- percentages and anchors. These are useful as they will take
- care of repositioning views when view's frames are resized or
- if the terminal size changes.
- </p>
- <p>
- Absolute layout requires specifying coordinates and sizes of Views explicitly, and the
- View will typcialy stay in a fixed position and size. To change the position and size use the
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> property.
- </p>
- <p>
- Subviews (child views) can be added to a View by calling the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> method.
- The container of a View can be accessed with the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a> property.
- </p>
- <p>
- To flag a region of the View's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> to be redrawn call <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">SetNeedsDisplay(Rect)</a>. To flag the entire view
- for redraw call <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a>.
- </p>
- <p>
- Views have a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> property that defines the default colors that subviews
- should use for rendering. This ensures that the views fit in the context where
- they are being used, and allows for themes to be plugged in. For example, the
- default colors for windows and toplevels uses a blue background, while it uses
- a white background for dialog boxes and a red background for errors.
- </p>
- <p>
- Subclasses should not rely on <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> being
- set at construction time. If a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> is not set on a view, the view will inherit the
- value from its <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a> and the value might only be valid once a view has been
- added to a SuperView.
- </p>
- <p>
- By using <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> applications will work both
- in color as well as black and white displays.
- </p>
- <p>
- Views that are focusable should implement the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">PositionCursor()</a> to make sure that
- the cursor is placed in a location that makes sense. Unix terminals do not have
- a way of hiding the cursor, so it can be distracting to have the cursor left at
- the last focused view. So views should make sure that they place the cursor
- in a visually sensible place.
- </p>
- <p>
- The <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">LayoutSubviews()</a> method is invoked when the size or layout of a view has
- changed. The default processing system will keep the size and dimensions
- for views that use the <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>, and will recompute the
- frames for the vies that use <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
- </p>
- </div>
- <h3 id="constructors">Constructors
- </h3>
-
-
- <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
- <h4 id="Terminal_Gui_View__ctor" data-uid="Terminal.Gui.View.#ctor">View()</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View()</code></pre>
- </div>
- <h5 id="Terminal_Gui_View__ctor_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties to dynamically control the size and location of the view.
- The <a class="xref" href="Terminal.Gui.Label.html">Label</a> will be created using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
- coordinates. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
- adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines ('\n') for multiple lines.
- </p>
- <p>
- If <code>Height</code> is greater than one, word wrapping is provided.
- </p>
- <p>
- This constructor intitalize a View with a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
- Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties to dynamically control the size and location of the view.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
- <h4 id="Terminal_Gui_View__ctor_NStack_ustring_" data-uid="Terminal.Gui.View.#ctor(NStack.ustring)">View(ustring)</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View(ustring text)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td><span class="parametername">text</span></td>
- <td>text to initialize the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> property with.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View__ctor_NStack_ustring__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- The <a class="xref" href="Terminal.Gui.View.html">View</a> will be created using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
- coordinates with the given string. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
- adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines ('\n') for multiple lines.
- </p>
- <p>
- If <code>Height</code> is greater than one, word wrapping is provided.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
- <h4 id="Terminal_Gui_View__ctor_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.View.#ctor(System.Int32,System.Int32,NStack.ustring)">View(Int32, Int32, ustring)</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View(int x, int y, ustring text)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">x</span></td>
- <td>column to locate the Label.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">y</span></td>
- <td>row to locate the Label.</td>
- </tr>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td><span class="parametername">text</span></td>
- <td>text to initialize the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> property with.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View__ctor_System_Int32_System_Int32_NStack_ustring__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- The <a class="xref" href="Terminal.Gui.View.html">View</a> will be created at the given
- coordinates with the given string. The size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
- adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines ('\n') for multiple lines.
- </p>
- <p>
- No line wrapping is provided.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
- <h4 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.#ctor(Terminal.Gui.Rect)">View(Rect)</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of a <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> <a class="xref" href="Terminal.Gui.View.html">View</a> class with the absolute
- dimensions specified in the <code>frame</code> parameter.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View(Rect frame)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">frame</span></td>
- <td>The region covered by this view.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- This constructor intitalize a View with a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View__ctor">View()</a> to
- initialize a View with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> of <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>
- </div>
-
-
- <a id="Terminal_Gui_View__ctor_" data-uid="Terminal.Gui.View.#ctor*"></a>
- <h4 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_NStack_ustring_" data-uid="Terminal.Gui.View.#ctor(Terminal.Gui.Rect,NStack.ustring)">View(Rect, ustring)</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of <a class="xref" href="Terminal.Gui.View.html">View</a> using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View(Rect rect, ustring text)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">rect</span></td>
- <td>Location.</td>
- </tr>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td><span class="parametername">text</span></td>
- <td>text to initialize the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> property with.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View__ctor_Terminal_Gui_Rect_NStack_ustring__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- The <a class="xref" href="Terminal.Gui.View.html">View</a> will be created at the given
- coordinates with the given string. The initial size (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> will be
- adjusted to fit the contents of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a>, including newlines ('\n') for multiple lines.
- </p>
- <p>
- If <code>rect.Height</code> is greater than one, word wrapping is provided.
- </p>
- </div>
- <h3 id="properties">Properties
- </h3>
-
-
- <a id="Terminal_Gui_View_AutoSize_" data-uid="Terminal.Gui.View.AutoSize*"></a>
- <h4 id="Terminal_Gui_View_AutoSize" data-uid="Terminal.Gui.View.AutoSize">AutoSize</h4>
- <div class="markdown level1 summary">
- Used by <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> to resize the view's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> with the <a class="xref" href="Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_Size">Size</a>.
- Setting <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">AutoSize</a> to true only work if the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a> and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> are null or
- <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> values and doesn't work with <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout,
- to avoid breaking the <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> and <a class="xref" href="Terminal.Gui.Dim.html">Dim</a> settings.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool AutoSize { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Bounds_" data-uid="Terminal.Gui.View.Bounds*"></a>
- <h4 id="Terminal_Gui_View_Bounds" data-uid="Terminal.Gui.View.Bounds">Bounds</h4>
- <div class="markdown level1 summary">
- The bounds represent the View-relative rectangle used for this view; the area inside of the view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rect Bounds { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td>The bounds.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Bounds_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Updates to the Bounds update the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>,
- and has the same side effects as updating the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>.
- </p>
- <p>
- Because <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> coordinates are relative to the upper-left corner of the <a class="xref" href="Terminal.Gui.View.html">View</a>,
- the coordinates of the upper-left corner of the rectangle returned by this property are (0,0).
- Use this property to obtain the size and coordinates of the client area of the
- control for tasks such as drawing on the surface of the control.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_CanFocus_" data-uid="Terminal.Gui.View.CanFocus*"></a>
- <h4 id="Terminal_Gui_View_CanFocus" data-uid="Terminal.Gui.View.CanFocus">CanFocus</h4>
- <div class="markdown level1 summary">
- Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a></div>
-
-
- <a id="Terminal_Gui_View_ColorScheme_" data-uid="Terminal.Gui.View.ColorScheme*"></a>
- <h4 id="Terminal_Gui_View_ColorScheme" data-uid="Terminal.Gui.View.ColorScheme">ColorScheme</h4>
- <div class="markdown level1 summary">
- The color scheme for this view, if it is not defined, it returns the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>'s
- color scheme.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public ColorScheme ColorScheme { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Data_" data-uid="Terminal.Gui.View.Data*"></a>
- <h4 id="Terminal_Gui_View_Data" data-uid="Terminal.Gui.View.Data">Data</h4>
- <div class="markdown level1 summary">
- Gets or sets arbitrary data for the view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public object Data { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Object</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Data_remarks">Remarks</h5>
- <div class="markdown level1 remarks">This property is not used internally.</div>
-
-
- <a id="Terminal_Gui_View_Driver_" data-uid="Terminal.Gui.View.Driver*"></a>
- <h4 id="Terminal_Gui_View_Driver" data-uid="Terminal.Gui.View.Driver">Driver</h4>
- <div class="markdown level1 summary">
- Points to the current driver in use by the view, it is a convenience property
- for simplifying the development of new views.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static ConsoleDriver Driver { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Focused_" data-uid="Terminal.Gui.View.Focused*"></a>
- <h4 id="Terminal_Gui_View_Focused" data-uid="Terminal.Gui.View.Focused">Focused</h4>
- <div class="markdown level1 summary">
- Returns the currently focused view inside this view, or null if nothing is focused.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View Focused { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td>The focused.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Frame_" data-uid="Terminal.Gui.View.Frame*"></a>
- <h4 id="Terminal_Gui_View_Frame" data-uid="Terminal.Gui.View.Frame">Frame</h4>
- <div class="markdown level1 summary">
- Gets or sets the frame for the view. The frame is relative to the view's container (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>).
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual Rect Frame { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td>The frame.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Frame_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Change the Frame when using the <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout style to move or resize views.
- </p>
- <p>
- Altering the Frame of a view will trigger the redrawing of the
- view as well as the redrawing of the affected regions of the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_HasFocus_" data-uid="Terminal.Gui.View.HasFocus*"></a>
- <h4 id="Terminal_Gui_View_HasFocus" data-uid="Terminal.Gui.View.HasFocus">HasFocus</h4>
- <div class="markdown level1 summary">
- Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> has focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool HasFocus { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code> if has focus; otherwise, <code>false</code>.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_HasFocus">Responder.HasFocus</a></div>
-
-
- <a id="Terminal_Gui_View_Height_" data-uid="Terminal.Gui.View.Height*"></a>
- <h4 id="Terminal_Gui_View_Height" data-uid="Terminal.Gui.View.Height">Height</h4>
- <div class="markdown level1 summary">
- Gets or sets the height of the view. Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Dim Height { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></td>
- <td>The height.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_HotKey_" data-uid="Terminal.Gui.View.HotKey*"></a>
- <h4 id="Terminal_Gui_View_HotKey" data-uid="Terminal.Gui.View.HotKey">HotKey</h4>
- <div class="markdown level1 summary">
- 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.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Key HotKey { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_HotKeySpecifier_" data-uid="Terminal.Gui.View.HotKeySpecifier*"></a>
- <h4 id="Terminal_Gui_View_HotKeySpecifier" data-uid="Terminal.Gui.View.HotKeySpecifier">HotKeySpecifier</h4>
- <div class="markdown level1 summary">
- 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'.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune HotKeySpecifier { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Rune</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Id_" data-uid="Terminal.Gui.View.Id*"></a>
- <h4 id="Terminal_Gui_View_Id" data-uid="Terminal.Gui.View.Id">Id</h4>
- <div class="markdown level1 summary">
- Gets or sets an identifier for the view;
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public ustring Id { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td>The identifier.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Id_remarks">Remarks</h5>
- <div class="markdown level1 remarks">The id should be unique across all Views that share a SuperView.</div>
-
-
- <a id="Terminal_Gui_View_IsCurrentTop_" data-uid="Terminal.Gui.View.IsCurrentTop*"></a>
- <h4 id="Terminal_Gui_View_IsCurrentTop" data-uid="Terminal.Gui.View.IsCurrentTop">IsCurrentTop</h4>
- <div class="markdown level1 summary">
- Returns a value indicating if this View is currently on Top (Active)
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool IsCurrentTop { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_IsInitialized_" data-uid="Terminal.Gui.View.IsInitialized*"></a>
- <h4 id="Terminal_Gui_View_IsInitialized" data-uid="Terminal.Gui.View.IsInitialized">IsInitialized</h4>
- <div class="markdown level1 summary">
- Get or sets if the <a class="xref" href="Terminal.Gui.View.html">View</a> was already initialized.
- This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are being initialized.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool IsInitialized { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_LayoutStyle_" data-uid="Terminal.Gui.View.LayoutStyle*"></a>
- <h4 id="Terminal_Gui_View_LayoutStyle" data-uid="Terminal.Gui.View.LayoutStyle">LayoutStyle</h4>
- <div class="markdown level1 summary">
- Controls how the View's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> is computed during the LayoutSubviews method, if the style is set to <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a>,
- LayoutSubviews does not change the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a>. If the style is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> is updated using
- the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">X</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">Y</a>, <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a>, and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> properties.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public LayoutStyle LayoutStyle { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></td>
- <td>The layout style.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_MostFocused_" data-uid="Terminal.Gui.View.MostFocused*"></a>
- <h4 id="Terminal_Gui_View_MostFocused" data-uid="Terminal.Gui.View.MostFocused">MostFocused</h4>
- <div class="markdown level1 summary">
- Returns the most focused view in the chain of subviews (the leaf view that has the focus).
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View MostFocused { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td>The most focused.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Shortcut_" data-uid="Terminal.Gui.View.Shortcut*"></a>
- <h4 id="Terminal_Gui_View_Shortcut" data-uid="Terminal.Gui.View.Shortcut">Shortcut</h4>
- <div class="markdown level1 summary">
- This is the global setting that can be used as a global shortcut to invoke an action if provided.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Key Shortcut { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_ShortcutAction_" data-uid="Terminal.Gui.View.ShortcutAction*"></a>
- <h4 id="Terminal_Gui_View_ShortcutAction" data-uid="Terminal.Gui.View.ShortcutAction">ShortcutAction</h4>
- <div class="markdown level1 summary">
- The action to run if the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">Shortcut</a> is defined.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual Action ShortcutAction { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_ShortcutTag_" data-uid="Terminal.Gui.View.ShortcutTag*"></a>
- <h4 id="Terminal_Gui_View_ShortcutTag" data-uid="Terminal.Gui.View.ShortcutTag">ShortcutTag</h4>
- <div class="markdown level1 summary">
- The keystroke combination used in the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">Shortcut</a> as string.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public ustring ShortcutTag { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Subviews_" data-uid="Terminal.Gui.View.Subviews*"></a>
- <h4 id="Terminal_Gui_View_Subviews" data-uid="Terminal.Gui.View.Subviews">Subviews</h4>
- <div class="markdown level1 summary">
- This returns a list of the subviews contained by this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public IList<View> Subviews { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Terminal.Gui.View.html">View</a>></td>
- <td>The subviews.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_SuperView_" data-uid="Terminal.Gui.View.SuperView*"></a>
- <h4 id="Terminal_Gui_View_SuperView" data-uid="Terminal.Gui.View.SuperView">SuperView</h4>
- <div class="markdown level1 summary">
- Returns the container for this view, or null if this view has not been added to a container.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View SuperView { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td>The super view.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_TabIndex_" data-uid="Terminal.Gui.View.TabIndex*"></a>
- <h4 id="Terminal_Gui_View_TabIndex" data-uid="Terminal.Gui.View.TabIndex">TabIndex</h4>
- <div class="markdown level1 summary">
- Indicates the index of the current <a class="xref" href="Terminal.Gui.View.html">View</a> from the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">TabIndexes</a> list.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public int TabIndex { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_TabIndexes_" data-uid="Terminal.Gui.View.TabIndexes*"></a>
- <h4 id="Terminal_Gui_View_TabIndexes" data-uid="Terminal.Gui.View.TabIndexes">TabIndexes</h4>
- <div class="markdown level1 summary">
- This returns a tab index list of the subviews contained by this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public IList<View> TabIndexes { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Terminal.Gui.View.html">View</a>></td>
- <td>The tabIndexes.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_TabStop_" data-uid="Terminal.Gui.View.TabStop*"></a>
- <h4 id="Terminal_Gui_View_TabStop" data-uid="Terminal.Gui.View.TabStop">TabStop</h4>
- <div class="markdown level1 summary">
- This only be <code>true</code> if the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">CanFocus</a> is also <code>true</code> and the focus can be avoided by setting this to <code>false</code>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool TabStop { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Text_" data-uid="Terminal.Gui.View.Text*"></a>
- <h4 id="Terminal_Gui_View_Text" data-uid="Terminal.Gui.View.Text">Text</h4>
- <div class="markdown level1 summary">
- The text displayed by the <a class="xref" href="Terminal.Gui.View.html">View</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual ustring Text { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Text_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- If provided, the text will be drawn before any subviews are drawn.
- </p>
- <p>
- The text will be drawn starting at the view origin (0, 0) and will be formatted according
- to the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">TextAlignment</a> property. If the view's height is greater than 1, the
- text will word-wrap to additional lines if it does not fit horizontally. If the view's height
- is 1, the text will be clipped.
- </p>
- <p>
- Set the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a> to enable hotkey support. To disable hotkey support set <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a> to
- <code>(Rune)0xffff</code>.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_TextAlignment_" data-uid="Terminal.Gui.View.TextAlignment*"></a>
- <h4 id="Terminal_Gui_View_TextAlignment" data-uid="Terminal.Gui.View.TextAlignment">TextAlignment</h4>
- <div class="markdown level1 summary">
- Gets or sets how the View's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">Text</a> is aligned horizontally when drawn. Changing this property will redisplay the <a class="xref" href="Terminal.Gui.View.html">View</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual TextAlignment TextAlignment { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></td>
- <td>The text alignment.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Visible_" data-uid="Terminal.Gui.View.Visible*"></a>
- <h4 id="Terminal_Gui_View_Visible" data-uid="Terminal.Gui.View.Visible">Visible</h4>
- <div class="markdown level1 summary">
- Gets or sets the view visibility.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool Visible { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_WantContinuousButtonPressed_" data-uid="Terminal.Gui.View.WantContinuousButtonPressed*"></a>
- <h4 id="Terminal_Gui_View_WantContinuousButtonPressed" data-uid="Terminal.Gui.View.WantContinuousButtonPressed">WantContinuousButtonPressed</h4>
- <div class="markdown level1 summary">
- Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> want continuous button pressed event.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool WantContinuousButtonPressed { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_WantMousePositionReports_" data-uid="Terminal.Gui.View.WantMousePositionReports*"></a>
- <h4 id="Terminal_Gui_View_WantMousePositionReports" data-uid="Terminal.Gui.View.WantMousePositionReports">WantMousePositionReports</h4>
- <div class="markdown level1 summary">
- Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> wants mouse position reports.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool WantMousePositionReports { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code> if want mouse position reports; otherwise, <code>false</code>.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_Width_" data-uid="Terminal.Gui.View.Width*"></a>
- <h4 id="Terminal_Gui_View_Width" data-uid="Terminal.Gui.View.Width">Width</h4>
- <div class="markdown level1 summary">
- Gets or sets the width of the view. Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Dim Width { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></td>
- <td>The width.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Width_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> changing this property has no effect and its value is indeterminate.
- </div>
-
-
- <a id="Terminal_Gui_View_X_" data-uid="Terminal.Gui.View.X*"></a>
- <h4 id="Terminal_Gui_View_X" data-uid="Terminal.Gui.View.X">X</h4>
- <div class="markdown level1 summary">
- Gets or sets the X position for the view (the column). Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Pos X { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
- <td>The X Position.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_X_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> changing this property has no effect and its value is indeterminate.
- </div>
-
-
- <a id="Terminal_Gui_View_Y_" data-uid="Terminal.Gui.View.Y*"></a>
- <h4 id="Terminal_Gui_View_Y" data-uid="Terminal.Gui.View.Y">Y</h4>
- <div class="markdown level1 summary">
- Gets or sets the Y position for the view (the row). Only used whe <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Pos Y { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></td>
- <td>The y position (line).</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Y_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- If <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">LayoutStyle</a> is <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> changing this property has no effect and its value is indeterminate.
- </div>
- <h3 id="methods">Methods
- </h3>
-
-
- <a id="Terminal_Gui_View_Add_" data-uid="Terminal.Gui.View.Add*"></a>
- <h4 id="Terminal_Gui_View_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.View.Add(Terminal.Gui.View)">Add(View)</h4>
- <div class="markdown level1 summary">
- Adds a subview (child) to this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void Add(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Add_Terminal_Gui_View__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- The Views that have been added to this view can be retrieved via the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> property. See also <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">Remove(View)</a> <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">RemoveAll()</a>
- </div>
-
-
- <a id="Terminal_Gui_View_Add_" data-uid="Terminal.Gui.View.Add*"></a>
- <h4 id="Terminal_Gui_View_Add_Terminal_Gui_View___" data-uid="Terminal.Gui.View.Add(Terminal.Gui.View[])">Add(View[])</h4>
- <div class="markdown level1 summary">
- Adds the specified views (children) to the view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void Add(params View[] views)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a>[]</td>
- <td><span class="parametername">views</span></td>
- <td>Array of one or more views (can be optional parameter).</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Add_Terminal_Gui_View____remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- The Views that have been added to this view can be retrieved via the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> property. See also <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">Remove(View)</a> <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">RemoveAll()</a>
- </div>
-
-
- <a id="Terminal_Gui_View_AddRune_" data-uid="Terminal.Gui.View.AddRune*"></a>
- <h4 id="Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_" data-uid="Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune)">AddRune(Int32, Int32, Rune)</h4>
- <div class="markdown level1 summary">
- Displays the specified character in the specified column and row of the View.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void AddRune(int col, int row, Rune ch)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">col</span></td>
- <td>Column (view-relative).</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">row</span></td>
- <td>Row (view-relative).</td>
- </tr>
- <tr>
- <td><span class="xref">System.Rune</span></td>
- <td><span class="parametername">ch</span></td>
- <td>Ch.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_BeginInit_" data-uid="Terminal.Gui.View.BeginInit*"></a>
- <h4 id="Terminal_Gui_View_BeginInit" data-uid="Terminal.Gui.View.BeginInit">BeginInit()</h4>
- <div class="markdown level1 summary">
- This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are beginning initialized.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void BeginInit()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_BringSubviewForward_" data-uid="Terminal.Gui.View.BringSubviewForward*"></a>
- <h4 id="Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_" data-uid="Terminal.Gui.View.BringSubviewForward(Terminal.Gui.View)">BringSubviewForward(View)</h4>
- <div class="markdown level1 summary">
- Moves the subview backwards in the hierarchy, only one step
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void BringSubviewForward(View subview)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">subview</span></td>
- <td>The subview to send backwards</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- If you want to send the view all the way to the back use SendSubviewToBack.
- </div>
-
-
- <a id="Terminal_Gui_View_BringSubviewToFront_" data-uid="Terminal.Gui.View.BringSubviewToFront*"></a>
- <h4 id="Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_" data-uid="Terminal.Gui.View.BringSubviewToFront(Terminal.Gui.View)">BringSubviewToFront(View)</h4>
- <div class="markdown level1 summary">
- Brings the specified subview to the front so it is drawn on top of any other views.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void BringSubviewToFront(View subview)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">subview</span></td>
- <td>The subview to send to the front</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">SendSubviewToBack(View)</a>.
- </div>
-
-
- <a id="Terminal_Gui_View_Clear_" data-uid="Terminal.Gui.View.Clear*"></a>
- <h4 id="Terminal_Gui_View_Clear" data-uid="Terminal.Gui.View.Clear">Clear()</h4>
- <div class="markdown level1 summary">
- Clears the view region with the current color.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void Clear()</code></pre>
- </div>
- <h5 id="Terminal_Gui_View_Clear_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- This clears the entire region used by this view.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_Clear_" data-uid="Terminal.Gui.View.Clear*"></a>
- <h4 id="Terminal_Gui_View_Clear_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.Clear(Terminal.Gui.Rect)">Clear(Rect)</h4>
- <div class="markdown level1 summary">
- Clears the specified region with the current color.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void Clear(Rect regionScreen)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">regionScreen</span></td>
- <td>The screen-relative region to clear.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Clear_Terminal_Gui_Rect__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- </div>
-
-
- <a id="Terminal_Gui_View_ClearLayoutNeeded_" data-uid="Terminal.Gui.View.ClearLayoutNeeded*"></a>
- <h4 id="Terminal_Gui_View_ClearLayoutNeeded" data-uid="Terminal.Gui.View.ClearLayoutNeeded">ClearLayoutNeeded()</h4>
- <div class="markdown level1 summary">
- Removes the <span class="xref">Terminal.Gui.View.SetNeedsLayout</span> setting on this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void ClearLayoutNeeded()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_ClearNeedsDisplay_" data-uid="Terminal.Gui.View.ClearNeedsDisplay*"></a>
- <h4 id="Terminal_Gui_View_ClearNeedsDisplay" data-uid="Terminal.Gui.View.ClearNeedsDisplay">ClearNeedsDisplay()</h4>
- <div class="markdown level1 summary">
- Removes the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">SetNeedsDisplay()</a> and the <span class="xref">Terminal.Gui.View.ChildNeedsDisplay()</span> setting on this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void ClearNeedsDisplay()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_ClipToBounds_" data-uid="Terminal.Gui.View.ClipToBounds*"></a>
- <h4 id="Terminal_Gui_View_ClipToBounds" data-uid="Terminal.Gui.View.ClipToBounds">ClipToBounds()</h4>
- <div class="markdown level1 summary">
- Sets the <a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a>'s clip region to the current View's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rect ClipToBounds()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td>The existing driver's clip region, which can be then re-eapplied by setting <code><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">Driver</a>.Clip</code> (<a class="xref" href="Terminal.Gui.ConsoleDriver.html#Terminal_Gui_ConsoleDriver_Clip">Clip</a>).</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_ClipToBounds_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> is View-relative.
- </div>
-
-
- <a id="Terminal_Gui_View_Dispose_" data-uid="Terminal.Gui.View.Dispose*"></a>
- <h4 id="Terminal_Gui_View_Dispose_System_Boolean_" data-uid="Terminal.Gui.View.Dispose(System.Boolean)">Dispose(Boolean)</h4>
- <div class="markdown level1 summary">
- Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected override void Dispose(bool disposing)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">disposing</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose_System_Boolean_">Responder.Dispose(Boolean)</a></div>
- <h5 id="Terminal_Gui_View_Dispose_System_Boolean__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- If disposing equals true, the method has been called directly
- or indirectly by a user's code. Managed and unmanaged resources
- can be disposed.
- If disposing equals false, the method has been called by the
- runtime from inside the finalizer and you should not reference
- other objects. Only unmanaged resources can be disposed.
- </div>
-
-
- <a id="Terminal_Gui_View_DrawFrame_" data-uid="Terminal.Gui.View.DrawFrame*"></a>
- <h4 id="Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_" data-uid="Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)">DrawFrame(Rect, Int32, Boolean)</h4>
- <div class="markdown level1 summary">
- Draws a frame in the current view, clipped by the boundary of this view
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawFrame(Rect region, int padding = 0, bool fill = false)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">region</span></td>
- <td>View-relative region for the frame to be drawn.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">padding</span></td>
- <td>The padding to add around the outside of the drawn frame.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">fill</span></td>
- <td>If set to <code>true</code> it fill will the contents.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
- <h4 id="Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.View.DrawHotString(NStack.ustring,System.Boolean,Terminal.Gui.ColorScheme)">DrawHotString(ustring, Boolean, ColorScheme)</h4>
- <div class="markdown level1 summary">
- Utility function to draw strings that contains a hotkey using a <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">ColorScheme</a> and the "focused" state.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawHotString(ustring text, bool focused, ColorScheme scheme)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td><span class="parametername">text</span></td>
- <td>String to display, the underscoore before a letter flags the next letter as the hotkey.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">focused</span></td>
- <td>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
- <td><span class="parametername">scheme</span></td>
- <td>The color scheme to use.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
- <h4 id="Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.View.DrawHotString(NStack.ustring,Terminal.Gui.Attribute,Terminal.Gui.Attribute)">DrawHotString(ustring, Attribute, Attribute)</h4>
- <div class="markdown level1 summary">
- Utility function to draw strings that contain a hotkey.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">NStack.ustring</span></td>
- <td><span class="parametername">text</span></td>
- <td>String to display, the hotkey specifier before a letter flags the next letter as the hotkey.</td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
- <td><span class="parametername">hotColor</span></td>
- <td>Hot color.</td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
- <td><span class="parametername">normalColor</span></td>
- <td>Normal color.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default.</p>
- <p>The hotkey specifier can be changed via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">HotKeySpecifier</a></p>
- </div>
-
-
- <a id="Terminal_Gui_View_EndInit_" data-uid="Terminal.Gui.View.EndInit*"></a>
- <h4 id="Terminal_Gui_View_EndInit" data-uid="Terminal.Gui.View.EndInit">EndInit()</h4>
- <div class="markdown level1 summary">
- This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are ending initialized.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void EndInit()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_EnsureFocus_" data-uid="Terminal.Gui.View.EnsureFocus*"></a>
- <h4 id="Terminal_Gui_View_EnsureFocus" data-uid="Terminal.Gui.View.EnsureFocus">EnsureFocus()</h4>
- <div class="markdown level1 summary">
- Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void EnsureFocus()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_FocusFirst_" data-uid="Terminal.Gui.View.FocusFirst*"></a>
- <h4 id="Terminal_Gui_View_FocusFirst" data-uid="Terminal.Gui.View.FocusFirst">FocusFirst()</h4>
- <div class="markdown level1 summary">
- Focuses the first focusable subview if one exists.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void FocusFirst()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_FocusLast_" data-uid="Terminal.Gui.View.FocusLast*"></a>
- <h4 id="Terminal_Gui_View_FocusLast" data-uid="Terminal.Gui.View.FocusLast">FocusLast()</h4>
- <div class="markdown level1 summary">
- Focuses the last focusable subview if one exists.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void FocusLast()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_FocusNext_" data-uid="Terminal.Gui.View.FocusNext*"></a>
- <h4 id="Terminal_Gui_View_FocusNext" data-uid="Terminal.Gui.View.FocusNext">FocusNext()</h4>
- <div class="markdown level1 summary">
- Focuses the next view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool FocusNext()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if next was focused, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_FocusPrev_" data-uid="Terminal.Gui.View.FocusPrev*"></a>
- <h4 id="Terminal_Gui_View_FocusPrev" data-uid="Terminal.Gui.View.FocusPrev">FocusPrev()</h4>
- <div class="markdown level1 summary">
- Focuses the previous view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool FocusPrev()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if previous was focused, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_LayoutSubviews_" data-uid="Terminal.Gui.View.LayoutSubviews*"></a>
- <h4 id="Terminal_Gui_View_LayoutSubviews" data-uid="Terminal.Gui.View.LayoutSubviews">LayoutSubviews()</h4>
- <div class="markdown level1 summary">
- Invoked when a view starts executing or when the dimensions of the view have changed, for example in
- response to the container view or terminal resizing.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void LayoutSubviews()</code></pre>
- </div>
- <h5 id="Terminal_Gui_View_LayoutSubviews_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- Calls <span class="xref">Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs)</span> (which raises the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">LayoutComplete</a> event) before it returns.
- </div>
-
-
- <a id="Terminal_Gui_View_Move_" data-uid="Terminal.Gui.View.Move*"></a>
- <h4 id="Terminal_Gui_View_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
- <div class="markdown level1 summary">
- This moves the cursor to the specified column and row in the view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void Move(int col, int row)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">col</span></td>
- <td>Col.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">row</span></td>
- <td>Row.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_OnAdded_" data-uid="Terminal.Gui.View.OnAdded*"></a>
- <h4 id="Terminal_Gui_View_OnAdded_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnAdded(Terminal.Gui.View)">OnAdded(View)</h4>
- <div class="markdown level1 summary">
- Method invoked when a subview is being added to this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnAdded(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td>The subview being added.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_OnDrawContent_" data-uid="Terminal.Gui.View.OnDrawContent*"></a>
- <h4 id="Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.OnDrawContent(Terminal.Gui.Rect)">OnDrawContent(Rect)</h4>
- <div class="markdown level1 summary">
- Enables overrides to draw infinitely scrolled content and/or a background behind added controls.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnDrawContent(Rect viewport)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">viewport</span></td>
- <td>The view-relative rectangle describing the currently visible viewport into the <a class="xref" href="Terminal.Gui.View.html">View</a></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- This method will be called before any subviews added with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> have been drawn.
- </div>
-
-
- <a id="Terminal_Gui_View_OnEnter_" data-uid="Terminal.Gui.View.OnEnter*"></a>
- <h4 id="Terminal_Gui_View_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
- <div class="markdown level1 summary">
- Method invoked when a view gets focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td>The view that is losing focus.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnEnter_Terminal_Gui_View_">Responder.OnEnter(View)</a></div>
-
-
- <a id="Terminal_Gui_View_OnKeyDown_" data-uid="Terminal.Gui.View.OnKeyDown*"></a>
- <h4 id="Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
- <div class="markdown level1 summary"></div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnKeyDown(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnKeyDown_Terminal_Gui_KeyEvent_">Responder.OnKeyDown(KeyEvent)</a></div>
-
-
- <a id="Terminal_Gui_View_OnKeyUp_" data-uid="Terminal.Gui.View.OnKeyUp*"></a>
- <h4 id="Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
- <div class="markdown level1 summary"></div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnKeyUp(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnKeyUp_Terminal_Gui_KeyEvent_">Responder.OnKeyUp(KeyEvent)</a></div>
-
-
- <a id="Terminal_Gui_View_OnLeave_" data-uid="Terminal.Gui.View.OnLeave*"></a>
- <h4 id="Terminal_Gui_View_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
- <div class="markdown level1 summary">
- Method invoked when a view loses focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnLeave(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td>The view that is getting focus.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnLeave_Terminal_Gui_View_">Responder.OnLeave(View)</a></div>
-
-
- <a id="Terminal_Gui_View_OnMouseClick_" data-uid="Terminal.Gui.View.OnMouseClick*"></a>
- <h4 id="Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_" data-uid="Terminal.Gui.View.OnMouseClick(Terminal.Gui.View.MouseEventArgs)">OnMouseClick(View.MouseEventArgs)</h4>
- <div class="markdown level1 summary">
- Invokes the MouseClick event.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">protected void OnMouseClick(View.MouseEventArgs args)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a></td>
- <td><span class="parametername">args</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_OnMouseEnter_" data-uid="Terminal.Gui.View.OnMouseEnter*"></a>
- <h4 id="Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseEnter(Terminal.Gui.MouseEvent)">OnMouseEnter(MouseEvent)</h4>
- <div class="markdown level1 summary">
- Method invoked when a mouse event is generated for the first time.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnMouseEnter(MouseEvent mouseEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
- <td><span class="parametername">mouseEvent</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnMouseEnter_Terminal_Gui_MouseEvent_">Responder.OnMouseEnter(MouseEvent)</a></div>
-
-
- <a id="Terminal_Gui_View_OnMouseEvent_" data-uid="Terminal.Gui.View.OnMouseEvent*"></a>
- <h4 id="Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseEvent(Terminal.Gui.MouseEvent)">OnMouseEvent(MouseEvent)</h4>
- <div class="markdown level1 summary">
- Method invoked when a mouse event is generated
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool OnMouseEvent(MouseEvent mouseEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
- <td><span class="parametername">mouseEvent</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_OnMouseLeave_" data-uid="Terminal.Gui.View.OnMouseLeave*"></a>
- <h4 id="Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.View.OnMouseLeave(Terminal.Gui.MouseEvent)">OnMouseLeave(MouseEvent)</h4>
- <div class="markdown level1 summary">
- Method invoked when a mouse event is generated for the last time.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnMouseLeave(MouseEvent mouseEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
- <td><span class="parametername">mouseEvent</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_OnMouseLeave_Terminal_Gui_MouseEvent_">Responder.OnMouseLeave(MouseEvent)</a></div>
-
-
- <a id="Terminal_Gui_View_OnRemoved_" data-uid="Terminal.Gui.View.OnRemoved*"></a>
- <h4 id="Terminal_Gui_View_OnRemoved_Terminal_Gui_View_" data-uid="Terminal.Gui.View.OnRemoved(Terminal.Gui.View)">OnRemoved(View)</h4>
- <div class="markdown level1 summary">
- Method invoked when a subview is being removed from this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnRemoved(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td>The subview being removed.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_PositionCursor_" data-uid="Terminal.Gui.View.PositionCursor*"></a>
- <h4 id="Terminal_Gui_View_PositionCursor" data-uid="Terminal.Gui.View.PositionCursor">PositionCursor()</h4>
- <div class="markdown level1 summary">
- Positions the cursor in the right position based on the currently focused view in the chain.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void PositionCursor()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_ProcessColdKey_" data-uid="Terminal.Gui.View.ProcessColdKey*"></a>
- <h4 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
- <div class="markdown level1 summary">
- This method can be overwritten by views that
- want to provide accelerator functionality
- (Alt-key for example), but without
- interefering with normal ProcessKey behavior.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessColdKey_Terminal_Gui_KeyEvent_">Responder.ProcessColdKey(KeyEvent)</a></div>
- <h5 id="Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- After keys are sent to the subviews on the
- current view, all the view are
- processed and the key is passed to the views
- to allow some of them to process the keystroke
- as a cold-key. </p>
- <p>
- This functionality is used, for example, by
- default buttons to act on the enter key.
- Processing this as a hot-key would prevent
- non-default buttons from consuming the enter
- keypress when they have the focus.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_ProcessHotKey_" data-uid="Terminal.Gui.View.ProcessHotKey*"></a>
- <h4 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
- <div class="markdown level1 summary">
- This method can be overwritten by view that
- want to provide accelerator functionality
- (Alt-key for example).
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessHotKey_Terminal_Gui_KeyEvent_">Responder.ProcessHotKey(KeyEvent)</a></div>
- <h5 id="Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Before keys are sent to the subview on the
- current view, all the views are
- processed and the key is passed to the widgets
- to allow some of them to process the keystroke
- as a hot-key. </p>
- <p>
- For example, if you implement a button that
- has a hotkey ok "o", you would catch the
- combination Alt-o here. If the event is
- caught, you must return true to stop the
- keystroke from being dispatched to other
- views.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_ProcessKey_" data-uid="Terminal.Gui.View.ProcessKey*"></a>
- <h4 id="Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.View.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
- <div class="markdown level1 summary">
- If the view is focused, gives the view a
- chance to process the keystroke.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_ProcessKey_Terminal_Gui_KeyEvent_">Responder.ProcessKey(KeyEvent)</a></div>
- <h5 id="Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Views can override this method if they are
- interested in processing the given keystroke.
- If they consume the keystroke, they must
- return true to stop the keystroke from being
- processed by other widgets or consumed by the
- widget engine. If they return false, the
- keystroke will be passed using the ProcessColdKey
- method to other views to process.
- </p>
- <p>
- The View implementation does nothing but return false,
- so it is not necessary to call base.ProcessKey if you
- derive directly from View, but you should if you derive
- other View subclasses.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_Redraw_" data-uid="Terminal.Gui.View.Redraw*"></a>
- <h4 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
- <div class="markdown level1 summary">
- Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void Redraw(Rect bounds)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">bounds</span></td>
- <td>The bounds (view-relative region) to redraw.</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
- </p>
- <p>
- Views should set the color that they want to use on entry, as otherwise this will inherit
- the last color that was set globally on the driver.
- </p>
- <p>
- Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
- larger than the <code>region</code> parameter.
- </p>
- </div>
-
-
- <a id="Terminal_Gui_View_Remove_" data-uid="Terminal.Gui.View.Remove*"></a>
- <h4 id="Terminal_Gui_View_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.View.Remove(Terminal.Gui.View)">Remove(View)</h4>
- <div class="markdown level1 summary">
- Removes a subview added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void Remove(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Remove_Terminal_Gui_View__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- </div>
-
-
- <a id="Terminal_Gui_View_RemoveAll_" data-uid="Terminal.Gui.View.RemoveAll*"></a>
- <h4 id="Terminal_Gui_View_RemoveAll" data-uid="Terminal.Gui.View.RemoveAll">RemoveAll()</h4>
- <div class="markdown level1 summary">
- Removes all subviews (children) added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void RemoveAll()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_ScreenToView_" data-uid="Terminal.Gui.View.ScreenToView*"></a>
- <h4 id="Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.ScreenToView(System.Int32,System.Int32)">ScreenToView(Int32, Int32)</h4>
- <div class="markdown level1 summary">
- Converts a point from screen-relative coordinates to view-relative coordinates.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Point ScreenToView(int x, int y)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">x</span></td>
- <td>X screen-coordinate point.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">y</span></td>
- <td>Y screen-coordinate point.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
- <td>The mapped point.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_SendSubviewBackwards_" data-uid="Terminal.Gui.View.SendSubviewBackwards*"></a>
- <h4 id="Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_" data-uid="Terminal.Gui.View.SendSubviewBackwards(Terminal.Gui.View)">SendSubviewBackwards(View)</h4>
- <div class="markdown level1 summary">
- Moves the subview backwards in the hierarchy, only one step
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SendSubviewBackwards(View subview)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">subview</span></td>
- <td>The subview to send backwards</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- If you want to send the view all the way to the back use SendSubviewToBack.
- </div>
-
-
- <a id="Terminal_Gui_View_SendSubviewToBack_" data-uid="Terminal.Gui.View.SendSubviewToBack*"></a>
- <h4 id="Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_" data-uid="Terminal.Gui.View.SendSubviewToBack(Terminal.Gui.View)">SendSubviewToBack(View)</h4>
- <div class="markdown level1 summary">
- Sends the specified subview to the front so it is the first view drawn
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SendSubviewToBack(View subview)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">subview</span></td>
- <td>The subview to send to the front</td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View__remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">BringSubviewToFront(View)</a>.
- </div>
-
-
- <a id="Terminal_Gui_View_SetChildNeedsDisplay_" data-uid="Terminal.Gui.View.SetChildNeedsDisplay*"></a>
- <h4 id="Terminal_Gui_View_SetChildNeedsDisplay" data-uid="Terminal.Gui.View.SetChildNeedsDisplay">SetChildNeedsDisplay()</h4>
- <div class="markdown level1 summary">
- Indicates that any child views (in the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">Subviews</a> list) need to be repainted.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SetChildNeedsDisplay()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_SetClip_" data-uid="Terminal.Gui.View.SetClip*"></a>
- <h4 id="Terminal_Gui_View_SetClip_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.SetClip(Terminal.Gui.Rect)">SetClip(Rect)</h4>
- <div class="markdown level1 summary">
- Sets the clip region to the specified view-relative region.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rect SetClip(Rect region)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">region</span></td>
- <td>View-relative clip region.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td>The previous screen-relative clip region.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_SetFocus_" data-uid="Terminal.Gui.View.SetFocus*"></a>
- <h4 id="Terminal_Gui_View_SetFocus" data-uid="Terminal.Gui.View.SetFocus">SetFocus()</h4>
- <div class="markdown level1 summary">
- Causes the specified view and the entire parent hierarchy to have the focused order updated.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SetFocus()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_SetHeight_" data-uid="Terminal.Gui.View.SetHeight*"></a>
- <h4 id="Terminal_Gui_View_SetHeight_System_Int32_System_Int32__" data-uid="Terminal.Gui.View.SetHeight(System.Int32,System.Int32@)">SetHeight(Int32, out Int32)</h4>
- <div class="markdown level1 summary">
- Calculate the height based on the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">Height</a> settings.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool SetHeight(int desiredHeight, out int resultHeight)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">desiredHeight</span></td>
- <td>The desired height.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">resultHeight</span></td>
- <td>The real result height.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td>True if the height can be directly assigned, false otherwise.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_SetNeedsDisplay_" data-uid="Terminal.Gui.View.SetNeedsDisplay*"></a>
- <h4 id="Terminal_Gui_View_SetNeedsDisplay" data-uid="Terminal.Gui.View.SetNeedsDisplay">SetNeedsDisplay()</h4>
- <div class="markdown level1 summary">
- Sets a flag indicating this view needs to be redisplayed because its state has changed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SetNeedsDisplay()</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_View_SetNeedsDisplay_" data-uid="Terminal.Gui.View.SetNeedsDisplay*"></a>
- <h4 id="Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect)">SetNeedsDisplay(Rect)</h4>
- <div class="markdown level1 summary">
- Flags the view-relative region on this View as needing to be repainted.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SetNeedsDisplay(Rect region)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">region</span></td>
- <td>The view-relative region that must be flagged for repaint.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_SetWidth_" data-uid="Terminal.Gui.View.SetWidth*"></a>
- <h4 id="Terminal_Gui_View_SetWidth_System_Int32_System_Int32__" data-uid="Terminal.Gui.View.SetWidth(System.Int32,System.Int32@)">SetWidth(Int32, out Int32)</h4>
- <div class="markdown level1 summary">
- Calculate the width based on the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">Width</a> settings.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool SetWidth(int desiredWidth, out int resultWidth)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">desiredWidth</span></td>
- <td>The desired width.</td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">resultWidth</span></td>
- <td>The real result width.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td>True if the width can be directly assigned, false otherwise.</td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_ToString_" data-uid="Terminal.Gui.View.ToString*"></a>
- <h4 id="Terminal_Gui_View_ToString" data-uid="Terminal.Gui.View.ToString">ToString()</h4>
- <div class="markdown level1 summary">
- Pretty prints the View
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.String</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><span class="xref">System.Object.ToString()</span></div>
- <h3 id="events">Events
- </h3>
-
-
- <h4 id="Terminal_Gui_View_Added" data-uid="Terminal.Gui.View.Added">Added</h4>
- <div class="markdown level1 summary">
- Event fired when a subview is being added to this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View> Added</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.html">View</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_DrawContent" data-uid="Terminal.Gui.View.DrawContent">DrawContent</h4>
- <div class="markdown level1 summary">
- Event invoked when the content area of the View is to be drawn.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Rect> DrawContent</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Rect.html">Rect</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_DrawContent_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- <p>
- Will be invoked before any subviews added with <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> have been drawn.
- </p>
- <p>
- Rect provides the view-relative rectangle describing the currently visible viewport into the <a class="xref" href="Terminal.Gui.View.html">View</a>.
- </p>
- </div>
-
-
- <h4 id="Terminal_Gui_View_Enter" data-uid="Terminal.Gui.View.Enter">Enter</h4>
- <div class="markdown level1 summary">
- Event fired when the view gets focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.FocusEventArgs> Enter</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_Initialized" data-uid="Terminal.Gui.View.Initialized">Initialized</h4>
- <div class="markdown level1 summary">
- Event called only once when the <a class="xref" href="Terminal.Gui.View.html">View</a> is being initialized for the first time.
- Allows configurations and assignments to be performed before the <a class="xref" href="Terminal.Gui.View.html">View</a> being shown.
- This derived from <span class="xref">System.ComponentModel.ISupportInitializeNotification</span> to allow notify all the views that are being initialized.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event EventHandler Initialized</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.EventHandler</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_KeyDown" data-uid="Terminal.Gui.View.KeyDown">KeyDown</h4>
- <div class="markdown level1 summary">
- Invoked when a key is pressed
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.KeyEventEventArgs> KeyDown</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_KeyPress" data-uid="Terminal.Gui.View.KeyPress">KeyPress</h4>
- <div class="markdown level1 summary">
- Invoked when a character key is pressed and occurs after the key up event.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.KeyEventEventArgs> KeyPress</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_KeyUp" data-uid="Terminal.Gui.View.KeyUp">KeyUp</h4>
- <div class="markdown level1 summary">
- Invoked when a key is released
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.KeyEventEventArgs> KeyUp</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_LayoutComplete" data-uid="Terminal.Gui.View.LayoutComplete">LayoutComplete</h4>
- <div class="markdown level1 summary">
- Fired after the Views's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">LayoutSubviews()</a> method has completed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.LayoutEventArgs> LayoutComplete</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_LayoutComplete_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- Subscribe to this event to perform tasks when the <a class="xref" href="Terminal.Gui.View.html">View</a> has been resized or the layout has otherwise changed.
- </div>
-
-
- <h4 id="Terminal_Gui_View_LayoutStarted" data-uid="Terminal.Gui.View.LayoutStarted">LayoutStarted</h4>
- <div class="markdown level1 summary">
- Fired after the Views's <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">LayoutSubviews()</a> method has completed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.LayoutEventArgs> LayoutStarted</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_LayoutStarted_remarks">Remarks</h5>
- <div class="markdown level1 remarks">
- Subscribe to this event to perform tasks when the <a class="xref" href="Terminal.Gui.View.html">View</a> has been resized or the layout has otherwise changed.
- </div>
-
-
- <h4 id="Terminal_Gui_View_Leave" data-uid="Terminal.Gui.View.Leave">Leave</h4>
- <div class="markdown level1 summary">
- Event fired when the view looses focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.FocusEventArgs> Leave</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_MouseClick" data-uid="Terminal.Gui.View.MouseClick">MouseClick</h4>
- <div class="markdown level1 summary">
- Event fired when a mouse event is generated.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.MouseEventArgs> MouseClick</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_MouseEnter" data-uid="Terminal.Gui.View.MouseEnter">MouseEnter</h4>
- <div class="markdown level1 summary">
- Event fired when the view receives the mouse event for the first time.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.MouseEventArgs> MouseEnter</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_MouseLeave" data-uid="Terminal.Gui.View.MouseLeave">MouseLeave</h4>
- <div class="markdown level1 summary">
- Event fired when the view receives a mouse event for the last time.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View.MouseEventArgs> MouseLeave</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_View_Removed" data-uid="Terminal.Gui.View.Removed">Removed</h4>
- <div class="markdown level1 summary">
- Event fired when a subview is being removed from this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<View> Removed</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.View.html">View</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h3 id="implements">Implements</h3>
- <div>
- <span class="xref">System.IDisposable</span>
- </div>
- <div>
- <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
- </div>
- <div>
- <span class="xref">System.ComponentModel.ISupportInitialize</span>
- </div>
- </article>
- </div>
-
- <div class="hidden-sm col-md-2" role="complementary">
- <div class="sideaffix">
- <div class="contribution">
- <ul class="nav">
- </ul>
- </div>
- <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
- <h5>In This Article</h5>
- <div></div>
- </nav>
- </div>
- </div>
- </div>
- </div>
-
- <footer>
- <div class="grad-bottom"></div>
- <div class="footer">
- <div class="container">
- <span class="pull-right">
- <a href="#top">Back to top</a>
- </span>
-
- <span>Generated by <strong>DocFX</strong></span>
- </div>
- </div>
- </footer>
- </div>
-
- <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
- <script type="text/javascript" src="../../styles/docfx.js"></script>
- <script type="text/javascript" src="../../styles/main.js"></script>
- </body>
- </html>
|