Files
FTXUI/functions_vars_c.html
2025-11-12 12:56:59 +00:00

332 lines
19 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: Class Members - Variables</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('functions_vars_c.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="contents">
<div class="textblock">Here is a list of all variables with links to the classes they belong to:</div>
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>C&#160;:&#160;<a class="el" href="group__component.html#aad99c99d06c8b90edc409743b4c23efb">Event</a></li>
<li>c&#160;:&#160;<a class="el" href="group__component.html#af8a909c0d59f212fdf1e79af33888d53">Event</a></li>
<li>character&#160;:&#160;<a class="el" href="group__screen.html#a3bbcd6a381555ea201dbe4251a9aafb3">Pixel</a></li>
<li>checkbox&#160;:&#160;<a class="el" href="group__component.html#a0797deb307cd89059137a4ca6075fcbf">DropdownOption</a></li>
<li>checked&#160;:&#160;<a class="el" href="group__component.html#ab7741e52624c0d7906159d77edffe27e">CheckboxOption</a></li>
<li>children_&#160;:&#160;<a class="el" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">ComponentBase</a>, <a class="el" href="group__dom.html#a2aeb117dade3254694355ab90e9fc566">Node</a></li>
<li>color&#160;:&#160;<a class="el" href="structftxui_1_1LinearGradient_1_1Stop.html#aa5f4d1eda21c196bd8401ff73f105073">LinearGradient::Stop</a></li>
<li>color_active&#160;:&#160;<a class="el" href="structftxui_1_1SliderOption.html#a593f1ba15add21d1972c01372db369df">SliderOption&lt; T &gt;</a>, <a class="el" href="group__component.html#a593f1ba15add21d1972c01372db369df">UnderlineOption</a></li>
<li>color_inactive&#160;:&#160;<a class="el" href="structftxui_1_1SliderOption.html#ad5a77e0bc0ce649271a13949a7a0a635">SliderOption&lt; T &gt;</a>, <a class="el" href="group__component.html#ad5a77e0bc0ce649271a13949a7a0a635">UnderlineOption</a></li>
<li>component_active&#160;:&#160;<a class="el" href="structftxui_1_1Requirement_1_1Focused.html#ac3226c18ed017dd81566f593d1257ce1">Requirement::Focused</a></li>
<li>config&#160;:&#160;<a class="el" href="structftxui_1_1flexbox__helper_1_1Global.html#ae1dac1dbfb99211895f88d2c4b609849">Global</a></li>
<li>content&#160;:&#160;<a class="el" href="group__component.html#ac9f6c2acd72d74eeb3a18baf32b02932">InputOption</a></li>
<li>control&#160;:&#160;<a class="el" href="group__component.html#ad155fe5a68eb888a7e0eb897a3dfc015">Mouse</a></li>
<li>CtrlA&#160;:&#160;<a class="el" href="group__component.html#acf7817ed11559c82a26322521f390d6e">Event</a></li>
<li>CtrlAltA&#160;:&#160;<a class="el" href="group__component.html#adb198f3baf944a55bcfa46107615d359">Event</a></li>
<li>CtrlAltB&#160;:&#160;<a class="el" href="group__component.html#ae44c243b858cb3400fdbfa0175c489e4">Event</a></li>
<li>CtrlAltC&#160;:&#160;<a class="el" href="group__component.html#a1cd1b6ca37581db00ee5ad5d44e94e3f">Event</a></li>
<li>CtrlAltD&#160;:&#160;<a class="el" href="group__component.html#aec5fdc15c18b77c8ca74d1f077754916">Event</a></li>
<li>CtrlAltE&#160;:&#160;<a class="el" href="group__component.html#a459c4f925ed72d9ebdd5caa74be905f8">Event</a></li>
<li>CtrlAltF&#160;:&#160;<a class="el" href="group__component.html#a22ee0cd5fb9dbb1ff5fe2b249d9de1fc">Event</a></li>
<li>CtrlAltG&#160;:&#160;<a class="el" href="group__component.html#acf6ba80979dddb644d8a06ddc8b32a43">Event</a></li>
<li>CtrlAltH&#160;:&#160;<a class="el" href="group__component.html#a54b56653957ef7a339f0659e6c4f826f">Event</a></li>
<li>CtrlAltI&#160;:&#160;<a class="el" href="group__component.html#a2bf197114604fe111bd01a5ad64b0576">Event</a></li>
<li>CtrlAltJ&#160;:&#160;<a class="el" href="group__component.html#a48019246646c62005152941069919bf2">Event</a></li>
<li>CtrlAltK&#160;:&#160;<a class="el" href="group__component.html#ace12bff4272d8e0c85db12524e42f7b0">Event</a></li>
<li>CtrlAltL&#160;:&#160;<a class="el" href="group__component.html#ab37accf33aab3cd7187bb7f589bc3c5b">Event</a></li>
<li>CtrlAltM&#160;:&#160;<a class="el" href="group__component.html#a7866574be02fec611b5aca5d333ccccf">Event</a></li>
<li>CtrlAltN&#160;:&#160;<a class="el" href="group__component.html#a0bcae083304c682e85f1e18be85dc141">Event</a></li>
<li>CtrlAltO&#160;:&#160;<a class="el" href="group__component.html#a62641366fdaffa002aca0087af45297a">Event</a></li>
<li>CtrlAltP&#160;:&#160;<a class="el" href="group__component.html#a44bc2e6312cd6e9eda4d4778e88052f0">Event</a></li>
<li>CtrlAltQ&#160;:&#160;<a class="el" href="group__component.html#af8bec3764c43c08d08c0bffdcf9b4255">Event</a></li>
<li>CtrlAltR&#160;:&#160;<a class="el" href="group__component.html#a8aecef2c60fd63f3cbc7c16b7b5d804b">Event</a></li>
<li>CtrlAltS&#160;:&#160;<a class="el" href="group__component.html#abf589677d9c6463e97519567c3d1b021">Event</a></li>
<li>CtrlAltT&#160;:&#160;<a class="el" href="group__component.html#adad452726bfb3d523b19299bf8017a41">Event</a></li>
<li>CtrlAltU&#160;:&#160;<a class="el" href="group__component.html#ad4e4ff7f9a534882d7e5adc29235d761">Event</a></li>
<li>CtrlAltV&#160;:&#160;<a class="el" href="group__component.html#ae7afc70b1bc9d4e5c046bcbaf7767c19">Event</a></li>
<li>CtrlAltW&#160;:&#160;<a class="el" href="group__component.html#a5d6ebbe9bdb0b7fe28104a58602bcc37">Event</a></li>
<li>CtrlAltX&#160;:&#160;<a class="el" href="group__component.html#a07a380297456b42f4929d47ece5517a0">Event</a></li>
<li>CtrlAltY&#160;:&#160;<a class="el" href="group__component.html#ab001073b99625145403adbbd3a3e21e8">Event</a></li>
<li>CtrlAltZ&#160;:&#160;<a class="el" href="group__component.html#a98f8350cb5499a5432506ac732d495ec">Event</a></li>
<li>CtrlB&#160;:&#160;<a class="el" href="group__component.html#a52c5a6db246fce616cf8d6408af8e3a3">Event</a></li>
<li>CtrlC&#160;:&#160;<a class="el" href="group__component.html#a038a33c469a2e4474d08d637e37f660d">Event</a></li>
<li>CtrlD&#160;:&#160;<a class="el" href="group__component.html#ae0d493f520768be24d4e9508eb3f263d">Event</a></li>
<li>CtrlE&#160;:&#160;<a class="el" href="group__component.html#a1fbae80d9ab6f7c72f07f1a84da7de64">Event</a></li>
<li>CtrlF&#160;:&#160;<a class="el" href="group__component.html#a46651cd420861328dff49c5651ac853c">Event</a></li>
<li>CtrlG&#160;:&#160;<a class="el" href="group__component.html#aa221be42071500650486cc199f26b072">Event</a></li>
<li>CtrlH&#160;:&#160;<a class="el" href="group__component.html#a72c30a2cd1d2309f4e81aad7163e24ca">Event</a></li>
<li>CtrlI&#160;:&#160;<a class="el" href="group__component.html#af5df3d152c8ea5303cc2d5c9bb8c5747">Event</a></li>
<li>CtrlJ&#160;:&#160;<a class="el" href="group__component.html#a76d3ea748f24c9c8d55a8f563616de3f">Event</a></li>
<li>CtrlK&#160;:&#160;<a class="el" href="group__component.html#a8deeb92abd293c7a0750b6891cc217bd">Event</a></li>
<li>CtrlL&#160;:&#160;<a class="el" href="group__component.html#a0608ea347cb61c04bf7f1e89d215d1c3">Event</a></li>
<li>CtrlM&#160;:&#160;<a class="el" href="group__component.html#a86af858198ebfedc83ada8f775a1b4bc">Event</a></li>
<li>CtrlN&#160;:&#160;<a class="el" href="group__component.html#a85966b9d428df487e2b896596e90f4ed">Event</a></li>
<li>CtrlO&#160;:&#160;<a class="el" href="group__component.html#ae7915261b9c6d8e844933bd1f68ed120">Event</a></li>
<li>CtrlP&#160;:&#160;<a class="el" href="group__component.html#a043bd0f01364983076c98ebf2fd6f503">Event</a></li>
<li>CtrlQ&#160;:&#160;<a class="el" href="group__component.html#a97bdebeccfd100f5e8f5df3b4e04b62e">Event</a></li>
<li>CtrlR&#160;:&#160;<a class="el" href="group__component.html#a5cca4aa809fa07d3ea1992ebef011a19">Event</a></li>
<li>CtrlS&#160;:&#160;<a class="el" href="group__component.html#a7c7ffc28a2d2d1eb67444edb7a44e575">Event</a></li>
<li>CtrlT&#160;:&#160;<a class="el" href="group__component.html#ac1e7d6a13cfa09a29e2c735e01463598">Event</a></li>
<li>CtrlU&#160;:&#160;<a class="el" href="group__component.html#a26730fa452c79611f5aa6ca0e157e217">Event</a></li>
<li>CtrlV&#160;:&#160;<a class="el" href="group__component.html#a053eca96c74722632b0a1e53f3af2978">Event</a></li>
<li>CtrlW&#160;:&#160;<a class="el" href="group__component.html#a8520a7531235eb2ff76f2de1704e7e1c">Event</a></li>
<li>CtrlX&#160;:&#160;<a class="el" href="group__component.html#a50ef26ee285d63d0a805f59eed52239f">Event</a></li>
<li>CtrlY&#160;:&#160;<a class="el" href="group__component.html#a697c813972ac5d83b75f65e81acd5cff">Event</a></li>
<li>CtrlZ&#160;:&#160;<a class="el" href="group__component.html#a22ef83103e0443ba82acc19f24f729bc">Event</a></li>
<li>cursor&#160;:&#160;<a class="el" href="group__component.html#a9d8d873964fd143f113fce55e15c37fb">Event</a></li>
<li>cursor_&#160;:&#160;<a class="el" href="group__screen.html#a9df9d1ae7ed66857ca987963b2365904">Screen</a></li>
<li>cursor_position&#160;:&#160;<a class="el" href="group__component.html#a699547942204afa70864e0e6df94c96c">InputOption</a></li>
<li>cursor_shape&#160;:&#160;<a class="el" href="group__component.html#a25a0efbff7ae0393c695f6d720cb5542">Event</a>, <a class="el" href="structftxui_1_1Requirement_1_1Focused.html#a21f4c5c8f6862a204f795d4f0cb6d479">Requirement::Focused</a></li>
<li>Custom&#160;:&#160;<a class="el" href="group__component.html#a699872f2a6d8607d714be174e9435290">Event</a></li>
</ul>
</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! -->
</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": "en/v6.1.9/index.html", "v6.1.8": "en/v6.1.8/index.html", "v6.1.7": "en/v6.1.7/index.html", "v6.1.6": "en/v6.1.6/index.html", "v6.1.5": "en/v6.1.5/index.html", "v6.1.4": "en/v6.1.4/index.html", "v6.1.3": "en/v6.1.3/index.html", "v6.1.2": "en/v6.1.2/index.html", "v6.1.1": "en/v6.1.1/index.html", "v6.1.0": "en/v6.1.0/index.html", "v6.0.2": "en/v6.0.2/index.html", "v6.0.1": "en/v6.0.1/index.html", "v6.0.0": "en/v6.0.0/index.html", "v5.0.0": "en/v5.0.0/index.html", "v4.1.1": "en/v4.1.1/index.html", "v4.1.0": "en/v4.1.0/index.html", "v4.0.0": "en/v4.0.0/index.html", "v3.0.0": "en/v3.0.0/index.html", "v2.0.0": "en/v2.0.0/index.html", "v0.9": "en/v0.9/index.html", "v0.11": "en/v0.11/index.html", "v0.10": "en/v0.10/index.html"};
const currentVersion = "main";
// 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>