Terminal.Gui.FakeMainLoop.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  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 FakeMainLoop
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class FakeMainLoop
  11. ">
  12. <meta name="generator" content="docfx 2.56.7.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.FakeMainLoop">
  73. <h1 id="Terminal_Gui_FakeMainLoop" data-uid="Terminal.Gui.FakeMainLoop" class="text-break">Class FakeMainLoop
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Mainloop intended to be used with the .NET System.Console API, and can
  77. be used on Windows and Unix, it is cross platform but lacks things like
  78. file descriptor monitoring.
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">FakeMainLoop</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetHashCode()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.GetType()</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.MemberwiseClone()</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  109. </div>
  110. <div>
  111. <span class="xref">System.Object.ToString()</span>
  112. </div>
  113. </div>
  114. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  115. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  116. <h5 id="Terminal_Gui_FakeMainLoop_syntax">Syntax</h5>
  117. <div class="codewrapper">
  118. <pre><code class="lang-csharp hljs">public class FakeMainLoop : IMainLoopDriver</code></pre>
  119. </div>
  120. <h5 id="Terminal_Gui_FakeMainLoop_remarks"><strong>Remarks</strong></h5>
  121. <div class="markdown level0 remarks">
  122. This implementation is used for FakeDriver.
  123. </div>
  124. <h3 id="constructors">Constructors
  125. </h3>
  126. <a id="Terminal_Gui_FakeMainLoop__ctor_" data-uid="Terminal.Gui.FakeMainLoop.#ctor*"></a>
  127. <h4 id="Terminal_Gui_FakeMainLoop__ctor_System_Func_System_ConsoleKeyInfo__" data-uid="Terminal.Gui.FakeMainLoop.#ctor(System.Func{System.ConsoleKeyInfo})">FakeMainLoop(Func&lt;ConsoleKeyInfo&gt;)</h4>
  128. <div class="markdown level1 summary">
  129. Initializes the class.
  130. </div>
  131. <div class="markdown level1 conceptual"></div>
  132. <h5 class="decalaration">Declaration</h5>
  133. <div class="codewrapper">
  134. <pre><code class="lang-csharp hljs">public FakeMainLoop(Func&lt;ConsoleKeyInfo&gt; consoleKeyReaderFn = null)</code></pre>
  135. </div>
  136. <h5 class="parameters">Parameters</h5>
  137. <table class="table table-bordered table-striped table-condensed">
  138. <thead>
  139. <tr>
  140. <th>Type</th>
  141. <th>Name</th>
  142. <th>Description</th>
  143. </tr>
  144. </thead>
  145. <tbody>
  146. <tr>
  147. <td><span class="xref">System.Func</span>&lt;<span class="xref">System.ConsoleKeyInfo</span>&gt;</td>
  148. <td><span class="parametername">consoleKeyReaderFn</span></td>
  149. <td>The method to be called to get a key from the console.</td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. <h5 id="Terminal_Gui_FakeMainLoop__ctor_System_Func_System_ConsoleKeyInfo___remarks">Remarks</h5>
  154. <div class="markdown level1 remarks">
  155. Passing a consoleKeyReaderfn is provided to support unit test scenarios.
  156. </div>
  157. <h3 id="fields">Fields
  158. </h3>
  159. <h4 id="Terminal_Gui_FakeMainLoop_KeyPressed" data-uid="Terminal.Gui.FakeMainLoop.KeyPressed">KeyPressed</h4>
  160. <div class="markdown level1 summary">
  161. Invoked when a Key is pressed.
  162. </div>
  163. <div class="markdown level1 conceptual"></div>
  164. <h5 class="decalaration">Declaration</h5>
  165. <div class="codewrapper">
  166. <pre><code class="lang-csharp hljs">public Action&lt;ConsoleKeyInfo&gt; KeyPressed</code></pre>
  167. </div>
  168. <h5 class="fieldValue">Field Value</h5>
  169. <table class="table table-bordered table-striped table-condensed">
  170. <thead>
  171. <tr>
  172. <th>Type</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><span class="xref">System.Action</span>&lt;<span class="xref">System.ConsoleKeyInfo</span>&gt;</td>
  179. <td></td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <h3 id="eii">Explicit Interface Implementations
  184. </h3>
  185. <a id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_EventsPending_" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#EventsPending*"></a>
  186. <h4 id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_EventsPending_System_Boolean_" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#EventsPending(System.Boolean)">IMainLoopDriver.EventsPending(Boolean)</h4>
  187. <div class="markdown level1 summary"></div>
  188. <div class="markdown level1 conceptual"></div>
  189. <h5 class="decalaration">Declaration</h5>
  190. <div class="codewrapper">
  191. <pre><code class="lang-csharp hljs">bool IMainLoopDriver.EventsPending(bool wait)</code></pre>
  192. </div>
  193. <h5 class="parameters">Parameters</h5>
  194. <table class="table table-bordered table-striped table-condensed">
  195. <thead>
  196. <tr>
  197. <th>Type</th>
  198. <th>Name</th>
  199. <th>Description</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td><span class="xref">System.Boolean</span></td>
  205. <td><span class="parametername">wait</span></td>
  206. <td></td>
  207. </tr>
  208. </tbody>
  209. </table>
  210. <h5 class="returns">Returns</h5>
  211. <table class="table table-bordered table-striped table-condensed">
  212. <thead>
  213. <tr>
  214. <th>Type</th>
  215. <th>Description</th>
  216. </tr>
  217. </thead>
  218. <tbody>
  219. <tr>
  220. <td><span class="xref">System.Boolean</span></td>
  221. <td></td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <a id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_MainIteration_" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#MainIteration*"></a>
  226. <h4 id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_MainIteration" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#MainIteration">IMainLoopDriver.MainIteration()</h4>
  227. <div class="markdown level1 summary"></div>
  228. <div class="markdown level1 conceptual"></div>
  229. <h5 class="decalaration">Declaration</h5>
  230. <div class="codewrapper">
  231. <pre><code class="lang-csharp hljs">void IMainLoopDriver.MainIteration()</code></pre>
  232. </div>
  233. <a id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_Setup_" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#Setup*"></a>
  234. <h4 id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_Setup_Terminal_Gui_MainLoop_" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#Setup(Terminal.Gui.MainLoop)">IMainLoopDriver.Setup(MainLoop)</h4>
  235. <div class="markdown level1 summary"></div>
  236. <div class="markdown level1 conceptual"></div>
  237. <h5 class="decalaration">Declaration</h5>
  238. <div class="codewrapper">
  239. <pre><code class="lang-csharp hljs">void IMainLoopDriver.Setup(MainLoop mainLoop)</code></pre>
  240. </div>
  241. <h5 class="parameters">Parameters</h5>
  242. <table class="table table-bordered table-striped table-condensed">
  243. <thead>
  244. <tr>
  245. <th>Type</th>
  246. <th>Name</th>
  247. <th>Description</th>
  248. </tr>
  249. </thead>
  250. <tbody>
  251. <tr>
  252. <td><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></td>
  253. <td><span class="parametername">mainLoop</span></td>
  254. <td></td>
  255. </tr>
  256. </tbody>
  257. </table>
  258. <a id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_Wakeup_" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#Wakeup*"></a>
  259. <h4 id="Terminal_Gui_FakeMainLoop_Terminal_Gui_IMainLoopDriver_Wakeup" data-uid="Terminal.Gui.FakeMainLoop.Terminal#Gui#IMainLoopDriver#Wakeup">IMainLoopDriver.Wakeup()</h4>
  260. <div class="markdown level1 summary"></div>
  261. <div class="markdown level1 conceptual"></div>
  262. <h5 class="decalaration">Declaration</h5>
  263. <div class="codewrapper">
  264. <pre><code class="lang-csharp hljs">void IMainLoopDriver.Wakeup()</code></pre>
  265. </div>
  266. <h3 id="implements">Implements</h3>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a>
  269. </div>
  270. </article>
  271. </div>
  272. <div class="hidden-sm col-md-2" role="complementary">
  273. <div class="sideaffix">
  274. <div class="contribution">
  275. <ul class="nav">
  276. </ul>
  277. </div>
  278. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  279. <h5>In This Article</h5>
  280. <div></div>
  281. </nav>
  282. </div>
  283. </div>
  284. </div>
  285. </div>
  286. <footer>
  287. <div class="grad-bottom"></div>
  288. <div class="footer">
  289. <div class="container">
  290. <span class="pull-right">
  291. <a href="#top">Back to top</a>
  292. </span>
  293. <span>Generated by <strong>DocFX</strong></span>
  294. </div>
  295. </div>
  296. </footer>
  297. </div>
  298. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  299. <script type="text/javascript" src="../../styles/docfx.js"></script>
  300. <script type="text/javascript" src="../../styles/main.js"></script>
  301. </body>
  302. </html>