FTXUI/functions_b.html
2025-06-20 14:18:44 +00:00

241 lines
12 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</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_b.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 class members with links to the classes they belong to:</div>
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
<li>B&#160;:&#160;<a class="el" href="group__component.html#a4dd738a967d95833e57bd94580c03d08">Event</a></li>
<li>b&#160;:&#160;<a class="el" href="group__component.html#a27d7cfd7232d069c045ca18db3523093">Event</a></li>
<li>back&#160;:&#160;<a class="el" href="structftxui_1_1ResizableSplitOption.html#a591ffd25e449a214855e0dfd78dab766">ResizableSplitOption</a></li>
<li>background&#160;:&#160;<a class="el" href="structftxui_1_1AnimatedColorsOption.html#a550692ff465684652d29385a6b24304d">AnimatedColorsOption</a></li>
<li>background_color&#160;:&#160;<a class="el" href="group__screen.html#a3af4612678da78558adccf47e17164bb">Pixel</a></li>
<li>Backspace&#160;:&#160;<a class="el" href="group__component.html#a87cb6a8c09564342227afc71c7f76c82">Event</a></li>
<li>Bar&#160;:&#160;<a class="el" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca6424dbda22da2f105580d1c8095600d3">Screen::Cursor</a></li>
<li>BarBlinking&#160;:&#160;<a class="el" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cae7dfc08d4e90b88e0cb1cea7a54796c1">Screen::Cursor</a></li>
<li>Black&#160;:&#160;<a class="el" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802fac1e9bce8242f443c54c7405223d616cd">Color</a></li>
<li>Blend()&#160;:&#160;<a class="el" href="group__screen.html#a3422660268648b5a260ac94336e7e405">Color</a></li>
<li>blink&#160;:&#160;<a class="el" href="group__screen.html#a399ff0c757d88aeaa2439212f073f380">Pixel</a></li>
<li>Block&#160;:&#160;<a class="el" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa00f801460e81f86eab56d86fe627551">Screen::Cursor</a></li>
<li>BlockBlinking&#160;:&#160;<a class="el" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca2f4a0b3cacb4468d8467dc0746ea23aa">Screen::Cursor</a></li>
<li>blocks&#160;:&#160;<a class="el" href="structftxui_1_1flexbox__helper_1_1Global.html#ac91f06264613997a325271ce8e35d840">Global</a>, <a class="el" href="structftxui_1_1flexbox__helper_1_1Line.html#acb3eeab6f2ab1007cacd9f72caf9cdb8">Line</a></li>
<li>Blue&#160;:&#160;<a class="el" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8">Color</a></li>
<li>blue&#160;:&#160;<a class="el" href="group__screen.html#a287b397e90d7b995c81ff54e741f96b2">ColorInfo</a></li>
<li>Blue1&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa9eafa8db807f9452108cd02b80cd4adc">Color</a></li>
<li>Blue3&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa910d98e6c6282c1c8133f53438beb7ca">Color</a></li>
<li>Blue3Bis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfabb8f8ef3f352a8a9c884fadff1576b13">Color</a></li>
<li>BlueLight&#160;:&#160;<a class="el" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802faf7cc79a56a740e9c59a156b0b3b93cbd">Color</a></li>
<li>BlueViolet&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfabcd3fa02524f2597996333516267c773">Color</a></li>
<li>bold&#160;:&#160;<a class="el" href="group__screen.html#a7a210a24d67146bd143c013d1da0f2dd">Pixel</a></li>
<li>Border()&#160;:&#160;<a class="el" href="group__component.html#a2f8ead79a770376a36e9b9b7fa6bc966">ButtonOption</a>, <a class="el" href="classftxui_1_1TableSelection.html#af47b05e5a3f01cafc419ce94388cae51">TableSelection</a></li>
<li>BorderBottom()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#ab3efbe517730170703eba50cf23b150d">TableSelection</a></li>
<li>BorderLeft()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#a5b822ad80ff44922a9d6551743f64259">TableSelection</a></li>
<li>BorderRight()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#af36f1d9893a26293f24da431c5a344cc">TableSelection</a></li>
<li>BorderTop()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#aa9002be87d1fc0c5c6416b8006a902e4">TableSelection</a></li>
<li>box&#160;:&#160;<a class="el" href="structftxui_1_1Requirement_1_1Focused.html#ab19e728e80bc2fc43d8e82c3602f8333">Requirement::Focused</a></li>
<li>box_&#160;:&#160;<a class="el" href="group__dom.html#aa7e7d30102945911407723a5cbcdfabc">Node</a></li>
<li>Button&#160;:&#160;<a class="el" href="group__component.html#a03bfec859eac87be20f8952c1eb89de0">Mouse</a></li>
<li>button&#160;:&#160;<a class="el" href="group__component.html#aa56e877ca6a7524cf1e891c7435c3ace">Mouse</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! -->
<ul>
<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>