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

244 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 - Functions</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_func_d.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 functions with links to the classes they belong to:</div>
<h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
<li>DebugString()&#160;:&#160;<a class="el" href="group__component.html#a764be64f3029f8b8e23511061d8de355">Event</a></li>
<li>Decorate()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#a8e7e9329ee7f557eef6d037fef8003e0">TableSelection</a></li>
<li>DecorateAlternateColumn()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#a00b7d84571ed47043e55cd879ed851a3">TableSelection</a></li>
<li>DecorateAlternateRow()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#a9cadee0ff95e66e2ca90e15648ad592d">TableSelection</a></li>
<li>DecorateCells()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#a335808a6c8beb4744bfe91b359ebf0bb">TableSelection</a></li>
<li>DecorateCellsAlternateColumn()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#a751593eb3bc2e704eb6667ed518f614e">TableSelection</a></li>
<li>DecorateCellsAlternateRow()&#160;:&#160;<a class="el" href="classftxui_1_1TableSelection.html#ac2810f38a5f722916f364f354c204cb7">TableSelection</a></li>
<li>Default()&#160;:&#160;<a class="el" href="group__component.html#a2108670f055ede2fdc4993f6ffc8ff07">InputOption</a></li>
<li>Detach()&#160;:&#160;<a class="el" href="group__component.html#abb7a2b60240651d16e17d02eb6f636cf">ComponentBase</a></li>
<li>DetachAllChildren()&#160;:&#160;<a class="el" href="group__component.html#a84bd6480cf5e8f51cf5965f81b1f2460">ComponentBase</a></li>
<li>dimx()&#160;:&#160;<a class="el" href="group__screen.html#ae7a460c9dacd70ed81b1adfea46b492e">Image</a></li>
<li>dimy()&#160;:&#160;<a class="el" href="group__screen.html#a0d283cfb1ec16b3fc13d344ebfea93d4">Image</a></li>
<li>DrawBlock()&#160;:&#160;<a class="el" href="group__dom.html#ae38b2e4f5bcda94c060bb77779d1e339">Canvas</a></li>
<li>DrawBlockCircle()&#160;:&#160;<a class="el" href="group__dom.html#ac3977d4b06ca96ff799a3b72437c8a0b">Canvas</a></li>
<li>DrawBlockCircleFilled()&#160;:&#160;<a class="el" href="group__dom.html#acffdcd5bae224992e155facb0baf4119">Canvas</a></li>
<li>DrawBlockEllipse()&#160;:&#160;<a class="el" href="group__dom.html#a8dd75f2dfc5bef37aa2c8bc8cfaf0579">Canvas</a></li>
<li>DrawBlockEllipseFilled()&#160;:&#160;<a class="el" href="group__dom.html#a78dc3c908f7ce1c30837bd3043f19526">Canvas</a></li>
<li>DrawBlockLine()&#160;:&#160;<a class="el" href="group__dom.html#a182a915a7e3fc863f5c222253de01ff1">Canvas</a></li>
<li>DrawBlockOff()&#160;:&#160;<a class="el" href="group__dom.html#ad626747e5e54412d0376ba870565dce6">Canvas</a></li>
<li>DrawBlockOn()&#160;:&#160;<a class="el" href="group__dom.html#a43cd60e79e418d3173e757a1809fde09">Canvas</a></li>
<li>DrawBlockToggle()&#160;:&#160;<a class="el" href="group__dom.html#ab4154641384d18497de60c2626b71a94">Canvas</a></li>
<li>DrawImage()&#160;:&#160;<a class="el" href="group__dom.html#a02b6e8bab532a2c43d3102674e1e1647">Canvas</a></li>
<li>DrawPixel()&#160;:&#160;<a class="el" href="group__dom.html#afde1b1962124ef417569bef59c6dcdcc">Canvas</a></li>
<li>DrawPoint()&#160;:&#160;<a class="el" href="group__dom.html#a8707f2585ed8b787b6b14032a5c761a1">Canvas</a></li>
<li>DrawPointCircle()&#160;:&#160;<a class="el" href="group__dom.html#ad21641f8f1fd60aa5f1d149379eba3eb">Canvas</a></li>
<li>DrawPointCircleFilled()&#160;:&#160;<a class="el" href="group__dom.html#a5b6388d2515edcfb6c88a39ea56805b2">Canvas</a></li>
<li>DrawPointEllipse()&#160;:&#160;<a class="el" href="group__dom.html#a79ee88b3cfe258309041469f707dcf68">Canvas</a></li>
<li>DrawPointEllipseFilled()&#160;:&#160;<a class="el" href="group__dom.html#a2633b8a556a82c74438fe41b253b39ee">Canvas</a></li>
<li>DrawPointLine()&#160;:&#160;<a class="el" href="group__dom.html#a2b6800c9a6a93457a921d9b570fb2f30">Canvas</a></li>
<li>DrawPointOff()&#160;:&#160;<a class="el" href="group__dom.html#a64ad8a12830a3341d4a5afb380913474">Canvas</a></li>
<li>DrawPointOn()&#160;:&#160;<a class="el" href="group__dom.html#a5f488ea43e72f25cc25d055bf18dac5b">Canvas</a></li>
<li>DrawPointToggle()&#160;:&#160;<a class="el" href="group__dom.html#afd64176f05f91df2d96e8f3bb0631c51">Canvas</a></li>
<li>DrawText()&#160;:&#160;<a class="el" href="group__dom.html#a3791777bd6d3c6f8ff6281efd19a5161">Canvas</a></li>
<li>duration()&#160;:&#160;<a class="el" href="classftxui_1_1animation_1_1Params.html#a2cf2e0a4288915aee8f100d2f0ee3e50">Params</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>