mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 08:17:53 +01:00
536 lines
14 KiB
HTML
536 lines
14 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>Enum Key
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Enum Key
|
|
">
|
|
<meta name="generator" content="docfx 2.56.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="../../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../../">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../../index.html">
|
|
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></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">
|
|
<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.Key">
|
|
|
|
|
|
<h1 id="Terminal_Gui_Key" data-uid="Terminal.Gui.Key" class="text-break">Enum Key
|
|
</h1>
|
|
<div class="markdown level0 summary">
|
|
The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
|
|
encode all the unicode values that can be passed.
|
|
</div>
|
|
<div class="markdown level0 conceptual"></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_Key_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[Flags]
|
|
public enum Key : uint</code></pre>
|
|
</div>
|
|
<h5 id="Terminal_Gui_Key_remarks"><strong>Remarks</strong></h5>
|
|
<div class="markdown level0 remarks">
|
|
<p>
|
|
If the <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_SpecialMask">SpecialMask</a> is set, then the value is that of the special mask,
|
|
otherwise, the value is the one of the lower bits (as extracted by <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_CharMask">CharMask</a>)
|
|
</p>
|
|
<p>
|
|
Control keys are the values between 1 and 26 corresponding to Control-A to Control-Z
|
|
</p>
|
|
<p>
|
|
Unicode runes are also stored here, the letter 'A" for example is encoded as a value 65 (not surfaced in the enum).
|
|
</p>
|
|
</div>
|
|
<h3 id="fields">Fields
|
|
</h3>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<thead>
|
|
<tbody>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_AltMask">AltMask</td>
|
|
<td>
|
|
When this value is set, the Key encodes the sequence Alt-KeyValue.
|
|
And the actual value must be extracted by removing the AltMask.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Backspace">Backspace</td>
|
|
<td>
|
|
Backspace key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_BackTab">BackTab</td>
|
|
<td>
|
|
Shift-tab key (backwards tab key).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_CharMask">CharMask</td>
|
|
<td>
|
|
Mask that indicates that this is a character value, values outside this range
|
|
indicate special characters like Alt-key combinations or special keys on the
|
|
keyboard like function keys, arrows keys and so on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlA">ControlA</td>
|
|
<td>
|
|
The key code for the user pressing Control-A
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlB">ControlB</td>
|
|
<td>
|
|
The key code for the user pressing Control-B
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlC">ControlC</td>
|
|
<td>
|
|
The key code for the user pressing Control-C
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlD">ControlD</td>
|
|
<td>
|
|
The key code for the user pressing Control-D
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlE">ControlE</td>
|
|
<td>
|
|
The key code for the user pressing Control-E
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlF">ControlF</td>
|
|
<td>
|
|
The key code for the user pressing Control-F
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlG">ControlG</td>
|
|
<td>
|
|
The key code for the user pressing Control-G
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlH">ControlH</td>
|
|
<td>
|
|
The key code for the user pressing Control-H
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlI">ControlI</td>
|
|
<td>
|
|
The key code for the user pressing Control-I (same as the tab key).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlJ">ControlJ</td>
|
|
<td>
|
|
The key code for the user pressing Control-J
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlK">ControlK</td>
|
|
<td>
|
|
The key code for the user pressing Control-K
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlL">ControlL</td>
|
|
<td>
|
|
The key code for the user pressing Control-L
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlM">ControlM</td>
|
|
<td>
|
|
The key code for the user pressing Control-M
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlN">ControlN</td>
|
|
<td>
|
|
The key code for the user pressing Control-N (same as the return key).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlO">ControlO</td>
|
|
<td>
|
|
The key code for the user pressing Control-O
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlP">ControlP</td>
|
|
<td>
|
|
The key code for the user pressing Control-P
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlQ">ControlQ</td>
|
|
<td>
|
|
The key code for the user pressing Control-Q
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlR">ControlR</td>
|
|
<td>
|
|
The key code for the user pressing Control-R
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlS">ControlS</td>
|
|
<td>
|
|
The key code for the user pressing Control-S
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlSpace">ControlSpace</td>
|
|
<td>
|
|
The key code for the user pressing Control-spacebar
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlT">ControlT</td>
|
|
<td>
|
|
The key code for the user pressing Control-T
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlU">ControlU</td>
|
|
<td>
|
|
The key code for the user pressing Control-U
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlV">ControlV</td>
|
|
<td>
|
|
The key code for the user pressing Control-V
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlW">ControlW</td>
|
|
<td>
|
|
The key code for the user pressing Control-W
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlX">ControlX</td>
|
|
<td>
|
|
The key code for the user pressing Control-X
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlY">ControlY</td>
|
|
<td>
|
|
The key code for the user pressing Control-Y
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ControlZ">ControlZ</td>
|
|
<td>
|
|
The key code for the user pressing Control-Z
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_CtrlMask">CtrlMask</td>
|
|
<td>
|
|
When this value is set, the Key encodes the sequence Ctrl-KeyValue.
|
|
And the actual value must be extracted by removing the CtrlMask.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_CursorDown">CursorDown</td>
|
|
<td>
|
|
Cursor down key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_CursorLeft">CursorLeft</td>
|
|
<td>
|
|
Cursor left key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_CursorRight">CursorRight</td>
|
|
<td>
|
|
Cursor right key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_CursorUp">CursorUp</td>
|
|
<td>
|
|
Cursor up key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Delete">Delete</td>
|
|
<td>
|
|
The key code for the user pressing the delete key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_DeleteChar">DeleteChar</td>
|
|
<td>
|
|
Delete character key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_End">End</td>
|
|
<td>
|
|
End key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Enter">Enter</td>
|
|
<td>
|
|
The key code for the user pressing the return key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Esc">Esc</td>
|
|
<td>
|
|
The key code for the user pressing the escape key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F1">F1</td>
|
|
<td>
|
|
F1 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F10">F10</td>
|
|
<td>
|
|
F10 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F11">F11</td>
|
|
<td>
|
|
F11 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F12">F12</td>
|
|
<td>
|
|
F12 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F2">F2</td>
|
|
<td>
|
|
F2 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F3">F3</td>
|
|
<td>
|
|
F3 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F4">F4</td>
|
|
<td>
|
|
F4 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F5">F5</td>
|
|
<td>
|
|
F5 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F6">F6</td>
|
|
<td>
|
|
F6 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F7">F7</td>
|
|
<td>
|
|
F7 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F8">F8</td>
|
|
<td>
|
|
F8 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_F9">F9</td>
|
|
<td>
|
|
F9 key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Home">Home</td>
|
|
<td>
|
|
Home key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_InsertChar">InsertChar</td>
|
|
<td>
|
|
Insert character key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_PageDown">PageDown</td>
|
|
<td>
|
|
Page Down key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_PageUp">PageUp</td>
|
|
<td>
|
|
Page Up key.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_ShiftMask">ShiftMask</td>
|
|
<td>
|
|
When this value is set, the Key encodes the sequence Shift-KeyValue.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Space">Space</td>
|
|
<td>
|
|
The key code for the user pressing the space bar
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_SpecialMask">SpecialMask</td>
|
|
<td>
|
|
If the <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_SpecialMask">SpecialMask</a> is set, then the value is that of the special mask,
|
|
otherwise, the value is the one of the lower bits (as extracted by <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_CharMask">CharMask</a>).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Tab">Tab</td>
|
|
<td>
|
|
The key code for the user pressing the tab key (forwards tab key).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Unknown">Unknown</td>
|
|
<td>
|
|
A key with an unknown mapping was raised.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</thead></thead></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>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>
|