mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
495 lines
26 KiB
HTML
495 lines
26 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: ftxui / screen</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('module-screen.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">ftxui / screen</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="toc"><h3>目录</h3>
|
||
<ul>
|
||
<li class="level1 empty">
|
||
<ul>
|
||
<li class="level2 empty">
|
||
<ul>
|
||
<li class="level3">
|
||
<a href="#ftxuiscreen-1">ftxui::Screen</a>
|
||
</li>
|
||
<li class="level3">
|
||
<a href="#ftxuidimension">ftxui::Dimension</a>
|
||
</li>
|
||
<li class="level3">
|
||
<a href="#ftxuipixel">ftxui::Pixel</a>
|
||
</li>
|
||
<li class="level3">
|
||
<a href="#ftxuicolor">ftxui::Color</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="textblock"><p><img src="https://nsm09.casimages.com/img/2025/05/31//2505310207423242518595348.png" alt="title-img" class="inline"/></p>
|
||
<p><code>ftxui::screen</code> 模块是底层基础。它可以独立使用,但主要设计用于与 <a href="module-dom.html">ftxui::dom</a> 和 <a href="module-component.html">ftxui::component</a> 模块结合使用。</p>
|
||
<p>It provides a <a class="el" href="group__screen.html#classftxui_1_1Screen">ftxui::Screen</a>.</p>
|
||
<hr />
|
||
<h3><a class="anchor" id="ftxuiscreen-1"></a>
|
||
ftxui::Screen</h3>
|
||
<p><a class="el" href="group__screen.html#classftxui_1_1Screen">ftxui::Screen</a> 类表示一个 2D 样式字符网格,可以渲染到终端。 它提供了创建屏幕、访问像素和渲染元素的方法。</p>
|
||
<p>您可以使用 <a class="el" href="group__screen.html#a483f8ee1967e200cfc9e277b3ce00174">ftxui::Screen::PixelAt</a> 方法访问屏幕的单个单元格 (<a class="el" href="group__screen.html#structftxui_1_1Pixel">ftxui::Pixel</a>),该方法返回指定坐标处像素的引用。</p>
|
||
<p><b>Example</b> </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="color_8hpp.html">ftxui/screen/color.hpp</a>></span></div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="keywordtype">void</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__screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a>(</div>
|
||
<div class="line"> ftxui::Dimension::Full(), <span class="comment">// Use full terminal width</span></div>
|
||
<div class="line"> ftxui::Dimension::Fixed(10) <span class="comment">// Fixed height of 10 rows</span></div>
|
||
<div class="line"> );</div>
|
||
<div class="line"> </div>
|
||
<div class="line"> <span class="comment">// Access a specific pixel at (10, 5)</span></div>
|
||
<div class="line"> <span class="keyword">auto</span>& pixel = screen.PixelAt(10, 5);</div>
|
||
<div class="line"> </div>
|
||
<div class="line"> <span class="comment">// Set properties of the pixel.</span></div>
|
||
<div class="line"> pixel.character = U<span class="charliteral">'X'</span>;</div>
|
||
<div class="line"> pixel.foreground_color = <a class="code hl_enumvalue" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a>;</div>
|
||
<div class="line"> pixel.background_color = <a class="code hl_function" href="group__screen.html#aacec69e0aa1063fbec2cc305e7b076dd">ftxui::Color::RGB</a>(0, 255, 0);</div>
|
||
<div class="line"> pixel.bold = <span class="keyword">true</span>; <span class="comment">// Set bold style</span></div>
|
||
<div class="line"> screen.Print(); <span class="comment">// Print the screen to the terminal</span></div>
|
||
<div class="line">}</div>
|
||
<div class="ttc" id="acolor_8hpp_html"><div class="ttname"><a href="color_8hpp.html">color.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__screen_html_a32b98be0603ace46d6dc9d05b330a9fd"><div class="ttname"><a href="group__screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a></div><div class="ttdeci">static Screen Create(Dimensions dimension)</div><div class="ttdoc">创建一个具有给定维度的屏幕。</div><div class="ttdef"><b>定义</b> <a href="screen_8cpp_source.html#l00394">screen.cpp:394</a></div></div>
|
||
<div class="ttc" id="agroup__screen_html_aacec69e0aa1063fbec2cc305e7b076dd"><div class="ttname"><a href="group__screen.html#aacec69e0aa1063fbec2cc305e7b076dd">ftxui::Color::RGB</a></div><div class="ttdeci">static Color RGB(uint8_t red, uint8_t green, uint8_t blue)</div><div class="ttdoc">从其 RGB 表示构建一个颜色。 https://en.wikipedia.org/wiki/RGB_color_model</div><div class="ttdef"><b>定义</b> <a href="screen_2color_8cpp_source.html#l00146">screen/color.cpp:146</a></div></div>
|
||
<div class="ttc" id="agroup__screen_html_ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743"><div class="ttname"><a href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a></div><div class="ttdeci">@ Red</div><div class="ttdef"><b>定义</b> <a href="color_8hpp_source.html#l00053">color.hpp:53</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 --><dl class="section note"><dt>注解</dt><dd>如果坐标超出边界,则返回一个虚拟像素。</dd></dl>
|
||
<p>屏幕可以使用 <a class="el" href="group__screen.html#ad93edbe885499a712129356f1ffd506b">ftxui::Screen::Print()</a> 打印到终端,或使用 <a class="el" href="group__screen.html#a19c380b03cea21d7ac7325136a131ff0">ftxui::Screen::ToString()</a> 转换为 std::string。</p>
|
||
<div class="tabbed"></div><div class="tabbed"><ul>
|
||
<li><b class="tab-title">Print()</b> <div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ...;</div>
|
||
<div class="line">screen.Print();</div>
|
||
</div><!-- fragment --></li>
|
||
<li><b class="tab-title">ToString()</b> <div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ...;</div>
|
||
<div class="line">std::cout << screen.ToString();</div>
|
||
</div><!-- fragment --></li>
|
||
</ul>
|
||
</div><div class="tabbed"></div><p>请注意,您可以在打印后通过调用 ftxui::Screen::ResetCursorPosition() 将光标位置重置到屏幕的左上角。</p>
|
||
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ...;</div>
|
||
<div class="line"><span class="keywordflow">while</span>(<span class="keyword">true</span>) {</div>
|
||
<div class="line"> <span class="comment">// Drawing operations:</span></div>
|
||
<div class="line"> ...</div>
|
||
<div class="line"> </div>
|
||
<div class="line"> <span class="comment">// Print the screen to the terminal. Then reset the cursor position and the</span></div>
|
||
<div class="line"> <span class="comment">// screen content.</span></div>
|
||
<div class="line"> std::cout << screen.ToString();</div>
|
||
<div class="line"> std::cout << screen.ResetCursorPosition(<span class="comment">/*clear=*/</span><span class="keyword">true</span>);</div>
|
||
<div class="line"> std::cout << std::flush;</div>
|
||
<div class="line"> </div>
|
||
<div class="line"> <span class="comment">// Sleep for a short duration to control the refresh rate.</span></div>
|
||
<div class="line"> std::this_thread::sleep_for(std::chrono::milliseconds(100));</div>
|
||
<div class="line">}</div>
|
||
</div><!-- fragment --><hr />
|
||
<h3><a class="anchor" id="ftxuidimension"></a>
|
||
ftxui::Dimension</h3>
|
||
<p><a class="el" href="namespaceftxui_1_1Dimension.html">ftxui::Dimension</a> 工具控制屏幕尺寸:</p>
|
||
<ul>
|
||
<li><code>Dimension::Full()</code> — 使用完整的终端宽度或高度</li>
|
||
<li><code>Dimension::Fit(element)</code> — 尺寸以适应渲染的 <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></li>
|
||
<li><code>Dimension::Fixed(n)</code> — 精确使用 <code>n</code> 列或行</li>
|
||
</ul>
|
||
<p>这些值将传递给 <code><a class="el" href="group__screen.html#a32b98be0603ace46d6dc9d05b330a9fd" title="创建一个具有给定维度的屏幕。">ftxui::Screen::Create()</a></code>。</p>
|
||
<p><a class="el" href="group__screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create()</a> 提供了两个重载:</p>
|
||
<ul>
|
||
<li><code>Screen::Create(Dimension)</code> 将宽度和高度都设置为相同类型的尺寸</li>
|
||
<li><code>Screen::Create(Dimension width, Dimension height)</code> 允许对每个轴进行不同的控制</li>
|
||
</ul>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="group__screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a>(</div>
|
||
<div class="line"> ftxui::Dimension::Full(), <span class="comment">// width</span></div>
|
||
<div class="line"> ftxui::Dimension::Fixed(10) <span class="comment">// height</span></div>
|
||
<div class="line">);</div>
|
||
</div><!-- fragment --><p>Once created, render an element and display the result:</p>
|
||
<div class="fragment"><div class="line"><a class="code hl_function" href="group__dom.html#gad4b8aa9392f56ba41e2b421e046a7d83">ftxui::Render</a>(screen, element);</div>
|
||
<div class="line">screen.Print();</div>
|
||
<div class="ttc" id="agroup__dom_html_gad4b8aa9392f56ba41e2b421e046a7d83"><div class="ttname"><a href="group__dom.html#gad4b8aa9392f56ba41e2b421e046a7d83">ftxui::Render</a></div><div class="ttdeci">void Render(Screen &screen, const Element &element)</div><div class="ttdoc">在 ftxui::Screen 上显示元素。</div><div class="ttdef"><b>定义</b> <a href="node_8cpp_source.html#l00084">node.cpp:84</a></div></div>
|
||
</div><!-- fragment --><hr />
|
||
<h3><a class="anchor" id="ftxuipixel"></a>
|
||
ftxui::Pixel</h3>
|
||
<p>屏幕网格中的每个单元格都是一个 ftxui::Pixel,它包含:</p>
|
||
<ul>
|
||
<li>Unicode 码点。<ul>
|
||
<li><code>character</code></li>
|
||
</ul>
|
||
</li>
|
||
<li>ftxui::Color:<ul>
|
||
<li><code>foreground_color</code></li>
|
||
<li><code>background_color</code></li>
|
||
</ul>
|
||
</li>
|
||
<li>布尔值:<ul>
|
||
<li><code>blink</code></li>
|
||
<li><code>bold</code></li>
|
||
<li><code>dim</code></li>
|
||
<li><code>italic</code></li>
|
||
<li><code>inverted</code> (交换前景色和背景色)</li>
|
||
<li><code>underlined</code></li>
|
||
<li><code>underlined_double</code></li>
|
||
<li><code>strikethrough</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="group__screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a>(</div>
|
||
<div class="line"> ftxui::Dimension::Fixed(5),</div>
|
||
<div class="line"> ftxui::Dimension::Fixed(5),</div>
|
||
<div class="line">);</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="keyword">auto</span>& pixel = screen.PixelAt(3, 3);</div>
|
||
<div class="line">pixel.character = U<span class="charliteral">'X'</span>;</div>
|
||
<div class="line">pixel.bold = <span class="keyword">true</span>;</div>
|
||
<div class="line">pixel.foreground_color = <a class="code hl_enumvalue" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a>;</div>
|
||
<div class="line">pixel.background_color = <a class="code hl_function" href="group__screen.html#aacec69e0aa1063fbec2cc305e7b076dd">ftxui::Color::RGB</a>(0, 255, 0);</div>
|
||
<div class="line"> </div>
|
||
<div class="line">screen.Print();</div>
|
||
</div><!-- fragment --><dl class="section note"><dt>注解</dt><dd><code>PixelAt(x, y)</code> 执行边界检查并返回指定坐标处像素的引用。 如果超出边界,则返回一个虚拟像素引用。</dd></dl>
|
||
<p>屏幕中的每个单元格都是一个 ftxui::Pixel。您可以使用以下方式修改它们:</p>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span>& pixel = screen.PixelAt(x, y);</div>
|
||
<div class="line">pixel.character = U<span class="charliteral">'X'</span>;</div>
|
||
<div class="line">pixel.bold = <span class="keyword">true</span>;</div>
|
||
<div class="line">pixel.foreground_color = Color::Red;</div>
|
||
</div><!-- fragment --><hr />
|
||
<h3><a class="anchor" id="ftxuicolor"></a>
|
||
ftxui::Color</h3>
|
||
<p><a class="el" href="group__screen.html#classftxui_1_1Color">ftxui::Color</a> 类用于定义每个 <a class="el" href="group__screen.html#structftxui_1_1Pixel">ftxui::Pixel</a> 的前景色和背景色。</p>
|
||
<p>它支持各种颜色空间和预定义调色板。如果终端不支持请求的颜色,FTXUI 将 动态回退到终端中最接近的可用颜色。</p>
|
||
<p><b>颜色空间</b></p>
|
||
<ul>
|
||
<li><b>默认**:<code><a class="el" href="group__screen.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">ftxui::Color::Default</a></code> (终端的默认颜色)</b></li>
|
||
<li><b>**16 色调色板</b> <a href="https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_gallery">Demo</a>:<ul>
|
||
<li><code><a class="el" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802fac1e9bce8242f443c54c7405223d616cd">ftxui::Color::Black</a></code>,</li>
|
||
<li><code><a class="el" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a></code>,</li>
|
||
<li>...</li>
|
||
</ul>
|
||
</li>
|
||
<li><b>256 色调色板</b> <a href="https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_palette256">Demo</a>:<ul>
|
||
<li><code><a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa7d2d4cc3af6756a4eac7d12fbe4775d4">ftxui::Color::Chartreuse1</a></code>,</li>
|
||
<li><code><a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa0c92c7e17edeca09b7c63c8a783a562f">ftxui::Color::DarkViolet</a></code>,</li>
|
||
<li>...</li>
|
||
</ul>
|
||
</li>
|
||
<li><b>真彩色</b> (24 位) [Demo](<a href="https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_truecolor_HSV:">https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_truecolor_HSV:</a><ul>
|
||
<li><code><a class="el" href="group__screen.html#aacec69e0aa1063fbec2cc305e7b076dd" title="从其 RGB 表示构建一个颜色。 https://en.wikipedia.org/wiki/RGB_color_model">ftxui::Color::RGB(uint8_t red, uint8_t green, uint8_t blue)</a></code></li>
|
||
<li><code><a class="el" href="group__screen.html#a1a119fd00beafc7d2aa5f94518e38fc5" title="从其 HSV 表示构建一个颜色。 https://en.wikipedia.org/wiki/HSL_and_HSV">ftxui::Color::HSV(uint8_t h, uint8_t s, uint8_t v)</a></code>。</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<dl class="section note"><dt>注解</dt><dd>您可以使用 <a class="el" href="group__screen.html#gae6e034f37aa66cfe4458a8cb6e8fc526">ftxui::Terminal::ColorSupport()</a> 查询终端功能; <br />
|
||
<br />
|
||
这可以使用 <a class="el" href="group__dom.html#ga65945a706131f407a47a1b9960dc1a4a">ftxui::Terminal::SetColorSupport()</a> 手动设置。 </dd></dl>
|
||
</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>
|