Terminal.Gui.ConsoleDriver.html 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234
  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.59.3.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. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.ConsoleDriver">
  74. <h1 id="Terminal_Gui_ConsoleDriver" data-uid="Terminal.Gui.ConsoleDriver" class="text-break">Class ConsoleDriver
  75. </h1>
  76. <div class="markdown level0 summary">
  77. ConsoleDriver is an abstract class that defines the requirements for a console driver.
  78. There are currently three implementations: <span class="xref">Terminal.Gui.CursesDriver</span> (for Unix and Mac), <span class="xref">Terminal.Gui.WindowsDriver</span>, and <span class="xref">Terminal.Gui.NetDriver</span> that uses the .NET Console API.
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">ConsoleDriver</span></div>
  85. <div class="level2"><a class="xref" href="Terminal.Gui.FakeDriver.html">FakeDriver</a></div>
  86. </div>
  87. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  88. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  89. <h5 id="Terminal_Gui_ConsoleDriver_syntax">Syntax</h5>
  90. <div class="codewrapper">
  91. <pre><code class="lang-csharp hljs">public abstract class ConsoleDriver : Object</code></pre>
  92. </div>
  93. <h3 id="constructors">Constructors
  94. </h3>
  95. <a id="Terminal_Gui_ConsoleDriver__ctor_" data-uid="Terminal.Gui.ConsoleDriver.#ctor*"></a>
  96. <h4 id="Terminal_Gui_ConsoleDriver__ctor" data-uid="Terminal.Gui.ConsoleDriver.#ctor">ConsoleDriver()</h4>
  97. <div class="markdown level1 summary"></div>
  98. <div class="markdown level1 conceptual"></div>
  99. <h5 class="decalaration">Declaration</h5>
  100. <div class="codewrapper">
  101. <pre><code class="lang-csharp hljs">protected ConsoleDriver()</code></pre>
  102. </div>
  103. <h3 id="fields">Fields
  104. </h3>
  105. <h4 id="Terminal_Gui_ConsoleDriver_BlocksMeterSegment" data-uid="Terminal.Gui.ConsoleDriver.BlocksMeterSegment">BlocksMeterSegment</h4>
  106. <div class="markdown level1 summary">
  107. Blocks Segment indicator for meter views (e.g. <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a>.
  108. </div>
  109. <div class="markdown level1 conceptual"></div>
  110. <h5 class="decalaration">Declaration</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public Rune BlocksMeterSegment</code></pre>
  113. </div>
  114. <h5 class="fieldValue">Field Value</h5>
  115. <table class="table table-bordered table-striped table-condensed">
  116. <thead>
  117. <tr>
  118. <th>Type</th>
  119. <th>Description</th>
  120. </tr>
  121. </thead>
  122. <tbody>
  123. <tr>
  124. <td><span class="xref">System.Rune</span></td>
  125. <td></td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. <h4 id="Terminal_Gui_ConsoleDriver_BottomTee" data-uid="Terminal.Gui.ConsoleDriver.BottomTee">BottomTee</h4>
  130. <div class="markdown level1 summary">
  131. The bottom tee.
  132. </div>
  133. <div class="markdown level1 conceptual"></div>
  134. <h5 class="decalaration">Declaration</h5>
  135. <div class="codewrapper">
  136. <pre><code class="lang-csharp hljs">public Rune BottomTee</code></pre>
  137. </div>
  138. <h5 class="fieldValue">Field Value</h5>
  139. <table class="table table-bordered table-striped table-condensed">
  140. <thead>
  141. <tr>
  142. <th>Type</th>
  143. <th>Description</th>
  144. </tr>
  145. </thead>
  146. <tbody>
  147. <tr>
  148. <td><span class="xref">System.Rune</span></td>
  149. <td></td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. <h4 id="Terminal_Gui_ConsoleDriver_Checked" data-uid="Terminal.Gui.ConsoleDriver.Checked">Checked</h4>
  154. <div class="markdown level1 summary">
  155. Checkmark.
  156. </div>
  157. <div class="markdown level1 conceptual"></div>
  158. <h5 class="decalaration">Declaration</h5>
  159. <div class="codewrapper">
  160. <pre><code class="lang-csharp hljs">public Rune Checked</code></pre>
  161. </div>
  162. <h5 class="fieldValue">Field Value</h5>
  163. <table class="table table-bordered table-striped table-condensed">
  164. <thead>
  165. <tr>
  166. <th>Type</th>
  167. <th>Description</th>
  168. </tr>
  169. </thead>
  170. <tbody>
  171. <tr>
  172. <td><span class="xref">System.Rune</span></td>
  173. <td></td>
  174. </tr>
  175. </tbody>
  176. </table>
  177. <h4 id="Terminal_Gui_ConsoleDriver_ContinuousMeterSegment" data-uid="Terminal.Gui.ConsoleDriver.ContinuousMeterSegment">ContinuousMeterSegment</h4>
  178. <div class="markdown level1 summary">
  179. Continuous Segment indicator for meter views (e.g. <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a>.
  180. </div>
  181. <div class="markdown level1 conceptual"></div>
  182. <h5 class="decalaration">Declaration</h5>
  183. <div class="codewrapper">
  184. <pre><code class="lang-csharp hljs">public Rune ContinuousMeterSegment</code></pre>
  185. </div>
  186. <h5 class="fieldValue">Field Value</h5>
  187. <table class="table table-bordered table-striped table-condensed">
  188. <thead>
  189. <tr>
  190. <th>Type</th>
  191. <th>Description</th>
  192. </tr>
  193. </thead>
  194. <tbody>
  195. <tr>
  196. <td><span class="xref">System.Rune</span></td>
  197. <td></td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. <h4 id="Terminal_Gui_ConsoleDriver_Diamond" data-uid="Terminal.Gui.ConsoleDriver.Diamond">Diamond</h4>
  202. <div class="markdown level1 summary">
  203. Diamond character
  204. </div>
  205. <div class="markdown level1 conceptual"></div>
  206. <h5 class="decalaration">Declaration</h5>
  207. <div class="codewrapper">
  208. <pre><code class="lang-csharp hljs">public Rune Diamond</code></pre>
  209. </div>
  210. <h5 class="fieldValue">Field Value</h5>
  211. <table class="table table-bordered table-striped table-condensed">
  212. <thead>
  213. <tr>
  214. <th>Type</th>
  215. <th>Description</th>
  216. </tr>
  217. </thead>
  218. <tbody>
  219. <tr>
  220. <td><span class="xref">System.Rune</span></td>
  221. <td></td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <h4 id="Terminal_Gui_ConsoleDriver_DownArrow" data-uid="Terminal.Gui.ConsoleDriver.DownArrow">DownArrow</h4>
  226. <div class="markdown level1 summary">
  227. Down Arrow.
  228. </div>
  229. <div class="markdown level1 conceptual"></div>
  230. <h5 class="decalaration">Declaration</h5>
  231. <div class="codewrapper">
  232. <pre><code class="lang-csharp hljs">public Rune DownArrow</code></pre>
  233. </div>
  234. <h5 class="fieldValue">Field Value</h5>
  235. <table class="table table-bordered table-striped table-condensed">
  236. <thead>
  237. <tr>
  238. <th>Type</th>
  239. <th>Description</th>
  240. </tr>
  241. </thead>
  242. <tbody>
  243. <tr>
  244. <td><span class="xref">System.Rune</span></td>
  245. <td></td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <h4 id="Terminal_Gui_ConsoleDriver_HDLine" data-uid="Terminal.Gui.ConsoleDriver.HDLine">HDLine</h4>
  250. <div class="markdown level1 summary">
  251. Horizontal double line character.
  252. </div>
  253. <div class="markdown level1 conceptual"></div>
  254. <h5 class="decalaration">Declaration</h5>
  255. <div class="codewrapper">
  256. <pre><code class="lang-csharp hljs">public Rune HDLine</code></pre>
  257. </div>
  258. <h5 class="fieldValue">Field Value</h5>
  259. <table class="table table-bordered table-striped table-condensed">
  260. <thead>
  261. <tr>
  262. <th>Type</th>
  263. <th>Description</th>
  264. </tr>
  265. </thead>
  266. <tbody>
  267. <tr>
  268. <td><span class="xref">System.Rune</span></td>
  269. <td></td>
  270. </tr>
  271. </tbody>
  272. </table>
  273. <h4 id="Terminal_Gui_ConsoleDriver_HLine" data-uid="Terminal.Gui.ConsoleDriver.HLine">HLine</h4>
  274. <div class="markdown level1 summary">
  275. Horizontal line character.
  276. </div>
  277. <div class="markdown level1 conceptual"></div>
  278. <h5 class="decalaration">Declaration</h5>
  279. <div class="codewrapper">
  280. <pre><code class="lang-csharp hljs">public Rune HLine</code></pre>
  281. </div>
  282. <h5 class="fieldValue">Field Value</h5>
  283. <table class="table table-bordered table-striped table-condensed">
  284. <thead>
  285. <tr>
  286. <th>Type</th>
  287. <th>Description</th>
  288. </tr>
  289. </thead>
  290. <tbody>
  291. <tr>
  292. <td><span class="xref">System.Rune</span></td>
  293. <td></td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <h4 id="Terminal_Gui_ConsoleDriver_HRLine" data-uid="Terminal.Gui.ConsoleDriver.HRLine">HRLine</h4>
  298. <div class="markdown level1 summary">
  299. Horizontal line character for rounded corners.
  300. </div>
  301. <div class="markdown level1 conceptual"></div>
  302. <h5 class="decalaration">Declaration</h5>
  303. <div class="codewrapper">
  304. <pre><code class="lang-csharp hljs">public Rune HRLine</code></pre>
  305. </div>
  306. <h5 class="fieldValue">Field Value</h5>
  307. <table class="table table-bordered table-striped table-condensed">
  308. <thead>
  309. <tr>
  310. <th>Type</th>
  311. <th>Description</th>
  312. </tr>
  313. </thead>
  314. <tbody>
  315. <tr>
  316. <td><span class="xref">System.Rune</span></td>
  317. <td></td>
  318. </tr>
  319. </tbody>
  320. </table>
  321. <h4 id="Terminal_Gui_ConsoleDriver_LeftArrow" data-uid="Terminal.Gui.ConsoleDriver.LeftArrow">LeftArrow</h4>
  322. <div class="markdown level1 summary">
  323. Left Arrow.
  324. </div>
  325. <div class="markdown level1 conceptual"></div>
  326. <h5 class="decalaration">Declaration</h5>
  327. <div class="codewrapper">
  328. <pre><code class="lang-csharp hljs">public Rune LeftArrow</code></pre>
  329. </div>
  330. <h5 class="fieldValue">Field Value</h5>
  331. <table class="table table-bordered table-striped table-condensed">
  332. <thead>
  333. <tr>
  334. <th>Type</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><span class="xref">System.Rune</span></td>
  341. <td></td>
  342. </tr>
  343. </tbody>
  344. </table>
  345. <h4 id="Terminal_Gui_ConsoleDriver_LeftBracket" data-uid="Terminal.Gui.ConsoleDriver.LeftBracket">LeftBracket</h4>
  346. <div class="markdown level1 summary">
  347. Left frame/bracket (e.g. &apos;[&apos; for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  348. </div>
  349. <div class="markdown level1 conceptual"></div>
  350. <h5 class="decalaration">Declaration</h5>
  351. <div class="codewrapper">
  352. <pre><code class="lang-csharp hljs">public Rune LeftBracket</code></pre>
  353. </div>
  354. <h5 class="fieldValue">Field Value</h5>
  355. <table class="table table-bordered table-striped table-condensed">
  356. <thead>
  357. <tr>
  358. <th>Type</th>
  359. <th>Description</th>
  360. </tr>
  361. </thead>
  362. <tbody>
  363. <tr>
  364. <td><span class="xref">System.Rune</span></td>
  365. <td></td>
  366. </tr>
  367. </tbody>
  368. </table>
  369. <h4 id="Terminal_Gui_ConsoleDriver_LeftDefaultIndicator" data-uid="Terminal.Gui.ConsoleDriver.LeftDefaultIndicator">LeftDefaultIndicator</h4>
  370. <div class="markdown level1 summary">
  371. Left indicator for default action (e.g. for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  372. </div>
  373. <div class="markdown level1 conceptual"></div>
  374. <h5 class="decalaration">Declaration</h5>
  375. <div class="codewrapper">
  376. <pre><code class="lang-csharp hljs">public Rune LeftDefaultIndicator</code></pre>
  377. </div>
  378. <h5 class="fieldValue">Field Value</h5>
  379. <table class="table table-bordered table-striped table-condensed">
  380. <thead>
  381. <tr>
  382. <th>Type</th>
  383. <th>Description</th>
  384. </tr>
  385. </thead>
  386. <tbody>
  387. <tr>
  388. <td><span class="xref">System.Rune</span></td>
  389. <td></td>
  390. </tr>
  391. </tbody>
  392. </table>
  393. <h4 id="Terminal_Gui_ConsoleDriver_LeftTee" data-uid="Terminal.Gui.ConsoleDriver.LeftTee">LeftTee</h4>
  394. <div class="markdown level1 summary">
  395. Left tee
  396. </div>
  397. <div class="markdown level1 conceptual"></div>
  398. <h5 class="decalaration">Declaration</h5>
  399. <div class="codewrapper">
  400. <pre><code class="lang-csharp hljs">public Rune LeftTee</code></pre>
  401. </div>
  402. <h5 class="fieldValue">Field Value</h5>
  403. <table class="table table-bordered table-striped table-condensed">
  404. <thead>
  405. <tr>
  406. <th>Type</th>
  407. <th>Description</th>
  408. </tr>
  409. </thead>
  410. <tbody>
  411. <tr>
  412. <td><span class="xref">System.Rune</span></td>
  413. <td></td>
  414. </tr>
  415. </tbody>
  416. </table>
  417. <h4 id="Terminal_Gui_ConsoleDriver_LLCorner" data-uid="Terminal.Gui.ConsoleDriver.LLCorner">LLCorner</h4>
  418. <div class="markdown level1 summary">
  419. Lower left corner
  420. </div>
  421. <div class="markdown level1 conceptual"></div>
  422. <h5 class="decalaration">Declaration</h5>
  423. <div class="codewrapper">
  424. <pre><code class="lang-csharp hljs">public Rune LLCorner</code></pre>
  425. </div>
  426. <h5 class="fieldValue">Field Value</h5>
  427. <table class="table table-bordered table-striped table-condensed">
  428. <thead>
  429. <tr>
  430. <th>Type</th>
  431. <th>Description</th>
  432. </tr>
  433. </thead>
  434. <tbody>
  435. <tr>
  436. <td><span class="xref">System.Rune</span></td>
  437. <td></td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. <h4 id="Terminal_Gui_ConsoleDriver_LLDCorner" data-uid="Terminal.Gui.ConsoleDriver.LLDCorner">LLDCorner</h4>
  442. <div class="markdown level1 summary">
  443. Lower left double corner
  444. </div>
  445. <div class="markdown level1 conceptual"></div>
  446. <h5 class="decalaration">Declaration</h5>
  447. <div class="codewrapper">
  448. <pre><code class="lang-csharp hljs">public Rune LLDCorner</code></pre>
  449. </div>
  450. <h5 class="fieldValue">Field Value</h5>
  451. <table class="table table-bordered table-striped table-condensed">
  452. <thead>
  453. <tr>
  454. <th>Type</th>
  455. <th>Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td><span class="xref">System.Rune</span></td>
  461. <td></td>
  462. </tr>
  463. </tbody>
  464. </table>
  465. <h4 id="Terminal_Gui_ConsoleDriver_LLRCorner" data-uid="Terminal.Gui.ConsoleDriver.LLRCorner">LLRCorner</h4>
  466. <div class="markdown level1 summary">
  467. Lower left rounded corner
  468. </div>
  469. <div class="markdown level1 conceptual"></div>
  470. <h5 class="decalaration">Declaration</h5>
  471. <div class="codewrapper">
  472. <pre><code class="lang-csharp hljs">public Rune LLRCorner</code></pre>
  473. </div>
  474. <h5 class="fieldValue">Field Value</h5>
  475. <table class="table table-bordered table-striped table-condensed">
  476. <thead>
  477. <tr>
  478. <th>Type</th>
  479. <th>Description</th>
  480. </tr>
  481. </thead>
  482. <tbody>
  483. <tr>
  484. <td><span class="xref">System.Rune</span></td>
  485. <td></td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <h4 id="Terminal_Gui_ConsoleDriver_LRCorner" data-uid="Terminal.Gui.ConsoleDriver.LRCorner">LRCorner</h4>
  490. <div class="markdown level1 summary">
  491. Lower right corner
  492. </div>
  493. <div class="markdown level1 conceptual"></div>
  494. <h5 class="decalaration">Declaration</h5>
  495. <div class="codewrapper">
  496. <pre><code class="lang-csharp hljs">public Rune LRCorner</code></pre>
  497. </div>
  498. <h5 class="fieldValue">Field Value</h5>
  499. <table class="table table-bordered table-striped table-condensed">
  500. <thead>
  501. <tr>
  502. <th>Type</th>
  503. <th>Description</th>
  504. </tr>
  505. </thead>
  506. <tbody>
  507. <tr>
  508. <td><span class="xref">System.Rune</span></td>
  509. <td></td>
  510. </tr>
  511. </tbody>
  512. </table>
  513. <h4 id="Terminal_Gui_ConsoleDriver_LRDCorner" data-uid="Terminal.Gui.ConsoleDriver.LRDCorner">LRDCorner</h4>
  514. <div class="markdown level1 summary">
  515. Lower right double corner
  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 Rune LRDCorner</code></pre>
  521. </div>
  522. <h5 class="fieldValue">Field Value</h5>
  523. <table class="table table-bordered table-striped table-condensed">
  524. <thead>
  525. <tr>
  526. <th>Type</th>
  527. <th>Description</th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr>
  532. <td><span class="xref">System.Rune</span></td>
  533. <td></td>
  534. </tr>
  535. </tbody>
  536. </table>
  537. <h4 id="Terminal_Gui_ConsoleDriver_LRRCorner" data-uid="Terminal.Gui.ConsoleDriver.LRRCorner">LRRCorner</h4>
  538. <div class="markdown level1 summary">
  539. Lower right rounded corner
  540. </div>
  541. <div class="markdown level1 conceptual"></div>
  542. <h5 class="decalaration">Declaration</h5>
  543. <div class="codewrapper">
  544. <pre><code class="lang-csharp hljs">public Rune LRRCorner</code></pre>
  545. </div>
  546. <h5 class="fieldValue">Field Value</h5>
  547. <table class="table table-bordered table-striped table-condensed">
  548. <thead>
  549. <tr>
  550. <th>Type</th>
  551. <th>Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td><span class="xref">System.Rune</span></td>
  557. <td></td>
  558. </tr>
  559. </tbody>
  560. </table>
  561. <h4 id="Terminal_Gui_ConsoleDriver_RightArrow" data-uid="Terminal.Gui.ConsoleDriver.RightArrow">RightArrow</h4>
  562. <div class="markdown level1 summary">
  563. Right Arrow.
  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 Rune RightArrow</code></pre>
  569. </div>
  570. <h5 class="fieldValue">Field Value</h5>
  571. <table class="table table-bordered table-striped table-condensed">
  572. <thead>
  573. <tr>
  574. <th>Type</th>
  575. <th>Description</th>
  576. </tr>
  577. </thead>
  578. <tbody>
  579. <tr>
  580. <td><span class="xref">System.Rune</span></td>
  581. <td></td>
  582. </tr>
  583. </tbody>
  584. </table>
  585. <h4 id="Terminal_Gui_ConsoleDriver_RightBracket" data-uid="Terminal.Gui.ConsoleDriver.RightBracket">RightBracket</h4>
  586. <div class="markdown level1 summary">
  587. Right frame/bracket (e.g. &apos;]&apos; for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  588. </div>
  589. <div class="markdown level1 conceptual"></div>
  590. <h5 class="decalaration">Declaration</h5>
  591. <div class="codewrapper">
  592. <pre><code class="lang-csharp hljs">public Rune RightBracket</code></pre>
  593. </div>
  594. <h5 class="fieldValue">Field Value</h5>
  595. <table class="table table-bordered table-striped table-condensed">
  596. <thead>
  597. <tr>
  598. <th>Type</th>
  599. <th>Description</th>
  600. </tr>
  601. </thead>
  602. <tbody>
  603. <tr>
  604. <td><span class="xref">System.Rune</span></td>
  605. <td></td>
  606. </tr>
  607. </tbody>
  608. </table>
  609. <h4 id="Terminal_Gui_ConsoleDriver_RightDefaultIndicator" data-uid="Terminal.Gui.ConsoleDriver.RightDefaultIndicator">RightDefaultIndicator</h4>
  610. <div class="markdown level1 summary">
  611. Right indicator for default action (e.g. for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  612. </div>
  613. <div class="markdown level1 conceptual"></div>
  614. <h5 class="decalaration">Declaration</h5>
  615. <div class="codewrapper">
  616. <pre><code class="lang-csharp hljs">public Rune RightDefaultIndicator</code></pre>
  617. </div>
  618. <h5 class="fieldValue">Field Value</h5>
  619. <table class="table table-bordered table-striped table-condensed">
  620. <thead>
  621. <tr>
  622. <th>Type</th>
  623. <th>Description</th>
  624. </tr>
  625. </thead>
  626. <tbody>
  627. <tr>
  628. <td><span class="xref">System.Rune</span></td>
  629. <td></td>
  630. </tr>
  631. </tbody>
  632. </table>
  633. <h4 id="Terminal_Gui_ConsoleDriver_RightTee" data-uid="Terminal.Gui.ConsoleDriver.RightTee">RightTee</h4>
  634. <div class="markdown level1 summary">
  635. Right tee
  636. </div>
  637. <div class="markdown level1 conceptual"></div>
  638. <h5 class="decalaration">Declaration</h5>
  639. <div class="codewrapper">
  640. <pre><code class="lang-csharp hljs">public Rune RightTee</code></pre>
  641. </div>
  642. <h5 class="fieldValue">Field Value</h5>
  643. <table class="table table-bordered table-striped table-condensed">
  644. <thead>
  645. <tr>
  646. <th>Type</th>
  647. <th>Description</th>
  648. </tr>
  649. </thead>
  650. <tbody>
  651. <tr>
  652. <td><span class="xref">System.Rune</span></td>
  653. <td></td>
  654. </tr>
  655. </tbody>
  656. </table>
  657. <h4 id="Terminal_Gui_ConsoleDriver_Selected" data-uid="Terminal.Gui.ConsoleDriver.Selected">Selected</h4>
  658. <div class="markdown level1 summary">
  659. Selected mark.
  660. </div>
  661. <div class="markdown level1 conceptual"></div>
  662. <h5 class="decalaration">Declaration</h5>
  663. <div class="codewrapper">
  664. <pre><code class="lang-csharp hljs">public Rune Selected</code></pre>
  665. </div>
  666. <h5 class="fieldValue">Field Value</h5>
  667. <table class="table table-bordered table-striped table-condensed">
  668. <thead>
  669. <tr>
  670. <th>Type</th>
  671. <th>Description</th>
  672. </tr>
  673. </thead>
  674. <tbody>
  675. <tr>
  676. <td><span class="xref">System.Rune</span></td>
  677. <td></td>
  678. </tr>
  679. </tbody>
  680. </table>
  681. <h4 id="Terminal_Gui_ConsoleDriver_Stipple" data-uid="Terminal.Gui.ConsoleDriver.Stipple">Stipple</h4>
  682. <div class="markdown level1 summary">
  683. Stipple pattern
  684. </div>
  685. <div class="markdown level1 conceptual"></div>
  686. <h5 class="decalaration">Declaration</h5>
  687. <div class="codewrapper">
  688. <pre><code class="lang-csharp hljs">public Rune Stipple</code></pre>
  689. </div>
  690. <h5 class="fieldValue">Field Value</h5>
  691. <table class="table table-bordered table-striped table-condensed">
  692. <thead>
  693. <tr>
  694. <th>Type</th>
  695. <th>Description</th>
  696. </tr>
  697. </thead>
  698. <tbody>
  699. <tr>
  700. <td><span class="xref">System.Rune</span></td>
  701. <td></td>
  702. </tr>
  703. </tbody>
  704. </table>
  705. <h4 id="Terminal_Gui_ConsoleDriver_TerminalResized" data-uid="Terminal.Gui.ConsoleDriver.TerminalResized">TerminalResized</h4>
  706. <div class="markdown level1 summary">
  707. The handler fired when the terminal is resized.
  708. </div>
  709. <div class="markdown level1 conceptual"></div>
  710. <h5 class="decalaration">Declaration</h5>
  711. <div class="codewrapper">
  712. <pre><code class="lang-csharp hljs">protected Action TerminalResized</code></pre>
  713. </div>
  714. <h5 class="fieldValue">Field Value</h5>
  715. <table class="table table-bordered table-striped table-condensed">
  716. <thead>
  717. <tr>
  718. <th>Type</th>
  719. <th>Description</th>
  720. </tr>
  721. </thead>
  722. <tbody>
  723. <tr>
  724. <td><span class="xref">System.Action</span></td>
  725. <td></td>
  726. </tr>
  727. </tbody>
  728. </table>
  729. <h4 id="Terminal_Gui_ConsoleDriver_TopTee" data-uid="Terminal.Gui.ConsoleDriver.TopTee">TopTee</h4>
  730. <div class="markdown level1 summary">
  731. Top tee
  732. </div>
  733. <div class="markdown level1 conceptual"></div>
  734. <h5 class="decalaration">Declaration</h5>
  735. <div class="codewrapper">
  736. <pre><code class="lang-csharp hljs">public Rune TopTee</code></pre>
  737. </div>
  738. <h5 class="fieldValue">Field Value</h5>
  739. <table class="table table-bordered table-striped table-condensed">
  740. <thead>
  741. <tr>
  742. <th>Type</th>
  743. <th>Description</th>
  744. </tr>
  745. </thead>
  746. <tbody>
  747. <tr>
  748. <td><span class="xref">System.Rune</span></td>
  749. <td></td>
  750. </tr>
  751. </tbody>
  752. </table>
  753. <h4 id="Terminal_Gui_ConsoleDriver_ULCorner" data-uid="Terminal.Gui.ConsoleDriver.ULCorner">ULCorner</h4>
  754. <div class="markdown level1 summary">
  755. Upper left corner
  756. </div>
  757. <div class="markdown level1 conceptual"></div>
  758. <h5 class="decalaration">Declaration</h5>
  759. <div class="codewrapper">
  760. <pre><code class="lang-csharp hljs">public Rune ULCorner</code></pre>
  761. </div>
  762. <h5 class="fieldValue">Field Value</h5>
  763. <table class="table table-bordered table-striped table-condensed">
  764. <thead>
  765. <tr>
  766. <th>Type</th>
  767. <th>Description</th>
  768. </tr>
  769. </thead>
  770. <tbody>
  771. <tr>
  772. <td><span class="xref">System.Rune</span></td>
  773. <td></td>
  774. </tr>
  775. </tbody>
  776. </table>
  777. <h4 id="Terminal_Gui_ConsoleDriver_ULDCorner" data-uid="Terminal.Gui.ConsoleDriver.ULDCorner">ULDCorner</h4>
  778. <div class="markdown level1 summary">
  779. Upper left double corner
  780. </div>
  781. <div class="markdown level1 conceptual"></div>
  782. <h5 class="decalaration">Declaration</h5>
  783. <div class="codewrapper">
  784. <pre><code class="lang-csharp hljs">public Rune ULDCorner</code></pre>
  785. </div>
  786. <h5 class="fieldValue">Field Value</h5>
  787. <table class="table table-bordered table-striped table-condensed">
  788. <thead>
  789. <tr>
  790. <th>Type</th>
  791. <th>Description</th>
  792. </tr>
  793. </thead>
  794. <tbody>
  795. <tr>
  796. <td><span class="xref">System.Rune</span></td>
  797. <td></td>
  798. </tr>
  799. </tbody>
  800. </table>
  801. <h4 id="Terminal_Gui_ConsoleDriver_ULRCorner" data-uid="Terminal.Gui.ConsoleDriver.ULRCorner">ULRCorner</h4>
  802. <div class="markdown level1 summary">
  803. Upper left rounded corner
  804. </div>
  805. <div class="markdown level1 conceptual"></div>
  806. <h5 class="decalaration">Declaration</h5>
  807. <div class="codewrapper">
  808. <pre><code class="lang-csharp hljs">public Rune ULRCorner</code></pre>
  809. </div>
  810. <h5 class="fieldValue">Field Value</h5>
  811. <table class="table table-bordered table-striped table-condensed">
  812. <thead>
  813. <tr>
  814. <th>Type</th>
  815. <th>Description</th>
  816. </tr>
  817. </thead>
  818. <tbody>
  819. <tr>
  820. <td><span class="xref">System.Rune</span></td>
  821. <td></td>
  822. </tr>
  823. </tbody>
  824. </table>
  825. <h4 id="Terminal_Gui_ConsoleDriver_UnChecked" data-uid="Terminal.Gui.ConsoleDriver.UnChecked">UnChecked</h4>
  826. <div class="markdown level1 summary">
  827. Un-checked checkmark.
  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 Rune UnChecked</code></pre>
  833. </div>
  834. <h5 class="fieldValue">Field Value</h5>
  835. <table class="table table-bordered table-striped table-condensed">
  836. <thead>
  837. <tr>
  838. <th>Type</th>
  839. <th>Description</th>
  840. </tr>
  841. </thead>
  842. <tbody>
  843. <tr>
  844. <td><span class="xref">System.Rune</span></td>
  845. <td></td>
  846. </tr>
  847. </tbody>
  848. </table>
  849. <h4 id="Terminal_Gui_ConsoleDriver_UnSelected" data-uid="Terminal.Gui.ConsoleDriver.UnSelected">UnSelected</h4>
  850. <div class="markdown level1 summary">
  851. Un-selected selected mark.
  852. </div>
  853. <div class="markdown level1 conceptual"></div>
  854. <h5 class="decalaration">Declaration</h5>
  855. <div class="codewrapper">
  856. <pre><code class="lang-csharp hljs">public Rune UnSelected</code></pre>
  857. </div>
  858. <h5 class="fieldValue">Field Value</h5>
  859. <table class="table table-bordered table-striped table-condensed">
  860. <thead>
  861. <tr>
  862. <th>Type</th>
  863. <th>Description</th>
  864. </tr>
  865. </thead>
  866. <tbody>
  867. <tr>
  868. <td><span class="xref">System.Rune</span></td>
  869. <td></td>
  870. </tr>
  871. </tbody>
  872. </table>
  873. <h4 id="Terminal_Gui_ConsoleDriver_UpArrow" data-uid="Terminal.Gui.ConsoleDriver.UpArrow">UpArrow</h4>
  874. <div class="markdown level1 summary">
  875. Up Arrow.
  876. </div>
  877. <div class="markdown level1 conceptual"></div>
  878. <h5 class="decalaration">Declaration</h5>
  879. <div class="codewrapper">
  880. <pre><code class="lang-csharp hljs">public Rune UpArrow</code></pre>
  881. </div>
  882. <h5 class="fieldValue">Field Value</h5>
  883. <table class="table table-bordered table-striped table-condensed">
  884. <thead>
  885. <tr>
  886. <th>Type</th>
  887. <th>Description</th>
  888. </tr>
  889. </thead>
  890. <tbody>
  891. <tr>
  892. <td><span class="xref">System.Rune</span></td>
  893. <td></td>
  894. </tr>
  895. </tbody>
  896. </table>
  897. <h4 id="Terminal_Gui_ConsoleDriver_URCorner" data-uid="Terminal.Gui.ConsoleDriver.URCorner">URCorner</h4>
  898. <div class="markdown level1 summary">
  899. Upper right corner
  900. </div>
  901. <div class="markdown level1 conceptual"></div>
  902. <h5 class="decalaration">Declaration</h5>
  903. <div class="codewrapper">
  904. <pre><code class="lang-csharp hljs">public Rune URCorner</code></pre>
  905. </div>
  906. <h5 class="fieldValue">Field Value</h5>
  907. <table class="table table-bordered table-striped table-condensed">
  908. <thead>
  909. <tr>
  910. <th>Type</th>
  911. <th>Description</th>
  912. </tr>
  913. </thead>
  914. <tbody>
  915. <tr>
  916. <td><span class="xref">System.Rune</span></td>
  917. <td></td>
  918. </tr>
  919. </tbody>
  920. </table>
  921. <h4 id="Terminal_Gui_ConsoleDriver_URDCorner" data-uid="Terminal.Gui.ConsoleDriver.URDCorner">URDCorner</h4>
  922. <div class="markdown level1 summary">
  923. Upper right double corner
  924. </div>
  925. <div class="markdown level1 conceptual"></div>
  926. <h5 class="decalaration">Declaration</h5>
  927. <div class="codewrapper">
  928. <pre><code class="lang-csharp hljs">public Rune URDCorner</code></pre>
  929. </div>
  930. <h5 class="fieldValue">Field Value</h5>
  931. <table class="table table-bordered table-striped table-condensed">
  932. <thead>
  933. <tr>
  934. <th>Type</th>
  935. <th>Description</th>
  936. </tr>
  937. </thead>
  938. <tbody>
  939. <tr>
  940. <td><span class="xref">System.Rune</span></td>
  941. <td></td>
  942. </tr>
  943. </tbody>
  944. </table>
  945. <h4 id="Terminal_Gui_ConsoleDriver_URRCorner" data-uid="Terminal.Gui.ConsoleDriver.URRCorner">URRCorner</h4>
  946. <div class="markdown level1 summary">
  947. Upper right rounded corner
  948. </div>
  949. <div class="markdown level1 conceptual"></div>
  950. <h5 class="decalaration">Declaration</h5>
  951. <div class="codewrapper">
  952. <pre><code class="lang-csharp hljs">public Rune URRCorner</code></pre>
  953. </div>
  954. <h5 class="fieldValue">Field Value</h5>
  955. <table class="table table-bordered table-striped table-condensed">
  956. <thead>
  957. <tr>
  958. <th>Type</th>
  959. <th>Description</th>
  960. </tr>
  961. </thead>
  962. <tbody>
  963. <tr>
  964. <td><span class="xref">System.Rune</span></td>
  965. <td></td>
  966. </tr>
  967. </tbody>
  968. </table>
  969. <h4 id="Terminal_Gui_ConsoleDriver_VDLine" data-uid="Terminal.Gui.ConsoleDriver.VDLine">VDLine</h4>
  970. <div class="markdown level1 summary">
  971. Vertical double line character.
  972. </div>
  973. <div class="markdown level1 conceptual"></div>
  974. <h5 class="decalaration">Declaration</h5>
  975. <div class="codewrapper">
  976. <pre><code class="lang-csharp hljs">public Rune VDLine</code></pre>
  977. </div>
  978. <h5 class="fieldValue">Field Value</h5>
  979. <table class="table table-bordered table-striped table-condensed">
  980. <thead>
  981. <tr>
  982. <th>Type</th>
  983. <th>Description</th>
  984. </tr>
  985. </thead>
  986. <tbody>
  987. <tr>
  988. <td><span class="xref">System.Rune</span></td>
  989. <td></td>
  990. </tr>
  991. </tbody>
  992. </table>
  993. <h4 id="Terminal_Gui_ConsoleDriver_VLine" data-uid="Terminal.Gui.ConsoleDriver.VLine">VLine</h4>
  994. <div class="markdown level1 summary">
  995. Vertical line character.
  996. </div>
  997. <div class="markdown level1 conceptual"></div>
  998. <h5 class="decalaration">Declaration</h5>
  999. <div class="codewrapper">
  1000. <pre><code class="lang-csharp hljs">public Rune VLine</code></pre>
  1001. </div>
  1002. <h5 class="fieldValue">Field Value</h5>
  1003. <table class="table table-bordered table-striped table-condensed">
  1004. <thead>
  1005. <tr>
  1006. <th>Type</th>
  1007. <th>Description</th>
  1008. </tr>
  1009. </thead>
  1010. <tbody>
  1011. <tr>
  1012. <td><span class="xref">System.Rune</span></td>
  1013. <td></td>
  1014. </tr>
  1015. </tbody>
  1016. </table>
  1017. <h4 id="Terminal_Gui_ConsoleDriver_VRLine" data-uid="Terminal.Gui.ConsoleDriver.VRLine">VRLine</h4>
  1018. <div class="markdown level1 summary">
  1019. Vertical line character for rounded corners.
  1020. </div>
  1021. <div class="markdown level1 conceptual"></div>
  1022. <h5 class="decalaration">Declaration</h5>
  1023. <div class="codewrapper">
  1024. <pre><code class="lang-csharp hljs">public Rune VRLine</code></pre>
  1025. </div>
  1026. <h5 class="fieldValue">Field Value</h5>
  1027. <table class="table table-bordered table-striped table-condensed">
  1028. <thead>
  1029. <tr>
  1030. <th>Type</th>
  1031. <th>Description</th>
  1032. </tr>
  1033. </thead>
  1034. <tbody>
  1035. <tr>
  1036. <td><span class="xref">System.Rune</span></td>
  1037. <td></td>
  1038. </tr>
  1039. </tbody>
  1040. </table>
  1041. <h3 id="properties">Properties
  1042. </h3>
  1043. <a id="Terminal_Gui_ConsoleDriver_Clip_" data-uid="Terminal.Gui.ConsoleDriver.Clip*"></a>
  1044. <h4 id="Terminal_Gui_ConsoleDriver_Clip" data-uid="Terminal.Gui.ConsoleDriver.Clip">Clip</h4>
  1045. <div class="markdown level1 summary">
  1046. Controls the current clipping region that AddRune/AddStr is subject to.
  1047. </div>
  1048. <div class="markdown level1 conceptual"></div>
  1049. <h5 class="decalaration">Declaration</h5>
  1050. <div class="codewrapper">
  1051. <pre><code class="lang-csharp hljs">public Rect Clip { get; set; }</code></pre>
  1052. </div>
  1053. <h5 class="propertyValue">Property Value</h5>
  1054. <table class="table table-bordered table-striped table-condensed">
  1055. <thead>
  1056. <tr>
  1057. <th>Type</th>
  1058. <th>Description</th>
  1059. </tr>
  1060. </thead>
  1061. <tbody>
  1062. <tr>
  1063. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1064. <td>The clip.</td>
  1065. </tr>
  1066. </tbody>
  1067. </table>
  1068. <a id="Terminal_Gui_ConsoleDriver_Clipboard_" data-uid="Terminal.Gui.ConsoleDriver.Clipboard*"></a>
  1069. <h4 id="Terminal_Gui_ConsoleDriver_Clipboard" data-uid="Terminal.Gui.ConsoleDriver.Clipboard">Clipboard</h4>
  1070. <div class="markdown level1 summary">
  1071. Get the operation system clipboard.
  1072. </div>
  1073. <div class="markdown level1 conceptual"></div>
  1074. <h5 class="decalaration">Declaration</h5>
  1075. <div class="codewrapper">
  1076. <pre><code class="lang-csharp hljs">public abstract IClipboard Clipboard { get; }</code></pre>
  1077. </div>
  1078. <h5 class="propertyValue">Property Value</h5>
  1079. <table class="table table-bordered table-striped table-condensed">
  1080. <thead>
  1081. <tr>
  1082. <th>Type</th>
  1083. <th>Description</th>
  1084. </tr>
  1085. </thead>
  1086. <tbody>
  1087. <tr>
  1088. <td><a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a></td>
  1089. <td></td>
  1090. </tr>
  1091. </tbody>
  1092. </table>
  1093. <a id="Terminal_Gui_ConsoleDriver_Cols_" data-uid="Terminal.Gui.ConsoleDriver.Cols*"></a>
  1094. <h4 id="Terminal_Gui_ConsoleDriver_Cols" data-uid="Terminal.Gui.ConsoleDriver.Cols">Cols</h4>
  1095. <div class="markdown level1 summary">
  1096. The current number of columns in the terminal.
  1097. </div>
  1098. <div class="markdown level1 conceptual"></div>
  1099. <h5 class="decalaration">Declaration</h5>
  1100. <div class="codewrapper">
  1101. <pre><code class="lang-csharp hljs">public abstract int Cols { get; }</code></pre>
  1102. </div>
  1103. <h5 class="propertyValue">Property Value</h5>
  1104. <table class="table table-bordered table-striped table-condensed">
  1105. <thead>
  1106. <tr>
  1107. <th>Type</th>
  1108. <th>Description</th>
  1109. </tr>
  1110. </thead>
  1111. <tbody>
  1112. <tr>
  1113. <td><span class="xref">System.Int32</span></td>
  1114. <td></td>
  1115. </tr>
  1116. </tbody>
  1117. </table>
  1118. <a id="Terminal_Gui_ConsoleDriver_Contents_" data-uid="Terminal.Gui.ConsoleDriver.Contents*"></a>
  1119. <h4 id="Terminal_Gui_ConsoleDriver_Contents" data-uid="Terminal.Gui.ConsoleDriver.Contents">Contents</h4>
  1120. <div class="markdown level1 summary">
  1121. The format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag
  1122. </div>
  1123. <div class="markdown level1 conceptual"></div>
  1124. <h5 class="decalaration">Declaration</h5>
  1125. <div class="codewrapper">
  1126. <pre><code class="lang-csharp hljs">public virtual int[,, ] Contents { get; }</code></pre>
  1127. </div>
  1128. <h5 class="propertyValue">Property Value</h5>
  1129. <table class="table table-bordered table-striped table-condensed">
  1130. <thead>
  1131. <tr>
  1132. <th>Type</th>
  1133. <th>Description</th>
  1134. </tr>
  1135. </thead>
  1136. <tbody>
  1137. <tr>
  1138. <td><span class="xref">System.Int32</span>[,,]</td>
  1139. <td></td>
  1140. </tr>
  1141. </tbody>
  1142. </table>
  1143. <a id="Terminal_Gui_ConsoleDriver_Diagnostics_" data-uid="Terminal.Gui.ConsoleDriver.Diagnostics*"></a>
  1144. <h4 id="Terminal_Gui_ConsoleDriver_Diagnostics" data-uid="Terminal.Gui.ConsoleDriver.Diagnostics">Diagnostics</h4>
  1145. <div class="markdown level1 summary">
  1146. Set flags to enable/disable <a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a> diagnostics.
  1147. </div>
  1148. <div class="markdown level1 conceptual"></div>
  1149. <h5 class="decalaration">Declaration</h5>
  1150. <div class="codewrapper">
  1151. <pre><code class="lang-csharp hljs">public static ConsoleDriver.DiagnosticFlags Diagnostics { get; set; }</code></pre>
  1152. </div>
  1153. <h5 class="propertyValue">Property Value</h5>
  1154. <table class="table table-bordered table-striped table-condensed">
  1155. <thead>
  1156. <tr>
  1157. <th>Type</th>
  1158. <th>Description</th>
  1159. </tr>
  1160. </thead>
  1161. <tbody>
  1162. <tr>
  1163. <td><a class="xref" href="Terminal.Gui.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></td>
  1164. <td></td>
  1165. </tr>
  1166. </tbody>
  1167. </table>
  1168. <a id="Terminal_Gui_ConsoleDriver_HeightAsBuffer_" data-uid="Terminal.Gui.ConsoleDriver.HeightAsBuffer*"></a>
  1169. <h4 id="Terminal_Gui_ConsoleDriver_HeightAsBuffer" data-uid="Terminal.Gui.ConsoleDriver.HeightAsBuffer">HeightAsBuffer</h4>
  1170. <div class="markdown level1 summary">
  1171. If false height is measured by the window height and thus no scrolling.
  1172. If true then height is measured by the buffer height, enabling scrolling.
  1173. </div>
  1174. <div class="markdown level1 conceptual"></div>
  1175. <h5 class="decalaration">Declaration</h5>
  1176. <div class="codewrapper">
  1177. <pre><code class="lang-csharp hljs">public abstract bool HeightAsBuffer { get; set; }</code></pre>
  1178. </div>
  1179. <h5 class="propertyValue">Property Value</h5>
  1180. <table class="table table-bordered table-striped table-condensed">
  1181. <thead>
  1182. <tr>
  1183. <th>Type</th>
  1184. <th>Description</th>
  1185. </tr>
  1186. </thead>
  1187. <tbody>
  1188. <tr>
  1189. <td><span class="xref">System.Boolean</span></td>
  1190. <td></td>
  1191. </tr>
  1192. </tbody>
  1193. </table>
  1194. <a id="Terminal_Gui_ConsoleDriver_Left_" data-uid="Terminal.Gui.ConsoleDriver.Left*"></a>
  1195. <h4 id="Terminal_Gui_ConsoleDriver_Left" data-uid="Terminal.Gui.ConsoleDriver.Left">Left</h4>
  1196. <div class="markdown level1 summary">
  1197. The current left in the terminal.
  1198. </div>
  1199. <div class="markdown level1 conceptual"></div>
  1200. <h5 class="decalaration">Declaration</h5>
  1201. <div class="codewrapper">
  1202. <pre><code class="lang-csharp hljs">public abstract int Left { get; }</code></pre>
  1203. </div>
  1204. <h5 class="propertyValue">Property Value</h5>
  1205. <table class="table table-bordered table-striped table-condensed">
  1206. <thead>
  1207. <tr>
  1208. <th>Type</th>
  1209. <th>Description</th>
  1210. </tr>
  1211. </thead>
  1212. <tbody>
  1213. <tr>
  1214. <td><span class="xref">System.Int32</span></td>
  1215. <td></td>
  1216. </tr>
  1217. </tbody>
  1218. </table>
  1219. <a id="Terminal_Gui_ConsoleDriver_Rows_" data-uid="Terminal.Gui.ConsoleDriver.Rows*"></a>
  1220. <h4 id="Terminal_Gui_ConsoleDriver_Rows" data-uid="Terminal.Gui.ConsoleDriver.Rows">Rows</h4>
  1221. <div class="markdown level1 summary">
  1222. The current number of rows in the terminal.
  1223. </div>
  1224. <div class="markdown level1 conceptual"></div>
  1225. <h5 class="decalaration">Declaration</h5>
  1226. <div class="codewrapper">
  1227. <pre><code class="lang-csharp hljs">public abstract int Rows { get; }</code></pre>
  1228. </div>
  1229. <h5 class="propertyValue">Property Value</h5>
  1230. <table class="table table-bordered table-striped table-condensed">
  1231. <thead>
  1232. <tr>
  1233. <th>Type</th>
  1234. <th>Description</th>
  1235. </tr>
  1236. </thead>
  1237. <tbody>
  1238. <tr>
  1239. <td><span class="xref">System.Int32</span></td>
  1240. <td></td>
  1241. </tr>
  1242. </tbody>
  1243. </table>
  1244. <a id="Terminal_Gui_ConsoleDriver_Top_" data-uid="Terminal.Gui.ConsoleDriver.Top*"></a>
  1245. <h4 id="Terminal_Gui_ConsoleDriver_Top" data-uid="Terminal.Gui.ConsoleDriver.Top">Top</h4>
  1246. <div class="markdown level1 summary">
  1247. The current top in the terminal.
  1248. </div>
  1249. <div class="markdown level1 conceptual"></div>
  1250. <h5 class="decalaration">Declaration</h5>
  1251. <div class="codewrapper">
  1252. <pre><code class="lang-csharp hljs">public abstract int Top { get; }</code></pre>
  1253. </div>
  1254. <h5 class="propertyValue">Property Value</h5>
  1255. <table class="table table-bordered table-striped table-condensed">
  1256. <thead>
  1257. <tr>
  1258. <th>Type</th>
  1259. <th>Description</th>
  1260. </tr>
  1261. </thead>
  1262. <tbody>
  1263. <tr>
  1264. <td><span class="xref">System.Int32</span></td>
  1265. <td></td>
  1266. </tr>
  1267. </tbody>
  1268. </table>
  1269. <h3 id="methods">Methods
  1270. </h3>
  1271. <a id="Terminal_Gui_ConsoleDriver_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
  1272. <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
  1273. <div class="markdown level1 summary">
  1274. Adds the specified rune to the display at the current cursor position
  1275. </div>
  1276. <div class="markdown level1 conceptual"></div>
  1277. <h5 class="decalaration">Declaration</h5>
  1278. <div class="codewrapper">
  1279. <pre><code class="lang-csharp hljs">public abstract void AddRune(Rune rune)</code></pre>
  1280. </div>
  1281. <h5 class="parameters">Parameters</h5>
  1282. <table class="table table-bordered table-striped table-condensed">
  1283. <thead>
  1284. <tr>
  1285. <th>Type</th>
  1286. <th>Name</th>
  1287. <th>Description</th>
  1288. </tr>
  1289. </thead>
  1290. <tbody>
  1291. <tr>
  1292. <td><span class="xref">System.Rune</span></td>
  1293. <td><span class="parametername">rune</span></td>
  1294. <td>Rune to add.</td>
  1295. </tr>
  1296. </tbody>
  1297. </table>
  1298. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  1299. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
  1300. <div class="markdown level1 summary">
  1301. Adds the specified
  1302. </div>
  1303. <div class="markdown level1 conceptual"></div>
  1304. <h5 class="decalaration">Declaration</h5>
  1305. <div class="codewrapper">
  1306. <pre><code class="lang-csharp hljs">public abstract void AddStr(ustring str)</code></pre>
  1307. </div>
  1308. <h5 class="parameters">Parameters</h5>
  1309. <table class="table table-bordered table-striped table-condensed">
  1310. <thead>
  1311. <tr>
  1312. <th>Type</th>
  1313. <th>Name</th>
  1314. <th>Description</th>
  1315. </tr>
  1316. </thead>
  1317. <tbody>
  1318. <tr>
  1319. <td><span class="xref">NStack.ustring</span></td>
  1320. <td><span class="parametername">str</span></td>
  1321. <td>String.</td>
  1322. </tr>
  1323. </tbody>
  1324. </table>
  1325. <a id="Terminal_Gui_ConsoleDriver_CookMouse_" data-uid="Terminal.Gui.ConsoleDriver.CookMouse*"></a>
  1326. <h4 id="Terminal_Gui_ConsoleDriver_CookMouse" data-uid="Terminal.Gui.ConsoleDriver.CookMouse">CookMouse()</h4>
  1327. <div class="markdown level1 summary">
  1328. Enables the cooked event processing from the mouse driver
  1329. </div>
  1330. <div class="markdown level1 conceptual"></div>
  1331. <h5 class="decalaration">Declaration</h5>
  1332. <div class="codewrapper">
  1333. <pre><code class="lang-csharp hljs">public abstract void CookMouse()</code></pre>
  1334. </div>
  1335. <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
  1336. <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>
  1337. <div class="markdown level1 summary">
  1338. Draws a frame on the specified region with the specified padding around the frame.
  1339. </div>
  1340. <div class="markdown level1 conceptual"></div>
  1341. <h5 class="decalaration">Declaration</h5>
  1342. <div class="codewrapper">
  1343. <pre><code class="lang-csharp hljs">public virtual void DrawFrame(Rect region, int padding, bool fill)</code></pre>
  1344. </div>
  1345. <h5 class="parameters">Parameters</h5>
  1346. <table class="table table-bordered table-striped table-condensed">
  1347. <thead>
  1348. <tr>
  1349. <th>Type</th>
  1350. <th>Name</th>
  1351. <th>Description</th>
  1352. </tr>
  1353. </thead>
  1354. <tbody>
  1355. <tr>
  1356. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1357. <td><span class="parametername">region</span></td>
  1358. <td>Screen relative region where the frame will be drawn.</td>
  1359. </tr>
  1360. <tr>
  1361. <td><span class="xref">System.Int32</span></td>
  1362. <td><span class="parametername">padding</span></td>
  1363. <td>Padding to add on the sides.</td>
  1364. </tr>
  1365. <tr>
  1366. <td><span class="xref">System.Boolean</span></td>
  1367. <td><span class="parametername">fill</span></td>
  1368. <td>If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.</td>
  1369. </tr>
  1370. </tbody>
  1371. </table>
  1372. <a id="Terminal_Gui_ConsoleDriver_DrawWindowFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowFrame*"></a>
  1373. <h4 id="Terminal_Gui_ConsoleDriver_DrawWindowFrame_Terminal_Gui_Rect_System_Int32_System_Int32_System_Int32_System_Int32_System_Boolean_System_Boolean_Terminal_Gui_Border_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowFrame(Terminal.Gui.Rect,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,Terminal.Gui.Border)">DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border)</h4>
  1374. <div class="markdown level1 summary">
  1375. Draws a frame for a window with padding and an optional visible border inside the padding.
  1376. </div>
  1377. <div class="markdown level1 conceptual"></div>
  1378. <h5 class="decalaration">Declaration</h5>
  1379. <div class="codewrapper">
  1380. <pre><code class="lang-csharp hljs">public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false, Border borderContent = null)</code></pre>
  1381. </div>
  1382. <h5 class="parameters">Parameters</h5>
  1383. <table class="table table-bordered table-striped table-condensed">
  1384. <thead>
  1385. <tr>
  1386. <th>Type</th>
  1387. <th>Name</th>
  1388. <th>Description</th>
  1389. </tr>
  1390. </thead>
  1391. <tbody>
  1392. <tr>
  1393. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1394. <td><span class="parametername">region</span></td>
  1395. <td>Screen relative region where the frame will be drawn.</td>
  1396. </tr>
  1397. <tr>
  1398. <td><span class="xref">System.Int32</span></td>
  1399. <td><span class="parametername">paddingLeft</span></td>
  1400. <td>Number of columns to pad on the left (if 0 the border will not appear on the left).</td>
  1401. </tr>
  1402. <tr>
  1403. <td><span class="xref">System.Int32</span></td>
  1404. <td><span class="parametername">paddingTop</span></td>
  1405. <td>Number of rows to pad on the top (if 0 the border and title will not appear on the top).</td>
  1406. </tr>
  1407. <tr>
  1408. <td><span class="xref">System.Int32</span></td>
  1409. <td><span class="parametername">paddingRight</span></td>
  1410. <td>Number of columns to pad on the right (if 0 the border will not appear on the right).</td>
  1411. </tr>
  1412. <tr>
  1413. <td><span class="xref">System.Int32</span></td>
  1414. <td><span class="parametername">paddingBottom</span></td>
  1415. <td>Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).</td>
  1416. </tr>
  1417. <tr>
  1418. <td><span class="xref">System.Boolean</span></td>
  1419. <td><span class="parametername">border</span></td>
  1420. <td>If set to <code>true</code> and any padding dimension is > 0 the border will be drawn.</td>
  1421. </tr>
  1422. <tr>
  1423. <td><span class="xref">System.Boolean</span></td>
  1424. <td><span class="parametername">fill</span></td>
  1425. <td>If set to <code>true</code> it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched.</td>
  1426. </tr>
  1427. <tr>
  1428. <td><a class="xref" href="Terminal.Gui.Border.html">Border</a></td>
  1429. <td><span class="parametername">borderContent</span></td>
  1430. <td>The <a class="xref" href="Terminal.Gui.Border.html">Border</a> to be used if defined.</td>
  1431. </tr>
  1432. </tbody>
  1433. </table>
  1434. <a id="Terminal_Gui_ConsoleDriver_DrawWindowTitle_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowTitle*"></a>
  1435. <h4 id="Terminal_Gui_ConsoleDriver_DrawWindowTitle_Terminal_Gui_Rect_NStack_ustring_System_Int32_System_Int32_System_Int32_System_Int32_Terminal_Gui_TextAlignment_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowTitle(Terminal.Gui.Rect,NStack.ustring,System.Int32,System.Int32,System.Int32,System.Int32,Terminal.Gui.TextAlignment)">DrawWindowTitle(Rect, ustring, Int32, Int32, Int32, Int32, TextAlignment)</h4>
  1436. <div class="markdown level1 summary">
  1437. Draws the title for a Window-style view incorporating padding.
  1438. </div>
  1439. <div class="markdown level1 conceptual"></div>
  1440. <h5 class="decalaration">Declaration</h5>
  1441. <div class="codewrapper">
  1442. <pre><code class="lang-csharp hljs">public virtual void DrawWindowTitle(Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment)</code></pre>
  1443. </div>
  1444. <h5 class="parameters">Parameters</h5>
  1445. <table class="table table-bordered table-striped table-condensed">
  1446. <thead>
  1447. <tr>
  1448. <th>Type</th>
  1449. <th>Name</th>
  1450. <th>Description</th>
  1451. </tr>
  1452. </thead>
  1453. <tbody>
  1454. <tr>
  1455. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1456. <td><span class="parametername">region</span></td>
  1457. <td>Screen relative region where the frame will be drawn.</td>
  1458. </tr>
  1459. <tr>
  1460. <td><span class="xref">NStack.ustring</span></td>
  1461. <td><span class="parametername">title</span></td>
  1462. <td>The title for the window. The title will only be drawn if <code>title</code> is not null or empty and paddingTop is greater than 0.</td>
  1463. </tr>
  1464. <tr>
  1465. <td><span class="xref">System.Int32</span></td>
  1466. <td><span class="parametername">paddingLeft</span></td>
  1467. <td>Number of columns to pad on the left (if 0 the border will not appear on the left).</td>
  1468. </tr>
  1469. <tr>
  1470. <td><span class="xref">System.Int32</span></td>
  1471. <td><span class="parametername">paddingTop</span></td>
  1472. <td>Number of rows to pad on the top (if 0 the border and title will not appear on the top).</td>
  1473. </tr>
  1474. <tr>
  1475. <td><span class="xref">System.Int32</span></td>
  1476. <td><span class="parametername">paddingRight</span></td>
  1477. <td>Number of columns to pad on the right (if 0 the border will not appear on the right).</td>
  1478. </tr>
  1479. <tr>
  1480. <td><span class="xref">System.Int32</span></td>
  1481. <td><span class="parametername">paddingBottom</span></td>
  1482. <td>Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).</td>
  1483. </tr>
  1484. <tr>
  1485. <td><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></td>
  1486. <td><span class="parametername">textAlignment</span></td>
  1487. <td>Not yet implemented.</td>
  1488. </tr>
  1489. </tbody>
  1490. </table>
  1491. <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
  1492. <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
  1493. <div class="markdown level1 summary">
  1494. Ends the execution of the console driver.
  1495. </div>
  1496. <div class="markdown level1 conceptual"></div>
  1497. <h5 class="decalaration">Declaration</h5>
  1498. <div class="codewrapper">
  1499. <pre><code class="lang-csharp hljs">public abstract void End()</code></pre>
  1500. </div>
  1501. <a id="Terminal_Gui_ConsoleDriver_EnsureCursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.EnsureCursorVisibility*"></a>
  1502. <h4 id="Terminal_Gui_ConsoleDriver_EnsureCursorVisibility" data-uid="Terminal.Gui.ConsoleDriver.EnsureCursorVisibility">EnsureCursorVisibility()</h4>
  1503. <div class="markdown level1 summary">
  1504. Ensure the cursor visibility
  1505. </div>
  1506. <div class="markdown level1 conceptual"></div>
  1507. <h5 class="decalaration">Declaration</h5>
  1508. <div class="codewrapper">
  1509. <pre><code class="lang-csharp hljs">public abstract bool EnsureCursorVisibility()</code></pre>
  1510. </div>
  1511. <h5 class="returns">Returns</h5>
  1512. <table class="table table-bordered table-striped table-condensed">
  1513. <thead>
  1514. <tr>
  1515. <th>Type</th>
  1516. <th>Description</th>
  1517. </tr>
  1518. </thead>
  1519. <tbody>
  1520. <tr>
  1521. <td><span class="xref">System.Boolean</span></td>
  1522. <td>true upon success</td>
  1523. </tr>
  1524. </tbody>
  1525. </table>
  1526. <a id="Terminal_Gui_ConsoleDriver_GetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.GetAttribute*"></a>
  1527. <h4 id="Terminal_Gui_ConsoleDriver_GetAttribute" data-uid="Terminal.Gui.ConsoleDriver.GetAttribute">GetAttribute()</h4>
  1528. <div class="markdown level1 summary">
  1529. Gets the current <a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>.
  1530. </div>
  1531. <div class="markdown level1 conceptual"></div>
  1532. <h5 class="decalaration">Declaration</h5>
  1533. <div class="codewrapper">
  1534. <pre><code class="lang-csharp hljs">public abstract Attribute GetAttribute()</code></pre>
  1535. </div>
  1536. <h5 class="returns">Returns</h5>
  1537. <table class="table table-bordered table-striped table-condensed">
  1538. <thead>
  1539. <tr>
  1540. <th>Type</th>
  1541. <th>Description</th>
  1542. </tr>
  1543. </thead>
  1544. <tbody>
  1545. <tr>
  1546. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1547. <td>The current attribute.</td>
  1548. </tr>
  1549. </tbody>
  1550. </table>
  1551. <a id="Terminal_Gui_ConsoleDriver_GetColors_" data-uid="Terminal.Gui.ConsoleDriver.GetColors*"></a>
  1552. <h4 id="Terminal_Gui_ConsoleDriver_GetColors_System_Int32_Terminal_Gui_Color__Terminal_Gui_Color__" data-uid="Terminal.Gui.ConsoleDriver.GetColors(System.Int32,Terminal.Gui.Color@,Terminal.Gui.Color@)">GetColors(Int32, out Color, out Color)</h4>
  1553. <div class="markdown level1 summary">
  1554. Gets the foreground and background colors based on the value.
  1555. </div>
  1556. <div class="markdown level1 conceptual"></div>
  1557. <h5 class="decalaration">Declaration</h5>
  1558. <div class="codewrapper">
  1559. <pre><code class="lang-csharp hljs">public abstract bool GetColors(int value, out Color foreground, out Color background)</code></pre>
  1560. </div>
  1561. <h5 class="parameters">Parameters</h5>
  1562. <table class="table table-bordered table-striped table-condensed">
  1563. <thead>
  1564. <tr>
  1565. <th>Type</th>
  1566. <th>Name</th>
  1567. <th>Description</th>
  1568. </tr>
  1569. </thead>
  1570. <tbody>
  1571. <tr>
  1572. <td><span class="xref">System.Int32</span></td>
  1573. <td><span class="parametername">value</span></td>
  1574. <td>The value.</td>
  1575. </tr>
  1576. <tr>
  1577. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  1578. <td><span class="parametername">foreground</span></td>
  1579. <td>The foreground.</td>
  1580. </tr>
  1581. <tr>
  1582. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  1583. <td><span class="parametername">background</span></td>
  1584. <td>The background.</td>
  1585. </tr>
  1586. </tbody>
  1587. </table>
  1588. <h5 class="returns">Returns</h5>
  1589. <table class="table table-bordered table-striped table-condensed">
  1590. <thead>
  1591. <tr>
  1592. <th>Type</th>
  1593. <th>Description</th>
  1594. </tr>
  1595. </thead>
  1596. <tbody>
  1597. <tr>
  1598. <td><span class="xref">System.Boolean</span></td>
  1599. <td></td>
  1600. </tr>
  1601. </tbody>
  1602. </table>
  1603. <a id="Terminal_Gui_ConsoleDriver_GetCursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.GetCursorVisibility*"></a>
  1604. <h4 id="Terminal_Gui_ConsoleDriver_GetCursorVisibility_Terminal_Gui_CursorVisibility__" data-uid="Terminal.Gui.ConsoleDriver.GetCursorVisibility(Terminal.Gui.CursorVisibility@)">GetCursorVisibility(out CursorVisibility)</h4>
  1605. <div class="markdown level1 summary">
  1606. Retreive the cursor caret visibility
  1607. </div>
  1608. <div class="markdown level1 conceptual"></div>
  1609. <h5 class="decalaration">Declaration</h5>
  1610. <div class="codewrapper">
  1611. <pre><code class="lang-csharp hljs">public abstract bool GetCursorVisibility(out CursorVisibility visibility)</code></pre>
  1612. </div>
  1613. <h5 class="parameters">Parameters</h5>
  1614. <table class="table table-bordered table-striped table-condensed">
  1615. <thead>
  1616. <tr>
  1617. <th>Type</th>
  1618. <th>Name</th>
  1619. <th>Description</th>
  1620. </tr>
  1621. </thead>
  1622. <tbody>
  1623. <tr>
  1624. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  1625. <td><span class="parametername">visibility</span></td>
  1626. <td>The current <a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  1627. </tr>
  1628. </tbody>
  1629. </table>
  1630. <h5 class="returns">Returns</h5>
  1631. <table class="table table-bordered table-striped table-condensed">
  1632. <thead>
  1633. <tr>
  1634. <th>Type</th>
  1635. <th>Description</th>
  1636. </tr>
  1637. </thead>
  1638. <tbody>
  1639. <tr>
  1640. <td><span class="xref">System.Boolean</span></td>
  1641. <td>true upon success</td>
  1642. </tr>
  1643. </tbody>
  1644. </table>
  1645. <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
  1646. <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
  1647. <div class="markdown level1 summary">
  1648. Initializes the driver
  1649. </div>
  1650. <div class="markdown level1 conceptual"></div>
  1651. <h5 class="decalaration">Declaration</h5>
  1652. <div class="codewrapper">
  1653. <pre><code class="lang-csharp hljs">public abstract void Init(Action terminalResized)</code></pre>
  1654. </div>
  1655. <h5 class="parameters">Parameters</h5>
  1656. <table class="table table-bordered table-striped table-condensed">
  1657. <thead>
  1658. <tr>
  1659. <th>Type</th>
  1660. <th>Name</th>
  1661. <th>Description</th>
  1662. </tr>
  1663. </thead>
  1664. <tbody>
  1665. <tr>
  1666. <td><span class="xref">System.Action</span></td>
  1667. <td><span class="parametername">terminalResized</span></td>
  1668. <td>Method to invoke when the terminal is resized.</td>
  1669. </tr>
  1670. </tbody>
  1671. </table>
  1672. <a id="Terminal_Gui_ConsoleDriver_IsValidContent_" data-uid="Terminal.Gui.ConsoleDriver.IsValidContent*"></a>
  1673. <h4 id="Terminal_Gui_ConsoleDriver_IsValidContent_System_Int32_System_Int32_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ConsoleDriver.IsValidContent(System.Int32,System.Int32,Terminal.Gui.Rect)">IsValidContent(Int32, Int32, Rect)</h4>
  1674. <div class="markdown level1 summary">
  1675. Ensures that the column and line are in a valid range from the size of the driver.
  1676. </div>
  1677. <div class="markdown level1 conceptual"></div>
  1678. <h5 class="decalaration">Declaration</h5>
  1679. <div class="codewrapper">
  1680. <pre><code class="lang-csharp hljs">public bool IsValidContent(int col, int row, Rect clip)</code></pre>
  1681. </div>
  1682. <h5 class="parameters">Parameters</h5>
  1683. <table class="table table-bordered table-striped table-condensed">
  1684. <thead>
  1685. <tr>
  1686. <th>Type</th>
  1687. <th>Name</th>
  1688. <th>Description</th>
  1689. </tr>
  1690. </thead>
  1691. <tbody>
  1692. <tr>
  1693. <td><span class="xref">System.Int32</span></td>
  1694. <td><span class="parametername">col</span></td>
  1695. <td>The column.</td>
  1696. </tr>
  1697. <tr>
  1698. <td><span class="xref">System.Int32</span></td>
  1699. <td><span class="parametername">row</span></td>
  1700. <td>The row.</td>
  1701. </tr>
  1702. <tr>
  1703. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1704. <td><span class="parametername">clip</span></td>
  1705. <td>The clip.</td>
  1706. </tr>
  1707. </tbody>
  1708. </table>
  1709. <h5 class="returns">Returns</h5>
  1710. <table class="table table-bordered table-striped table-condensed">
  1711. <thead>
  1712. <tr>
  1713. <th>Type</th>
  1714. <th>Description</th>
  1715. </tr>
  1716. </thead>
  1717. <tbody>
  1718. <tr>
  1719. <td><span class="xref">System.Boolean</span></td>
  1720. <td><code>true</code>if it&apos;s a valid range,<code>false</code>otherwise.</td>
  1721. </tr>
  1722. </tbody>
  1723. </table>
  1724. <a id="Terminal_Gui_ConsoleDriver_MakeAttribute_" data-uid="Terminal.Gui.ConsoleDriver.MakeAttribute*"></a>
  1725. <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>
  1726. <div class="markdown level1 summary">
  1727. Make the attribute for the foreground and background colors.
  1728. </div>
  1729. <div class="markdown level1 conceptual"></div>
  1730. <h5 class="decalaration">Declaration</h5>
  1731. <div class="codewrapper">
  1732. <pre><code class="lang-csharp hljs">public abstract Attribute MakeAttribute(Color fore, Color back)</code></pre>
  1733. </div>
  1734. <h5 class="parameters">Parameters</h5>
  1735. <table class="table table-bordered table-striped table-condensed">
  1736. <thead>
  1737. <tr>
  1738. <th>Type</th>
  1739. <th>Name</th>
  1740. <th>Description</th>
  1741. </tr>
  1742. </thead>
  1743. <tbody>
  1744. <tr>
  1745. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  1746. <td><span class="parametername">fore</span></td>
  1747. <td>Foreground.</td>
  1748. </tr>
  1749. <tr>
  1750. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  1751. <td><span class="parametername">back</span></td>
  1752. <td>Background.</td>
  1753. </tr>
  1754. </tbody>
  1755. </table>
  1756. <h5 class="returns">Returns</h5>
  1757. <table class="table table-bordered table-striped table-condensed">
  1758. <thead>
  1759. <tr>
  1760. <th>Type</th>
  1761. <th>Description</th>
  1762. </tr>
  1763. </thead>
  1764. <tbody>
  1765. <tr>
  1766. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1767. <td></td>
  1768. </tr>
  1769. </tbody>
  1770. </table>
  1771. <a id="Terminal_Gui_ConsoleDriver_MakePrintable_" data-uid="Terminal.Gui.ConsoleDriver.MakePrintable*"></a>
  1772. <h4 id="Terminal_Gui_ConsoleDriver_MakePrintable_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.MakePrintable(System.Rune)">MakePrintable(Rune)</h4>
  1773. <div class="markdown level1 summary">
  1774. Ensures a Rune is not a control character and can be displayed by translating characters below 0x20
  1775. to equivalent, printable, Unicode chars.
  1776. </div>
  1777. <div class="markdown level1 conceptual"></div>
  1778. <h5 class="decalaration">Declaration</h5>
  1779. <div class="codewrapper">
  1780. <pre><code class="lang-csharp hljs">public static Rune MakePrintable(Rune c)</code></pre>
  1781. </div>
  1782. <h5 class="parameters">Parameters</h5>
  1783. <table class="table table-bordered table-striped table-condensed">
  1784. <thead>
  1785. <tr>
  1786. <th>Type</th>
  1787. <th>Name</th>
  1788. <th>Description</th>
  1789. </tr>
  1790. </thead>
  1791. <tbody>
  1792. <tr>
  1793. <td><span class="xref">System.Rune</span></td>
  1794. <td><span class="parametername">c</span></td>
  1795. <td>Rune to translate</td>
  1796. </tr>
  1797. </tbody>
  1798. </table>
  1799. <h5 class="returns">Returns</h5>
  1800. <table class="table table-bordered table-striped table-condensed">
  1801. <thead>
  1802. <tr>
  1803. <th>Type</th>
  1804. <th>Description</th>
  1805. </tr>
  1806. </thead>
  1807. <tbody>
  1808. <tr>
  1809. <td><span class="xref">System.Rune</span></td>
  1810. <td></td>
  1811. </tr>
  1812. </tbody>
  1813. </table>
  1814. <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
  1815. <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  1816. <div class="markdown level1 summary">
  1817. Moves the cursor to the specified column and row.
  1818. </div>
  1819. <div class="markdown level1 conceptual"></div>
  1820. <h5 class="decalaration">Declaration</h5>
  1821. <div class="codewrapper">
  1822. <pre><code class="lang-csharp hljs">public abstract void Move(int col, int row)</code></pre>
  1823. </div>
  1824. <h5 class="parameters">Parameters</h5>
  1825. <table class="table table-bordered table-striped table-condensed">
  1826. <thead>
  1827. <tr>
  1828. <th>Type</th>
  1829. <th>Name</th>
  1830. <th>Description</th>
  1831. </tr>
  1832. </thead>
  1833. <tbody>
  1834. <tr>
  1835. <td><span class="xref">System.Int32</span></td>
  1836. <td><span class="parametername">col</span></td>
  1837. <td>Column to move the cursor to.</td>
  1838. </tr>
  1839. <tr>
  1840. <td><span class="xref">System.Int32</span></td>
  1841. <td><span class="parametername">row</span></td>
  1842. <td>Row to move the cursor to.</td>
  1843. </tr>
  1844. </tbody>
  1845. </table>
  1846. <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
  1847. <h4 id="Terminal_Gui_ConsoleDriver_PrepareToRun_Terminal_Gui_MainLoop_System_Action_Terminal_Gui_KeyEvent__System_Action_Terminal_Gui_KeyEvent__System_Action_Terminal_Gui_KeyEvent__System_Action_Terminal_Gui_MouseEvent__" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun(Terminal.Gui.MainLoop,System.Action{Terminal.Gui.KeyEvent},System.Action{Terminal.Gui.KeyEvent},System.Action{Terminal.Gui.KeyEvent},System.Action{Terminal.Gui.MouseEvent})">PrepareToRun(MainLoop, Action&lt;KeyEvent&gt;, Action&lt;KeyEvent&gt;, Action&lt;KeyEvent&gt;, Action&lt;MouseEvent&gt;)</h4>
  1848. <div class="markdown level1 summary">
  1849. Prepare the driver and set the key and mouse events handlers.
  1850. </div>
  1851. <div class="markdown level1 conceptual"></div>
  1852. <h5 class="decalaration">Declaration</h5>
  1853. <div class="codewrapper">
  1854. <pre><code class="lang-csharp hljs">public abstract void PrepareToRun(MainLoop mainLoop, Action&lt;KeyEvent&gt; keyHandler, Action&lt;KeyEvent&gt; keyDownHandler, Action&lt;KeyEvent&gt; keyUpHandler, Action&lt;MouseEvent&gt; mouseHandler)</code></pre>
  1855. </div>
  1856. <h5 class="parameters">Parameters</h5>
  1857. <table class="table table-bordered table-striped table-condensed">
  1858. <thead>
  1859. <tr>
  1860. <th>Type</th>
  1861. <th>Name</th>
  1862. <th>Description</th>
  1863. </tr>
  1864. </thead>
  1865. <tbody>
  1866. <tr>
  1867. <td><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></td>
  1868. <td><span class="parametername">mainLoop</span></td>
  1869. <td>The main loop.</td>
  1870. </tr>
  1871. <tr>
  1872. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  1873. <td><span class="parametername">keyHandler</span></td>
  1874. <td>The handler for ProcessKey</td>
  1875. </tr>
  1876. <tr>
  1877. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  1878. <td><span class="parametername">keyDownHandler</span></td>
  1879. <td>The handler for key down events</td>
  1880. </tr>
  1881. <tr>
  1882. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  1883. <td><span class="parametername">keyUpHandler</span></td>
  1884. <td>The handler for key up events</td>
  1885. </tr>
  1886. <tr>
  1887. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>&gt;</td>
  1888. <td><span class="parametername">mouseHandler</span></td>
  1889. <td>The handler for mouse events</td>
  1890. </tr>
  1891. </tbody>
  1892. </table>
  1893. <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
  1894. <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
  1895. <div class="markdown level1 summary">
  1896. Updates the screen to reflect all the changes that have been done to the display buffer
  1897. </div>
  1898. <div class="markdown level1 conceptual"></div>
  1899. <h5 class="decalaration">Declaration</h5>
  1900. <div class="codewrapper">
  1901. <pre><code class="lang-csharp hljs">public abstract void Refresh()</code></pre>
  1902. </div>
  1903. <a id="Terminal_Gui_ConsoleDriver_ResizeScreen_" data-uid="Terminal.Gui.ConsoleDriver.ResizeScreen*"></a>
  1904. <h4 id="Terminal_Gui_ConsoleDriver_ResizeScreen" data-uid="Terminal.Gui.ConsoleDriver.ResizeScreen">ResizeScreen()</h4>
  1905. <div class="markdown level1 summary">
  1906. Resizes the clip area when the screen is resized.
  1907. </div>
  1908. <div class="markdown level1 conceptual"></div>
  1909. <h5 class="decalaration">Declaration</h5>
  1910. <div class="codewrapper">
  1911. <pre><code class="lang-csharp hljs">public abstract void ResizeScreen()</code></pre>
  1912. </div>
  1913. <a id="Terminal_Gui_ConsoleDriver_SendKeys_" data-uid="Terminal.Gui.ConsoleDriver.SendKeys*"></a>
  1914. <h4 id="Terminal_Gui_ConsoleDriver_SendKeys_System_Char_System_ConsoleKey_System_Boolean_System_Boolean_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.SendKeys(System.Char,System.ConsoleKey,System.Boolean,System.Boolean,System.Boolean)">SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean)</h4>
  1915. <div class="markdown level1 summary">
  1916. Allows sending keys without typing on a keyboard.
  1917. </div>
  1918. <div class="markdown level1 conceptual"></div>
  1919. <h5 class="decalaration">Declaration</h5>
  1920. <div class="codewrapper">
  1921. <pre><code class="lang-csharp hljs">public abstract void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control)</code></pre>
  1922. </div>
  1923. <h5 class="parameters">Parameters</h5>
  1924. <table class="table table-bordered table-striped table-condensed">
  1925. <thead>
  1926. <tr>
  1927. <th>Type</th>
  1928. <th>Name</th>
  1929. <th>Description</th>
  1930. </tr>
  1931. </thead>
  1932. <tbody>
  1933. <tr>
  1934. <td><span class="xref">System.Char</span></td>
  1935. <td><span class="parametername">keyChar</span></td>
  1936. <td>The character key.</td>
  1937. </tr>
  1938. <tr>
  1939. <td><span class="xref">System.ConsoleKey</span></td>
  1940. <td><span class="parametername">key</span></td>
  1941. <td>The key.</td>
  1942. </tr>
  1943. <tr>
  1944. <td><span class="xref">System.Boolean</span></td>
  1945. <td><span class="parametername">shift</span></td>
  1946. <td>If shift key is sending.</td>
  1947. </tr>
  1948. <tr>
  1949. <td><span class="xref">System.Boolean</span></td>
  1950. <td><span class="parametername">alt</span></td>
  1951. <td>If alt key is sending.</td>
  1952. </tr>
  1953. <tr>
  1954. <td><span class="xref">System.Boolean</span></td>
  1955. <td><span class="parametername">control</span></td>
  1956. <td>If control key is sending.</td>
  1957. </tr>
  1958. </tbody>
  1959. </table>
  1960. <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
  1961. <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
  1962. <div class="markdown level1 summary">
  1963. Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.
  1964. </div>
  1965. <div class="markdown level1 conceptual"></div>
  1966. <h5 class="decalaration">Declaration</h5>
  1967. <div class="codewrapper">
  1968. <pre><code class="lang-csharp hljs">public abstract void SetAttribute(Attribute c)</code></pre>
  1969. </div>
  1970. <h5 class="parameters">Parameters</h5>
  1971. <table class="table table-bordered table-striped table-condensed">
  1972. <thead>
  1973. <tr>
  1974. <th>Type</th>
  1975. <th>Name</th>
  1976. <th>Description</th>
  1977. </tr>
  1978. </thead>
  1979. <tbody>
  1980. <tr>
  1981. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1982. <td><span class="parametername">c</span></td>
  1983. <td>C.</td>
  1984. </tr>
  1985. </tbody>
  1986. </table>
  1987. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  1988. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</h4>
  1989. <div class="markdown level1 summary">
  1990. Set Colors from limit sets of colors.
  1991. </div>
  1992. <div class="markdown level1 conceptual"></div>
  1993. <h5 class="decalaration">Declaration</h5>
  1994. <div class="codewrapper">
  1995. <pre><code class="lang-csharp hljs">public abstract void SetColors(ConsoleColor foreground, ConsoleColor background)</code></pre>
  1996. </div>
  1997. <h5 class="parameters">Parameters</h5>
  1998. <table class="table table-bordered table-striped table-condensed">
  1999. <thead>
  2000. <tr>
  2001. <th>Type</th>
  2002. <th>Name</th>
  2003. <th>Description</th>
  2004. </tr>
  2005. </thead>
  2006. <tbody>
  2007. <tr>
  2008. <td><span class="xref">System.ConsoleColor</span></td>
  2009. <td><span class="parametername">foreground</span></td>
  2010. <td>Foreground.</td>
  2011. </tr>
  2012. <tr>
  2013. <td><span class="xref">System.ConsoleColor</span></td>
  2014. <td><span class="parametername">background</span></td>
  2015. <td>Background.</td>
  2016. </tr>
  2017. </tbody>
  2018. </table>
  2019. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  2020. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
  2021. <div class="markdown level1 summary">
  2022. Advanced uses - set colors to any pre-set pairs, you would need to init_color
  2023. that independently with the R, G, B values.
  2024. </div>
  2025. <div class="markdown level1 conceptual"></div>
  2026. <h5 class="decalaration">Declaration</h5>
  2027. <div class="codewrapper">
  2028. <pre><code class="lang-csharp hljs">public abstract void SetColors(short foregroundColorId, short backgroundColorId)</code></pre>
  2029. </div>
  2030. <h5 class="parameters">Parameters</h5>
  2031. <table class="table table-bordered table-striped table-condensed">
  2032. <thead>
  2033. <tr>
  2034. <th>Type</th>
  2035. <th>Name</th>
  2036. <th>Description</th>
  2037. </tr>
  2038. </thead>
  2039. <tbody>
  2040. <tr>
  2041. <td><span class="xref">System.Int16</span></td>
  2042. <td><span class="parametername">foregroundColorId</span></td>
  2043. <td>Foreground color identifier.</td>
  2044. </tr>
  2045. <tr>
  2046. <td><span class="xref">System.Int16</span></td>
  2047. <td><span class="parametername">backgroundColorId</span></td>
  2048. <td>Background color identifier.</td>
  2049. </tr>
  2050. </tbody>
  2051. </table>
  2052. <a id="Terminal_Gui_ConsoleDriver_SetCursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.SetCursorVisibility*"></a>
  2053. <h4 id="Terminal_Gui_ConsoleDriver_SetCursorVisibility_Terminal_Gui_CursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.SetCursorVisibility(Terminal.Gui.CursorVisibility)">SetCursorVisibility(CursorVisibility)</h4>
  2054. <div class="markdown level1 summary">
  2055. Change the cursor caret visibility
  2056. </div>
  2057. <div class="markdown level1 conceptual"></div>
  2058. <h5 class="decalaration">Declaration</h5>
  2059. <div class="codewrapper">
  2060. <pre><code class="lang-csharp hljs">public abstract bool SetCursorVisibility(CursorVisibility visibility)</code></pre>
  2061. </div>
  2062. <h5 class="parameters">Parameters</h5>
  2063. <table class="table table-bordered table-striped table-condensed">
  2064. <thead>
  2065. <tr>
  2066. <th>Type</th>
  2067. <th>Name</th>
  2068. <th>Description</th>
  2069. </tr>
  2070. </thead>
  2071. <tbody>
  2072. <tr>
  2073. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  2074. <td><span class="parametername">visibility</span></td>
  2075. <td>The wished <a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  2076. </tr>
  2077. </tbody>
  2078. </table>
  2079. <h5 class="returns">Returns</h5>
  2080. <table class="table table-bordered table-striped table-condensed">
  2081. <thead>
  2082. <tr>
  2083. <th>Type</th>
  2084. <th>Description</th>
  2085. </tr>
  2086. </thead>
  2087. <tbody>
  2088. <tr>
  2089. <td><span class="xref">System.Boolean</span></td>
  2090. <td>true upon success</td>
  2091. </tr>
  2092. </tbody>
  2093. </table>
  2094. <a id="Terminal_Gui_ConsoleDriver_SetTerminalResized_" data-uid="Terminal.Gui.ConsoleDriver.SetTerminalResized*"></a>
  2095. <h4 id="Terminal_Gui_ConsoleDriver_SetTerminalResized_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.SetTerminalResized(System.Action)">SetTerminalResized(Action)</h4>
  2096. <div class="markdown level1 summary">
  2097. Set the handler when the terminal is resized.
  2098. </div>
  2099. <div class="markdown level1 conceptual"></div>
  2100. <h5 class="decalaration">Declaration</h5>
  2101. <div class="codewrapper">
  2102. <pre><code class="lang-csharp hljs">public void SetTerminalResized(Action terminalResized)</code></pre>
  2103. </div>
  2104. <h5 class="parameters">Parameters</h5>
  2105. <table class="table table-bordered table-striped table-condensed">
  2106. <thead>
  2107. <tr>
  2108. <th>Type</th>
  2109. <th>Name</th>
  2110. <th>Description</th>
  2111. </tr>
  2112. </thead>
  2113. <tbody>
  2114. <tr>
  2115. <td><span class="xref">System.Action</span></td>
  2116. <td><span class="parametername">terminalResized</span></td>
  2117. <td></td>
  2118. </tr>
  2119. </tbody>
  2120. </table>
  2121. <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
  2122. <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</h4>
  2123. <div class="markdown level1 summary">
  2124. Start of mouse moves.
  2125. </div>
  2126. <div class="markdown level1 conceptual"></div>
  2127. <h5 class="decalaration">Declaration</h5>
  2128. <div class="codewrapper">
  2129. <pre><code class="lang-csharp hljs">public abstract void StartReportingMouseMoves()</code></pre>
  2130. </div>
  2131. <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
  2132. <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</h4>
  2133. <div class="markdown level1 summary">
  2134. Stop reporting mouses moves.
  2135. </div>
  2136. <div class="markdown level1 conceptual"></div>
  2137. <h5 class="decalaration">Declaration</h5>
  2138. <div class="codewrapper">
  2139. <pre><code class="lang-csharp hljs">public abstract void StopReportingMouseMoves()</code></pre>
  2140. </div>
  2141. <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
  2142. <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
  2143. <div class="markdown level1 summary">
  2144. Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.
  2145. </div>
  2146. <div class="markdown level1 conceptual"></div>
  2147. <h5 class="decalaration">Declaration</h5>
  2148. <div class="codewrapper">
  2149. <pre><code class="lang-csharp hljs">public abstract void Suspend()</code></pre>
  2150. </div>
  2151. <a id="Terminal_Gui_ConsoleDriver_UncookMouse_" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse*"></a>
  2152. <h4 id="Terminal_Gui_ConsoleDriver_UncookMouse" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse">UncookMouse()</h4>
  2153. <div class="markdown level1 summary">
  2154. Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked.
  2155. </div>
  2156. <div class="markdown level1 conceptual"></div>
  2157. <h5 class="decalaration">Declaration</h5>
  2158. <div class="codewrapper">
  2159. <pre><code class="lang-csharp hljs">public abstract void UncookMouse()</code></pre>
  2160. </div>
  2161. <a id="Terminal_Gui_ConsoleDriver_UpdateCursor_" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor*"></a>
  2162. <h4 id="Terminal_Gui_ConsoleDriver_UpdateCursor" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor">UpdateCursor()</h4>
  2163. <div class="markdown level1 summary">
  2164. Updates the location of the cursor position
  2165. </div>
  2166. <div class="markdown level1 conceptual"></div>
  2167. <h5 class="decalaration">Declaration</h5>
  2168. <div class="codewrapper">
  2169. <pre><code class="lang-csharp hljs">public abstract void UpdateCursor()</code></pre>
  2170. </div>
  2171. <a id="Terminal_Gui_ConsoleDriver_UpdateOffScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateOffScreen*"></a>
  2172. <h4 id="Terminal_Gui_ConsoleDriver_UpdateOffScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateOffScreen">UpdateOffScreen()</h4>
  2173. <div class="markdown level1 summary">
  2174. Reset and recreate the contents and the driver buffer.
  2175. </div>
  2176. <div class="markdown level1 conceptual"></div>
  2177. <h5 class="decalaration">Declaration</h5>
  2178. <div class="codewrapper">
  2179. <pre><code class="lang-csharp hljs">public abstract void UpdateOffScreen()</code></pre>
  2180. </div>
  2181. <a id="Terminal_Gui_ConsoleDriver_UpdateScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen*"></a>
  2182. <h4 id="Terminal_Gui_ConsoleDriver_UpdateScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen">UpdateScreen()</h4>
  2183. <div class="markdown level1 summary">
  2184. Redraws the physical screen with the contents that have been queued up via any of the printing commands.
  2185. </div>
  2186. <div class="markdown level1 conceptual"></div>
  2187. <h5 class="decalaration">Declaration</h5>
  2188. <div class="codewrapper">
  2189. <pre><code class="lang-csharp hljs">public abstract void UpdateScreen()</code></pre>
  2190. </div>
  2191. </article>
  2192. </div>
  2193. <div class="hidden-sm col-md-2" role="complementary">
  2194. <div class="sideaffix">
  2195. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  2196. <h5>In This Article</h5>
  2197. <div></div>
  2198. </nav>
  2199. </div>
  2200. </div>
  2201. </div>
  2202. </div>
  2203. <footer>
  2204. <div class="grad-bottom"></div>
  2205. <div class="footer">
  2206. <div class="container">
  2207. <span class="pull-right">
  2208. <a href="#top">Back to top</a>
  2209. </span>
  2210. <span>Generated by <strong>DocFX</strong></span>
  2211. </div>
  2212. </div>
  2213. </footer>
  2214. </div>
  2215. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  2216. <script type="text/javascript" src="../../styles/docfx.js"></script>
  2217. <script type="text/javascript" src="../../styles/main.js"></script>
  2218. </body>
  2219. </html>