csharp
/
gui-cs.Terminal.Gui
mirrorاز https://github.com/gui-cs/Terminal.Gui.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class UnixMainLoop
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class UnixMainLoop
   ">
    <meta name="generator" content="docfx 2.18.2.0">
    
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="">
    <meta property="docfx:tocrel" content="../toc.html">
    
    
  </head>
  <body data-spy="scroll" data-target="#affix">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="Mono.Terminal.UnixMainLoop">
  
  
  <h1 id="Mono_Terminal_UnixMainLoop" data-uid="Mono.Terminal.UnixMainLoop">Class UnixMainLoop
  </h1>
  <div class="markdown level0 summary"><p>Unix main loop, suitable for using on Posix systems</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">UnixMainLoop</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="../Mono.Terminal.html">Mono.Terminal</a></h6>
  <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  <h5 id="Mono_Terminal_UnixMainLoop_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class UnixMainLoop : Mono.Terminal.IMainLoopDriver</code></pre>
  </div>
  <h5 id="Mono_Terminal_UnixMainLoop_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>In addition to the general functions of the mainloop, the Unix version
            can watch file descriptors using the AddWatch methods.</p>
</div>
  <h3 id="constructors">Constructors
  </h3>
  
  
  <a id="Mono_Terminal_UnixMainLoop__ctor_" data-uid="Mono.Terminal.UnixMainLoop.#ctor*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop__ctor" data-uid="Mono.Terminal.UnixMainLoop.#ctor">UnixMainLoop()</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public UnixMainLoop ();</code></pre>
  </div>
  <h3 id="methods">Methods
  </h3>
  
  
  <a id="Mono_Terminal_UnixMainLoop_AddWatch_" data-uid="Mono.Terminal.UnixMainLoop.AddWatch*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop_AddWatch_System_Int32_Mono_Terminal_UnixMainLoop_Condition_System_Func_Mono_Terminal_MainLoop_System_Boolean__" data-uid="Mono.Terminal.UnixMainLoop.AddWatch(System.Int32,Mono.Terminal.UnixMainLoop.Condition,System.Func{Mono.Terminal.MainLoop,System.Boolean})">AddWatch(Int32, UnixMainLoop+Condition, Func&lt;MainLoop,Boolean&gt;)</h4>
  <div class="markdown level1 summary"><p>Watches a file descriptor for activity.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public object AddWatch (int fileDescriptor, Mono.Terminal.UnixMainLoop.Condition condition, Func&lt;Mono.Terminal.MainLoop,bool&gt; callback);</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">fileDescriptor</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
      <tr>
        <td></td>
        <td><span class="parametername">condition</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Func</span>&lt;<a class="xref" href="Mono.Terminal.MainLoop.html">MainLoop</a>,<span class="xref">System.Boolean</span>&gt;</td>
        <td><span class="parametername">callback</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="Mono_Terminal_UnixMainLoop_AddWatch_System_Int32_Mono_Terminal_UnixMainLoop_Condition_System_Func_Mono_Terminal_MainLoop_System_Boolean___remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>When the condition is met, the provided callback
              is invoked.  If the callback returns false, the
              watch is automatically removed.</p>
<pre><code>          The return value is a token that represents this watch, you can
          use this token to remove the watch by calling RemoveWatch.
</code></pre></div>
  
  
  <a id="Mono_Terminal_UnixMainLoop_RemoveWatch_" data-uid="Mono.Terminal.UnixMainLoop.RemoveWatch*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop_RemoveWatch_System_Object_" data-uid="Mono.Terminal.UnixMainLoop.RemoveWatch(System.Object)">RemoveWatch(Object)</h4>
  <div class="markdown level1 summary"><p>Removes an active watch from the mainloop.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void RemoveWatch (object token);</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><span class="parametername">token</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="Mono_Terminal_UnixMainLoop_RemoveWatch_System_Object__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The token parameter is the value returned from AddWatch</p>
</div>
  <h3 id="eii">Explicit Interface Implementations
  </h3>
  
  
  <a id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_EventsPending_" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_EventsPending_System_Boolean_" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending(System.Boolean)">IMainLoopDriver.EventsPending(Boolean)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">bool IMainLoopDriver.EventsPending (bool wait);</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><span class="parametername">wait</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_MainIteration_" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_MainIteration" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration">IMainLoopDriver.MainIteration()</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">void IMainLoopDriver.MainIteration ();</code></pre>
  </div>
  
  
  <a id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_Setup_" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_Setup_Mono_Terminal_MainLoop_" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup(Mono.Terminal.MainLoop)">IMainLoopDriver.Setup(MainLoop)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">void IMainLoopDriver.Setup (Mono.Terminal.MainLoop mainLoop);</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Mono.Terminal.MainLoop.html">MainLoop</a></td>
        <td><span class="parametername">mainLoop</span></td>
        <td><p>To be added.</p>
</td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_Wakeup_" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup*"></a>
  <h4 id="Mono_Terminal_UnixMainLoop_Mono_Terminal_IMainLoopDriver_Wakeup" data-uid="Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup">IMainLoopDriver.Wakeup()</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">void IMainLoopDriver.Wakeup ();</code></pre>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>