Terminal.Gui.KeyEvent.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Struct KeyEvent
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Struct KeyEvent
  11. ">
  12. <meta name="generator" content="docfx 2.18.2.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.KeyEvent">
  63. <h1 id="Terminal_Gui_KeyEvent" data-uid="Terminal.Gui.KeyEvent">Struct KeyEvent
  64. </h1>
  65. <div class="markdown level0 summary"><p>Describes a keyboard event.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  69. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  70. <h5 id="Terminal_Gui_KeyEvent_syntax">Syntax</h5>
  71. <div class="codewrapper">
  72. <pre><code class="lang-csharp hljs">public struct KeyEvent</code></pre>
  73. </div>
  74. <h3 id="constructors">Constructors
  75. </h3>
  76. <a id="Terminal_Gui_KeyEvent__ctor_" data-uid="Terminal.Gui.KeyEvent.#ctor*"></a>
  77. <h4 id="Terminal_Gui_KeyEvent__ctor_Terminal_Gui_Key_" data-uid="Terminal.Gui.KeyEvent.#ctor(Terminal.Gui.Key)">KeyEvent(Key)</h4>
  78. <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>
  79. </div>
  80. <div class="markdown level1 conceptual"></div>
  81. <h5 class="decalaration">Declaration</h5>
  82. <div class="codewrapper">
  83. <pre><code class="lang-csharp hljs">public KeyEvent (Terminal.Gui.Key k);</code></pre>
  84. </div>
  85. <h5 class="parameters">Parameters</h5>
  86. <table class="table table-bordered table-striped table-condensed">
  87. <thead>
  88. <tr>
  89. <th>Type</th>
  90. <th>Name</th>
  91. <th>Description</th>
  92. </tr>
  93. </thead>
  94. <tbody>
  95. <tr>
  96. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  97. <td><span class="parametername">k</span></td>
  98. <td><p>To be added.</p>
  99. </td>
  100. </tr>
  101. </tbody>
  102. </table>
  103. <h3 id="fields">Fields
  104. </h3>
  105. <h4 id="Terminal_Gui_KeyEvent_Key" data-uid="Terminal.Gui.KeyEvent.Key">Key</h4>
  106. <div class="markdown level1 summary"><p>Symb olid definition for the key.</p>
  107. </div>
  108. <div class="markdown level1 conceptual"></div>
  109. <h5 class="decalaration">Declaration</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public Terminal.Gui.Key Key;</code></pre>
  112. </div>
  113. <h5 class="fieldValue">Field Value</h5>
  114. <table class="table table-bordered table-striped table-condensed">
  115. <thead>
  116. <tr>
  117. <th>Type</th>
  118. <th>Description</th>
  119. </tr>
  120. </thead>
  121. <tbody>
  122. <tr>
  123. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  124. <td><p>To be added.</p>
  125. </td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. <h3 id="properties">Properties
  130. </h3>
  131. <a id="Terminal_Gui_KeyEvent_IsAlt_" data-uid="Terminal.Gui.KeyEvent.IsAlt*"></a>
  132. <h4 id="Terminal_Gui_KeyEvent_IsAlt" data-uid="Terminal.Gui.KeyEvent.IsAlt">IsAlt</h4>
  133. <div class="markdown level1 summary"><p>Gets a value indicating whether the Alt key was pressed (real or synthesized)</p>
  134. </div>
  135. <div class="markdown level1 conceptual"></div>
  136. <h5 class="decalaration">Declaration</h5>
  137. <div class="codewrapper">
  138. <pre><code class="lang-csharp hljs">public bool IsAlt { get; }</code></pre>
  139. </div>
  140. <h5 class="propertyValue">Property Value</h5>
  141. <table class="table table-bordered table-striped table-condensed">
  142. <thead>
  143. <tr>
  144. <th>Type</th>
  145. <th>Description</th>
  146. </tr>
  147. </thead>
  148. <tbody>
  149. <tr>
  150. <td><span class="xref">System.Boolean</span></td>
  151. <td><p><code>true</code> if is alternate; otherwise, <code>false</code>.</p>
  152. </td>
  153. </tr>
  154. </tbody>
  155. </table>
  156. <a id="Terminal_Gui_KeyEvent_IsCtrl_" data-uid="Terminal.Gui.KeyEvent.IsCtrl*"></a>
  157. <h4 id="Terminal_Gui_KeyEvent_IsCtrl" data-uid="Terminal.Gui.KeyEvent.IsCtrl">IsCtrl</h4>
  158. <div class="markdown level1 summary"><p>Determines whether the value is a control key</p>
  159. </div>
  160. <div class="markdown level1 conceptual"></div>
  161. <h5 class="decalaration">Declaration</h5>
  162. <div class="codewrapper">
  163. <pre><code class="lang-csharp hljs">public bool IsCtrl { get; }</code></pre>
  164. </div>
  165. <h5 class="propertyValue">Property Value</h5>
  166. <table class="table table-bordered table-striped table-condensed">
  167. <thead>
  168. <tr>
  169. <th>Type</th>
  170. <th>Description</th>
  171. </tr>
  172. </thead>
  173. <tbody>
  174. <tr>
  175. <td><span class="xref">System.Boolean</span></td>
  176. <td><p><code>true</code> if is ctrl; otherwise, <code>false</code>.</p>
  177. </td>
  178. </tr>
  179. </tbody>
  180. </table>
  181. <a id="Terminal_Gui_KeyEvent_KeyValue_" data-uid="Terminal.Gui.KeyEvent.KeyValue*"></a>
  182. <h4 id="Terminal_Gui_KeyEvent_KeyValue" data-uid="Terminal.Gui.KeyEvent.KeyValue">KeyValue</h4>
  183. <div class="markdown level1 summary"><p>The key value cast to an integer, you will typicall use this for
  184. extracting the Unicode rune value out of a key, when none of the
  185. symbolic options are in use.</p>
  186. </div>
  187. <div class="markdown level1 conceptual"></div>
  188. <h5 class="decalaration">Declaration</h5>
  189. <div class="codewrapper">
  190. <pre><code class="lang-csharp hljs">public int KeyValue { get; }</code></pre>
  191. </div>
  192. <h5 class="propertyValue">Property Value</h5>
  193. <table class="table table-bordered table-striped table-condensed">
  194. <thead>
  195. <tr>
  196. <th>Type</th>
  197. <th>Description</th>
  198. </tr>
  199. </thead>
  200. <tbody>
  201. <tr>
  202. <td><span class="xref">System.Int32</span></td>
  203. <td><p>To be added.</p>
  204. </td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. </article>
  209. </div>
  210. <div class="hidden-sm col-md-2" role="complementary">
  211. <div class="sideaffix">
  212. <div class="contribution">
  213. <ul class="nav">
  214. </ul>
  215. </div>
  216. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  217. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  218. </nav>
  219. </div>
  220. </div>
  221. </div>
  222. </div>
  223. <footer>
  224. <div class="grad-bottom"></div>
  225. <div class="footer">
  226. <div class="container">
  227. <span class="pull-right">
  228. <a href="#top">Back to top</a>
  229. </span>
  230. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  231. </div>
  232. </div>
  233. </footer>
  234. </div>
  235. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  236. <script type="text/javascript" src="../../styles/docfx.js"></script>
  237. <script type="text/javascript" src="../../styles/main.js"></script>
  238. </body>
  239. </html>