Terminal.Gui.ConsoleDriver.html 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031
  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_AddCh_" data-uid="Terminal.Gui.ConsoleDriver.AddCh*"></a>
  459. <h4 id="Terminal_Gui_ConsoleDriver_AddCh_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.AddCh(System.Int32)">AddCh(Int32)</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 AddCh (int 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.Int32</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_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
  486. <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
  487. <div class="markdown level1 summary"><p>Adds the specified rune to the display at the current cursor position</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 AddRune (Rune rune);</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">System.Rune</span></td>
  506. <td><span class="parametername">rune</span></td>
  507. <td><p>Rune to add.</p>
  508. </td>
  509. </tr>
  510. </tbody>
  511. </table>
  512. <a id="Terminal_Gui_ConsoleDriver_AddSpecial_" data-uid="Terminal.Gui.ConsoleDriver.AddSpecial*"></a>
  513. <h4 id="Terminal_Gui_ConsoleDriver_AddSpecial_Terminal_Gui_SpecialChar_" data-uid="Terminal.Gui.ConsoleDriver.AddSpecial(Terminal.Gui.SpecialChar)">AddSpecial(SpecialChar)</h4>
  514. <div class="markdown level1 summary"><p>Draws a special characters in the screen</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 AddSpecial (Terminal.Gui.SpecialChar ch);</code></pre>
  520. </div>
  521. <h5 class="parameters">Parameters</h5>
  522. <table class="table table-bordered table-striped table-condensed">
  523. <thead>
  524. <tr>
  525. <th>Type</th>
  526. <th>Name</th>
  527. <th>Description</th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr>
  532. <td><a class="xref" href="Terminal.Gui.SpecialChar.html">SpecialChar</a></td>
  533. <td><span class="parametername">ch</span></td>
  534. <td><p>Ch.</p>
  535. </td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  540. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
  541. <div class="markdown level1 summary"><p>Adds the specified</p>
  542. </div>
  543. <div class="markdown level1 conceptual"></div>
  544. <h5 class="decalaration">Declaration</h5>
  545. <div class="codewrapper">
  546. <pre><code class="lang-csharp hljs">public abstract void AddStr (NStack.ustring str);</code></pre>
  547. </div>
  548. <h5 class="parameters">Parameters</h5>
  549. <table class="table table-bordered table-striped table-condensed">
  550. <thead>
  551. <tr>
  552. <th>Type</th>
  553. <th>Name</th>
  554. <th>Description</th>
  555. </tr>
  556. </thead>
  557. <tbody>
  558. <tr>
  559. <td><span class="xref">NStack.ustring</span></td>
  560. <td><span class="parametername">str</span></td>
  561. <td><p>String.</p>
  562. </td>
  563. </tr>
  564. </tbody>
  565. </table>
  566. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  567. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_System_String_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(System.String)">AddStr(String)</h4>
  568. <div class="markdown level1 summary"><p>Adds the specified</p>
  569. </div>
  570. <div class="markdown level1 conceptual"></div>
  571. <h5 class="decalaration">Declaration</h5>
  572. <div class="codewrapper">
  573. <pre><code class="lang-csharp hljs">public abstract void AddStr (string str);</code></pre>
  574. </div>
  575. <h5 class="parameters">Parameters</h5>
  576. <table class="table table-bordered table-striped table-condensed">
  577. <thead>
  578. <tr>
  579. <th>Type</th>
  580. <th>Name</th>
  581. <th>Description</th>
  582. </tr>
  583. </thead>
  584. <tbody>
  585. <tr>
  586. <td><span class="xref">System.String</span></td>
  587. <td><span class="parametername">str</span></td>
  588. <td><p>String.</p>
  589. </td>
  590. </tr>
  591. </tbody>
  592. </table>
  593. <a id="Terminal_Gui_ConsoleDriver_CookMouse_" data-uid="Terminal.Gui.ConsoleDriver.CookMouse*"></a>
  594. <h4 id="Terminal_Gui_ConsoleDriver_CookMouse" data-uid="Terminal.Gui.ConsoleDriver.CookMouse">CookMouse()</h4>
  595. <div class="markdown level1 summary"><p>Enables the cooked event processing from the mouse driver</p>
  596. </div>
  597. <div class="markdown level1 conceptual"></div>
  598. <h5 class="decalaration">Declaration</h5>
  599. <div class="codewrapper">
  600. <pre><code class="lang-csharp hljs">public abstract void CookMouse ();</code></pre>
  601. </div>
  602. <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
  603. <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>
  604. <div class="markdown level1 summary"><p>Draws a frame on the specified region with the specified padding around the frame.</p>
  605. </div>
  606. <div class="markdown level1 conceptual"></div>
  607. <h5 class="decalaration">Declaration</h5>
  608. <div class="codewrapper">
  609. <pre><code class="lang-csharp hljs">public virtual void DrawFrame (Terminal.Gui.Rect region, int padding, bool fill);</code></pre>
  610. </div>
  611. <h5 class="parameters">Parameters</h5>
  612. <table class="table table-bordered table-striped table-condensed">
  613. <thead>
  614. <tr>
  615. <th>Type</th>
  616. <th>Name</th>
  617. <th>Description</th>
  618. </tr>
  619. </thead>
  620. <tbody>
  621. <tr>
  622. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  623. <td><span class="parametername">region</span></td>
  624. <td><p>Region where the frame will be drawn..</p>
  625. </td>
  626. </tr>
  627. <tr>
  628. <td><span class="xref">System.Int32</span></td>
  629. <td><span class="parametername">padding</span></td>
  630. <td><p>Padding to add on the sides.</p>
  631. </td>
  632. </tr>
  633. <tr>
  634. <td><span class="xref">System.Boolean</span></td>
  635. <td><span class="parametername">fill</span></td>
  636. <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>
  637. </td>
  638. </tr>
  639. </tbody>
  640. </table>
  641. <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
  642. <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
  643. <div class="markdown level1 summary"><p>Ends the execution of the console driver.</p>
  644. </div>
  645. <div class="markdown level1 conceptual"></div>
  646. <h5 class="decalaration">Declaration</h5>
  647. <div class="codewrapper">
  648. <pre><code class="lang-csharp hljs">public abstract void End ();</code></pre>
  649. </div>
  650. <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
  651. <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
  652. <div class="markdown level1 summary"><p>Initializes the driver</p>
  653. </div>
  654. <div class="markdown level1 conceptual"></div>
  655. <h5 class="decalaration">Declaration</h5>
  656. <div class="codewrapper">
  657. <pre><code class="lang-csharp hljs">public abstract void Init (Action terminalResized);</code></pre>
  658. </div>
  659. <h5 class="parameters">Parameters</h5>
  660. <table class="table table-bordered table-striped table-condensed">
  661. <thead>
  662. <tr>
  663. <th>Type</th>
  664. <th>Name</th>
  665. <th>Description</th>
  666. </tr>
  667. </thead>
  668. <tbody>
  669. <tr>
  670. <td><span class="xref">System.Action</span></td>
  671. <td><span class="parametername">terminalResized</span></td>
  672. <td><p>Method to invoke when the terminal is resized.</p>
  673. </td>
  674. </tr>
  675. </tbody>
  676. </table>
  677. <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
  678. <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  679. <div class="markdown level1 summary"><p>Moves the cursor to the specified column and row.</p>
  680. </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 Move (int col, int row);</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><span class="xref">System.Int32</span></td>
  698. <td><span class="parametername">col</span></td>
  699. <td><p>Column to move the cursor to.</p>
  700. </td>
  701. </tr>
  702. <tr>
  703. <td><span class="xref">System.Int32</span></td>
  704. <td><span class="parametername">row</span></td>
  705. <td><p>Row to move the cursor to.</p>
  706. </td>
  707. </tr>
  708. </tbody>
  709. </table>
  710. <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
  711. <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>
  712. <div class="markdown level1 summary"></div>
  713. <div class="markdown level1 conceptual"></div>
  714. <h5 class="decalaration">Declaration</h5>
  715. <div class="codewrapper">
  716. <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>
  717. </div>
  718. <h5 class="parameters">Parameters</h5>
  719. <table class="table table-bordered table-striped table-condensed">
  720. <thead>
  721. <tr>
  722. <th>Type</th>
  723. <th>Name</th>
  724. <th>Description</th>
  725. </tr>
  726. </thead>
  727. <tbody>
  728. <tr>
  729. <td><a class="xref" href="../Mono.Terminal/Mono.Terminal.MainLoop.html">MainLoop</a></td>
  730. <td><span class="parametername">mainLoop</span></td>
  731. <td><p>To be added.</p>
  732. </td>
  733. </tr>
  734. <tr>
  735. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  736. <td><span class="parametername">target</span></td>
  737. <td><p>To be added.</p>
  738. </td>
  739. </tr>
  740. <tr>
  741. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>&gt;</td>
  742. <td><span class="parametername">mouse</span></td>
  743. <td><p>To be added.</p>
  744. </td>
  745. </tr>
  746. </tbody>
  747. </table>
  748. <a id="Terminal_Gui_ConsoleDriver_RedrawTop_" data-uid="Terminal.Gui.ConsoleDriver.RedrawTop*"></a>
  749. <h4 id="Terminal_Gui_ConsoleDriver_RedrawTop" data-uid="Terminal.Gui.ConsoleDriver.RedrawTop">RedrawTop()</h4>
  750. <div class="markdown level1 summary"></div>
  751. <div class="markdown level1 conceptual"></div>
  752. <h5 class="decalaration">Declaration</h5>
  753. <div class="codewrapper">
  754. <pre><code class="lang-csharp hljs">public abstract void RedrawTop ();</code></pre>
  755. </div>
  756. <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
  757. <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
  758. <div class="markdown level1 summary"><p>Updates the screen to reflect all the changes that have been done to the display buffer</p>
  759. </div>
  760. <div class="markdown level1 conceptual"></div>
  761. <h5 class="decalaration">Declaration</h5>
  762. <div class="codewrapper">
  763. <pre><code class="lang-csharp hljs">public abstract void Refresh ();</code></pre>
  764. </div>
  765. <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
  766. <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
  767. <div class="markdown level1 summary"><p>Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.</p>
  768. </div>
  769. <div class="markdown level1 conceptual"></div>
  770. <h5 class="decalaration">Declaration</h5>
  771. <div class="codewrapper">
  772. <pre><code class="lang-csharp hljs">public abstract void SetAttribute (Terminal.Gui.Attribute c);</code></pre>
  773. </div>
  774. <h5 class="parameters">Parameters</h5>
  775. <table class="table table-bordered table-striped table-condensed">
  776. <thead>
  777. <tr>
  778. <th>Type</th>
  779. <th>Name</th>
  780. <th>Description</th>
  781. </tr>
  782. </thead>
  783. <tbody>
  784. <tr>
  785. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  786. <td><span class="parametername">c</span></td>
  787. <td><p>C.</p>
  788. </td>
  789. </tr>
  790. </tbody>
  791. </table>
  792. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  793. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</h4>
  794. <div class="markdown level1 summary"></div>
  795. <div class="markdown level1 conceptual"></div>
  796. <h5 class="decalaration">Declaration</h5>
  797. <div class="codewrapper">
  798. <pre><code class="lang-csharp hljs">public abstract void SetColors (ConsoleColor foreground, ConsoleColor background);</code></pre>
  799. </div>
  800. <h5 class="parameters">Parameters</h5>
  801. <table class="table table-bordered table-striped table-condensed">
  802. <thead>
  803. <tr>
  804. <th>Type</th>
  805. <th>Name</th>
  806. <th>Description</th>
  807. </tr>
  808. </thead>
  809. <tbody>
  810. <tr>
  811. <td><span class="xref">System.ConsoleColor</span></td>
  812. <td><span class="parametername">foreground</span></td>
  813. <td><p>To be added.</p>
  814. </td>
  815. </tr>
  816. <tr>
  817. <td><span class="xref">System.ConsoleColor</span></td>
  818. <td><span class="parametername">background</span></td>
  819. <td><p>To be added.</p>
  820. </td>
  821. </tr>
  822. </tbody>
  823. </table>
  824. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  825. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
  826. <div class="markdown level1 summary"><p>Advanced uses - set colors to any pre-set pairs, you would need to init_color
  827. that independently with the R, G, B values.</p>
  828. </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 SetColors (short foregroundColorId, short backgroundColorId);</code></pre>
  833. </div>
  834. <h5 class="parameters">Parameters</h5>
  835. <table class="table table-bordered table-striped table-condensed">
  836. <thead>
  837. <tr>
  838. <th>Type</th>
  839. <th>Name</th>
  840. <th>Description</th>
  841. </tr>
  842. </thead>
  843. <tbody>
  844. <tr>
  845. <td><span class="xref">System.Int16</span></td>
  846. <td><span class="parametername">foregroundColorId</span></td>
  847. <td><p>Foreground color identifier.</p>
  848. </td>
  849. </tr>
  850. <tr>
  851. <td><span class="xref">System.Int16</span></td>
  852. <td><span class="parametername">backgroundColorId</span></td>
  853. <td><p>Background color identifier.</p>
  854. </td>
  855. </tr>
  856. </tbody>
  857. </table>
  858. <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
  859. <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</h4>
  860. <div class="markdown level1 summary"></div>
  861. <div class="markdown level1 conceptual"></div>
  862. <h5 class="decalaration">Declaration</h5>
  863. <div class="codewrapper">
  864. <pre><code class="lang-csharp hljs">public abstract void StartReportingMouseMoves ();</code></pre>
  865. </div>
  866. <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
  867. <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</h4>
  868. <div class="markdown level1 summary"></div>
  869. <div class="markdown level1 conceptual"></div>
  870. <h5 class="decalaration">Declaration</h5>
  871. <div class="codewrapper">
  872. <pre><code class="lang-csharp hljs">public abstract void StopReportingMouseMoves ();</code></pre>
  873. </div>
  874. <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
  875. <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
  876. <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>
  877. </div>
  878. <div class="markdown level1 conceptual"></div>
  879. <h5 class="decalaration">Declaration</h5>
  880. <div class="codewrapper">
  881. <pre><code class="lang-csharp hljs">public abstract void Suspend ();</code></pre>
  882. </div>
  883. <a id="Terminal_Gui_ConsoleDriver_UncookMouse_" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse*"></a>
  884. <h4 id="Terminal_Gui_ConsoleDriver_UncookMouse" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse">UncookMouse()</h4>
  885. <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>
  886. </div>
  887. <div class="markdown level1 conceptual"></div>
  888. <h5 class="decalaration">Declaration</h5>
  889. <div class="codewrapper">
  890. <pre><code class="lang-csharp hljs">public abstract void UncookMouse ();</code></pre>
  891. </div>
  892. <a id="Terminal_Gui_ConsoleDriver_UpdateCursor_" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor*"></a>
  893. <h4 id="Terminal_Gui_ConsoleDriver_UpdateCursor" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor">UpdateCursor()</h4>
  894. <div class="markdown level1 summary"><p>Updates the location of the cursor position</p>
  895. </div>
  896. <div class="markdown level1 conceptual"></div>
  897. <h5 class="decalaration">Declaration</h5>
  898. <div class="codewrapper">
  899. <pre><code class="lang-csharp hljs">public abstract void UpdateCursor ();</code></pre>
  900. </div>
  901. <a id="Terminal_Gui_ConsoleDriver_UpdateScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen*"></a>
  902. <h4 id="Terminal_Gui_ConsoleDriver_UpdateScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen">UpdateScreen()</h4>
  903. <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>
  904. </div>
  905. <div class="markdown level1 conceptual"></div>
  906. <h5 class="decalaration">Declaration</h5>
  907. <div class="codewrapper">
  908. <pre><code class="lang-csharp hljs">public abstract void UpdateScreen ();</code></pre>
  909. </div>
  910. </article>
  911. </div>
  912. <div class="hidden-sm col-md-2" role="complementary">
  913. <div class="sideaffix">
  914. <div class="contribution">
  915. <ul class="nav">
  916. </ul>
  917. </div>
  918. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  919. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  920. </nav>
  921. </div>
  922. </div>
  923. </div>
  924. </div>
  925. <footer>
  926. <div class="grad-bottom"></div>
  927. <div class="footer">
  928. <div class="container">
  929. <span class="pull-right">
  930. <a href="#top">Back to top</a>
  931. </span>
  932. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  933. </div>
  934. </div>
  935. </footer>
  936. </div>
  937. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  938. <script type="text/javascript" src="../../styles/docfx.js"></script>
  939. <script type="text/javascript" src="../../styles/main.js"></script>
  940. </body>
  941. </html>