mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
284 lines
13 KiB
HTML
284 lines
13 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: C++20 Modules</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('cpp20-modules.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><div class="header">
|
||
|
|
<div class="headertitle"><div class="title">C++20 Modules</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><dl class="section warning"><dt>Warning</dt><dd>This feature is still in development, and the API may change in future releases. Your contribution is needed to help us improve the compatibility and usability of C++20 modules in FTXUI. If you encounter any issues or have suggestions, please open an issue.</dd></dl>
|
||
|
|
<p>FTXUI experimentally supports <a href="https://en.cppreference.com/w/cpp/language/modules">C++20 modules</a> to reduce compilation times and improve code organization. Each header has a corresponding module.</p>
|
||
|
|
<p><b>Example with CMake and Ninja</b></p>
|
||
|
|
<div class="fragment"><div class="line"><span class="keyword">import</span> <a class="code" href="module__ftxui.html">ftxui</a>;</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> button = <a class="code hl_function" href="group__component.html#ga4e8295ec77dd31b0acc5063b134473e7">ftxui::Button</a>(<span class="stringliteral">"Click me"</span>, screen.QuitClosure());</div>
|
||
|
|
<div class="line"> screen.Loop(button);</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> 0;</div>
|
||
|
|
<div class="line">}</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#l00004">examples/component/button.cpp:4</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#l00407">screen_interactive.cpp:407</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">Draw a button. Execute a function when clicked.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2button_8cpp_source.html#l00176">src/ftxui/component/button.cpp:176</a></div></div>
|
||
|
|
<div class="ttc" id="amodule__ftxui_html"><div class="ttname"><a href="module__ftxui.html">ftxui</a></div><div class="ttdoc">Module file re-exporting all FTXUI submodules.</div></div>
|
||
|
|
</div><!-- fragment --><div class="fragment"><div class="line">cmake \</div>
|
||
|
|
<div class="line"> -DCMAKE_GENERATOR=Ninja \</div>
|
||
|
|
<div class="line"> -DFTXUI_BUILD_MODULES=ON \</div>
|
||
|
|
<div class="line"> ..</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line">ninja</div>
|
||
|
|
</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>To use modules, you need a C++20 compatible compiler, CMake version 3.20 or higher, and use a compatible generator like Ninja. Note that Makefile generators <b>do not support modules</b>.</dd></dl>
|
||
|
|
<h3><a class="anchor" id="module-list"></a>
|
||
|
|
Module list</h3>
|
||
|
|
<p>The modules directly reference the corresponding header, or a group of related headers to provide a more convenient interface. The following modules are available:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>ftxui</code><ul>
|
||
|
|
<li><code>ftxui.component</code><ul>
|
||
|
|
<li><code>ftxui.component.Animation</code></li>
|
||
|
|
<li><code>ftxui.component.CapturedMouse</code></li>
|
||
|
|
<li><code>ftxui.component.Component</code></li>
|
||
|
|
<li><code>ftxui.component.ComponentBase</code></li>
|
||
|
|
<li><code>ftxui.component.ComponentOptions</code></li>
|
||
|
|
<li><code>ftxui.component.Event</code></li>
|
||
|
|
<li><code>ftxui.component.Loop</code></li>
|
||
|
|
<li><code>ftxui.component.Mouse</code></li>
|
||
|
|
<li><code>ftxui.component.Receiver</code></li>
|
||
|
|
<li><code>ftxui.component.ScreenInteractive</code></li>
|
||
|
|
<li><code>ftxui.component.Task</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><code>ftxui.dom</code><ul>
|
||
|
|
<li><code>ftxui.dom.Canvas</code></li>
|
||
|
|
<li><code>ftxui.dom.Deprecated</code></li>
|
||
|
|
<li><code>ftxui.dom.Direction</code></li>
|
||
|
|
<li><code>ftxui.dom.Elements</code></li>
|
||
|
|
<li><code>ftxui.dom.FlexboxConfig</code></li>
|
||
|
|
<li><code>ftxui.dom.LinearGradient</code></li>
|
||
|
|
<li><code>ftxui.dom.Node</code></li>
|
||
|
|
<li><code>ftxui.dom.Requirement</code></li>
|
||
|
|
<li><code>ftxui.dom.Selection</code></li>
|
||
|
|
<li><code>ftxui.dom.Table</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><code>ftxui.screen</code><ul>
|
||
|
|
<li><code>ftxui.screen.Box</code></li>
|
||
|
|
<li><code>ftxui.screen.Color</code></li>
|
||
|
|
<li><code>ftxui.screen.ColorInfo</code></li>
|
||
|
|
<li><code>ftxui.screen.Deprecated</code></li>
|
||
|
|
<li><code>ftxui.screen.Image</code></li>
|
||
|
|
<li><code>ftxui.screen.Pixel</code></li>
|
||
|
|
<li><code>ftxui.screen.Screen</code></li>
|
||
|
|
<li><code>ftxui.screen.String</code></li>
|
||
|
|
<li><code>ftxui.screen.Terminal</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><code><a class="el" href="namespaceftxui_1_1util.html">ftxui.util</a></code><ul>
|
||
|
|
<li><code>ftxui.util.AutoReset</code></li>
|
||
|
|
<li><code>ftxui.util.Ref</code> </li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div></div><!-- contents -->
|
||
|
|
</div><!-- PageDoc -->
|
||
|
|
</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="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>
|