mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
668 lines
36 KiB
HTML
668 lines
36 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="module">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
await new Promise(r => window.addEventListener('DOMContentLoaded', r));
|
|
// Remove title when a img[alt='title-img'] is present.
|
|
// Find an image with the alt "img-title".
|
|
const img = document.querySelector("img[alt='title-img']");
|
|
const header = document.querySelector(".headertitle");
|
|
if (img && header) {
|
|
// Hide the header title progressively.
|
|
header.style.display = "none";
|
|
// Show progressively the image.
|
|
img.style.maxHeight = "40vh";
|
|
img.style.maxWidth = "100%";
|
|
img.style.objectFit = "contain";
|
|
}
|
|
// In the "examples.html" page. Turn every link with text
|
|
// "examples/<...>
|
|
//
|
|
// Add a "demo" link toward.
|
|
// https://arthursonzogni.github.io/FTXUI/examples/?file=<...>
|
|
const examples = document.querySelectorAll("a")
|
|
examples.forEach((example) => {
|
|
if (!example.textContent.startsWith("examples/")) {
|
|
return;
|
|
}
|
|
// Remove the ".cpp" extension from the example name.
|
|
const exampleName = example.textContent.replace("examples/", "").replace(".cpp", "");
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + exampleName;
|
|
a.style.marginRight= "1em";
|
|
a.style.fontWeight = "bold";
|
|
example.parentElement.insertBefore(a, example)
|
|
});
|
|
// If the current URL ends with -example.html, we can add a link to the demo
|
|
// as well using the div.title textContent.
|
|
const url = new URL(window.location.href);
|
|
if (url.pathname.endsWith("-example.html")) {
|
|
// Get the title text.
|
|
const title = document.querySelector("div.title").textContent;
|
|
const example = title.replace("examples/", "").replace(".cpp", "");
|
|
// Create a link to the demo.
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + example;
|
|
a.style.marginLeft = "1em";
|
|
a.style.fontWeight = "bold";
|
|
a.style.display = "inline-block";
|
|
// Insert the link after the title.
|
|
const titleDiv = document.querySelector("div.title");
|
|
if (titleDiv) {
|
|
titleDiv.insertBefore(a, titleDiv.nextSibling);
|
|
}
|
|
}
|
|
</script>
|
|
<script type="module">
|
|
// Click on the navtree, except for the main page where this is already done
|
|
// automatically.
|
|
let delay = 0;
|
|
while(true) {
|
|
const navtree = document.querySelector("div.item.selected");
|
|
if (!navtree) {
|
|
delay *= 2;
|
|
delay += 1;
|
|
await new Promise(resolve => setTimeout(resolve, delay));
|
|
continue;
|
|
}
|
|
// Include only selected navtree items.
|
|
console.log("navtree.textContent", navtree.textContent);
|
|
if (!navtree.textContent.includes("Getting Started") &&
|
|
!navtree.textContent.includes("Installation") &&
|
|
!navtree.textContent.includes("ftxui / screen") &&
|
|
!navtree.textContent.includes("ftxui / dom") &&
|
|
!navtree.textContent.includes("ftxui / component") &&
|
|
!navtree.textContent.includes("Reference")) {
|
|
break;
|
|
}
|
|
// Find the first link inside the navtree.
|
|
const link = navtree.querySelector("a");
|
|
if (link) {
|
|
// Simulate a click on the link.
|
|
link.click();
|
|
break;
|
|
}
|
|
}
|
|
</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> |
|
|
<a href="classftxui_1_1Loop-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">Loop Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classftxui_1_1Loop.html" title="Loop 是一個用於管理元件事件循環的類別。">Loop</a> 是一個用於管理元件事件循環的類別。
|
|
<a href="#details">More...</a></p>
|
|
|
|
<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="group__component.html#classftxui_1_1ScreenInteractive">ScreenInteractive</a> *screen, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="el" href="gallery_8cpp.html#a768a57bc667a7482ea6e7fdadf02ba90">component</a>)</td></tr>
|
|
<tr class="memdesc:aacbc899babaac445c3b9b831322e8c70"><td class="mdescLeft"> </td><td class="mdescRight">迴圈是 Component 和 <a class="el" href="group__component.html#classftxui_1_1ScreenInteractive" title="ScreenInteractive 是一個可以處理事件、執行主迴圈並管理組件的 Screen。">ScreenInteractive</a> 的包裝器。 它用於在終端機中執行元件。 <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">迴圈是否已退出。 <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">執行迴圈。讓 <code>component</code> 處理所有待處理的任務/事件。 如果前一個影格失效，可能會繪製一個新影格。 在迴圈完成之前返回 true。 <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">等待至少一個事件被處理並執行 <code><a class="el" href="#ad638ec512bc0d9876c2bf1c15913e9d3" title="執行迴圈。讓 component 處理所有待處理的任務/事件。 如果前一個影格失效，可能會繪製一個新影格。 在迴圈完成之前返回 true。">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="memdesc:aa3eca255b6be227d7d901cc2a72017a5"><td class="mdescLeft"> </td><td class="mdescRight">執行迴圈，阻塞當前執行緒，直到迴圈退出。 <br /></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="group__component.html#classftxui_1_1ScreenInteractive">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"><p><a class="el" href="classftxui_1_1Loop.html" title="Loop 是一個用於管理元件事件循環的類別。">Loop</a> 是一個用於管理元件事件循環的類別。 </p>
|
|
<p>它負責執行元件、處理事件，並 更新畫面。</p>
|
|
<p><a class="el" href="classftxui_1_1Loop.html" title="Loop 是一個用於管理元件事件循環的類別。">Loop</a> 類別旨在與 <a class="el" href="group__component.html#classftxui_1_1ScreenInteractive" title="ScreenInteractive 是一個可以處理事件、執行主迴圈並管理組件的 Screen。">ScreenInteractive</a> 物件一起使用， 該物件代表終端機畫面。</p>
|
|
<p><b>範例</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="component_8hpp.html">ftxui/component/component.hpp</a>></span></div>
|
|
<div class="line"><span class="preprocessor">#include <<a class="code" href="screen__interactive_8hpp.html">ftxui/component/screen_interactive.hpp</a>></span></div>
|
|
<div class="line"><span class="preprocessor">#include <<a class="code" href="loop_8hpp.html">ftxui/component/loop.hpp</a>></span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">int</span> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
|
<div class="line"> <span class="keyword">auto</span> screen = <a class="code hl_function" href="group__component.html#a0b7de0467b4e57ce5f337ba8634d8d13">ftxui::ScreenInteractive::TerminalOutput</a>();</div>
|
|
<div class="line"> <span class="keyword">auto</span> <a class="code hl_variable" href="gallery_8cpp.html#a768a57bc667a7482ea6e7fdadf02ba90">component</a> = <a class="code hl_function" href="group__component.html#ga4e8295ec77dd31b0acc5063b134473e7">ftxui::Button</a>(<span class="stringliteral">"Click me"</span>, [] { ... });</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_class" href="classftxui_1_1Loop.html">ftxui::Loop</a> loop(screen.get(), <a class="code hl_variable" href="gallery_8cpp.html#a768a57bc667a7482ea6e7fdadf02ba90">component</a>);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// 方法一</span></div>
|
|
<div class="line"> loop.Run(); <span class="comment">// 阻塞直到元件退出。</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// 方法二</span></div>
|
|
<div class="line"> loop.RunOnce(); <span class="comment">// 非阻塞，立即返回。</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// 方法三</span></div>
|
|
<div class="line"> loop.RunOnceBlocking(); <span class="comment">// 阻塞直到處理一個事件。</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// 方法四：在循環中：</span></div>
|
|
<div class="line"> <span class="keywordflow">while</span> (!loop.HasQuitted()) {</div>
|
|
<div class="line"> loop.RunOnce();</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// 執行其他操作，例如運行不同的函式庫循環函式。</span></div>
|
|
<div class="line"> }</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclassftxui_1_1Loop_html"><div class="ttname"><a href="classftxui_1_1Loop.html">ftxui::Loop</a></div><div class="ttdoc">Loop 是一個用於管理元件事件循環的類別。</div><div class="ttdef"><b>Definition</b> <a href="loop_8hpp_source.html#l00056">loop.hpp:56</a></div></div>
|
|
<div class="ttc" id="acomponent_8hpp_html"><div class="ttname"><a href="component_8hpp.html">component.hpp</a></div></div>
|
|
<div class="ttc" id="aexamples_2component_2button_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="examples_2component_2button_8cpp_source.html#l00030">examples/component/button.cpp:30</a></div></div>
|
|
<div class="ttc" id="agallery_8cpp_html_a768a57bc667a7482ea6e7fdadf02ba90"><div class="ttname"><a href="gallery_8cpp.html#a768a57bc667a7482ea6e7fdadf02ba90">component</a></div><div class="ttdeci">auto component</div><div class="ttdef"><b>Definition</b> <a href="gallery_8cpp_source.html#l00127">gallery.cpp:127</a></div></div>
|
|
<div class="ttc" id="agroup__component_html_a0b7de0467b4e57ce5f337ba8634d8d13"><div class="ttname"><a href="group__component.html#a0b7de0467b4e57ce5f337ba8634d8d13">ftxui::ScreenInteractive::TerminalOutput</a></div><div class="ttdeci">static ScreenInteractive TerminalOutput()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00331">screen_interactive.cpp:331</a></div></div>
|
|
<div class="ttc" id="agroup__component_html_ga4e8295ec77dd31b0acc5063b134473e7"><div class="ttname"><a href="group__component.html#ga4e8295ec77dd31b0acc5063b134473e7">ftxui::Button</a></div><div class="ttdeci">Component Button(ButtonOption options)</div><div class="ttdoc">繪製一個按鈕。點擊時執行一個函數。</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2button_8cpp_source.html#l00174">src/ftxui/component/button.cpp:174</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="ascreen__interactive_8hpp_html"><div class="ttname"><a href="screen__interactive_8hpp.html">screen_interactive.hpp</a></div></div>
|
|
</div><!-- fragment --> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2custom_loop_8cpp-example.html#_a3">examples/component/custom_loop.cpp</a>, and <a class="el" href="examples_2component_2homescreen_8cpp-example.html#_a8">examples/component/homescreen.cpp</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loop_8hpp_source.html#l00056">56</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="group__component.html#classftxui_1_1ScreenInteractive">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>迴圈是 Component 和 <a class="el" href="group__component.html#classftxui_1_1ScreenInteractive" title="ScreenInteractive 是一個可以處理事件、執行主迴圈並管理組件的 Screen。">ScreenInteractive</a> 的包裝器。 它用於在終端機中執行元件。 </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>, <a class="el" href="group__component.html#classftxui_1_1ScreenInteractive" title="ScreenInteractive 是一個可以處理事件、執行主迴圈並管理組件的 Screen。">ScreenInteractive</a>. </dd>
|
|
<dd>
|
|
<a class="el" href="group__component.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>要使用的螢幕。 </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">component</td><td>要執行的元件。 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00020">20</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#l00025">25</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="group__component.html#classftxui_1_1ScreenInteractive">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>迴圈是否已退出。 </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00030">30</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>執行迴圈。讓 <code>component</code> 處理所有待處理的任務/事件。 如果前一個影格失效，可能會繪製一個新影格。 在迴圈完成之前返回 true。 </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00037">37</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>等待至少一個事件被處理並執行 <code><a class="el" href="#ad638ec512bc0d9876c2bf1c15913e9d3" title="執行迴圈。讓 component 處理所有待處理的任務/事件。 如果前一個影格失效，可能會繪製一個新影格。 在迴圈完成之前返回 true。">Loop::RunOnce()</a></code>。 </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00043">43</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>執行迴圈，阻塞當前執行緒，直到迴圈退出。 </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00048">48</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! -->
|
|
</div>
|
|
<script>
|
|
document.addEventListener('DOMContentLoaded', function() {
|
|
const projectNumber = document.getElementById('projectname');
|
|
|
|
if (!projectNumber) {
|
|
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
|
|
return;
|
|
}
|
|
|
|
const langs = ["en", "es", "fr", "ja", "zh-CH", "zh-TW"];
|
|
const lang_paths = {"en": "../index.html", "es": "../es/index.html", "fr": "../fr/index.html", "ja": "../ja/index.html", "zh-CH": "../zh-CH/index.html", "zh-TW": "index.html"};
|
|
const lang_display = {"en": "English", "es": "Espa\u00f1ol", "fr": "Fran\u00e7ais", "ja": "\u65e5\u672c\u8a9e", "zh-CH": "\u4e2d\u6587 (\u7b80\u4f53)", "zh-TW": "\u4e2d\u6587 (\u7e41\u9ad4)"};
|
|
const versions = ["main"];
|
|
const version_paths = {"main": "index.html"};
|
|
const currentLang = "zh-TW";
|
|
const currentVersion = "main";
|
|
|
|
// Helper function to create a styled select element
|
|
const createSelect = (options, current, paths, label, displayMap = null) => {
|
|
const select = document.createElement('select');
|
|
select.title = label;
|
|
select.onchange = function() {
|
|
const selectedValue = this.value;
|
|
if (selectedValue in paths) {
|
|
window.location.href = paths[selectedValue];
|
|
}
|
|
};
|
|
|
|
// Sort versions: 'main' first, then others numerically descending.
|
|
options.sort((a, b) => {
|
|
if (a === 'main') return -1;
|
|
if (b === 'main') return 1;
|
|
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
|
|
});
|
|
|
|
options.forEach(v => {
|
|
const option = document.createElement('option');
|
|
option.value = v;
|
|
// Use the displayMap if provided, otherwise default to the value (v)
|
|
option.textContent = displayMap ? displayMap[v] : v;
|
|
if (v === current) {
|
|
option.selected = true;
|
|
}
|
|
select.appendChild(option);
|
|
});
|
|
|
|
// Apply some styling to make it look good.
|
|
Object.assign(select.style, {
|
|
backgroundColor: 'rgba(0, 0, 0, 0.8)',
|
|
color: 'white',
|
|
border: '1px solid rgba(255, 255, 255, 0.2)',
|
|
padding: '5px',
|
|
borderRadius: '5px',
|
|
fontSize: '14px',
|
|
fontFamily: 'inherit',
|
|
margin: '0 5px 0 0',
|
|
cursor: 'pointer'
|
|
});
|
|
return select;
|
|
};
|
|
|
|
// 1. Create Language Switcher, passing the language display names map
|
|
const langSelect = createSelect(langs, currentLang, lang_paths, 'Select Language', lang_display);
|
|
|
|
// 2. Create Version Switcher
|
|
const versionSelect = createSelect(versions, currentVersion, version_paths, 'Select Version');
|
|
|
|
// 3. Create FTXUI title.
|
|
const ftxuiTitle = document.createElement('span');
|
|
ftxuiTitle.textContent = 'FTXUI: ';
|
|
Object.assign(ftxuiTitle.style, {
|
|
color: 'white',
|
|
fontSize: '20px',
|
|
fontWeight: 'bold',
|
|
marginRight: '10px'
|
|
});
|
|
|
|
// 3. Create a container to hold both selectors
|
|
const container = document.createElement('div');
|
|
container.id = 'version-lang-switchers';
|
|
Object.assign(container.style, {
|
|
display: 'flex',
|
|
alignItems: 'center',
|
|
justifyContent: 'flex-end',
|
|
width: 'auto'
|
|
});
|
|
container.appendChild(ftxuiTitle);
|
|
container.appendChild(langSelect);
|
|
container.appendChild(versionSelect);
|
|
|
|
Object.assign(container.style, {
|
|
backgroundColor: 'rgba(0, 0, 0, 0.5)',
|
|
padding: '5px 10px',
|
|
borderRadius: '8px'
|
|
});
|
|
|
|
|
|
// Replace the Doxygen project number element with our container.
|
|
projectNumber.replaceWith(container);
|
|
|
|
// Clean up the original Doxygen project number text if it still exists nearby
|
|
const parent = container.parentElement;
|
|
if (parent) {
|
|
const textNode = Array.from(parent.childNodes).find(n => n.nodeType === 3 && n.textContent.trim() !== '');
|
|
if (textNode) {
|
|
textNode.remove();
|
|
}
|
|
}
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|