Files
Terminal.Gui/docs/api/Terminal/Terminal.CursesDriver.html
Miguel de Icaza 971ce0bdb7 Update docs
2018-01-17 16:11:14 -05:00

603 lines
22 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class CursesDriver
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CursesDriver
">
<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.CursesDriver">
<h1 id="Terminal_CursesDriver" data-uid="Terminal.CursesDriver">Class CursesDriver
</h1>
<div class="markdown level0 summary"><p>This is the Curses driver for the gui.cs/Terminal framework.</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.ConsoleDriver.html">ConsoleDriver</a></div>
<div class="level2"><span class="xref">CursesDriver</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.ConsoleDriver.html#Terminal_ConsoleDriver_Clip">ConsoleDriver.Clip</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
<h6><strong>Assembly</strong>: Terminal.dll</h6>
<h5 id="Terminal_CursesDriver_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CursesDriver : Terminal.ConsoleDriver</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_CursesDriver__ctor_" data-uid="Terminal.CursesDriver.#ctor*"></a>
<h4 id="Terminal_CursesDriver__ctor" data-uid="Terminal.CursesDriver.#ctor">CursesDriver()</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 CursesDriver ();</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="Terminal_CursesDriver_window" data-uid="Terminal.CursesDriver.window">window</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 Unix.Terminal.Curses.Window window;</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></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Terminal_CursesDriver_Cols_" data-uid="Terminal.CursesDriver.Cols*"></a>
<h4 id="Terminal_CursesDriver_Cols" data-uid="Terminal.CursesDriver.Cols">Cols</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 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_CursesDriver_Rows_" data-uid="Terminal.CursesDriver.Rows*"></a>
<h4 id="Terminal_CursesDriver_Rows" data-uid="Terminal.CursesDriver.Rows">Rows</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 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_CursesDriver_AddCh_" data-uid="Terminal.CursesDriver.AddCh*"></a>
<h4 id="Terminal_CursesDriver_AddCh_System_Int32_" data-uid="Terminal.CursesDriver.AddCh(System.Int32)">AddCh(Int32)</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 void AddCh (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">ch</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_AddSpecial_" data-uid="Terminal.CursesDriver.AddSpecial*"></a>
<h4 id="Terminal_CursesDriver_AddSpecial_Terminal_SpecialChar_" data-uid="Terminal.CursesDriver.AddSpecial(Terminal.SpecialChar)">AddSpecial(SpecialChar)</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 void AddSpecial (Terminal.SpecialChar 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><a class="xref" href="Terminal.SpecialChar.html">SpecialChar</a></td>
<td><span class="parametername">ch</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_AddStr_" data-uid="Terminal.CursesDriver.AddStr*"></a>
<h4 id="Terminal_CursesDriver_AddStr_System_String_" data-uid="Terminal.CursesDriver.AddStr(System.String)">AddStr(String)</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 void AddStr (string 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">System.String</span></td>
<td><span class="parametername">str</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_DrawFrame_" data-uid="Terminal.CursesDriver.DrawFrame*"></a>
<h4 id="Terminal_CursesDriver_DrawFrame_Terminal_Rect_System_Boolean_" data-uid="Terminal.CursesDriver.DrawFrame(Terminal.Rect,System.Boolean)">DrawFrame(Rect, Boolean)</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 void DrawFrame (Terminal.Rect region, 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.Rect.html">Rect</a></td>
<td><span class="parametername">region</span></td>
<td><p>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">fill</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_End_" data-uid="Terminal.CursesDriver.End*"></a>
<h4 id="Terminal_CursesDriver_End" data-uid="Terminal.CursesDriver.End">End()</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 void End ();</code></pre>
</div>
<a id="Terminal_CursesDriver_Init_" data-uid="Terminal.CursesDriver.Init*"></a>
<h4 id="Terminal_CursesDriver_Init_System_Action_" data-uid="Terminal.CursesDriver.Init(System.Action)">Init(Action)</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 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>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_Move_" data-uid="Terminal.CursesDriver.Move*"></a>
<h4 id="Terminal_CursesDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.CursesDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</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 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>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">row</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_PrepareToRun_" data-uid="Terminal.CursesDriver.PrepareToRun*"></a>
<h4 id="Terminal_CursesDriver_PrepareToRun_Mono_Terminal_MainLoop_System_Action_Terminal_KeyEvent__System_Action_Terminal_MouseEvent__" data-uid="Terminal.CursesDriver.PrepareToRun(Mono.Terminal.MainLoop,System.Action{Terminal.KeyEvent},System.Action{Terminal.MouseEvent})">PrepareToRun(MainLoop, Action&lt;KeyEvent&gt;, Action&lt;MouseEvent&gt;)</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 void PrepareToRun (Mono.Terminal.MainLoop mainLoop, Action&lt;Terminal.KeyEvent&gt; keyHandler, Action&lt;Terminal.MouseEvent&gt; 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>&lt;<a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a>&gt;</td>
<td><span class="parametername">keyHandler</span></td>
<td><p>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.MouseEvent.html">MouseEvent</a>&gt;</td>
<td><span class="parametername">mouseHandler</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_RedrawTop_" data-uid="Terminal.CursesDriver.RedrawTop*"></a>
<h4 id="Terminal_CursesDriver_RedrawTop" data-uid="Terminal.CursesDriver.RedrawTop">RedrawTop()</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 void RedrawTop ();</code></pre>
</div>
<a id="Terminal_CursesDriver_Refresh_" data-uid="Terminal.CursesDriver.Refresh*"></a>
<h4 id="Terminal_CursesDriver_Refresh" data-uid="Terminal.CursesDriver.Refresh">Refresh()</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 void Refresh ();</code></pre>
</div>
<a id="Terminal_CursesDriver_SetAttribute_" data-uid="Terminal.CursesDriver.SetAttribute*"></a>
<h4 id="Terminal_CursesDriver_SetAttribute_Terminal_Attribute_" data-uid="Terminal.CursesDriver.SetAttribute(Terminal.Attribute)">SetAttribute(Attribute)</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 void SetAttribute (Terminal.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.Attribute.html">Attribute</a></td>
<td><span class="parametername">c</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_SetColors_" data-uid="Terminal.CursesDriver.SetColors*"></a>
<h4 id="Terminal_CursesDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.CursesDriver.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 override 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_CursesDriver_SetColors_" data-uid="Terminal.CursesDriver.SetColors*"></a>
<h4 id="Terminal_CursesDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.CursesDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</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 void SetColors (short foreColorId, 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">foreColorId</span></td>
<td><p>To be added.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int16</span></td>
<td><span class="parametername">backgroundColorId</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_CursesDriver_StartReportingMouseMoves_" data-uid="Terminal.CursesDriver.StartReportingMouseMoves*"></a>
<h4 id="Terminal_CursesDriver_StartReportingMouseMoves" data-uid="Terminal.CursesDriver.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 override void StartReportingMouseMoves ();</code></pre>
</div>
<a id="Terminal_CursesDriver_StopReportingMouseMoves_" data-uid="Terminal.CursesDriver.StopReportingMouseMoves*"></a>
<h4 id="Terminal_CursesDriver_StopReportingMouseMoves" data-uid="Terminal.CursesDriver.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 override void StopReportingMouseMoves ();</code></pre>
</div>
<a id="Terminal_CursesDriver_Suspend_" data-uid="Terminal.CursesDriver.Suspend*"></a>
<h4 id="Terminal_CursesDriver_Suspend" data-uid="Terminal.CursesDriver.Suspend">Suspend()</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 void Suspend ();</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>