Terminal.Gui.ConsoleDriver.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  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.18.2.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="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.ConsoleDriver">
  63. <h1 id="Terminal_Gui_ConsoleDriver" data-uid="Terminal.Gui.ConsoleDriver">Class ConsoleDriver
  64. </h1>
  65. <div class="markdown level0 summary"><p>ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><span class="xref">ConsoleDriver</span></div>
  72. </div>
  73. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  74. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  75. <h5 id="Terminal_Gui_ConsoleDriver_syntax">Syntax</h5>
  76. <div class="codewrapper">
  77. <pre><code class="lang-csharp hljs">public abstract class ConsoleDriver</code></pre>
  78. </div>
  79. <h3 id="constructors">Constructors
  80. </h3>
  81. <a id="Terminal_Gui_ConsoleDriver__ctor_" data-uid="Terminal.Gui.ConsoleDriver.#ctor*"></a>
  82. <h4 id="Terminal_Gui_ConsoleDriver__ctor" data-uid="Terminal.Gui.ConsoleDriver.#ctor">ConsoleDriver()</h4>
  83. <div class="markdown level1 summary"></div>
  84. <div class="markdown level1 conceptual"></div>
  85. <h5 class="decalaration">Declaration</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">protected ConsoleDriver ();</code></pre>
  88. </div>
  89. <h3 id="properties">Properties
  90. </h3>
  91. <a id="Terminal_Gui_ConsoleDriver_Clip_" data-uid="Terminal.Gui.ConsoleDriver.Clip*"></a>
  92. <h4 id="Terminal_Gui_ConsoleDriver_Clip" data-uid="Terminal.Gui.ConsoleDriver.Clip">Clip</h4>
  93. <div class="markdown level1 summary"><p>Controls the current clipping region that AddRune/AddStr is subject to.</p>
  94. </div>
  95. <div class="markdown level1 conceptual"></div>
  96. <h5 class="decalaration">Declaration</h5>
  97. <div class="codewrapper">
  98. <pre><code class="lang-csharp hljs">public Terminal.Gui.Rect Clip { get; set; }</code></pre>
  99. </div>
  100. <h5 class="propertyValue">Property Value</h5>
  101. <table class="table table-bordered table-striped table-condensed">
  102. <thead>
  103. <tr>
  104. <th>Type</th>
  105. <th>Description</th>
  106. </tr>
  107. </thead>
  108. <tbody>
  109. <tr>
  110. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  111. <td><p>The clip.</p>
  112. </td>
  113. </tr>
  114. </tbody>
  115. </table>
  116. <a id="Terminal_Gui_ConsoleDriver_Cols_" data-uid="Terminal.Gui.ConsoleDriver.Cols*"></a>
  117. <h4 id="Terminal_Gui_ConsoleDriver_Cols" data-uid="Terminal.Gui.ConsoleDriver.Cols">Cols</h4>
  118. <div class="markdown level1 summary"><p>The current number of columns in the terminal.</p>
  119. </div>
  120. <div class="markdown level1 conceptual"></div>
  121. <h5 class="decalaration">Declaration</h5>
  122. <div class="codewrapper">
  123. <pre><code class="lang-csharp hljs">public abstract int Cols { get; }</code></pre>
  124. </div>
  125. <h5 class="propertyValue">Property Value</h5>
  126. <table class="table table-bordered table-striped table-condensed">
  127. <thead>
  128. <tr>
  129. <th>Type</th>
  130. <th>Description</th>
  131. </tr>
  132. </thead>
  133. <tbody>
  134. <tr>
  135. <td><span class="xref">System.Int32</span></td>
  136. <td><p>To be added.</p>
  137. </td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <a id="Terminal_Gui_ConsoleDriver_Rows_" data-uid="Terminal.Gui.ConsoleDriver.Rows*"></a>
  142. <h4 id="Terminal_Gui_ConsoleDriver_Rows" data-uid="Terminal.Gui.ConsoleDriver.Rows">Rows</h4>
  143. <div class="markdown level1 summary"><p>The current number of rows in the terminal.</p>
  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 abstract int Rows { get; }</code></pre>
  149. </div>
  150. <h5 class="propertyValue">Property 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.Int32</span></td>
  161. <td><p>To be added.</p>
  162. </td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <h3 id="methods">Methods
  167. </h3>
  168. <a id="Terminal_Gui_ConsoleDriver_AddCh_" data-uid="Terminal.Gui.ConsoleDriver.AddCh*"></a>
  169. <h4 id="Terminal_Gui_ConsoleDriver_AddCh_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.AddCh(System.Int32)">AddCh(Int32)</h4>
  170. <div class="markdown level1 summary"><p>Adds the specified rune to the display at the current cursor position</p>
  171. </div>
  172. <div class="markdown level1 conceptual"></div>
  173. <h5 class="decalaration">Declaration</h5>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">public abstract void AddCh (int rune);</code></pre>
  176. </div>
  177. <h5 class="parameters">Parameters</h5>
  178. <table class="table table-bordered table-striped table-condensed">
  179. <thead>
  180. <tr>
  181. <th>Type</th>
  182. <th>Name</th>
  183. <th>Description</th>
  184. </tr>
  185. </thead>
  186. <tbody>
  187. <tr>
  188. <td><span class="xref">System.Int32</span></td>
  189. <td><span class="parametername">rune</span></td>
  190. <td><p>Rune to add.</p>
  191. </td>
  192. </tr>
  193. </tbody>
  194. </table>
  195. <a id="Terminal_Gui_ConsoleDriver_AddRune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune*"></a>
  196. <h4 id="Terminal_Gui_ConsoleDriver_AddRune_System_Rune_" data-uid="Terminal.Gui.ConsoleDriver.AddRune(System.Rune)">AddRune(Rune)</h4>
  197. <div class="markdown level1 summary"><p>Adds the specified rune to the display at the current cursor position</p>
  198. </div>
  199. <div class="markdown level1 conceptual"></div>
  200. <h5 class="decalaration">Declaration</h5>
  201. <div class="codewrapper">
  202. <pre><code class="lang-csharp hljs">public abstract void AddRune (Rune rune);</code></pre>
  203. </div>
  204. <h5 class="parameters">Parameters</h5>
  205. <table class="table table-bordered table-striped table-condensed">
  206. <thead>
  207. <tr>
  208. <th>Type</th>
  209. <th>Name</th>
  210. <th>Description</th>
  211. </tr>
  212. </thead>
  213. <tbody>
  214. <tr>
  215. <td><span class="xref">System.Rune</span></td>
  216. <td><span class="parametername">rune</span></td>
  217. <td><p>Rune to add.</p>
  218. </td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. <a id="Terminal_Gui_ConsoleDriver_AddSpecial_" data-uid="Terminal.Gui.ConsoleDriver.AddSpecial*"></a>
  223. <h4 id="Terminal_Gui_ConsoleDriver_AddSpecial_Terminal_Gui_SpecialChar_" data-uid="Terminal.Gui.ConsoleDriver.AddSpecial(Terminal.Gui.SpecialChar)">AddSpecial(SpecialChar)</h4>
  224. <div class="markdown level1 summary"><p>Draws a special characters in the screen</p>
  225. </div>
  226. <div class="markdown level1 conceptual"></div>
  227. <h5 class="decalaration">Declaration</h5>
  228. <div class="codewrapper">
  229. <pre><code class="lang-csharp hljs">public abstract void AddSpecial (Terminal.Gui.SpecialChar ch);</code></pre>
  230. </div>
  231. <h5 class="parameters">Parameters</h5>
  232. <table class="table table-bordered table-striped table-condensed">
  233. <thead>
  234. <tr>
  235. <th>Type</th>
  236. <th>Name</th>
  237. <th>Description</th>
  238. </tr>
  239. </thead>
  240. <tbody>
  241. <tr>
  242. <td><a class="xref" href="Terminal.Gui.SpecialChar.html">SpecialChar</a></td>
  243. <td><span class="parametername">ch</span></td>
  244. <td><p>Ch.</p>
  245. </td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  250. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_NStack_ustring_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(NStack.ustring)">AddStr(ustring)</h4>
  251. <div class="markdown level1 summary"><p>Adds the specified</p>
  252. </div>
  253. <div class="markdown level1 conceptual"></div>
  254. <h5 class="decalaration">Declaration</h5>
  255. <div class="codewrapper">
  256. <pre><code class="lang-csharp hljs">public abstract void AddStr (NStack.ustring str);</code></pre>
  257. </div>
  258. <h5 class="parameters">Parameters</h5>
  259. <table class="table table-bordered table-striped table-condensed">
  260. <thead>
  261. <tr>
  262. <th>Type</th>
  263. <th>Name</th>
  264. <th>Description</th>
  265. </tr>
  266. </thead>
  267. <tbody>
  268. <tr>
  269. <td><span class="xref">NStack.ustring</span></td>
  270. <td><span class="parametername">str</span></td>
  271. <td><p>String.</p>
  272. </td>
  273. </tr>
  274. </tbody>
  275. </table>
  276. <a id="Terminal_Gui_ConsoleDriver_AddStr_" data-uid="Terminal.Gui.ConsoleDriver.AddStr*"></a>
  277. <h4 id="Terminal_Gui_ConsoleDriver_AddStr_System_String_" data-uid="Terminal.Gui.ConsoleDriver.AddStr(System.String)">AddStr(String)</h4>
  278. <div class="markdown level1 summary"><p>Adds the specified</p>
  279. </div>
  280. <div class="markdown level1 conceptual"></div>
  281. <h5 class="decalaration">Declaration</h5>
  282. <div class="codewrapper">
  283. <pre><code class="lang-csharp hljs">public abstract void AddStr (string str);</code></pre>
  284. </div>
  285. <h5 class="parameters">Parameters</h5>
  286. <table class="table table-bordered table-striped table-condensed">
  287. <thead>
  288. <tr>
  289. <th>Type</th>
  290. <th>Name</th>
  291. <th>Description</th>
  292. </tr>
  293. </thead>
  294. <tbody>
  295. <tr>
  296. <td><span class="xref">System.String</span></td>
  297. <td><span class="parametername">str</span></td>
  298. <td><p>String.</p>
  299. </td>
  300. </tr>
  301. </tbody>
  302. </table>
  303. <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
  304. <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>
  305. <div class="markdown level1 summary"></div>
  306. <div class="markdown level1 conceptual"></div>
  307. <h5 class="decalaration">Declaration</h5>
  308. <div class="codewrapper">
  309. <pre><code class="lang-csharp hljs">public abstract void DrawFrame (Terminal.Gui.Rect region, int padding, bool fill);</code></pre>
  310. </div>
  311. <h5 class="parameters">Parameters</h5>
  312. <table class="table table-bordered table-striped table-condensed">
  313. <thead>
  314. <tr>
  315. <th>Type</th>
  316. <th>Name</th>
  317. <th>Description</th>
  318. </tr>
  319. </thead>
  320. <tbody>
  321. <tr>
  322. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  323. <td><span class="parametername">region</span></td>
  324. <td><p>To be added.</p>
  325. </td>
  326. </tr>
  327. <tr>
  328. <td><span class="xref">System.Int32</span></td>
  329. <td><span class="parametername">padding</span></td>
  330. <td><p>To be added.</p>
  331. </td>
  332. </tr>
  333. <tr>
  334. <td><span class="xref">System.Boolean</span></td>
  335. <td><span class="parametername">fill</span></td>
  336. <td><p>To be added.</p>
  337. </td>
  338. </tr>
  339. </tbody>
  340. </table>
  341. <a id="Terminal_Gui_ConsoleDriver_End_" data-uid="Terminal.Gui.ConsoleDriver.End*"></a>
  342. <h4 id="Terminal_Gui_ConsoleDriver_End" data-uid="Terminal.Gui.ConsoleDriver.End">End()</h4>
  343. <div class="markdown level1 summary"><p>Ends the execution of the console driver.</p>
  344. </div>
  345. <div class="markdown level1 conceptual"></div>
  346. <h5 class="decalaration">Declaration</h5>
  347. <div class="codewrapper">
  348. <pre><code class="lang-csharp hljs">public abstract void End ();</code></pre>
  349. </div>
  350. <a id="Terminal_Gui_ConsoleDriver_Init_" data-uid="Terminal.Gui.ConsoleDriver.Init*"></a>
  351. <h4 id="Terminal_Gui_ConsoleDriver_Init_System_Action_" data-uid="Terminal.Gui.ConsoleDriver.Init(System.Action)">Init(Action)</h4>
  352. <div class="markdown level1 summary"><p>Initializes the driver</p>
  353. </div>
  354. <div class="markdown level1 conceptual"></div>
  355. <h5 class="decalaration">Declaration</h5>
  356. <div class="codewrapper">
  357. <pre><code class="lang-csharp hljs">public abstract void Init (Action terminalResized);</code></pre>
  358. </div>
  359. <h5 class="parameters">Parameters</h5>
  360. <table class="table table-bordered table-striped table-condensed">
  361. <thead>
  362. <tr>
  363. <th>Type</th>
  364. <th>Name</th>
  365. <th>Description</th>
  366. </tr>
  367. </thead>
  368. <tbody>
  369. <tr>
  370. <td><span class="xref">System.Action</span></td>
  371. <td><span class="parametername">terminalResized</span></td>
  372. <td><p>Method to invoke when the terminal is resized.</p>
  373. </td>
  374. </tr>
  375. </tbody>
  376. </table>
  377. <a id="Terminal_Gui_ConsoleDriver_Move_" data-uid="Terminal.Gui.ConsoleDriver.Move*"></a>
  378. <h4 id="Terminal_Gui_ConsoleDriver_Move_System_Int32_System_Int32_" data-uid="Terminal.Gui.ConsoleDriver.Move(System.Int32,System.Int32)">Move(Int32, Int32)</h4>
  379. <div class="markdown level1 summary"><p>Moves the cursor to the specified column and row.</p>
  380. </div>
  381. <div class="markdown level1 conceptual"></div>
  382. <h5 class="decalaration">Declaration</h5>
  383. <div class="codewrapper">
  384. <pre><code class="lang-csharp hljs">public abstract void Move (int col, int row);</code></pre>
  385. </div>
  386. <h5 class="parameters">Parameters</h5>
  387. <table class="table table-bordered table-striped table-condensed">
  388. <thead>
  389. <tr>
  390. <th>Type</th>
  391. <th>Name</th>
  392. <th>Description</th>
  393. </tr>
  394. </thead>
  395. <tbody>
  396. <tr>
  397. <td><span class="xref">System.Int32</span></td>
  398. <td><span class="parametername">col</span></td>
  399. <td><p>Column to move the cursor to.</p>
  400. </td>
  401. </tr>
  402. <tr>
  403. <td><span class="xref">System.Int32</span></td>
  404. <td><span class="parametername">row</span></td>
  405. <td><p>Row to move the cursor to.</p>
  406. </td>
  407. </tr>
  408. </tbody>
  409. </table>
  410. <a id="Terminal_Gui_ConsoleDriver_PrepareToRun_" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun*"></a>
  411. <h4 id="Terminal_Gui_ConsoleDriver_PrepareToRun_Mono_Terminal_MainLoop_System_Action_Terminal_Gui_KeyEvent__System_Action_Terminal_Gui_MouseEvent__" data-uid="Terminal.Gui.ConsoleDriver.PrepareToRun(Mono.Terminal.MainLoop,System.Action{Terminal.Gui.KeyEvent},System.Action{Terminal.Gui.MouseEvent})">PrepareToRun(MainLoop, Action&lt;KeyEvent&gt;, Action&lt;MouseEvent&gt;)</h4>
  412. <div class="markdown level1 summary"></div>
  413. <div class="markdown level1 conceptual"></div>
  414. <h5 class="decalaration">Declaration</h5>
  415. <div class="codewrapper">
  416. <pre><code class="lang-csharp hljs">public abstract void PrepareToRun (Mono.Terminal.MainLoop mainLoop, Action&lt;Terminal.Gui.KeyEvent&gt; target, Action&lt;Terminal.Gui.MouseEvent&gt; mouse);</code></pre>
  417. </div>
  418. <h5 class="parameters">Parameters</h5>
  419. <table class="table table-bordered table-striped table-condensed">
  420. <thead>
  421. <tr>
  422. <th>Type</th>
  423. <th>Name</th>
  424. <th>Description</th>
  425. </tr>
  426. </thead>
  427. <tbody>
  428. <tr>
  429. <td><a class="xref" href="../Mono.Terminal/Mono.Terminal.MainLoop.html">MainLoop</a></td>
  430. <td><span class="parametername">mainLoop</span></td>
  431. <td><p>To be added.</p>
  432. </td>
  433. </tr>
  434. <tr>
  435. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a>&gt;</td>
  436. <td><span class="parametername">target</span></td>
  437. <td><p>To be added.</p>
  438. </td>
  439. </tr>
  440. <tr>
  441. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>&gt;</td>
  442. <td><span class="parametername">mouse</span></td>
  443. <td><p>To be added.</p>
  444. </td>
  445. </tr>
  446. </tbody>
  447. </table>
  448. <a id="Terminal_Gui_ConsoleDriver_RedrawTop_" data-uid="Terminal.Gui.ConsoleDriver.RedrawTop*"></a>
  449. <h4 id="Terminal_Gui_ConsoleDriver_RedrawTop" data-uid="Terminal.Gui.ConsoleDriver.RedrawTop">RedrawTop()</h4>
  450. <div class="markdown level1 summary"></div>
  451. <div class="markdown level1 conceptual"></div>
  452. <h5 class="decalaration">Declaration</h5>
  453. <div class="codewrapper">
  454. <pre><code class="lang-csharp hljs">public abstract void RedrawTop ();</code></pre>
  455. </div>
  456. <a id="Terminal_Gui_ConsoleDriver_Refresh_" data-uid="Terminal.Gui.ConsoleDriver.Refresh*"></a>
  457. <h4 id="Terminal_Gui_ConsoleDriver_Refresh" data-uid="Terminal.Gui.ConsoleDriver.Refresh">Refresh()</h4>
  458. <div class="markdown level1 summary"><p>Updates the screen to reflect all the changes that have been done to the display buffer</p>
  459. </div>
  460. <div class="markdown level1 conceptual"></div>
  461. <h5 class="decalaration">Declaration</h5>
  462. <div class="codewrapper">
  463. <pre><code class="lang-csharp hljs">public abstract void Refresh ();</code></pre>
  464. </div>
  465. <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
  466. <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
  467. <div class="markdown level1 summary"></div>
  468. <div class="markdown level1 conceptual"></div>
  469. <h5 class="decalaration">Declaration</h5>
  470. <div class="codewrapper">
  471. <pre><code class="lang-csharp hljs">public abstract void SetAttribute (Terminal.Gui.Attribute c);</code></pre>
  472. </div>
  473. <h5 class="parameters">Parameters</h5>
  474. <table class="table table-bordered table-striped table-condensed">
  475. <thead>
  476. <tr>
  477. <th>Type</th>
  478. <th>Name</th>
  479. <th>Description</th>
  480. </tr>
  481. </thead>
  482. <tbody>
  483. <tr>
  484. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  485. <td><span class="parametername">c</span></td>
  486. <td><p>To be added.</p>
  487. </td>
  488. </tr>
  489. </tbody>
  490. </table>
  491. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  492. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_ConsoleColor_System_ConsoleColor_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.ConsoleColor,System.ConsoleColor)">SetColors(ConsoleColor, ConsoleColor)</h4>
  493. <div class="markdown level1 summary"></div>
  494. <div class="markdown level1 conceptual"></div>
  495. <h5 class="decalaration">Declaration</h5>
  496. <div class="codewrapper">
  497. <pre><code class="lang-csharp hljs">public abstract void SetColors (ConsoleColor foreground, ConsoleColor background);</code></pre>
  498. </div>
  499. <h5 class="parameters">Parameters</h5>
  500. <table class="table table-bordered table-striped table-condensed">
  501. <thead>
  502. <tr>
  503. <th>Type</th>
  504. <th>Name</th>
  505. <th>Description</th>
  506. </tr>
  507. </thead>
  508. <tbody>
  509. <tr>
  510. <td><span class="xref">System.ConsoleColor</span></td>
  511. <td><span class="parametername">foreground</span></td>
  512. <td><p>To be added.</p>
  513. </td>
  514. </tr>
  515. <tr>
  516. <td><span class="xref">System.ConsoleColor</span></td>
  517. <td><span class="parametername">background</span></td>
  518. <td><p>To be added.</p>
  519. </td>
  520. </tr>
  521. </tbody>
  522. </table>
  523. <a id="Terminal_Gui_ConsoleDriver_SetColors_" data-uid="Terminal.Gui.ConsoleDriver.SetColors*"></a>
  524. <h4 id="Terminal_Gui_ConsoleDriver_SetColors_System_Int16_System_Int16_" data-uid="Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)">SetColors(Int16, Int16)</h4>
  525. <div class="markdown level1 summary"><p>Advanced uses - set colors to any pre-set pairs, you would need to init_color
  526. that independently with the R, G, B values.</p>
  527. </div>
  528. <div class="markdown level1 conceptual"></div>
  529. <h5 class="decalaration">Declaration</h5>
  530. <div class="codewrapper">
  531. <pre><code class="lang-csharp hljs">public abstract void SetColors (short foregroundColorId, short backgroundColorId);</code></pre>
  532. </div>
  533. <h5 class="parameters">Parameters</h5>
  534. <table class="table table-bordered table-striped table-condensed">
  535. <thead>
  536. <tr>
  537. <th>Type</th>
  538. <th>Name</th>
  539. <th>Description</th>
  540. </tr>
  541. </thead>
  542. <tbody>
  543. <tr>
  544. <td><span class="xref">System.Int16</span></td>
  545. <td><span class="parametername">foregroundColorId</span></td>
  546. <td><p>Foreground color identifier.</p>
  547. </td>
  548. </tr>
  549. <tr>
  550. <td><span class="xref">System.Int16</span></td>
  551. <td><span class="parametername">backgroundColorId</span></td>
  552. <td><p>Background color identifier.</p>
  553. </td>
  554. </tr>
  555. </tbody>
  556. </table>
  557. <a id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves*"></a>
  558. <h4 id="Terminal_Gui_ConsoleDriver_StartReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StartReportingMouseMoves">StartReportingMouseMoves()</h4>
  559. <div class="markdown level1 summary"></div>
  560. <div class="markdown level1 conceptual"></div>
  561. <h5 class="decalaration">Declaration</h5>
  562. <div class="codewrapper">
  563. <pre><code class="lang-csharp hljs">public abstract void StartReportingMouseMoves ();</code></pre>
  564. </div>
  565. <a id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves_" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves*"></a>
  566. <h4 id="Terminal_Gui_ConsoleDriver_StopReportingMouseMoves" data-uid="Terminal.Gui.ConsoleDriver.StopReportingMouseMoves">StopReportingMouseMoves()</h4>
  567. <div class="markdown level1 summary"></div>
  568. <div class="markdown level1 conceptual"></div>
  569. <h5 class="decalaration">Declaration</h5>
  570. <div class="codewrapper">
  571. <pre><code class="lang-csharp hljs">public abstract void StopReportingMouseMoves ();</code></pre>
  572. </div>
  573. <a id="Terminal_Gui_ConsoleDriver_Suspend_" data-uid="Terminal.Gui.ConsoleDriver.Suspend*"></a>
  574. <h4 id="Terminal_Gui_ConsoleDriver_Suspend" data-uid="Terminal.Gui.ConsoleDriver.Suspend">Suspend()</h4>
  575. <div class="markdown level1 summary"><p>Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.</p>
  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 abstract void Suspend ();</code></pre>
  581. </div>
  582. </article>
  583. </div>
  584. <div class="hidden-sm col-md-2" role="complementary">
  585. <div class="sideaffix">
  586. <div class="contribution">
  587. <ul class="nav">
  588. </ul>
  589. </div>
  590. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  591. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  592. </nav>
  593. </div>
  594. </div>
  595. </div>
  596. </div>
  597. <footer>
  598. <div class="grad-bottom"></div>
  599. <div class="footer">
  600. <div class="container">
  601. <span class="pull-right">
  602. <a href="#top">Back to top</a>
  603. </span>
  604. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  605. </div>
  606. </div>
  607. </footer>
  608. </div>
  609. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  610. <script type="text/javascript" src="../../styles/docfx.js"></script>
  611. <script type="text/javascript" src="../../styles/main.js"></script>
  612. </body>
  613. </html>