mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 16:27:55 +01:00
600 lines
15 KiB
HTML
600 lines
15 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.7.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">Search Results for <span></span></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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>
|
|
Numerics keys are the values between 48 and 57 corresponding to 0 to 9
|
|
</p>
|
|
</p>
|
|
<p>
|
|
Upper alpha keys are the values between 65 and 90 corresponding to A to 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_A">A</td>
|
|
<td>
|
|
The key code for the user pressing Shift-A
|
|
</td>
|
|
</tr>
|
|
<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_B">B</td>
|
|
<td>
|
|
The key code for the user pressing Shift-B
|
|
</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_C">C</td>
|
|
<td>
|
|
The key code for the user pressing Shift-C
|
|
</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_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_D">D</td>
|
|
<td>
|
|
The key code for the user pressing Shift-D
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D0">D0</td>
|
|
<td>
|
|
Digit 0.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D1">D1</td>
|
|
<td>
|
|
Digit 1.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D2">D2</td>
|
|
<td>
|
|
Digit 2.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D3">D3</td>
|
|
<td>
|
|
Digit 3.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D4">D4</td>
|
|
<td>
|
|
Digit 4.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D5">D5</td>
|
|
<td>
|
|
Digit 5.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D6">D6</td>
|
|
<td>
|
|
Digit 6.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D7">D7</td>
|
|
<td>
|
|
Digit 7.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D8">D8</td>
|
|
<td>
|
|
Digit 8.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_D9">D9</td>
|
|
<td>
|
|
Digit 9.
|
|
</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_E">E</td>
|
|
<td>
|
|
The key code for the user pressing Shift-E
|
|
</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_F">F</td>
|
|
<td>
|
|
The key code for the user pressing Shift-F
|
|
</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_G">G</td>
|
|
<td>
|
|
The key code for the user pressing Shift-G
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_H">H</td>
|
|
<td>
|
|
The key code for the user pressing Shift-H
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Home">Home</td>
|
|
<td>
|
|
Home key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_I">I</td>
|
|
<td>
|
|
The key code for the user pressing Shift-I
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_InsertChar">InsertChar</td>
|
|
<td>
|
|
Insert character key
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_J">J</td>
|
|
<td>
|
|
The key code for the user pressing Shift-J
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_K">K</td>
|
|
<td>
|
|
The key code for the user pressing Shift-K
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_L">L</td>
|
|
<td>
|
|
The key code for the user pressing Shift-L
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_M">M</td>
|
|
<td>
|
|
The key code for the user pressing Shift-M
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_N">N</td>
|
|
<td>
|
|
The key code for the user pressing Shift-N
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Null">Null</td>
|
|
<td>
|
|
The key code representing null or empty
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_O">O</td>
|
|
<td>
|
|
The key code for the user pressing Shift-O
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_P">P</td>
|
|
<td>
|
|
The key code for the user pressing Shift-P
|
|
</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_Q">Q</td>
|
|
<td>
|
|
The key code for the user pressing Shift-Q
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_R">R</td>
|
|
<td>
|
|
The key code for the user pressing Shift-R
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_S">S</td>
|
|
<td>
|
|
The key code for the user pressing Shift-S
|
|
</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_T">T</td>
|
|
<td>
|
|
The key code for the user pressing Shift-T
|
|
</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_U">U</td>
|
|
<td>
|
|
The key code for the user pressing Shift-U
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Unknown">Unknown</td>
|
|
<td>
|
|
A key with an unknown mapping was raised.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_V">V</td>
|
|
<td>
|
|
The key code for the user pressing Shift-V
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_W">W</td>
|
|
<td>
|
|
The key code for the user pressing Shift-W
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_X">X</td>
|
|
<td>
|
|
The key code for the user pressing Shift-X
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Y">Y</td>
|
|
<td>
|
|
The key code for the user pressing Shift-Y
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td id="Terminal_Gui_Key_Z">Z</td>
|
|
<td>
|
|
The key code for the user pressing Shift-Z
|
|
</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">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</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>
|