Terminal.Gui.ConsoleDriver.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934
  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 ConsoleDriver
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ConsoleDriver
  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.ConsoleDriver">
  63. <h1 id="Terminal_Gui_ConsoleDriver" data-uid="Terminal.Gui.ConsoleDriver">Class ConsoleDriver
  64. </h1>
  65. <div class="markdown level0 summary"><p>ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><span class="xref">ConsoleDriver</span></div>
  72. </div>
  73. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  74. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  75. <h5 id="Terminal_Gui_ConsoleDriver_syntax">Syntax</h5>
  76. <div class="codewrapper">
  77. <pre><code class="lang-csharp hljs">public abstract class ConsoleDriver</code></pre>
  78. </div>
  79. <h3 id="constructors">Constructors
  80. </h3>
  81. <a id="Terminal_Gui_ConsoleDriver__ctor_" data-uid="Terminal.Gui.ConsoleDriver.#ctor*"></a>
  82. <h4 id="Terminal_Gui_ConsoleDriver__ctor" data-uid="Terminal.Gui.ConsoleDriver.#ctor">ConsoleDriver()</h4>
  83. <div class="markdown level1 summary"></div>
  84. <div class="markdown level1 conceptual"></div>
  85. <h5 class="decalaration">Declaration</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">protected ConsoleDriver ();</code></pre>
  88. </div>
  89. <h3 id="fields">Fields
  90. </h3>
  91. <h4 id="Terminal_Gui_ConsoleDriver_BottomTee" data-uid="Terminal.Gui.ConsoleDriver.BottomTee">BottomTee</h4>
  92. <div class="markdown level1 summary"><p>The bottom tee.</p>
  93. </div>
  94. <div class="markdown level1 conceptual"></div>
  95. <h5 class="decalaration">Declaration</h5>
  96. <div class="codewrapper">
  97. <pre><code class="lang-csharp hljs">public Rune BottomTee;</code></pre>
  98. </div>
  99. <h5 class="fieldValue">Field Value</h5>
  100. <table class="table table-bordered table-striped table-condensed">
  101. <thead>
  102. <tr>
  103. <th>Type</th>
  104. <th>Description</th>
  105. </tr>
  106. </thead>
  107. <tbody>
  108. <tr>
  109. <td><span class="xref">System.Rune</span></td>
  110. <td><p>To be added.</p>
  111. </td>
  112. </tr>
  113. </tbody>
  114. </table>
  115. <h4 id="Terminal_Gui_ConsoleDriver_Diamond" data-uid="Terminal.Gui.ConsoleDriver.Diamond">Diamond</h4>
  116. <div class="markdown level1 summary"><p>Diamond character</p>
  117. </div>
  118. <div class="markdown level1 conceptual"></div>
  119. <h5 class="decalaration">Declaration</h5>
  120. <div class="codewrapper">
  121. <pre><code class="lang-csharp hljs">public Rune Diamond;</code></pre>
  122. </div>
  123. <h5 class="fieldValue">Field Value</h5>
  124. <table class="table table-bordered table-striped table-condensed">
  125. <thead>
  126. <tr>
  127. <th>Type</th>
  128. <th>Description</th>
  129. </tr>
  130. </thead>
  131. <tbody>
  132. <tr>
  133. <td><span class="xref">System.Rune</span></td>
  134. <td><p>To be added.</p>
  135. </td>
  136. </tr>
  137. </tbody>
  138. </table>
  139. <h4 id="Terminal_Gui_ConsoleDriver_HLine" data-uid="Terminal.Gui.ConsoleDriver.HLine">HLine</h4>
  140. <div class="markdown level1 summary"><p>Horizontal line character.</p>
  141. </div>
  142. <div class="markdown level1 conceptual"></div>
  143. <h5 class="decalaration">Declaration</h5>
  144. <div class="codewrapper">
  145. <pre><code class="lang-csharp hljs">public Rune HLine;</code></pre>
  146. </div>
  147. <h5 class="fieldValue">Field Value</h5>
  148. <table class="table table-bordered table-striped table-condensed">
  149. <thead>
  150. <tr>
  151. <th>Type</th>
  152. <th>Description</th>
  153. </tr>
  154. </thead>
  155. <tbody>
  156. <tr>
  157. <td><span class="xref">System.Rune</span></td>
  158. <td><p>To be added.</p>
  159. </td>
  160. </tr>
  161. </tbody>
  162. </table>
  163. <h4 id="Terminal_Gui_ConsoleDriver_LeftTee" data-uid="Terminal.Gui.ConsoleDriver.LeftTee">LeftTee</h4>
  164. <div class="markdown level1 summary"><p>Left tee</p>
  165. </div>
  166. <div class="markdown level1 conceptual"></div>
  167. <h5 class="decalaration">Declaration</h5>
  168. <div class="codewrapper">
  169. <pre><code class="lang-csharp hljs">public Rune LeftTee;</code></pre>
  170. </div>
  171. <h5 class="fieldValue">Field Value</h5>
  172. <table class="table table-bordered table-striped table-condensed">
  173. <thead>
  174. <tr>
  175. <th>Type</th>
  176. <th>Description</th>
  177. </tr>
  178. </thead>
  179. <tbody>
  180. <tr>
  181. <td><span class="xref">System.Rune</span></td>
  182. <td><p>To be added.</p>
  183. </td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. <h4 id="Terminal_Gui_ConsoleDriver_LLCorner" data-uid="Terminal.Gui.ConsoleDriver.LLCorner">LLCorner</h4>
  188. <div class="markdown level1 summary"><p>Lower left corner</p>
  189. </div>
  190. <div class="markdown level1 conceptual"></div>
  191. <h5 class="decalaration">Declaration</h5>
  192. <div class="codewrapper">
  193. <pre><code class="lang-csharp hljs">public Rune LLCorner;</code></pre>
  194. </div>
  195. <h5 class="fieldValue">Field Value</h5>
  196. <table class="table table-bordered table-striped table-condensed">
  197. <thead>
  198. <tr>
  199. <th>Type</th>
  200. <th>Description</th>
  201. </tr>
  202. </thead>
  203. <tbody>
  204. <tr>
  205. <td><span class="xref">System.Rune</span></td>
  206. <td><p>To be added.</p>
  207. </td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <h4 id="Terminal_Gui_ConsoleDriver_LRCorner" data-uid="Terminal.Gui.ConsoleDriver.LRCorner">LRCorner</h4>
  212. <div class="markdown level1 summary"><p>Lower right corner</p>
  213. </div>
  214. <div class="markdown level1 conceptual"></div>
  215. <h5 class="decalaration">Declaration</h5>
  216. <div class="codewrapper">
  217. <pre><code class="lang-csharp hljs">public Rune LRCorner;</code></pre>
  218. </div>
  219. <h5 class="fieldValue">Field Value</h5>
  220. <table class="table table-bordered table-striped table-condensed">
  221. <thead>
  222. <tr>
  223. <th>Type</th>
  224. <th>Description</th>
  225. </tr>
  226. </thead>
  227. <tbody>
  228. <tr>
  229. <td><span class="xref">System.Rune</span></td>
  230. <td><p>To be added.</p>
  231. </td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. <h4 id="Terminal_Gui_ConsoleDriver_RightTee" data-uid="Terminal.Gui.ConsoleDriver.RightTee">RightTee</h4>
  236. <div class="markdown level1 summary"><p>Right tee</p>
  237. </div>
  238. <div class="markdown level1 conceptual"></div>
  239. <h5 class="decalaration">Declaration</h5>
  240. <div class="codewrapper">
  241. <pre><code class="lang-csharp hljs">public Rune RightTee;</code></pre>
  242. </div>
  243. <h5 class="fieldValue">Field Value</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><span class="xref">System.Rune</span></td>
  254. <td><p>To be added.</p>
  255. </td>
  256. </tr>
  257. </tbody>
  258. </table>
  259. <h4 id="Terminal_Gui_ConsoleDriver_Stipple" data-uid="Terminal.Gui.ConsoleDriver.Stipple">Stipple</h4>
  260. <div class="markdown level1 summary"><p>Stipple pattern</p>
  261. </div>
  262. <div class="markdown level1 conceptual"></div>
  263. <h5 class="decalaration">Declaration</h5>
  264. <div class="codewrapper">
  265. <pre><code class="lang-csharp hljs">public Rune Stipple;</code></pre>
  266. </div>
  267. <h5 class="fieldValue">Field Value</h5>
  268. <table class="table table-bordered table-striped table-condensed">
  269. <thead>
  270. <tr>
  271. <th>Type</th>
  272. <th>Description</th>
  273. </tr>
  274. </thead>
  275. <tbody>
  276. <tr>
  277. <td><span class="xref">System.Rune</span></td>
  278. <td><p>To be added.</p>
  279. </td>
  280. </tr>
  281. </tbody>
  282. </table>
  283. <h4 id="Terminal_Gui_ConsoleDriver_TopTee" data-uid="Terminal.Gui.ConsoleDriver.TopTee">TopTee</h4>
  284. <div class="markdown level1 summary"><p>Top tee</p>
  285. </div>
  286. <div class="markdown level1 conceptual"></div>
  287. <h5 class="decalaration">Declaration</h5>
  288. <div class="codewrapper">
  289. <pre><code class="lang-csharp hljs">public Rune TopTee;</code></pre>
  290. </div>
  291. <h5 class="fieldValue">Field Value</h5>
  292. <table class="table table-bordered table-striped table-condensed">
  293. <thead>
  294. <tr>
  295. <th>Type</th>
  296. <th>Description</th>
  297. </tr>
  298. </thead>
  299. <tbody>
  300. <tr>
  301. <td><span class="xref">System.Rune</span></td>
  302. <td><p>To be added.</p>
  303. </td>
  304. </tr>
  305. </tbody>
  306. </table>
  307. <h4 id="Terminal_Gui_ConsoleDriver_ULCorner" data-uid="Terminal.Gui.ConsoleDriver.ULCorner">ULCorner</h4>
  308. <div class="markdown level1 summary"><p>Upper left corner</p>
  309. </div>
  310. <div class="markdown level1 conceptual"></div>
  311. <h5 class="decalaration">Declaration</h5>
  312. <div class="codewrapper">
  313. <pre><code class="lang-csharp hljs">public Rune ULCorner;</code></pre>
  314. </div>
  315. <h5 class="fieldValue">Field Value</h5>
  316. <table class="table table-bordered table-striped table-condensed">
  317. <thead>
  318. <tr>
  319. <th>Type</th>
  320. <th>Description</th>
  321. </tr>
  322. </thead>
  323. <tbody>
  324. <tr>
  325. <td><span class="xref">System.Rune</span></td>
  326. <td><p>To be added.</p>
  327. </td>
  328. </tr>
  329. </tbody>
  330. </table>
  331. <h4 id="Terminal_Gui_ConsoleDriver_URCorner" data-uid="Terminal.Gui.ConsoleDriver.URCorner">URCorner</h4>
  332. <div class="markdown level1 summary"><p>Upper right corner</p>
  333. </div>
  334. <div class="markdown level1 conceptual"></div>
  335. <h5 class="decalaration">Declaration</h5>
  336. <div class="codewrapper">
  337. <pre><code class="lang-csharp hljs">public Rune URCorner;</code></pre>
  338. </div>
  339. <h5 class="fieldValue">Field Value</h5>
  340. <table class="table table-bordered table-striped table-condensed">
  341. <thead>
  342. <tr>
  343. <th>Type</th>
  344. <th>Description</th>
  345. </tr>
  346. </thead>
  347. <tbody>
  348. <tr>
  349. <td><span class="xref">System.Rune</span></td>
  350. <td><p>To be added.</p>
  351. </td>
  352. </tr>
  353. </tbody>
  354. </table>
  355. <h4 id="Terminal_Gui_ConsoleDriver_VLine" data-uid="Terminal.Gui.ConsoleDriver.VLine">VLine</h4>
  356. <div class="markdown level1 summary"><p>Vertical line character.</p>
  357. </div>
  358. <div class="markdown level1 conceptual"></div>
  359. <h5 class="decalaration">Declaration</h5>
  360. <div class="codewrapper">
  361. <pre><code class="lang-csharp hljs">public Rune VLine;</code></pre>
  362. </div>
  363. <h5 class="fieldValue">Field Value</h5>
  364. <table class="table table-bordered table-striped table-condensed">
  365. <thead>
  366. <tr>
  367. <th>Type</th>
  368. <th>Description</th>
  369. </tr>
  370. </thead>
  371. <tbody>
  372. <tr>
  373. <td><span class="xref">System.Rune</span></td>
  374. <td><p>To be added.</p>
  375. </td>
  376. </tr>
  377. </tbody>
  378. </table>
  379. <h3 id="properties">Properties
  380. </h3>
  381. <a id="Terminal_Gui_ConsoleDriver_Clip_" data-uid="Terminal.Gui.ConsoleDriver.Clip*"></a>
  382. <h4 id="Terminal_Gui_ConsoleDriver_Clip" data-uid="Terminal.Gui.ConsoleDriver.Clip">Clip</h4>
  383. <div class="markdown level1 summary"><p>Controls the current clipping region that AddRune/AddStr is subject to.</p>
  384. </div>
  385. <div class="markdown level1 conceptual"></div>
  386. <h5 class="decalaration">Declaration</h5>
  387. <div class="codewrapper">
  388. <pre><code class="lang-csharp hljs">public Terminal.Gui.Rect Clip { get; set; }</code></pre>
  389. </div>
  390. <h5 class="propertyValue">Property Value</h5>
  391. <table class="table table-bordered table-striped table-condensed">
  392. <thead>
  393. <tr>
  394. <th>Type</th>
  395. <th>Description</th>
  396. </tr>
  397. </thead>
  398. <tbody>
  399. <tr>
  400. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  401. <td><p>The clip.</p>
  402. </td>
  403. </tr>
  404. </tbody>
  405. </table>
  406. <a id="Terminal_Gui_ConsoleDriver_Cols_" data-uid="Terminal.Gui.ConsoleDriver.Cols*"></a>
  407. <h4 id="Terminal_Gui_ConsoleDriver_Cols" data-uid="Terminal.Gui.ConsoleDriver.Cols">Cols</h4>
  408. <div class="markdown level1 summary"><p>The current number of columns in the terminal.</p>
  409. </div>
  410. <div class="markdown level1 conceptual"></div>
  411. <h5 class="decalaration">Declaration</h5>
  412. <div class="codewrapper">
  413. <pre><code class="lang-csharp hljs">public abstract int Cols { get; }</code></pre>
  414. </div>
  415. <h5 class="propertyValue">Property Value</h5>
  416. <table class="table table-bordered table-striped table-condensed">
  417. <thead>
  418. <tr>
  419. <th>Type</th>
  420. <th>Description</th>
  421. </tr>
  422. </thead>
  423. <tbody>
  424. <tr>
  425. <td><span class="xref">System.Int32</span></td>
  426. <td><p>To be added.</p>
  427. </td>
  428. </tr>
  429. </tbody>
  430. </table>
  431. <a id="Terminal_Gui_ConsoleDriver_Rows_" data-uid="Terminal.Gui.ConsoleDriver.Rows*"></a>
  432. <h4 id="Terminal_Gui_ConsoleDriver_Rows" data-uid="Terminal.Gui.ConsoleDriver.Rows">Rows</h4>
  433. <div class="markdown level1 summary"><p>The current number of rows in the terminal.</p>
  434. </div>
  435. <div class="markdown level1 conceptual"></div>
  436. <h5 class="decalaration">Declaration</h5>
  437. <div class="codewrapper">
  438. <pre><code class="lang-csharp hljs">public abstract int Rows { get; }</code></pre>
  439. </div>
  440. <h5 class="propertyValue">Property Value</h5>
  441. <table class="table table-bordered table-striped table-condensed">
  442. <thead>
  443. <tr>
  444. <th>Type</th>
  445. <th>Description</th>
  446. </tr>
  447. </thead>
  448. <tbody>
  449. <tr>
  450. <td><span class="xref">System.Int32</span></td>
  451. <td><p>To be added.</p>
  452. </td>
  453. </tr>
  454. </tbody>
  455. </table>
  456. <h3 id="methods">Methods
  457. </h3>
  458. <a id="Terminal_Gui_ConsoleDriver_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
  459. <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
  460. <div class="markdown level1 summary"><p>Adds the specified rune to the display at the current cursor position</p>
  461. </div>
  462. <div class="markdown level1 conceptual"></div>
  463. <h5 class="decalaration">Declaration</h5>
  464. <div class="codewrapper">
  465. <pre><code class="lang-csharp hljs">public abstract void AddRune (Rune rune);</code></pre>
  466. </div>
  467. <h5 class="parameters">Parameters</h5>
  468. <table class="table table-bordered table-striped table-condensed">
  469. <thead>
  470. <tr>
  471. <th>Type</th>
  472. <th>Name</th>
  473. <th>Description</th>
  474. </tr>
  475. </thead>
  476. <tbody>
  477. <tr>
  478. <td><span class="xref">System.Rune</span></td>
  479. <td><span class="parametername">rune</span></td>
  480. <td><p>Rune to add.</p>
  481. </td>
  482. </tr>
  483. </tbody>
  484. </table>
  485. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  486. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
  487. <div class="markdown level1 summary"><p>Adds the specified</p>
  488. </div>
  489. <div class="markdown level1 conceptual"></div>
  490. <h5 class="decalaration">Declaration</h5>
  491. <div class="codewrapper">
  492. <pre><code class="lang-csharp hljs">public abstract void AddStr (NStack.ustring str);</code></pre>
  493. </div>
  494. <h5 class="parameters">Parameters</h5>
  495. <table class="table table-bordered table-striped table-condensed">
  496. <thead>
  497. <tr>
  498. <th>Type</th>
  499. <th>Name</th>
  500. <th>Description</th>
  501. </tr>
  502. </thead>
  503. <tbody>
  504. <tr>
  505. <td><span class="xref">NStack.ustring</span></td>
  506. <td><span class="parametername">str</span></td>
  507. <td><p>String.</p>
  508. </td>
  509. </tr>
  510. </tbody>
  511. </table>
  512. <a id="Terminal_Gui_ConsoleDriver_CookMouse_" data-uid="Terminal.Gui.ConsoleDriver.CookMouse*"></a>
  513. <h4 id="Terminal_Gui_ConsoleDriver_CookMouse" data-uid="Terminal.Gui.ConsoleDriver.CookMouse">CookMouse()</h4>
  514. <div class="markdown level1 summary"><p>Enables the cooked event processing from the mouse driver</p>
  515. </div>
  516. <div class="markdown level1 conceptual"></div>
  517. <h5 class="decalaration">Declaration</h5>
  518. <div class="codewrapper">
  519. <pre><code class="lang-csharp hljs">public abstract void CookMouse ();</code></pre>
  520. </div>
  521. <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
  522. <h4 id="Terminal_Gui_ConsoleDriver_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)">DrawFrame(Rect, Int32, Boolean)</h4>
  523. <div class="markdown level1 summary"><p>Draws a frame on the specified region with the specified padding around the frame.</p>
  524. </div>
  525. <div class="markdown level1 conceptual"></div>
  526. <h5 class="decalaration">Declaration</h5>
  527. <div class="codewrapper">
  528. <pre><code class="lang-csharp hljs">public virtual void DrawFrame (Terminal.Gui.Rect region, int padding, bool fill);</code></pre>
  529. </div>
  530. <h5 class="parameters">Parameters</h5>
  531. <table class="table table-bordered table-striped table-condensed">
  532. <thead>
  533. <tr>
  534. <th>Type</th>
  535. <th>Name</th>
  536. <th>Description</th>
  537. </tr>
  538. </thead>
  539. <tbody>
  540. <tr>
  541. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  542. <td><span class="parametername">region</span></td>
  543. <td><p>Region where the frame will be drawn..</p>
  544. </td>
  545. </tr>
  546. <tr>
  547. <td><span class="xref">System.Int32</span></td>
  548. <td><span class="parametername">padding</span></td>
  549. <td><p>Padding to add on the sides.</p>
  550. </td>
  551. </tr>
  552. <tr>
  553. <td><span class="xref">System.Boolean</span></td>
  554. <td><span class="parametername">fill</span></td>
  555. <td><p>If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.</p>
  556. </td>
  557. </tr>
  558. </tbody>
  559. </table>
  560. <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
  561. <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
  562. <div class="markdown level1 summary"><p>Ends the execution of the console driver.</p>
  563. </div>
  564. <div class="markdown level1 conceptual"></div>
  565. <h5 class="decalaration">Declaration</h5>
  566. <div class="codewrapper">
  567. <pre><code class="lang-csharp hljs">public abstract void End ();</code></pre>
  568. </div>
  569. <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
  570. <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
  571. <div class="markdown level1 summary"><p>Initializes the driver</p>
  572. </div>
  573. <div class="markdown level1 conceptual"></div>
  574. <h5 class="decalaration">Declaration</h5>
  575. <div class="codewrapper">
  576. <pre><code class="lang-csharp hljs">public abstract void Init (Action terminalResized);</code></pre>
  577. </div>
  578. <h5 class="parameters">Parameters</h5>
  579. <table class="table table-bordered table-striped table-condensed">
  580. <thead>
  581. <tr>
  582. <th>Type</th>
  583. <th>Name</th>
  584. <th>Description</th>
  585. </tr>
  586. </thead>
  587. <tbody>
  588. <tr>
  589. <td><span class="xref">System.Action</span></td>
  590. <td><span class="parametername">terminalResized</span></td>
  591. <td><p>Method to invoke when the terminal is resized.</p>
  592. </td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
  597. <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  598. <div class="markdown level1 summary"><p>Moves the cursor to the specified column and row.</p>
  599. </div>
  600. <div class="markdown level1 conceptual"></div>
  601. <h5 class="decalaration">Declaration</h5>
  602. <div class="codewrapper">
  603. <pre><code class="lang-csharp hljs">public abstract void Move (int col, int row);</code></pre>
  604. </div>
  605. <h5 class="parameters">Parameters</h5>
  606. <table class="table table-bordered table-striped table-condensed">
  607. <thead>
  608. <tr>
  609. <th>Type</th>
  610. <th>Name</th>
  611. <th>Description</th>
  612. </tr>
  613. </thead>
  614. <tbody>
  615. <tr>
  616. <td><span class="xref">System.Int32</span></td>
  617. <td><span class="parametername">col</span></td>
  618. <td><p>Column to move the cursor to.</p>
  619. </td>
  620. </tr>
  621. <tr>
  622. <td><span class="xref">System.Int32</span></td>
  623. <td><span class="parametername">row</span></td>
  624. <td><p>Row to move the cursor to.</p>
  625. </td>
  626. </tr>
  627. </tbody>
  628. </table>
  629. <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
  630. <h4 id="Terminal_Gui_ConsoleDriver_PrepareToRun_Mono_Terminal_MainLoop_System_Action_Terminal_Gui_KeyEvent__System_Action_Terminal_Gui_MouseEvent__" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun(Mono.Terminal.MainLoop,System.Action{Terminal.Gui.KeyEvent},System.Action{Terminal.Gui.MouseEvent})">PrepareToRun(MainLoop, Action&lt;KeyEvent&gt;, Action&lt;MouseEvent&gt;)</h4>
  631. <div class="markdown level1 summary"></div>
  632. <div class="markdown level1 conceptual"></div>
  633. <h5 class="decalaration">Declaration</h5>
  634. <div class="codewrapper">
  635. <pre><code class="lang-csharp hljs">public abstract void PrepareToRun (Mono.Terminal.MainLoop mainLoop, Action&lt;Terminal.Gui.KeyEvent&gt; keyHandler, Action&lt;Terminal.Gui.MouseEvent&gt; mouseHandler);</code></pre>
  636. </div>
  637. <h5 class="parameters">Parameters</h5>
  638. <table class="table table-bordered table-striped table-condensed">
  639. <thead>
  640. <tr>
  641. <th>Type</th>
  642. <th>Name</th>
  643. <th>Description</th>
  644. </tr>
  645. </thead>
  646. <tbody>
  647. <tr>
  648. <td><a class="xref" href="../Mono.Terminal/Mono.Terminal.MainLoop.html">MainLoop</a></td>
  649. <td><span class="parametername">mainLoop</span></td>
  650. <td><p>To be added.</p>
  651. </td>
  652. </tr>
  653. <tr>
  654. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  655. <td><span class="parametername">keyHandler</span></td>
  656. <td><p>To be added.</p>
  657. </td>
  658. </tr>
  659. <tr>
  660. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>&gt;</td>
  661. <td><span class="parametername">mouseHandler</span></td>
  662. <td><p>To be added.</p>
  663. </td>
  664. </tr>
  665. </tbody>
  666. </table>
  667. <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
  668. <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
  669. <div class="markdown level1 summary"><p>Updates the screen to reflect all the changes that have been done to the display buffer</p>
  670. </div>
  671. <div class="markdown level1 conceptual"></div>
  672. <h5 class="decalaration">Declaration</h5>
  673. <div class="codewrapper">
  674. <pre><code class="lang-csharp hljs">public abstract void Refresh ();</code></pre>
  675. </div>
  676. <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
  677. <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
  678. <div class="markdown level1 summary"><p>Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.</p>
  679. </div>
  680. <div class="markdown level1 conceptual"></div>
  681. <h5 class="decalaration">Declaration</h5>
  682. <div class="codewrapper">
  683. <pre><code class="lang-csharp hljs">public abstract void SetAttribute (Terminal.Gui.Attribute c);</code></pre>
  684. </div>
  685. <h5 class="parameters">Parameters</h5>
  686. <table class="table table-bordered table-striped table-condensed">
  687. <thead>
  688. <tr>
  689. <th>Type</th>
  690. <th>Name</th>
  691. <th>Description</th>
  692. </tr>
  693. </thead>
  694. <tbody>
  695. <tr>
  696. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  697. <td><span class="parametername">c</span></td>
  698. <td><p>C.</p>
  699. </td>
  700. </tr>
  701. </tbody>
  702. </table>
  703. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  704. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</h4>
  705. <div class="markdown level1 summary"></div>
  706. <div class="markdown level1 conceptual"></div>
  707. <h5 class="decalaration">Declaration</h5>
  708. <div class="codewrapper">
  709. <pre><code class="lang-csharp hljs">public abstract void SetColors (ConsoleColor foreground, ConsoleColor background);</code></pre>
  710. </div>
  711. <h5 class="parameters">Parameters</h5>
  712. <table class="table table-bordered table-striped table-condensed">
  713. <thead>
  714. <tr>
  715. <th>Type</th>
  716. <th>Name</th>
  717. <th>Description</th>
  718. </tr>
  719. </thead>
  720. <tbody>
  721. <tr>
  722. <td><span class="xref">System.ConsoleColor</span></td>
  723. <td><span class="parametername">foreground</span></td>
  724. <td><p>To be added.</p>
  725. </td>
  726. </tr>
  727. <tr>
  728. <td><span class="xref">System.ConsoleColor</span></td>
  729. <td><span class="parametername">background</span></td>
  730. <td><p>To be added.</p>
  731. </td>
  732. </tr>
  733. </tbody>
  734. </table>
  735. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  736. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
  737. <div class="markdown level1 summary"><p>Advanced uses - set colors to any pre-set pairs, you would need to init_color
  738. that independently with the R, G, B values.</p>
  739. </div>
  740. <div class="markdown level1 conceptual"></div>
  741. <h5 class="decalaration">Declaration</h5>
  742. <div class="codewrapper">
  743. <pre><code class="lang-csharp hljs">public abstract void SetColors (short foregroundColorId, short backgroundColorId);</code></pre>
  744. </div>
  745. <h5 class="parameters">Parameters</h5>
  746. <table class="table table-bordered table-striped table-condensed">
  747. <thead>
  748. <tr>
  749. <th>Type</th>
  750. <th>Name</th>
  751. <th>Description</th>
  752. </tr>
  753. </thead>
  754. <tbody>
  755. <tr>
  756. <td><span class="xref">System.Int16</span></td>
  757. <td><span class="parametername">foregroundColorId</span></td>
  758. <td><p>Foreground color identifier.</p>
  759. </td>
  760. </tr>
  761. <tr>
  762. <td><span class="xref">System.Int16</span></td>
  763. <td><span class="parametername">backgroundColorId</span></td>
  764. <td><p>Background color identifier.</p>
  765. </td>
  766. </tr>
  767. </tbody>
  768. </table>
  769. <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
  770. <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</h4>
  771. <div class="markdown level1 summary"></div>
  772. <div class="markdown level1 conceptual"></div>
  773. <h5 class="decalaration">Declaration</h5>
  774. <div class="codewrapper">
  775. <pre><code class="lang-csharp hljs">public abstract void StartReportingMouseMoves ();</code></pre>
  776. </div>
  777. <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
  778. <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</h4>
  779. <div class="markdown level1 summary"></div>
  780. <div class="markdown level1 conceptual"></div>
  781. <h5 class="decalaration">Declaration</h5>
  782. <div class="codewrapper">
  783. <pre><code class="lang-csharp hljs">public abstract void StopReportingMouseMoves ();</code></pre>
  784. </div>
  785. <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
  786. <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
  787. <div class="markdown level1 summary"><p>Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.</p>
  788. </div>
  789. <div class="markdown level1 conceptual"></div>
  790. <h5 class="decalaration">Declaration</h5>
  791. <div class="codewrapper">
  792. <pre><code class="lang-csharp hljs">public abstract void Suspend ();</code></pre>
  793. </div>
  794. <a id="Terminal_Gui_ConsoleDriver_UncookMouse_" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse*"></a>
  795. <h4 id="Terminal_Gui_ConsoleDriver_UncookMouse" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse">UncookMouse()</h4>
  796. <div class="markdown level1 summary"><p>Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked.</p>
  797. </div>
  798. <div class="markdown level1 conceptual"></div>
  799. <h5 class="decalaration">Declaration</h5>
  800. <div class="codewrapper">
  801. <pre><code class="lang-csharp hljs">public abstract void UncookMouse ();</code></pre>
  802. </div>
  803. <a id="Terminal_Gui_ConsoleDriver_UpdateCursor_" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor*"></a>
  804. <h4 id="Terminal_Gui_ConsoleDriver_UpdateCursor" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor">UpdateCursor()</h4>
  805. <div class="markdown level1 summary"><p>Updates the location of the cursor position</p>
  806. </div>
  807. <div class="markdown level1 conceptual"></div>
  808. <h5 class="decalaration">Declaration</h5>
  809. <div class="codewrapper">
  810. <pre><code class="lang-csharp hljs">public abstract void UpdateCursor ();</code></pre>
  811. </div>
  812. <a id="Terminal_Gui_ConsoleDriver_UpdateScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen*"></a>
  813. <h4 id="Terminal_Gui_ConsoleDriver_UpdateScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen">UpdateScreen()</h4>
  814. <div class="markdown level1 summary"><p>Redraws the physical screen with the contents that have been queued up via any of the printing commands.</p>
  815. </div>
  816. <div class="markdown level1 conceptual"></div>
  817. <h5 class="decalaration">Declaration</h5>
  818. <div class="codewrapper">
  819. <pre><code class="lang-csharp hljs">public abstract void UpdateScreen ();</code></pre>
  820. </div>
  821. </article>
  822. </div>
  823. <div class="hidden-sm col-md-2" role="complementary">
  824. <div class="sideaffix">
  825. <div class="contribution">
  826. <ul class="nav">
  827. </ul>
  828. </div>
  829. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  830. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  831. </nav>
  832. </div>
  833. </div>
  834. </div>
  835. </div>
  836. <footer>
  837. <div class="grad-bottom"></div>
  838. <div class="footer">
  839. <div class="container">
  840. <span class="pull-right">
  841. <a href="#top">Back to top</a>
  842. </span>
  843. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  844. </div>
  845. </div>
  846. </footer>
  847. </div>
  848. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  849. <script type="text/javascript" src="../../styles/docfx.js"></script>
  850. <script type="text/javascript" src="../../styles/main.js"></script>
  851. </body>
  852. </html>