Terminal.Gui.KeyModifiers.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  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>Class KeyModifiers
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class KeyModifiers
  11. ">
  12. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  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="../../images/logo48.png" 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 class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.KeyModifiers">
  72. <h1 id="Terminal_Gui_KeyModifiers" data-uid="Terminal.Gui.KeyModifiers" class="text-break">Class KeyModifiers
  73. </h1>
  74. <div class="markdown level0 summary">Identifies the state of the "shift"-keys within a event.</div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  79. <div class="level1"><span class="xref">KeyModifiers</span></div>
  80. </div>
  81. <div class="inheritedMembers">
  82. <h5>Inherited Members</h5>
  83. <div>
  84. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  103. </div>
  104. </div>
  105. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  106. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  107. <h5 id="Terminal_Gui_KeyModifiers_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public class KeyModifiers</code></pre>
  110. </div>
  111. <h3 id="fields">Fields
  112. </h3>
  113. <span class="small pull-right mobile-hide">
  114. <span class="divider">|</span>
  115. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers_Alt.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers.Alt%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  116. </span>
  117. <span class="small pull-right mobile-hide">
  118. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L22">View Source</a>
  119. </span>
  120. <h4 id="Terminal_Gui_KeyModifiers_Alt" data-uid="Terminal.Gui.KeyModifiers.Alt">Alt</h4>
  121. <div class="markdown level1 summary">Check if the Alt key was pressed or not.</div>
  122. <div class="markdown level1 conceptual"></div>
  123. <h5 class="declaration">Declaration</h5>
  124. <div class="codewrapper">
  125. <pre><code class="lang-csharp hljs">public bool Alt</code></pre>
  126. </div>
  127. <h5 class="fieldValue">Field Value</h5>
  128. <table class="table table-bordered table-condensed">
  129. <thead>
  130. <tr>
  131. <th>Type</th>
  132. <th>Description</th>
  133. </tr>
  134. </thead>
  135. <tbody>
  136. <tr>
  137. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  138. <td></td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. <span class="small pull-right mobile-hide">
  143. <span class="divider">|</span>
  144. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers_Capslock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers.Capslock%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  145. </span>
  146. <span class="small pull-right mobile-hide">
  147. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L30">View Source</a>
  148. </span>
  149. <h4 id="Terminal_Gui_KeyModifiers_Capslock" data-uid="Terminal.Gui.KeyModifiers.Capslock">Capslock</h4>
  150. <div class="markdown level1 summary">Check if the Caps lock key was pressed or not.</div>
  151. <div class="markdown level1 conceptual"></div>
  152. <h5 class="declaration">Declaration</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public bool Capslock</code></pre>
  155. </div>
  156. <h5 class="fieldValue">Field Value</h5>
  157. <table class="table table-bordered table-condensed">
  158. <thead>
  159. <tr>
  160. <th>Type</th>
  161. <th>Description</th>
  162. </tr>
  163. </thead>
  164. <tbody>
  165. <tr>
  166. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  167. <td></td>
  168. </tr>
  169. </tbody>
  170. </table>
  171. <span class="small pull-right mobile-hide">
  172. <span class="divider">|</span>
  173. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers_Ctrl.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers.Ctrl%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  174. </span>
  175. <span class="small pull-right mobile-hide">
  176. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L26">View Source</a>
  177. </span>
  178. <h4 id="Terminal_Gui_KeyModifiers_Ctrl" data-uid="Terminal.Gui.KeyModifiers.Ctrl">Ctrl</h4>
  179. <div class="markdown level1 summary">Check if the Ctrl key was pressed or not.</div>
  180. <div class="markdown level1 conceptual"></div>
  181. <h5 class="declaration">Declaration</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">public bool Ctrl</code></pre>
  184. </div>
  185. <h5 class="fieldValue">Field Value</h5>
  186. <table class="table table-bordered table-condensed">
  187. <thead>
  188. <tr>
  189. <th>Type</th>
  190. <th>Description</th>
  191. </tr>
  192. </thead>
  193. <tbody>
  194. <tr>
  195. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  196. <td></td>
  197. </tr>
  198. </tbody>
  199. </table>
  200. <span class="small pull-right mobile-hide">
  201. <span class="divider">|</span>
  202. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers_Numlock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers.Numlock%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  203. </span>
  204. <span class="small pull-right mobile-hide">
  205. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L34">View Source</a>
  206. </span>
  207. <h4 id="Terminal_Gui_KeyModifiers_Numlock" data-uid="Terminal.Gui.KeyModifiers.Numlock">Numlock</h4>
  208. <div class="markdown level1 summary">Check if the Num lock key was pressed or not.</div>
  209. <div class="markdown level1 conceptual"></div>
  210. <h5 class="declaration">Declaration</h5>
  211. <div class="codewrapper">
  212. <pre><code class="lang-csharp hljs">public bool Numlock</code></pre>
  213. </div>
  214. <h5 class="fieldValue">Field Value</h5>
  215. <table class="table table-bordered table-condensed">
  216. <thead>
  217. <tr>
  218. <th>Type</th>
  219. <th>Description</th>
  220. </tr>
  221. </thead>
  222. <tbody>
  223. <tr>
  224. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  225. <td></td>
  226. </tr>
  227. </tbody>
  228. </table>
  229. <span class="small pull-right mobile-hide">
  230. <span class="divider">|</span>
  231. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers_Scrolllock.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers.Scrolllock%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  232. </span>
  233. <span class="small pull-right mobile-hide">
  234. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L38">View Source</a>
  235. </span>
  236. <h4 id="Terminal_Gui_KeyModifiers_Scrolllock" data-uid="Terminal.Gui.KeyModifiers.Scrolllock">Scrolllock</h4>
  237. <div class="markdown level1 summary">Check if the Scroll lock key was pressed or not.</div>
  238. <div class="markdown level1 conceptual"></div>
  239. <h5 class="declaration">Declaration</h5>
  240. <div class="codewrapper">
  241. <pre><code class="lang-csharp hljs">public bool Scrolllock</code></pre>
  242. </div>
  243. <h5 class="fieldValue">Field Value</h5>
  244. <table class="table table-bordered table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  254. <td></td>
  255. </tr>
  256. </tbody>
  257. </table>
  258. <span class="small pull-right mobile-hide">
  259. <span class="divider">|</span>
  260. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers_Shift.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers.Shift%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  261. </span>
  262. <span class="small pull-right mobile-hide">
  263. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L18">View Source</a>
  264. </span>
  265. <h4 id="Terminal_Gui_KeyModifiers_Shift" data-uid="Terminal.Gui.KeyModifiers.Shift">Shift</h4>
  266. <div class="markdown level1 summary">Check if the Shift key was pressed or not.</div>
  267. <div class="markdown level1 conceptual"></div>
  268. <h5 class="declaration">Declaration</h5>
  269. <div class="codewrapper">
  270. <pre><code class="lang-csharp hljs">public bool Shift</code></pre>
  271. </div>
  272. <h5 class="fieldValue">Field Value</h5>
  273. <table class="table table-bordered table-condensed">
  274. <thead>
  275. <tr>
  276. <th>Type</th>
  277. <th>Description</th>
  278. </tr>
  279. </thead>
  280. <tbody>
  281. <tr>
  282. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
  283. <td></td>
  284. </tr>
  285. </tbody>
  286. </table>
  287. </article>
  288. </div>
  289. <div class="hidden-sm col-md-2" role="complementary">
  290. <div class="sideaffix">
  291. <div class="contribution">
  292. <ul class="nav">
  293. <li>
  294. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_KeyModifiers.md&amp;value=---%0Auid%3A%20Terminal.Gui.KeyModifiers%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  295. </li>
  296. <li>
  297. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Event.cs/#L14" class="contribution-link">View Source</a>
  298. </li>
  299. </ul>
  300. </div>
  301. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  302. <h5>In this article</h5>
  303. <div></div>
  304. </nav>
  305. </div>
  306. </div>
  307. </div>
  308. </div>
  309. <footer>
  310. <div class="grad-bottom"></div>
  311. <div class="footer">
  312. <div class="container">
  313. <span class="pull-right">
  314. <a href="#top">Back to top</a>
  315. </span>
  316. <span>Generated by <strong>DocFX</strong></span>
  317. </div>
  318. </div>
  319. </footer>
  320. </div>
  321. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  322. <script type="text/javascript" src="../../styles/docfx.js"></script>
  323. <script type="text/javascript" src="../../styles/main.js"></script>
  324. </body>
  325. </html>