Terminal.Gui.MainLoop.Timeout.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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 MainLoop.Timeout
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MainLoop.Timeout
  11. ">
  12. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  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="../../images/logo48.png" 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 class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.MainLoop.Timeout">
  72. <h1 id="Terminal_Gui_MainLoop_Timeout" data-uid="Terminal.Gui.MainLoop.Timeout" class="text-break">Class MainLoop.Timeout
  73. </h1>
  74. <div class="markdown level0 summary">Provides data for timers running manipulation.</div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  79. <div class="level1"><span class="xref">MainLoop.Timeout</span></div>
  80. </div>
  81. <div class="inheritedMembers">
  82. <h5>Inherited Members</h5>
  83. <div>
  84. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  85. </div>
  86. <div>
  87. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  100. </div>
  101. </div>
  102. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a></h6>
  103. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  104. <h5 id="Terminal_Gui_MainLoop_Timeout_syntax">Syntax</h5>
  105. <div class="codewrapper">
  106. <pre><code class="lang-csharp hljs">public sealed class MainLoop.Timeout</code></pre>
  107. </div>
  108. <h3 id="fields">Fields
  109. </h3>
  110. <span class="small pull-right mobile-hide">
  111. <span class="divider">|</span>
  112. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MainLoop_Timeout_Callback.md&amp;value=---%0Auid%3A%20Terminal.Gui.MainLoop.Timeout.Callback%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  113. </span>
  114. <span class="small pull-right mobile-hide">
  115. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/MainLoop.cs/#L60">View Source</a>
  116. </span>
  117. <h4 id="Terminal_Gui_MainLoop_Timeout_Callback" data-uid="Terminal.Gui.MainLoop.Timeout.Callback">Callback</h4>
  118. <div class="markdown level1 summary">The function that will be invoked.</div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="declaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public Func&lt;MainLoop, bool&gt; Callback</code></pre>
  123. </div>
  124. <h5 class="fieldValue">Field Value</h5>
  125. <table class="table table-bordered table-condensed">
  126. <thead>
  127. <tr>
  128. <th>Type</th>
  129. <th>Description</th>
  130. </tr>
  131. </thead>
  132. <tbody>
  133. <tr>
  134. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</td>
  135. <td></td>
  136. </tr>
  137. </tbody>
  138. </table>
  139. <span class="small pull-right mobile-hide">
  140. <span class="divider">|</span>
  141. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MainLoop_Timeout_Span.md&amp;value=---%0Auid%3A%20Terminal.Gui.MainLoop.Timeout.Span%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  142. </span>
  143. <span class="small pull-right mobile-hide">
  144. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/MainLoop.cs/#L56">View Source</a>
  145. </span>
  146. <h4 id="Terminal_Gui_MainLoop_Timeout_Span" data-uid="Terminal.Gui.MainLoop.Timeout.Span">Span</h4>
  147. <div class="markdown level1 summary">Time to wait before invoke the callback.</div>
  148. <div class="markdown level1 conceptual"></div>
  149. <h5 class="declaration">Declaration</h5>
  150. <div class="codewrapper">
  151. <pre><code class="lang-csharp hljs">public TimeSpan Span</code></pre>
  152. </div>
  153. <h5 class="fieldValue">Field Value</h5>
  154. <table class="table table-bordered table-condensed">
  155. <thead>
  156. <tr>
  157. <th>Type</th>
  158. <th>Description</th>
  159. </tr>
  160. </thead>
  161. <tbody>
  162. <tr>
  163. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></td>
  164. <td></td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. </article>
  169. </div>
  170. <div class="hidden-sm col-md-2" role="complementary">
  171. <div class="sideaffix">
  172. <div class="contribution">
  173. <ul class="nav">
  174. <li>
  175. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_MainLoop_Timeout.md&amp;value=---%0Auid%3A%20Terminal.Gui.MainLoop.Timeout%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  176. </li>
  177. <li>
  178. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/MainLoop.cs/#L52" class="contribution-link">View Source</a>
  179. </li>
  180. </ul>
  181. </div>
  182. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  183. <h5>In this article</h5>
  184. <div></div>
  185. </nav>
  186. </div>
  187. </div>
  188. </div>
  189. </div>
  190. <footer>
  191. <div class="grad-bottom"></div>
  192. <div class="footer">
  193. <div class="container">
  194. <span class="pull-right">
  195. <a href="#top">Back to top</a>
  196. </span>
  197. <span>Generated by <strong>DocFX</strong></span>
  198. </div>
  199. </div>
  200. </footer>
  201. </div>
  202. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  203. <script type="text/javascript" src="../../styles/docfx.js"></script>
  204. <script type="text/javascript" src="../../styles/main.js"></script>
  205. </body>
  206. </html>