FTXUI/functions_h.html

236 lines
12 KiB
HTML
Raw Permalink Normal View History

<!-- 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_h.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_h" name="index_h"></a>- h -</h3><ul>
<li>H&#160;:&#160;<a class="el" href="group__component.html#a4f2d69d0f85ae76a015b0fd34ccb9bbc">Event</a></li>
<li>h&#160;:&#160;<a class="el" href="group__component.html#a226af846ad5e1dd35e84212a145dfb72">Event</a></li>
<li>HasPending()&#160;:&#160;<a class="el" href="classftxui_1_1ReceiverImpl.html#a49f2a9285b485f25694f48732b0c2554">ReceiverImpl&lt; T &gt;</a></li>
<li>HasQuitted()&#160;:&#160;<a class="el" href="group__component.html#a0f10869cb1cad212e8885deac6960a41">Loop</a>, <a class="el" href="classftxui_1_1ReceiverImpl.html#a0f10869cb1cad212e8885deac6960a41">ReceiverImpl&lt; T &gt;</a></li>
<li>height()&#160;:&#160;<a class="el" href="group__dom.html#ad3774f6419003470f54fd495124ef51f">Canvas</a>, <a class="el" href="structftxui_1_1WindowOptions.html#a3f551d52ec458be9ffbcd38c715f9e19">WindowOptions</a></li>
<li>Hidden&#160;:&#160;<a class="el" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cacf46e529658ebc6532c204f3246929f4">Screen::Cursor</a></li>
<li>Home&#160;:&#160;<a class="el" href="group__component.html#aad7d2ec712d40ad87d330e5e4399fdbc">Event</a></li>
<li>Honeydew2&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfacfd861941ef13f197407b7d02deaf617">Color</a></li>
<li>Horizontal()&#160;:&#160;<a class="el" href="group__component.html#a5ee36f528383cc1db765fa2140797837">MenuOption</a></li>
<li>HorizontalAnimated()&#160;:&#160;<a class="el" href="group__component.html#aedc93fba91339d9713812821cb140c50">MenuOption</a></li>
<li>HotPink&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfad886c67902578a7336b821b1cb279c4e">Color</a></li>
<li>HotPink2&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa1b701a7828d1930b59b76d091913e7d1">Color</a></li>
<li>HotPink3&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa5b9fcd5ea12531a4fb1273743063f49f">Color</a></li>
<li>HotPink3Bis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa073af5071fd22b51b77f43766b86d6a5">Color</a></li>
<li>HotPinkBis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfac178a78c367fd250556adaa1b9ad4730">Color</a></li>
<li>hover_down&#160;:&#160;<a class="el" href="group__component.html#a2fbfe3e43b596c8a47c5548b38e4d721">WindowRenderState</a></li>
<li>hover_left&#160;:&#160;<a class="el" href="group__component.html#abca2d427dd57d2b5eecb6685ed68e857">WindowRenderState</a></li>
<li>hover_right&#160;:&#160;<a class="el" href="group__component.html#a8e6af441e03d44f593bcb0d17ee809b1">WindowRenderState</a></li>
<li>hover_top&#160;:&#160;<a class="el" href="group__component.html#acb4dc002e621733f1e6c232f369af8ca">WindowRenderState</a></li>
<li>hovered&#160;:&#160;<a class="el" href="structftxui_1_1InputState.html#a9a61bb2fb8c309b32c457adb0392ec31">InputState</a></li>
<li>HSV()&#160;:&#160;<a class="el" href="group__screen.html#a1a119fd00beafc7d2aa5f94518e38fc5">Color</a></li>
<li>HSVA()&#160;:&#160;<a class="el" href="group__screen.html#af067d3410c55684d727aeb29bc8d2af2">Color</a></li>
<li>hue&#160;:&#160;<a class="el" href="group__screen.html#ad7b7eb0b3e04af91bdd64715226c3c68">ColorInfo</a></li>
<li>Hyperlink()&#160;:&#160;<a class="el" href="group__screen.html#a0b55b16969dfccc79195fe61c5ba6d1a">Screen</a></li>
<li>hyperlink&#160;:&#160;<a class="el" href="group__screen.html#a071ab11cf7706c7800281716177c88e3">Pixel</a></li>
<li>hyperlinks_&#160;:&#160;<a class="el" href="group__screen.html#acff83d382ef60ad2a0fca3ba68e9397f">Screen</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>