Terminal.Gui.UnixMainLoop.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  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 UnixMainLoop
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class UnixMainLoop
  11. ">
  12. <meta name="generator" content="docfx 2.53.1.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. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <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.UnixMainLoop">
  73. <h1 id="Terminal_Gui_UnixMainLoop" data-uid="Terminal.Gui.UnixMainLoop" class="text-break">Class UnixMainLoop
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Unix main loop, suitable for using on Posix systems
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">UnixMainLoop</span></div>
  83. </div>
  84. <div classs="implements">
  85. <h5>Implements</h5>
  86. <div><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></div>
  87. </div>
  88. <div class="inheritedMembers">
  89. <h5>Inherited Members</h5>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetHashCode()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetType()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.MemberwiseClone()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Object.ToString()</span>
  110. </div>
  111. </div>
  112. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  113. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  114. <h5 id="Terminal_Gui_UnixMainLoop_syntax">Syntax</h5>
  115. <div class="codewrapper">
  116. <pre><code class="lang-csharp hljs">public class UnixMainLoop : IMainLoopDriver</code></pre>
  117. </div>
  118. <h5 id="Terminal_Gui_UnixMainLoop_remarks"><strong>Remarks</strong></h5>
  119. <div class="markdown level0 remarks">
  120. In addition to the general functions of the mainloop, the Unix version
  121. can watch file descriptors using the AddWatch methods.
  122. </div>
  123. <h3 id="methods">Methods
  124. </h3>
  125. <a id="Terminal_Gui_UnixMainLoop_AddWatch_" data-uid="Terminal.Gui.UnixMainLoop.AddWatch*"></a>
  126. <h4 id="Terminal_Gui_UnixMainLoop_AddWatch_System_Int32_Terminal_Gui_UnixMainLoop_Condition_System_Func_Terminal_Gui_MainLoop_System_Boolean__" data-uid="Terminal.Gui.UnixMainLoop.AddWatch(System.Int32,Terminal.Gui.UnixMainLoop.Condition,System.Func{Terminal.Gui.MainLoop,System.Boolean})">AddWatch(Int32, UnixMainLoop.Condition, Func&lt;MainLoop, Boolean&gt;)</h4>
  127. <div class="markdown level1 summary">
  128. Watches a file descriptor for activity.
  129. </div>
  130. <div class="markdown level1 conceptual"></div>
  131. <h5 class="decalaration">Declaration</h5>
  132. <div class="codewrapper">
  133. <pre><code class="lang-csharp hljs">public object AddWatch(int fileDescriptor, UnixMainLoop.Condition condition, Func&lt;MainLoop, bool&gt; callback)</code></pre>
  134. </div>
  135. <h5 class="parameters">Parameters</h5>
  136. <table class="table table-bordered table-striped table-condensed">
  137. <thead>
  138. <tr>
  139. <th>Type</th>
  140. <th>Name</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><span class="xref">System.Int32</span></td>
  147. <td><span class="parametername">fileDescriptor</span></td>
  148. <td></td>
  149. </tr>
  150. <tr>
  151. <td><a class="xref" href="Terminal.Gui.UnixMainLoop.Condition.html">UnixMainLoop.Condition</a></td>
  152. <td><span class="parametername">condition</span></td>
  153. <td></td>
  154. </tr>
  155. <tr>
  156. <td><span class="xref">System.Func</span>&lt;<a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a>, <span class="xref">System.Boolean</span>&gt;</td>
  157. <td><span class="parametername">callback</span></td>
  158. <td></td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h5 class="returns">Returns</h5>
  163. <table class="table table-bordered table-striped table-condensed">
  164. <thead>
  165. <tr>
  166. <th>Type</th>
  167. <th>Description</th>
  168. </tr>
  169. </thead>
  170. <tbody>
  171. <tr>
  172. <td><span class="xref">System.Object</span></td>
  173. <td></td>
  174. </tr>
  175. </tbody>
  176. </table>
  177. <h5 id="Terminal_Gui_UnixMainLoop_AddWatch_System_Int32_Terminal_Gui_UnixMainLoop_Condition_System_Func_Terminal_Gui_MainLoop_System_Boolean___remarks">Remarks</h5>
  178. <div class="markdown level1 remarks">
  179. When the condition is met, the provided callback
  180. is invoked. If the callback returns false, the
  181. watch is automatically removed.
  182. The return value is a token that represents this watch, you can
  183. use this token to remove the watch by calling RemoveWatch.
  184. </div>
  185. <a id="Terminal_Gui_UnixMainLoop_RemoveWatch_" data-uid="Terminal.Gui.UnixMainLoop.RemoveWatch*"></a>
  186. <h4 id="Terminal_Gui_UnixMainLoop_RemoveWatch_System_Object_" data-uid="Terminal.Gui.UnixMainLoop.RemoveWatch(System.Object)">RemoveWatch(Object)</h4>
  187. <div class="markdown level1 summary">
  188. Removes an active watch from the mainloop.
  189. </div>
  190. <div class="markdown level1 conceptual"></div>
  191. <h5 class="decalaration">Declaration</h5>
  192. <div class="codewrapper">
  193. <pre><code class="lang-csharp hljs">public void RemoveWatch(object token)</code></pre>
  194. </div>
  195. <h5 class="parameters">Parameters</h5>
  196. <table class="table table-bordered table-striped table-condensed">
  197. <thead>
  198. <tr>
  199. <th>Type</th>
  200. <th>Name</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">System.Object</span></td>
  207. <td><span class="parametername">token</span></td>
  208. <td></td>
  209. </tr>
  210. </tbody>
  211. </table>
  212. <h5 id="Terminal_Gui_UnixMainLoop_RemoveWatch_System_Object__remarks">Remarks</h5>
  213. <div class="markdown level1 remarks">
  214. The token parameter is the value returned from AddWatch
  215. </div>
  216. <h3 id="eii">Explicit Interface Implementations
  217. </h3>
  218. <a id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_EventsPending_" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#EventsPending*"></a>
  219. <h4 id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_EventsPending_System_Boolean_" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#EventsPending(System.Boolean)">IMainLoopDriver.EventsPending(Boolean)</h4>
  220. <div class="markdown level1 summary"></div>
  221. <div class="markdown level1 conceptual"></div>
  222. <h5 class="decalaration">Declaration</h5>
  223. <div class="codewrapper">
  224. <pre><code class="lang-csharp hljs">bool IMainLoopDriver.EventsPending(bool wait)</code></pre>
  225. </div>
  226. <h5 class="parameters">Parameters</h5>
  227. <table class="table table-bordered table-striped table-condensed">
  228. <thead>
  229. <tr>
  230. <th>Type</th>
  231. <th>Name</th>
  232. <th>Description</th>
  233. </tr>
  234. </thead>
  235. <tbody>
  236. <tr>
  237. <td><span class="xref">System.Boolean</span></td>
  238. <td><span class="parametername">wait</span></td>
  239. <td></td>
  240. </tr>
  241. </tbody>
  242. </table>
  243. <h5 class="returns">Returns</h5>
  244. <table class="table table-bordered table-striped table-condensed">
  245. <thead>
  246. <tr>
  247. <th>Type</th>
  248. <th>Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><span class="xref">System.Boolean</span></td>
  254. <td></td>
  255. </tr>
  256. </tbody>
  257. </table>
  258. <a id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_MainIteration_" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#MainIteration*"></a>
  259. <h4 id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_MainIteration" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#MainIteration">IMainLoopDriver.MainIteration()</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.MainIteration()</code></pre>
  265. </div>
  266. <a id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_Setup_" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#Setup*"></a>
  267. <h4 id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_Setup_Terminal_Gui_MainLoop_" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#Setup(Terminal.Gui.MainLoop)">IMainLoopDriver.Setup(MainLoop)</h4>
  268. <div class="markdown level1 summary"></div>
  269. <div class="markdown level1 conceptual"></div>
  270. <h5 class="decalaration">Declaration</h5>
  271. <div class="codewrapper">
  272. <pre><code class="lang-csharp hljs">void IMainLoopDriver.Setup(MainLoop mainLoop)</code></pre>
  273. </div>
  274. <h5 class="parameters">Parameters</h5>
  275. <table class="table table-bordered table-striped table-condensed">
  276. <thead>
  277. <tr>
  278. <th>Type</th>
  279. <th>Name</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></td>
  286. <td><span class="parametername">mainLoop</span></td>
  287. <td></td>
  288. </tr>
  289. </tbody>
  290. </table>
  291. <a id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_Wakeup_" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#Wakeup*"></a>
  292. <h4 id="Terminal_Gui_UnixMainLoop_Terminal_Gui_IMainLoopDriver_Wakeup" data-uid="Terminal.Gui.UnixMainLoop.Terminal#Gui#IMainLoopDriver#Wakeup">IMainLoopDriver.Wakeup()</h4>
  293. <div class="markdown level1 summary"></div>
  294. <div class="markdown level1 conceptual"></div>
  295. <h5 class="decalaration">Declaration</h5>
  296. <div class="codewrapper">
  297. <pre><code class="lang-csharp hljs">void IMainLoopDriver.Wakeup()</code></pre>
  298. </div>
  299. <h3 id="implements">Implements</h3>
  300. <div>
  301. <a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a>
  302. </div>
  303. </article>
  304. </div>
  305. <div class="hidden-sm col-md-2" role="complementary">
  306. <div class="sideaffix">
  307. <div class="contribution">
  308. <ul class="nav">
  309. </ul>
  310. </div>
  311. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  312. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  313. </nav>
  314. </div>
  315. </div>
  316. </div>
  317. </div>
  318. <footer>
  319. <div class="grad-bottom"></div>
  320. <div class="footer">
  321. <div class="container">
  322. <span class="pull-right">
  323. <a href="#top">Back to top</a>
  324. </span>
  325. <span>Generated by <strong>DocFX</strong></span>
  326. </div>
  327. </div>
  328. </footer>
  329. </div>
  330. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  331. <script type="text/javascript" src="../../styles/docfx.js"></script>
  332. <script type="text/javascript" src="../../styles/main.js"></script>
  333. </body>
  334. </html>