Terminal.Gui.ConsoleDriver.html 66 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883
  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.56.7.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.ConsoleDriver">
  73. <h1 id="Terminal_Gui_ConsoleDriver" data-uid="Terminal.Gui.ConsoleDriver" class="text-break">Class ConsoleDriver
  74. </h1>
  75. <div class="markdown level0 summary">
  76. ConsoleDriver is an abstract class that defines the requirements for a console driver.
  77. 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.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">ConsoleDriver</span></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.FakeDriver.html">FakeDriver</a></div>
  85. </div>
  86. <div class="inheritedMembers">
  87. <h5>Inherited Members</h5>
  88. <div>
  89. <span class="xref">System.Object.Equals(System.Object)</span>
  90. </div>
  91. <div>
  92. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.GetHashCode()</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.GetType()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.MemberwiseClone()</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Object.ToString()</span>
  108. </div>
  109. </div>
  110. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  111. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  112. <h5 id="Terminal_Gui_ConsoleDriver_syntax">Syntax</h5>
  113. <div class="codewrapper">
  114. <pre><code class="lang-csharp hljs">public abstract class ConsoleDriver</code></pre>
  115. </div>
  116. <h3 id="fields">Fields
  117. </h3>
  118. <h4 id="Terminal_Gui_ConsoleDriver_BottomTee" data-uid="Terminal.Gui.ConsoleDriver.BottomTee">BottomTee</h4>
  119. <div class="markdown level1 summary">
  120. The bottom tee.
  121. </div>
  122. <div class="markdown level1 conceptual"></div>
  123. <h5 class="decalaration">Declaration</h5>
  124. <div class="codewrapper">
  125. <pre><code class="lang-csharp hljs">public Rune BottomTee</code></pre>
  126. </div>
  127. <h5 class="fieldValue">Field Value</h5>
  128. <table class="table table-bordered table-striped table-condensed">
  129. <thead>
  130. <tr>
  131. <th>Type</th>
  132. <th>Description</th>
  133. </tr>
  134. </thead>
  135. <tbody>
  136. <tr>
  137. <td><span class="xref">System.Rune</span></td>
  138. <td></td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. <h4 id="Terminal_Gui_ConsoleDriver_Checked" data-uid="Terminal.Gui.ConsoleDriver.Checked">Checked</h4>
  143. <div class="markdown level1 summary">
  144. Checkmark.
  145. </div>
  146. <div class="markdown level1 conceptual"></div>
  147. <h5 class="decalaration">Declaration</h5>
  148. <div class="codewrapper">
  149. <pre><code class="lang-csharp hljs">public Rune Checked</code></pre>
  150. </div>
  151. <h5 class="fieldValue">Field Value</h5>
  152. <table class="table table-bordered table-striped table-condensed">
  153. <thead>
  154. <tr>
  155. <th>Type</th>
  156. <th>Description</th>
  157. </tr>
  158. </thead>
  159. <tbody>
  160. <tr>
  161. <td><span class="xref">System.Rune</span></td>
  162. <td></td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <h4 id="Terminal_Gui_ConsoleDriver_Diamond" data-uid="Terminal.Gui.ConsoleDriver.Diamond">Diamond</h4>
  167. <div class="markdown level1 summary">
  168. Diamond character
  169. </div>
  170. <div class="markdown level1 conceptual"></div>
  171. <h5 class="decalaration">Declaration</h5>
  172. <div class="codewrapper">
  173. <pre><code class="lang-csharp hljs">public Rune Diamond</code></pre>
  174. </div>
  175. <h5 class="fieldValue">Field Value</h5>
  176. <table class="table table-bordered table-striped table-condensed">
  177. <thead>
  178. <tr>
  179. <th>Type</th>
  180. <th>Description</th>
  181. </tr>
  182. </thead>
  183. <tbody>
  184. <tr>
  185. <td><span class="xref">System.Rune</span></td>
  186. <td></td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. <h4 id="Terminal_Gui_ConsoleDriver_DownArrow" data-uid="Terminal.Gui.ConsoleDriver.DownArrow">DownArrow</h4>
  191. <div class="markdown level1 summary">
  192. Down Arrow.
  193. </div>
  194. <div class="markdown level1 conceptual"></div>
  195. <h5 class="decalaration">Declaration</h5>
  196. <div class="codewrapper">
  197. <pre><code class="lang-csharp hljs">public Rune DownArrow</code></pre>
  198. </div>
  199. <h5 class="fieldValue">Field Value</h5>
  200. <table class="table table-bordered table-striped table-condensed">
  201. <thead>
  202. <tr>
  203. <th>Type</th>
  204. <th>Description</th>
  205. </tr>
  206. </thead>
  207. <tbody>
  208. <tr>
  209. <td><span class="xref">System.Rune</span></td>
  210. <td></td>
  211. </tr>
  212. </tbody>
  213. </table>
  214. <h4 id="Terminal_Gui_ConsoleDriver_HLine" data-uid="Terminal.Gui.ConsoleDriver.HLine">HLine</h4>
  215. <div class="markdown level1 summary">
  216. Horizontal line character.
  217. </div>
  218. <div class="markdown level1 conceptual"></div>
  219. <h5 class="decalaration">Declaration</h5>
  220. <div class="codewrapper">
  221. <pre><code class="lang-csharp hljs">public Rune HLine</code></pre>
  222. </div>
  223. <h5 class="fieldValue">Field Value</h5>
  224. <table class="table table-bordered table-striped table-condensed">
  225. <thead>
  226. <tr>
  227. <th>Type</th>
  228. <th>Description</th>
  229. </tr>
  230. </thead>
  231. <tbody>
  232. <tr>
  233. <td><span class="xref">System.Rune</span></td>
  234. <td></td>
  235. </tr>
  236. </tbody>
  237. </table>
  238. <h4 id="Terminal_Gui_ConsoleDriver_LeftArrow" data-uid="Terminal.Gui.ConsoleDriver.LeftArrow">LeftArrow</h4>
  239. <div class="markdown level1 summary">
  240. Left Arrow.
  241. </div>
  242. <div class="markdown level1 conceptual"></div>
  243. <h5 class="decalaration">Declaration</h5>
  244. <div class="codewrapper">
  245. <pre><code class="lang-csharp hljs">public Rune LeftArrow</code></pre>
  246. </div>
  247. <h5 class="fieldValue">Field Value</h5>
  248. <table class="table table-bordered table-striped table-condensed">
  249. <thead>
  250. <tr>
  251. <th>Type</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><span class="xref">System.Rune</span></td>
  258. <td></td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. <h4 id="Terminal_Gui_ConsoleDriver_LeftBracket" data-uid="Terminal.Gui.ConsoleDriver.LeftBracket">LeftBracket</h4>
  263. <div class="markdown level1 summary">
  264. Left frame/bracket (e.g. &apos;[&apos; for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  265. </div>
  266. <div class="markdown level1 conceptual"></div>
  267. <h5 class="decalaration">Declaration</h5>
  268. <div class="codewrapper">
  269. <pre><code class="lang-csharp hljs">public Rune LeftBracket</code></pre>
  270. </div>
  271. <h5 class="fieldValue">Field Value</h5>
  272. <table class="table table-bordered table-striped table-condensed">
  273. <thead>
  274. <tr>
  275. <th>Type</th>
  276. <th>Description</th>
  277. </tr>
  278. </thead>
  279. <tbody>
  280. <tr>
  281. <td><span class="xref">System.Rune</span></td>
  282. <td></td>
  283. </tr>
  284. </tbody>
  285. </table>
  286. <h4 id="Terminal_Gui_ConsoleDriver_LeftDefaultIndicator" data-uid="Terminal.Gui.ConsoleDriver.LeftDefaultIndicator">LeftDefaultIndicator</h4>
  287. <div class="markdown level1 summary">
  288. Left indicator for default action (e.g. for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  289. </div>
  290. <div class="markdown level1 conceptual"></div>
  291. <h5 class="decalaration">Declaration</h5>
  292. <div class="codewrapper">
  293. <pre><code class="lang-csharp hljs">public Rune LeftDefaultIndicator</code></pre>
  294. </div>
  295. <h5 class="fieldValue">Field Value</h5>
  296. <table class="table table-bordered table-striped table-condensed">
  297. <thead>
  298. <tr>
  299. <th>Type</th>
  300. <th>Description</th>
  301. </tr>
  302. </thead>
  303. <tbody>
  304. <tr>
  305. <td><span class="xref">System.Rune</span></td>
  306. <td></td>
  307. </tr>
  308. </tbody>
  309. </table>
  310. <h4 id="Terminal_Gui_ConsoleDriver_LeftTee" data-uid="Terminal.Gui.ConsoleDriver.LeftTee">LeftTee</h4>
  311. <div class="markdown level1 summary">
  312. Left tee
  313. </div>
  314. <div class="markdown level1 conceptual"></div>
  315. <h5 class="decalaration">Declaration</h5>
  316. <div class="codewrapper">
  317. <pre><code class="lang-csharp hljs">public Rune LeftTee</code></pre>
  318. </div>
  319. <h5 class="fieldValue">Field Value</h5>
  320. <table class="table table-bordered table-striped table-condensed">
  321. <thead>
  322. <tr>
  323. <th>Type</th>
  324. <th>Description</th>
  325. </tr>
  326. </thead>
  327. <tbody>
  328. <tr>
  329. <td><span class="xref">System.Rune</span></td>
  330. <td></td>
  331. </tr>
  332. </tbody>
  333. </table>
  334. <h4 id="Terminal_Gui_ConsoleDriver_LLCorner" data-uid="Terminal.Gui.ConsoleDriver.LLCorner">LLCorner</h4>
  335. <div class="markdown level1 summary">
  336. Lower left corner
  337. </div>
  338. <div class="markdown level1 conceptual"></div>
  339. <h5 class="decalaration">Declaration</h5>
  340. <div class="codewrapper">
  341. <pre><code class="lang-csharp hljs">public Rune LLCorner</code></pre>
  342. </div>
  343. <h5 class="fieldValue">Field Value</h5>
  344. <table class="table table-bordered table-striped table-condensed">
  345. <thead>
  346. <tr>
  347. <th>Type</th>
  348. <th>Description</th>
  349. </tr>
  350. </thead>
  351. <tbody>
  352. <tr>
  353. <td><span class="xref">System.Rune</span></td>
  354. <td></td>
  355. </tr>
  356. </tbody>
  357. </table>
  358. <h4 id="Terminal_Gui_ConsoleDriver_LRCorner" data-uid="Terminal.Gui.ConsoleDriver.LRCorner">LRCorner</h4>
  359. <div class="markdown level1 summary">
  360. Lower right corner
  361. </div>
  362. <div class="markdown level1 conceptual"></div>
  363. <h5 class="decalaration">Declaration</h5>
  364. <div class="codewrapper">
  365. <pre><code class="lang-csharp hljs">public Rune LRCorner</code></pre>
  366. </div>
  367. <h5 class="fieldValue">Field Value</h5>
  368. <table class="table table-bordered table-striped table-condensed">
  369. <thead>
  370. <tr>
  371. <th>Type</th>
  372. <th>Description</th>
  373. </tr>
  374. </thead>
  375. <tbody>
  376. <tr>
  377. <td><span class="xref">System.Rune</span></td>
  378. <td></td>
  379. </tr>
  380. </tbody>
  381. </table>
  382. <h4 id="Terminal_Gui_ConsoleDriver_OffMeterSegement" data-uid="Terminal.Gui.ConsoleDriver.OffMeterSegement">OffMeterSegement</h4>
  383. <div class="markdown level1 summary">
  384. Off Segment indicator for meter views (e.g. <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a>.
  385. </div>
  386. <div class="markdown level1 conceptual"></div>
  387. <h5 class="decalaration">Declaration</h5>
  388. <div class="codewrapper">
  389. <pre><code class="lang-csharp hljs">public Rune OffMeterSegement</code></pre>
  390. </div>
  391. <h5 class="fieldValue">Field Value</h5>
  392. <table class="table table-bordered table-striped table-condensed">
  393. <thead>
  394. <tr>
  395. <th>Type</th>
  396. <th>Description</th>
  397. </tr>
  398. </thead>
  399. <tbody>
  400. <tr>
  401. <td><span class="xref">System.Rune</span></td>
  402. <td></td>
  403. </tr>
  404. </tbody>
  405. </table>
  406. <h4 id="Terminal_Gui_ConsoleDriver_OnMeterSegment" data-uid="Terminal.Gui.ConsoleDriver.OnMeterSegment">OnMeterSegment</h4>
  407. <div class="markdown level1 summary">
  408. On Segment indicator for meter views (e.g. <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a>.
  409. </div>
  410. <div class="markdown level1 conceptual"></div>
  411. <h5 class="decalaration">Declaration</h5>
  412. <div class="codewrapper">
  413. <pre><code class="lang-csharp hljs">public Rune OnMeterSegment</code></pre>
  414. </div>
  415. <h5 class="fieldValue">Field Value</h5>
  416. <table class="table table-bordered table-striped table-condensed">
  417. <thead>
  418. <tr>
  419. <th>Type</th>
  420. <th>Description</th>
  421. </tr>
  422. </thead>
  423. <tbody>
  424. <tr>
  425. <td><span class="xref">System.Rune</span></td>
  426. <td></td>
  427. </tr>
  428. </tbody>
  429. </table>
  430. <h4 id="Terminal_Gui_ConsoleDriver_RightArrow" data-uid="Terminal.Gui.ConsoleDriver.RightArrow">RightArrow</h4>
  431. <div class="markdown level1 summary">
  432. Right Arrow.
  433. </div>
  434. <div class="markdown level1 conceptual"></div>
  435. <h5 class="decalaration">Declaration</h5>
  436. <div class="codewrapper">
  437. <pre><code class="lang-csharp hljs">public Rune RightArrow</code></pre>
  438. </div>
  439. <h5 class="fieldValue">Field Value</h5>
  440. <table class="table table-bordered table-striped table-condensed">
  441. <thead>
  442. <tr>
  443. <th>Type</th>
  444. <th>Description</th>
  445. </tr>
  446. </thead>
  447. <tbody>
  448. <tr>
  449. <td><span class="xref">System.Rune</span></td>
  450. <td></td>
  451. </tr>
  452. </tbody>
  453. </table>
  454. <h4 id="Terminal_Gui_ConsoleDriver_RightBracket" data-uid="Terminal.Gui.ConsoleDriver.RightBracket">RightBracket</h4>
  455. <div class="markdown level1 summary">
  456. Right frame/bracket (e.g. &apos;]&apos; for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  457. </div>
  458. <div class="markdown level1 conceptual"></div>
  459. <h5 class="decalaration">Declaration</h5>
  460. <div class="codewrapper">
  461. <pre><code class="lang-csharp hljs">public Rune RightBracket</code></pre>
  462. </div>
  463. <h5 class="fieldValue">Field Value</h5>
  464. <table class="table table-bordered table-striped table-condensed">
  465. <thead>
  466. <tr>
  467. <th>Type</th>
  468. <th>Description</th>
  469. </tr>
  470. </thead>
  471. <tbody>
  472. <tr>
  473. <td><span class="xref">System.Rune</span></td>
  474. <td></td>
  475. </tr>
  476. </tbody>
  477. </table>
  478. <h4 id="Terminal_Gui_ConsoleDriver_RightDefaultIndicator" data-uid="Terminal.Gui.ConsoleDriver.RightDefaultIndicator">RightDefaultIndicator</h4>
  479. <div class="markdown level1 summary">
  480. Right indicator for default action (e.g. for <a class="xref" href="Terminal.Gui.Button.html">Button</a>).
  481. </div>
  482. <div class="markdown level1 conceptual"></div>
  483. <h5 class="decalaration">Declaration</h5>
  484. <div class="codewrapper">
  485. <pre><code class="lang-csharp hljs">public Rune RightDefaultIndicator</code></pre>
  486. </div>
  487. <h5 class="fieldValue">Field Value</h5>
  488. <table class="table table-bordered table-striped table-condensed">
  489. <thead>
  490. <tr>
  491. <th>Type</th>
  492. <th>Description</th>
  493. </tr>
  494. </thead>
  495. <tbody>
  496. <tr>
  497. <td><span class="xref">System.Rune</span></td>
  498. <td></td>
  499. </tr>
  500. </tbody>
  501. </table>
  502. <h4 id="Terminal_Gui_ConsoleDriver_RightTee" data-uid="Terminal.Gui.ConsoleDriver.RightTee">RightTee</h4>
  503. <div class="markdown level1 summary">
  504. Right tee
  505. </div>
  506. <div class="markdown level1 conceptual"></div>
  507. <h5 class="decalaration">Declaration</h5>
  508. <div class="codewrapper">
  509. <pre><code class="lang-csharp hljs">public Rune RightTee</code></pre>
  510. </div>
  511. <h5 class="fieldValue">Field Value</h5>
  512. <table class="table table-bordered table-striped table-condensed">
  513. <thead>
  514. <tr>
  515. <th>Type</th>
  516. <th>Description</th>
  517. </tr>
  518. </thead>
  519. <tbody>
  520. <tr>
  521. <td><span class="xref">System.Rune</span></td>
  522. <td></td>
  523. </tr>
  524. </tbody>
  525. </table>
  526. <h4 id="Terminal_Gui_ConsoleDriver_Selected" data-uid="Terminal.Gui.ConsoleDriver.Selected">Selected</h4>
  527. <div class="markdown level1 summary">
  528. Selected mark.
  529. </div>
  530. <div class="markdown level1 conceptual"></div>
  531. <h5 class="decalaration">Declaration</h5>
  532. <div class="codewrapper">
  533. <pre><code class="lang-csharp hljs">public Rune Selected</code></pre>
  534. </div>
  535. <h5 class="fieldValue">Field Value</h5>
  536. <table class="table table-bordered table-striped table-condensed">
  537. <thead>
  538. <tr>
  539. <th>Type</th>
  540. <th>Description</th>
  541. </tr>
  542. </thead>
  543. <tbody>
  544. <tr>
  545. <td><span class="xref">System.Rune</span></td>
  546. <td></td>
  547. </tr>
  548. </tbody>
  549. </table>
  550. <h4 id="Terminal_Gui_ConsoleDriver_Stipple" data-uid="Terminal.Gui.ConsoleDriver.Stipple">Stipple</h4>
  551. <div class="markdown level1 summary">
  552. Stipple pattern
  553. </div>
  554. <div class="markdown level1 conceptual"></div>
  555. <h5 class="decalaration">Declaration</h5>
  556. <div class="codewrapper">
  557. <pre><code class="lang-csharp hljs">public Rune Stipple</code></pre>
  558. </div>
  559. <h5 class="fieldValue">Field Value</h5>
  560. <table class="table table-bordered table-striped table-condensed">
  561. <thead>
  562. <tr>
  563. <th>Type</th>
  564. <th>Description</th>
  565. </tr>
  566. </thead>
  567. <tbody>
  568. <tr>
  569. <td><span class="xref">System.Rune</span></td>
  570. <td></td>
  571. </tr>
  572. </tbody>
  573. </table>
  574. <h4 id="Terminal_Gui_ConsoleDriver_TerminalResized" data-uid="Terminal.Gui.ConsoleDriver.TerminalResized">TerminalResized</h4>
  575. <div class="markdown level1 summary">
  576. The handler fired when the terminal is resized.
  577. </div>
  578. <div class="markdown level1 conceptual"></div>
  579. <h5 class="decalaration">Declaration</h5>
  580. <div class="codewrapper">
  581. <pre><code class="lang-csharp hljs">protected Action TerminalResized</code></pre>
  582. </div>
  583. <h5 class="fieldValue">Field Value</h5>
  584. <table class="table table-bordered table-striped table-condensed">
  585. <thead>
  586. <tr>
  587. <th>Type</th>
  588. <th>Description</th>
  589. </tr>
  590. </thead>
  591. <tbody>
  592. <tr>
  593. <td><span class="xref">System.Action</span></td>
  594. <td></td>
  595. </tr>
  596. </tbody>
  597. </table>
  598. <h4 id="Terminal_Gui_ConsoleDriver_TopTee" data-uid="Terminal.Gui.ConsoleDriver.TopTee">TopTee</h4>
  599. <div class="markdown level1 summary">
  600. Top tee
  601. </div>
  602. <div class="markdown level1 conceptual"></div>
  603. <h5 class="decalaration">Declaration</h5>
  604. <div class="codewrapper">
  605. <pre><code class="lang-csharp hljs">public Rune TopTee</code></pre>
  606. </div>
  607. <h5 class="fieldValue">Field Value</h5>
  608. <table class="table table-bordered table-striped table-condensed">
  609. <thead>
  610. <tr>
  611. <th>Type</th>
  612. <th>Description</th>
  613. </tr>
  614. </thead>
  615. <tbody>
  616. <tr>
  617. <td><span class="xref">System.Rune</span></td>
  618. <td></td>
  619. </tr>
  620. </tbody>
  621. </table>
  622. <h4 id="Terminal_Gui_ConsoleDriver_ULCorner" data-uid="Terminal.Gui.ConsoleDriver.ULCorner">ULCorner</h4>
  623. <div class="markdown level1 summary">
  624. Upper left corner
  625. </div>
  626. <div class="markdown level1 conceptual"></div>
  627. <h5 class="decalaration">Declaration</h5>
  628. <div class="codewrapper">
  629. <pre><code class="lang-csharp hljs">public Rune ULCorner</code></pre>
  630. </div>
  631. <h5 class="fieldValue">Field Value</h5>
  632. <table class="table table-bordered table-striped table-condensed">
  633. <thead>
  634. <tr>
  635. <th>Type</th>
  636. <th>Description</th>
  637. </tr>
  638. </thead>
  639. <tbody>
  640. <tr>
  641. <td><span class="xref">System.Rune</span></td>
  642. <td></td>
  643. </tr>
  644. </tbody>
  645. </table>
  646. <h4 id="Terminal_Gui_ConsoleDriver_UnChecked" data-uid="Terminal.Gui.ConsoleDriver.UnChecked">UnChecked</h4>
  647. <div class="markdown level1 summary">
  648. Un-checked checkmark.
  649. </div>
  650. <div class="markdown level1 conceptual"></div>
  651. <h5 class="decalaration">Declaration</h5>
  652. <div class="codewrapper">
  653. <pre><code class="lang-csharp hljs">public Rune UnChecked</code></pre>
  654. </div>
  655. <h5 class="fieldValue">Field Value</h5>
  656. <table class="table table-bordered table-striped table-condensed">
  657. <thead>
  658. <tr>
  659. <th>Type</th>
  660. <th>Description</th>
  661. </tr>
  662. </thead>
  663. <tbody>
  664. <tr>
  665. <td><span class="xref">System.Rune</span></td>
  666. <td></td>
  667. </tr>
  668. </tbody>
  669. </table>
  670. <h4 id="Terminal_Gui_ConsoleDriver_UnSelected" data-uid="Terminal.Gui.ConsoleDriver.UnSelected">UnSelected</h4>
  671. <div class="markdown level1 summary">
  672. Un-selected selected mark.
  673. </div>
  674. <div class="markdown level1 conceptual"></div>
  675. <h5 class="decalaration">Declaration</h5>
  676. <div class="codewrapper">
  677. <pre><code class="lang-csharp hljs">public Rune UnSelected</code></pre>
  678. </div>
  679. <h5 class="fieldValue">Field Value</h5>
  680. <table class="table table-bordered table-striped table-condensed">
  681. <thead>
  682. <tr>
  683. <th>Type</th>
  684. <th>Description</th>
  685. </tr>
  686. </thead>
  687. <tbody>
  688. <tr>
  689. <td><span class="xref">System.Rune</span></td>
  690. <td></td>
  691. </tr>
  692. </tbody>
  693. </table>
  694. <h4 id="Terminal_Gui_ConsoleDriver_UpArrow" data-uid="Terminal.Gui.ConsoleDriver.UpArrow">UpArrow</h4>
  695. <div class="markdown level1 summary">
  696. Up Arrow.
  697. </div>
  698. <div class="markdown level1 conceptual"></div>
  699. <h5 class="decalaration">Declaration</h5>
  700. <div class="codewrapper">
  701. <pre><code class="lang-csharp hljs">public Rune UpArrow</code></pre>
  702. </div>
  703. <h5 class="fieldValue">Field Value</h5>
  704. <table class="table table-bordered table-striped table-condensed">
  705. <thead>
  706. <tr>
  707. <th>Type</th>
  708. <th>Description</th>
  709. </tr>
  710. </thead>
  711. <tbody>
  712. <tr>
  713. <td><span class="xref">System.Rune</span></td>
  714. <td></td>
  715. </tr>
  716. </tbody>
  717. </table>
  718. <h4 id="Terminal_Gui_ConsoleDriver_URCorner" data-uid="Terminal.Gui.ConsoleDriver.URCorner">URCorner</h4>
  719. <div class="markdown level1 summary">
  720. Upper right corner
  721. </div>
  722. <div class="markdown level1 conceptual"></div>
  723. <h5 class="decalaration">Declaration</h5>
  724. <div class="codewrapper">
  725. <pre><code class="lang-csharp hljs">public Rune URCorner</code></pre>
  726. </div>
  727. <h5 class="fieldValue">Field Value</h5>
  728. <table class="table table-bordered table-striped table-condensed">
  729. <thead>
  730. <tr>
  731. <th>Type</th>
  732. <th>Description</th>
  733. </tr>
  734. </thead>
  735. <tbody>
  736. <tr>
  737. <td><span class="xref">System.Rune</span></td>
  738. <td></td>
  739. </tr>
  740. </tbody>
  741. </table>
  742. <h4 id="Terminal_Gui_ConsoleDriver_VLine" data-uid="Terminal.Gui.ConsoleDriver.VLine">VLine</h4>
  743. <div class="markdown level1 summary">
  744. Vertical line character.
  745. </div>
  746. <div class="markdown level1 conceptual"></div>
  747. <h5 class="decalaration">Declaration</h5>
  748. <div class="codewrapper">
  749. <pre><code class="lang-csharp hljs">public Rune VLine</code></pre>
  750. </div>
  751. <h5 class="fieldValue">Field Value</h5>
  752. <table class="table table-bordered table-striped table-condensed">
  753. <thead>
  754. <tr>
  755. <th>Type</th>
  756. <th>Description</th>
  757. </tr>
  758. </thead>
  759. <tbody>
  760. <tr>
  761. <td><span class="xref">System.Rune</span></td>
  762. <td></td>
  763. </tr>
  764. </tbody>
  765. </table>
  766. <h3 id="properties">Properties
  767. </h3>
  768. <a id="Terminal_Gui_ConsoleDriver_Clip_" data-uid="Terminal.Gui.ConsoleDriver.Clip*"></a>
  769. <h4 id="Terminal_Gui_ConsoleDriver_Clip" data-uid="Terminal.Gui.ConsoleDriver.Clip">Clip</h4>
  770. <div class="markdown level1 summary">
  771. Controls the current clipping region that AddRune/AddStr is subject to.
  772. </div>
  773. <div class="markdown level1 conceptual"></div>
  774. <h5 class="decalaration">Declaration</h5>
  775. <div class="codewrapper">
  776. <pre><code class="lang-csharp hljs">public Rect Clip { get; set; }</code></pre>
  777. </div>
  778. <h5 class="propertyValue">Property Value</h5>
  779. <table class="table table-bordered table-striped table-condensed">
  780. <thead>
  781. <tr>
  782. <th>Type</th>
  783. <th>Description</th>
  784. </tr>
  785. </thead>
  786. <tbody>
  787. <tr>
  788. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  789. <td>The clip.</td>
  790. </tr>
  791. </tbody>
  792. </table>
  793. <a id="Terminal_Gui_ConsoleDriver_Cols_" data-uid="Terminal.Gui.ConsoleDriver.Cols*"></a>
  794. <h4 id="Terminal_Gui_ConsoleDriver_Cols" data-uid="Terminal.Gui.ConsoleDriver.Cols">Cols</h4>
  795. <div class="markdown level1 summary">
  796. The current number of columns in the terminal.
  797. </div>
  798. <div class="markdown level1 conceptual"></div>
  799. <h5 class="decalaration">Declaration</h5>
  800. <div class="codewrapper">
  801. <pre><code class="lang-csharp hljs">public abstract int Cols { get; }</code></pre>
  802. </div>
  803. <h5 class="propertyValue">Property Value</h5>
  804. <table class="table table-bordered table-striped table-condensed">
  805. <thead>
  806. <tr>
  807. <th>Type</th>
  808. <th>Description</th>
  809. </tr>
  810. </thead>
  811. <tbody>
  812. <tr>
  813. <td><span class="xref">System.Int32</span></td>
  814. <td></td>
  815. </tr>
  816. </tbody>
  817. </table>
  818. <a id="Terminal_Gui_ConsoleDriver_Diagnostics_" data-uid="Terminal.Gui.ConsoleDriver.Diagnostics*"></a>
  819. <h4 id="Terminal_Gui_ConsoleDriver_Diagnostics" data-uid="Terminal.Gui.ConsoleDriver.Diagnostics">Diagnostics</h4>
  820. <div class="markdown level1 summary">
  821. Set flags to enable/disable <a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a> diagnostics.
  822. </div>
  823. <div class="markdown level1 conceptual"></div>
  824. <h5 class="decalaration">Declaration</h5>
  825. <div class="codewrapper">
  826. <pre><code class="lang-csharp hljs">public static ConsoleDriver.DiagnosticFlags Diagnostics { get; set; }</code></pre>
  827. </div>
  828. <h5 class="propertyValue">Property Value</h5>
  829. <table class="table table-bordered table-striped table-condensed">
  830. <thead>
  831. <tr>
  832. <th>Type</th>
  833. <th>Description</th>
  834. </tr>
  835. </thead>
  836. <tbody>
  837. <tr>
  838. <td><a class="xref" href="Terminal.Gui.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></td>
  839. <td></td>
  840. </tr>
  841. </tbody>
  842. </table>
  843. <a id="Terminal_Gui_ConsoleDriver_HeightAsBuffer_" data-uid="Terminal.Gui.ConsoleDriver.HeightAsBuffer*"></a>
  844. <h4 id="Terminal_Gui_ConsoleDriver_HeightAsBuffer" data-uid="Terminal.Gui.ConsoleDriver.HeightAsBuffer">HeightAsBuffer</h4>
  845. <div class="markdown level1 summary">
  846. If false height is measured by the window height and thus no scrolling.
  847. If true then height is measured by the buffer height, enabling scrolling.
  848. </div>
  849. <div class="markdown level1 conceptual"></div>
  850. <h5 class="decalaration">Declaration</h5>
  851. <div class="codewrapper">
  852. <pre><code class="lang-csharp hljs">public abstract bool HeightAsBuffer { get; set; }</code></pre>
  853. </div>
  854. <h5 class="propertyValue">Property Value</h5>
  855. <table class="table table-bordered table-striped table-condensed">
  856. <thead>
  857. <tr>
  858. <th>Type</th>
  859. <th>Description</th>
  860. </tr>
  861. </thead>
  862. <tbody>
  863. <tr>
  864. <td><span class="xref">System.Boolean</span></td>
  865. <td></td>
  866. </tr>
  867. </tbody>
  868. </table>
  869. <a id="Terminal_Gui_ConsoleDriver_Rows_" data-uid="Terminal.Gui.ConsoleDriver.Rows*"></a>
  870. <h4 id="Terminal_Gui_ConsoleDriver_Rows" data-uid="Terminal.Gui.ConsoleDriver.Rows">Rows</h4>
  871. <div class="markdown level1 summary">
  872. The current number of rows in the terminal.
  873. </div>
  874. <div class="markdown level1 conceptual"></div>
  875. <h5 class="decalaration">Declaration</h5>
  876. <div class="codewrapper">
  877. <pre><code class="lang-csharp hljs">public abstract int Rows { get; }</code></pre>
  878. </div>
  879. <h5 class="propertyValue">Property Value</h5>
  880. <table class="table table-bordered table-striped table-condensed">
  881. <thead>
  882. <tr>
  883. <th>Type</th>
  884. <th>Description</th>
  885. </tr>
  886. </thead>
  887. <tbody>
  888. <tr>
  889. <td><span class="xref">System.Int32</span></td>
  890. <td></td>
  891. </tr>
  892. </tbody>
  893. </table>
  894. <a id="Terminal_Gui_ConsoleDriver_Top_" data-uid="Terminal.Gui.ConsoleDriver.Top*"></a>
  895. <h4 id="Terminal_Gui_ConsoleDriver_Top" data-uid="Terminal.Gui.ConsoleDriver.Top">Top</h4>
  896. <div class="markdown level1 summary">
  897. The current top in the terminal.
  898. </div>
  899. <div class="markdown level1 conceptual"></div>
  900. <h5 class="decalaration">Declaration</h5>
  901. <div class="codewrapper">
  902. <pre><code class="lang-csharp hljs">public abstract int Top { get; }</code></pre>
  903. </div>
  904. <h5 class="propertyValue">Property Value</h5>
  905. <table class="table table-bordered table-striped table-condensed">
  906. <thead>
  907. <tr>
  908. <th>Type</th>
  909. <th>Description</th>
  910. </tr>
  911. </thead>
  912. <tbody>
  913. <tr>
  914. <td><span class="xref">System.Int32</span></td>
  915. <td></td>
  916. </tr>
  917. </tbody>
  918. </table>
  919. <h3 id="methods">Methods
  920. </h3>
  921. <a id="Terminal_Gui_ConsoleDriver_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
  922. <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
  923. <div class="markdown level1 summary">
  924. Adds the specified rune to the display at the current cursor position
  925. </div>
  926. <div class="markdown level1 conceptual"></div>
  927. <h5 class="decalaration">Declaration</h5>
  928. <div class="codewrapper">
  929. <pre><code class="lang-csharp hljs">public abstract void AddRune(Rune rune)</code></pre>
  930. </div>
  931. <h5 class="parameters">Parameters</h5>
  932. <table class="table table-bordered table-striped table-condensed">
  933. <thead>
  934. <tr>
  935. <th>Type</th>
  936. <th>Name</th>
  937. <th>Description</th>
  938. </tr>
  939. </thead>
  940. <tbody>
  941. <tr>
  942. <td><span class="xref">System.Rune</span></td>
  943. <td><span class="parametername">rune</span></td>
  944. <td>Rune to add.</td>
  945. </tr>
  946. </tbody>
  947. </table>
  948. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  949. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
  950. <div class="markdown level1 summary">
  951. Adds the specified
  952. </div>
  953. <div class="markdown level1 conceptual"></div>
  954. <h5 class="decalaration">Declaration</h5>
  955. <div class="codewrapper">
  956. <pre><code class="lang-csharp hljs">public abstract void AddStr(ustring str)</code></pre>
  957. </div>
  958. <h5 class="parameters">Parameters</h5>
  959. <table class="table table-bordered table-striped table-condensed">
  960. <thead>
  961. <tr>
  962. <th>Type</th>
  963. <th>Name</th>
  964. <th>Description</th>
  965. </tr>
  966. </thead>
  967. <tbody>
  968. <tr>
  969. <td><span class="xref">NStack.ustring</span></td>
  970. <td><span class="parametername">str</span></td>
  971. <td>String.</td>
  972. </tr>
  973. </tbody>
  974. </table>
  975. <a id="Terminal_Gui_ConsoleDriver_CookMouse_" data-uid="Terminal.Gui.ConsoleDriver.CookMouse*"></a>
  976. <h4 id="Terminal_Gui_ConsoleDriver_CookMouse" data-uid="Terminal.Gui.ConsoleDriver.CookMouse">CookMouse()</h4>
  977. <div class="markdown level1 summary">
  978. Enables the cooked event processing from the mouse driver
  979. </div>
  980. <div class="markdown level1 conceptual"></div>
  981. <h5 class="decalaration">Declaration</h5>
  982. <div class="codewrapper">
  983. <pre><code class="lang-csharp hljs">public abstract void CookMouse()</code></pre>
  984. </div>
  985. <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
  986. <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>
  987. <div class="markdown level1 summary">
  988. Draws a frame on the specified region with the specified padding around the frame.
  989. </div>
  990. <div class="markdown level1 conceptual"></div>
  991. <h5 class="decalaration">Declaration</h5>
  992. <div class="codewrapper">
  993. <pre><code class="lang-csharp hljs">public virtual void DrawFrame(Rect region, int padding, bool fill)</code></pre>
  994. </div>
  995. <h5 class="parameters">Parameters</h5>
  996. <table class="table table-bordered table-striped table-condensed">
  997. <thead>
  998. <tr>
  999. <th>Type</th>
  1000. <th>Name</th>
  1001. <th>Description</th>
  1002. </tr>
  1003. </thead>
  1004. <tbody>
  1005. <tr>
  1006. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1007. <td><span class="parametername">region</span></td>
  1008. <td>Screen relative region where the frame will be drawn.</td>
  1009. </tr>
  1010. <tr>
  1011. <td><span class="xref">System.Int32</span></td>
  1012. <td><span class="parametername">padding</span></td>
  1013. <td>Padding to add on the sides.</td>
  1014. </tr>
  1015. <tr>
  1016. <td><span class="xref">System.Boolean</span></td>
  1017. <td><span class="parametername">fill</span></td>
  1018. <td>If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.</td>
  1019. </tr>
  1020. </tbody>
  1021. </table>
  1022. <h5 id="Terminal_Gui_ConsoleDriver_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean__remarks">Remarks</h5>
  1023. <div class="markdown level1 remarks">This API has been superseded by <a class="xref" href="Terminal.Gui.ConsoleDriver.html#Terminal_Gui_ConsoleDriver_DrawWindowFrame_Terminal_Gui_Rect_System_Int32_System_Int32_System_Int32_System_Int32_System_Boolean_System_Boolean_">DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean)</a>.</div>
  1024. <a id="Terminal_Gui_ConsoleDriver_DrawWindowFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowFrame*"></a>
  1025. <h4 id="Terminal_Gui_ConsoleDriver_DrawWindowFrame_Terminal_Gui_Rect_System_Int32_System_Int32_System_Int32_System_Int32_System_Boolean_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowFrame(Terminal.Gui.Rect,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean)</h4>
  1026. <div class="markdown level1 summary">
  1027. Draws a frame for a window with padding and an optional visible border inside the padding.
  1028. </div>
  1029. <div class="markdown level1 conceptual"></div>
  1030. <h5 class="decalaration">Declaration</h5>
  1031. <div class="codewrapper">
  1032. <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)</code></pre>
  1033. </div>
  1034. <h5 class="parameters">Parameters</h5>
  1035. <table class="table table-bordered table-striped table-condensed">
  1036. <thead>
  1037. <tr>
  1038. <th>Type</th>
  1039. <th>Name</th>
  1040. <th>Description</th>
  1041. </tr>
  1042. </thead>
  1043. <tbody>
  1044. <tr>
  1045. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1046. <td><span class="parametername">region</span></td>
  1047. <td>Screen relative region where the frame will be drawn.</td>
  1048. </tr>
  1049. <tr>
  1050. <td><span class="xref">System.Int32</span></td>
  1051. <td><span class="parametername">paddingLeft</span></td>
  1052. <td>Number of columns to pad on the left (if 0 the border will not appear on the left).</td>
  1053. </tr>
  1054. <tr>
  1055. <td><span class="xref">System.Int32</span></td>
  1056. <td><span class="parametername">paddingTop</span></td>
  1057. <td>Number of rows to pad on the top (if 0 the border and title will not appear on the top).</td>
  1058. </tr>
  1059. <tr>
  1060. <td><span class="xref">System.Int32</span></td>
  1061. <td><span class="parametername">paddingRight</span></td>
  1062. <td>Number of columns to pad on the right (if 0 the border will not appear on the right).</td>
  1063. </tr>
  1064. <tr>
  1065. <td><span class="xref">System.Int32</span></td>
  1066. <td><span class="parametername">paddingBottom</span></td>
  1067. <td>Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).</td>
  1068. </tr>
  1069. <tr>
  1070. <td><span class="xref">System.Boolean</span></td>
  1071. <td><span class="parametername">border</span></td>
  1072. <td>If set to <code>true</code> and any padding dimension is > 0 the border will be drawn.</td>
  1073. </tr>
  1074. <tr>
  1075. <td><span class="xref">System.Boolean</span></td>
  1076. <td><span class="parametername">fill</span></td>
  1077. <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>
  1078. </tr>
  1079. </tbody>
  1080. </table>
  1081. <a id="Terminal_Gui_ConsoleDriver_DrawWindowTitle_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowTitle*"></a>
  1082. <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>
  1083. <div class="markdown level1 summary">
  1084. Draws the title for a Window-style view incorporating padding.
  1085. </div>
  1086. <div class="markdown level1 conceptual"></div>
  1087. <h5 class="decalaration">Declaration</h5>
  1088. <div class="codewrapper">
  1089. <pre><code class="lang-csharp hljs">public virtual void DrawWindowTitle(Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment = TextAlignment.Left)</code></pre>
  1090. </div>
  1091. <h5 class="parameters">Parameters</h5>
  1092. <table class="table table-bordered table-striped table-condensed">
  1093. <thead>
  1094. <tr>
  1095. <th>Type</th>
  1096. <th>Name</th>
  1097. <th>Description</th>
  1098. </tr>
  1099. </thead>
  1100. <tbody>
  1101. <tr>
  1102. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1103. <td><span class="parametername">region</span></td>
  1104. <td>Screen relative region where the frame will be drawn.</td>
  1105. </tr>
  1106. <tr>
  1107. <td><span class="xref">NStack.ustring</span></td>
  1108. <td><span class="parametername">title</span></td>
  1109. <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>
  1110. </tr>
  1111. <tr>
  1112. <td><span class="xref">System.Int32</span></td>
  1113. <td><span class="parametername">paddingLeft</span></td>
  1114. <td>Number of columns to pad on the left (if 0 the border will not appear on the left).</td>
  1115. </tr>
  1116. <tr>
  1117. <td><span class="xref">System.Int32</span></td>
  1118. <td><span class="parametername">paddingTop</span></td>
  1119. <td>Number of rows to pad on the top (if 0 the border and title will not appear on the top).</td>
  1120. </tr>
  1121. <tr>
  1122. <td><span class="xref">System.Int32</span></td>
  1123. <td><span class="parametername">paddingRight</span></td>
  1124. <td>Number of columns to pad on the right (if 0 the border will not appear on the right).</td>
  1125. </tr>
  1126. <tr>
  1127. <td><span class="xref">System.Int32</span></td>
  1128. <td><span class="parametername">paddingBottom</span></td>
  1129. <td>Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).</td>
  1130. </tr>
  1131. <tr>
  1132. <td><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></td>
  1133. <td><span class="parametername">textAlignment</span></td>
  1134. <td>Not yet implemented.</td>
  1135. </tr>
  1136. </tbody>
  1137. </table>
  1138. <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
  1139. <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
  1140. <div class="markdown level1 summary">
  1141. Ends the execution of the console driver.
  1142. </div>
  1143. <div class="markdown level1 conceptual"></div>
  1144. <h5 class="decalaration">Declaration</h5>
  1145. <div class="codewrapper">
  1146. <pre><code class="lang-csharp hljs">public abstract void End()</code></pre>
  1147. </div>
  1148. <a id="Terminal_Gui_ConsoleDriver_EnsureCursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.EnsureCursorVisibility*"></a>
  1149. <h4 id="Terminal_Gui_ConsoleDriver_EnsureCursorVisibility" data-uid="Terminal.Gui.ConsoleDriver.EnsureCursorVisibility">EnsureCursorVisibility()</h4>
  1150. <div class="markdown level1 summary">
  1151. Ensure the cursor visibility
  1152. </div>
  1153. <div class="markdown level1 conceptual"></div>
  1154. <h5 class="decalaration">Declaration</h5>
  1155. <div class="codewrapper">
  1156. <pre><code class="lang-csharp hljs">public abstract bool EnsureCursorVisibility()</code></pre>
  1157. </div>
  1158. <h5 class="returns">Returns</h5>
  1159. <table class="table table-bordered table-striped table-condensed">
  1160. <thead>
  1161. <tr>
  1162. <th>Type</th>
  1163. <th>Description</th>
  1164. </tr>
  1165. </thead>
  1166. <tbody>
  1167. <tr>
  1168. <td><span class="xref">System.Boolean</span></td>
  1169. <td>true upon success</td>
  1170. </tr>
  1171. </tbody>
  1172. </table>
  1173. <a id="Terminal_Gui_ConsoleDriver_GetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.GetAttribute*"></a>
  1174. <h4 id="Terminal_Gui_ConsoleDriver_GetAttribute" data-uid="Terminal.Gui.ConsoleDriver.GetAttribute">GetAttribute()</h4>
  1175. <div class="markdown level1 summary">
  1176. Gets the current <a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>.
  1177. </div>
  1178. <div class="markdown level1 conceptual"></div>
  1179. <h5 class="decalaration">Declaration</h5>
  1180. <div class="codewrapper">
  1181. <pre><code class="lang-csharp hljs">public abstract Attribute GetAttribute()</code></pre>
  1182. </div>
  1183. <h5 class="returns">Returns</h5>
  1184. <table class="table table-bordered table-striped table-condensed">
  1185. <thead>
  1186. <tr>
  1187. <th>Type</th>
  1188. <th>Description</th>
  1189. </tr>
  1190. </thead>
  1191. <tbody>
  1192. <tr>
  1193. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1194. <td>The current attribute.</td>
  1195. </tr>
  1196. </tbody>
  1197. </table>
  1198. <a id="Terminal_Gui_ConsoleDriver_GetCursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.GetCursorVisibility*"></a>
  1199. <h4 id="Terminal_Gui_ConsoleDriver_GetCursorVisibility_Terminal_Gui_CursorVisibility__" data-uid="Terminal.Gui.ConsoleDriver.GetCursorVisibility(Terminal.Gui.CursorVisibility@)">GetCursorVisibility(out CursorVisibility)</h4>
  1200. <div class="markdown level1 summary">
  1201. Retreive the cursor caret visibility
  1202. </div>
  1203. <div class="markdown level1 conceptual"></div>
  1204. <h5 class="decalaration">Declaration</h5>
  1205. <div class="codewrapper">
  1206. <pre><code class="lang-csharp hljs">public abstract bool GetCursorVisibility(out CursorVisibility visibility)</code></pre>
  1207. </div>
  1208. <h5 class="parameters">Parameters</h5>
  1209. <table class="table table-bordered table-striped table-condensed">
  1210. <thead>
  1211. <tr>
  1212. <th>Type</th>
  1213. <th>Name</th>
  1214. <th>Description</th>
  1215. </tr>
  1216. </thead>
  1217. <tbody>
  1218. <tr>
  1219. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  1220. <td><span class="parametername">visibility</span></td>
  1221. <td>The current <a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  1222. </tr>
  1223. </tbody>
  1224. </table>
  1225. <h5 class="returns">Returns</h5>
  1226. <table class="table table-bordered table-striped table-condensed">
  1227. <thead>
  1228. <tr>
  1229. <th>Type</th>
  1230. <th>Description</th>
  1231. </tr>
  1232. </thead>
  1233. <tbody>
  1234. <tr>
  1235. <td><span class="xref">System.Boolean</span></td>
  1236. <td>true upon success</td>
  1237. </tr>
  1238. </tbody>
  1239. </table>
  1240. <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
  1241. <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
  1242. <div class="markdown level1 summary">
  1243. Initializes the driver
  1244. </div>
  1245. <div class="markdown level1 conceptual"></div>
  1246. <h5 class="decalaration">Declaration</h5>
  1247. <div class="codewrapper">
  1248. <pre><code class="lang-csharp hljs">public abstract void Init(Action terminalResized)</code></pre>
  1249. </div>
  1250. <h5 class="parameters">Parameters</h5>
  1251. <table class="table table-bordered table-striped table-condensed">
  1252. <thead>
  1253. <tr>
  1254. <th>Type</th>
  1255. <th>Name</th>
  1256. <th>Description</th>
  1257. </tr>
  1258. </thead>
  1259. <tbody>
  1260. <tr>
  1261. <td><span class="xref">System.Action</span></td>
  1262. <td><span class="parametername">terminalResized</span></td>
  1263. <td>Method to invoke when the terminal is resized.</td>
  1264. </tr>
  1265. </tbody>
  1266. </table>
  1267. <a id="Terminal_Gui_ConsoleDriver_MakeAttribute_" data-uid="Terminal.Gui.ConsoleDriver.MakeAttribute*"></a>
  1268. <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>
  1269. <div class="markdown level1 summary">
  1270. Make the attribute for the foreground and background colors.
  1271. </div>
  1272. <div class="markdown level1 conceptual"></div>
  1273. <h5 class="decalaration">Declaration</h5>
  1274. <div class="codewrapper">
  1275. <pre><code class="lang-csharp hljs">public abstract Attribute MakeAttribute(Color fore, Color back)</code></pre>
  1276. </div>
  1277. <h5 class="parameters">Parameters</h5>
  1278. <table class="table table-bordered table-striped table-condensed">
  1279. <thead>
  1280. <tr>
  1281. <th>Type</th>
  1282. <th>Name</th>
  1283. <th>Description</th>
  1284. </tr>
  1285. </thead>
  1286. <tbody>
  1287. <tr>
  1288. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  1289. <td><span class="parametername">fore</span></td>
  1290. <td>Foreground.</td>
  1291. </tr>
  1292. <tr>
  1293. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  1294. <td><span class="parametername">back</span></td>
  1295. <td>Background.</td>
  1296. </tr>
  1297. </tbody>
  1298. </table>
  1299. <h5 class="returns">Returns</h5>
  1300. <table class="table table-bordered table-striped table-condensed">
  1301. <thead>
  1302. <tr>
  1303. <th>Type</th>
  1304. <th>Description</th>
  1305. </tr>
  1306. </thead>
  1307. <tbody>
  1308. <tr>
  1309. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1310. <td></td>
  1311. </tr>
  1312. </tbody>
  1313. </table>
  1314. <a id="Terminal_Gui_ConsoleDriver_MakePrintable_" data-uid="Terminal.Gui.ConsoleDriver.MakePrintable*"></a>
  1315. <h4 id="Terminal_Gui_ConsoleDriver_MakePrintable_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.MakePrintable(System.Rune)">MakePrintable(Rune)</h4>
  1316. <div class="markdown level1 summary">
  1317. Ensures a Rune is not a control character and can be displayed by translating characters below 0x20
  1318. to equivalent, printable, Unicode chars.
  1319. </div>
  1320. <div class="markdown level1 conceptual"></div>
  1321. <h5 class="decalaration">Declaration</h5>
  1322. <div class="codewrapper">
  1323. <pre><code class="lang-csharp hljs">public static Rune MakePrintable(Rune c)</code></pre>
  1324. </div>
  1325. <h5 class="parameters">Parameters</h5>
  1326. <table class="table table-bordered table-striped table-condensed">
  1327. <thead>
  1328. <tr>
  1329. <th>Type</th>
  1330. <th>Name</th>
  1331. <th>Description</th>
  1332. </tr>
  1333. </thead>
  1334. <tbody>
  1335. <tr>
  1336. <td><span class="xref">System.Rune</span></td>
  1337. <td><span class="parametername">c</span></td>
  1338. <td>Rune to translate</td>
  1339. </tr>
  1340. </tbody>
  1341. </table>
  1342. <h5 class="returns">Returns</h5>
  1343. <table class="table table-bordered table-striped table-condensed">
  1344. <thead>
  1345. <tr>
  1346. <th>Type</th>
  1347. <th>Description</th>
  1348. </tr>
  1349. </thead>
  1350. <tbody>
  1351. <tr>
  1352. <td><span class="xref">System.Rune</span></td>
  1353. <td></td>
  1354. </tr>
  1355. </tbody>
  1356. </table>
  1357. <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
  1358. <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  1359. <div class="markdown level1 summary">
  1360. Moves the cursor to the specified column and row.
  1361. </div>
  1362. <div class="markdown level1 conceptual"></div>
  1363. <h5 class="decalaration">Declaration</h5>
  1364. <div class="codewrapper">
  1365. <pre><code class="lang-csharp hljs">public abstract void Move(int col, int row)</code></pre>
  1366. </div>
  1367. <h5 class="parameters">Parameters</h5>
  1368. <table class="table table-bordered table-striped table-condensed">
  1369. <thead>
  1370. <tr>
  1371. <th>Type</th>
  1372. <th>Name</th>
  1373. <th>Description</th>
  1374. </tr>
  1375. </thead>
  1376. <tbody>
  1377. <tr>
  1378. <td><span class="xref">System.Int32</span></td>
  1379. <td><span class="parametername">col</span></td>
  1380. <td>Column to move the cursor to.</td>
  1381. </tr>
  1382. <tr>
  1383. <td><span class="xref">System.Int32</span></td>
  1384. <td><span class="parametername">row</span></td>
  1385. <td>Row to move the cursor to.</td>
  1386. </tr>
  1387. </tbody>
  1388. </table>
  1389. <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
  1390. <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>
  1391. <div class="markdown level1 summary">
  1392. Prepare the driver and set the key and mouse events handlers.
  1393. </div>
  1394. <div class="markdown level1 conceptual"></div>
  1395. <h5 class="decalaration">Declaration</h5>
  1396. <div class="codewrapper">
  1397. <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>
  1398. </div>
  1399. <h5 class="parameters">Parameters</h5>
  1400. <table class="table table-bordered table-striped table-condensed">
  1401. <thead>
  1402. <tr>
  1403. <th>Type</th>
  1404. <th>Name</th>
  1405. <th>Description</th>
  1406. </tr>
  1407. </thead>
  1408. <tbody>
  1409. <tr>
  1410. <td><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></td>
  1411. <td><span class="parametername">mainLoop</span></td>
  1412. <td>The main loop.</td>
  1413. </tr>
  1414. <tr>
  1415. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  1416. <td><span class="parametername">keyHandler</span></td>
  1417. <td>The handler for ProcessKey</td>
  1418. </tr>
  1419. <tr>
  1420. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  1421. <td><span class="parametername">keyDownHandler</span></td>
  1422. <td>The handler for key down events</td>
  1423. </tr>
  1424. <tr>
  1425. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  1426. <td><span class="parametername">keyUpHandler</span></td>
  1427. <td>The handler for key up events</td>
  1428. </tr>
  1429. <tr>
  1430. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>&gt;</td>
  1431. <td><span class="parametername">mouseHandler</span></td>
  1432. <td>The handler for mouse events</td>
  1433. </tr>
  1434. </tbody>
  1435. </table>
  1436. <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
  1437. <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
  1438. <div class="markdown level1 summary">
  1439. Updates the screen to reflect all the changes that have been done to the display buffer
  1440. </div>
  1441. <div class="markdown level1 conceptual"></div>
  1442. <h5 class="decalaration">Declaration</h5>
  1443. <div class="codewrapper">
  1444. <pre><code class="lang-csharp hljs">public abstract void Refresh()</code></pre>
  1445. </div>
  1446. <a id="Terminal_Gui_ConsoleDriver_SendKeys_" data-uid="Terminal.Gui.ConsoleDriver.SendKeys*"></a>
  1447. <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>
  1448. <div class="markdown level1 summary">
  1449. Allows sending keys without typing on a keyboard.
  1450. </div>
  1451. <div class="markdown level1 conceptual"></div>
  1452. <h5 class="decalaration">Declaration</h5>
  1453. <div class="codewrapper">
  1454. <pre><code class="lang-csharp hljs">public abstract void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control)</code></pre>
  1455. </div>
  1456. <h5 class="parameters">Parameters</h5>
  1457. <table class="table table-bordered table-striped table-condensed">
  1458. <thead>
  1459. <tr>
  1460. <th>Type</th>
  1461. <th>Name</th>
  1462. <th>Description</th>
  1463. </tr>
  1464. </thead>
  1465. <tbody>
  1466. <tr>
  1467. <td><span class="xref">System.Char</span></td>
  1468. <td><span class="parametername">keyChar</span></td>
  1469. <td>The character key.</td>
  1470. </tr>
  1471. <tr>
  1472. <td><span class="xref">System.ConsoleKey</span></td>
  1473. <td><span class="parametername">key</span></td>
  1474. <td>The key.</td>
  1475. </tr>
  1476. <tr>
  1477. <td><span class="xref">System.Boolean</span></td>
  1478. <td><span class="parametername">shift</span></td>
  1479. <td>If shift key is sending.</td>
  1480. </tr>
  1481. <tr>
  1482. <td><span class="xref">System.Boolean</span></td>
  1483. <td><span class="parametername">alt</span></td>
  1484. <td>If alt key is sending.</td>
  1485. </tr>
  1486. <tr>
  1487. <td><span class="xref">System.Boolean</span></td>
  1488. <td><span class="parametername">control</span></td>
  1489. <td>If control key is sending.</td>
  1490. </tr>
  1491. </tbody>
  1492. </table>
  1493. <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
  1494. <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
  1495. <div class="markdown level1 summary">
  1496. Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.
  1497. </div>
  1498. <div class="markdown level1 conceptual"></div>
  1499. <h5 class="decalaration">Declaration</h5>
  1500. <div class="codewrapper">
  1501. <pre><code class="lang-csharp hljs">public abstract void SetAttribute(Attribute c)</code></pre>
  1502. </div>
  1503. <h5 class="parameters">Parameters</h5>
  1504. <table class="table table-bordered table-striped table-condensed">
  1505. <thead>
  1506. <tr>
  1507. <th>Type</th>
  1508. <th>Name</th>
  1509. <th>Description</th>
  1510. </tr>
  1511. </thead>
  1512. <tbody>
  1513. <tr>
  1514. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  1515. <td><span class="parametername">c</span></td>
  1516. <td>C.</td>
  1517. </tr>
  1518. </tbody>
  1519. </table>
  1520. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  1521. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</h4>
  1522. <div class="markdown level1 summary">
  1523. Set Colors from limit sets of colors.
  1524. </div>
  1525. <div class="markdown level1 conceptual"></div>
  1526. <h5 class="decalaration">Declaration</h5>
  1527. <div class="codewrapper">
  1528. <pre><code class="lang-csharp hljs">public abstract void SetColors(ConsoleColor foreground, ConsoleColor background)</code></pre>
  1529. </div>
  1530. <h5 class="parameters">Parameters</h5>
  1531. <table class="table table-bordered table-striped table-condensed">
  1532. <thead>
  1533. <tr>
  1534. <th>Type</th>
  1535. <th>Name</th>
  1536. <th>Description</th>
  1537. </tr>
  1538. </thead>
  1539. <tbody>
  1540. <tr>
  1541. <td><span class="xref">System.ConsoleColor</span></td>
  1542. <td><span class="parametername">foreground</span></td>
  1543. <td>Foreground.</td>
  1544. </tr>
  1545. <tr>
  1546. <td><span class="xref">System.ConsoleColor</span></td>
  1547. <td><span class="parametername">background</span></td>
  1548. <td>Background.</td>
  1549. </tr>
  1550. </tbody>
  1551. </table>
  1552. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  1553. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
  1554. <div class="markdown level1 summary">
  1555. Advanced uses - set colors to any pre-set pairs, you would need to init_color
  1556. that independently with the R, G, B values.
  1557. </div>
  1558. <div class="markdown level1 conceptual"></div>
  1559. <h5 class="decalaration">Declaration</h5>
  1560. <div class="codewrapper">
  1561. <pre><code class="lang-csharp hljs">public abstract void SetColors(short foregroundColorId, short backgroundColorId)</code></pre>
  1562. </div>
  1563. <h5 class="parameters">Parameters</h5>
  1564. <table class="table table-bordered table-striped table-condensed">
  1565. <thead>
  1566. <tr>
  1567. <th>Type</th>
  1568. <th>Name</th>
  1569. <th>Description</th>
  1570. </tr>
  1571. </thead>
  1572. <tbody>
  1573. <tr>
  1574. <td><span class="xref">System.Int16</span></td>
  1575. <td><span class="parametername">foregroundColorId</span></td>
  1576. <td>Foreground color identifier.</td>
  1577. </tr>
  1578. <tr>
  1579. <td><span class="xref">System.Int16</span></td>
  1580. <td><span class="parametername">backgroundColorId</span></td>
  1581. <td>Background color identifier.</td>
  1582. </tr>
  1583. </tbody>
  1584. </table>
  1585. <a id="Terminal_Gui_ConsoleDriver_SetCursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.SetCursorVisibility*"></a>
  1586. <h4 id="Terminal_Gui_ConsoleDriver_SetCursorVisibility_Terminal_Gui_CursorVisibility_" data-uid="Terminal.Gui.ConsoleDriver.SetCursorVisibility(Terminal.Gui.CursorVisibility)">SetCursorVisibility(CursorVisibility)</h4>
  1587. <div class="markdown level1 summary">
  1588. Change the cursor caret visibility
  1589. </div>
  1590. <div class="markdown level1 conceptual"></div>
  1591. <h5 class="decalaration">Declaration</h5>
  1592. <div class="codewrapper">
  1593. <pre><code class="lang-csharp hljs">public abstract bool SetCursorVisibility(CursorVisibility visibility)</code></pre>
  1594. </div>
  1595. <h5 class="parameters">Parameters</h5>
  1596. <table class="table table-bordered table-striped table-condensed">
  1597. <thead>
  1598. <tr>
  1599. <th>Type</th>
  1600. <th>Name</th>
  1601. <th>Description</th>
  1602. </tr>
  1603. </thead>
  1604. <tbody>
  1605. <tr>
  1606. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  1607. <td><span class="parametername">visibility</span></td>
  1608. <td>The wished <a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  1609. </tr>
  1610. </tbody>
  1611. </table>
  1612. <h5 class="returns">Returns</h5>
  1613. <table class="table table-bordered table-striped table-condensed">
  1614. <thead>
  1615. <tr>
  1616. <th>Type</th>
  1617. <th>Description</th>
  1618. </tr>
  1619. </thead>
  1620. <tbody>
  1621. <tr>
  1622. <td><span class="xref">System.Boolean</span></td>
  1623. <td>true upon success</td>
  1624. </tr>
  1625. </tbody>
  1626. </table>
  1627. <a id="Terminal_Gui_ConsoleDriver_SetTerminalResized_" data-uid="Terminal.Gui.ConsoleDriver.SetTerminalResized*"></a>
  1628. <h4 id="Terminal_Gui_ConsoleDriver_SetTerminalResized_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.SetTerminalResized(System.Action)">SetTerminalResized(Action)</h4>
  1629. <div class="markdown level1 summary">
  1630. Set the handler when the terminal is resized.
  1631. </div>
  1632. <div class="markdown level1 conceptual"></div>
  1633. <h5 class="decalaration">Declaration</h5>
  1634. <div class="codewrapper">
  1635. <pre><code class="lang-csharp hljs">public void SetTerminalResized(Action terminalResized)</code></pre>
  1636. </div>
  1637. <h5 class="parameters">Parameters</h5>
  1638. <table class="table table-bordered table-striped table-condensed">
  1639. <thead>
  1640. <tr>
  1641. <th>Type</th>
  1642. <th>Name</th>
  1643. <th>Description</th>
  1644. </tr>
  1645. </thead>
  1646. <tbody>
  1647. <tr>
  1648. <td><span class="xref">System.Action</span></td>
  1649. <td><span class="parametername">terminalResized</span></td>
  1650. <td></td>
  1651. </tr>
  1652. </tbody>
  1653. </table>
  1654. <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
  1655. <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</h4>
  1656. <div class="markdown level1 summary">
  1657. Start of mouse moves.
  1658. </div>
  1659. <div class="markdown level1 conceptual"></div>
  1660. <h5 class="decalaration">Declaration</h5>
  1661. <div class="codewrapper">
  1662. <pre><code class="lang-csharp hljs">public abstract void StartReportingMouseMoves()</code></pre>
  1663. </div>
  1664. <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
  1665. <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</h4>
  1666. <div class="markdown level1 summary">
  1667. Stop reporting mouses moves.
  1668. </div>
  1669. <div class="markdown level1 conceptual"></div>
  1670. <h5 class="decalaration">Declaration</h5>
  1671. <div class="codewrapper">
  1672. <pre><code class="lang-csharp hljs">public abstract void StopReportingMouseMoves()</code></pre>
  1673. </div>
  1674. <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
  1675. <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
  1676. <div class="markdown level1 summary">
  1677. Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.
  1678. </div>
  1679. <div class="markdown level1 conceptual"></div>
  1680. <h5 class="decalaration">Declaration</h5>
  1681. <div class="codewrapper">
  1682. <pre><code class="lang-csharp hljs">public abstract void Suspend()</code></pre>
  1683. </div>
  1684. <a id="Terminal_Gui_ConsoleDriver_UncookMouse_" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse*"></a>
  1685. <h4 id="Terminal_Gui_ConsoleDriver_UncookMouse" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse">UncookMouse()</h4>
  1686. <div class="markdown level1 summary">
  1687. Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked.
  1688. </div>
  1689. <div class="markdown level1 conceptual"></div>
  1690. <h5 class="decalaration">Declaration</h5>
  1691. <div class="codewrapper">
  1692. <pre><code class="lang-csharp hljs">public abstract void UncookMouse()</code></pre>
  1693. </div>
  1694. <a id="Terminal_Gui_ConsoleDriver_UpdateCursor_" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor*"></a>
  1695. <h4 id="Terminal_Gui_ConsoleDriver_UpdateCursor" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor">UpdateCursor()</h4>
  1696. <div class="markdown level1 summary">
  1697. Updates the location of the cursor position
  1698. </div>
  1699. <div class="markdown level1 conceptual"></div>
  1700. <h5 class="decalaration">Declaration</h5>
  1701. <div class="codewrapper">
  1702. <pre><code class="lang-csharp hljs">public abstract void UpdateCursor()</code></pre>
  1703. </div>
  1704. <a id="Terminal_Gui_ConsoleDriver_UpdateScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen*"></a>
  1705. <h4 id="Terminal_Gui_ConsoleDriver_UpdateScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen">UpdateScreen()</h4>
  1706. <div class="markdown level1 summary">
  1707. Redraws the physical screen with the contents that have been queued up via any of the printing commands.
  1708. </div>
  1709. <div class="markdown level1 conceptual"></div>
  1710. <h5 class="decalaration">Declaration</h5>
  1711. <div class="codewrapper">
  1712. <pre><code class="lang-csharp hljs">public abstract void UpdateScreen()</code></pre>
  1713. </div>
  1714. </article>
  1715. </div>
  1716. <div class="hidden-sm col-md-2" role="complementary">
  1717. <div class="sideaffix">
  1718. <div class="contribution">
  1719. <ul class="nav">
  1720. </ul>
  1721. </div>
  1722. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1723. <h5>In This Article</h5>
  1724. <div></div>
  1725. </nav>
  1726. </div>
  1727. </div>
  1728. </div>
  1729. </div>
  1730. <footer>
  1731. <div class="grad-bottom"></div>
  1732. <div class="footer">
  1733. <div class="container">
  1734. <span class="pull-right">
  1735. <a href="#top">Back to top</a>
  1736. </span>
  1737. <span>Generated by <strong>DocFX</strong></span>
  1738. </div>
  1739. </div>
  1740. </footer>
  1741. </div>
  1742. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1743. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1744. <script type="text/javascript" src="../../styles/main.js"></script>
  1745. </body>
  1746. </html>