12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571 |
- <!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.18.2.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="">
- <meta property="docfx:tocrel" content="../toc.html">
-
-
- </head>
- <body data-spy="scroll" data-target="#affix">
- <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="../../logo.svg" 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 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 View
- </h1>
- <div class="markdown level0 summary"><p>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.</p>
- </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>
- <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.FrameView.html">FrameView</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.TextField.html">TextField</a></div>
- <div class="level3"><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></div>
- <div class="inheritedMembers">
- <h5>Inherited Members</h5>
- <div>
- <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a>
- </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 : Terminal.Gui.Responder, System.Collections.IEnumerable</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.cs. Views
- can contain one or more subviews, can respond to user input and render themselves on the screen.
- </p>
- <p>
- Views are created with a specified rectangle region (the frame) that is relative to the container
- that they are added into.<br> </p>
- <p>
- Subviews can be added to a View by calling the Add method. The container of a view is the
- Superview.
- </p>
- <p>
- Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view
- as requiring to be redrawn.
- </p>
- <p>
- Views have a ColorScheme 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>
- If a ColorScheme is not set on a view, the result of the ColorScheme is the
- value of the SuperView and the value might only be valid once a view has been
- added to a SuperView, so your subclasses should not rely on ColorScheme being
- set at construction time.
- </p>
- <p>
- Using ColorSchemes has the advantage that your application will work both
- in color as well as black and white displays.
- </p>
- <p>
- Views that are focusable should implement the PositionCursor 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></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_Terminal_Gui_Rect_" data-uid="Terminal.Gui.View.#ctor(Terminal.Gui.Rect)">View(Rect)</h4>
- <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Terminal.Gui.View.html">View</a> class with the specified frame. This is the default constructor.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View (Terminal.Gui.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><p>The region covered by this view.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="fields">Fields
- </h3>
-
-
- <h4 id="Terminal_Gui_View_Driver" data-uid="Terminal.Gui.View.Driver">Driver</h4>
- <div class="markdown level1 summary"><p>Points to the current driver in use by the view, it is a convenience property
- for simplifying the development of new views.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Terminal.Gui.ConsoleDriver Driver;</code></pre>
- </div>
- <h5 class="fieldValue">Field 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><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="properties">Properties
- </h3>
-
-
- <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"><p>The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>The bounds.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>The color scheme for this view, if it is not defined, it returns the parent's
- color scheme.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>To be added.</p>
- </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"><p>Returns the currently focused view inside this view, or null if nothing is focused.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>The focused.</p>
- </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"><p>Gets or sets the frame for the view.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>The frame.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Frame_remarks">Remarks</h5>
- <div class="markdown level1 remarks"><p>Altering the Frame of a view will trigger the redrawing of the
- view as well as the redrawing of the affected regions in the superview.</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"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> has focus.</p>
- </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><p><code>true</code> if has focus; otherwise, <code>false</code>.</p>
- </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"><p>Gets or sets an identifier for the view;</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public NStack.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><p>The identifier.</p>
- </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"><p>Returns the most focused view in the chain of subviews (the leaf view that has the focus).</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>The most focused.</p>
- </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"><p>This returns a list of the subviews contained by this view.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public System.Collections.Generic.IList<Terminal.Gui.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><p>The subviews.</p>
- </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"><p>Returns the container for this view, or null if this view has not been added to a container.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>The super view.</p>
- </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"><p>Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.View.html">View</a> want mouse position reports.</p>
- </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><p><code>true</code> if want mouse position reports; otherwise, <code>false</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <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"><p>Adds a subview to this view.</p>
- </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 (Terminal.Gui.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><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Adds the specified views to the view.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void Add (Terminal.Gui.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><p>Array of one or more views (can be optional parameter).</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_AddCh_" data-uid="Terminal.Gui.View.AddCh*"></a>
- <h4 id="Terminal_Gui_View_AddCh_System_Int32_System_Int32_System_Int32_" data-uid="Terminal.Gui.View.AddCh(System.Int32,System.Int32,System.Int32)">AddCh(Int32, Int32, Int32)</h4>
- <div class="markdown level1 summary"><p>Displays the specified character in the specified column and row.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void AddCh (int col, int row, int 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><p>Col.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">row</span></td>
- <td><p>Row.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">ch</span></td>
- <td><p>Ch.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Displays the specified character in the specified column and row.</p>
- </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><p>Col.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">row</span></td>
- <td><p>Row.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Rune</span></td>
- <td><span class="parametername">ch</span></td>
- <td><p>Ch.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_ChildNeedsDisplay_" data-uid="Terminal.Gui.View.ChildNeedsDisplay*"></a>
- <h4 id="Terminal_Gui_View_ChildNeedsDisplay" data-uid="Terminal.Gui.View.ChildNeedsDisplay">ChildNeedsDisplay()</h4>
- <div class="markdown level1 summary"><p>Flags this view for requiring the children views to be repainted.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void ChildNeedsDisplay ();</code></pre>
- </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"><p>Clears the view region with the current color.</p>
- </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"><p>Clears the specfied rectangular region with the current color</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void Clear (Terminal.Gui.Rect r);</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">r</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.</p>
- </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"><p>Sets the Console driver's clip region to the current View's Bounds.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>The existing driver's Clip region, which can be then set by setting the Driver.Clip property.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_DrawFrame_" data-uid="Terminal.Gui.View.DrawFrame*"></a>
- <h4 id="Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Boolean_" data-uid="Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Boolean)">DrawFrame(Rect, Boolean)</h4>
- <div class="markdown level1 summary"><p>Draws a frame in the current view, clipped by the boundary of this view</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawFrame (Terminal.Gui.Rect rect, 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">rect</span></td>
- <td><p>Rectangular region for the frame to be drawn.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">fill</span></td>
- <td><p>If set to <code>true</code> it fill will the contents.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Draws a frame in the current view, clipped by the boundary of this view</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawFrame (Terminal.Gui.Rect rect, 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">rect</span></td>
- <td><p>Rectangular region for the frame to be drawn.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">padding</span></td>
- <td><p>The padding to add to the drawn frame.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">fill</span></td>
- <td><p>If set to <code>true</code> it fill will the contents.</p>
- </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"><p>Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawHotString (NStack.ustring text, bool focused, Terminal.Gui.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><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">focused</span></td>
- <td><p>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</p>
- </td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
- <td><span class="parametername">scheme</span></td>
- <td><p>The color scheme to use.</p>
- </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"><p>Utility function to draw strings that contain a hotkey</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawHotString (NStack.ustring text, Terminal.Gui.Attribute hotColor, Terminal.Gui.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><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
- </td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
- <td><span class="parametername">hotColor</span></td>
- <td><p>Hot color.</p>
- </td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
- <td><span class="parametername">normalColor</span></td>
- <td><p>Normal color.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
- <h4 id="Terminal_Gui_View_DrawHotString_System_String_System_Boolean_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.View.DrawHotString(System.String,System.Boolean,Terminal.Gui.ColorScheme)">DrawHotString(String, Boolean, ColorScheme)</h4>
- <div class="markdown level1 summary"><p>Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawHotString (string text, bool focused, Terminal.Gui.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">System.String</span></td>
- <td><span class="parametername">text</span></td>
- <td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><span class="parametername">focused</span></td>
- <td><p>If set to <code>true</code> this uses the focused colors from the color scheme, otherwise the regular ones.</p>
- </td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
- <td><span class="parametername">scheme</span></td>
- <td><p>The color scheme to use.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_DrawHotString_" data-uid="Terminal.Gui.View.DrawHotString*"></a>
- <h4 id="Terminal_Gui_View_DrawHotString_System_String_Terminal_Gui_Attribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.View.DrawHotString(System.String,Terminal.Gui.Attribute,Terminal.Gui.Attribute)">DrawHotString(String, Attribute, Attribute)</h4>
- <div class="markdown level1 summary"><p>Utility function to draw strings that contain a hotkey</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void DrawHotString (string text, Terminal.Gui.Attribute hotColor, Terminal.Gui.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">System.String</span></td>
- <td><span class="parametername">text</span></td>
- <td><p>String to display, the underscoore before a letter flags the next letter as the hotkey.</p>
- </td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
- <td><span class="parametername">hotColor</span></td>
- <td><p>Hot color.</p>
- </td>
- </tr>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
- <td><span class="parametername">normalColor</span></td>
- <td><p>Normal color.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.</p>
- </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"><p>Focuses the first focusable subview if one exists.</p>
- </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"><p>Focuses the last focusable subview if one exists.</p>
- </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"><p>Focuses the next view.</p>
- </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><p><code>true</code>, if next was focused, <code>false</code> otherwise.</p>
- </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"><p>Focuses the previous view.</p>
- </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><p><code>true</code>, if previous was focused, <code>false</code> otherwise.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_GetEnumerator_" data-uid="Terminal.Gui.View.GetEnumerator*"></a>
- <h4 id="Terminal_Gui_View_GetEnumerator" data-uid="Terminal.Gui.View.GetEnumerator">GetEnumerator()</h4>
- <div class="markdown level1 summary"><p>Gets an enumerator that enumerates the subviews in this view.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.Gui.View/<GetEnumerator>d__23))]
- public System.Collections.IEnumerator GetEnumerator ();</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.Collections.IEnumerator</span></td>
- <td><p>The enumerator.</p>
- </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"><p>This virtual method is 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.</p>
- </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>
-
-
- <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"><p>This moves the cursor to the specified column and row in the view.</p>
- </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><p>Col.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">row</span></td>
- <td><p>Row.</p>
- </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"><p>Positions the cursor in the right position based on the currently focused view in the chain.</p>
- </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"></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 (Terminal.Gui.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">kb</span></td>
- <td><p>To be added.</p>
- </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><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"></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 (Terminal.Gui.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">kb</span></td>
- <td><p>To be added.</p>
- </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><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"></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 (Terminal.Gui.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">kb</span></td>
- <td><p>To be added.</p>
- </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><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.</p>
- </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 (Terminal.Gui.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><p>The region to redraw, this is relative to the view itself.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h5 id="Terminal_Gui_View_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
- <div class="markdown level1 remarks"><p>
- Views should set the color that they want to use on entry, as otherwise this will inherit
- the last color that was set globaly on the driver.
- </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"><p>Removes a widget from this container.</p>
- </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 (Terminal.Gui.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><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Removes all the widgets from this container.</p>
- </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"><p>Converts a point from screen coordinates into the view coordinate space.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.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><p>X screen-coordinate point.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">y</span></td>
- <td><p>Y screen-coordinate point.</p>
- </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><p>The mapped point.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <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"><p>Sets the clipping region to the specified region, the region is view-relative</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Terminal.Gui.Rect SetClip (Terminal.Gui.Rect rect);</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><p>Rectangle region to clip into, the region is view-relative.</p>
- </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><p>The previous clip region.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_View_SetFocus_" data-uid="Terminal.Gui.View.SetFocus*"></a>
- <h4 id="Terminal_Gui_View_SetFocus_Terminal_Gui_View_" data-uid="Terminal.Gui.View.SetFocus(Terminal.Gui.View)">SetFocus(View)</h4>
- <div class="markdown level1 summary"><p>Focuses the specified sub-view.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SetFocus (Terminal.Gui.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><p>View.</p>
- </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"><p>Invoke to flag that this view needs to be redisplayed, by any code
- that alters the state of the view.</p>
- </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"><p>Flags the specified rectangle region on this view as needing to be repainted.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public void SetNeedsDisplay (Terminal.Gui.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><p>The region that must be flagged for repaint.</p>
- </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"><p>Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.Gui.View.html">View</a>.</p>
- </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><p>A <span class="xref">System.String</span> that represents the current <a class="xref" href="Terminal.Gui.View.html">View</a>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </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">
- <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
- </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>Copyright © 2015-2017 Microsoft<br>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>
|