mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-09-16 08:04:21 +08:00
299 lines
15 KiB
HTML
299 lines
15 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: Conan</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('installation_conan.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">Conan</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="toc"><h3>Table of Contents</h3>
|
||
<ul>
|
||
<li class="level1 empty">
|
||
<ul>
|
||
<li class="level2">
|
||
<a href="#prerequisites">Prerequisites</a>
|
||
</li>
|
||
<li class="level2">
|
||
<a href="#configuration">Configuration</a>
|
||
</li>
|
||
<li class="level2">
|
||
<a href="#install-dependencies-and-build">Install Dependencies and Build</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="textblock"><p>FTXUI can be easily obtained and integrated into your project using the Conan package manager.</p>
|
||
<h2><a class="anchor" id="prerequisites"></a>
|
||
Prerequisites</h2>
|
||
<p>First, ensure that Conan is installed on your system. If not, you can install it via pip:</p>
|
||
<div class="fragment"><div class="line">pip install conan</div>
|
||
</div><!-- fragment --><p> Conan often works in tandem with CMake, so you will need to have CMake installed as well. Once you have confirmed both Conan and CMake are installed, create a project directory, for example, <code>ftxui-demo</code>:</p>
|
||
<div class="fragment"><div class="line">mkdir C:\ftxui-demo</div>
|
||
<div class="line">cd C:\ftxui-demo</div>
|
||
</div><!-- fragment --><h2><a class="anchor" id="configuration"></a>
|
||
Configuration</h2>
|
||
<p>After ensuring your environment is set up correctly, create a Conan configuration file <code>conanfile.txt</code>. This file is used to declare your project's dependencies. The community-maintained package for FTXUI can be found on <a href="https://conan.io/center/recipes/ftxui">Conan Center</a>.</p>
|
||
<dl class="section note"><dt>Note</dt><dd>This is an unofficial build script. This means it is not maintained by the FTXUI team but by the community. The package maintainer appears to actively update it to the latest releases. Many thanks to the maintainer for their work!</dd></dl>
|
||
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo</a></b></dt><dd>If you are familiar with the process, please consider adding an "official" build script to Conan Center. This could be a GitHub Action that automatically updates Conan Center upon new releases.</dd></dl>
|
||
<div class="fragment"><div class="line">[requires]</div>
|
||
<div class="line">ftxui/6.0.2</div>
|
||
<div class="line"> </div>
|
||
<div class="line">[generators]</div>
|
||
<div class="line">CMakeDeps</div>
|
||
<div class="line">CMakeToolchain</div>
|
||
<div class="line"> </div>
|
||
<div class="line">[layout]</div>
|
||
<div class="line">cmake_layout</div>
|
||
</div><!-- fragment --><h2><a class="anchor" id="install-dependencies-and-build"></a>
|
||
Install Dependencies and Build</h2>
|
||
<p>Once configured, run the following command to install FTXUI and its dependencies:</p>
|
||
<div class="fragment"><div class="line">conan install . --output-folder=build --build=missing</div>
|
||
</div><!-- fragment --><p>This will download and install <code>ftxui/6.0.2</code> along with all its dependencies from Conan's remote repositories.</p>
|
||
<p>After the installation completes, you can test it by creating a <code>demo.cpp</code> file in your project directory:</p>
|
||
<div class="fragment"><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 <<a class="code" href="elements_8hpp.html">ftxui/dom/elements.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"> <span class="keyword">auto</span> document = hbox({</div>
|
||
<div class="line"> text(<span class="stringliteral">" Hello "</span>),</div>
|
||
<div class="line"> text(<span class="stringliteral">"FTXUI "</span>) | bold | color(Color::Red),</div>
|
||
<div class="line"> text(<span class="stringliteral">" world! "</span>)</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"> std::cout << screen.ToString() << std::endl;</div>
|
||
<div class="line"> <span class="keywordflow">return</span> 0;</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>Definition</b> <a href="examples_2component_2button_8cpp_source.html#l00033">examples/component/button.cpp:33</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdoc">The FTXUI ftxui:: namespace.</div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</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>If the test is successful, you can then create a <code>CMakeLists.txt</code> file in the project directory:</p>
|
||
<div class="fragment"><div class="line">cmake_minimum_required(VERSION 3.20)</div>
|
||
<div class="line">project(ftxui-demo)</div>
|
||
<div class="line"> </div>
|
||
<div class="line"># Set the C++ standard</div>
|
||
<div class="line">set(CMAKE_CXX_STANDARD 20)</div>
|
||
<div class="line"> </div>
|
||
<div class="line"># Find the FTXUI package installed via Conan</div>
|
||
<div class="line">find_package(ftxui CONFIG REQUIRED)</div>
|
||
<div class="line"> </div>
|
||
<div class="line"># Create the executable</div>
|
||
<div class="line">add_executable(demo demo.cpp)</div>
|
||
<div class="line"> </div>
|
||
<div class="line"># Link the executable to the FTXUI library</div>
|
||
<div class="line">target_link_libraries(demo PRIVATE ftxui::component)</div>
|
||
</div><!-- fragment --><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo</a></b></dt><dd>考虑到中国多数地区使用Conan很有可能遇到各种网络问题，我想做一个定制的版本说明，但是我对conan的了解有限再加上没有找到合适的资料，因此这个计划短暂的被搁置了，如果您知道方法，欢迎在<a href="xiaoditx.girhub.io/public/docs/ftxui%E4%B8%AD%E6%96%87%E7%BF%BB%E8%AF%91/installation/conan/">中文版本</a>的下方留下评论以提醒我</dd></dl>
|
||
<hr />
|
||
<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! -->
|
||
<ul>
|
||
<li class="navelem"><a class="el" href="installation.html">Installation</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>
|