mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
246 lines
13 KiB
HTML
246 lines
13 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"> 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_func_s.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_s" name="index_s"></a>- s -</h3><ul>
|
||
|
|
<li>SaturateHorizontal() : <a class="el" href="group__dom.html#af3f2674604d907fbce26d4217cfa9324">Selection</a></li>
|
||
|
|
<li>SaturateVertical() : <a class="el" href="group__dom.html#ace69e1e7c6e64b7ae0c4402e0e1e3336">Selection</a></li>
|
||
|
|
<li>Screen() : <a class="el" href="group__screen.html#a7ecf7c5fb3d90a1620098a60cfafc215">Screen</a></li>
|
||
|
|
<li>Select() : <a class="el" href="group__dom.html#a05352f5a353f1e86630a978060e77305">Node</a></li>
|
||
|
|
<li>SelectAll() : <a class="el" href="group__dom.html#ad5f50927f54334b84514bc4b11a14d71">Table</a></li>
|
||
|
|
<li>SelectCell() : <a class="el" href="group__dom.html#a3c2f178ef9f94da293a53b467ef8643b">Table</a></li>
|
||
|
|
<li>SelectColumn() : <a class="el" href="group__dom.html#a4ee8ddbab36f592fba81c6430d26545e">Table</a></li>
|
||
|
|
<li>SelectColumns() : <a class="el" href="group__dom.html#a79109565fe65710f725eb474778cae36">Table</a></li>
|
||
|
|
<li>Selection() : <a class="el" href="group__dom.html#ade00d4039f147221b9fd6b6b402b43b1">Selection</a></li>
|
||
|
|
<li>SelectionChange() : <a class="el" href="group__component.html#ad6daabb2df61b6be6f0b2a8950ac3281">ScreenInteractive</a></li>
|
||
|
|
<li>SelectRectangle() : <a class="el" href="group__dom.html#af0021915d0cbda394077929601b8ab8f">Table</a></li>
|
||
|
|
<li>SelectRow() : <a class="el" href="group__dom.html#a64435bbfbdefd7408241c69b6b8283e7">Table</a></li>
|
||
|
|
<li>SelectRows() : <a class="el" href="group__dom.html#ab36d32e3675a9353ee79e84405cd7a44">Table</a></li>
|
||
|
|
<li>Send() : <a class="el" href="classftxui_1_1SenderImpl.html#af3a961fb9b4025671b6122a392a5bc3f">SenderImpl< T ></a></li>
|
||
|
|
<li>SenderImpl() : <a class="el" href="classftxui_1_1SenderImpl.html#a7770521e8bff392402a1539bf4eb8ff4">SenderImpl< T ></a></li>
|
||
|
|
<li>Separator() : <a class="el" href="classftxui_1_1TableSelection.html#ab1c6e11d86131eddb095c8211b824b18">TableSelection</a></li>
|
||
|
|
<li>SeparatorHorizontal() : <a class="el" href="classftxui_1_1TableSelection.html#affd2ab7143cb388fdedad3bd51995802">TableSelection</a></li>
|
||
|
|
<li>SeparatorVertical() : <a class="el" href="classftxui_1_1TableSelection.html#a2334aed76610138905c96dc298b7e9df">TableSelection</a></li>
|
||
|
|
<li>Set() : <a class="el" href="group__component.html#ad186d5a36e45174bbc7c50df85c2e91e">AnimatedColorOption</a>, <a class="el" href="group__dom.html#ae47b5b0d793d0c2312e4805a1f40012a">FlexboxConfig</a></li>
|
||
|
|
<li>SetActiveChild() : <a class="el" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">ComponentBase</a></li>
|
||
|
|
<li>SetAnimation() : <a class="el" href="group__component.html#a754d89398aac6051ced26fd452c62589">UnderlineOption</a></li>
|
||
|
|
<li>SetAnimationDuration() : <a class="el" href="group__component.html#a798360474be7511364b8171f0c62f6d5">UnderlineOption</a></li>
|
||
|
|
<li>SetAnimationFunction() : <a class="el" href="group__component.html#a34e6222dbf10e899074054160870816c">UnderlineOption</a></li>
|
||
|
|
<li>SetBox() : <a class="el" href="group__dom.html#a2ed318aaadb07efc50e76fce1ccf9637">Node</a>, <a class="el" href="classftxui_1_1NodeDecorator.html#aafcc9bd6538ccb37babf4d56c4c1c238">NodeDecorator</a></li>
|
||
|
|
<li>SetCursor() : <a class="el" href="group__screen.html#a1aa24862a3d050b3aea2ade1300d51a7">Screen</a></li>
|
||
|
|
<li>SetGap() : <a class="el" href="group__dom.html#a98d9a43033c09c7f967cdec791408bad">FlexboxConfig</a></li>
|
||
|
|
<li>SetSelectionStyle() : <a class="el" href="group__screen.html#aba0d30b90db17d6b7561f704ed63b5e6">Screen</a></li>
|
||
|
|
<li>Shift() : <a class="el" href="group__screen.html#a507dad970b4732caab79e5922bdc5fb5">Box</a></li>
|
||
|
|
<li>Signal() : <a class="el" href="classftxui_1_1ScreenInteractive_1_1Private.html#aa831d3b9234cd15d4bcb5a42dec43943">ScreenInteractive::Private</a></li>
|
||
|
|
<li>Simple() : <a class="el" href="group__component.html#a553fe18f102e8e62aec516d4d3213eac">ButtonOption</a>, <a class="el" href="group__component.html#a41b17a916980353033366c01b15d3cb1">CheckboxOption</a>, <a class="el" href="group__component.html#af2b048773665961fae6c104762533908">RadioboxOption</a></li>
|
||
|
|
<li>size() : <a class="el" href="classftxui_1_1ConstStringListRef_1_1Adapter.html#aa983ddaeded5756189f46428be79c631">ConstStringListRef::Adapter</a>, <a class="el" href="classftxui_1_1ConstStringListRef.html#a259cb5a711406a8c3e5d937eb9350cca">ConstStringListRef</a></li>
|
||
|
|
<li>Spacious() : <a class="el" href="group__component.html#a36c56131167eaaae707f64bbb9d07ef2">InputOption</a></li>
|
||
|
|
<li>Special() : <a class="el" href="group__component.html#afe901de476c29382cc358333f10e5ee7">Event</a></li>
|
||
|
|
<li>Stop() : <a class="el" href="group__dom.html#a03b10012f78e1c731616ce760d28df40">LinearGradient</a></li>
|
||
|
|
<li>StringRef() : <a class="el" href="classftxui_1_1StringRef.html#ad3cfa31525e075cbd5f50c2476e665ce">StringRef</a></li>
|
||
|
|
<li>Style() : <a class="el" href="group__dom.html#ae9e7d3f5b753cf2650057623960d4cb4">Canvas</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>
|