mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-15 09:28:59 +08:00
352 lines
14 KiB
HTML
352 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: Arch Linux</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">
|
||
|
|
// Ignore non english pages and/or the main page.
|
||
|
|
const excluded_lang = [
|
||
|
|
"/de",
|
||
|
|
"/es",
|
||
|
|
"/fr",
|
||
|
|
"/it",
|
||
|
|
"/ja",
|
||
|
|
"/ja",
|
||
|
|
"/ko"
|
||
|
|
"/ru",
|
||
|
|
"/zh-CH",
|
||
|
|
"/zh-TW",
|
||
|
|
]
|
||
|
|
if (excluded_lang.some(lang => window.location.pathname.startsWith(lang)) ||
|
||
|
|
window.location.pathname.endsWith("index.html")) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
// 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('installation_arch.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">Arch Linux</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><p>FTXUI is packaged on the AUR. Install using an AUR helper:</p>
|
||
|
|
<div class="fragment"><div class="line">yay -S ftxui</div>
|
||
|
|
</div><!-- fragment --><p>You can also manually download the PKGBUILD from <a href="https://aur.archlinux.org/packages/ftxui">https://aur.archlinux.org/packages/ftxui</a>.</p>
|
||
|
|
<p>Once installed, you can use it in your CMake projects by adding the following to your <code>CMakeLists.txt</code>:</p>
|
||
|
|
<div class="fragment"><div class="line">find_package(ftxui REQUIRED)</div>
|
||
|
|
<div class="line">add_executable(main main.cpp)</div>
|
||
|
|
<div class="line">target_link_libraries(main</div>
|
||
|
|
<div class="line"> PRIVATE ftxui::screen</div>
|
||
|
|
<div class="line"> PRIVATE ftxui::dom</div>
|
||
|
|
<div class="line"> PRIVATE ftxui::component</div>
|
||
|
|
<div class="line">)</div>
|
||
|
|
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>This is an unofficial package. That means it is not maintained by the FTXUI team, but by the community. The package maintainers seems to actively update the package to the latest version. Thanks to the maintainers for their work!</dd></dl>
|
||
|
|
<div class="section_buttons"></div><div class="section_buttons"><table class="markdownTable">
|
||
|
|
<tr class="markdownTableHead">
|
||
|
|
<th class="markdownTableHeadLeft">Previous </th></tr>
|
||
|
|
<tr class="markdownTableRowOdd">
|
||
|
|
<td class="markdownTableBodyLeft"><a href="getting-started.html">Getting Started</a> </td></tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="section_buttons"></div> </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! -->
|
||
|
|
</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": "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", "v6.1.9", "v6.1.8", "v6.1.7", "v6.1.6", "v6.1.5", "v6.1.4", "v6.1.3", "v6.1.2", "v6.1.1", "v6.1.0", "v6.0.2", "v6.0.1", "v6.0.0", "v5.0.0", "v4.1.1", "v4.1.0", "v4.0.0", "v3.0.0", "v2.0.0", "v0.9", "v0.11", "v0.10"];
|
||
|
|
const version_paths = {"main": "index.html", "v6.1.9": "en/v6.1.9/index.html", "v6.1.8": "en/v6.1.8/index.html", "v6.1.7": "en/v6.1.7/index.html", "v6.1.6": "en/v6.1.6/index.html", "v6.1.5": "en/v6.1.5/index.html", "v6.1.4": "en/v6.1.4/index.html", "v6.1.3": "en/v6.1.3/index.html", "v6.1.2": "en/v6.1.2/index.html", "v6.1.1": "en/v6.1.1/index.html", "v6.1.0": "en/v6.1.0/index.html", "v6.0.2": "en/v6.0.2/index.html", "v6.0.1": "en/v6.0.1/index.html", "v6.0.0": "en/v6.0.0/index.html", "v5.0.0": "en/v5.0.0/index.html", "v4.1.1": "en/v4.1.1/index.html", "v4.1.0": "en/v4.1.0/index.html", "v4.0.0": "en/v4.0.0/index.html", "v3.0.0": "en/v3.0.0/index.html", "v2.0.0": "en/v2.0.0/index.html", "v0.9": "en/v0.9/index.html", "v0.11": "en/v0.11/index.html", "v0.10": "en/v0.10/index.html"};
|
||
|
|
const currentLang = "en";
|
||
|
|
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>
|