mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
377 lines
17 KiB
HTML
377 lines
17 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="zh">
|
||
<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: 入门</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 -->
|
||
<!-- 制作者 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','搜索',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('getting-started.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">载入中...</div>
|
||
<div class="SRStatus" id="Searching">搜索中...</div>
|
||
<div class="SRStatus" id="NoMatches">未找到</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div><div class="header">
|
||
<div class="headertitle"><div class="title">入门</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="toc"><h3>目录</h3>
|
||
<ul>
|
||
<li class="level1">
|
||
<a href="#安装-ftxui">安装 FTXUI</a>
|
||
</li>
|
||
<li class="level1">
|
||
<a href="#最小示例">最小示例</a>
|
||
</li>
|
||
<li class="level1">
|
||
<a href="#入门模板">入门模板</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="textblock"><p><img src="https://nsm09.casimages.com/img/2025/05/30//2505300816063242518595256.jpg" alt="title-img" class="inline"/></p>
|
||
<h1><a class="anchor" id="安装-ftxui"></a>
|
||
安装 FTXUI</h1>
|
||
<p>要在您的项目中设置 FTXUI，请遵循<a href="installation.html">安装指南</a>，其中提供了适用于多种构建系统和包管理器的说明。</p>
|
||
<h1><a class="anchor" id="最小示例"></a>
|
||
最小示例</h1>
|
||
<p>将以下代码保存为 <code>main.cpp</code>：</p>
|
||
<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="elements_8hpp.html">ftxui/dom/elements.hpp</a>></span></div>
|
||
<div class="line"><span class="preprocessor">#include <<a class="code" href="screen_8hpp.html">ftxui/screen/screen.hpp</a>></span></div>
|
||
<div class="line"><span class="preprocessor">#include <iostream></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">using namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>;</div>
|
||
<div class="line"> </div>
|
||
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = hbox({</div>
|
||
<div class="line"> text(<span class="stringliteral">"left"</span>) | <a class="code hl_function" href="group__dom.html#gae8537acd423d47cf07e61bd774fb1098">border</a>,</div>
|
||
<div class="line"> text(<span class="stringliteral">"middle"</span>) | border | flex,</div>
|
||
<div class="line"> text(<span class="stringliteral">"right"</span>) | <a class="code hl_function" href="group__dom.html#gae8537acd423d47cf07e61bd774fb1098">border</a>,</div>
|
||
<div class="line"> });</div>
|
||
<div class="line"> </div>
|
||
<div class="line"> <span class="keyword">auto</span> screen = Screen::Create(Dimension::Full(), Dimension::Fit(document));</div>
|
||
<div class="line"> Render(screen, document);</div>
|
||
<div class="line"> screen.Print();</div>
|
||
<div class="line">}</div>
|
||
<div class="ttc" id="aelements_8hpp_html"><div class="ttname"><a href="elements_8hpp.html">elements.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>定义</b> <a href="examples_2component_2button_8cpp_source.html#l00033">examples/component/button.cpp:33</a></div></div>
|
||
<div class="ttc" id="agroup__dom_html_gae8537acd423d47cf07e61bd774fb1098"><div class="ttname"><a href="group__dom.html#gae8537acd423d47cf07e61bd774fb1098">border</a></div><div class="ttdeci">Element border(Element child)</div><div class="ttdoc">在元素周围绘制边框。</div><div class="ttdef"><b>定义</b> <a href="src_2ftxui_2dom_2border_8cpp_source.html#l00225">src/ftxui/dom/border.cpp:225</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdoc">#include "ftxui/component/component_base.hpp" // 用于 ComponentBase</div><div class="ttdef"><b>定义</b> <a href="animation_8hpp_source.html#l00009">animation.hpp:9</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a2bc31f2d685189e5c61d2293a1f51b4f"><div class="ttname"><a href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></div><div class="ttdeci">std::shared_ptr< Node > Element</div><div class="ttdef"><b>定义</b> <a href="elements_8hpp_source.html#l00022">elements.hpp:22</a></div></div>
|
||
<div class="ttc" id="ascreen_8hpp_html"><div class="ttname"><a href="screen_8hpp.html">screen.hpp</a></div></div>
|
||
</div><!-- fragment --><p>使用您首选的构建系统构建并运行它。 <br />
|
||
如果不确定，请从<a href="installation.html">安装页面</a>中描述的方法之一开始。</p>
|
||
<p>预期输出：</p>
|
||
<div class="fragment"><div class="line">┌────┐┌────────────────────────────────────┐┌─────┐</div>
|
||
<div class="line">│left││middle ││right│</div>
|
||
<div class="line">└────┘└────────────────────────────────────┘└─────┘</div>
|
||
</div><!-- fragment --><h1><a class="anchor" id="入门模板"></a>
|
||
入门模板</h1>
|
||
<p>对于一个完整的工作项目，克隆官方入门存储库：</p>
|
||
<div class="fragment"><div class="line">git clone https://github.com/ArthurSonzogni/ftxui-starter</div>
|
||
</div><!-- fragment --><p>遵循该存储库 <code>README.md</code> 中的构建说明。</p>
|
||
<div class="section_buttons"></div><div class="section_buttons"><table class="markdownTable">
|
||
<tr class="markdownTableHead">
|
||
<th class="markdownTableHeadLeft">上一个 </th><th class="markdownTableHeadRight">下一个 </th></tr>
|
||
<tr class="markdownTableRowOdd">
|
||
<td class="markdownTableBodyLeft"><a href="index.html">简介</a> </td><td class="markdownTableBodyRight"><a href="modules.html">模块</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": "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"];
|
||
const version_paths = {"main": "index.html"};
|
||
const currentLang = "zh-CH";
|
||
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>
|