Files
FTXUI/en/v6.0.1/terminal_8hpp_source.html
2025-11-12 12:56:59 +00:00

220 lines
19 KiB
HTML

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="cache-control" content="max-age=86400"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FTXUI: include/ftxui/screen/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>
<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_extra.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FTXUI
&#160;<span id="projectnumber">6.0.1</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="foldopen" id="foldopen00008" data-start="{" data-end="};">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="namespaceftxui.html"> 8</a></span><span class="keyword">struct </span><a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="namespaceftxui.html#a8b0f6ae031a507c3ffb7bf0eec290d46"> 9</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceftxui.html#a8b0f6ae031a507c3ffb7bf0eec290d46">dimx</a>;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="namespaceftxui.html#a3a072d6ef9c51d085b44eac70f2edff6"> 10</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceftxui.html#a3a072d6ef9c51d085b44eac70f2edff6">dimy</a>;</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>};</div>
</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html"> 13</a></span><span class="keyword">namespace </span>Terminal {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> <a class="code hl_function" href="namespaceftxui_1_1Terminal.html#ad890c37601448c82ed0d5051c29e2f0c">Size</a>();</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</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="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a>&amp; fallbackSize);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1c"> 17</a></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1c">Color</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41"> 18</a></span> <a class="code hl_enumvalue" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41">Palette1</a>,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349"> 19</a></span> <a class="code hl_enumvalue" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349">Palette16</a>,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876"> 20</a></span> <a class="code hl_enumvalue" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876">Palette256</a>,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29"> 21</a></span> <a class="code hl_enumvalue" href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29">TrueColor</a>,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>};</div>
</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui_1_1Terminal.html#ae6e034f37aa66cfe4458a8cb6e8fc526">ColorSupport</a>();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceftxui_1_1Terminal.html#a65945a706131f407a47a1b9960dc1a4a">SetColorSupport</a>(<a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>} <span class="comment">// namespace Terminal</span></div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>} <span class="comment">// namespace ftxui</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif </span><span class="comment">// FTXUI_SCREEN_TERMINAL_HPP</span></div>
<div class="ttc" id="aclassftxui_1_1Color_html"><div class="ttname"><a href="classftxui_1_1Color.html">ftxui::Color</a></div><div class="ttdoc">A class representing terminal colors.</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00020">color.hpp:20</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_a65945a706131f407a47a1b9960dc1a4a"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#a65945a706131f407a47a1b9960dc1a4a">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="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_1_1Terminal_html_ab87bacfdad76e61b9412d7124be44c1c"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1c">ftxui::Terminal::Color</a></div><div class="ttdeci">Color</div><div class="ttdef"><b>Definition</b> <a href="#l00017">terminal.hpp:17</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29">ftxui::Terminal::TrueColor</a></div><div class="ttdeci">@ TrueColor</div><div class="ttdef"><b>Definition</b> <a href="#l00021">terminal.hpp:21</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876">ftxui::Terminal::Palette256</a></div><div class="ttdeci">@ Palette256</div><div class="ttdef"><b>Definition</b> <a href="#l00020">terminal.hpp:20</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349">ftxui::Terminal::Palette16</a></div><div class="ttdeci">@ Palette16</div><div class="ttdef"><b>Definition</b> <a href="#l00019">terminal.hpp:19</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41">ftxui::Terminal::Palette1</a></div><div class="ttdeci">@ Palette1</div><div class="ttdef"><b>Definition</b> <a href="#l00018">terminal.hpp:18</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Terminal_html_ad890c37601448c82ed0d5051c29e2f0c"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ad890c37601448c82ed0d5051c29e2f0c">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="anamespaceftxui_1_1Terminal_html_ae6e034f37aa66cfe4458a8cb6e8fc526"><div class="ttname"><a href="namespaceftxui_1_1Terminal.html#ae6e034f37aa66cfe4458a8cb6e8fc526">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="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a3a072d6ef9c51d085b44eac70f2edff6"><div class="ttname"><a href="namespaceftxui.html#a3a072d6ef9c51d085b44eac70f2edff6">ftxui::Dimensions::dimy</a></div><div class="ttdeci">int dimy</div><div class="ttdef"><b>Definition</b> <a href="#l00010">terminal.hpp:10</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a8b0f6ae031a507c3ffb7bf0eec290d46"><div class="ttname"><a href="namespaceftxui.html#a8b0f6ae031a507c3ffb7bf0eec290d46">ftxui::Dimensions::dimx</a></div><div class="ttdeci">int dimx</div><div class="ttdef"><b>Definition</b> <a href="#l00009">terminal.hpp:9</a></div></div>
<div class="ttc" id="anamespaceftxui_html_af61b489da39ca5e24b68e6e1a2b09c0d"><div class="ttname"><a href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">ftxui::color</a></div><div class="ttdeci">Decorator color(Color)</div><div class="ttdoc">Decorate using a foreground color.</div><div class="ttdef"><b>Definition</b> <a href="dom_2color_8cpp_source.html#l00110">color.cpp:110</a></div></div>
<div class="ttc" id="anamespaceftxui_html_structftxui_1_1Dimensions"><div class="ttname"><a href="namespaceftxui.html#structftxui_1_1Dimensions">ftxui::Dimensions</a></div><div class="ttdef"><b>Definition</b> <a href="#l00008">terminal.hpp:8</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- 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('projectnumber');
if (!projectNumber) {
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
return;
}
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": "../v6.1.9/index.html", "v6.1.8": "../v6.1.8/index.html", "v6.1.7": "../v6.1.7/index.html", "v6.1.6": "../v6.1.6/index.html", "v6.1.5": "../v6.1.5/index.html", "v6.1.4": "../v6.1.4/index.html", "v6.1.3": "../v6.1.3/index.html", "v6.1.2": "../v6.1.2/index.html", "v6.1.1": "../v6.1.1/index.html", "v6.1.0": "../v6.1.0/index.html", "v6.0.2": "../v6.0.2/index.html", "v6.0.1": "index.html", "v6.0.0": "../v6.0.0/index.html", "v5.0.0": "../v5.0.0/index.html", "v4.1.1": "../v4.1.1/index.html", "v4.1.0": "../v4.1.0/index.html", "v4.0.0": "../v4.0.0/index.html", "v3.0.0": "../v3.0.0/index.html", "v2.0.0": "../v2.0.0/index.html", "v0.9": "../v0.9/index.html", "v0.11": "../v0.11/index.html", "v0.10": "../v0.10/index.html"};
const currentVersion = "v6.0.1";
// Sort versions: 'main' first, then others numerically descending.
versions.sort((a, b) => {
if (a === 'main') return -1;
if (b === 'main') return 1;
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
});
const select = document.createElement('select');
select.onchange = function() {
const selectedVersion = this.value;
// Navigate directly to the pre-calculated relative path.
if (selectedVersion !== currentVersion) {
window.location.href = version_paths[selectedVersion];
}
};
versions.forEach(v => {
const option = document.createElement('option');
option.value = v;
option.textContent = v;
if (v === currentVersion) {
option.selected = true;
}
select.appendChild(option);
});
// Replace the Doxygen project number element with our dropdown.
projectNumber.replaceWith(select);
// 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',
marginLeft: '10px',
cursor: 'pointer'
});
});
</script>
</body>
</html>