mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
453 lines
24 KiB
HTML
453 lines
24 KiB
HTML
|
<!-- HTML header for doxygen 1.9.8-->
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.12.0"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>FTXUI: Loop Class Reference</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>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
||
|
|
DoxygenAwesomeParagraphLink.init()
|
||
|
|
DoxygenAwesomeInteractiveToc.init()
|
||
|
|
DoxygenAwesomeTabs.init()
|
||
|
|
window.addEventListener('DOMContentLoaded', function () {
|
||
|
|
document.querySelectorAll(".headertitle").forEach(div => {
|
||
|
|
// Hide progressively the title.
|
||
|
|
if (div.textContent != "Getting Started" &&
|
||
|
|
div.textContent != "Installation" &&
|
||
|
|
div.textContent != "Modules" &&
|
||
|
|
true) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
div.style.display = "none";
|
||
|
|
// Show progressively the image.
|
||
|
|
const img = document.querySelector("img.inline");
|
||
|
|
img.style.maxHeight = "40vh";
|
||
|
|
img.style.maxWidth = "100%";
|
||
|
|
img.style.objectFit = "contain";
|
||
|
|
});
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="cookie.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-awesome.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link href="stylesheet.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 id="projectrow">
|
||
|
|
<td id="projectalign">
|
||
|
|
<div id="projectname">FTXUI<span id="projectnumber"> 6.1.9</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">C++ functional terminal UI.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
||
|
|
<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">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(function() { codefold.init(0); });
|
||
|
|
/* @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',true);
|
||
|
|
$(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
</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 */
|
||
|
|
$(function(){initNavTree('classftxui_1_1Loop.html',''); initResizable(true); });
|
||
|
|
/* @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="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">Loop Class Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="loop_8hpp_source.html">loop.hpp</a>></code></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:aacbc899babaac445c3b9b831322e8c70" id="r_aacbc899babaac445c3b9b831322e8c70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aacbc899babaac445c3b9b831322e8c70">Loop</a> (<a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> *screen, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component)</td></tr>
|
||
|
|
<tr class="memdesc:aacbc899babaac445c3b9b831322e8c70"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="classftxui_1_1Loop.html">Loop</a> is a wrapper around a Component and a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>. It is used to run a Component in a terminal. <br /></td></tr>
|
||
|
|
<tr class="separator:aacbc899babaac445c3b9b831322e8c70"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a84c72a09400ffc01ce3257d2109453a2" id="r_a84c72a09400ffc01ce3257d2109453a2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a84c72a09400ffc01ce3257d2109453a2">~Loop</a> ()</td></tr>
|
||
|
|
<tr class="separator:a84c72a09400ffc01ce3257d2109453a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0f10869cb1cad212e8885deac6960a41" id="r_a0f10869cb1cad212e8885deac6960a41"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0f10869cb1cad212e8885deac6960a41">HasQuitted</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a0f10869cb1cad212e8885deac6960a41"><td class="mdescLeft"> </td><td class="mdescRight">Whether the loop has quitted. <br /></td></tr>
|
||
|
|
<tr class="separator:a0f10869cb1cad212e8885deac6960a41"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad638ec512bc0d9876c2bf1c15913e9d3" id="r_ad638ec512bc0d9876c2bf1c15913e9d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad638ec512bc0d9876c2bf1c15913e9d3">RunOnce</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ad638ec512bc0d9876c2bf1c15913e9d3"><td class="mdescLeft"> </td><td class="mdescRight">Execute the loop. Make the <code>component</code> to process every pending tasks/events. A new frame might be drawn if the previous was invalidated. Return true until the loop hasn't completed. <br /></td></tr>
|
||
|
|
<tr class="separator:ad638ec512bc0d9876c2bf1c15913e9d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afe89c4e52cb64cd7271c3fa8a04e7b61" id="r_afe89c4e52cb64cd7271c3fa8a04e7b61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#afe89c4e52cb64cd7271c3fa8a04e7b61">RunOnceBlocking</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:afe89c4e52cb64cd7271c3fa8a04e7b61"><td class="mdescLeft"> </td><td class="mdescRight">Wait for at least one event to be handled and execute <code><a class="el" href="#ad638ec512bc0d9876c2bf1c15913e9d3" title="Execute the loop. Make the component to process every pending tasks/events. A new frame might be draw...">Loop::RunOnce()</a></code>. <br /></td></tr>
|
||
|
|
<tr class="separator:afe89c4e52cb64cd7271c3fa8a04e7b61"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa3eca255b6be227d7d901cc2a72017a5" id="r_aa3eca255b6be227d7d901cc2a72017a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3eca255b6be227d7d901cc2a72017a5">Run</a> ()</td></tr>
|
||
|
|
<tr class="separator:aa3eca255b6be227d7d901cc2a72017a5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad72ac0aa7a08850990b76f15e13dbe79" id="r_ad72ac0aa7a08850990b76f15e13dbe79"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad72ac0aa7a08850990b76f15e13dbe79">Loop</a> (const <a class="el" href="classftxui_1_1Loop.html">Loop</a> &)=default</td></tr>
|
||
|
|
<tr class="separator:ad72ac0aa7a08850990b76f15e13dbe79"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adfc045f0113bbf7f6dc5895ff7ce3ac5" id="r_adfc045f0113bbf7f6dc5895ff7ce3ac5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#adfc045f0113bbf7f6dc5895ff7ce3ac5">Loop</a> (<a class="el" href="classftxui_1_1Loop.html">Loop</a> &&)=delete</td></tr>
|
||
|
|
<tr class="separator:adfc045f0113bbf7f6dc5895ff7ce3ac5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:add07fd33947183c42a79cb4759129ff8" id="r_add07fd33947183c42a79cb4759129ff8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Loop.html">Loop</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#add07fd33947183c42a79cb4759129ff8">operator=</a> (<a class="el" href="classftxui_1_1Loop.html">Loop</a> &&)=delete</td></tr>
|
||
|
|
<tr class="separator:add07fd33947183c42a79cb4759129ff8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a734882bfa3e357e4bb57581494e8699b" id="r_a734882bfa3e357e4bb57581494e8699b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a734882bfa3e357e4bb57581494e8699b">Loop</a> (const <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> &)=delete</td></tr>
|
||
|
|
<tr class="separator:a734882bfa3e357e4bb57581494e8699b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab35ce310313b96f28233ebc9279b5dd3" id="r_ab35ce310313b96f28233ebc9279b5dd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Loop.html">Loop</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab35ce310313b96f28233ebc9279b5dd3">operator=</a> (const <a class="el" href="classftxui_1_1Loop.html">Loop</a> &)=delete</td></tr>
|
||
|
|
<tr class="separator:ab35ce310313b96f28233ebc9279b5dd3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2composition_8cpp-example.html#_a2">examples/component/composition.cpp</a>, and <a class="el" href="examples_2component_2custom_loop_8cpp-example.html#_a2">examples/component/custom_loop.cpp</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8hpp_source.html#l00017">17</a> of file <a class="el" href="loop_8hpp_source.html">loop.hpp</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="aacbc899babaac445c3b9b831322e8c70" name="aacbc899babaac445c3b9b831322e8c70"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacbc899babaac445c3b9b831322e8c70">◆ </a></span>Loop() <span class="overload">[1/4]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> *</td> <td class="paramname"><span class="paramname"><em>screen</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span> )</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>A <a class="el" href="classftxui_1_1Loop.html">Loop</a> is a wrapper around a Component and a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>. It is used to run a Component in a terminal. </p>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>, <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>. </dd>
|
||
|
|
<dd>
|
||
|
|
<a class="el" href="classftxui_1_1ScreenInteractive.html#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop()</a>. </dd>
|
||
|
|
<dd>
|
||
|
|
ScreenInteractive::ExitLoop(). </dd></dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">screen</td><td>The screen to use. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">component</td><td>The component to run. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00021">21</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a84c72a09400ffc01ce3257d2109453a2" name="a84c72a09400ffc01ce3257d2109453a2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84c72a09400ffc01ce3257d2109453a2">◆ </a></span>~Loop()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">~<a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00026">26</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad72ac0aa7a08850990b76f15e13dbe79" name="ad72ac0aa7a08850990b76f15e13dbe79"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad72ac0aa7a08850990b76f15e13dbe79">◆ </a></span>Loop() <span class="overload">[2/4]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1Loop.html">Loop</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="adfc045f0113bbf7f6dc5895ff7ce3ac5" name="adfc045f0113bbf7f6dc5895ff7ce3ac5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfc045f0113bbf7f6dc5895ff7ce3ac5">◆ </a></span>Loop() <span class="overload">[3/4]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1Loop.html">Loop</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a734882bfa3e357e4bb57581494e8699b" name="a734882bfa3e357e4bb57581494e8699b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a734882bfa3e357e4bb57581494e8699b">◆ </a></span>Loop() <span class="overload">[4/4]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a0f10869cb1cad212e8885deac6960a41" name="a0f10869cb1cad212e8885deac6960a41"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f10869cb1cad212e8885deac6960a41">◆ </a></span>HasQuitted()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool HasQuitted </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Whether the loop has quitted. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00032">32</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad638ec512bc0d9876c2bf1c15913e9d3" name="ad638ec512bc0d9876c2bf1c15913e9d3"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad638ec512bc0d9876c2bf1c15913e9d3">◆ </a></span>RunOnce()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void RunOnce </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Execute the loop. Make the <code>component</code> to process every pending tasks/events. A new frame might be drawn if the previous was invalidated. Return true until the loop hasn't completed. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00039">39</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="afe89c4e52cb64cd7271c3fa8a04e7b61" name="afe89c4e52cb64cd7271c3fa8a04e7b61"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe89c4e52cb64cd7271c3fa8a04e7b61">◆ </a></span>RunOnceBlocking()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void RunOnceBlocking </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Wait for at least one event to be handled and execute <code><a class="el" href="#ad638ec512bc0d9876c2bf1c15913e9d3" title="Execute the loop. Make the component to process every pending tasks/events. A new frame might be draw...">Loop::RunOnce()</a></code>. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00045">45</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aa3eca255b6be227d7d901cc2a72017a5" name="aa3eca255b6be227d7d901cc2a72017a5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3eca255b6be227d7d901cc2a72017a5">◆ </a></span>Run()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Run </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Execute the loop, blocking the current thread, up until the loop has quitted. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00051">51</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="add07fd33947183c42a79cb4759129ff8" name="add07fd33947183c42a79cb4759129ff8"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add07fd33947183c42a79cb4759129ff8">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> & operator= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1Loop.html">Loop</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ab35ce310313b96f28233ebc9279b5dd3" name="ab35ce310313b96f28233ebc9279b5dd3"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab35ce310313b96f28233ebc9279b5dd3">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> & operator= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1Loop.html">Loop</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li><a class="el" href="loop_8hpp_source.html">loop.hpp</a></li>
|
||
|
|
<li><a class="el" href="loop_8cpp_source.html">loop.cpp</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- HTML footer for doxygen 1.9.8-->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="classftxui_1_1Loop.html">Loop</a></li>
|
||
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|