mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
234 lines
14 KiB
HTML
234 lines
14 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: ftxui::Container Namespace 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('namespaceftxui_1_1Container.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="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">ftxui::Container Namespace Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ga6471e39f5664d059144746c5801d37e6" id="r_ga6471e39f5664d059144746c5801d37e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__component.html#ga6471e39f5664d059144746c5801d37e6">Vertical</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
|
|
<tr class="memdesc:ga6471e39f5664d059144746c5801d37e6"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. <br /></td></tr>
|
||
|
|
<tr class="separator:ga6471e39f5664d059144746c5801d37e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga25099e2d2ead8a46c8d9a899982070b7" id="r_ga25099e2d2ead8a46c8d9a899982070b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__component.html#ga25099e2d2ead8a46c8d9a899982070b7">Vertical</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
||
|
|
<tr class="memdesc:ga25099e2d2ead8a46c8d9a899982070b7"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. <br /></td></tr>
|
||
|
|
<tr class="separator:ga25099e2d2ead8a46c8d9a899982070b7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga01563bae9454fe64c0b29b0eb3755e68" id="r_ga01563bae9454fe64c0b29b0eb3755e68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__component.html#ga01563bae9454fe64c0b29b0eb3755e68">Horizontal</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
|
|
<tr class="memdesc:ga01563bae9454fe64c0b29b0eb3755e68"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. <br /></td></tr>
|
||
|
|
<tr class="separator:ga01563bae9454fe64c0b29b0eb3755e68"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga337564f8a13c98222025d8fe7e47df4c" id="r_ga337564f8a13c98222025d8fe7e47df4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__component.html#ga337564f8a13c98222025d8fe7e47df4c">Horizontal</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
||
|
|
<tr class="memdesc:ga337564f8a13c98222025d8fe7e47df4c"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. <br /></td></tr>
|
||
|
|
<tr class="separator:ga337564f8a13c98222025d8fe7e47df4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaea9fe244eeeb420276bcc5760b46953d" id="r_gaea9fe244eeeb420276bcc5760b46953d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__component.html#gaea9fe244eeeb420276bcc5760b46953d">Tab</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
||
|
|
<tr class="memdesc:gaea9fe244eeeb420276bcc5760b46953d"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. <br /></td></tr>
|
||
|
|
<tr class="separator:gaea9fe244eeeb420276bcc5760b46953d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaafd394665b0c231380a143b810339d8e" id="r_gaafd394665b0c231380a143b810339d8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__component.html#gaafd394665b0c231380a143b810339d8e">Stacked</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
|
|
<tr class="memdesc:gaafd394665b0c231380a143b810339d8e"><td class="mdescLeft"> </td><td class="mdescRight">A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. <br /></td></tr>
|
||
|
|
<tr class="separator:gaafd394665b0c231380a143b810339d8e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
</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="namespaceftxui_1_1Container.html">Container</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>
|