Mirror/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-11-15 11:38:56 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
FTXUI/en/v5.0.0/namespaceftxui_1_1Terminal.html
ArthurSonzogni 4aab714d3f deploy: 229cae78b5
2025-11-12 12:56:59 +00:00

312 lines
16 KiB
HTML
Raw Permalink Blame History

<!-- 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: ftxui::Terminal Namespace Reference</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">5.0.0</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('namespaceftxui_1_1Terminal.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="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">ftxui::Terminal Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad890c37601448c82ed0d5051c29e2f0c" id="r_ad890c37601448c82ed0d5051c29e2f0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad890c37601448c82ed0d5051c29e2f0c">Size</a> ()</td></tr>
<tr class="memdesc:ad890c37601448c82ed0d5051c29e2f0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the terminal size. <br /></td></tr>
<tr class="separator:ad890c37601448c82ed0d5051c29e2f0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a765662bcabb59dc93884674ee2fcc9fc" id="r_a765662bcabb59dc93884674ee2fcc9fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a765662bcabb59dc93884674ee2fcc9fc">SetFallbackSize</a> (const <a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> &amp;fallbackSize)</td></tr>
<tr class="memdesc:a765662bcabb59dc93884674ee2fcc9fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override terminal size in case auto-detection fails. <br /></td></tr>
<tr class="separator:a765662bcabb59dc93884674ee2fcc9fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6e034f37aa66cfe4458a8cb6e8fc526" id="r_ae6e034f37aa66cfe4458a8cb6e8fc526"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ab87bacfdad76e61b9412d7124be44c1c">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6e034f37aa66cfe4458a8cb6e8fc526">ColorSupport</a> ()</td></tr>
<tr class="memdesc:ae6e034f37aa66cfe4458a8cb6e8fc526"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the color support of the terminal. <br /></td></tr>
<tr class="separator:ae6e034f37aa66cfe4458a8cb6e8fc526"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65945a706131f407a47a1b9960dc1a4a" id="r_a65945a706131f407a47a1b9960dc1a4a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65945a706131f407a47a1b9960dc1a4a">SetColorSupport</a> (<a class="el" href="#ab87bacfdad76e61b9412d7124be44c1c">Color</a> <a class="el" href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>)</td></tr>
<tr class="memdesc:a65945a706131f407a47a1b9960dc1a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override terminal color support in case auto-detection fails. <br /></td></tr>
<tr class="separator:a65945a706131f407a47a1b9960dc1a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab87bacfdad76e61b9412d7124be44c1c" id="r_ab87bacfdad76e61b9412d7124be44c1c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab87bacfdad76e61b9412d7124be44c1c">Color</a> { <a class="el" href="#ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41">Palette1</a>
, <a class="el" href="#ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349">Palette16</a>
, <a class="el" href="#ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876">Palette256</a>
, <a class="el" href="#ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29">TrueColor</a>
}</td></tr>
<tr class="separator:ab87bacfdad76e61b9412d7124be44c1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ab87bacfdad76e61b9412d7124be44c1c" name="ab87bacfdad76e61b9412d7124be44c1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab87bacfdad76e61b9412d7124be44c1c">&#9670;&#160;</a></span>Color</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#ab87bacfdad76e61b9412d7124be44c1c">Color</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41" name="ab87bacfdad76e61b9412d7124be44c1caf8fee1420fe204b3dafbacf27a545c41"></a>Palette1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349" name="ab87bacfdad76e61b9412d7124be44c1cae5a76102d821ec8233fee04273c60349"></a>Palette16&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876" name="ab87bacfdad76e61b9412d7124be44c1ca7b88ab2a5c8fe8866c96ea4acb623876"></a>Palette256&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29" name="ab87bacfdad76e61b9412d7124be44c1ca7afd9568e82d523c91b2bfe0cc47be29"></a>TrueColor&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="terminal_8hpp_source.html#l00017">17</a> of file <a class="el" href="terminal_8hpp_source.html">terminal.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad890c37601448c82ed0d5051c29e2f0c" name="ad890c37601448c82ed0d5051c29e2f0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad890c37601448c82ed0d5051c29e2f0c">&#9670;&#160;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> Size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the terminal size. </p>
<dl class="section return"><dt>Returns</dt><dd>The terminal size. </dd></dl>
<p class="definition">Definition at line <a class="el" href="terminal_8cpp_source.html#l00094">94</a> of file <a class="el" href="terminal_8cpp_source.html">terminal.cpp</a>.</p>
</div>
</div>
<a id="a765662bcabb59dc93884674ee2fcc9fc" name="a765662bcabb59dc93884674ee2fcc9fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a765662bcabb59dc93884674ee2fcc9fc">&#9670;&#160;</a></span>SetFallbackSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SetFallbackSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> &amp;</td> <td class="paramname"><span class="paramname"><em>fallbackSize</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Override terminal size in case auto-detection fails. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fallbackSize</td><td><a class="el" href="namespaceftxui_1_1Terminal.html">Terminal</a> dimensions to fallback to </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="terminal_8cpp_source.html#l00124">124</a> of file <a class="el" href="terminal_8cpp_source.html">terminal.cpp</a>.</p>
</div>
</div>
<a id="ae6e034f37aa66cfe4458a8cb6e8fc526" name="ae6e034f37aa66cfe4458a8cb6e8fc526"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6e034f37aa66cfe4458a8cb6e8fc526">&#9670;&#160;</a></span>ColorSupport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ab87bacfdad76e61b9412d7124be44c1c">Color</a> ColorSupport </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the color support of the terminal. </p>
<p class="definition">Definition at line <a class="el" href="terminal_8cpp_source.html#l00130">130</a> of file <a class="el" href="terminal_8cpp_source.html">terminal.cpp</a>.</p>
</div>
</div>
<a id="a65945a706131f407a47a1b9960dc1a4a" name="a65945a706131f407a47a1b9960dc1a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65945a706131f407a47a1b9960dc1a4a">&#9670;&#160;</a></span>SetColorSupport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SetColorSupport </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ab87bacfdad76e61b9412d7124be44c1c">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Override terminal color support in case auto-detection fails. </p>
<p class="definition">Definition at line <a class="el" href="terminal_8cpp_source.html#l00140">140</a> of file <a class="el" href="terminal_8cpp_source.html">terminal.cpp</a>.</p>
</div>
</div>
</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": "../v6.0.1/index.html", "v6.0.0": "../v6.0.0/index.html", "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 = "v5.0.0";
// 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>
Reference in New Issue View Git Blame Copy Permalink