Files
FTXUI/functions_p.html
2025-11-12 12:56:59 +00:00

304 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">&#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_p.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_p" name="index_p"></a>- p -</h3><ul>
<li>P&#160;:&#160;<a class="el" href="group__component.html#adbe5783b3283110278f68e58bb286b9f">Event</a></li>
<li>p&#160;:&#160;<a class="el" href="group__component.html#a6e9d231eb7f1a65490a68e31131c945b">Event</a></li>
<li>PageDown&#160;:&#160;<a class="el" href="group__component.html#acc3462fea2a9b2085734ff87dc881b4c">Event</a></li>
<li>PageUp&#160;:&#160;<a class="el" href="group__component.html#a21ae13b6dcbc80ed6549a5afab248477">Event</a></li>
<li>PaleGreen1&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfaa37e5d9f46ab5a7952f9cdf0a3cc8925">Color</a></li>
<li>PaleGreen1Bis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa115628c4a676f43dc9a5791c927e7048">Color</a></li>
<li>PaleGreen3&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa73f2e82908260a1c80e9cdffd7c80b05">Color</a></li>
<li>PaleGreen3Bis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa05657d514246de9444d35bfd78da177d">Color</a></li>
<li>Palette1&#160;:&#160;<a class="el" href="group__screen.html#aa4be56f94fc180d7b070df23c235b0c7">Color</a></li>
<li>Palette16&#160;:&#160;<a class="el" href="group__screen.html#ae2b6d9670960e89c66d7b76167a0802f">Color</a></li>
<li>Palette256&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcf">Color</a></li>
<li>PaleTurquoise1&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa2c1b8b84117604af63923758665c0762">Color</a></li>
<li>PaleTurquoise4&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfafebf48dd9c5efb72a880db1800b70cb4">Color</a></li>
<li>PaleVioletRed1&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa7b52566a531a122cc807cd5698659f6f">Color</a></li>
<li>Params()&#160;:&#160;<a class="el" href="classftxui_1_1animation_1_1Params.html#a27854a0925475df9b926b03808cc8d8c">Params</a></li>
<li>Parent()&#160;:&#160;<a class="el" href="group__component.html#aaf284a408631f31558694973a04186c2">ComponentBase</a></li>
<li>password&#160;:&#160;<a class="el" href="group__component.html#a927bd46792ffe38c7545a764d847d066">InputOption</a></li>
<li>PendingTask()&#160;:&#160;<a class="el" href="structftxui_1_1task_1_1PendingTask.html#afc8e67df1a9259a50e7afa49765cb7c8">PendingTask</a></li>
<li>Pink1&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfab1b14b4665532f810353fbd89ba7bf69">Color</a></li>
<li>Pink3&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa18d97cfab35116e2049378e4410b0563">Color</a></li>
<li>Pixel()&#160;:&#160;<a class="el" href="group__screen.html#a3d22dc2630f1c1c69ec973cd4648b5d5">Pixel</a></li>
<li>PixelAt()&#160;:&#160;<a class="el" href="group__screen.html#a483f8ee1967e200cfc9e277b3ce00174">Image</a></li>
<li>pixels_&#160;:&#160;<a class="el" href="group__screen.html#aeab8c1788b3f2c7403749c3be95a68ae">Image</a></li>
<li>placeholder&#160;:&#160;<a class="el" href="group__component.html#aaca8e18f9fe70089d8fd4165f4b518e1">InputOption</a></li>
<li>Plum1&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfaa3c254e3ced4cbe2836a246270317ac1">Color</a></li>
<li>Plum2&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa383cc742bb6efae64c17af4b0159f2f1">Color</a></li>
<li>Plum3&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfab2b302d3a548112c82dbe295f1cace40">Color</a></li>
<li>Plum4&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa69b6a24bf00f2a9278f12241e176106c">Color</a></li>
<li>position&#160;:&#160;<a class="el" href="structftxui_1_1LinearGradient_1_1Stop.html#a2f3c9e83b473a71f2882ee1ec4fb88de">LinearGradient::Stop</a></li>
<li>Post()&#160;:&#160;<a class="el" href="group__component.html#a49209b09dcf8bc540f79e2bfd0a7ee88">ScreenInteractive</a></li>
<li>PostDelayedTask()&#160;:&#160;<a class="el" href="classftxui_1_1task_1_1TaskRunner.html#a9ed72fa10b2d44bb1af7bd8af64dd28b">TaskRunner</a></li>
<li>PostEvent()&#160;:&#160;<a class="el" href="group__component.html#a29e75bdaa1d5465518787ec014b2c3bf">ScreenInteractive</a></li>
<li>PostTask()&#160;:&#160;<a class="el" href="structftxui_1_1task_1_1TaskQueue.html#ada41a34871c48f856bf3659e0b0c4f81">TaskQueue</a>, <a class="el" href="classftxui_1_1task_1_1TaskRunner.html#a6265a2d99ef09d491365c21a4a703c71">TaskRunner</a></li>
<li>Prefer()&#160;:&#160;<a class="el" href="structftxui_1_1Requirement_1_1Focused.html#a8a204963959c73e971c7d030cbc34134">Requirement::Focused</a></li>
<li>Pressed&#160;:&#160;<a class="el" href="group__component.html#a099c889d2b948b264c7a665b66e3a9b6a05f4abb2322aa023aba9570c327aff25">Mouse</a></li>
<li>Print()&#160;:&#160;<a class="el" href="group__screen.html#acfe358aa128835387b6c2b7ffe22bab5">Color</a>, <a class="el" href="group__screen.html#ad93edbe885499a712129356f1ffd506b">Screen</a></li>
<li>Private&#160;:&#160;<a class="el" href="group__component.html#a55bfcd8369da28d548069f2761d2c39f">ScreenInteractive</a></li>
<li>Purple&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa0102772e56e7f068bdb57bf2905f7c09">Color</a></li>
<li>Purple3&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa3ba6254f6df4ad7c05ee0be4ccd4bce0">Color</a></li>
<li>Purple4&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfacb508ce5a099dbfa4e04cd59530f7f0c">Color</a></li>
<li>Purple4Bis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfa1dfe93e583d4f1a3538c40ce29208e64">Color</a></li>
<li>PurpleBis&#160;:&#160;<a class="el" href="group__screen.html#abd07c48f62cc507fafa2486a43130fcfae855e26440338753abef27e7b999ce5b">Color</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! -->
</div>
<script>
document.addEventListener('DOMContentLoaded', function() {
const projectNumber = document.getElementById('projectnumber');
if (!projectNumber) {
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
return;
}
const versions = ["main", "v6.1.9", "v6.1.8", "v6.1.7", "v6.1.6", "v6.1.5", "v6.1.4", "v6.1.3", "v6.1.2", "v6.1.1", "v6.1.0", "v6.0.2", "v6.0.1", "v6.0.0", "v5.0.0", "v4.1.1", "v4.1.0", "v4.0.0", "v3.0.0", "v2.0.0", "v0.9", "v0.11", "v0.10"];
const version_paths = {"main": "index.html", "v6.1.9": "en/v6.1.9/index.html", "v6.1.8": "en/v6.1.8/index.html", "v6.1.7": "en/v6.1.7/index.html", "v6.1.6": "en/v6.1.6/index.html", "v6.1.5": "en/v6.1.5/index.html", "v6.1.4": "en/v6.1.4/index.html", "v6.1.3": "en/v6.1.3/index.html", "v6.1.2": "en/v6.1.2/index.html", "v6.1.1": "en/v6.1.1/index.html", "v6.1.0": "en/v6.1.0/index.html", "v6.0.2": "en/v6.0.2/index.html", "v6.0.1": "en/v6.0.1/index.html", "v6.0.0": "en/v6.0.0/index.html", "v5.0.0": "en/v5.0.0/index.html", "v4.1.1": "en/v4.1.1/index.html", "v4.1.0": "en/v4.1.0/index.html", "v4.0.0": "en/v4.0.0/index.html", "v3.0.0": "en/v3.0.0/index.html", "v2.0.0": "en/v2.0.0/index.html", "v0.9": "en/v0.9/index.html", "v0.11": "en/v0.11/index.html", "v0.10": "en/v0.10/index.html"};
const currentVersion = "main";
// Sort versions: 'main' first, then others numerically descending.
versions.sort((a, b) => {
if (a === 'main') return -1;
if (b === 'main') return 1;
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
});
const select = document.createElement('select');
select.onchange = function() {
const selectedVersion = this.value;
// Navigate directly to the pre-calculated relative path.
if (selectedVersion !== currentVersion) {
window.location.href = version_paths[selectedVersion];
}
};
versions.forEach(v => {
const option = document.createElement('option');
option.value = v;
option.textContent = v;
if (v === currentVersion) {
option.selected = true;
}
select.appendChild(option);
});
// Replace the Doxygen project number element with our dropdown.
projectNumber.replaceWith(select);
// Apply some styling to make it look good.
Object.assign(select.style, {
backgroundColor: 'rgba(0, 0, 0, 0.8)',
color: 'white',
border: '1px solid rgba(255, 255, 255, 0.2)',
padding: '5px',
borderRadius: '5px',
fontSize: '14px',
fontFamily: 'inherit',
marginLeft: '10px',
cursor: 'pointer'
});
});
</script>
</body>
</html>