mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
deploy: bcdcf70348
This commit is contained in:
ArthurSonzogni
193
loop_8cpp_source.html
Normal file
193
loop_8cpp_source.html
Normal file
@@ -0,0 +1,193 @@
|
||||
<!-- HTML header for doxygen 1.8.14-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="cache-control" content="max-age=86400"/>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>FTXUI: src/ftxui/component/loop.cpp Source File</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">FTXUI
|
||||
 <span id="projectnumber">6.1.1</span>
|
||||
</div>
|
||||
<div id="projectbrief">C++ functional terminal UI.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function() { init_codefold(0); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function(){initNavTree('loop_8cpp_source.html',''); initResizable(); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle"><div class="title">loop.cpp</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="loop_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2022 Arthur Sonzogni. All rights reserved.</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// the LICENSE file.</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "<a class="code" href="loop_8hpp.html">ftxui/component/loop.hpp</a>"</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <utility></span> <span class="comment">// for move</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "<a class="code" href="screen__interactive_8hpp.html">ftxui/component/screen_interactive.hpp</a>"</span> <span class="comment">// for ScreenInteractive, Component</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">/// @brief A Loop is a wrapper around a Component and a ScreenInteractive.</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/// It is used to run a Component in a terminal.</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">/// @ingroup component</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">/// @see Component, ScreenInteractive.</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/// @see ScreenInteractive::Loop().</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/// @see ScreenInteractive::ExitLoop().</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/// @param[in] screen The screen to use.</span></div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/// @param[in] component The component to run.</span></div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span><span class="comment">// NOLINTNEXTLINE</span></div>
|
||||
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classftxui_1_1Loop.html#aacbc899babaac445c3b9b831322e8c70"> 21</a></span><a class="code hl_function" href="classftxui_1_1Loop.html#aacbc899babaac445c3b9b831322e8c70">Loop::Loop</a>(<a class="code hl_class" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>* <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">screen</a>, <a class="code hl_typedef" href="namespaceftxui.html#a3149fb57ff17207d2516790b82503002">Component</a> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">component</a>)</div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> : screen_(<a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">screen</a>), component_(<a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">std</a>::<a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">move</a>(<a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">component</a>)) {</div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> screen_->PreMain();</div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
||||
<div class="foldopen" id="foldopen00026" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classftxui_1_1Loop.html#a84c72a09400ffc01ce3257d2109453a2"> 26</a></span><a class="code hl_function" href="classftxui_1_1Loop.html#a84c72a09400ffc01ce3257d2109453a2">Loop::~Loop</a>() {</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> screen_->PostMain();</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/// @brief Whether the loop has quitted.</span></div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">/// @ingroup component</span></div>
|
||||
<div class="foldopen" id="foldopen00032" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classftxui_1_1Loop.html#a0f10869cb1cad212e8885deac6960a41"> 32</a></span><span class="comment"></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classftxui_1_1Loop.html#a0f10869cb1cad212e8885deac6960a41">Loop::HasQuitted</a>() {</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> screen_->HasQuitted();</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">/// @brief Execute the loop. Make the `component` to process every pending</span></div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">/// tasks/events. A new frame might be drawn if the previous was invalidated.</span></div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">/// Return true until the loop hasn't completed.</span></div>
|
||||
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classftxui_1_1Loop.html#ad638ec512bc0d9876c2bf1c15913e9d3"> 39</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="classftxui_1_1Loop.html#ad638ec512bc0d9876c2bf1c15913e9d3">Loop::RunOnce</a>() {</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> screen_->RunOnce(component_);</div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">/// @brief Wait for at least one event to be handled and execute</span></div>
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">/// `Loop::RunOnce()`.</span></div>
|
||||
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classftxui_1_1Loop.html#afe89c4e52cb64cd7271c3fa8a04e7b61"> 45</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="classftxui_1_1Loop.html#afe89c4e52cb64cd7271c3fa8a04e7b61">Loop::RunOnceBlocking</a>() {</div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> screen_->RunOnceBlocking(component_);</div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">/// Execute the loop, blocking the current thread, up until the loop has</span></div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">/// quitted.</span></div>
|
||||
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classftxui_1_1Loop.html#aa3eca255b6be227d7d901cc2a72017a5"> 51</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="classftxui_1_1Loop.html#aa3eca255b6be227d7d901cc2a72017a5">Loop::Run</a>() {</div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">while</span> (!<a class="code hl_function" href="classftxui_1_1Loop.html#a0f10869cb1cad212e8885deac6960a41">HasQuitted</a>()) {</div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_function" href="classftxui_1_1Loop.html#afe89c4e52cb64cd7271c3fa8a04e7b61">RunOnceBlocking</a>();</div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>} <span class="comment">// namespace ftxui</span></div>
|
||||
<div class="ttc" id="aclassftxui_1_1Loop_html_a0f10869cb1cad212e8885deac6960a41"><div class="ttname"><a href="classftxui_1_1Loop.html#a0f10869cb1cad212e8885deac6960a41">ftxui::Loop::HasQuitted</a></div><div class="ttdeci">bool HasQuitted()</div><div class="ttdoc">Whether the loop has quitted.</div><div class="ttdef"><b>Definition</b> <a href="loop_8cpp_source.html#l00032">loop.cpp:32</a></div></div>
|
||||
<div class="ttc" id="aclassftxui_1_1Loop_html_a84c72a09400ffc01ce3257d2109453a2"><div class="ttname"><a href="classftxui_1_1Loop.html#a84c72a09400ffc01ce3257d2109453a2">ftxui::Loop::~Loop</a></div><div class="ttdeci">~Loop()</div><div class="ttdef"><b>Definition</b> <a href="loop_8cpp_source.html#l00026">loop.cpp:26</a></div></div>
|
||||
<div class="ttc" id="aclassftxui_1_1Loop_html_aa3eca255b6be227d7d901cc2a72017a5"><div class="ttname"><a href="classftxui_1_1Loop.html#aa3eca255b6be227d7d901cc2a72017a5">ftxui::Loop::Run</a></div><div class="ttdeci">void Run()</div><div class="ttdef"><b>Definition</b> <a href="loop_8cpp_source.html#l00051">loop.cpp:51</a></div></div>
|
||||
<div class="ttc" id="aclassftxui_1_1Loop_html_aacbc899babaac445c3b9b831322e8c70"><div class="ttname"><a href="classftxui_1_1Loop.html#aacbc899babaac445c3b9b831322e8c70">ftxui::Loop::Loop</a></div><div class="ttdeci">Loop(ScreenInteractive *screen, Component component)</div><div class="ttdoc">A Loop is a wrapper around a Component and a ScreenInteractive. It is used to run a Component in a te...</div><div class="ttdef"><b>Definition</b> <a href="loop_8cpp_source.html#l00021">loop.cpp:21</a></div></div>
|
||||
<div class="ttc" id="aclassftxui_1_1Loop_html_ad638ec512bc0d9876c2bf1c15913e9d3"><div class="ttname"><a href="classftxui_1_1Loop.html#ad638ec512bc0d9876c2bf1c15913e9d3">ftxui::Loop::RunOnce</a></div><div class="ttdeci">void RunOnce()</div><div class="ttdoc">Execute the loop. Make the component to process every pending tasks/events. A new frame might be draw...</div><div class="ttdef"><b>Definition</b> <a href="loop_8cpp_source.html#l00039">loop.cpp:39</a></div></div>
|
||||
<div class="ttc" id="aclassftxui_1_1Loop_html_afe89c4e52cb64cd7271c3fa8a04e7b61"><div class="ttname"><a href="classftxui_1_1Loop.html#afe89c4e52cb64cd7271c3fa8a04e7b61">ftxui::Loop::RunOnceBlocking</a></div><div class="ttdeci">void RunOnceBlocking()</div><div class="ttdoc">Wait for at least one event to be handled and execute Loop::RunOnce().</div><div class="ttdef"><b>Definition</b> <a href="loop_8cpp_source.html#l00045">loop.cpp:45</a></div></div>
|
||||
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html"><div class="ttname"><a href="classftxui_1_1ScreenInteractive.html">ftxui::ScreenInteractive</a></div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8hpp_source.html#l00030">screen_interactive.hpp:30</a></div></div>
|
||||
<div class="ttc" id="aloop_8hpp_html"><div class="ttname"><a href="loop_8hpp.html">loop.hpp</a></div></div>
|
||||
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</a></div></div>
|
||||
<div class="ttc" id="anamespaceftxui_html_a2b8973dc71334f1d98e2e6f55de8b5ae"><div class="ttname"><a href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">ftxui::Make</a></div><div class="ttdeci">std::shared_ptr< T > Make(Args &&... args)</div><div class="ttdef"><b>Definition</b> <a href="component_8hpp_source.html#l00026">component.hpp:26</a></div></div>
|
||||
<div class="ttc" id="anamespaceftxui_html_a3149fb57ff17207d2516790b82503002"><div class="ttname"><a href="namespaceftxui.html#a3149fb57ff17207d2516790b82503002">ftxui::Component</a></div><div class="ttdeci">std::shared_ptr< ComponentBase > Component</div><div class="ttdef"><b>Definition</b> <a href="component__base_8hpp_source.html#l00024">component_base.hpp:24</a></div></div>
|
||||
<div class="ttc" id="ascreen__interactive_8hpp_html"><div class="ttname"><a href="screen__interactive_8hpp.html">screen_interactive.hpp</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- HTML footer for doxygen 1.8.14-->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user