Terminal.Gui.ConsoleDriver.html 80 KB

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