mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
269 lines
16 KiB
HTML
269 lines
16 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"> 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&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
||
|
|
$(function(){initNavTree('functions.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_a" name="index_a"></a>- a -</h3><ul>
|
||
|
|
<li>A : <a class="el" href="group__component.html#a6a0fe62e2e45aa9516d3d774dc405b0c">Event</a></li>
|
||
|
|
<li>a : <a class="el" href="group__component.html#a0dd476cbdcf3ab0b9bba76b7eb51dd18">Event</a></li>
|
||
|
|
<li>Active() : <a class="el" href="group__component.html#a52beef6d7a687d4d109e6cec1606e32e">ComponentBase</a>, <a class="el" href="group__component.html#a9dc30615370889030396a239ceee2a77">ScreenInteractive</a></li>
|
||
|
|
<li>active : <a class="el" href="group__component.html#a5c04e41d802330270ae14a9861c1e2df">AnimatedColorOption</a>, <a class="el" href="structftxui_1_1EntryState.html#a03c996f9fcf0e10baeb3e700be0c409a">EntryState</a>, <a class="el" href="group__component.html#a03c996f9fcf0e10baeb3e700be0c409a">WindowRenderState</a></li>
|
||
|
|
<li>ActiveChild() : <a class="el" href="group__component.html#a5c421f00a2a7f50c542c5c286d2e696c">ComponentBase</a></li>
|
||
|
|
<li>Adapter() : <a class="el" href="classftxui_1_1ConstStringListRef_1_1Adapter.html#aeeff28a487da7a74856b51e966773246">ConstStringListRef::Adapter</a></li>
|
||
|
|
<li>Add() : <a class="el" href="group__component.html#a21f040bec9104e164bfa6c3ad45be3a1">ComponentBase</a>, <a class="el" href="classftxui_1_1TerminalInputParser.html#a4b2f1e271dd6ebbf5bad2418d960832a">TerminalInputParser</a></li>
|
||
|
|
<li>AddPart() : <a class="el" href="group__dom.html#a9887e25feddebbf840876824cb3cbf61">Selection</a></li>
|
||
|
|
<li>align_content : <a class="el" href="group__dom.html#a103275cb09167852e469450cf8471256">FlexboxConfig</a></li>
|
||
|
|
<li>align_items : <a class="el" href="group__dom.html#a1514fd3d64965c521555fdc2cf2002ce">FlexboxConfig</a></li>
|
||
|
|
<li>AlignContent : <a class="el" href="group__dom.html#a1f99410fd0fc632a5bc2497b6a447420">FlexboxConfig</a></li>
|
||
|
|
<li>AlignItems : <a class="el" href="group__dom.html#a821af961ece5fe13540ad48b54c7a9e7">FlexboxConfig</a></li>
|
||
|
|
<li>AltA : <a class="el" href="group__component.html#a9afff79ad622a8deab0c1106610bd635">Event</a></li>
|
||
|
|
<li>AltB : <a class="el" href="group__component.html#ab72b86bd630ac23d469394b4f115d388">Event</a></li>
|
||
|
|
<li>AltC : <a class="el" href="group__component.html#a527184b90a16487888d646d44e0e8a6b">Event</a></li>
|
||
|
|
<li>AltD : <a class="el" href="group__component.html#aaeed8e5d3503dc5418978329168cc455">Event</a></li>
|
||
|
|
<li>AltE : <a class="el" href="group__component.html#adbc22b402e7e8e7a25ea8da614e84082">Event</a></li>
|
||
|
|
<li>AltF : <a class="el" href="group__component.html#a13f05bbf8f71e0ecd73bca163018e2b5">Event</a></li>
|
||
|
|
<li>AltG : <a class="el" href="group__component.html#a6e26660f8ded2ee68c00bbd09247f007">Event</a></li>
|
||
|
|
<li>AltH : <a class="el" href="group__component.html#a1365e5d1a530aca80da90dfe10b48cbc">Event</a></li>
|
||
|
|
<li>AltI : <a class="el" href="group__component.html#ac728998d6c0e0a9b59e31987e9292c1e">Event</a></li>
|
||
|
|
<li>AltJ : <a class="el" href="group__component.html#ab2b4e0ee4d2db65374b1111553dc96f9">Event</a></li>
|
||
|
|
<li>AltK : <a class="el" href="group__component.html#a4d2a42120ce47e7fa7cd5237d61cf9c5">Event</a></li>
|
||
|
|
<li>AltL : <a class="el" href="group__component.html#a2d0b55c600a1ae7c0406dfad3c31c591">Event</a></li>
|
||
|
|
<li>AltM : <a class="el" href="group__component.html#a59dc4d656241c7f76433d0103e8e6934">Event</a></li>
|
||
|
|
<li>AltN : <a class="el" href="group__component.html#a9a6e150b0940479d2dd24f039f91675c">Event</a></li>
|
||
|
|
<li>AltO : <a class="el" href="group__component.html#a76c653ab37318c4bb6a2832c9cf1d612">Event</a></li>
|
||
|
|
<li>AltP : <a class="el" href="group__component.html#acabec40a30b5854999e774d0a1f3342e">Event</a></li>
|
||
|
|
<li>AltQ : <a class="el" href="group__component.html#a26ff1602105cf0df822f8b370be63fdd">Event</a></li>
|
||
|
|
<li>AltR : <a class="el" href="group__component.html#a7edddb7c159929157b0bf0b0deb7e4e0">Event</a></li>
|
||
|
|
<li>AltS : <a class="el" href="group__component.html#ad1becc889768aafe7e452bc529f3bc4c">Event</a></li>
|
||
|
|
<li>AltT : <a class="el" href="group__component.html#a06b17875059c0e92f716c0463ca60e86">Event</a></li>
|
||
|
|
<li>AltU : <a class="el" href="group__component.html#a95b1b6528a78575ca07954600c45f805">Event</a></li>
|
||
|
|
<li>AltV : <a class="el" href="group__component.html#ae5063b138286493e68fa140af2c3e4e6">Event</a></li>
|
||
|
|
<li>AltW : <a class="el" href="group__component.html#a35ad37bd8fb24e3ce38df9c3b61ef4e5">Event</a></li>
|
||
|
|
<li>AltX : <a class="el" href="group__component.html#aec5dcc79e3d6c86ce71306a57b49b48c">Event</a></li>
|
||
|
|
<li>AltY : <a class="el" href="group__component.html#a2a7b9d5b6dc8ce1529bd58b5f196cf91">Event</a></li>
|
||
|
|
<li>AltZ : <a class="el" href="group__component.html#aaac4eb7051d6901cf79fa32b46bface9">Event</a></li>
|
||
|
|
<li>Angle() : <a class="el" href="group__dom.html#a251d447c54f49914a2cbf5dc16fc8b5b">LinearGradient</a></li>
|
||
|
|
<li>angle : <a class="el" href="group__dom.html#ab8ef1bf8a70cc07c6d55823c390a7e76">LinearGradient</a></li>
|
||
|
|
<li>Animated() : <a class="el" href="group__component.html#a008018822835ed0f3758af3c6e72837d">ButtonOption</a></li>
|
||
|
|
<li>animated_colors : <a class="el" href="group__component.html#ab7131557fbe84a6b4b2f2ffcff7d44f0">ButtonOption</a>, <a class="el" href="group__component.html#ab7131557fbe84a6b4b2f2ffcff7d44f0">MenuEntryOption</a></li>
|
||
|
|
<li>Animator() : <a class="el" href="classftxui_1_1animation_1_1Animator.html#a03909a0243b559e18e21996ccacdc8b6">Animator</a></li>
|
||
|
|
<li>ApplyShader() : <a class="el" href="group__screen.html#a04d18c0cb0df3ed7a01ca5c3b8711ff7">Screen</a></li>
|
||
|
|
<li>Aquamarine1 : <a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfaf54d1112226e67ee67339a050ae1b352">Color</a></li>
|
||
|
|
<li>Aquamarine1Bis : <a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa4db1324d99372274e2414031d1773151">Color</a></li>
|
||
|
|
<li>Aquamarine3 : <a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfadc172e17e6f05d6e2b0e48c85803a85a">Color</a></li>
|
||
|
|
<li>ArrowDown : <a class="el" href="group__component.html#a9d2a831cf68bf2185a3c56c2e09b2f23">Event</a></li>
|
||
|
|
<li>ArrowDownCtrl : <a class="el" href="group__component.html#aeb40ca3ed1e25a8a02cec6e94f20cd01">Event</a></li>
|
||
|
|
<li>ArrowLeft : <a class="el" href="group__component.html#ae1b59315a513c99ac3095bc42dff0d94">Event</a></li>
|
||
|
|
<li>ArrowLeftCtrl : <a class="el" href="group__component.html#a05941a0e87f230113219319b1ce8a6b2">Event</a></li>
|
||
|
|
<li>ArrowRight : <a class="el" href="group__component.html#afed9a747f55d4564e4f749bea1de4022">Event</a></li>
|
||
|
|
<li>ArrowRightCtrl : <a class="el" href="group__component.html#af7861733aa43e55da68824c10e164dd1">Event</a></li>
|
||
|
|
<li>ArrowUp : <a class="el" href="group__component.html#a916bd0ae3c86941b660d9a07980bb0c9">Event</a></li>
|
||
|
|
<li>ArrowUpCtrl : <a class="el" href="group__component.html#abcf6d1b9fe64b9a6376e1d6c486d802b">Event</a></li>
|
||
|
|
<li>Ascii() : <a class="el" href="group__component.html#a66e244b326f3cdc7b80ea836c391c34b">ButtonOption</a></li>
|
||
|
|
<li>at() : <a class="el" href="group__screen.html#a55b0a995463c6936efb33391f29565bc">Image</a></li>
|
||
|
|
<li>automerge : <a class="el" href="group__screen.html#ada8b6dbd466ba5b6c4b240f229bd627f">Pixel</a></li>
|
||
|
|
<li>AutoReset() : <a class="el" href="classftxui_1_1AutoReset.html#ae393855d753027bcb3d4d1e1514e6ad4">AutoReset< T ></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>
|