Terminal.Gui.ConsoleDriver.html 82 KB

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