Terminal.Gui.ConsoleDriver.html 44 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199
  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.54.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"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></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>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetHashCode()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetType()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.MemberwiseClone()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ToString()</span>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  110. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  111. <h5 id="Terminal_Gui_ConsoleDriver_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public abstract class ConsoleDriver</code></pre>
  114. </div>
  115. <h3 id="fields">Fields
  116. </h3>
  117. <h4 id="Terminal_Gui_ConsoleDriver_BottomTee" data-uid="Terminal.Gui.ConsoleDriver.BottomTee">BottomTee</h4>
  118. <div class="markdown level1 summary">
  119. The bottom tee.
  120. </div>
  121. <div class="markdown level1 conceptual"></div>
  122. <h5 class="decalaration">Declaration</h5>
  123. <div class="codewrapper">
  124. <pre><code class="lang-csharp hljs">public Rune BottomTee</code></pre>
  125. </div>
  126. <h5 class="fieldValue">Field Value</h5>
  127. <table class="table table-bordered table-striped table-condensed">
  128. <thead>
  129. <tr>
  130. <th>Type</th>
  131. <th>Description</th>
  132. </tr>
  133. </thead>
  134. <tbody>
  135. <tr>
  136. <td><span class="xref">System.Rune</span></td>
  137. <td></td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <h4 id="Terminal_Gui_ConsoleDriver_Diamond" data-uid="Terminal.Gui.ConsoleDriver.Diamond">Diamond</h4>
  142. <div class="markdown level1 summary">
  143. Diamond character
  144. </div>
  145. <div class="markdown level1 conceptual"></div>
  146. <h5 class="decalaration">Declaration</h5>
  147. <div class="codewrapper">
  148. <pre><code class="lang-csharp hljs">public Rune Diamond</code></pre>
  149. </div>
  150. <h5 class="fieldValue">Field Value</h5>
  151. <table class="table table-bordered table-striped table-condensed">
  152. <thead>
  153. <tr>
  154. <th>Type</th>
  155. <th>Description</th>
  156. </tr>
  157. </thead>
  158. <tbody>
  159. <tr>
  160. <td><span class="xref">System.Rune</span></td>
  161. <td></td>
  162. </tr>
  163. </tbody>
  164. </table>
  165. <h4 id="Terminal_Gui_ConsoleDriver_HLine" data-uid="Terminal.Gui.ConsoleDriver.HLine">HLine</h4>
  166. <div class="markdown level1 summary">
  167. Horizontal line character.
  168. </div>
  169. <div class="markdown level1 conceptual"></div>
  170. <h5 class="decalaration">Declaration</h5>
  171. <div class="codewrapper">
  172. <pre><code class="lang-csharp hljs">public Rune HLine</code></pre>
  173. </div>
  174. <h5 class="fieldValue">Field Value</h5>
  175. <table class="table table-bordered table-striped table-condensed">
  176. <thead>
  177. <tr>
  178. <th>Type</th>
  179. <th>Description</th>
  180. </tr>
  181. </thead>
  182. <tbody>
  183. <tr>
  184. <td><span class="xref">System.Rune</span></td>
  185. <td></td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. <h4 id="Terminal_Gui_ConsoleDriver_LeftTee" data-uid="Terminal.Gui.ConsoleDriver.LeftTee">LeftTee</h4>
  190. <div class="markdown level1 summary">
  191. Left tee
  192. </div>
  193. <div class="markdown level1 conceptual"></div>
  194. <h5 class="decalaration">Declaration</h5>
  195. <div class="codewrapper">
  196. <pre><code class="lang-csharp hljs">public Rune LeftTee</code></pre>
  197. </div>
  198. <h5 class="fieldValue">Field Value</h5>
  199. <table class="table table-bordered table-striped table-condensed">
  200. <thead>
  201. <tr>
  202. <th>Type</th>
  203. <th>Description</th>
  204. </tr>
  205. </thead>
  206. <tbody>
  207. <tr>
  208. <td><span class="xref">System.Rune</span></td>
  209. <td></td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <h4 id="Terminal_Gui_ConsoleDriver_LLCorner" data-uid="Terminal.Gui.ConsoleDriver.LLCorner">LLCorner</h4>
  214. <div class="markdown level1 summary">
  215. Lower left corner
  216. </div>
  217. <div class="markdown level1 conceptual"></div>
  218. <h5 class="decalaration">Declaration</h5>
  219. <div class="codewrapper">
  220. <pre><code class="lang-csharp hljs">public Rune LLCorner</code></pre>
  221. </div>
  222. <h5 class="fieldValue">Field Value</h5>
  223. <table class="table table-bordered table-striped table-condensed">
  224. <thead>
  225. <tr>
  226. <th>Type</th>
  227. <th>Description</th>
  228. </tr>
  229. </thead>
  230. <tbody>
  231. <tr>
  232. <td><span class="xref">System.Rune</span></td>
  233. <td></td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <h4 id="Terminal_Gui_ConsoleDriver_LRCorner" data-uid="Terminal.Gui.ConsoleDriver.LRCorner">LRCorner</h4>
  238. <div class="markdown level1 summary">
  239. Lower right corner
  240. </div>
  241. <div class="markdown level1 conceptual"></div>
  242. <h5 class="decalaration">Declaration</h5>
  243. <div class="codewrapper">
  244. <pre><code class="lang-csharp hljs">public Rune LRCorner</code></pre>
  245. </div>
  246. <h5 class="fieldValue">Field Value</h5>
  247. <table class="table table-bordered table-striped table-condensed">
  248. <thead>
  249. <tr>
  250. <th>Type</th>
  251. <th>Description</th>
  252. </tr>
  253. </thead>
  254. <tbody>
  255. <tr>
  256. <td><span class="xref">System.Rune</span></td>
  257. <td></td>
  258. </tr>
  259. </tbody>
  260. </table>
  261. <h4 id="Terminal_Gui_ConsoleDriver_RightTee" data-uid="Terminal.Gui.ConsoleDriver.RightTee">RightTee</h4>
  262. <div class="markdown level1 summary">
  263. Right tee
  264. </div>
  265. <div class="markdown level1 conceptual"></div>
  266. <h5 class="decalaration">Declaration</h5>
  267. <div class="codewrapper">
  268. <pre><code class="lang-csharp hljs">public Rune RightTee</code></pre>
  269. </div>
  270. <h5 class="fieldValue">Field Value</h5>
  271. <table class="table table-bordered table-striped table-condensed">
  272. <thead>
  273. <tr>
  274. <th>Type</th>
  275. <th>Description</th>
  276. </tr>
  277. </thead>
  278. <tbody>
  279. <tr>
  280. <td><span class="xref">System.Rune</span></td>
  281. <td></td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. <h4 id="Terminal_Gui_ConsoleDriver_Stipple" data-uid="Terminal.Gui.ConsoleDriver.Stipple">Stipple</h4>
  286. <div class="markdown level1 summary">
  287. Stipple pattern
  288. </div>
  289. <div class="markdown level1 conceptual"></div>
  290. <h5 class="decalaration">Declaration</h5>
  291. <div class="codewrapper">
  292. <pre><code class="lang-csharp hljs">public Rune Stipple</code></pre>
  293. </div>
  294. <h5 class="fieldValue">Field Value</h5>
  295. <table class="table table-bordered table-striped table-condensed">
  296. <thead>
  297. <tr>
  298. <th>Type</th>
  299. <th>Description</th>
  300. </tr>
  301. </thead>
  302. <tbody>
  303. <tr>
  304. <td><span class="xref">System.Rune</span></td>
  305. <td></td>
  306. </tr>
  307. </tbody>
  308. </table>
  309. <h4 id="Terminal_Gui_ConsoleDriver_TerminalResized" data-uid="Terminal.Gui.ConsoleDriver.TerminalResized">TerminalResized</h4>
  310. <div class="markdown level1 summary">
  311. The handler fired when the terminal is resized.
  312. </div>
  313. <div class="markdown level1 conceptual"></div>
  314. <h5 class="decalaration">Declaration</h5>
  315. <div class="codewrapper">
  316. <pre><code class="lang-csharp hljs">protected Action TerminalResized</code></pre>
  317. </div>
  318. <h5 class="fieldValue">Field Value</h5>
  319. <table class="table table-bordered table-striped table-condensed">
  320. <thead>
  321. <tr>
  322. <th>Type</th>
  323. <th>Description</th>
  324. </tr>
  325. </thead>
  326. <tbody>
  327. <tr>
  328. <td><span class="xref">System.Action</span></td>
  329. <td></td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <h4 id="Terminal_Gui_ConsoleDriver_TopTee" data-uid="Terminal.Gui.ConsoleDriver.TopTee">TopTee</h4>
  334. <div class="markdown level1 summary">
  335. Top tee
  336. </div>
  337. <div class="markdown level1 conceptual"></div>
  338. <h5 class="decalaration">Declaration</h5>
  339. <div class="codewrapper">
  340. <pre><code class="lang-csharp hljs">public Rune TopTee</code></pre>
  341. </div>
  342. <h5 class="fieldValue">Field Value</h5>
  343. <table class="table table-bordered table-striped table-condensed">
  344. <thead>
  345. <tr>
  346. <th>Type</th>
  347. <th>Description</th>
  348. </tr>
  349. </thead>
  350. <tbody>
  351. <tr>
  352. <td><span class="xref">System.Rune</span></td>
  353. <td></td>
  354. </tr>
  355. </tbody>
  356. </table>
  357. <h4 id="Terminal_Gui_ConsoleDriver_ULCorner" data-uid="Terminal.Gui.ConsoleDriver.ULCorner">ULCorner</h4>
  358. <div class="markdown level1 summary">
  359. Upper left corner
  360. </div>
  361. <div class="markdown level1 conceptual"></div>
  362. <h5 class="decalaration">Declaration</h5>
  363. <div class="codewrapper">
  364. <pre><code class="lang-csharp hljs">public Rune ULCorner</code></pre>
  365. </div>
  366. <h5 class="fieldValue">Field Value</h5>
  367. <table class="table table-bordered table-striped table-condensed">
  368. <thead>
  369. <tr>
  370. <th>Type</th>
  371. <th>Description</th>
  372. </tr>
  373. </thead>
  374. <tbody>
  375. <tr>
  376. <td><span class="xref">System.Rune</span></td>
  377. <td></td>
  378. </tr>
  379. </tbody>
  380. </table>
  381. <h4 id="Terminal_Gui_ConsoleDriver_URCorner" data-uid="Terminal.Gui.ConsoleDriver.URCorner">URCorner</h4>
  382. <div class="markdown level1 summary">
  383. Upper right corner
  384. </div>
  385. <div class="markdown level1 conceptual"></div>
  386. <h5 class="decalaration">Declaration</h5>
  387. <div class="codewrapper">
  388. <pre><code class="lang-csharp hljs">public Rune URCorner</code></pre>
  389. </div>
  390. <h5 class="fieldValue">Field Value</h5>
  391. <table class="table table-bordered table-striped table-condensed">
  392. <thead>
  393. <tr>
  394. <th>Type</th>
  395. <th>Description</th>
  396. </tr>
  397. </thead>
  398. <tbody>
  399. <tr>
  400. <td><span class="xref">System.Rune</span></td>
  401. <td></td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <h4 id="Terminal_Gui_ConsoleDriver_VLine" data-uid="Terminal.Gui.ConsoleDriver.VLine">VLine</h4>
  406. <div class="markdown level1 summary">
  407. Vertical line character.
  408. </div>
  409. <div class="markdown level1 conceptual"></div>
  410. <h5 class="decalaration">Declaration</h5>
  411. <div class="codewrapper">
  412. <pre><code class="lang-csharp hljs">public Rune VLine</code></pre>
  413. </div>
  414. <h5 class="fieldValue">Field Value</h5>
  415. <table class="table table-bordered table-striped table-condensed">
  416. <thead>
  417. <tr>
  418. <th>Type</th>
  419. <th>Description</th>
  420. </tr>
  421. </thead>
  422. <tbody>
  423. <tr>
  424. <td><span class="xref">System.Rune</span></td>
  425. <td></td>
  426. </tr>
  427. </tbody>
  428. </table>
  429. <h3 id="properties">Properties
  430. </h3>
  431. <a id="Terminal_Gui_ConsoleDriver_Clip_" data-uid="Terminal.Gui.ConsoleDriver.Clip*"></a>
  432. <h4 id="Terminal_Gui_ConsoleDriver_Clip" data-uid="Terminal.Gui.ConsoleDriver.Clip">Clip</h4>
  433. <div class="markdown level1 summary">
  434. Controls the current clipping region that AddRune/AddStr is subject to.
  435. </div>
  436. <div class="markdown level1 conceptual"></div>
  437. <h5 class="decalaration">Declaration</h5>
  438. <div class="codewrapper">
  439. <pre><code class="lang-csharp hljs">public Rect Clip { get; set; }</code></pre>
  440. </div>
  441. <h5 class="propertyValue">Property Value</h5>
  442. <table class="table table-bordered table-striped table-condensed">
  443. <thead>
  444. <tr>
  445. <th>Type</th>
  446. <th>Description</th>
  447. </tr>
  448. </thead>
  449. <tbody>
  450. <tr>
  451. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  452. <td>The clip.</td>
  453. </tr>
  454. </tbody>
  455. </table>
  456. <a id="Terminal_Gui_ConsoleDriver_Cols_" data-uid="Terminal.Gui.ConsoleDriver.Cols*"></a>
  457. <h4 id="Terminal_Gui_ConsoleDriver_Cols" data-uid="Terminal.Gui.ConsoleDriver.Cols">Cols</h4>
  458. <div class="markdown level1 summary">
  459. The current number of columns in the terminal.
  460. </div>
  461. <div class="markdown level1 conceptual"></div>
  462. <h5 class="decalaration">Declaration</h5>
  463. <div class="codewrapper">
  464. <pre><code class="lang-csharp hljs">public abstract int Cols { get; }</code></pre>
  465. </div>
  466. <h5 class="propertyValue">Property Value</h5>
  467. <table class="table table-bordered table-striped table-condensed">
  468. <thead>
  469. <tr>
  470. <th>Type</th>
  471. <th>Description</th>
  472. </tr>
  473. </thead>
  474. <tbody>
  475. <tr>
  476. <td><span class="xref">System.Int32</span></td>
  477. <td></td>
  478. </tr>
  479. </tbody>
  480. </table>
  481. <a id="Terminal_Gui_ConsoleDriver_Rows_" data-uid="Terminal.Gui.ConsoleDriver.Rows*"></a>
  482. <h4 id="Terminal_Gui_ConsoleDriver_Rows" data-uid="Terminal.Gui.ConsoleDriver.Rows">Rows</h4>
  483. <div class="markdown level1 summary">
  484. The current number of rows in the terminal.
  485. </div>
  486. <div class="markdown level1 conceptual"></div>
  487. <h5 class="decalaration">Declaration</h5>
  488. <div class="codewrapper">
  489. <pre><code class="lang-csharp hljs">public abstract int Rows { get; }</code></pre>
  490. </div>
  491. <h5 class="propertyValue">Property Value</h5>
  492. <table class="table table-bordered table-striped table-condensed">
  493. <thead>
  494. <tr>
  495. <th>Type</th>
  496. <th>Description</th>
  497. </tr>
  498. </thead>
  499. <tbody>
  500. <tr>
  501. <td><span class="xref">System.Int32</span></td>
  502. <td></td>
  503. </tr>
  504. </tbody>
  505. </table>
  506. <h3 id="methods">Methods
  507. </h3>
  508. <a id="Terminal_Gui_ConsoleDriver_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
  509. <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
  510. <div class="markdown level1 summary">
  511. Adds the specified rune to the display at the current cursor position
  512. </div>
  513. <div class="markdown level1 conceptual"></div>
  514. <h5 class="decalaration">Declaration</h5>
  515. <div class="codewrapper">
  516. <pre><code class="lang-csharp hljs">public abstract void AddRune(Rune rune)</code></pre>
  517. </div>
  518. <h5 class="parameters">Parameters</h5>
  519. <table class="table table-bordered table-striped table-condensed">
  520. <thead>
  521. <tr>
  522. <th>Type</th>
  523. <th>Name</th>
  524. <th>Description</th>
  525. </tr>
  526. </thead>
  527. <tbody>
  528. <tr>
  529. <td><span class="xref">System.Rune</span></td>
  530. <td><span class="parametername">rune</span></td>
  531. <td>Rune to add.</td>
  532. </tr>
  533. </tbody>
  534. </table>
  535. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  536. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
  537. <div class="markdown level1 summary">
  538. Adds the specified
  539. </div>
  540. <div class="markdown level1 conceptual"></div>
  541. <h5 class="decalaration">Declaration</h5>
  542. <div class="codewrapper">
  543. <pre><code class="lang-csharp hljs">public abstract void AddStr(ustring str)</code></pre>
  544. </div>
  545. <h5 class="parameters">Parameters</h5>
  546. <table class="table table-bordered table-striped table-condensed">
  547. <thead>
  548. <tr>
  549. <th>Type</th>
  550. <th>Name</th>
  551. <th>Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td><span class="xref">NStack.ustring</span></td>
  557. <td><span class="parametername">str</span></td>
  558. <td>String.</td>
  559. </tr>
  560. </tbody>
  561. </table>
  562. <a id="Terminal_Gui_ConsoleDriver_CookMouse_" data-uid="Terminal.Gui.ConsoleDriver.CookMouse*"></a>
  563. <h4 id="Terminal_Gui_ConsoleDriver_CookMouse" data-uid="Terminal.Gui.ConsoleDriver.CookMouse">CookMouse()</h4>
  564. <div class="markdown level1 summary">
  565. Enables the cooked event processing from the mouse driver
  566. </div>
  567. <div class="markdown level1 conceptual"></div>
  568. <h5 class="decalaration">Declaration</h5>
  569. <div class="codewrapper">
  570. <pre><code class="lang-csharp hljs">public abstract void CookMouse()</code></pre>
  571. </div>
  572. <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
  573. <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>
  574. <div class="markdown level1 summary">
  575. Draws a frame on the specified region with the specified padding around the frame.
  576. </div>
  577. <div class="markdown level1 conceptual"></div>
  578. <h5 class="decalaration">Declaration</h5>
  579. <div class="codewrapper">
  580. <pre><code class="lang-csharp hljs">public virtual void DrawFrame(Rect region, int padding, bool fill)</code></pre>
  581. </div>
  582. <h5 class="parameters">Parameters</h5>
  583. <table class="table table-bordered table-striped table-condensed">
  584. <thead>
  585. <tr>
  586. <th>Type</th>
  587. <th>Name</th>
  588. <th>Description</th>
  589. </tr>
  590. </thead>
  591. <tbody>
  592. <tr>
  593. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  594. <td><span class="parametername">region</span></td>
  595. <td>Screen relative region where the frame will be drawn.</td>
  596. </tr>
  597. <tr>
  598. <td><span class="xref">System.Int32</span></td>
  599. <td><span class="parametername">padding</span></td>
  600. <td>Padding to add on the sides.</td>
  601. </tr>
  602. <tr>
  603. <td><span class="xref">System.Boolean</span></td>
  604. <td><span class="parametername">fill</span></td>
  605. <td>If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.</td>
  606. </tr>
  607. </tbody>
  608. </table>
  609. <h5 id="Terminal_Gui_ConsoleDriver_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean__remarks">Remarks</h5>
  610. <div class="markdown level1 remarks">This API has been superceded by <a class="xref" href="Terminal.Gui.ConsoleDriver.html#Terminal_Gui_ConsoleDriver_DrawWindowFrame_Terminal_Gui_Rect_System_Int32_System_Int32_System_Int32_System_Int32_System_Boolean_System_Boolean_">DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean)</a>.</div>
  611. <a id="Terminal_Gui_ConsoleDriver_DrawWindowFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowFrame*"></a>
  612. <h4 id="Terminal_Gui_ConsoleDriver_DrawWindowFrame_Terminal_Gui_Rect_System_Int32_System_Int32_System_Int32_System_Int32_System_Boolean_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowFrame(Terminal.Gui.Rect,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean)</h4>
  613. <div class="markdown level1 summary">
  614. Draws a frame for a window with padding and an optional visible border inside the padding.
  615. </div>
  616. <div class="markdown level1 conceptual"></div>
  617. <h5 class="decalaration">Declaration</h5>
  618. <div class="codewrapper">
  619. <pre><code class="lang-csharp hljs">public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false)</code></pre>
  620. </div>
  621. <h5 class="parameters">Parameters</h5>
  622. <table class="table table-bordered table-striped table-condensed">
  623. <thead>
  624. <tr>
  625. <th>Type</th>
  626. <th>Name</th>
  627. <th>Description</th>
  628. </tr>
  629. </thead>
  630. <tbody>
  631. <tr>
  632. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  633. <td><span class="parametername">region</span></td>
  634. <td>Screen relative region where the frame will be drawn.</td>
  635. </tr>
  636. <tr>
  637. <td><span class="xref">System.Int32</span></td>
  638. <td><span class="parametername">paddingLeft</span></td>
  639. <td>Number of columns to pad on the left (if 0 the border will not appear on the left).</td>
  640. </tr>
  641. <tr>
  642. <td><span class="xref">System.Int32</span></td>
  643. <td><span class="parametername">paddingTop</span></td>
  644. <td>Number of rows to pad on the top (if 0 the border and title will not appear on the top).</td>
  645. </tr>
  646. <tr>
  647. <td><span class="xref">System.Int32</span></td>
  648. <td><span class="parametername">paddingRight</span></td>
  649. <td>Number of columns to pad on the right (if 0 the border will not appear on the right).</td>
  650. </tr>
  651. <tr>
  652. <td><span class="xref">System.Int32</span></td>
  653. <td><span class="parametername">paddingBottom</span></td>
  654. <td>Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).</td>
  655. </tr>
  656. <tr>
  657. <td><span class="xref">System.Boolean</span></td>
  658. <td><span class="parametername">border</span></td>
  659. <td>If set to <code>true</code> and any padding dimension is > 0 the border will be drawn.</td>
  660. </tr>
  661. <tr>
  662. <td><span class="xref">System.Boolean</span></td>
  663. <td><span class="parametername">fill</span></td>
  664. <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>
  665. </tr>
  666. </tbody>
  667. </table>
  668. <a id="Terminal_Gui_ConsoleDriver_DrawWindowTitle_" data-uid="Terminal.Gui.ConsoleDriver.DrawWindowTitle*"></a>
  669. <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>
  670. <div class="markdown level1 summary">
  671. Draws the title for a Window-style view incorporating padding.
  672. </div>
  673. <div class="markdown level1 conceptual"></div>
  674. <h5 class="decalaration">Declaration</h5>
  675. <div class="codewrapper">
  676. <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>
  677. </div>
  678. <h5 class="parameters">Parameters</h5>
  679. <table class="table table-bordered table-striped table-condensed">
  680. <thead>
  681. <tr>
  682. <th>Type</th>
  683. <th>Name</th>
  684. <th>Description</th>
  685. </tr>
  686. </thead>
  687. <tbody>
  688. <tr>
  689. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  690. <td><span class="parametername">region</span></td>
  691. <td>Screen relative region where the frame will be drawn.</td>
  692. </tr>
  693. <tr>
  694. <td><span class="xref">NStack.ustring</span></td>
  695. <td><span class="parametername">title</span></td>
  696. <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>
  697. </tr>
  698. <tr>
  699. <td><span class="xref">System.Int32</span></td>
  700. <td><span class="parametername">paddingLeft</span></td>
  701. <td>Number of columns to pad on the left (if 0 the border will not appear on the left).</td>
  702. </tr>
  703. <tr>
  704. <td><span class="xref">System.Int32</span></td>
  705. <td><span class="parametername">paddingTop</span></td>
  706. <td>Number of rows to pad on the top (if 0 the border and title will not appear on the top).</td>
  707. </tr>
  708. <tr>
  709. <td><span class="xref">System.Int32</span></td>
  710. <td><span class="parametername">paddingRight</span></td>
  711. <td>Number of columns to pad on the right (if 0 the border will not appear on the right).</td>
  712. </tr>
  713. <tr>
  714. <td><span class="xref">System.Int32</span></td>
  715. <td><span class="parametername">paddingBottom</span></td>
  716. <td>Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).</td>
  717. </tr>
  718. <tr>
  719. <td><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></td>
  720. <td><span class="parametername">textAlignment</span></td>
  721. <td>Not yet immplemented.</td>
  722. </tr>
  723. </tbody>
  724. </table>
  725. <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
  726. <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
  727. <div class="markdown level1 summary">
  728. Ends the execution of the console driver.
  729. </div>
  730. <div class="markdown level1 conceptual"></div>
  731. <h5 class="decalaration">Declaration</h5>
  732. <div class="codewrapper">
  733. <pre><code class="lang-csharp hljs">public abstract void End()</code></pre>
  734. </div>
  735. <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
  736. <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
  737. <div class="markdown level1 summary">
  738. Initializes the driver
  739. </div>
  740. <div class="markdown level1 conceptual"></div>
  741. <h5 class="decalaration">Declaration</h5>
  742. <div class="codewrapper">
  743. <pre><code class="lang-csharp hljs">public abstract void Init(Action terminalResized)</code></pre>
  744. </div>
  745. <h5 class="parameters">Parameters</h5>
  746. <table class="table table-bordered table-striped table-condensed">
  747. <thead>
  748. <tr>
  749. <th>Type</th>
  750. <th>Name</th>
  751. <th>Description</th>
  752. </tr>
  753. </thead>
  754. <tbody>
  755. <tr>
  756. <td><span class="xref">System.Action</span></td>
  757. <td><span class="parametername">terminalResized</span></td>
  758. <td>Method to invoke when the terminal is resized.</td>
  759. </tr>
  760. </tbody>
  761. </table>
  762. <a id="Terminal_Gui_ConsoleDriver_MakeAttribute_" data-uid="Terminal.Gui.ConsoleDriver.MakeAttribute*"></a>
  763. <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>
  764. <div class="markdown level1 summary">
  765. Make the attribute for the foreground and background colors.
  766. </div>
  767. <div class="markdown level1 conceptual"></div>
  768. <h5 class="decalaration">Declaration</h5>
  769. <div class="codewrapper">
  770. <pre><code class="lang-csharp hljs">public abstract Attribute MakeAttribute(Color fore, Color back)</code></pre>
  771. </div>
  772. <h5 class="parameters">Parameters</h5>
  773. <table class="table table-bordered table-striped table-condensed">
  774. <thead>
  775. <tr>
  776. <th>Type</th>
  777. <th>Name</th>
  778. <th>Description</th>
  779. </tr>
  780. </thead>
  781. <tbody>
  782. <tr>
  783. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  784. <td><span class="parametername">fore</span></td>
  785. <td>Foreground.</td>
  786. </tr>
  787. <tr>
  788. <td><a class="xref" href="Terminal.Gui.Color.html">Color</a></td>
  789. <td><span class="parametername">back</span></td>
  790. <td>Background.</td>
  791. </tr>
  792. </tbody>
  793. </table>
  794. <h5 class="returns">Returns</h5>
  795. <table class="table table-bordered table-striped table-condensed">
  796. <thead>
  797. <tr>
  798. <th>Type</th>
  799. <th>Description</th>
  800. </tr>
  801. </thead>
  802. <tbody>
  803. <tr>
  804. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  805. <td></td>
  806. </tr>
  807. </tbody>
  808. </table>
  809. <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
  810. <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  811. <div class="markdown level1 summary">
  812. Moves the cursor to the specified column and row.
  813. </div>
  814. <div class="markdown level1 conceptual"></div>
  815. <h5 class="decalaration">Declaration</h5>
  816. <div class="codewrapper">
  817. <pre><code class="lang-csharp hljs">public abstract void Move(int col, int row)</code></pre>
  818. </div>
  819. <h5 class="parameters">Parameters</h5>
  820. <table class="table table-bordered table-striped table-condensed">
  821. <thead>
  822. <tr>
  823. <th>Type</th>
  824. <th>Name</th>
  825. <th>Description</th>
  826. </tr>
  827. </thead>
  828. <tbody>
  829. <tr>
  830. <td><span class="xref">System.Int32</span></td>
  831. <td><span class="parametername">col</span></td>
  832. <td>Column to move the cursor to.</td>
  833. </tr>
  834. <tr>
  835. <td><span class="xref">System.Int32</span></td>
  836. <td><span class="parametername">row</span></td>
  837. <td>Row to move the cursor to.</td>
  838. </tr>
  839. </tbody>
  840. </table>
  841. <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
  842. <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>
  843. <div class="markdown level1 summary">
  844. Prepare the driver and set the key and mouse events handlers.
  845. </div>
  846. <div class="markdown level1 conceptual"></div>
  847. <h5 class="decalaration">Declaration</h5>
  848. <div class="codewrapper">
  849. <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>
  850. </div>
  851. <h5 class="parameters">Parameters</h5>
  852. <table class="table table-bordered table-striped table-condensed">
  853. <thead>
  854. <tr>
  855. <th>Type</th>
  856. <th>Name</th>
  857. <th>Description</th>
  858. </tr>
  859. </thead>
  860. <tbody>
  861. <tr>
  862. <td><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></td>
  863. <td><span class="parametername">mainLoop</span></td>
  864. <td>The main loop.</td>
  865. </tr>
  866. <tr>
  867. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  868. <td><span class="parametername">keyHandler</span></td>
  869. <td>The handler for ProcessKey</td>
  870. </tr>
  871. <tr>
  872. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  873. <td><span class="parametername">keyDownHandler</span></td>
  874. <td>The handler for key down events</td>
  875. </tr>
  876. <tr>
  877. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  878. <td><span class="parametername">keyUpHandler</span></td>
  879. <td>The handler for key up events</td>
  880. </tr>
  881. <tr>
  882. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>&gt;</td>
  883. <td><span class="parametername">mouseHandler</span></td>
  884. <td>The handler for mouse events</td>
  885. </tr>
  886. </tbody>
  887. </table>
  888. <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
  889. <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
  890. <div class="markdown level1 summary">
  891. Updates the screen to reflect all the changes that have been done to the display buffer
  892. </div>
  893. <div class="markdown level1 conceptual"></div>
  894. <h5 class="decalaration">Declaration</h5>
  895. <div class="codewrapper">
  896. <pre><code class="lang-csharp hljs">public abstract void Refresh()</code></pre>
  897. </div>
  898. <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
  899. <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
  900. <div class="markdown level1 summary">
  901. Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.
  902. </div>
  903. <div class="markdown level1 conceptual"></div>
  904. <h5 class="decalaration">Declaration</h5>
  905. <div class="codewrapper">
  906. <pre><code class="lang-csharp hljs">public abstract void SetAttribute(Attribute c)</code></pre>
  907. </div>
  908. <h5 class="parameters">Parameters</h5>
  909. <table class="table table-bordered table-striped table-condensed">
  910. <thead>
  911. <tr>
  912. <th>Type</th>
  913. <th>Name</th>
  914. <th>Description</th>
  915. </tr>
  916. </thead>
  917. <tbody>
  918. <tr>
  919. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  920. <td><span class="parametername">c</span></td>
  921. <td>C.</td>
  922. </tr>
  923. </tbody>
  924. </table>
  925. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  926. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</h4>
  927. <div class="markdown level1 summary">
  928. Set Colors from limit sets of colors.
  929. </div>
  930. <div class="markdown level1 conceptual"></div>
  931. <h5 class="decalaration">Declaration</h5>
  932. <div class="codewrapper">
  933. <pre><code class="lang-csharp hljs">public abstract void SetColors(ConsoleColor foreground, ConsoleColor background)</code></pre>
  934. </div>
  935. <h5 class="parameters">Parameters</h5>
  936. <table class="table table-bordered table-striped table-condensed">
  937. <thead>
  938. <tr>
  939. <th>Type</th>
  940. <th>Name</th>
  941. <th>Description</th>
  942. </tr>
  943. </thead>
  944. <tbody>
  945. <tr>
  946. <td><span class="xref">System.ConsoleColor</span></td>
  947. <td><span class="parametername">foreground</span></td>
  948. <td>Foreground.</td>
  949. </tr>
  950. <tr>
  951. <td><span class="xref">System.ConsoleColor</span></td>
  952. <td><span class="parametername">background</span></td>
  953. <td>Background.</td>
  954. </tr>
  955. </tbody>
  956. </table>
  957. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  958. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
  959. <div class="markdown level1 summary">
  960. Advanced uses - set colors to any pre-set pairs, you would need to init_color
  961. that independently with the R, G, B values.
  962. </div>
  963. <div class="markdown level1 conceptual"></div>
  964. <h5 class="decalaration">Declaration</h5>
  965. <div class="codewrapper">
  966. <pre><code class="lang-csharp hljs">public abstract void SetColors(short foregroundColorId, short backgroundColorId)</code></pre>
  967. </div>
  968. <h5 class="parameters">Parameters</h5>
  969. <table class="table table-bordered table-striped table-condensed">
  970. <thead>
  971. <tr>
  972. <th>Type</th>
  973. <th>Name</th>
  974. <th>Description</th>
  975. </tr>
  976. </thead>
  977. <tbody>
  978. <tr>
  979. <td><span class="xref">System.Int16</span></td>
  980. <td><span class="parametername">foregroundColorId</span></td>
  981. <td>Foreground color identifier.</td>
  982. </tr>
  983. <tr>
  984. <td><span class="xref">System.Int16</span></td>
  985. <td><span class="parametername">backgroundColorId</span></td>
  986. <td>Background color identifier.</td>
  987. </tr>
  988. </tbody>
  989. </table>
  990. <a id="Terminal_Gui_ConsoleDriver_SetTerminalResized_" data-uid="Terminal.Gui.ConsoleDriver.SetTerminalResized*"></a>
  991. <h4 id="Terminal_Gui_ConsoleDriver_SetTerminalResized_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.SetTerminalResized(System.Action)">SetTerminalResized(Action)</h4>
  992. <div class="markdown level1 summary">
  993. Set the handler when the terminal is resized.
  994. </div>
  995. <div class="markdown level1 conceptual"></div>
  996. <h5 class="decalaration">Declaration</h5>
  997. <div class="codewrapper">
  998. <pre><code class="lang-csharp hljs">public void SetTerminalResized(Action terminalResized)</code></pre>
  999. </div>
  1000. <h5 class="parameters">Parameters</h5>
  1001. <table class="table table-bordered table-striped table-condensed">
  1002. <thead>
  1003. <tr>
  1004. <th>Type</th>
  1005. <th>Name</th>
  1006. <th>Description</th>
  1007. </tr>
  1008. </thead>
  1009. <tbody>
  1010. <tr>
  1011. <td><span class="xref">System.Action</span></td>
  1012. <td><span class="parametername">terminalResized</span></td>
  1013. <td></td>
  1014. </tr>
  1015. </tbody>
  1016. </table>
  1017. <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
  1018. <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</h4>
  1019. <div class="markdown level1 summary">
  1020. Start of mouse moves.
  1021. </div>
  1022. <div class="markdown level1 conceptual"></div>
  1023. <h5 class="decalaration">Declaration</h5>
  1024. <div class="codewrapper">
  1025. <pre><code class="lang-csharp hljs">public abstract void StartReportingMouseMoves()</code></pre>
  1026. </div>
  1027. <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
  1028. <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</h4>
  1029. <div class="markdown level1 summary">
  1030. Stop reporting mouses moves.
  1031. </div>
  1032. <div class="markdown level1 conceptual"></div>
  1033. <h5 class="decalaration">Declaration</h5>
  1034. <div class="codewrapper">
  1035. <pre><code class="lang-csharp hljs">public abstract void StopReportingMouseMoves()</code></pre>
  1036. </div>
  1037. <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
  1038. <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
  1039. <div class="markdown level1 summary">
  1040. Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.
  1041. </div>
  1042. <div class="markdown level1 conceptual"></div>
  1043. <h5 class="decalaration">Declaration</h5>
  1044. <div class="codewrapper">
  1045. <pre><code class="lang-csharp hljs">public abstract void Suspend()</code></pre>
  1046. </div>
  1047. <a id="Terminal_Gui_ConsoleDriver_UncookMouse_" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse*"></a>
  1048. <h4 id="Terminal_Gui_ConsoleDriver_UncookMouse" data-uid="Terminal.Gui.ConsoleDriver.UncookMouse">UncookMouse()</h4>
  1049. <div class="markdown level1 summary">
  1050. Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked.
  1051. </div>
  1052. <div class="markdown level1 conceptual"></div>
  1053. <h5 class="decalaration">Declaration</h5>
  1054. <div class="codewrapper">
  1055. <pre><code class="lang-csharp hljs">public abstract void UncookMouse()</code></pre>
  1056. </div>
  1057. <a id="Terminal_Gui_ConsoleDriver_UpdateCursor_" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor*"></a>
  1058. <h4 id="Terminal_Gui_ConsoleDriver_UpdateCursor" data-uid="Terminal.Gui.ConsoleDriver.UpdateCursor">UpdateCursor()</h4>
  1059. <div class="markdown level1 summary">
  1060. Updates the location of the cursor position
  1061. </div>
  1062. <div class="markdown level1 conceptual"></div>
  1063. <h5 class="decalaration">Declaration</h5>
  1064. <div class="codewrapper">
  1065. <pre><code class="lang-csharp hljs">public abstract void UpdateCursor()</code></pre>
  1066. </div>
  1067. <a id="Terminal_Gui_ConsoleDriver_UpdateScreen_" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen*"></a>
  1068. <h4 id="Terminal_Gui_ConsoleDriver_UpdateScreen" data-uid="Terminal.Gui.ConsoleDriver.UpdateScreen">UpdateScreen()</h4>
  1069. <div class="markdown level1 summary">
  1070. Redraws the physical screen with the contents that have been queued up via any of the printing commands.
  1071. </div>
  1072. <div class="markdown level1 conceptual"></div>
  1073. <h5 class="decalaration">Declaration</h5>
  1074. <div class="codewrapper">
  1075. <pre><code class="lang-csharp hljs">public abstract void UpdateScreen()</code></pre>
  1076. </div>
  1077. </article>
  1078. </div>
  1079. <div class="hidden-sm col-md-2" role="complementary">
  1080. <div class="sideaffix">
  1081. <div class="contribution">
  1082. <ul class="nav">
  1083. </ul>
  1084. </div>
  1085. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1086. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  1087. </nav>
  1088. </div>
  1089. </div>
  1090. </div>
  1091. </div>
  1092. <footer>
  1093. <div class="grad-bottom"></div>
  1094. <div class="footer">
  1095. <div class="container">
  1096. <span class="pull-right">
  1097. <a href="#top">Back to top</a>
  1098. </span>
  1099. <span>Generated by <strong>DocFX</strong></span>
  1100. </div>
  1101. </div>
  1102. </footer>
  1103. </div>
  1104. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1105. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1106. <script type="text/javascript" src="../../styles/main.js"></script>
  1107. </body>
  1108. </html>