123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class ConsoleDriver
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class ConsoleDriver
- ">
- <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.ConsoleDriver">
-
-
- <h1 id="Terminal_Gui_ConsoleDriver" data-uid="Terminal.Gui.ConsoleDriver">Class ConsoleDriver
- </h1>
- <div class="markdown level0 summary"><p>ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.</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"><span class="xref">ConsoleDriver</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_ConsoleDriver_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract class ConsoleDriver</code></pre>
- </div>
- <h3 id="constructors">Constructors
- </h3>
-
-
- <a id="Terminal_Gui_ConsoleDriver__ctor_" data-uid="Terminal.Gui.ConsoleDriver.#ctor*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver__ctor" data-uid="Terminal.Gui.ConsoleDriver.#ctor">ConsoleDriver()</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">protected ConsoleDriver ();</code></pre>
- </div>
- <h3 id="fields">Fields
- </h3>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_BottomTee" data-uid="Terminal.Gui.ConsoleDriver.BottomTee">BottomTee</h4>
- <div class="markdown level1 summary"><p>The bottom tee.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune BottomTee;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_Diamond" data-uid="Terminal.Gui.ConsoleDriver.Diamond">Diamond</h4>
- <div class="markdown level1 summary"><p>Diamond character</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune Diamond;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_HLine" data-uid="Terminal.Gui.ConsoleDriver.HLine">HLine</h4>
- <div class="markdown level1 summary"><p>Horizontal line character.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune HLine;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_LeftTee" data-uid="Terminal.Gui.ConsoleDriver.LeftTee">LeftTee</h4>
- <div class="markdown level1 summary"><p>Left tee</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune LeftTee;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_LLCorner" data-uid="Terminal.Gui.ConsoleDriver.LLCorner">LLCorner</h4>
- <div class="markdown level1 summary"><p>Lower left corner</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune LLCorner;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_LRCorner" data-uid="Terminal.Gui.ConsoleDriver.LRCorner">LRCorner</h4>
- <div class="markdown level1 summary"><p>Lower right corner</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune LRCorner;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_RightTee" data-uid="Terminal.Gui.ConsoleDriver.RightTee">RightTee</h4>
- <div class="markdown level1 summary"><p>Right tee</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune RightTee;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_Stipple" data-uid="Terminal.Gui.ConsoleDriver.Stipple">Stipple</h4>
- <div class="markdown level1 summary"><p>Stipple pattern</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune Stipple;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_TopTee" data-uid="Terminal.Gui.ConsoleDriver.TopTee">TopTee</h4>
- <div class="markdown level1 summary"><p>Top tee</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune TopTee;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_ULCorner" data-uid="Terminal.Gui.ConsoleDriver.ULCorner">ULCorner</h4>
- <div class="markdown level1 summary"><p>Upper left corner</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune ULCorner;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_URCorner" data-uid="Terminal.Gui.ConsoleDriver.URCorner">URCorner</h4>
- <div class="markdown level1 summary"><p>Upper right corner</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune URCorner;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <h4 id="Terminal_Gui_ConsoleDriver_VLine" data-uid="Terminal.Gui.ConsoleDriver.VLine">VLine</h4>
- <div class="markdown level1 summary"><p>Vertical line character.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Rune VLine;</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><span class="xref">System.Rune</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="properties">Properties
- </h3>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Clip_" data-uid="Terminal.Gui.ConsoleDriver.Clip*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Clip" data-uid="Terminal.Gui.ConsoleDriver.Clip">Clip</h4>
- <div class="markdown level1 summary"><p>Controls the current clipping region that AddRune/AddStr is subject to.</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 Clip { 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 clip.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Cols_" data-uid="Terminal.Gui.ConsoleDriver.Cols*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Cols" data-uid="Terminal.Gui.ConsoleDriver.Cols">Cols</h4>
- <div class="markdown level1 summary"><p>The current number of columns in the terminal.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract int Cols { 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.Int32</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Rows_" data-uid="Terminal.Gui.ConsoleDriver.Rows*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Rows" data-uid="Terminal.Gui.ConsoleDriver.Rows">Rows</h4>
- <div class="markdown level1 summary"><p>The current number of rows in the terminal.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract int Rows { 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.Int32</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="methods">Methods
- </h3>
-
-
- <a id="Terminal_Gui_ConsoleDriver_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
- <div class="markdown level1 summary"><p>Adds the specified rune to the display at the current cursor position</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void AddRune (Rune rune);</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.Rune</span></td>
- <td><span class="parametername">rune</span></td>
- <td><p>Rune to add.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
- <div class="markdown level1 summary"><p>Adds the specified</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void AddStr (NStack.ustring str);</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">str</span></td>
- <td><p>String.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_CookMouse_" data-uid="Terminal.Gui.ConsoleDriver.CookMouse*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_CookMouse" data-uid="Terminal.Gui.ConsoleDriver.CookMouse">CookMouse()</h4>
- <div class="markdown level1 summary"><p>Enables the cooked event processing from the mouse driver</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void CookMouse ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)">DrawFrame(Rect, Int32, Boolean)</h4>
- <div class="markdown level1 summary"><p>Draws a frame on the specified region with the specified padding around 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 virtual void DrawFrame (Terminal.Gui.Rect region, int padding, bool fill);</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>Region where the frame will be drawn..</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">padding</span></td>
- <td><p>Padding to add on the sides.</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 will clear the contents with the current color, otherwise the contents will be left untouched.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
- <div class="markdown level1 summary"><p>Ends the execution of the console driver.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void End ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
- <div class="markdown level1 summary"><p>Initializes the driver</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void Init (Action terminalResized);</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.Action</span></td>
- <td><span class="parametername">terminalResized</span></td>
- <td><p>Method to invoke when the terminal is resized.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
- <div class="markdown level1 summary"><p>Moves the cursor to 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 abstract 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>Column to move the cursor to.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int32</span></td>
- <td><span class="parametername">row</span></td>
- <td><p>Row to move the cursor to.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_PrepareToRun_Mono_Terminal_MainLoop_System_Action_Terminal_Gui_KeyEvent__System_Action_Terminal_Gui_MouseEvent__" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun(Mono.Terminal.MainLoop,System.Action{Terminal.Gui.KeyEvent},System.Action{Terminal.Gui.MouseEvent})">PrepareToRun(MainLoop, Action<KeyEvent>, Action<MouseEvent>)</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 abstract void PrepareToRun (Mono.Terminal.MainLoop mainLoop, Action<Terminal.Gui.KeyEvent> keyHandler, Action<Terminal.Gui.MouseEvent> mouseHandler);</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="../Mono.Terminal/Mono.Terminal.MainLoop.html">MainLoop</a></td>
- <td><span class="parametername">mainLoop</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>></td>
- <td><span class="parametername">keyHandler</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>></td>
- <td><span class="parametername">mouseHandler</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
- <div class="markdown level1 summary"><p>Updates the screen to reflect all the changes that have been done to the display buffer</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void Refresh ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
- <div class="markdown level1 summary"><p>Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void SetAttribute (Terminal.Gui.Attribute c);</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.Attribute.html">Attribute</a></td>
- <td><span class="parametername">c</span></td>
- <td><p>C.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</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 abstract void SetColors (ConsoleColor foreground, ConsoleColor background);</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.ConsoleColor</span></td>
- <td><span class="parametername">foreground</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.ConsoleColor</span></td>
- <td><span class="parametername">background</span></td>
- <td><p>To be added.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
- <div class="markdown level1 summary"><p>Advanced uses - set colors to any pre-set pairs, you would need to init_color
- that independently with the R, G, B values.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void SetColors (short foregroundColorId, short backgroundColorId);</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.Int16</span></td>
- <td><span class="parametername">foregroundColorId</span></td>
- <td><p>Foreground color identifier.</p>
- </td>
- </tr>
- <tr>
- <td><span class="xref">System.Int16</span></td>
- <td><span class="parametername">backgroundColorId</span></td>
- <td><p>Background color identifier.</p>
- </td>
- </tr>
- </tbody>
- </table>
-
-
- <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</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 abstract void StartReportingMouseMoves ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</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 abstract void StopReportingMouseMoves ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
- <div class="markdown level1 summary"><p>Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void Suspend ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_UncookMouse_" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_UncookMouse" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse">UncookMouse()</h4>
- <div class="markdown level1 summary"><p>Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void UncookMouse ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_UpdateCursor_" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_UpdateCursor" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor">UpdateCursor()</h4>
- <div class="markdown level1 summary"><p>Updates the location of the cursor position</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void UpdateCursor ();</code></pre>
- </div>
-
-
- <a id="Terminal_Gui_ConsoleDriver_UpdateScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen*"></a>
- <h4 id="Terminal_Gui_ConsoleDriver_UpdateScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen">UpdateScreen()</h4>
- <div class="markdown level1 summary"><p>Redraws the physical screen with the contents that have been queued up via any of the printing commands.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public abstract void UpdateScreen ();</code></pre>
- </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">
- <!-- <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>
|