zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-06-23 23:41:13 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
fca8e2977f
FTXUI/terminal_8hpp_source.html

266 lines
21 KiB
HTML
Raw Normal View History

deploy: 68fc9b12127bd540c8ebfd6ef70f722604e5a0cd
2025-06-20 22:18:44 +08:00
<!-- 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: terminal.hpp Source File</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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('terminal_8hpp_source.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="headertitle"><div class="title">terminal.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="terminal_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2020 Arthur Sonzogni. All rights reserved.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// the LICENSE file.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifndef FTXUI_SCREEN_TERMINAL_HPP</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define FTXUI_SCREEN_TERMINAL_HPP</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">/// @brief Dimensions is a structure that represents the size of the terminal</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">/// @ingroup screen</span></div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="group__screen.html"> 11</a></span><span class="comment"></span><span class="keyword">struct </span><a class="code hl_struct" href="group__screen.html#structftxui_1_1Dimensions">Dimensions</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="group__screen.html#a8b0f6ae031a507c3ffb7bf0eec290d46"> 12</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="group__screen.html#a8b0f6ae031a507c3ffb7bf0eec290d46">dimx</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="group__screen.html#a3a072d6ef9c51d085b44eac70f2edff6"> 13</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="group__screen.html#a3a072d6ef9c51d085b44eac70f2edff6">dimy</a>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>};</div>
</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="}">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html"> 16</a></span><span class="keyword">namespace </span>Terminal {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><a class="code hl_struct" href="group__screen.html#structftxui_1_1Dimensions">Dimensions</a> <a class="code hl_function" href="group__screen.html#gad890c37601448c82ed0d5051c29e2f0c">Size</a>();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceftxui_1_1Terminal.html#a765662bcabb59dc93884674ee2fcc9fc">SetFallbackSize</a>(<span class="keyword">const</span> <a class="code hl_struct" href="group__screen.html#structftxui_1_1Dimensions">Dimensions</a>&amp; fallbackSize);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">/// @brief Color is an enumeration that represents the color support of the</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/// terminal.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/// @ingroup screen</span></div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="group__screen.html#gab87bacfdad76e61b9412d7124be44c1c"> 23</a></span><span class="comment"></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="group__screen.html#gab87bacfdad76e61b9412d7124be44c1c">Color</a> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41"> 24</a></span> <a class="code hl_enumvalue" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41">Palette1</a>,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349"> 25</a></span> <a class="code hl_enumvalue" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349">Palette16</a>,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876"> 26</a></span> <a class="code hl_enumvalue" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876">Palette256</a>,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29"> 27</a></span> <a class="code hl_enumvalue" href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29">TrueColor</a>,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>};</div>
</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><a class="code hl_class" href="group__screen.html#classftxui_1_1Color">Color</a> <a class="code hl_function" href="group__screen.html#gae6e034f37aa66cfe4458a8cb6e8fc526">ColorSupport</a>();</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__dom.html#ga65945a706131f407a47a1b9960dc1a4a">SetColorSupport</a>(<a class="code hl_class" href="group__screen.html#classftxui_1_1Color">Color</a> color);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>} <span class="comment">// namespace Terminal</span></div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>} <span class="comment">// namespace ftxui</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#endif </span><span class="comment">// FTXUI_SCREEN_TERMINAL_HPP</span></div>
<div class="ttc" id="agroup__dom_html_ga65945a706131f407a47a1b9960dc1a4a"><div class="ttname"><a href="group__dom.html#ga65945a706131f407a47a1b9960dc1a4a">ftxui::Terminal::SetColorSupport</a></div><div class="ttdeci">void SetColorSupport(Color color)</div><div class="ttdoc">Override terminal color support in case auto-detection fails.</div><div class="ttdef"><b>Definition</b> <a href="terminal_8cpp_source.html#l00140">terminal.cpp:140</a></div></div>
<div class="ttc" id="agroup__screen_html_a3a072d6ef9c51d085b44eac70f2edff6"><div class="ttname"><a href="group__screen.html#a3a072d6ef9c51d085b44eac70f2edff6">ftxui::Dimensions::dimy</a></div><div class="ttdeci">int dimy</div><div class="ttdef"><b>Definition</b> <a href="#l00013">terminal.hpp:13</a></div></div>
<div class="ttc" id="agroup__screen_html_a8b0f6ae031a507c3ffb7bf0eec290d46"><div class="ttname"><a href="group__screen.html#a8b0f6ae031a507c3ffb7bf0eec290d46">ftxui::Dimensions::dimx</a></div><div class="ttdeci">int dimx</div><div class="ttdef"><b>Definition</b> <a href="#l00012">terminal.hpp:12</a></div></div>
<div class="ttc" id="agroup__screen_html_classftxui_1_1Color"><div class="ttname"><a href="group__screen.html#classftxui_1_1Color">ftxui::Color</a></div><div class="ttdoc">Color is a class that represents a color in the terminal user interface.</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00022">color.hpp:22</a></div></div>
<div class="ttc" id="agroup__screen_html_gab87bacfdad76e61b9412d7124be44c1c"><div class="ttname"><a href="group__screen.html#gab87bacfdad76e61b9412d7124be44c1c">ftxui::Terminal::Color</a></div><div class="ttdeci">Color</div><div class="ttdoc">Color is an enumeration that represents the color support of the terminal.</div><div class="ttdef"><b>Definition</b> <a href="#l00023">terminal.hpp:23</a></div></div>
<div class="ttc" id="agroup__screen_html_gad890c37601448c82ed0d5051c29e2f0c"><div class="ttname"><a href="group__screen.html#gad890c37601448c82ed0d5051c29e2f0c">ftxui::Terminal::Size</a></div><div class="ttdeci">Dimensions Size()</div><div class="ttdoc">Get the terminal size.</div><div class="ttdef"><b>Definition</b> <a href="terminal_8cpp_source.html#l00094">terminal.cpp:94</a></div></div>
<div class="ttc" id="agroup__screen_html_gae6e034f37aa66cfe4458a8cb6e8fc526"><div class="ttname"><a href="group__screen.html#gae6e034f37aa66cfe4458a8cb6e8fc526">ftxui::Terminal::ColorSupport</a></div><div class="ttdeci">Color ColorSupport()</div><div class="ttdoc">Get the color support of the terminal.</div><div class="ttdef"><b>Definition</b> <a href="terminal_8cpp_source.html#l00130">terminal.cpp:130</a></div></div>
<div class="ttc" id="agroup__screen_html_ggab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29"><div class="ttname"><a href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29">ftxui::Terminal::TrueColor</a></div><div class="ttdeci">@ TrueColor</div><div class="ttdef"><b>Definition</b> <a href="#l00027">terminal.hpp:27</a></div></div>
<div class="ttc" id="agroup__screen_html_ggab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876"><div class="ttname"><a href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876">ftxui::Terminal::Palette256</a></div><div class="ttdeci">@ Palette256</div><div class="ttdef"><b>Definition</b> <a href="#l00026">terminal.hpp:26</a></div></div>
<div class="ttc" id="agroup__screen_html_ggab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349"><div class="ttname"><a href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349">ftxui::Terminal::Palette16</a></div><div class="ttdeci">@ Palette16</div><div class="ttdef"><b>Definition</b> <a href="#l00025">terminal.hpp:25</a></div></div>
<div class="ttc" id="agroup__screen_html_ggab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41"><div class="ttname"><a href="group__screen.html#ggab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41">ftxui::Terminal::Palette1</a></div><div class="ttdeci">@ Palette1</div><div class="ttdef"><b>Definition</b> <a href="#l00024">terminal.hpp:24</a></div></div>
<div class="ttc" id="agroup__screen_html_structftxui_1_1Dimensions"><div class="ttname"><a href="group__screen.html#structftxui_1_1Dimensions">ftxui::Dimensions</a></div><div class="ttdoc">Dimensions is a structure that represents the size of the terminal.</div><div class="ttdef"><b>Definition</b> <a href="#l00011">terminal.hpp:11</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_a765662bcabb59dc93884674ee2fcc9fc"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#a765662bcabb59dc93884674ee2fcc9fc">ftxui::Terminal::SetFallbackSize</a></div><div class="ttdeci">void SetFallbackSize(const Dimensions &amp;fallbackSize)</div><div class="ttdoc">Override terminal size in case auto-detection fails.</div><div class="ttdef"><b>Definition</b> <a href="terminal_8cpp_source.html#l00124">terminal.cpp:124</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><!-- fragment --></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7f0d124f4cd00c9c7b5b93f60cb4ae34.html">ftxui</a></li><li class="navelem"><a class="el" href="dir_53f6d8d3eb5689656c3f196f1d99fcb2.html">screen</a></li><li class="navelem"><a class="el" href="terminal_8hpp.html">terminal.hpp</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>
Reference in New Issue Copy Permalink