Terminal.Gui.ConsoleDriver.html 36 KB

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