mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2026-01-01 16:59:35 +01:00
Updated docfx. Generated fresh docs. Added an icon.
This commit is contained in:
Charlie Kindel
@@ -1,27 +1,28 @@
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Struct KeyEvent
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Struct KeyEvent
|
||||
">
|
||||
<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">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class KeyEvent
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class KeyEvent
|
||||
">
|
||||
<meta name="generator" content="docfx 2.53.1.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">
|
||||
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
||||
<meta property="docfx:navrel" content="">
|
||||
<meta property="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta property="docfx:rel" content="../../">
|
||||
|
||||
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
||||
<div id="wrapper">
|
||||
<header>
|
||||
|
||||
@@ -36,7 +37,7 @@
|
||||
</button>
|
||||
|
||||
<a class="navbar-brand" href="../../index.html">
|
||||
<img id="logo" class="svg" src="../../logo.svg" alt="">
|
||||
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
|
||||
</a>
|
||||
</div>
|
||||
<div class="collapse navbar-collapse" id="navbar">
|
||||
@@ -57,6 +58,16 @@
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container body-content">
|
||||
|
||||
<div id="search-results">
|
||||
<div class="search-list"></div>
|
||||
<div class="sr-items">
|
||||
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
||||
</div>
|
||||
<ul id="pagination"></ul>
|
||||
</div>
|
||||
</div>
|
||||
<div role="main" class="container body-content hide-when-search">
|
||||
|
||||
<div class="sidenav hide-when-search">
|
||||
@@ -70,29 +81,69 @@
|
||||
<article class="content wrap" id="_content" data-uid="Terminal.Gui.KeyEvent">
|
||||
|
||||
|
||||
<h1 id="Terminal_Gui_KeyEvent" data-uid="Terminal.Gui.KeyEvent">Struct KeyEvent
|
||||
<h1 id="Terminal_Gui_KeyEvent" data-uid="Terminal.Gui.KeyEvent" class="text-break">Class KeyEvent
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Describes a keyboard event.</p>
|
||||
<div class="markdown level0 summary">
|
||||
Describes a keyboard event.
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">KeyEvent</span></div>
|
||||
</div>
|
||||
<div class="inheritedMembers">
|
||||
<h5>Inherited Members</h5>
|
||||
<div>
|
||||
<span class="xref">System.Object.Equals(System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.GetHashCode()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.GetType()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.MemberwiseClone()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
||||
</div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
|
||||
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
|
||||
<h5 id="Terminal_Gui_KeyEvent_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public struct KeyEvent</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class KeyEvent</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent__ctor_Terminal_Gui_Key_" data-uid="Terminal.Gui.KeyEvent.#ctor(Terminal.Gui.Key)">KeyEvent(Key)</h4>
|
||||
<div class="markdown level1 summary"><p>Constructs a new KeyEvent from the provided Key value - can be a rune cast into a Key value</p>
|
||||
<h4 id="Terminal_Gui_KeyEvent__ctor" data-uid="Terminal.Gui.KeyEvent.#ctor">KeyEvent()</h4>
|
||||
<div class="markdown level1 summary">
|
||||
Constructs a new <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public KeyEvent (Terminal.Gui.Key k);</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public KeyEvent()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent__ctor_Terminal_Gui_Key_" data-uid="Terminal.Gui.KeyEvent.#ctor(Terminal.Gui.Key)">KeyEvent(Key)</h4>
|
||||
<div class="markdown level1 summary">
|
||||
Constructs a new <a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a> from the provided Key value - can be a rune cast into a Key value
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public KeyEvent(Key k)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
@@ -107,8 +158,7 @@
|
||||
<tr>
|
||||
<td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
|
||||
<td><span class="parametername">k</span></td>
|
||||
<td><p>To be added.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -117,12 +167,13 @@
|
||||
|
||||
|
||||
<h4 id="Terminal_Gui_KeyEvent_Key" data-uid="Terminal.Gui.KeyEvent.Key">Key</h4>
|
||||
<div class="markdown level1 summary"><p>Symb olid definition for the key.</p>
|
||||
<div class="markdown level1 summary">
|
||||
Symb olid definition for the key.
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Terminal.Gui.Key Key;</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Key Key</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
@@ -135,8 +186,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
|
||||
<td><p>To be added.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -146,7 +196,8 @@
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent_IsAlt_" data-uid="Terminal.Gui.KeyEvent.IsAlt*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent_IsAlt" data-uid="Terminal.Gui.KeyEvent.IsAlt">IsAlt</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a value indicating whether the Alt key was pressed (real or synthesized)</p>
|
||||
<div class="markdown level1 summary">
|
||||
Gets a value indicating whether the Alt key was pressed (real or synthesized)
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
@@ -164,8 +215,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p><code>true</code> if is alternate; otherwise, <code>false</code>.</p>
|
||||
</td>
|
||||
<td><code>true</code> if is alternate; otherwise, <code>false</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -173,7 +223,8 @@
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent_IsCtrl_" data-uid="Terminal.Gui.KeyEvent.IsCtrl*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent_IsCtrl" data-uid="Terminal.Gui.KeyEvent.IsCtrl">IsCtrl</h4>
|
||||
<div class="markdown level1 summary"><p>Determines whether the value is a control key</p>
|
||||
<div class="markdown level1 summary">
|
||||
Determines whether the value is a control key (and NOT just the ctrl key)
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
@@ -191,8 +242,34 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><p><code>true</code> if is ctrl; otherwise, <code>false</code>.</p>
|
||||
</td>
|
||||
<td><code>true</code> if is ctrl; otherwise, <code>false</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent_IsShift_" data-uid="Terminal.Gui.KeyEvent.IsShift*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent_IsShift" data-uid="Terminal.Gui.KeyEvent.IsShift">IsShift</h4>
|
||||
<div class="markdown level1 summary">
|
||||
Gets a value indicating whether the Shift key was pressed.
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsShift { get; }</code></pre>
|
||||
</div>
|
||||
<h5 class="propertyValue">Property Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><code>true</code> if is shift; otherwise, <code>false</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -200,9 +277,10 @@
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent_KeyValue_" data-uid="Terminal.Gui.KeyEvent.KeyValue*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent_KeyValue" data-uid="Terminal.Gui.KeyEvent.KeyValue">KeyValue</h4>
|
||||
<div class="markdown level1 summary"><p>The key value cast to an integer, you will typicall use this for
|
||||
extracting the Unicode rune value out of a key, when none of the
|
||||
symbolic options are in use.</p>
|
||||
<div class="markdown level1 summary">
|
||||
The key value cast to an integer, you will typical use this for
|
||||
extracting the Unicode rune value out of a key, when none of the
|
||||
symbolic options are in use.
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
@@ -220,11 +298,39 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><p>To be added.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
|
||||
|
||||
<a id="Terminal_Gui_KeyEvent_ToString_" data-uid="Terminal.Gui.KeyEvent.ToString*"></a>
|
||||
<h4 id="Terminal_Gui_KeyEvent_ToString" data-uid="Terminal.Gui.KeyEvent.ToString">ToString()</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 string ToString()</code></pre>
|
||||
</div>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><span class="xref">System.Object.ToString()</span></div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -250,7 +356,7 @@
|
||||
<a href="#top">Back to top</a>
|
||||
</span>
|
||||
|
||||
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
|
||||
<span>Generated by <strong>DocFX</strong></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
Reference in New Issue
Block a user