mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
5697 lines
405 KiB
HTML
5697 lines
405 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: ftxui/component</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('group__component.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="header">
|
||
<div class="summary">
|
||
<a href="#nested-classes">Classes</a> |
|
||
<a href="#func-members">Functions</a> </div>
|
||
<div class="headertitle"><div class="title">ftxui/component</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
<p>Please check the <a href="module-component.html">tutorial</a> of the <code>ftxui/component</code> module. </p>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||
Classes</h2></td></tr>
|
||
<tr class="memitem:classftxui_1_1ComponentBase" id="r_classftxui_1_1ComponentBase"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a></td></tr>
|
||
<tr class="memdesc:classftxui_1_1ComponentBase"><td class="mdescLeft"> </td><td class="mdescRight">It implement rendering itself as <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a>. It implement keyboard navigation by responding to <a class="el" href="structftxui_1_1Event.html" title="Represent an event. It can be key press event, a terminal resize, or more ...">ftxui::Event</a>. <a href="#classftxui_1_1ComponentBase">More...</a><br /></td></tr>
|
||
<tr class="separator:classftxui_1_1ComponentBase"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1AnimatedColorOption" id="r_structftxui_1_1AnimatedColorOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1AnimatedColorOption">AnimatedColorOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1AnimatedColorOption"><td class="mdescLeft"> </td><td class="mdescRight">Option about a potentially animated color. <a href="#structftxui_1_1AnimatedColorOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1AnimatedColorOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1MenuEntryOption" id="r_structftxui_1_1MenuEntryOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1MenuEntryOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the MenuEntry component. <a href="#structftxui_1_1MenuEntryOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1MenuEntryOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1MenuOption" id="r_structftxui_1_1MenuOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1MenuOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Menu component. <a href="#structftxui_1_1MenuOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1MenuOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1ButtonOption" id="r_structftxui_1_1ButtonOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1ButtonOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the AnimatedButton component. <a href="#structftxui_1_1ButtonOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1ButtonOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1CheckboxOption" id="r_structftxui_1_1CheckboxOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1CheckboxOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Checkbox component. <a href="#structftxui_1_1CheckboxOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1CheckboxOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1InputOption" id="r_structftxui_1_1InputOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1InputOption">InputOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1InputOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Input component. <a href="#structftxui_1_1InputOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1InputOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1RadioboxOption" id="r_structftxui_1_1RadioboxOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1RadioboxOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Radiobox component. <a href="#structftxui_1_1RadioboxOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1RadioboxOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1DropdownOption" id="r_structftxui_1_1DropdownOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1DropdownOption">DropdownOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1DropdownOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Dropdown component.A dropdown menu is a checkbox opening/closing a radiobox. <a href="#structftxui_1_1DropdownOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1DropdownOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1Mouse" id="r_structftxui_1_1Mouse"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1Mouse">Mouse</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1Mouse"><td class="mdescLeft"> </td><td class="mdescRight">A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift, ctrl, meta). <a href="#structftxui_1_1Mouse">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1Mouse"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||
Functions</h2></td></tr>
|
||
<tr class="memitem:ga4e8295ec77dd31b0acc5063b134473e7" id="r_ga4e8295ec77dd31b0acc5063b134473e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a> (<a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga4e8295ec77dd31b0acc5063b134473e7"><td class="mdescLeft"> </td><td class="mdescRight">Draw a button. Execute a function when clicked. <br /></td></tr>
|
||
<tr class="separator:ga4e8295ec77dd31b0acc5063b134473e7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0488e28ee9388e0ddca26f1d03d827d1" id="r_ga0488e28ee9388e0ddca26f1d03d827d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0488e28ee9388e0ddca26f1d03d827d1">Button</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, std::function< void()> on_click, <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga0488e28ee9388e0ddca26f1d03d827d1"><td class="mdescLeft"> </td><td class="mdescRight">Draw a button. Execute a function when clicked. <br /></td></tr>
|
||
<tr class="separator:ga0488e28ee9388e0ddca26f1d03d827d1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0bfd67a2815807dc6fc9bc0f79bce29e" id="r_ga0bfd67a2815807dc6fc9bc0f79bce29e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0bfd67a2815807dc6fc9bc0f79bce29e">CatchEvent</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a> event)> on_event)</td></tr>
|
||
<tr class="memdesc:ga0bfd67a2815807dc6fc9bc0f79bce29e"><td class="mdescLeft"> </td><td class="mdescRight">Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. <br /></td></tr>
|
||
<tr class="separator:ga0bfd67a2815807dc6fc9bc0f79bce29e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gad2948235799c010c76c6de861c050c59" id="r_gad2948235799c010c76c6de861c050c59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad2948235799c010c76c6de861c050c59">CatchEvent</a> (std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a>)> on_event)</td></tr>
|
||
<tr class="memdesc:gad2948235799c010c76c6de861c050c59"><td class="mdescLeft"> </td><td class="mdescRight">Decorate a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. <br /></td></tr>
|
||
<tr class="separator:gad2948235799c010c76c6de861c050c59"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gae0d441d2c83740f187f62db566bbefcd" id="r_gae0d441d2c83740f187f62db566bbefcd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae0d441d2c83740f187f62db566bbefcd">Checkbox</a> (<a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> option)</td></tr>
|
||
<tr class="memdesc:gae0d441d2c83740f187f62db566bbefcd"><td class="mdescLeft"> </td><td class="mdescRight">Draw checkable element. <br /></td></tr>
|
||
<tr class="separator:gae0d441d2c83740f187f62db566bbefcd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga5e9dbb03c44d549f10c96f134269366f" id="r_ga5e9dbb03c44d549f10c96f134269366f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5e9dbb03c44d549f10c96f134269366f">Checkbox</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, bool *checked, <a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga5e9dbb03c44d549f10c96f134269366f"><td class="mdescLeft"> </td><td class="mdescRight">Draw checkable element. <br /></td></tr>
|
||
<tr class="separator:ga5e9dbb03c44d549f10c96f134269366f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga6471e39f5664d059144746c5801d37e6" id="r_ga6471e39f5664d059144746c5801d37e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6471e39f5664d059144746c5801d37e6">Vertical</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
<tr class="memdesc:ga6471e39f5664d059144746c5801d37e6"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. <br /></td></tr>
|
||
<tr class="separator:ga6471e39f5664d059144746c5801d37e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga25099e2d2ead8a46c8d9a899982070b7" id="r_ga25099e2d2ead8a46c8d9a899982070b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga25099e2d2ead8a46c8d9a899982070b7">Vertical</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
||
<tr class="memdesc:ga25099e2d2ead8a46c8d9a899982070b7"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. <br /></td></tr>
|
||
<tr class="separator:ga25099e2d2ead8a46c8d9a899982070b7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga01563bae9454fe64c0b29b0eb3755e68" id="r_ga01563bae9454fe64c0b29b0eb3755e68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga01563bae9454fe64c0b29b0eb3755e68">Horizontal</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
<tr class="memdesc:ga01563bae9454fe64c0b29b0eb3755e68"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. <br /></td></tr>
|
||
<tr class="separator:ga01563bae9454fe64c0b29b0eb3755e68"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga337564f8a13c98222025d8fe7e47df4c" id="r_ga337564f8a13c98222025d8fe7e47df4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga337564f8a13c98222025d8fe7e47df4c">Horizontal</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
||
<tr class="memdesc:ga337564f8a13c98222025d8fe7e47df4c"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. <br /></td></tr>
|
||
<tr class="separator:ga337564f8a13c98222025d8fe7e47df4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaea9fe244eeeb420276bcc5760b46953d" id="r_gaea9fe244eeeb420276bcc5760b46953d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaea9fe244eeeb420276bcc5760b46953d">Tab</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
||
<tr class="memdesc:gaea9fe244eeeb420276bcc5760b46953d"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. <br /></td></tr>
|
||
<tr class="separator:gaea9fe244eeeb420276bcc5760b46953d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaafd394665b0c231380a143b810339d8e" id="r_gaafd394665b0c231380a143b810339d8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaafd394665b0c231380a143b810339d8e">Stacked</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
<tr class="memdesc:gaafd394665b0c231380a143b810339d8e"><td class="mdescLeft"> </td><td class="mdescRight">A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. <br /></td></tr>
|
||
<tr class="separator:gaafd394665b0c231380a143b810339d8e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaa22bddff4aeed66e20f30d0715596999" id="r_gaa22bddff4aeed66e20f30d0715596999"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa22bddff4aeed66e20f30d0715596999">Dropdown</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected)</td></tr>
|
||
<tr class="memdesc:gaa22bddff4aeed66e20f30d0715596999"><td class="mdescLeft"> </td><td class="mdescRight">A dropdown menu. <br /></td></tr>
|
||
<tr class="separator:gaa22bddff4aeed66e20f30d0715596999"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaa4b353566017558bac648ee1409930de" id="r_gaa4b353566017558bac648ee1409930de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa4b353566017558bac648ee1409930de">Dropdown</a> (<a class="el" href="#structftxui_1_1DropdownOption">DropdownOption</a> option)</td></tr>
|
||
<tr class="memdesc:gaa4b353566017558bac648ee1409930de"><td class="mdescLeft"> </td><td class="mdescRight">A dropdown menu. <br /></td></tr>
|
||
<tr class="separator:gaa4b353566017558bac648ee1409930de"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga562d984d3830d63285643565cd55d16f" id="r_ga562d984d3830d63285643565cd55d16f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, bool *hover)</td></tr>
|
||
<tr class="memdesc:ga562d984d3830d63285643565cd55d16f"><td class="mdescLeft"> </td><td class="mdescRight">Wrap a component. Gives the ability to know if it is hovered by the mouse. <br /></td></tr>
|
||
<tr class="separator:ga562d984d3830d63285643565cd55d16f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga92ec2f5ccb509da2e2c24ae6a1f6b12b" id="r_ga92ec2f5ccb509da2e2c24ae6a1f6b12b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga92ec2f5ccb509da2e2c24ae6a1f6b12b">Hoverable</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, std::function< void()> on_enter, std::function< void()> on_leave)</td></tr>
|
||
<tr class="memdesc:ga92ec2f5ccb509da2e2c24ae6a1f6b12b"><td class="mdescLeft"> </td><td class="mdescRight">Wrap a component. Uses callbacks. <br /></td></tr>
|
||
<tr class="separator:ga92ec2f5ccb509da2e2c24ae6a1f6b12b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9d94b37352be13d3551a9d5785f75439" id="r_ga9d94b37352be13d3551a9d5785f75439"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9d94b37352be13d3551a9d5785f75439">Hoverable</a> (bool *hover)</td></tr>
|
||
<tr class="memdesc:ga9d94b37352be13d3551a9d5785f75439"><td class="mdescLeft"> </td><td class="mdescRight">Wrap a component. Gives the ability to know if it is hovered by the mouse. <br /></td></tr>
|
||
<tr class="separator:ga9d94b37352be13d3551a9d5785f75439"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga34adfc9c76cf3603156cba32ad5d7142" id="r_ga34adfc9c76cf3603156cba32ad5d7142"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga34adfc9c76cf3603156cba32ad5d7142">Hoverable</a> (std::function< void()> on_enter, std::function< void()> on_leave)</td></tr>
|
||
<tr class="memdesc:ga34adfc9c76cf3603156cba32ad5d7142"><td class="mdescLeft"> </td><td class="mdescRight">Wrap a component. Gives the ability to know if it is hovered by the mouse. <br /></td></tr>
|
||
<tr class="separator:ga34adfc9c76cf3603156cba32ad5d7142"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga91cac81077c483efdb952268aee9a523" id="r_ga91cac81077c483efdb952268aee9a523"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga91cac81077c483efdb952268aee9a523">Hoverable</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, std::function< void(bool)> on_change)</td></tr>
|
||
<tr class="memdesc:ga91cac81077c483efdb952268aee9a523"><td class="mdescLeft"> </td><td class="mdescRight">Wrap a component. Gives the ability to know if it is hovered by the mouse. <br /></td></tr>
|
||
<tr class="separator:ga91cac81077c483efdb952268aee9a523"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gafd7cbaef5378a907111a64ee69aed56a" id="r_gafd7cbaef5378a907111a64ee69aed56a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafd7cbaef5378a907111a64ee69aed56a">Hoverable</a> (std::function< void(bool)> on_change)</td></tr>
|
||
<tr class="memdesc:gafd7cbaef5378a907111a64ee69aed56a"><td class="mdescLeft"> </td><td class="mdescRight">Wrap a component. Gives the ability to know if it is hovered by the mouse. <br /></td></tr>
|
||
<tr class="separator:gafd7cbaef5378a907111a64ee69aed56a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga7f285fcbc4dd0a0767b89a255fd062dc" id="r_ga7f285fcbc4dd0a0767b89a255fd062dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a> (<a class="el" href="#structftxui_1_1InputOption">InputOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga7f285fcbc4dd0a0767b89a255fd062dc"><td class="mdescLeft"> </td><td class="mdescRight">An input box for editing text. <br /></td></tr>
|
||
<tr class="separator:ga7f285fcbc4dd0a0767b89a255fd062dc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9d118d596e33bf5bee9d5eccb6265d15" id="r_ga9d118d596e33bf5bee9d5eccb6265d15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9d118d596e33bf5bee9d5eccb6265d15">Input</a> (<a class="el" href="classftxui_1_1StringRef.html">StringRef</a> content, <a class="el" href="#structftxui_1_1InputOption">InputOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga9d118d596e33bf5bee9d5eccb6265d15"><td class="mdescLeft"> </td><td class="mdescRight">An input box for editing text. <br /></td></tr>
|
||
<tr class="separator:ga9d118d596e33bf5bee9d5eccb6265d15"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga82ba18065d2c29514f034c7278dead74" id="r_ga82ba18065d2c29514f034c7278dead74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga82ba18065d2c29514f034c7278dead74">Input</a> (<a class="el" href="classftxui_1_1StringRef.html">StringRef</a> content, <a class="el" href="classftxui_1_1StringRef.html">StringRef</a> placeholder, <a class="el" href="#structftxui_1_1InputOption">InputOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga82ba18065d2c29514f034c7278dead74"><td class="mdescLeft"> </td><td class="mdescRight">An input box for editing text. <br /></td></tr>
|
||
<tr class="separator:ga82ba18065d2c29514f034c7278dead74"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga70afe9695167fb736631173201969730" id="r_ga70afe9695167fb736631173201969730"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga70afe9695167fb736631173201969730">Maybe</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function< bool()> show)</td></tr>
|
||
<tr class="memdesc:ga70afe9695167fb736631173201969730"><td class="mdescLeft"> </td><td class="mdescRight">Decorate a component |child|. It is shown only when |show| returns true. <br /></td></tr>
|
||
<tr class="separator:ga70afe9695167fb736631173201969730"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gae39ad8b223e6bb7704c77a3708571a7d" id="r_gae39ad8b223e6bb7704c77a3708571a7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae39ad8b223e6bb7704c77a3708571a7d">Maybe</a> (std::function< bool()> show)</td></tr>
|
||
<tr class="memdesc:gae39ad8b223e6bb7704c77a3708571a7d"><td class="mdescLeft"> </td><td class="mdescRight">Decorate a component. It is shown only when the |show| function returns true. <br /></td></tr>
|
||
<tr class="separator:gae39ad8b223e6bb7704c77a3708571a7d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga20b66a70c1cd4ff3f0ff571a4507d2b4" id="r_ga20b66a70c1cd4ff3f0ff571a4507d2b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child, const bool *show)</td></tr>
|
||
<tr class="memdesc:ga20b66a70c1cd4ff3f0ff571a4507d2b4"><td class="mdescLeft"> </td><td class="mdescRight">Decorate a component |child|. It is shown only when |show| is true. <br /></td></tr>
|
||
<tr class="separator:ga20b66a70c1cd4ff3f0ff571a4507d2b4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga83b6fd5e1524023722a7450f987f15d0" id="r_ga83b6fd5e1524023722a7450f987f15d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga83b6fd5e1524023722a7450f987f15d0">Maybe</a> (const bool *show)</td></tr>
|
||
<tr class="memdesc:ga83b6fd5e1524023722a7450f987f15d0"><td class="mdescLeft"> </td><td class="mdescRight">Decorate a component. It is shown only when |show| is true. <br /></td></tr>
|
||
<tr class="separator:ga83b6fd5e1524023722a7450f987f15d0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga27828fc39da10a18478ba84b1b162039" id="r_ga27828fc39da10a18478ba84b1b162039"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga27828fc39da10a18478ba84b1b162039">Menu</a> (<a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga27828fc39da10a18478ba84b1b162039"><td class="mdescLeft"> </td><td class="mdescRight">A list of text. The focused element is selected. <br /></td></tr>
|
||
<tr class="separator:ga27828fc39da10a18478ba84b1b162039"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gad793a3a507766ffa711c4332a3815e24" id="r_gad793a3a507766ffa711c4332a3815e24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad793a3a507766ffa711c4332a3815e24">Menu</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected, <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> option)</td></tr>
|
||
<tr class="memdesc:gad793a3a507766ffa711c4332a3815e24"><td class="mdescLeft"> </td><td class="mdescRight">A list of text. The focused element is selected. <br /></td></tr>
|
||
<tr class="separator:gad793a3a507766ffa711c4332a3815e24"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga3537fccac66b07cd792874c9a6086811" id="r_ga3537fccac66b07cd792874c9a6086811"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3537fccac66b07cd792874c9a6086811">Toggle</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected)</td></tr>
|
||
<tr class="memdesc:ga3537fccac66b07cd792874c9a6086811"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal list of elements. The user can navigate through them. <br /></td></tr>
|
||
<tr class="separator:ga3537fccac66b07cd792874c9a6086811"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gafca94c5cdae5fbf3c6aa81fc1cd7b1c0" id="r_gafca94c5cdae5fbf3c6aa81fc1cd7b1c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafca94c5cdae5fbf3c6aa81fc1cd7b1c0">MenuEntry</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, <a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a> option)</td></tr>
|
||
<tr class="memdesc:gafca94c5cdae5fbf3c6aa81fc1cd7b1c0"><td class="mdescLeft"> </td><td class="mdescRight">A specific menu entry. They can be put into a Container::Vertical to form a menu. <br /></td></tr>
|
||
<tr class="separator:gafca94c5cdae5fbf3c6aa81fc1cd7b1c0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2c0a27959e6a5d90109f6d4506e00f69" id="r_ga2c0a27959e6a5d90109f6d4506e00f69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a> (<a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga2c0a27959e6a5d90109f6d4506e00f69"><td class="mdescLeft"> </td><td class="mdescRight">A specific menu entry. They can be put into a Container::Vertical to form a menu. <br /></td></tr>
|
||
<tr class="separator:ga2c0a27959e6a5d90109f6d4506e00f69"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga5185342fbba215496cb8a6805f36089c" id="r_ga5185342fbba215496cb8a6805f36089c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5185342fbba215496cb8a6805f36089c">Modal</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="el" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> modal, const bool *show_modal)</td></tr>
|
||
<tr class="separator:ga5185342fbba215496cb8a6805f36089c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga5babae0bb25f8cada57784cc5d27fb74" id="r_ga5babae0bb25f8cada57784cc5d27fb74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5babae0bb25f8cada57784cc5d27fb74">Modal</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> modal, const bool *show_modal)</td></tr>
|
||
<tr class="separator:ga5babae0bb25f8cada57784cc5d27fb74"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga3e7a44f321fa910f07aef5879e67af95" id="r_ga3e7a44f321fa910f07aef5879e67af95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3e7a44f321fa910f07aef5879e67af95">Radiobox</a> (<a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> option)</td></tr>
|
||
<tr class="memdesc:ga3e7a44f321fa910f07aef5879e67af95"><td class="mdescLeft"> </td><td class="mdescRight">A list of element, where only one can be selected. <br /></td></tr>
|
||
<tr class="separator:ga3e7a44f321fa910f07aef5879e67af95"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gac73eebf15ff6b5386b7ee6c6cb4a4890" id="r_gac73eebf15ff6b5386b7ee6c6cb4a4890"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac73eebf15ff6b5386b7ee6c6cb4a4890">Radiobox</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected, <a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> option)</td></tr>
|
||
<tr class="memdesc:gac73eebf15ff6b5386b7ee6c6cb4a4890"><td class="mdescLeft"> </td><td class="mdescRight">A list of element, where only one can be selected. <br /></td></tr>
|
||
<tr class="separator:gac73eebf15ff6b5386b7ee6c6cb4a4890"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaf03d3df7243bf71bb1a73686628f7f2b" id="r_gaf03d3df7243bf71bb1a73686628f7f2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf03d3df7243bf71bb1a73686628f7f2b">Renderer</a> (std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> render)</td></tr>
|
||
<tr class="memdesc:gaf03d3df7243bf71bb1a73686628f7f2b"><td class="mdescLeft"> </td><td class="mdescRight">Return a component, using |render| to render its interface. <br /></td></tr>
|
||
<tr class="separator:gaf03d3df7243bf71bb1a73686628f7f2b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga533e883e2aeea28de2b60564fcaf0361" id="r_ga533e883e2aeea28de2b60564fcaf0361"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> render)</td></tr>
|
||
<tr class="memdesc:ga533e883e2aeea28de2b60564fcaf0361"><td class="mdescLeft"> </td><td class="mdescRight">Return a new Component, similar to |child|, but using |render| as the Component::Render() event. <br /></td></tr>
|
||
<tr class="separator:ga533e883e2aeea28de2b60564fcaf0361"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga099cb57274a99396ee10f38acbfe62a7" id="r_ga099cb57274a99396ee10f38acbfe62a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga099cb57274a99396ee10f38acbfe62a7">Renderer</a> (std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(bool)> render)</td></tr>
|
||
<tr class="memdesc:ga099cb57274a99396ee10f38acbfe62a7"><td class="mdescLeft"> </td><td class="mdescRight">Return a focusable component, using |render| to render its interface. <br /></td></tr>
|
||
<tr class="separator:ga099cb57274a99396ee10f38acbfe62a7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga41d63b7af41dee1570b54915821abd30" id="r_ga41d63b7af41dee1570b54915821abd30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga41d63b7af41dee1570b54915821abd30">Renderer</a> (<a class="el" href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ElementDecorator</a> decorator)</td></tr>
|
||
<tr class="memdesc:ga41d63b7af41dee1570b54915821abd30"><td class="mdescLeft"> </td><td class="mdescRight">Decorate a component, by decorating what it renders. <br /></td></tr>
|
||
<tr class="separator:ga41d63b7af41dee1570b54915821abd30"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gae2205fc172615b43e1e3307bb614be4c" id="r_gae2205fc172615b43e1e3307bb614be4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae2205fc172615b43e1e3307bb614be4c">ResizableSplitLeft</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="el" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:gae2205fc172615b43e1e3307bb614be4c"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:gae2205fc172615b43e1e3307bb614be4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9030d0beb64f653603cab382b02750a8" id="r_ga9030d0beb64f653603cab382b02750a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9030d0beb64f653603cab382b02750a8">ResizableSplitRight</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="el" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:ga9030d0beb64f653603cab382b02750a8"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:ga9030d0beb64f653603cab382b02750a8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga238b4b650aca14716b82b2198695e008" id="r_ga238b4b650aca14716b82b2198695e008"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga238b4b650aca14716b82b2198695e008">ResizableSplitTop</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="el" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:ga238b4b650aca14716b82b2198695e008"><td class="mdescLeft"> </td><td class="mdescRight">An vertical split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:ga238b4b650aca14716b82b2198695e008"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gacb75e6e61a021829893f7b57aeb7e3a2" id="r_gacb75e6e61a021829893f7b57aeb7e3a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacb75e6e61a021829893f7b57aeb7e3a2">ResizableSplitBottom</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="el" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:gacb75e6e61a021829893f7b57aeb7e3a2"><td class="mdescLeft"> </td><td class="mdescRight">An vertical split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:gacb75e6e61a021829893f7b57aeb7e3a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gafdce74ff1421c2f1bda336c8dacefcbd" id="r_gafdce74ff1421c2f1bda336c8dacefcbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafdce74ff1421c2f1bda336c8dacefcbd">Slider</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > value, <a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>< int > min, <a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>< int > max, <a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>< int > increment)</td></tr>
|
||
<tr class="memdesc:gafdce74ff1421c2f1bda336c8dacefcbd"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal slider. <br /></td></tr>
|
||
<tr class="separator:gafdce74ff1421c2f1bda336c8dacefcbd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga638693abef9289912f5fa39606390b20" id="r_ga638693abef9289912f5fa39606390b20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga638693abef9289912f5fa39606390b20">Window</a> (<a class="el" href="structftxui_1_1WindowOptions.html">WindowOptions</a> option)</td></tr>
|
||
<tr class="memdesc:ga638693abef9289912f5fa39606390b20"><td class="mdescLeft"> </td><td class="mdescRight">A draggeable / resizeable window. To use multiple of them, they must be stacked using <code>Container::Stacked({...})</code> component;. <br /></td></tr>
|
||
<tr class="separator:ga638693abef9289912f5fa39606390b20"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaaf284a408631f31558694973a04186c2" id="r_gaaf284a408631f31558694973a04186c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaf284a408631f31558694973a04186c2">Parent</a> () const</td></tr>
|
||
<tr class="memdesc:gaaf284a408631f31558694973a04186c2"><td class="mdescLeft"> </td><td class="mdescRight">Return the parent <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a>, or nul if any. <br /></td></tr>
|
||
<tr class="separator:gaaf284a408631f31558694973a04186c2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaceb41a98abe10fb0b521ff8b65529b7f" id="r_gaceb41a98abe10fb0b521ff8b65529b7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaceb41a98abe10fb0b521ff8b65529b7f">ChildAt</a> (size_t i)</td></tr>
|
||
<tr class="memdesc:gaceb41a98abe10fb0b521ff8b65529b7f"><td class="mdescLeft"> </td><td class="mdescRight">Access the child at index <code>i</code>. <br /></td></tr>
|
||
<tr class="separator:gaceb41a98abe10fb0b521ff8b65529b7f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9ae5f77e923e2f0f8b0e26dcd4affb5b" id="r_ga9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9ae5f77e923e2f0f8b0e26dcd4affb5b">ChildCount</a> () const</td></tr>
|
||
<tr class="memdesc:ga9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of children. <br /></td></tr>
|
||
<tr class="separator:ga9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga8ef12397d1682615bc3108c397734179" id="r_ga8ef12397d1682615bc3108c397734179"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8ef12397d1682615bc3108c397734179">Index</a> () const</td></tr>
|
||
<tr class="memdesc:ga8ef12397d1682615bc3108c397734179"><td class="mdescLeft"> </td><td class="mdescRight">Return index of the component in its parent. -1 if no parent. <br /></td></tr>
|
||
<tr class="separator:ga8ef12397d1682615bc3108c397734179"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga21f040bec9104e164bfa6c3ad45be3a1" id="r_ga21f040bec9104e164bfa6c3ad45be3a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga21f040bec9104e164bfa6c3ad45be3a1">Add</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> children)</td></tr>
|
||
<tr class="memdesc:ga21f040bec9104e164bfa6c3ad45be3a1"><td class="mdescLeft"> </td><td class="mdescRight">Add a child. @param child The child to be attached. <br /></td></tr>
|
||
<tr class="separator:ga21f040bec9104e164bfa6c3ad45be3a1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gabb7a2b60240651d16e17d02eb6f636cf" id="r_gabb7a2b60240651d16e17d02eb6f636cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabb7a2b60240651d16e17d02eb6f636cf">Detach</a> ()</td></tr>
|
||
<tr class="memdesc:gabb7a2b60240651d16e17d02eb6f636cf"><td class="mdescLeft"> </td><td class="mdescRight">Detach this child from its parent. <br /></td></tr>
|
||
<tr class="separator:gabb7a2b60240651d16e17d02eb6f636cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga84bd6480cf5e8f51cf5965f81b1f2460" id="r_ga84bd6480cf5e8f51cf5965f81b1f2460"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga84bd6480cf5e8f51cf5965f81b1f2460">DetachAllChildren</a> ()</td></tr>
|
||
<tr class="memdesc:ga84bd6480cf5e8f51cf5965f81b1f2460"><td class="mdescLeft"> </td><td class="mdescRight">Remove all children. <br /></td></tr>
|
||
<tr class="separator:ga84bd6480cf5e8f51cf5965f81b1f2460"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga28d41d6113c5b29c8dd45846582b3299" id="r_ga28d41d6113c5b29c8dd45846582b3299"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga28d41d6113c5b29c8dd45846582b3299">Render</a> ()</td></tr>
|
||
<tr class="memdesc:ga28d41d6113c5b29c8dd45846582b3299"><td class="mdescLeft"> </td><td class="mdescRight">Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the <a class="el" href="group__screen.html#classftxui_1_1Screen" title="A rectangular grid of Pixel.">ftxui::Screen</a> representing this <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. Please override <a class="el" href="#gab79303652dad19eac0540848487cf8c5" title="Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::C...">OnRender()</a> to modify the rendering. <br /></td></tr>
|
||
<tr class="separator:ga28d41d6113c5b29c8dd45846582b3299"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gab79303652dad19eac0540848487cf8c5" id="r_gab79303652dad19eac0540848487cf8c5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab79303652dad19eac0540848487cf8c5">OnRender</a> ()</td></tr>
|
||
<tr class="memdesc:gab79303652dad19eac0540848487cf8c5"><td class="mdescLeft"> </td><td class="mdescRight">Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the ftxi::Screen representing this <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. This function is means to be overridden. <br /></td></tr>
|
||
<tr class="separator:gab79303652dad19eac0540848487cf8c5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gab84629a8fecad2e1cdd426b7ddc72277" id="r_gab84629a8fecad2e1cdd426b7ddc72277"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab84629a8fecad2e1cdd426b7ddc72277">OnEvent</a> (<a class="el" href="structftxui_1_1Event.html">Event</a>)</td></tr>
|
||
<tr class="memdesc:gab84629a8fecad2e1cdd426b7ddc72277"><td class="mdescLeft"> </td><td class="mdescRight">Called in response to an event. <br /></td></tr>
|
||
<tr class="separator:gab84629a8fecad2e1cdd426b7ddc72277"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaebad858485d02f035a8ea34af66a7fa7" id="r_gaebad858485d02f035a8ea34af66a7fa7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaebad858485d02f035a8ea34af66a7fa7">OnAnimation</a> (<a class="el" href="classftxui_1_1animation_1_1Params.html">animation::Params</a> &params)</td></tr>
|
||
<tr class="memdesc:gaebad858485d02f035a8ea34af66a7fa7"><td class="mdescLeft"> </td><td class="mdescRight">Called in response to an animation event. <br /></td></tr>
|
||
<tr class="separator:gaebad858485d02f035a8ea34af66a7fa7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga5c421f00a2a7f50c542c5c286d2e696c" id="r_ga5c421f00a2a7f50c542c5c286d2e696c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5c421f00a2a7f50c542c5c286d2e696c">ActiveChild</a> ()</td></tr>
|
||
<tr class="memdesc:ga5c421f00a2a7f50c542c5c286d2e696c"><td class="mdescLeft"> </td><td class="mdescRight">Return the currently Active child. <br /></td></tr>
|
||
<tr class="separator:ga5c421f00a2a7f50c542c5c286d2e696c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga02ccd3db74312f1c66aa8e7931489318" id="r_ga02ccd3db74312f1c66aa8e7931489318"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga02ccd3db74312f1c66aa8e7931489318">Focusable</a> () const</td></tr>
|
||
<tr class="memdesc:ga02ccd3db74312f1c66aa8e7931489318"><td class="mdescLeft"> </td><td class="mdescRight">Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. <br /></td></tr>
|
||
<tr class="separator:ga02ccd3db74312f1c66aa8e7931489318"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga52beef6d7a687d4d109e6cec1606e32e" id="r_ga52beef6d7a687d4d109e6cec1606e32e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga52beef6d7a687d4d109e6cec1606e32e">Active</a> () const</td></tr>
|
||
<tr class="memdesc:ga52beef6d7a687d4d109e6cec1606e32e"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the element if the currently active child of its parent. <br /></td></tr>
|
||
<tr class="separator:ga52beef6d7a687d4d109e6cec1606e32e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0cc612fa3d753b456e0f480f44654a9f" id="r_ga0cc612fa3d753b456e0f480f44654a9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0cc612fa3d753b456e0f480f44654a9f">Focused</a> () const</td></tr>
|
||
<tr class="memdesc:ga0cc612fa3d753b456e0f480f44654a9f"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the elements if focused by the user. True when the <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a> is focused by the user. An element is Focused when it is with all its ancestors the <a class="el" href="#ga5c421f00a2a7f50c542c5c286d2e696c" title="Return the currently Active child.">ActiveChild()</a> of their parents, and it <a class="el" href="#ga02ccd3db74312f1c66aa8e7931489318" title="Return true when the component contains focusable elements. The non focusable Components will be skip...">Focusable()</a>. <br /></td></tr>
|
||
<tr class="separator:ga0cc612fa3d753b456e0f480f44654a9f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga8cbf27680c6154e15c8b32d6601340de" id="r_ga8cbf27680c6154e15c8b32d6601340de"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8cbf27680c6154e15c8b32d6601340de">SetActiveChild</a> (<a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> *child)</td></tr>
|
||
<tr class="memdesc:ga8cbf27680c6154e15c8b32d6601340de"><td class="mdescLeft"> </td><td class="mdescRight">Make the |child| to be the "active" one. <br /></td></tr>
|
||
<tr class="separator:ga8cbf27680c6154e15c8b32d6601340de"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga50ad32ad14dd7912e681fab0ee294be2" id="r_ga50ad32ad14dd7912e681fab0ee294be2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga50ad32ad14dd7912e681fab0ee294be2">SetActiveChild</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child)</td></tr>
|
||
<tr class="memdesc:ga50ad32ad14dd7912e681fab0ee294be2"><td class="mdescLeft"> </td><td class="mdescRight">Make the |child| to be the "active" one. <br /></td></tr>
|
||
<tr class="separator:ga50ad32ad14dd7912e681fab0ee294be2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2cf27e9d7128a6a4b3263ecd34c19105" id="r_ga2cf27e9d7128a6a4b3263ecd34c19105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2cf27e9d7128a6a4b3263ecd34c19105">TakeFocus</a> ()</td></tr>
|
||
<tr class="memdesc:ga2cf27e9d7128a6a4b3263ecd34c19105"><td class="mdescLeft"> </td><td class="mdescRight">Configure all the ancestors to give focus to this component. <br /></td></tr>
|
||
<tr class="separator:ga2cf27e9d7128a6a4b3263ecd34c19105"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga164d10a2cf367bdd4ae14318a6c7d769" id="r_ga164d10a2cf367bdd4ae14318a6c7d769"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga164d10a2cf367bdd4ae14318a6c7d769">CaptureMouse</a> (const <a class="el" href="structftxui_1_1Event.html">Event</a> &event)</td></tr>
|
||
<tr class="memdesc:ga164d10a2cf367bdd4ae14318a6c7d769"><td class="mdescLeft"> </td><td class="mdescRight">Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. <br /></td></tr>
|
||
<tr class="separator:ga164d10a2cf367bdd4ae14318a6c7d769"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gad186d5a36e45174bbc7c50df85c2e91e" id="r_gad186d5a36e45174bbc7c50df85c2e91e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad186d5a36e45174bbc7c50df85c2e91e">Set</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> <a class="el" href="#a898e4eb6c2a93ea3b71fc373f39854eb">inactive</a>, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> <a class="el" href="#a5c04e41d802330270ae14a9861c1e2df">active</a>, <a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> <a class="el" href="#a7449575119a6168a323351fb04a7eb64">duration</a>=std::chrono::milliseconds(250), <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> <a class="el" href="#a23a21de13ab9c6644225966245df3fe3">function</a>=animation::easing::QuadraticInOut)</td></tr>
|
||
<tr class="memdesc:gad186d5a36e45174bbc7c50df85c2e91e"><td class="mdescLeft"> </td><td class="mdescRight">A color option that can be animated. @params _inactive The color when the component is inactive. @params _active The color when the component is active. @params _duration The duration of the animation. @params _function The easing function of the animation. <br /></td></tr>
|
||
<tr class="separator:gad186d5a36e45174bbc7c50df85c2e91e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga754d89398aac6051ced26fd452c62589" id="r_ga754d89398aac6051ced26fd452c62589"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga754d89398aac6051ced26fd452c62589">SetAnimation</a> (<a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> d, <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> f)</td></tr>
|
||
<tr class="memdesc:ga754d89398aac6051ced26fd452c62589"><td class="mdescLeft"> </td><td class="mdescRight">Set how the underline should animate. <br /></td></tr>
|
||
<tr class="separator:ga754d89398aac6051ced26fd452c62589"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga798360474be7511364b8171f0c62f6d5" id="r_ga798360474be7511364b8171f0c62f6d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga798360474be7511364b8171f0c62f6d5">SetAnimationDuration</a> (<a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> d)</td></tr>
|
||
<tr class="memdesc:ga798360474be7511364b8171f0c62f6d5"><td class="mdescLeft"> </td><td class="mdescRight">Set how the underline should animate. <br /></td></tr>
|
||
<tr class="separator:ga798360474be7511364b8171f0c62f6d5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga34e6222dbf10e899074054160870816c" id="r_ga34e6222dbf10e899074054160870816c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga34e6222dbf10e899074054160870816c">SetAnimationFunction</a> (<a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> f)</td></tr>
|
||
<tr class="memdesc:ga34e6222dbf10e899074054160870816c"><td class="mdescLeft"> </td><td class="mdescRight">Set how the underline should animate. <br /></td></tr>
|
||
<tr class="separator:ga34e6222dbf10e899074054160870816c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga7d978b34c37e9d08c57a22477016204c" id="r_ga7d978b34c37e9d08c57a22477016204c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7d978b34c37e9d08c57a22477016204c">SetAnimationFunction</a> (<a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> f_leader, <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> f_follower)</td></tr>
|
||
<tr class="memdesc:ga7d978b34c37e9d08c57a22477016204c"><td class="mdescLeft"> </td><td class="mdescRight">Set how the underline should animate. This is useful to desynchronize the animation of the leader and the follower. <br /></td></tr>
|
||
<tr class="separator:ga7d978b34c37e9d08c57a22477016204c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga5ee36f528383cc1db765fa2140797837" id="r_ga5ee36f528383cc1db765fa2140797837"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5ee36f528383cc1db765fa2140797837">Horizontal</a> ()</td></tr>
|
||
<tr class="memdesc:ga5ee36f528383cc1db765fa2140797837"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a horizontal menu. This can be useful to implement a tab bar. <br /></td></tr>
|
||
<tr class="separator:ga5ee36f528383cc1db765fa2140797837"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaedc93fba91339d9713812821cb140c50" id="r_gaedc93fba91339d9713812821cb140c50"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaedc93fba91339d9713812821cb140c50">HorizontalAnimated</a> ()</td></tr>
|
||
<tr class="memdesc:gaedc93fba91339d9713812821cb140c50"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an animated horizontal menu. This can be useful to implement a tab bar. <br /></td></tr>
|
||
<tr class="separator:gaedc93fba91339d9713812821cb140c50"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga617c59fdb94db99100d0e7a569c31d75" id="r_ga617c59fdb94db99100d0e7a569c31d75"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga617c59fdb94db99100d0e7a569c31d75">Vertical</a> ()</td></tr>
|
||
<tr class="memdesc:ga617c59fdb94db99100d0e7a569c31d75"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a vertical menu. This can be useful to implement a list of selectable items. <br /></td></tr>
|
||
<tr class="separator:ga617c59fdb94db99100d0e7a569c31d75"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga6079a7637256d70b30aacb92d2034205" id="r_ga6079a7637256d70b30aacb92d2034205"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6079a7637256d70b30aacb92d2034205">VerticalAnimated</a> ()</td></tr>
|
||
<tr class="memdesc:ga6079a7637256d70b30aacb92d2034205"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an animated vertical menu. This can be useful to implement a list of selectable items. <br /></td></tr>
|
||
<tr class="separator:ga6079a7637256d70b30aacb92d2034205"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga133a8caaf0246db0902f7abce37a9b6d" id="r_ga133a8caaf0246db0902f7abce37a9b6d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga133a8caaf0246db0902f7abce37a9b6d">Toggle</a> ()</td></tr>
|
||
<tr class="memdesc:ga133a8caaf0246db0902f7abce37a9b6d"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a horizontal menu with some separator. This can be useful to implement a tab bar. <br /></td></tr>
|
||
<tr class="separator:ga133a8caaf0246db0902f7abce37a9b6d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga66e244b326f3cdc7b80ea836c391c34b" id="r_ga66e244b326f3cdc7b80ea836c391c34b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga66e244b326f3cdc7b80ea836c391c34b">Ascii</a> ()</td></tr>
|
||
<tr class="memdesc:ga66e244b326f3cdc7b80ea836c391c34b"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, highlighted using [] characters. <br /></td></tr>
|
||
<tr class="separator:ga66e244b326f3cdc7b80ea836c391c34b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga553fe18f102e8e62aec516d4d3213eac" id="r_ga553fe18f102e8e62aec516d4d3213eac"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga553fe18f102e8e62aec516d4d3213eac">Simple</a> ()</td></tr>
|
||
<tr class="memdesc:ga553fe18f102e8e62aec516d4d3213eac"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, inverted when focused. <br /></td></tr>
|
||
<tr class="separator:ga553fe18f102e8e62aec516d4d3213eac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2f8ead79a770376a36e9b9b7fa6bc966" id="r_ga2f8ead79a770376a36e9b9b7fa6bc966"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2f8ead79a770376a36e9b9b7fa6bc966">Border</a> ()</td></tr>
|
||
<tr class="memdesc:ga2f8ead79a770376a36e9b9b7fa6bc966"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>. The button is shown using a border, inverted when focused. This is the current default. <br /></td></tr>
|
||
<tr class="separator:ga2f8ead79a770376a36e9b9b7fa6bc966"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga008018822835ed0f3758af3c6e72837d" id="r_ga008018822835ed0f3758af3c6e72837d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga008018822835ed0f3758af3c6e72837d">Animated</a> ()</td></tr>
|
||
<tr class="memdesc:ga008018822835ed0f3758af3c6e72837d"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:ga008018822835ed0f3758af3c6e72837d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga1a78fe7bb802251805a3867ba1a31e15" id="r_ga1a78fe7bb802251805a3867ba1a31e15"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1a78fe7bb802251805a3867ba1a31e15">Animated</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> color)</td></tr>
|
||
<tr class="memdesc:ga1a78fe7bb802251805a3867ba1a31e15"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:ga1a78fe7bb802251805a3867ba1a31e15"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0295430ca4a317b0cbba9ee5faa4a324" id="r_ga0295430ca4a317b0cbba9ee5faa4a324"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0295430ca4a317b0cbba9ee5faa4a324">Animated</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> background, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> foreground)</td></tr>
|
||
<tr class="memdesc:ga0295430ca4a317b0cbba9ee5faa4a324"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:ga0295430ca4a317b0cbba9ee5faa4a324"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gadf705e582d884e89211b540a97f2e090" id="r_gadf705e582d884e89211b540a97f2e090"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadf705e582d884e89211b540a97f2e090">Animated</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> background, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> foreground, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> background_active, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> foreground_active)</td></tr>
|
||
<tr class="memdesc:gadf705e582d884e89211b540a97f2e090"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:gadf705e582d884e89211b540a97f2e090"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga41b17a916980353033366c01b15d3cb1" id="r_ga41b17a916980353033366c01b15d3cb1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga41b17a916980353033366c01b15d3cb1">Simple</a> ()</td></tr>
|
||
<tr class="memdesc:ga41b17a916980353033366c01b15d3cb1"><td class="mdescLeft"> </td><td class="mdescRight">Option for standard Checkbox. <br /></td></tr>
|
||
<tr class="separator:ga41b17a916980353033366c01b15d3cb1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaf2b048773665961fae6c104762533908" id="r_gaf2b048773665961fae6c104762533908"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf2b048773665961fae6c104762533908">Simple</a> ()</td></tr>
|
||
<tr class="memdesc:gaf2b048773665961fae6c104762533908"><td class="mdescLeft"> </td><td class="mdescRight">Option for standard Radiobox. <br /></td></tr>
|
||
<tr class="separator:gaf2b048773665961fae6c104762533908"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2108670f055ede2fdc4993f6ffc8ff07" id="r_ga2108670f055ede2fdc4993f6ffc8ff07"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1InputOption">InputOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2108670f055ede2fdc4993f6ffc8ff07">Default</a> ()</td></tr>
|
||
<tr class="memdesc:ga2108670f055ede2fdc4993f6ffc8ff07"><td class="mdescLeft"> </td><td class="mdescRight">Create the default input style: <br /></td></tr>
|
||
<tr class="separator:ga2108670f055ede2fdc4993f6ffc8ff07"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga36c56131167eaaae707f64bbb9d07ef2" id="r_ga36c56131167eaaae707f64bbb9d07ef2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1InputOption">InputOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga36c56131167eaaae707f64bbb9d07ef2">Spacious</a> ()</td></tr>
|
||
<tr class="memdesc:ga36c56131167eaaae707f64bbb9d07ef2"><td class="mdescLeft"> </td><td class="mdescRight">A white on black style with high margins: <br /></td></tr>
|
||
<tr class="separator:ga36c56131167eaaae707f64bbb9d07ef2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga769519ed730b72a53a2e770d6ee44365" id="r_ga769519ed730b72a53a2e770d6ee44365"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga769519ed730b72a53a2e770d6ee44365">Character</a> (std::string)</td></tr>
|
||
<tr class="memdesc:ga769519ed730b72a53a2e770d6ee44365"><td class="mdescLeft"> </td><td class="mdescRight">An event corresponding to a given typed character. <br /></td></tr>
|
||
<tr class="separator:ga769519ed730b72a53a2e770d6ee44365"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9970fcb99b3c5ed50753111edf1d2cae" id="r_ga9970fcb99b3c5ed50753111edf1d2cae"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9970fcb99b3c5ed50753111edf1d2cae">Character</a> (char)</td></tr>
|
||
<tr class="memdesc:ga9970fcb99b3c5ed50753111edf1d2cae"><td class="mdescLeft"> </td><td class="mdescRight">An event corresponding to a given typed character. <br /></td></tr>
|
||
<tr class="separator:ga9970fcb99b3c5ed50753111edf1d2cae"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2f33d5ea7fca5423861773f891f5ba07" id="r_ga2f33d5ea7fca5423861773f891f5ba07"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2f33d5ea7fca5423861773f891f5ba07">Character</a> (wchar_t)</td></tr>
|
||
<tr class="memdesc:ga2f33d5ea7fca5423861773f891f5ba07"><td class="mdescLeft"> </td><td class="mdescRight">An event corresponding to a given typed character. <br /></td></tr>
|
||
<tr class="separator:ga2f33d5ea7fca5423861773f891f5ba07"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga382859ca10d98eb9c03713de4a95d3f9" id="r_ga382859ca10d98eb9c03713de4a95d3f9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga382859ca10d98eb9c03713de4a95d3f9">Mouse</a> (std::string, <a class="el" href="#structftxui_1_1Mouse">Mouse</a> <a class="el" href="structftxui_1_1Event.html#a761c3b7a78d8408dfbe76131209532d7">mouse</a>)</td></tr>
|
||
<tr class="memdesc:ga382859ca10d98eb9c03713de4a95d3f9"><td class="mdescLeft"> </td><td class="mdescRight">An event corresponding to a given typed character. <br /></td></tr>
|
||
<tr class="separator:ga382859ca10d98eb9c03713de4a95d3f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gafe901de476c29382cc358333f10e5ee7" id="r_gafe901de476c29382cc358333f10e5ee7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafe901de476c29382cc358333f10e5ee7">Special</a> (std::string)</td></tr>
|
||
<tr class="memdesc:gafe901de476c29382cc358333f10e5ee7"><td class="mdescLeft"> </td><td class="mdescRight">An custom event whose meaning is defined by the user of the library. <br /></td></tr>
|
||
<tr class="separator:gafe901de476c29382cc358333f10e5ee7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaacbc899babaac445c3b9b831322e8c70" id="r_gaacbc899babaac445c3b9b831322e8c70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaacbc899babaac445c3b9b831322e8c70">Loop</a> (<a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> *screen, <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component)</td></tr>
|
||
<tr class="memdesc:gaacbc899babaac445c3b9b831322e8c70"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="classftxui_1_1Loop.html">Loop</a> is a wrapper around a Component and a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>. It is used to run a Component in a terminal. <br /></td></tr>
|
||
<tr class="separator:gaacbc899babaac445c3b9b831322e8c70"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0f10869cb1cad212e8885deac6960a41" id="r_ga0f10869cb1cad212e8885deac6960a41"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0f10869cb1cad212e8885deac6960a41">HasQuitted</a> ()</td></tr>
|
||
<tr class="memdesc:ga0f10869cb1cad212e8885deac6960a41"><td class="mdescLeft"> </td><td class="mdescRight">Whether the loop has quitted. <br /></td></tr>
|
||
<tr class="separator:ga0f10869cb1cad212e8885deac6960a41"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga53dc5c3030151713857cf1a898d0f897" id="r_ga53dc5c3030151713857cf1a898d0f897"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga53dc5c3030151713857cf1a898d0f897">Fullscreen</a> ()</td></tr>
|
||
<tr class="separator:ga53dc5c3030151713857cf1a898d0f897"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga6be13532d5bef8f566c12090db2dffba" id="r_ga6be13532d5bef8f566c12090db2dffba"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6be13532d5bef8f566c12090db2dffba">FullscreenPrimaryScreen</a> ()</td></tr>
|
||
<tr class="separator:ga6be13532d5bef8f566c12090db2dffba"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gacad4646ece7569fd39a3a5c847ebb4a8" id="r_gacad4646ece7569fd39a3a5c847ebb4a8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacad4646ece7569fd39a3a5c847ebb4a8">FullscreenAlternateScreen</a> ()</td></tr>
|
||
<tr class="separator:gacad4646ece7569fd39a3a5c847ebb4a8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gad5961c1d4caf0ba9a030e5675162a164" id="r_gad5961c1d4caf0ba9a030e5675162a164"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad5961c1d4caf0ba9a030e5675162a164">TrackMouse</a> (bool enable=true)</td></tr>
|
||
<tr class="memdesc:gad5961c1d4caf0ba9a030e5675162a164"><td class="mdescLeft"> </td><td class="mdescRight">Set whether mouse is tracked and events reported. called outside of the main loop. E.g <code><a class="el" href="classftxui_1_1ScreenInteractive.html#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop(...)</a></code>. <br /></td></tr>
|
||
<tr class="separator:gad5961c1d4caf0ba9a030e5675162a164"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga49209b09dcf8bc540f79e2bfd0a7ee88" id="r_ga49209b09dcf8bc540f79e2bfd0a7ee88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga49209b09dcf8bc540f79e2bfd0a7ee88">Post</a> (<a class="el" href="namespaceftxui.html#aaa92a82e968c721805c62787cd000534">Task</a> task)</td></tr>
|
||
<tr class="memdesc:ga49209b09dcf8bc540f79e2bfd0a7ee88"><td class="mdescLeft"> </td><td class="mdescRight">Add a task to the main loop. It will be executed later, after every other scheduled tasks. <br /></td></tr>
|
||
<tr class="separator:ga49209b09dcf8bc540f79e2bfd0a7ee88"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga29e75bdaa1d5465518787ec014b2c3bf" id="r_ga29e75bdaa1d5465518787ec014b2c3bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga29e75bdaa1d5465518787ec014b2c3bf">PostEvent</a> (<a class="el" href="structftxui_1_1Event.html">Event</a> event)</td></tr>
|
||
<tr class="memdesc:ga29e75bdaa1d5465518787ec014b2c3bf"><td class="mdescLeft"> </td><td class="mdescRight">Add an event to the main loop. It will be executed later, after every other scheduled events. <br /></td></tr>
|
||
<tr class="separator:ga29e75bdaa1d5465518787ec014b2c3bf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaad61519d291dcc216d2ac618618a45a2" id="r_gaad61519d291dcc216d2ac618618a45a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaad61519d291dcc216d2ac618618a45a2">CaptureMouse</a> ()</td></tr>
|
||
<tr class="memdesc:gaad61519d291dcc216d2ac618618a45a2"><td class="mdescLeft"> </td><td class="mdescRight">Try to get the unique lock about behing able to capture the mouse. <br /></td></tr>
|
||
<tr class="separator:gaad61519d291dcc216d2ac618618a45a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9bd3dbd471fce0038700caaa47dddc1a" id="r_ga9bd3dbd471fce0038700caaa47dddc1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9bd3dbd471fce0038700caaa47dddc1a">Loop</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>)</td></tr>
|
||
<tr class="memdesc:ga9bd3dbd471fce0038700caaa47dddc1a"><td class="mdescLeft"> </td><td class="mdescRight">Execute the main loop. <br /></td></tr>
|
||
<tr class="separator:ga9bd3dbd471fce0038700caaa47dddc1a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gae295157a88e6300609df83769ed885f2" id="r_gae295157a88e6300609df83769ed885f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae295157a88e6300609df83769ed885f2">ExitLoopClosure</a> ()</td></tr>
|
||
<tr class="memdesc:gae295157a88e6300609df83769ed885f2"><td class="mdescLeft"> </td><td class="mdescRight">Return a function to exit the main loop. <br /></td></tr>
|
||
<tr class="separator:gae295157a88e6300609df83769ed885f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga1a6a7739e9cc01ba888b57d1f9457f4c" id="r_ga1a6a7739e9cc01ba888b57d1f9457f4c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1a6a7739e9cc01ba888b57d1f9457f4c">Exit</a> ()</td></tr>
|
||
<tr class="memdesc:ga1a6a7739e9cc01ba888b57d1f9457f4c"><td class="mdescLeft"> </td><td class="mdescRight">Exit the main loop. <br /></td></tr>
|
||
<tr class="separator:ga1a6a7739e9cc01ba888b57d1f9457f4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<hr/><h2 class="groupheader">Class Documentation</h2>
|
||
<a name="classftxui_1_1ComponentBase" id="classftxui_1_1ComponentBase"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#classftxui_1_1ComponentBase">◆ </a></span>ftxui::ComponentBase</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">class ftxui::ComponentBase</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>It implement rendering itself as <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a>. It implement keyboard navigation by responding to <a class="el" href="structftxui_1_1Event.html" title="Represent an event. It can be key press event, a terminal resize, or more ...">ftxui::Event</a>. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00030">30</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:ad2a5b6ce11bc7a8ce1150cf0ba9144c0" id="r_ad2a5b6ce11bc7a8ce1150cf0ba9144c0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2a5b6ce11bc7a8ce1150cf0ba9144c0">ComponentBase</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
||
<tr class="separator:ad2a5b6ce11bc7a8ce1150cf0ba9144c0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae490d465a018a9d81bb4e30604708fba" id="r_ae490d465a018a9d81bb4e30604708fba"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae490d465a018a9d81bb4e30604708fba">~ComponentBase</a> ()</td></tr>
|
||
<tr class="separator:ae490d465a018a9d81bb4e30604708fba"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:acda4c8b63ffbc2e9e2e28f056edbf01c" id="r_acda4c8b63ffbc2e9e2e28f056edbf01c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acda4c8b63ffbc2e9e2e28f056edbf01c">ComponentBase</a> ()=default</td></tr>
|
||
<tr class="separator:acda4c8b63ffbc2e9e2e28f056edbf01c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abd8cf6a9df5eb4678fb9925b686c7aea" id="r_abd8cf6a9df5eb4678fb9925b686c7aea"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abd8cf6a9df5eb4678fb9925b686c7aea">ComponentBase</a> (const <a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &)=delete</td></tr>
|
||
<tr class="separator:abd8cf6a9df5eb4678fb9925b686c7aea"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9b3cf357cf150023641969d5fcb7d08f" id="r_a9b3cf357cf150023641969d5fcb7d08f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b3cf357cf150023641969d5fcb7d08f">ComponentBase</a> (<a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &&)=delete</td></tr>
|
||
<tr class="separator:a9b3cf357cf150023641969d5fcb7d08f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac444ac233dcbd4b2ad7972d2086ecc73" id="r_ac444ac233dcbd4b2ad7972d2086ecc73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac444ac233dcbd4b2ad7972d2086ecc73">operator=</a> (const <a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &)=delete</td></tr>
|
||
<tr class="separator:ac444ac233dcbd4b2ad7972d2086ecc73"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9e3b99c8fc32f2ce151e2ba737c0d546" id="r_a9e3b99c8fc32f2ce151e2ba737c0d546"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e3b99c8fc32f2ce151e2ba737c0d546">operator=</a> (<a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &&)=delete</td></tr>
|
||
<tr class="separator:a9e3b99c8fc32f2ce151e2ba737c0d546"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaaf284a408631f31558694973a04186c2" id="r_gaaf284a408631f31558694973a04186c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaf284a408631f31558694973a04186c2">Parent</a> () const</td></tr>
|
||
<tr class="memdesc:gaaf284a408631f31558694973a04186c2"><td class="mdescLeft"> </td><td class="mdescRight">Return the parent <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a>, or nul if any. <br /></td></tr>
|
||
<tr class="separator:gaaf284a408631f31558694973a04186c2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaceb41a98abe10fb0b521ff8b65529b7f" id="r_gaceb41a98abe10fb0b521ff8b65529b7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaceb41a98abe10fb0b521ff8b65529b7f">ChildAt</a> (size_t i)</td></tr>
|
||
<tr class="memdesc:gaceb41a98abe10fb0b521ff8b65529b7f"><td class="mdescLeft"> </td><td class="mdescRight">Access the child at index <code>i</code>. <br /></td></tr>
|
||
<tr class="separator:gaceb41a98abe10fb0b521ff8b65529b7f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga9ae5f77e923e2f0f8b0e26dcd4affb5b" id="r_ga9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9ae5f77e923e2f0f8b0e26dcd4affb5b">ChildCount</a> () const</td></tr>
|
||
<tr class="memdesc:ga9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of children. <br /></td></tr>
|
||
<tr class="separator:ga9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga8ef12397d1682615bc3108c397734179" id="r_ga8ef12397d1682615bc3108c397734179"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8ef12397d1682615bc3108c397734179">Index</a> () const</td></tr>
|
||
<tr class="memdesc:ga8ef12397d1682615bc3108c397734179"><td class="mdescLeft"> </td><td class="mdescRight">Return index of the component in its parent. -1 if no parent. <br /></td></tr>
|
||
<tr class="separator:ga8ef12397d1682615bc3108c397734179"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga21f040bec9104e164bfa6c3ad45be3a1" id="r_ga21f040bec9104e164bfa6c3ad45be3a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga21f040bec9104e164bfa6c3ad45be3a1">Add</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> children)</td></tr>
|
||
<tr class="memdesc:ga21f040bec9104e164bfa6c3ad45be3a1"><td class="mdescLeft"> </td><td class="mdescRight">Add a child. @param child The child to be attached. <br /></td></tr>
|
||
<tr class="separator:ga21f040bec9104e164bfa6c3ad45be3a1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gabb7a2b60240651d16e17d02eb6f636cf" id="r_gabb7a2b60240651d16e17d02eb6f636cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabb7a2b60240651d16e17d02eb6f636cf">Detach</a> ()</td></tr>
|
||
<tr class="memdesc:gabb7a2b60240651d16e17d02eb6f636cf"><td class="mdescLeft"> </td><td class="mdescRight">Detach this child from its parent. <br /></td></tr>
|
||
<tr class="separator:gabb7a2b60240651d16e17d02eb6f636cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga84bd6480cf5e8f51cf5965f81b1f2460" id="r_ga84bd6480cf5e8f51cf5965f81b1f2460"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga84bd6480cf5e8f51cf5965f81b1f2460">DetachAllChildren</a> ()</td></tr>
|
||
<tr class="memdesc:ga84bd6480cf5e8f51cf5965f81b1f2460"><td class="mdescLeft"> </td><td class="mdescRight">Remove all children. <br /></td></tr>
|
||
<tr class="separator:ga84bd6480cf5e8f51cf5965f81b1f2460"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga28d41d6113c5b29c8dd45846582b3299" id="r_ga28d41d6113c5b29c8dd45846582b3299"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga28d41d6113c5b29c8dd45846582b3299">Render</a> ()</td></tr>
|
||
<tr class="memdesc:ga28d41d6113c5b29c8dd45846582b3299"><td class="mdescLeft"> </td><td class="mdescRight">Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the <a class="el" href="group__screen.html#classftxui_1_1Screen" title="A rectangular grid of Pixel.">ftxui::Screen</a> representing this <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. Please override <a class="el" href="#gab79303652dad19eac0540848487cf8c5" title="Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::C...">OnRender()</a> to modify the rendering. <br /></td></tr>
|
||
<tr class="separator:ga28d41d6113c5b29c8dd45846582b3299"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gab79303652dad19eac0540848487cf8c5" id="r_gab79303652dad19eac0540848487cf8c5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab79303652dad19eac0540848487cf8c5">OnRender</a> ()</td></tr>
|
||
<tr class="memdesc:gab79303652dad19eac0540848487cf8c5"><td class="mdescLeft"> </td><td class="mdescRight">Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the ftxi::Screen representing this <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. This function is means to be overridden. <br /></td></tr>
|
||
<tr class="separator:gab79303652dad19eac0540848487cf8c5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gab84629a8fecad2e1cdd426b7ddc72277" id="r_gab84629a8fecad2e1cdd426b7ddc72277"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab84629a8fecad2e1cdd426b7ddc72277">OnEvent</a> (<a class="el" href="structftxui_1_1Event.html">Event</a>)</td></tr>
|
||
<tr class="memdesc:gab84629a8fecad2e1cdd426b7ddc72277"><td class="mdescLeft"> </td><td class="mdescRight">Called in response to an event. <br /></td></tr>
|
||
<tr class="separator:gab84629a8fecad2e1cdd426b7ddc72277"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaebad858485d02f035a8ea34af66a7fa7" id="r_gaebad858485d02f035a8ea34af66a7fa7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaebad858485d02f035a8ea34af66a7fa7">OnAnimation</a> (<a class="el" href="classftxui_1_1animation_1_1Params.html">animation::Params</a> &params)</td></tr>
|
||
<tr class="memdesc:gaebad858485d02f035a8ea34af66a7fa7"><td class="mdescLeft"> </td><td class="mdescRight">Called in response to an animation event. <br /></td></tr>
|
||
<tr class="separator:gaebad858485d02f035a8ea34af66a7fa7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga5c421f00a2a7f50c542c5c286d2e696c" id="r_ga5c421f00a2a7f50c542c5c286d2e696c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5c421f00a2a7f50c542c5c286d2e696c">ActiveChild</a> ()</td></tr>
|
||
<tr class="memdesc:ga5c421f00a2a7f50c542c5c286d2e696c"><td class="mdescLeft"> </td><td class="mdescRight">Return the currently Active child. <br /></td></tr>
|
||
<tr class="separator:ga5c421f00a2a7f50c542c5c286d2e696c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga02ccd3db74312f1c66aa8e7931489318" id="r_ga02ccd3db74312f1c66aa8e7931489318"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga02ccd3db74312f1c66aa8e7931489318">Focusable</a> () const</td></tr>
|
||
<tr class="memdesc:ga02ccd3db74312f1c66aa8e7931489318"><td class="mdescLeft"> </td><td class="mdescRight">Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. <br /></td></tr>
|
||
<tr class="separator:ga02ccd3db74312f1c66aa8e7931489318"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga52beef6d7a687d4d109e6cec1606e32e" id="r_ga52beef6d7a687d4d109e6cec1606e32e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga52beef6d7a687d4d109e6cec1606e32e">Active</a> () const</td></tr>
|
||
<tr class="memdesc:ga52beef6d7a687d4d109e6cec1606e32e"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the element if the currently active child of its parent. <br /></td></tr>
|
||
<tr class="separator:ga52beef6d7a687d4d109e6cec1606e32e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0cc612fa3d753b456e0f480f44654a9f" id="r_ga0cc612fa3d753b456e0f480f44654a9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0cc612fa3d753b456e0f480f44654a9f">Focused</a> () const</td></tr>
|
||
<tr class="memdesc:ga0cc612fa3d753b456e0f480f44654a9f"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the elements if focused by the user. True when the <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a> is focused by the user. An element is Focused when it is with all its ancestors the <a class="el" href="#ga5c421f00a2a7f50c542c5c286d2e696c" title="Return the currently Active child.">ActiveChild()</a> of their parents, and it <a class="el" href="#ga02ccd3db74312f1c66aa8e7931489318" title="Return true when the component contains focusable elements. The non focusable Components will be skip...">Focusable()</a>. <br /></td></tr>
|
||
<tr class="separator:ga0cc612fa3d753b456e0f480f44654a9f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga8cbf27680c6154e15c8b32d6601340de" id="r_ga8cbf27680c6154e15c8b32d6601340de"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8cbf27680c6154e15c8b32d6601340de">SetActiveChild</a> (<a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> *child)</td></tr>
|
||
<tr class="memdesc:ga8cbf27680c6154e15c8b32d6601340de"><td class="mdescLeft"> </td><td class="mdescRight">Make the |child| to be the "active" one. <br /></td></tr>
|
||
<tr class="separator:ga8cbf27680c6154e15c8b32d6601340de"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga50ad32ad14dd7912e681fab0ee294be2" id="r_ga50ad32ad14dd7912e681fab0ee294be2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga50ad32ad14dd7912e681fab0ee294be2">SetActiveChild</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child)</td></tr>
|
||
<tr class="memdesc:ga50ad32ad14dd7912e681fab0ee294be2"><td class="mdescLeft"> </td><td class="mdescRight">Make the |child| to be the "active" one. <br /></td></tr>
|
||
<tr class="separator:ga50ad32ad14dd7912e681fab0ee294be2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2cf27e9d7128a6a4b3263ecd34c19105" id="r_ga2cf27e9d7128a6a4b3263ecd34c19105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2cf27e9d7128a6a4b3263ecd34c19105">TakeFocus</a> ()</td></tr>
|
||
<tr class="memdesc:ga2cf27e9d7128a6a4b3263ecd34c19105"><td class="mdescLeft"> </td><td class="mdescRight">Configure all the ancestors to give focus to this component. <br /></td></tr>
|
||
<tr class="separator:ga2cf27e9d7128a6a4b3263ecd34c19105"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Protected Member Functions</h3></td></tr>
|
||
<tr class="memitem:ga164d10a2cf367bdd4ae14318a6c7d769" id="r_ga164d10a2cf367bdd4ae14318a6c7d769"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga164d10a2cf367bdd4ae14318a6c7d769">CaptureMouse</a> (const <a class="el" href="structftxui_1_1Event.html">Event</a> &event)</td></tr>
|
||
<tr class="memdesc:ga164d10a2cf367bdd4ae14318a6c7d769"><td class="mdescLeft"> </td><td class="mdescRight">Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. <br /></td></tr>
|
||
<tr class="separator:ga164d10a2cf367bdd4ae14318a6c7d769"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Protected Attributes</h3></td></tr>
|
||
<tr class="memitem:a22b4fa4d6aa4c9c2eef275cd25aa8ab9" id="r_a22b4fa4d6aa4c9c2eef275cd25aa8ab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a></td></tr>
|
||
<tr class="separator:a22b4fa4d6aa4c9c2eef275cd25aa8ab9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Constructor & Destructor Documentation</h4>
|
||
<a id="ad2a5b6ce11bc7a8ce1150cf0ba9144c0" name="ad2a5b6ce11bc7a8ce1150cf0ba9144c0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad2a5b6ce11bc7a8ce1150cf0ba9144c0">◆ </a></span>ComponentBase() <span class="overload">[1/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00032">32</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae490d465a018a9d81bb4e30604708fba" name="ae490d465a018a9d81bb4e30604708fba"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae490d465a018a9d81bb4e30604708fba">◆ </a></span>~ComponentBase()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">~<a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00031">31</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="acda4c8b63ffbc2e9e2e28f056edbf01c" name="acda4c8b63ffbc2e9e2e28f056edbf01c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#acda4c8b63ffbc2e9e2e28f056edbf01c">◆ </a></span>ComponentBase() <span class="overload">[2/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abd8cf6a9df5eb4678fb9925b686c7aea" name="abd8cf6a9df5eb4678fb9925b686c7aea"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abd8cf6a9df5eb4678fb9925b686c7aea">◆ </a></span>ComponentBase() <span class="overload">[3/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const <a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9b3cf357cf150023641969d5fcb7d08f" name="a9b3cf357cf150023641969d5fcb7d08f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9b3cf357cf150023641969d5fcb7d08f">◆ </a></span>ComponentBase() <span class="overload">[4/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<h4 class="groupheader">Member Function Documentation</h4>
|
||
<a id="ac444ac233dcbd4b2ad7972d2086ecc73" name="ac444ac233dcbd4b2ad7972d2086ecc73"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac444ac233dcbd4b2ad7972d2086ecc73">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> & operator= </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const <a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9e3b99c8fc32f2ce151e2ba737c0d546" name="a9e3b99c8fc32f2ce151e2ba737c0d546"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9e3b99c8fc32f2ce151e2ba737c0d546">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> & operator= </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a22b4fa4d6aa4c9c2eef275cd25aa8ab9" name="a22b4fa4d6aa4c9c2eef275cd25aa8ab9"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">◆ </a></span>children_</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children_</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00096">96</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1AnimatedColorOption" id="structftxui_1_1AnimatedColorOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1AnimatedColorOption">◆ </a></span>ftxui::AnimatedColorOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::AnimatedColorOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option about a potentially animated color. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00055">55</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:gad186d5a36e45174bbc7c50df85c2e91e" id="r_gad186d5a36e45174bbc7c50df85c2e91e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad186d5a36e45174bbc7c50df85c2e91e">Set</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> <a class="el" href="#a898e4eb6c2a93ea3b71fc373f39854eb">inactive</a>, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> <a class="el" href="#a5c04e41d802330270ae14a9861c1e2df">active</a>, <a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> <a class="el" href="#a7449575119a6168a323351fb04a7eb64">duration</a>=std::chrono::milliseconds(250), <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> <a class="el" href="#a23a21de13ab9c6644225966245df3fe3">function</a>=animation::easing::QuadraticInOut)</td></tr>
|
||
<tr class="memdesc:gad186d5a36e45174bbc7c50df85c2e91e"><td class="mdescLeft"> </td><td class="mdescRight">A color option that can be animated. @params _inactive The color when the component is inactive. @params _active The color when the component is active. @params _duration The duration of the animation. @params _function The easing function of the animation. <br /></td></tr>
|
||
<tr class="separator:gad186d5a36e45174bbc7c50df85c2e91e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:a8740ba80e30dd75e71d09fa1dcf04f3d" id="r_a8740ba80e30dd75e71d09fa1dcf04f3d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8740ba80e30dd75e71d09fa1dcf04f3d">enabled</a> = false</td></tr>
|
||
<tr class="separator:a8740ba80e30dd75e71d09fa1dcf04f3d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a898e4eb6c2a93ea3b71fc373f39854eb" id="r_a898e4eb6c2a93ea3b71fc373f39854eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a898e4eb6c2a93ea3b71fc373f39854eb">inactive</a></td></tr>
|
||
<tr class="separator:a898e4eb6c2a93ea3b71fc373f39854eb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5c04e41d802330270ae14a9861c1e2df" id="r_a5c04e41d802330270ae14a9861c1e2df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c04e41d802330270ae14a9861c1e2df">active</a></td></tr>
|
||
<tr class="separator:a5c04e41d802330270ae14a9861c1e2df"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a7449575119a6168a323351fb04a7eb64" id="r_a7449575119a6168a323351fb04a7eb64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7449575119a6168a323351fb04a7eb64">duration</a> = std::chrono::milliseconds(250)</td></tr>
|
||
<tr class="separator:a7449575119a6168a323351fb04a7eb64"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a23a21de13ab9c6644225966245df3fe3" id="r_a23a21de13ab9c6644225966245df3fe3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a23a21de13ab9c6644225966245df3fe3">function</a> = animation::easing::QuadraticInOut</td></tr>
|
||
<tr class="separator:a23a21de13ab9c6644225966245df3fe3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a8740ba80e30dd75e71d09fa1dcf04f3d" name="a8740ba80e30dd75e71d09fa1dcf04f3d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a8740ba80e30dd75e71d09fa1dcf04f3d">◆ </a></span>enabled</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool enabled = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00062">62</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a898e4eb6c2a93ea3b71fc373f39854eb" name="a898e4eb6c2a93ea3b71fc373f39854eb"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a898e4eb6c2a93ea3b71fc373f39854eb">◆ </a></span>inactive</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> inactive</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00063">63</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5c04e41d802330270ae14a9861c1e2df" name="a5c04e41d802330270ae14a9861c1e2df"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5c04e41d802330270ae14a9861c1e2df">◆ </a></span>active</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> active</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00064">64</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a7449575119a6168a323351fb04a7eb64" name="a7449575119a6168a323351fb04a7eb64"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7449575119a6168a323351fb04a7eb64">◆ </a></span>duration</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> duration = std::chrono::milliseconds(250)</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00065">65</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a23a21de13ab9c6644225966245df3fe3" name="a23a21de13ab9c6644225966245df3fe3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a23a21de13ab9c6644225966245df3fe3">◆ </a></span>function</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> function = animation::easing::QuadraticInOut</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00066">66</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1MenuEntryOption" id="structftxui_1_1MenuEntryOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1MenuEntryOption">◆ </a></span>ftxui::MenuEntryOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::MenuEntryOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the MenuEntry component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00076">76</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:a336758144ce2b1095f2a0ef062551f5b" id="r_a336758144ce2b1095f2a0ef062551f5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a336758144ce2b1095f2a0ef062551f5b">label</a> = "MenuEntry"</td></tr>
|
||
<tr class="separator:a336758144ce2b1095f2a0ef062551f5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5641c45021a8cc20bdd21498563825a0" id="r_a5641c45021a8cc20bdd21498563825a0"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a> &state)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5641c45021a8cc20bdd21498563825a0">transform</a></td></tr>
|
||
<tr class="separator:a5641c45021a8cc20bdd21498563825a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab7131557fbe84a6b4b2f2ffcff7d44f0" id="r_ab7131557fbe84a6b4b2f2ffcff7d44f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1AnimatedColorsOption.html">AnimatedColorsOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab7131557fbe84a6b4b2f2ffcff7d44f0">animated_colors</a></td></tr>
|
||
<tr class="separator:ab7131557fbe84a6b4b2f2ffcff7d44f0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a336758144ce2b1095f2a0ef062551f5b" name="a336758144ce2b1095f2a0ef062551f5b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a336758144ce2b1095f2a0ef062551f5b">◆ </a></span>label</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label = "MenuEntry"</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00077">77</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5641c45021a8cc20bdd21498563825a0" name="a5641c45021a8cc20bdd21498563825a0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5641c45021a8cc20bdd21498563825a0">◆ </a></span>transform</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a>& state)> transform</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00078">78</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab7131557fbe84a6b4b2f2ffcff7d44f0" name="ab7131557fbe84a6b4b2f2ffcff7d44f0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab7131557fbe84a6b4b2f2ffcff7d44f0">◆ </a></span>animated_colors</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1AnimatedColorsOption.html">AnimatedColorsOption</a> animated_colors</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00079">79</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1MenuOption" id="structftxui_1_1MenuOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1MenuOption">◆ </a></span>ftxui::MenuOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::MenuOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the Menu component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00084">84</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Static Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:ga5ee36f528383cc1db765fa2140797837" id="r_ga5ee36f528383cc1db765fa2140797837"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5ee36f528383cc1db765fa2140797837">Horizontal</a> ()</td></tr>
|
||
<tr class="memdesc:ga5ee36f528383cc1db765fa2140797837"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a horizontal menu. This can be useful to implement a tab bar. <br /></td></tr>
|
||
<tr class="separator:ga5ee36f528383cc1db765fa2140797837"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gaedc93fba91339d9713812821cb140c50" id="r_gaedc93fba91339d9713812821cb140c50"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaedc93fba91339d9713812821cb140c50">HorizontalAnimated</a> ()</td></tr>
|
||
<tr class="memdesc:gaedc93fba91339d9713812821cb140c50"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an animated horizontal menu. This can be useful to implement a tab bar. <br /></td></tr>
|
||
<tr class="separator:gaedc93fba91339d9713812821cb140c50"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga617c59fdb94db99100d0e7a569c31d75" id="r_ga617c59fdb94db99100d0e7a569c31d75"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga617c59fdb94db99100d0e7a569c31d75">Vertical</a> ()</td></tr>
|
||
<tr class="memdesc:ga617c59fdb94db99100d0e7a569c31d75"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a vertical menu. This can be useful to implement a list of selectable items. <br /></td></tr>
|
||
<tr class="separator:ga617c59fdb94db99100d0e7a569c31d75"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga6079a7637256d70b30aacb92d2034205" id="r_ga6079a7637256d70b30aacb92d2034205"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6079a7637256d70b30aacb92d2034205">VerticalAnimated</a> ()</td></tr>
|
||
<tr class="memdesc:ga6079a7637256d70b30aacb92d2034205"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an animated vertical menu. This can be useful to implement a list of selectable items. <br /></td></tr>
|
||
<tr class="separator:ga6079a7637256d70b30aacb92d2034205"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga133a8caaf0246db0902f7abce37a9b6d" id="r_ga133a8caaf0246db0902f7abce37a9b6d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga133a8caaf0246db0902f7abce37a9b6d">Toggle</a> ()</td></tr>
|
||
<tr class="memdesc:ga133a8caaf0246db0902f7abce37a9b6d"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a horizontal menu with some separator. This can be useful to implement a tab bar. <br /></td></tr>
|
||
<tr class="separator:ga133a8caaf0246db0902f7abce37a9b6d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:a7b534b117dbbe826d34ba17af85f1e93" id="r_a7b534b117dbbe826d34ba17af85f1e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b534b117dbbe826d34ba17af85f1e93">entries</a></td></tr>
|
||
<tr class="separator:a7b534b117dbbe826d34ba17af85f1e93"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac42a32c3439d08be9c5626a5fbc3a0c4" id="r_ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac42a32c3439d08be9c5626a5fbc3a0c4">selected</a> = 0</td></tr>
|
||
<tr class="separator:ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a55b558727e02acce3f5259811b2dfe5b" id="r_a55b558727e02acce3f5259811b2dfe5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1UnderlineOption.html">UnderlineOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a55b558727e02acce3f5259811b2dfe5b">underline</a></td></tr>
|
||
<tr class="separator:a55b558727e02acce3f5259811b2dfe5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2076e7253c5acce2321c067e9b7a1823" id="r_a2076e7253c5acce2321c067e9b7a1823"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2076e7253c5acce2321c067e9b7a1823">entries_option</a></td></tr>
|
||
<tr class="separator:a2076e7253c5acce2321c067e9b7a1823"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a53421c695d00016ab925777d423b4eb6" id="r_a53421c695d00016ab925777d423b4eb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a53421c695d00016ab925777d423b4eb6">direction</a> = <a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aaa08a38277b0309070706f6652eeae9a53">Direction::Down</a></td></tr>
|
||
<tr class="separator:a53421c695d00016ab925777d423b4eb6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a11476ea3dc58bf17777879693fb2985a" id="r_a11476ea3dc58bf17777879693fb2985a"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a11476ea3dc58bf17777879693fb2985a">elements_prefix</a></td></tr>
|
||
<tr class="separator:a11476ea3dc58bf17777879693fb2985a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9504d8d3bfa1daaab000e5455536b20d" id="r_a9504d8d3bfa1daaab000e5455536b20d"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9504d8d3bfa1daaab000e5455536b20d">elements_infix</a></td></tr>
|
||
<tr class="separator:a9504d8d3bfa1daaab000e5455536b20d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab08362a5698543aec0fbb37f99777119" id="r_ab08362a5698543aec0fbb37f99777119"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab08362a5698543aec0fbb37f99777119">elements_postfix</a></td></tr>
|
||
<tr class="separator:ab08362a5698543aec0fbb37f99777119"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a></td></tr>
|
||
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a4ba9530701be07334a17c0184747c535" id="r_a4ba9530701be07334a17c0184747c535"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ba9530701be07334a17c0184747c535">on_enter</a></td></tr>
|
||
<tr class="separator:a4ba9530701be07334a17c0184747c535"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a93d5d37708b77971a666b73486017835" id="r_a93d5d37708b77971a666b73486017835"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a93d5d37708b77971a666b73486017835">focused_entry</a> = 0</td></tr>
|
||
<tr class="separator:a93d5d37708b77971a666b73486017835"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a7b534b117dbbe826d34ba17af85f1e93" name="a7b534b117dbbe826d34ba17af85f1e93"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7b534b117dbbe826d34ba17af85f1e93">◆ </a></span>entries</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00092">92</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac42a32c3439d08be9c5626a5fbc3a0c4" name="ac42a32c3439d08be9c5626a5fbc3a0c4"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac42a32c3439d08be9c5626a5fbc3a0c4">◆ </a></span>selected</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> selected = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<blockquote class="doxtable">
|
||
<p>‍The list of entries. </p>
|
||
</blockquote>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00093">93</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a55b558727e02acce3f5259811b2dfe5b" name="a55b558727e02acce3f5259811b2dfe5b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a55b558727e02acce3f5259811b2dfe5b">◆ </a></span>underline</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1UnderlineOption.html">UnderlineOption</a> underline</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<blockquote class="doxtable">
|
||
<p>‍The index of the selected entry. </p>
|
||
</blockquote>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00096">96</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a2076e7253c5acce2321c067e9b7a1823" name="a2076e7253c5acce2321c067e9b7a1823"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2076e7253c5acce2321c067e9b7a1823">◆ </a></span>entries_option</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a> entries_option</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00097">97</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a53421c695d00016ab925777d423b4eb6" name="a53421c695d00016ab925777d423b4eb6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a53421c695d00016ab925777d423b4eb6">◆ </a></span>direction</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> direction = <a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aaa08a38277b0309070706f6652eeae9a53">Direction::Down</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00098">98</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a11476ea3dc58bf17777879693fb2985a" name="a11476ea3dc58bf17777879693fb2985a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a11476ea3dc58bf17777879693fb2985a">◆ </a></span>elements_prefix</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> elements_prefix</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00099">99</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9504d8d3bfa1daaab000e5455536b20d" name="a9504d8d3bfa1daaab000e5455536b20d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9504d8d3bfa1daaab000e5455536b20d">◆ </a></span>elements_infix</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> elements_infix</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00100">100</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab08362a5698543aec0fbb37f99777119" name="ab08362a5698543aec0fbb37f99777119"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab08362a5698543aec0fbb37f99777119">◆ </a></span>elements_postfix</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> elements_postfix</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00101">101</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abdfe3c83deeec2323ff90248815b8f0a" name="abdfe3c83deeec2323ff90248815b8f0a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abdfe3c83deeec2323ff90248815b8f0a">◆ </a></span>on_change</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_change</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00104">104</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a4ba9530701be07334a17c0184747c535" name="a4ba9530701be07334a17c0184747c535"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a4ba9530701be07334a17c0184747c535">◆ </a></span>on_enter</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_enter</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<blockquote class="doxtable">
|
||
<p>‍Called when the selected entry changes. </p>
|
||
</blockquote>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00105">105</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a93d5d37708b77971a666b73486017835" name="a93d5d37708b77971a666b73486017835"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a93d5d37708b77971a666b73486017835">◆ </a></span>focused_entry</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> focused_entry = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<blockquote class="doxtable">
|
||
<p>‍Called when the user presses enter. </p>
|
||
</blockquote>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00106">106</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1ButtonOption" id="structftxui_1_1ButtonOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1ButtonOption">◆ </a></span>ftxui::ButtonOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::ButtonOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the AnimatedButton component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00111">111</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Static Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:ga66e244b326f3cdc7b80ea836c391c34b" id="r_ga66e244b326f3cdc7b80ea836c391c34b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga66e244b326f3cdc7b80ea836c391c34b">Ascii</a> ()</td></tr>
|
||
<tr class="memdesc:ga66e244b326f3cdc7b80ea836c391c34b"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, highlighted using [] characters. <br /></td></tr>
|
||
<tr class="separator:ga66e244b326f3cdc7b80ea836c391c34b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga553fe18f102e8e62aec516d4d3213eac" id="r_ga553fe18f102e8e62aec516d4d3213eac"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga553fe18f102e8e62aec516d4d3213eac">Simple</a> ()</td></tr>
|
||
<tr class="memdesc:ga553fe18f102e8e62aec516d4d3213eac"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, inverted when focused. <br /></td></tr>
|
||
<tr class="separator:ga553fe18f102e8e62aec516d4d3213eac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga2f8ead79a770376a36e9b9b7fa6bc966" id="r_ga2f8ead79a770376a36e9b9b7fa6bc966"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2f8ead79a770376a36e9b9b7fa6bc966">Border</a> ()</td></tr>
|
||
<tr class="memdesc:ga2f8ead79a770376a36e9b9b7fa6bc966"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>. The button is shown using a border, inverted when focused. This is the current default. <br /></td></tr>
|
||
<tr class="separator:ga2f8ead79a770376a36e9b9b7fa6bc966"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga008018822835ed0f3758af3c6e72837d" id="r_ga008018822835ed0f3758af3c6e72837d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga008018822835ed0f3758af3c6e72837d">Animated</a> ()</td></tr>
|
||
<tr class="memdesc:ga008018822835ed0f3758af3c6e72837d"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:ga008018822835ed0f3758af3c6e72837d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga1a78fe7bb802251805a3867ba1a31e15" id="r_ga1a78fe7bb802251805a3867ba1a31e15"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1a78fe7bb802251805a3867ba1a31e15">Animated</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> color)</td></tr>
|
||
<tr class="memdesc:ga1a78fe7bb802251805a3867ba1a31e15"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:ga1a78fe7bb802251805a3867ba1a31e15"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga0295430ca4a317b0cbba9ee5faa4a324" id="r_ga0295430ca4a317b0cbba9ee5faa4a324"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0295430ca4a317b0cbba9ee5faa4a324">Animated</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> background, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> foreground)</td></tr>
|
||
<tr class="memdesc:ga0295430ca4a317b0cbba9ee5faa4a324"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:ga0295430ca4a317b0cbba9ee5faa4a324"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:gadf705e582d884e89211b540a97f2e090" id="r_gadf705e582d884e89211b540a97f2e090"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadf705e582d884e89211b540a97f2e090">Animated</a> (<a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> background, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> foreground, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> background_active, <a class="el" href="group__screen.html#classftxui_1_1Color">Color</a> foreground_active)</td></tr>
|
||
<tr class="memdesc:gadf705e582d884e89211b540a97f2e090"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. <br /></td></tr>
|
||
<tr class="separator:gadf705e582d884e89211b540a97f2e090"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:a336758144ce2b1095f2a0ef062551f5b" id="r_a336758144ce2b1095f2a0ef062551f5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a336758144ce2b1095f2a0ef062551f5b">label</a> = "Button"</td></tr>
|
||
<tr class="separator:a336758144ce2b1095f2a0ef062551f5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0ae001950b0ed23752b298963cecf3d1" id="r_a0ae001950b0ed23752b298963cecf3d1"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ae001950b0ed23752b298963cecf3d1">on_click</a> = [] {}</td></tr>
|
||
<tr class="separator:a0ae001950b0ed23752b298963cecf3d1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:afe14c161494dad905597e75661c7b6a0" id="r_afe14c161494dad905597e75661c7b6a0"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afe14c161494dad905597e75661c7b6a0">transform</a></td></tr>
|
||
<tr class="separator:afe14c161494dad905597e75661c7b6a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab7131557fbe84a6b4b2f2ffcff7d44f0" id="r_ab7131557fbe84a6b4b2f2ffcff7d44f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1AnimatedColorsOption.html">AnimatedColorsOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab7131557fbe84a6b4b2f2ffcff7d44f0">animated_colors</a></td></tr>
|
||
<tr class="separator:ab7131557fbe84a6b4b2f2ffcff7d44f0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a336758144ce2b1095f2a0ef062551f5b" name="a336758144ce2b1095f2a0ef062551f5b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a336758144ce2b1095f2a0ef062551f5b">◆ </a></span>label</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label = "Button"</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00124">124</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0ae001950b0ed23752b298963cecf3d1" name="a0ae001950b0ed23752b298963cecf3d1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0ae001950b0ed23752b298963cecf3d1">◆ </a></span>on_click</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_click = [] {}</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00125">125</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="afe14c161494dad905597e75661c7b6a0" name="afe14c161494dad905597e75661c7b6a0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afe14c161494dad905597e75661c7b6a0">◆ </a></span>transform</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a>&)> transform</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00128">128</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab7131557fbe84a6b4b2f2ffcff7d44f0" name="ab7131557fbe84a6b4b2f2ffcff7d44f0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab7131557fbe84a6b4b2f2ffcff7d44f0">◆ </a></span>animated_colors</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1AnimatedColorsOption.html">AnimatedColorsOption</a> animated_colors</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00129">129</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1CheckboxOption" id="structftxui_1_1CheckboxOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1CheckboxOption">◆ </a></span>ftxui::CheckboxOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::CheckboxOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the Checkbox component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00134">134</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Static Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:ga41b17a916980353033366c01b15d3cb1" id="r_ga41b17a916980353033366c01b15d3cb1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga41b17a916980353033366c01b15d3cb1">Simple</a> ()</td></tr>
|
||
<tr class="memdesc:ga41b17a916980353033366c01b15d3cb1"><td class="mdescLeft"> </td><td class="mdescRight">Option for standard Checkbox. <br /></td></tr>
|
||
<tr class="separator:ga41b17a916980353033366c01b15d3cb1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:a336758144ce2b1095f2a0ef062551f5b" id="r_a336758144ce2b1095f2a0ef062551f5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a336758144ce2b1095f2a0ef062551f5b">label</a> = "Checkbox"</td></tr>
|
||
<tr class="separator:a336758144ce2b1095f2a0ef062551f5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab7741e52624c0d7906159d77edffe27e" id="r_ab7741e52624c0d7906159d77edffe27e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab7741e52624c0d7906159d77edffe27e">checked</a> = false</td></tr>
|
||
<tr class="separator:ab7741e52624c0d7906159d77edffe27e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:afe14c161494dad905597e75661c7b6a0" id="r_afe14c161494dad905597e75661c7b6a0"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afe14c161494dad905597e75661c7b6a0">transform</a></td></tr>
|
||
<tr class="separator:afe14c161494dad905597e75661c7b6a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a> = [] {}</td></tr>
|
||
<tr class="memdesc:abdfe3c83deeec2323ff90248815b8f0a"><td class="mdescLeft"> </td><td class="mdescRight">Called when the user change the state. <br /></td></tr>
|
||
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a336758144ce2b1095f2a0ef062551f5b" name="a336758144ce2b1095f2a0ef062551f5b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a336758144ce2b1095f2a0ef062551f5b">◆ </a></span>label</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label = "Checkbox"</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00138">138</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab7741e52624c0d7906159d77edffe27e" name="ab7741e52624c0d7906159d77edffe27e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab7741e52624c0d7906159d77edffe27e">◆ </a></span>checked</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> checked = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00140">140</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="afe14c161494dad905597e75661c7b6a0" name="afe14c161494dad905597e75661c7b6a0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afe14c161494dad905597e75661c7b6a0">◆ </a></span>transform</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a>&)> transform</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00143">143</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abdfe3c83deeec2323ff90248815b8f0a" name="abdfe3c83deeec2323ff90248815b8f0a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abdfe3c83deeec2323ff90248815b8f0a">◆ </a></span>on_change</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_change = [] {}</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Called when the user change the state. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00147">147</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1InputOption" id="structftxui_1_1InputOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1InputOption">◆ </a></span>ftxui::InputOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::InputOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the Input component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00161">161</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Static Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:ga2108670f055ede2fdc4993f6ffc8ff07" id="r_ga2108670f055ede2fdc4993f6ffc8ff07"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1InputOption">InputOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2108670f055ede2fdc4993f6ffc8ff07">Default</a> ()</td></tr>
|
||
<tr class="memdesc:ga2108670f055ede2fdc4993f6ffc8ff07"><td class="mdescLeft"> </td><td class="mdescRight">Create the default input style: <br /></td></tr>
|
||
<tr class="separator:ga2108670f055ede2fdc4993f6ffc8ff07"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ga36c56131167eaaae707f64bbb9d07ef2" id="r_ga36c56131167eaaae707f64bbb9d07ef2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1InputOption">InputOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga36c56131167eaaae707f64bbb9d07ef2">Spacious</a> ()</td></tr>
|
||
<tr class="memdesc:ga36c56131167eaaae707f64bbb9d07ef2"><td class="mdescLeft"> </td><td class="mdescRight">A white on black style with high margins: <br /></td></tr>
|
||
<tr class="separator:ga36c56131167eaaae707f64bbb9d07ef2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:ac9f6c2acd72d74eeb3a18baf32b02932" id="r_ac9f6c2acd72d74eeb3a18baf32b02932"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9f6c2acd72d74eeb3a18baf32b02932">content</a> = ""</td></tr>
|
||
<tr class="memdesc:ac9f6c2acd72d74eeb3a18baf32b02932"><td class="mdescLeft"> </td><td class="mdescRight">The content of the input. <br /></td></tr>
|
||
<tr class="separator:ac9f6c2acd72d74eeb3a18baf32b02932"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aaca8e18f9fe70089d8fd4165f4b518e1" id="r_aaca8e18f9fe70089d8fd4165f4b518e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaca8e18f9fe70089d8fd4165f4b518e1">placeholder</a> = ""</td></tr>
|
||
<tr class="memdesc:aaca8e18f9fe70089d8fd4165f4b518e1"><td class="mdescLeft"> </td><td class="mdescRight">The content of the input when it's empty. <br /></td></tr>
|
||
<tr class="separator:aaca8e18f9fe70089d8fd4165f4b518e1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a93721d00aaf44f42cc0399024514b628" id="r_a93721d00aaf44f42cc0399024514b628"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="el" href="structftxui_1_1InputState.html">InputState</a>)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a93721d00aaf44f42cc0399024514b628">transform</a></td></tr>
|
||
<tr class="separator:a93721d00aaf44f42cc0399024514b628"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a927bd46792ffe38c7545a764d847d066" id="r_a927bd46792ffe38c7545a764d847d066"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a927bd46792ffe38c7545a764d847d066">password</a> = false</td></tr>
|
||
<tr class="memdesc:a927bd46792ffe38c7545a764d847d066"><td class="mdescLeft"> </td><td class="mdescRight">Obscure the input content using '*'. <br /></td></tr>
|
||
<tr class="separator:a927bd46792ffe38c7545a764d847d066"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af18b2db29029e23c13a8bfc233c62878" id="r_af18b2db29029e23c13a8bfc233c62878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#af18b2db29029e23c13a8bfc233c62878">multiline</a> = true</td></tr>
|
||
<tr class="memdesc:af18b2db29029e23c13a8bfc233c62878"><td class="mdescLeft"> </td><td class="mdescRight">Whether the input can be multiline. <br /></td></tr>
|
||
<tr class="separator:af18b2db29029e23c13a8bfc233c62878"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3ae35fa7cff9f950b9c66536523c69c1" id="r_a3ae35fa7cff9f950b9c66536523c69c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3ae35fa7cff9f950b9c66536523c69c1">insert</a> = true</td></tr>
|
||
<tr class="memdesc:a3ae35fa7cff9f950b9c66536523c69c1"><td class="mdescLeft"> </td><td class="mdescRight">Insert or overtype character mode. <br /></td></tr>
|
||
<tr class="separator:a3ae35fa7cff9f950b9c66536523c69c1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a> = [] {}</td></tr>
|
||
<tr class="memdesc:abdfe3c83deeec2323ff90248815b8f0a"><td class="mdescLeft"> </td><td class="mdescRight">Called when the content changes. <br /></td></tr>
|
||
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a4ba9530701be07334a17c0184747c535" id="r_a4ba9530701be07334a17c0184747c535"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ba9530701be07334a17c0184747c535">on_enter</a> = [] {}</td></tr>
|
||
<tr class="memdesc:a4ba9530701be07334a17c0184747c535"><td class="mdescLeft"> </td><td class="mdescRight">Called when the user presses enter. <br /></td></tr>
|
||
<tr class="separator:a4ba9530701be07334a17c0184747c535"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a699547942204afa70864e0e6df94c96c" id="r_a699547942204afa70864e0e6df94c96c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a699547942204afa70864e0e6df94c96c">cursor_position</a> = 0</td></tr>
|
||
<tr class="separator:a699547942204afa70864e0e6df94c96c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="ac9f6c2acd72d74eeb3a18baf32b02932" name="ac9f6c2acd72d74eeb3a18baf32b02932"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac9f6c2acd72d74eeb3a18baf32b02932">◆ </a></span>content</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> content = ""</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>The content of the input. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00170">170</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aaca8e18f9fe70089d8fd4165f4b518e1" name="aaca8e18f9fe70089d8fd4165f4b518e1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aaca8e18f9fe70089d8fd4165f4b518e1">◆ </a></span>placeholder</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> placeholder = ""</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>The content of the input when it's empty. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00173">173</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a93721d00aaf44f42cc0399024514b628" name="a93721d00aaf44f42cc0399024514b628"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a93721d00aaf44f42cc0399024514b628">◆ </a></span>transform</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="el" href="structftxui_1_1InputState.html">InputState</a>)> transform</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00176">176</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a927bd46792ffe38c7545a764d847d066" name="a927bd46792ffe38c7545a764d847d066"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a927bd46792ffe38c7545a764d847d066">◆ </a></span>password</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> password = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Obscure the input content using '*'. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00177">177</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af18b2db29029e23c13a8bfc233c62878" name="af18b2db29029e23c13a8bfc233c62878"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af18b2db29029e23c13a8bfc233c62878">◆ </a></span>multiline</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> multiline = true</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Whether the input can be multiline. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00178">178</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a3ae35fa7cff9f950b9c66536523c69c1" name="a3ae35fa7cff9f950b9c66536523c69c1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a3ae35fa7cff9f950b9c66536523c69c1">◆ </a></span>insert</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> insert = true</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Insert or overtype character mode. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00179">179</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abdfe3c83deeec2323ff90248815b8f0a" name="abdfe3c83deeec2323ff90248815b8f0a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abdfe3c83deeec2323ff90248815b8f0a">◆ </a></span>on_change</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_change = [] {}</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Called when the content changes. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00182">182</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a4ba9530701be07334a17c0184747c535" name="a4ba9530701be07334a17c0184747c535"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a4ba9530701be07334a17c0184747c535">◆ </a></span>on_enter</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_enter = [] {}</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Called when the user presses enter. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00184">184</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a699547942204afa70864e0e6df94c96c" name="a699547942204afa70864e0e6df94c96c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a699547942204afa70864e0e6df94c96c">◆ </a></span>cursor_position</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> cursor_position = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00187">187</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1RadioboxOption" id="structftxui_1_1RadioboxOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1RadioboxOption">◆ </a></span>ftxui::RadioboxOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::RadioboxOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the Radiobox component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00192">192</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Static Public Member Functions</h3></td></tr>
|
||
<tr class="memitem:gaf2b048773665961fae6c104762533908" id="r_gaf2b048773665961fae6c104762533908"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf2b048773665961fae6c104762533908">Simple</a> ()</td></tr>
|
||
<tr class="memdesc:gaf2b048773665961fae6c104762533908"><td class="mdescLeft"> </td><td class="mdescRight">Option for standard Radiobox. <br /></td></tr>
|
||
<tr class="separator:gaf2b048773665961fae6c104762533908"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:a7b534b117dbbe826d34ba17af85f1e93" id="r_a7b534b117dbbe826d34ba17af85f1e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b534b117dbbe826d34ba17af85f1e93">entries</a></td></tr>
|
||
<tr class="separator:a7b534b117dbbe826d34ba17af85f1e93"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac42a32c3439d08be9c5626a5fbc3a0c4" id="r_ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac42a32c3439d08be9c5626a5fbc3a0c4">selected</a> = 0</td></tr>
|
||
<tr class="separator:ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:afe14c161494dad905597e75661c7b6a0" id="r_afe14c161494dad905597e75661c7b6a0"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afe14c161494dad905597e75661c7b6a0">transform</a></td></tr>
|
||
<tr class="separator:afe14c161494dad905597e75661c7b6a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a> = [] {}</td></tr>
|
||
<tr class="memdesc:abdfe3c83deeec2323ff90248815b8f0a"><td class="mdescLeft"> </td><td class="mdescRight">Called when the selected entry changes. <br /></td></tr>
|
||
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a93d5d37708b77971a666b73486017835" id="r_a93d5d37708b77971a666b73486017835"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a93d5d37708b77971a666b73486017835">focused_entry</a> = 0</td></tr>
|
||
<tr class="separator:a93d5d37708b77971a666b73486017835"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="a7b534b117dbbe826d34ba17af85f1e93" name="a7b534b117dbbe826d34ba17af85f1e93"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7b534b117dbbe826d34ba17af85f1e93">◆ </a></span>entries</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00197">197</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac42a32c3439d08be9c5626a5fbc3a0c4" name="ac42a32c3439d08be9c5626a5fbc3a0c4"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac42a32c3439d08be9c5626a5fbc3a0c4">◆ </a></span>selected</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> selected = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00198">198</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="afe14c161494dad905597e75661c7b6a0" name="afe14c161494dad905597e75661c7b6a0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afe14c161494dad905597e75661c7b6a0">◆ </a></span>transform</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a>&)> transform</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00201">201</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abdfe3c83deeec2323ff90248815b8f0a" name="abdfe3c83deeec2323ff90248815b8f0a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abdfe3c83deeec2323ff90248815b8f0a">◆ </a></span>on_change</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<void()> on_change = [] {}</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Called when the selected entry changes. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00205">205</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a93d5d37708b77971a666b73486017835" name="a93d5d37708b77971a666b73486017835"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a93d5d37708b77971a666b73486017835">◆ </a></span>focused_entry</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> focused_entry = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00206">206</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1DropdownOption" id="structftxui_1_1DropdownOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1DropdownOption">◆ </a></span>ftxui::DropdownOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::DropdownOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>Option for the Dropdown component.</p>
|
||
<p>A dropdown menu is a checkbox opening/closing a radiobox. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00269">269</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:aa9ee4f52203c5dec717cf45077b82776" id="r_aa9ee4f52203c5dec717cf45077b82776"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9ee4f52203c5dec717cf45077b82776">open</a> = false</td></tr>
|
||
<tr class="memdesc:aa9ee4f52203c5dec717cf45077b82776"><td class="mdescLeft"> </td><td class="mdescRight">Whether the dropdown is open or closed: <br /></td></tr>
|
||
<tr class="separator:aa9ee4f52203c5dec717cf45077b82776"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0797deb307cd89059137a4ca6075fcbf" id="r_a0797deb307cd89059137a4ca6075fcbf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0797deb307cd89059137a4ca6075fcbf">checkbox</a></td></tr>
|
||
<tr class="separator:a0797deb307cd89059137a4ca6075fcbf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a83288bb2ebb6ca0eef0651285a71291e" id="r_a83288bb2ebb6ca0eef0651285a71291e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a83288bb2ebb6ca0eef0651285a71291e">radiobox</a></td></tr>
|
||
<tr class="separator:a83288bb2ebb6ca0eef0651285a71291e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae2d438a2693c6279aba8a2549a161601" id="r_ae2d438a2693c6279aba8a2549a161601"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(bool <a class="el" href="#aa9ee4f52203c5dec717cf45077b82776">open</a>, <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="el" href="#a0797deb307cd89059137a4ca6075fcbf">checkbox</a>, <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="el" href="#a83288bb2ebb6ca0eef0651285a71291e">radiobox</a>)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2d438a2693c6279aba8a2549a161601">transform</a></td></tr>
|
||
<tr class="separator:ae2d438a2693c6279aba8a2549a161601"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="aa9ee4f52203c5dec717cf45077b82776" name="aa9ee4f52203c5dec717cf45077b82776"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa9ee4f52203c5dec717cf45077b82776">◆ </a></span>open</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> open = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Whether the dropdown is open or closed: </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00271">271</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0797deb307cd89059137a4ca6075fcbf" name="a0797deb307cd89059137a4ca6075fcbf"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0797deb307cd89059137a4ca6075fcbf">◆ </a></span>checkbox</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> checkbox</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00273">273</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a83288bb2ebb6ca0eef0651285a71291e" name="a83288bb2ebb6ca0eef0651285a71291e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a83288bb2ebb6ca0eef0651285a71291e">◆ </a></span>radiobox</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> radiobox</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00275">275</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae2d438a2693c6279aba8a2549a161601" name="ae2d438a2693c6279aba8a2549a161601"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae2d438a2693c6279aba8a2549a161601">◆ </a></span>transform</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(bool <a class="el" href="#aa9ee4f52203c5dec717cf45077b82776">open</a>, <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="el" href="#a0797deb307cd89059137a4ca6075fcbf">checkbox</a>, <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="el" href="#a83288bb2ebb6ca0eef0651285a71291e">radiobox</a>)> transform</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00278">278</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1Mouse" id="structftxui_1_1Mouse"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1Mouse">◆ </a></span>ftxui::Mouse</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::Mouse</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<div class="textblock"><p>A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift, ctrl, meta). </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00011">11</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
</div><table class="memberdecls">
|
||
<tr><td colspan="2"><h3>Public Types</h3></td></tr>
|
||
<tr class="memitem:a03bfec859eac87be20f8952c1eb89de0" id="r_a03bfec859eac87be20f8952c1eb89de0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a03bfec859eac87be20f8952c1eb89de0">Button</a> { <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0a9d4d8b0b72fc2659da772d761a3c5ecb">Left</a> = 0
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0a673e6efef9aafe98078c5552e99c923c">Middle</a> = 1
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0ad48f7af8c070184f3774c8e85854eb66">Right</a> = 2
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0ac9d3e887722f2bc482bcca9d41c512af">None</a> = 3
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0ab51f2e2fc1697565b732263f86a976d6">WheelUp</a> = 4
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0afd8a27c9d7eac3486f6fbd2d608da0db">WheelDown</a> = 5
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0a160e671a76bd0d1f424a8b9700275375">WheelLeft</a> = 6
|
||
, <br />
|
||
  <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0ae73184b2d38af984b5cda75057471adc">WheelRight</a> = 7
|
||
<br />
|
||
}</td></tr>
|
||
<tr class="separator:a03bfec859eac87be20f8952c1eb89de0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a099c889d2b948b264c7a665b66e3a9b6" id="r_a099c889d2b948b264c7a665b66e3a9b6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6">Motion</a> { <br />
|
||
  <a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6ad9417ac74f0134b9577d1d85cf422c25">Released</a> = 0
|
||
, <br />
|
||
  <a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6a05f4abb2322aa023aba9570c327aff25">Pressed</a> = 1
|
||
, <br />
|
||
  <a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6a9bf35ab1cecfbb50d8f1d708a4921fc6">Moved</a> = 2
|
||
<br />
|
||
}</td></tr>
|
||
<tr class="separator:a099c889d2b948b264c7a665b66e3a9b6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr><td colspan="2"><h3>Public Attributes</h3></td></tr>
|
||
<tr class="memitem:aa56e877ca6a7524cf1e891c7435c3ace" id="r_aa56e877ca6a7524cf1e891c7435c3ace"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a03bfec859eac87be20f8952c1eb89de0">Button</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa56e877ca6a7524cf1e891c7435c3ace">button</a> = <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0ac9d3e887722f2bc482bcca9d41c512af">Button::None</a></td></tr>
|
||
<tr class="separator:aa56e877ca6a7524cf1e891c7435c3ace"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af8ec4d0833a67c0bcd400f9e30bd07c7" id="r_af8ec4d0833a67c0bcd400f9e30bd07c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6">Motion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af8ec4d0833a67c0bcd400f9e30bd07c7">motion</a> = <a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6a05f4abb2322aa023aba9570c327aff25">Motion::Pressed</a></td></tr>
|
||
<tr class="separator:af8ec4d0833a67c0bcd400f9e30bd07c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ace78b37abb3d96740735fd8eb41235e6" id="r_ace78b37abb3d96740735fd8eb41235e6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ace78b37abb3d96740735fd8eb41235e6">shift</a> = false</td></tr>
|
||
<tr class="separator:ace78b37abb3d96740735fd8eb41235e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a46e545ef1aafd5ca9f1d6055fcebeeca" id="r_a46e545ef1aafd5ca9f1d6055fcebeeca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a46e545ef1aafd5ca9f1d6055fcebeeca">meta</a> = false</td></tr>
|
||
<tr class="separator:a46e545ef1aafd5ca9f1d6055fcebeeca"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad155fe5a68eb888a7e0eb897a3dfc015" id="r_ad155fe5a68eb888a7e0eb897a3dfc015"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad155fe5a68eb888a7e0eb897a3dfc015">control</a> = false</td></tr>
|
||
<tr class="separator:ad155fe5a68eb888a7e0eb897a3dfc015"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a6150e0515f7202e2fb518f7206ed97dc" id="r_a6150e0515f7202e2fb518f7206ed97dc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6150e0515f7202e2fb518f7206ed97dc">x</a> = 0</td></tr>
|
||
<tr class="separator:a6150e0515f7202e2fb518f7206ed97dc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0a2f84ed7838f07779ae24c5a9086d33" id="r_a0a2f84ed7838f07779ae24c5a9086d33"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0a2f84ed7838f07779ae24c5a9086d33">y</a> = 0</td></tr>
|
||
<tr class="separator:a0a2f84ed7838f07779ae24c5a9086d33"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<h4 class="groupheader">Member Enumeration Documentation</h4>
|
||
<a id="a03bfec859eac87be20f8952c1eb89de0" name="a03bfec859eac87be20f8952c1eb89de0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a03bfec859eac87be20f8952c1eb89de0">◆ </a></span>Button</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">enum <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0">Button</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<table class="fieldtable">
|
||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0a9d4d8b0b72fc2659da772d761a3c5ecb" name="a03bfec859eac87be20f8952c1eb89de0a9d4d8b0b72fc2659da772d761a3c5ecb"></a>Left </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0a673e6efef9aafe98078c5552e99c923c" name="a03bfec859eac87be20f8952c1eb89de0a673e6efef9aafe98078c5552e99c923c"></a>Middle </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0ad48f7af8c070184f3774c8e85854eb66" name="a03bfec859eac87be20f8952c1eb89de0ad48f7af8c070184f3774c8e85854eb66"></a>Right </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0ac9d3e887722f2bc482bcca9d41c512af" name="a03bfec859eac87be20f8952c1eb89de0ac9d3e887722f2bc482bcca9d41c512af"></a>None </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0ab51f2e2fc1697565b732263f86a976d6" name="a03bfec859eac87be20f8952c1eb89de0ab51f2e2fc1697565b732263f86a976d6"></a>WheelUp </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0afd8a27c9d7eac3486f6fbd2d608da0db" name="a03bfec859eac87be20f8952c1eb89de0afd8a27c9d7eac3486f6fbd2d608da0db"></a>WheelDown </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0a160e671a76bd0d1f424a8b9700275375" name="a03bfec859eac87be20f8952c1eb89de0a160e671a76bd0d1f424a8b9700275375"></a>WheelLeft </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a03bfec859eac87be20f8952c1eb89de0ae73184b2d38af984b5cda75057471adc" name="a03bfec859eac87be20f8952c1eb89de0ae73184b2d38af984b5cda75057471adc"></a>WheelRight </td><td class="fielddoc"><p>Supported terminal only. </p>
|
||
</td></tr>
|
||
</table>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00012">12</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a099c889d2b948b264c7a665b66e3a9b6" name="a099c889d2b948b264c7a665b66e3a9b6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a099c889d2b948b264c7a665b66e3a9b6">◆ </a></span>Motion</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">enum <a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6">Motion</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<table class="fieldtable">
|
||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a099c889d2b948b264c7a665b66e3a9b6ad9417ac74f0134b9577d1d85cf422c25" name="a099c889d2b948b264c7a665b66e3a9b6ad9417ac74f0134b9577d1d85cf422c25"></a>Released </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a099c889d2b948b264c7a665b66e3a9b6a05f4abb2322aa023aba9570c327aff25" name="a099c889d2b948b264c7a665b66e3a9b6a05f4abb2322aa023aba9570c327aff25"></a>Pressed </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a099c889d2b948b264c7a665b66e3a9b6a9bf35ab1cecfbb50d8f1d708a4921fc6" name="a099c889d2b948b264c7a665b66e3a9b6a9bf35ab1cecfbb50d8f1d708a4921fc6"></a>Moved </td><td class="fielddoc"></td></tr>
|
||
</table>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00023">23</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h4 class="groupheader">Member Data Documentation</h4>
|
||
<a id="aa56e877ca6a7524cf1e891c7435c3ace" name="aa56e877ca6a7524cf1e891c7435c3ace"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa56e877ca6a7524cf1e891c7435c3ace">◆ </a></span>button</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a03bfec859eac87be20f8952c1eb89de0">Button</a> button = <a class="el" href="#a03bfec859eac87be20f8952c1eb89de0ac9d3e887722f2bc482bcca9d41c512af">Button::None</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00030">30</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af8ec4d0833a67c0bcd400f9e30bd07c7" name="af8ec4d0833a67c0bcd400f9e30bd07c7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af8ec4d0833a67c0bcd400f9e30bd07c7">◆ </a></span>motion</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6">Motion</a> motion = <a class="el" href="#a099c889d2b948b264c7a665b66e3a9b6a05f4abb2322aa023aba9570c327aff25">Motion::Pressed</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00033">33</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ace78b37abb3d96740735fd8eb41235e6" name="ace78b37abb3d96740735fd8eb41235e6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ace78b37abb3d96740735fd8eb41235e6">◆ </a></span>shift</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool shift = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00036">36</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a46e545ef1aafd5ca9f1d6055fcebeeca" name="a46e545ef1aafd5ca9f1d6055fcebeeca"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a46e545ef1aafd5ca9f1d6055fcebeeca">◆ </a></span>meta</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool meta = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00037">37</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad155fe5a68eb888a7e0eb897a3dfc015" name="ad155fe5a68eb888a7e0eb897a3dfc015"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad155fe5a68eb888a7e0eb897a3dfc015">◆ </a></span>control</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool control = false</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00038">38</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a6150e0515f7202e2fb518f7206ed97dc" name="a6150e0515f7202e2fb518f7206ed97dc"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a6150e0515f7202e2fb518f7206ed97dc">◆ </a></span>x</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int x = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00041">41</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0a2f84ed7838f07779ae24c5a9086d33" name="a0a2f84ed7838f07779ae24c5a9086d33"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0a2f84ed7838f07779ae24c5a9086d33">◆ </a></span>y</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int y = 0</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="mouse_8hpp_source.html#l00042">42</a> of file <a class="el" href="mouse_8hpp_source.html">mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Function Documentation</h2>
|
||
<a id="ga4e8295ec77dd31b0acc5063b134473e7" name="ga4e8295ec77dd31b0acc5063b134473e7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga4e8295ec77dd31b0acc5063b134473e7">◆ </a></span>Button() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Button </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a button. Execute a function when clicked. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ButtonBase</dd></dl>
|
||
<h3><a class="anchor" id="example-6"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>({</div>
|
||
<div class="line"> .label = <span class="stringliteral">"Click to quit"</span>,</div>
|
||
<div class="line"> .on_click = screen.ExitLoopClosure(),</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(button)</div>
|
||
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html_a4f458e443ed672c2aea9fdd96531a621"><div class="ttname"><a href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ftxui::ScreenInteractive::FitComponent</a></div><div class="ttdeci">static ScreenInteractive FitComponent()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00416">screen_interactive.cpp:416</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_ga4e8295ec77dd31b0acc5063b134473e7"><div class="ttname"><a href="#ga4e8295ec77dd31b0acc5063b134473e7">ftxui::Button</a></div><div class="ttdeci">Component Button(ButtonOption options)</div><div class="ttdoc">Draw a button. Execute a function when clicked.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2button_8cpp_source.html#l00176">src/ftxui/component/button.cpp:176</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_af1479ede01dbf087342534ab4ada11d3"><div class="ttname"><a href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">ftxui::Component</a></div><div class="ttdeci">std::shared_ptr< ComponentBase > Component</div><div class="ttdef"><b>Definition</b> <a href="component__base_8hpp_source.html#l00024">component_base.hpp:24</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-3"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┌─────────────┐</div>
|
||
<div class="line">│Click to quit│</div>
|
||
<div class="line">└─────────────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2button_8cpp_source.html#l00176">176</a> of file <a class="el" href="src_2ftxui_2component_2button_8cpp_source.html">src/ftxui/component/button.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga0488e28ee9388e0ddca26f1d03d827d1" name="ga0488e28ee9388e0ddca26f1d03d827d1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga0488e28ee9388e0ddca26f1d03d827d1">◆ </a></span>Button() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Button </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< void()></td> <td class="paramname"><span class="paramname"><em>on_click</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a button. Execute a function when clicked. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The label of the button. </td></tr>
|
||
<tr><td class="paramname">on_click</td><td>The action to execute when clicked. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ButtonBase</dd></dl>
|
||
<h3><a class="anchor" id="example-7"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string label = <span class="stringliteral">"Click to quit"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(&label, screen.ExitLoopClosure());</div>
|
||
<div class="line">screen.Loop(button)</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-4"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┌─────────────┐</div>
|
||
<div class="line">│Click to quit│</div>
|
||
<div class="line">└─────────────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2button_8cpp_source.html#l00204">204</a> of file <a class="el" href="src_2ftxui_2component_2button_8cpp_source.html">src/ftxui/component/button.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga0bfd67a2815807dc6fc9bc0f79bce29e" name="ga0bfd67a2815807dc6fc9bc0f79bce29e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga0bfd67a2815807dc6fc9bc0f79bce29e">◆ </a></span>CatchEvent() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> CatchEvent </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a> event)></td> <td class="paramname"><span class="paramname"><em>on_event</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The wrapped component. </td></tr>
|
||
<tr><td class="paramname">on_event</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-1"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] {</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>);</div>
|
||
<div class="line">});</div>
|
||
<div class="line"><span class="keyword">auto</span> component = <a class="code hl_function" href="namespaceftxui.html#afa5872ba3f9889c7487e57e745e56857">CatchEvent</a>(renderer, [&](Event event) {</div>
|
||
<div class="line"> <span class="keywordflow">if</span> (event == Event::Character(<span class="charliteral">'q'</span>)) {</div>
|
||
<div class="line"> screen.ExitLoopClosure()();</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||
<div class="line"> }</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(component);</div>
|
||
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html_a0b7de0467b4e57ce5f337ba8634d8d13"><div class="ttname"><a href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ftxui::ScreenInteractive::TerminalOutput</a></div><div class="ttdeci">static ScreenInteractive TerminalOutput()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00406">screen_interactive.cpp:406</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_ga533e883e2aeea28de2b60564fcaf0361"><div class="ttname"><a href="#ga533e883e2aeea28de2b60564fcaf0361">ftxui::Renderer</a></div><div class="ttdeci">Component Renderer(Component child, std::function< Element()>)</div><div class="ttdoc">Return a new Component, similar to |child|, but using |render| as the Component::Render() event.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2renderer_8cpp_source.html#l00061">src/ftxui/component/renderer.cpp:61</a></div></div>
|
||
<div class="ttc" id="agroup__dom_html_ga75baaa2734ed76a9f478beaafa87ae57"><div class="ttname"><a href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">ftxui::text</a></div><div class="ttdeci">Element text(std::wstring text)</div><div class="ttdoc">Display a piece of unicode text.</div><div class="ttdef"><b>Definition</b> <a href="text_8cpp_source.html#l00160">text.cpp:160</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_afa5872ba3f9889c7487e57e745e56857"><div class="ttname"><a href="namespaceftxui.html#afa5872ba3f9889c7487e57e745e56857">ftxui::CatchEvent</a></div><div class="ttdeci">Component CatchEvent(Component child, std::function< bool(Event)>)</div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="catch__event_8cpp_source.html#l00054">54</a> of file <a class="el" href="catch__event_8cpp_source.html">catch_event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gad2948235799c010c76c6de861c050c59" name="gad2948235799c010c76c6de861c050c59"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gad2948235799c010c76c6de861c050c59">◆ </a></span>CatchEvent() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> CatchEvent </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a>)></td> <td class="paramname"><span class="paramname"><em>on_event</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">on_event</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-2"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello world"</span>); });</div>
|
||
<div class="line">renderer |= <a class="code hl_function" href="namespaceftxui.html#afa5872ba3f9889c7487e57e745e56857">CatchEvent</a>([&](Event event) {</div>
|
||
<div class="line"> <span class="keywordflow">if</span> (event == Event::Character(<span class="charliteral">'q'</span>)) {</div>
|
||
<div class="line"> screen.ExitLoopClosure()();</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
||
<div class="line"> }</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="catch__event_8cpp_source.html#l00080">80</a> of file <a class="el" href="catch__event_8cpp_source.html">catch_event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gae0d441d2c83740f187f62db566bbefcd" name="gae0d441d2c83740f187f62db566bbefcd"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gae0d441d2c83740f187f62db566bbefcd">◆ </a></span>Checkbox() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Checkbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw checkable element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>CheckboxBase</dd></dl>
|
||
<h3><a class="anchor" id="example-3"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line"><a class="code hl_struct" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> option;</div>
|
||
<div class="line">option.<a class="code hl_variable" href="#a336758144ce2b1095f2a0ef062551f5b">label</a> = <span class="stringliteral">"Make a sandwidth"</span>;</div>
|
||
<div class="line">option.<a class="code hl_variable" href="#ab7741e52624c0d7906159d77edffe27e">checked</a> = <span class="keyword">false</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> checkbox = <a class="code hl_function" href="#gae0d441d2c83740f187f62db566bbefcd">Checkbox</a>(option);</div>
|
||
<div class="line">screen.Loop(checkbox)</div>
|
||
<div class="ttc" id="agroup__component_html_a336758144ce2b1095f2a0ef062551f5b"><div class="ttname"><a href="#a336758144ce2b1095f2a0ef062551f5b">ftxui::CheckboxOption::label</a></div><div class="ttdeci">ConstStringRef label</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00138">component_options.hpp:138</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_ab7741e52624c0d7906159d77edffe27e"><div class="ttname"><a href="#ab7741e52624c0d7906159d77edffe27e">ftxui::CheckboxOption::checked</a></div><div class="ttdeci">Ref< bool > checked</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00140">component_options.hpp:140</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_gae0d441d2c83740f187f62db566bbefcd"><div class="ttname"><a href="#gae0d441d2c83740f187f62db566bbefcd">ftxui::Checkbox</a></div><div class="ttdeci">Component Checkbox(CheckboxOption options)</div><div class="ttdoc">Draw checkable element.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2checkbox_8cpp_source.html#l00108">src/ftxui/component/checkbox.cpp:108</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_structftxui_1_1CheckboxOption"><div class="ttname"><a href="#structftxui_1_1CheckboxOption">ftxui::CheckboxOption</a></div><div class="ttdoc">Option for the Checkbox component.</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00134">component_options.hpp:134</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">☐ Make a sandwitch</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2checkbox_8cpp_source.html#l00108">108</a> of file <a class="el" href="src_2ftxui_2component_2checkbox_8cpp_source.html">src/ftxui/component/checkbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga5e9dbb03c44d549f10c96f134269366f" name="ga5e9dbb03c44d549f10c96f134269366f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga5e9dbb03c44d549f10c96f134269366f">◆ </a></span>Checkbox() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Checkbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>checked</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw checkable element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The label of the checkbox. </td></tr>
|
||
<tr><td class="paramname">checked</td><td>Whether the checkbox is checked or not. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>CheckboxBase</dd></dl>
|
||
<h3><a class="anchor" id="example-5"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string label = <span class="stringliteral">"Make a sandwidth"</span>;</div>
|
||
<div class="line"><span class="keywordtype">bool</span> checked = <span class="keyword">false</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> checkbox = <a class="code hl_function" href="#gae0d441d2c83740f187f62db566bbefcd">Checkbox</a>(&label, &checked);</div>
|
||
<div class="line">screen.Loop(checkbox)</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-2"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">☐ Make a sandwitch</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2checkbox_8cpp_source.html#l00135">135</a> of file <a class="el" href="src_2ftxui_2component_2checkbox_8cpp_source.html">src/ftxui/component/checkbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga6471e39f5664d059144746c5801d37e6" name="ga6471e39f5664d059144746c5801d37e6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga6471e39f5664d059144746c5801d37e6">◆ </a></span>Vertical() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Vertical </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>the list of components.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
||
<h3><a class="anchor" id="example-14"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#ga6471e39f5664d059144746c5801d37e6">Container::Vertical</a>({</div>
|
||
<div class="line"> children_1,</div>
|
||
<div class="line"> children_2,</div>
|
||
<div class="line"> children_3,</div>
|
||
<div class="line"> children_4,</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="agroup__component_html_ga6471e39f5664d059144746c5801d37e6"><div class="ttname"><a href="#ga6471e39f5664d059144746c5801d37e6">ftxui::Container::Vertical</a></div><div class="ttdeci">Component Vertical(Components children)</div><div class="ttdoc">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00317">container.cpp:317</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00317">317</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga25099e2d2ead8a46c8d9a899982070b7" name="ga25099e2d2ead8a46c8d9a899982070b7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga25099e2d2ead8a46c8d9a899982070b7">◆ </a></span>Vertical() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Vertical </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selector</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>the list of components. </td></tr>
|
||
<tr><td class="paramname">selector</td><td>A reference to the index of the selected children.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
||
<h3><a class="anchor" id="example-15"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#ga6471e39f5664d059144746c5801d37e6">Container::Vertical</a>({</div>
|
||
<div class="line"> children_1,</div>
|
||
<div class="line"> children_2,</div>
|
||
<div class="line"> children_3,</div>
|
||
<div class="line"> children_4,</div>
|
||
<div class="line">}, &selected_children);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00339">339</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga01563bae9454fe64c0b29b0eb3755e68" name="ga01563bae9454fe64c0b29b0eb3755e68"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga01563bae9454fe64c0b29b0eb3755e68">◆ </a></span>Horizontal() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Horizontal </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>the list of components.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
||
<h3><a class="anchor" id="example-16"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keywordtype">int</span> selected_children = 2;</div>
|
||
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#ga01563bae9454fe64c0b29b0eb3755e68">Container::Horizontal</a>({</div>
|
||
<div class="line"> children_1,</div>
|
||
<div class="line"> children_2,</div>
|
||
<div class="line"> children_3,</div>
|
||
<div class="line"> children_4,</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="agroup__component_html_ga01563bae9454fe64c0b29b0eb3755e68"><div class="ttname"><a href="#ga01563bae9454fe64c0b29b0eb3755e68">ftxui::Container::Horizontal</a></div><div class="ttdeci">Component Horizontal(Components children)</div><div class="ttdoc">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00360">container.cpp:360</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00360">360</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga337564f8a13c98222025d8fe7e47df4c" name="ga337564f8a13c98222025d8fe7e47df4c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga337564f8a13c98222025d8fe7e47df4c">◆ </a></span>Horizontal() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Horizontal </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selector</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>the list of components. </td></tr>
|
||
<tr><td class="paramname">selector</td><td>A reference to the index of the selected children.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
||
<h3><a class="anchor" id="example-17"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keywordtype">int</span> selected_children = 2;</div>
|
||
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#ga01563bae9454fe64c0b29b0eb3755e68">Container::Horizontal</a>({</div>
|
||
<div class="line"> children_1,</div>
|
||
<div class="line"> children_2,</div>
|
||
<div class="line"> children_3,</div>
|
||
<div class="line"> children_4,</div>
|
||
<div class="line">}, selected_children);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00382">382</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaea9fe244eeeb420276bcc5760b46953d" name="gaea9fe244eeeb420276bcc5760b46953d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaea9fe244eeeb420276bcc5760b46953d">◆ </a></span>Tab()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Tab </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selector</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>The list of components. </td></tr>
|
||
<tr><td class="paramname">selector</td><td>The index of the drawn children.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
||
<h3><a class="anchor" id="example-18"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keywordtype">int</span> tab_drawn = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#gaea9fe244eeeb420276bcc5760b46953d">Container::Tab</a>({</div>
|
||
<div class="line"> children_1,</div>
|
||
<div class="line"> children_2,</div>
|
||
<div class="line"> children_3,</div>
|
||
<div class="line"> children_4,</div>
|
||
<div class="line">}, &tab_drawn);</div>
|
||
<div class="ttc" id="agroup__component_html_gaea9fe244eeeb420276bcc5760b46953d"><div class="ttname"><a href="#gaea9fe244eeeb420276bcc5760b46953d">ftxui::Container::Tab</a></div><div class="ttdeci">Component Tab(Components children, int *selector)</div><div class="ttdoc">A list of components, where only one is drawn and interacted with at a time. The |selector| gives the...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00405">container.cpp:405</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00405">405</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaafd394665b0c231380a143b810339d8e" name="gaafd394665b0c231380a143b810339d8e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaafd394665b0c231380a143b810339d8e">◆ </a></span>Stacked()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Stacked </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. </p>
|
||
<p>This should be used with the <code>Window</code> component.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>The list of components.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>Window</dd></dl>
|
||
<h3><a class="anchor" id="example-19"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#gaafd394665b0c231380a143b810339d8e">Container::Stacked</a>({</div>
|
||
<div class="line"> children_1,</div>
|
||
<div class="line"> children_2,</div>
|
||
<div class="line"> children_3,</div>
|
||
<div class="line"> children_4,</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="agroup__component_html_gaafd394665b0c231380a143b810339d8e"><div class="ttname"><a href="#gaafd394665b0c231380a143b810339d8e">ftxui::Container::Stacked</a></div><div class="ttdeci">Component Stacked(Components children)</div><div class="ttdoc">A list of components to be stacked on top of each other. Events are propagated to the first component...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00432">container.cpp:432</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00432">432</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaa22bddff4aeed66e20f30d0715596999" name="gaa22bddff4aeed66e20f30d0715596999"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaa22bddff4aeed66e20f30d0715596999">◆ </a></span>Dropdown() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Dropdown </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A dropdown menu. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of entries to display. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>The index of the selected entry. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2dropdown_8cpp_source.html#l00022">22</a> of file <a class="el" href="src_2ftxui_2component_2dropdown_8cpp_source.html">src/ftxui/component/dropdown.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaa4b353566017558bac648ee1409930de" name="gaa4b353566017558bac648ee1409930de"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaa4b353566017558bac648ee1409930de">◆ </a></span>Dropdown() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Dropdown </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1DropdownOption">DropdownOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A dropdown menu. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>The options for the dropdown. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2dropdown_8cpp_source.html#l00033">33</a> of file <a class="el" href="src_2ftxui_2component_2dropdown_8cpp_source.html">src/ftxui/component/dropdown.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga562d984d3830d63285643565cd55d16f" name="ga562d984d3830d63285643565cd55d16f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga562d984d3830d63285643565cd55d16f">◆ </a></span>Hoverable() <span class="overload">[1/6]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Hoverable </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>hover</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Wrap a component. Gives the ability to know if it is hovered by the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">component</td><td>The wrapped component. </td></tr>
|
||
<tr><td class="paramname">hover</td><td>The value to reflect whether the component is hovered or not.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-8"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(<span class="stringliteral">"exit"</span>, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keywordtype">bool</span> hover = <span class="keyword">false</span>;</div>
|
||
<div class="line"><span class="keyword">auto</span> button_hover = <a class="code hl_function" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(button, &hover);</div>
|
||
<div class="ttc" id="agroup__component_html_ga562d984d3830d63285643565cd55d16f"><div class="ttname"><a href="#ga562d984d3830d63285643565cd55d16f">ftxui::Hoverable</a></div><div class="ttdeci">Component Hoverable(Component component, bool *hover)</div><div class="ttdoc">Wrap a component. Gives the ability to know if it is hovered by the mouse.</div><div class="ttdef"><b>Definition</b> <a href="hoverable_8cpp_source.html#l00043">hoverable.cpp:43</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hoverable_8cpp_source.html#l00043">43</a> of file <a class="el" href="hoverable_8cpp_source.html">hoverable.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga92ec2f5ccb509da2e2c24ae6a1f6b12b" name="ga92ec2f5ccb509da2e2c24ae6a1f6b12b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga92ec2f5ccb509da2e2c24ae6a1f6b12b">◆ </a></span>Hoverable() <span class="overload">[2/6]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Hoverable </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< void()></td> <td class="paramname"><span class="paramname"><em>on_enter</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< void()></td> <td class="paramname"><span class="paramname"><em>on_leave</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Wrap a component. Uses callbacks. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">component</td><td>The wrapped component. </td></tr>
|
||
<tr><td class="paramname">on_enter</td><td>Callback OnEnter </td></tr>
|
||
<tr><td class="paramname">on_leave</td><td>Callback OnLeave</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-9"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(<span class="stringliteral">"exit"</span>, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keywordtype">bool</span> hover = <span class="keyword">false</span>;</div>
|
||
<div class="line"><span class="keyword">auto</span> button_hover = <a class="code hl_function" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(button, &hover);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hoverable_8cpp_source.html#l00086">86</a> of file <a class="el" href="hoverable_8cpp_source.html">hoverable.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga9d94b37352be13d3551a9d5785f75439" name="ga9d94b37352be13d3551a9d5785f75439"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga9d94b37352be13d3551a9d5785f75439">◆ </a></span>Hoverable() <span class="overload">[3/6]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Hoverable </td>
|
||
<td>(</td>
|
||
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>hover</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Wrap a component. Gives the ability to know if it is hovered by the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">hover</td><td>The value to reflect whether the component is hovered or not.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-10"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> hover = <span class="keyword">false</span>;</div>
|
||
<div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(<span class="stringliteral">"exit"</span>, screen.ExitLoopClosure());</div>
|
||
<div class="line">button |= <a class="code hl_function" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(&hover);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hoverable_8cpp_source.html#l00141">141</a> of file <a class="el" href="hoverable_8cpp_source.html">hoverable.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga34adfc9c76cf3603156cba32ad5d7142" name="ga34adfc9c76cf3603156cba32ad5d7142"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga34adfc9c76cf3603156cba32ad5d7142">◆ </a></span>Hoverable() <span class="overload">[4/6]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Hoverable </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< void()></td> <td class="paramname"><span class="paramname"><em>on_enter</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< void()></td> <td class="paramname"><span class="paramname"><em>on_leave</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Wrap a component. Gives the ability to know if it is hovered by the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">on_enter</td><td>is called when the mouse hover the component. </td></tr>
|
||
<tr><td class="paramname">on_leave</td><td>is called when the mouse leave the component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-11"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(<span class="stringliteral">"exit"</span>, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keywordtype">int</span> on_enter_cnt = 0;</div>
|
||
<div class="line"><span class="keywordtype">int</span> on_leave_cnt = 0;</div>
|
||
<div class="line">button |= <a class="code hl_function" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(</div>
|
||
<div class="line"> [&]{ on_enter_cnt++; },</div>
|
||
<div class="line"> [&]{ on_leave_cnt++; }</div>
|
||
<div class="line">);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hoverable_8cpp_source.html#l00165">165</a> of file <a class="el" href="hoverable_8cpp_source.html">hoverable.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga91cac81077c483efdb952268aee9a523" name="ga91cac81077c483efdb952268aee9a523"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga91cac81077c483efdb952268aee9a523">◆ </a></span>Hoverable() <span class="overload">[5/6]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Hoverable </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< void(bool)></td> <td class="paramname"><span class="paramname"><em>on_change</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Wrap a component. Gives the ability to know if it is hovered by the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">component</td><td>the wrapped component. </td></tr>
|
||
<tr><td class="paramname">on_change</td><td>is called when the mouse enter or leave the component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-12"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(<span class="stringliteral">"exit"</span>, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keywordtype">bool</span> hovered = <span class="keyword">false</span>;</div>
|
||
<div class="line"><span class="keyword">auto</span> button_hoverable = <a class="code hl_function" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(button,</div>
|
||
<div class="line"> [&](<span class="keywordtype">bool</span> hover) { hovered = hover;});</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hoverable_8cpp_source.html#l00188">188</a> of file <a class="el" href="hoverable_8cpp_source.html">hoverable.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gafd7cbaef5378a907111a64ee69aed56a" name="gafd7cbaef5378a907111a64ee69aed56a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gafd7cbaef5378a907111a64ee69aed56a">◆ </a></span>Hoverable() <span class="overload">[6/6]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Hoverable </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< void(bool)></td> <td class="paramname"><span class="paramname"><em>on_change</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Wrap a component. Gives the ability to know if it is hovered by the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">on_change</td><td>is called when the mouse enter or leave the component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-13"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(<span class="stringliteral">"exit"</span>, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keywordtype">bool</span> hovered = <span class="keyword">false</span>;</div>
|
||
<div class="line">button |= <a class="code hl_function" href="#ga562d984d3830d63285643565cd55d16f">Hoverable</a>([&](<span class="keywordtype">bool</span> hover) { hovered = hover;});</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hoverable_8cpp_source.html#l00209">209</a> of file <a class="el" href="hoverable_8cpp_source.html">hoverable.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga7f285fcbc4dd0a0767b89a255fd062dc" name="ga7f285fcbc4dd0a0767b89a255fd062dc"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga7f285fcbc4dd0a0767b89a255fd062dc">◆ </a></span>Input() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Input </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1InputOption">InputOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An input box for editing text. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>InputBase</dd></dl>
|
||
<h3><a class="anchor" id="example-23"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string content= <span class="stringliteral">""</span>;</div>
|
||
<div class="line">std::string placeholder = <span class="stringliteral">"placeholder"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input = <a class="code hl_function" href="#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a>({</div>
|
||
<div class="line"> .content = &content,</div>
|
||
<div class="line"> .placeholder = &placeholder,</div>
|
||
<div class="line">})</div>
|
||
<div class="line">screen.Loop(input);</div>
|
||
<div class="ttc" id="agroup__component_html_ga7f285fcbc4dd0a0767b89a255fd062dc"><div class="ttname"><a href="#ga7f285fcbc4dd0a0767b89a255fd062dc">ftxui::Input</a></div><div class="ttdeci">Component Input(InputOption options={})</div><div class="ttdoc">An input box for editing text.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2input_8cpp_source.html#l00571">src/ftxui/component/input.cpp:571</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-5"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">placeholder</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2input_8cpp_source.html#l00571">571</a> of file <a class="el" href="src_2ftxui_2component_2input_8cpp_source.html">src/ftxui/component/input.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga9d118d596e33bf5bee9d5eccb6265d15" name="ga9d118d596e33bf5bee9d5eccb6265d15"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga9d118d596e33bf5bee9d5eccb6265d15">◆ </a></span>Input() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Input </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a></td> <td class="paramname"><span class="paramname"><em>content</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1InputOption">InputOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An input box for editing text. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">content</td><td>The editable content. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>InputBase</dd></dl>
|
||
<h3><a class="anchor" id="example-24"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string content= <span class="stringliteral">""</span>;</div>
|
||
<div class="line">std::string placeholder = <span class="stringliteral">"placeholder"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input = <a class="code hl_function" href="#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a>(content, {</div>
|
||
<div class="line"> .placeholder = &placeholder,</div>
|
||
<div class="line"> .password = <span class="keyword">true</span>,</div>
|
||
<div class="line">})</div>
|
||
<div class="line">screen.Loop(input);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-6"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">placeholder</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2input_8cpp_source.html#l00599">599</a> of file <a class="el" href="src_2ftxui_2component_2input_8cpp_source.html">src/ftxui/component/input.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga82ba18065d2c29514f034c7278dead74" name="ga82ba18065d2c29514f034c7278dead74"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga82ba18065d2c29514f034c7278dead74">◆ </a></span>Input() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Input </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a></td> <td class="paramname"><span class="paramname"><em>content</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a></td> <td class="paramname"><span class="paramname"><em>placeholder</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1InputOption">InputOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An input box for editing text. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">content</td><td>The editable content. </td></tr>
|
||
<tr><td class="paramname">placeholder</td><td>The placeholder text. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>InputBase</dd></dl>
|
||
<h3><a class="anchor" id="example-25"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string content= <span class="stringliteral">""</span>;</div>
|
||
<div class="line">std::string placeholder = <span class="stringliteral">"placeholder"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input = <a class="code hl_function" href="#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a>(content, placeholder);</div>
|
||
<div class="line">screen.Loop(input);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-7"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">placeholder</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2input_8cpp_source.html#l00626">626</a> of file <a class="el" href="src_2ftxui_2component_2input_8cpp_source.html">src/ftxui/component/input.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga70afe9695167fb736631173201969730" name="ga70afe9695167fb736631173201969730"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga70afe9695167fb736631173201969730">◆ </a></span>Maybe() <span class="overload">[1/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Maybe </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< bool()></td> <td class="paramname"><span class="paramname"><em>show</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate a component |child|. It is shown only when |show| returns true. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>the component to decorate. </td></tr>
|
||
<tr><td class="paramname">show</td><td>a function returning whether |child| should shown. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html#l00021">21</a> of file <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html">src/ftxui/component/maybe.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gae39ad8b223e6bb7704c77a3708571a7d" name="gae39ad8b223e6bb7704c77a3708571a7d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gae39ad8b223e6bb7704c77a3708571a7d">◆ </a></span>Maybe() <span class="overload">[2/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Maybe </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< bool()></td> <td class="paramname"><span class="paramname"><em>show</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate a component. It is shown only when the |show| function returns true. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">show</td><td>a function returning whether the decorated component should be shown.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-20"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> component = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([]{ <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello World!"</span>); });</div>
|
||
<div class="line"><span class="keyword">auto</span> maybe_component = component | <a class="code hl_function" href="#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>([&]{ <span class="keywordflow">return</span> counter == 42; });</div>
|
||
<div class="ttc" id="agroup__component_html_ga20b66a70c1cd4ff3f0ff571a4507d2b4"><div class="ttname"><a href="#ga20b66a70c1cd4ff3f0ff571a4507d2b4">ftxui::Maybe</a></div><div class="ttdeci">Component Maybe(Component, const bool *show)</div><div class="ttdoc">Decorate a component |child|. It is shown only when |show| is true.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2maybe_8cpp_source.html#l00074">src/ftxui/component/maybe.cpp:74</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html#l00057">57</a> of file <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html">src/ftxui/component/maybe.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga20b66a70c1cd4ff3f0ff571a4507d2b4" name="ga20b66a70c1cd4ff3f0ff571a4507d2b4"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga20b66a70c1cd4ff3f0ff571a4507d2b4">◆ </a></span>Maybe() <span class="overload">[3/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Maybe </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const bool *</td> <td class="paramname"><span class="paramname"><em>show</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate a component |child|. It is shown only when |show| is true. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>the component to decorate. </td></tr>
|
||
<tr><td class="paramname">show</td><td>a boolean. |child| is shown when |show| is true.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-21"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> component = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([]{ <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello World!"</span>); });</div>
|
||
<div class="line"><span class="keyword">auto</span> maybe_component = <a class="code hl_function" href="#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>(component, &show);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html#l00074">74</a> of file <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html">src/ftxui/component/maybe.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga83b6fd5e1524023722a7450f987f15d0" name="ga83b6fd5e1524023722a7450f987f15d0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga83b6fd5e1524023722a7450f987f15d0">◆ </a></span>Maybe() <span class="overload">[4/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Maybe </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const bool *</td> <td class="paramname"><span class="paramname"><em>show</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate a component. It is shown only when |show| is true. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">show</td><td>a boolean. |child| is shown when |show| is true.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-22"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> component = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([]{ <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello World!"</span>); });</div>
|
||
<div class="line"><span class="keyword">auto</span> maybe_component = component | <a class="code hl_function" href="#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>(&show);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html#l00088">88</a> of file <a class="el" href="src_2ftxui_2component_2maybe_8cpp_source.html">src/ftxui/component/maybe.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga27828fc39da10a18478ba84b1b162039" name="ga27828fc39da10a18478ba84b1b162039"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga27828fc39da10a18478ba84b1b162039">◆ </a></span>Menu() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Menu </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of text. The focused element is selected. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>a structure containing all the paramters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-37"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::vector<std::string> entries = {</div>
|
||
<div class="line"> <span class="stringliteral">"entry 1"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 2"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 3"</span>,</div>
|
||
<div class="line">};</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#ga27828fc39da10a18478ba84b1b162039">Menu</a>({</div>
|
||
<div class="line"> .entries = &entries,</div>
|
||
<div class="line"> .selected = &selected,</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
<div class="ttc" id="agroup__component_html_ga27828fc39da10a18478ba84b1b162039"><div class="ttname"><a href="#ga27828fc39da10a18478ba84b1b162039">ftxui::Menu</a></div><div class="ttdeci">Component Menu(MenuOption options)</div><div class="ttdoc">A list of text. The focused element is selected.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2menu_8cpp_source.html#l00512">src/ftxui/component/menu.cpp:512</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-15"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">> entry 1</div>
|
||
<div class="line"> entry 2</div>
|
||
<div class="line"> entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html#l00512">512</a> of file <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html">src/ftxui/component/menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gad793a3a507766ffa711c4332a3815e24" name="gad793a3a507766ffa711c4332a3815e24"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gad793a3a507766ffa711c4332a3815e24">◆ </a></span>Menu() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Menu </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of text. The focused element is selected. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of entries in the menu. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>The index of the currently selected element. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-38"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::vector<std::string> entries = {</div>
|
||
<div class="line"> <span class="stringliteral">"entry 1"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 2"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 3"</span>,</div>
|
||
<div class="line">};</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#ga27828fc39da10a18478ba84b1b162039">Menu</a>(&entries, &selected);</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-16"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">> entry 1</div>
|
||
<div class="line"> entry 2</div>
|
||
<div class="line"> entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html#l00543">543</a> of file <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html">src/ftxui/component/menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga3537fccac66b07cd792874c9a6086811" name="ga3537fccac66b07cd792874c9a6086811"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga3537fccac66b07cd792874c9a6086811">◆ </a></span>Toggle() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Toggle </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal list of elements. The user can navigate through them. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of selectable entries to display. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>Reference the selected entry. See also |Menu|. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html#l00554">554</a> of file <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html">src/ftxui/component/menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gafca94c5cdae5fbf3c6aa81fc1cd7b1c0" name="gafca94c5cdae5fbf3c6aa81fc1cd7b1c0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gafca94c5cdae5fbf3c6aa81fc1cd7b1c0">◆ </a></span>MenuEntry() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> MenuEntry </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A specific menu entry. They can be put into a Container::Vertical to form a menu. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The text drawn representing this element. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-39"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#ga6471e39f5664d059144746c5801d37e6">Container::Vertical</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>(<span class="stringliteral">"entry 1"</span>),</div>
|
||
<div class="line"> <a class="code hl_function" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>(<span class="stringliteral">"entry 2"</span>),</div>
|
||
<div class="line"> <a class="code hl_function" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>(<span class="stringliteral">"entry 3"</span>),</div>
|
||
<div class="line">}, &selected);</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
<div class="ttc" id="agroup__component_html_ga2c0a27959e6a5d90109f6d4506e00f69"><div class="ttname"><a href="#ga2c0a27959e6a5d90109f6d4506e00f69">ftxui::MenuEntry</a></div><div class="ttdeci">Component MenuEntry(MenuEntryOption options)</div><div class="ttdoc">A specific menu entry. They can be put into a Container::Vertical to form a menu.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2menu_8cpp_source.html#l00614">src/ftxui/component/menu.cpp:614</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-17"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">> entry 1</div>
|
||
<div class="line"> entry 2</div>
|
||
<div class="line"> entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html#l00584">584</a> of file <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html">src/ftxui/component/menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga2c0a27959e6a5d90109f6d4506e00f69" name="ga2c0a27959e6a5d90109f6d4506e00f69"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga2c0a27959e6a5d90109f6d4506e00f69">◆ </a></span>MenuEntry() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> MenuEntry </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A specific menu entry. They can be put into a Container::Vertical to form a menu. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>The parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-40"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#ga6471e39f5664d059144746c5801d37e6">Container::Vertical</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>({.label = <span class="stringliteral">"entry 1"</span>}),</div>
|
||
<div class="line"> <a class="code hl_function" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>({.label = <span class="stringliteral">"entry 2"</span>}),</div>
|
||
<div class="line"> <a class="code hl_function" href="#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>({.label = <span class="stringliteral">"entry 3"</span>}),</div>
|
||
<div class="line">}, &selected);</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-18"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">> entry 1</div>
|
||
<div class="line"> entry 2</div>
|
||
<div class="line"> entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html#l00614">614</a> of file <a class="el" href="src_2ftxui_2component_2menu_8cpp_source.html">src/ftxui/component/menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga5185342fbba215496cb8a6805f36089c" name="ga5185342fbba215496cb8a6805f36089c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga5185342fbba215496cb8a6805f36089c">◆ </a></span>Modal() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Modal </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>modal</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const bool *</td> <td class="paramname"><span class="paramname"><em>show_modal</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="modal_8cpp_source.html#l00018">18</a> of file <a class="el" href="modal_8cpp_source.html">modal.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga5babae0bb25f8cada57784cc5d27fb74" name="ga5babae0bb25f8cada57784cc5d27fb74"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga5babae0bb25f8cada57784cc5d27fb74">◆ </a></span>Modal() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Modal </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>modal</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const bool *</td> <td class="paramname"><span class="paramname"><em>show_modal</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="modal_8cpp_source.html#l00058">58</a> of file <a class="el" href="modal_8cpp_source.html">modal.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga3e7a44f321fa910f07aef5879e67af95" name="ga3e7a44f321fa910f07aef5879e67af95"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga3e7a44f321fa910f07aef5879e67af95">◆ </a></span>Radiobox() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Radiobox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of element, where only one can be selected. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>The parameters</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>RadioboxBase</dd></dl>
|
||
<h3><a class="anchor" id="example-35"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::vector<std::string> entries = {</div>
|
||
<div class="line"> <span class="stringliteral">"entry 1"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 2"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 3"</span>,</div>
|
||
<div class="line">};</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#ga3e7a44f321fa910f07aef5879e67af95">Radiobox</a>({</div>
|
||
<div class="line"> .entries = entries,</div>
|
||
<div class="line"> .selected = &selected,</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
<div class="ttc" id="agroup__component_html_ga3e7a44f321fa910f07aef5879e67af95"><div class="ttname"><a href="#ga3e7a44f321fa910f07aef5879e67af95">ftxui::Radiobox</a></div><div class="ttdeci">Component Radiobox(RadioboxOption options)</div><div class="ttdoc">A list of element, where only one can be selected.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2radiobox_8cpp_source.html#l00204">src/ftxui/component/radiobox.cpp:204</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-13"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">◉ entry 1</div>
|
||
<div class="line">○ entry 2</div>
|
||
<div class="line">○ entry 3</div>
|
||
</div><!-- fragment --><p> NOLINTNEXTLINE </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2radiobox_8cpp_source.html#l00204">204</a> of file <a class="el" href="src_2ftxui_2component_2radiobox_8cpp_source.html">src/ftxui/component/radiobox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gac73eebf15ff6b5386b7ee6c6cb4a4890" name="gac73eebf15ff6b5386b7ee6c6cb4a4890"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gac73eebf15ff6b5386b7ee6c6cb4a4890">◆ </a></span>Radiobox() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Radiobox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of element, where only one can be selected. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of entries in the list. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>The index of the currently selected element. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>RadioboxBase</dd></dl>
|
||
<h3><a class="anchor" id="example-36"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::vector<std::string> entries = {</div>
|
||
<div class="line"> <span class="stringliteral">"entry 1"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 2"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 3"</span>,</div>
|
||
<div class="line">};</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#ga3e7a44f321fa910f07aef5879e67af95">Radiobox</a>(&entries, &selected);</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-14"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">◉ entry 1</div>
|
||
<div class="line">○ entry 2</div>
|
||
<div class="line">○ entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2radiobox_8cpp_source.html#l00236">236</a> of file <a class="el" href="src_2ftxui_2component_2radiobox_8cpp_source.html">src/ftxui/component/radiobox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaf03d3df7243bf71bb1a73686628f7f2b" name="gaf03d3df7243bf71bb1a73686628f7f2b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaf03d3df7243bf71bb1a73686628f7f2b">◆ </a></span>Renderer() <span class="overload">[1/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()></td> <td class="paramname"><span class="paramname"><em>render</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a component, using |render| to render its interface. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">render</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-26"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] {</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>);</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html#l00029">29</a> of file <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html">src/ftxui/component/renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga533e883e2aeea28de2b60564fcaf0361" name="ga533e883e2aeea28de2b60564fcaf0361"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga533e883e2aeea28de2b60564fcaf0361">◆ </a></span>Renderer() <span class="overload">[2/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()></td> <td class="paramname"><span class="paramname"><em>render</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a new Component, similar to |child|, but using |render| as the Component::Render() event. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The component to forward events to. </td></tr>
|
||
<tr><td class="paramname">render</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-27"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::string label = <span class="stringliteral">"Click to quit"</span>;</div>
|
||
<div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(&label, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>(button, [&] {</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceftxui.html#a552ba6d33b3c9bec586b99fba4c243ac">hbox</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"A button:"</span>),</div>
|
||
<div class="line"> button-><a class="code hl_function" href="group__dom.html#ga7e286fe14880614686ceeec84a9a9702">Render</a>(),</div>
|
||
<div class="line"> });</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
<div class="ttc" id="agroup__dom_html_ga7e286fe14880614686ceeec84a9a9702"><div class="ttname"><a href="group__dom.html#ga7e286fe14880614686ceeec84a9a9702">ftxui::Node::Render</a></div><div class="ttdeci">virtual void Render(Screen &screen)</div><div class="ttdoc">Display an element on a ftxui::Screen.</div><div class="ttdef"><b>Definition</b> <a href="node_8cpp_source.html#l00063">node.cpp:63</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a552ba6d33b3c9bec586b99fba4c243ac"><div class="ttname"><a href="namespaceftxui.html#a552ba6d33b3c9bec586b99fba4c243ac">ftxui::hbox</a></div><div class="ttdeci">Element hbox(Elements)</div><div class="ttdoc">A container displaying elements horizontally one by one.</div><div class="ttdef"><b>Definition</b> <a href="hbox_8cpp_source.html#l00094">hbox.cpp:94</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html#l00061">61</a> of file <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html">src/ftxui/component/renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga099cb57274a99396ee10f38acbfe62a7" name="ga099cb57274a99396ee10f38acbfe62a7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga099cb57274a99396ee10f38acbfe62a7">◆ </a></span>Renderer() <span class="overload">[3/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(bool)></td> <td class="paramname"><span class="paramname"><em>render</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a focusable component, using |render| to render its interface. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">render</td><td>The function drawing the interface, taking a boolean telling whether the component is focused or not.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-28"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] (<span class="keywordtype">bool</span> focused) {</div>
|
||
<div class="line"> <span class="keywordflow">if</span> (focused)</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>) | <a class="code hl_function" href="group__dom.html#ga672456b8f2091b615a30ff755418b37b">inverted</a>;</div>
|
||
<div class="line"> <span class="keywordflow">else</span></div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>);</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
<div class="ttc" id="agroup__dom_html_ga672456b8f2091b615a30ff755418b37b"><div class="ttname"><a href="group__dom.html#ga672456b8f2091b615a30ff755418b37b">ftxui::inverted</a></div><div class="ttdeci">Element inverted(Element)</div><div class="ttdoc">Add a filter that will invert the foreground and the background colors.</div><div class="ttdef"><b>Definition</b> <a href="inverted_8cpp_source.html#l00034">inverted.cpp:34</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html#l00084">84</a> of file <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html">src/ftxui/component/renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga41d63b7af41dee1570b54915821abd30" name="ga41d63b7af41dee1570b54915821abd30"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga41d63b7af41dee1570b54915821abd30">◆ </a></span>Renderer() <span class="overload">[4/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ElementDecorator</a></td> <td class="paramname"><span class="paramname"><em>decorator</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate a component, by decorating what it renders. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">decorator</td><td>the function modifying the element it renders.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-29"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"> <span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"> <span class="keyword">auto</span> renderer = */</div>
|
||
<div class="line"><span class="comment">// Renderer([] { return text("Hello");)</span><span class="comment"></span></div>
|
||
<div class="line"><span class="comment">/** | Renderer(bold)</span></div>
|
||
<div class="line"><span class="comment"> | Renderer(inverted);</span></div>
|
||
<div class="line"><span class="comment"> screen.Loop(renderer);</span></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html#l00125">125</a> of file <a class="el" href="src_2ftxui_2component_2renderer_8cpp_source.html">src/ftxui/component/renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gae2205fc172615b43e1e3307bb614be4c" name="gae2205fc172615b43e1e3307bb614be4c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gae2205fc172615b43e1e3307bb614be4c">◆ </a></span>ResizableSplitLeft()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitLeft </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the left. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the right. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-31"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="#ga53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> left_size = 10;</div>
|
||
<div class="line"><span class="keyword">auto</span> <a class="code hl_variable" href="screen_8cpp.html#a972107f15f3c0c099eb9fd605e7f51c6">left</a> = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Left"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> <a class="code hl_variable" href="screen_8cpp.html#aa4b74e56e675912bbc06504407fc7a46">right</a> = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"right"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = <a class="code hl_function" href="#gae2205fc172615b43e1e3307bb614be4c">ResizableSplitLeft</a>(<a class="code hl_variable" href="screen_8cpp.html#a972107f15f3c0c099eb9fd605e7f51c6">left</a>, <a class="code hl_variable" href="screen_8cpp.html#aa4b74e56e675912bbc06504407fc7a46">right</a>, &left_size);</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
<div class="ttc" id="agroup__component_html_ga53dc5c3030151713857cf1a898d0f897"><div class="ttname"><a href="#ga53dc5c3030151713857cf1a898d0f897">ftxui::ScreenInteractive::Fullscreen</a></div><div class="ttdeci">static ScreenInteractive Fullscreen()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00374">screen_interactive.cpp:374</a></div></div>
|
||
<div class="ttc" id="agroup__component_html_gae2205fc172615b43e1e3307bb614be4c"><div class="ttname"><a href="#gae2205fc172615b43e1e3307bb614be4c">ftxui::ResizableSplitLeft</a></div><div class="ttdeci">Component ResizableSplitLeft(Component main, Component back, int *main_size)</div><div class="ttdoc">An horizontal split in between two components, configurable using the mouse.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00215">src/ftxui/component/resizable_split.cpp:215</a></div></div>
|
||
<div class="ttc" id="agroup__dom_html_ga5b11656305fce8427b81daf1c35883f1"><div class="ttname"><a href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">ftxui::center</a></div><div class="ttdeci">Element center(Element)</div><div class="ttdoc">Center an element horizontally and vertically.</div><div class="ttdef"><b>Definition</b> <a href="composite__decorator_8cpp_source.html#l00031">composite_decorator.cpp:31</a></div></div>
|
||
<div class="ttc" id="ascreen_8cpp_html_a972107f15f3c0c099eb9fd605e7f51c6"><div class="ttname"><a href="screen_8cpp.html#a972107f15f3c0c099eb9fd605e7f51c6">left</a></div><div class="ttdeci">std::uint8_t left</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00129">screen.cpp:129</a></div></div>
|
||
<div class="ttc" id="ascreen_8cpp_html_aa4b74e56e675912bbc06504407fc7a46"><div class="ttname"><a href="screen_8cpp.html#aa4b74e56e675912bbc06504407fc7a46">right</a></div><div class="ttdeci">std::uint8_t right</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00131">screen.cpp:131</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-9"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> │</div>
|
||
<div class="line">left │ right</div>
|
||
<div class="line"> │</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00215">215</a> of file <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html">src/ftxui/component/resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga9030d0beb64f653603cab382b02750a8" name="ga9030d0beb64f653603cab382b02750a8"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga9030d0beb64f653603cab382b02750a8">◆ </a></span>ResizableSplitRight()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitRight </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the right. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the left. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-32"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="#ga53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> right_size = 10;</div>
|
||
<div class="line"><span class="keyword">auto</span> <a class="code hl_variable" href="screen_8cpp.html#a972107f15f3c0c099eb9fd605e7f51c6">left</a> = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Left"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> <a class="code hl_variable" href="screen_8cpp.html#aa4b74e56e675912bbc06504407fc7a46">right</a> = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"right"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = <a class="code hl_function" href="#ga9030d0beb64f653603cab382b02750a8">ResizableSplitRight</a>(<a class="code hl_variable" href="screen_8cpp.html#aa4b74e56e675912bbc06504407fc7a46">right</a>, <a class="code hl_variable" href="screen_8cpp.html#a972107f15f3c0c099eb9fd605e7f51c6">left</a>, &right_size)</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
<div class="ttc" id="agroup__component_html_ga9030d0beb64f653603cab382b02750a8"><div class="ttname"><a href="#ga9030d0beb64f653603cab382b02750a8">ftxui::ResizableSplitRight</a></div><div class="ttdeci">Component ResizableSplitRight(Component main, Component back, int *main_size)</div><div class="ttdoc">An horizontal split in between two components, configurable using the mouse.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00249">src/ftxui/component/resizable_split.cpp:249</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-10"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> │</div>
|
||
<div class="line">left │ right</div>
|
||
<div class="line"> │</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00249">249</a> of file <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html">src/ftxui/component/resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga238b4b650aca14716b82b2198695e008" name="ga238b4b650aca14716b82b2198695e008"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga238b4b650aca14716b82b2198695e008">◆ </a></span>ResizableSplitTop()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitTop </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An vertical split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the top. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the bottom. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-33"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="#ga53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> top_size = 1;</div>
|
||
<div class="line"><span class="keyword">auto</span> <a class="code hl_variable" href="screen_8cpp.html#a495e1456dc6a7df7638b2c507c756a24">top</a> = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Top"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> bottom = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Bottom"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = <a class="code hl_function" href="#ga238b4b650aca14716b82b2198695e008">ResizableSplitTop</a>(<a class="code hl_variable" href="screen_8cpp.html#a495e1456dc6a7df7638b2c507c756a24">top</a>, bottom, &top_size)</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
<div class="ttc" id="agroup__component_html_ga238b4b650aca14716b82b2198695e008"><div class="ttname"><a href="#ga238b4b650aca14716b82b2198695e008">ftxui::ResizableSplitTop</a></div><div class="ttdeci">Component ResizableSplitTop(Component main, Component back, int *main_size)</div><div class="ttdoc">An vertical split in between two components, configurable using the mouse.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00283">src/ftxui/component/resizable_split.cpp:283</a></div></div>
|
||
<div class="ttc" id="ascreen_8cpp_html_a495e1456dc6a7df7638b2c507c756a24"><div class="ttname"><a href="screen_8cpp.html#a495e1456dc6a7df7638b2c507c756a24">top</a></div><div class="ttdeci">std::uint8_t top</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00130">screen.cpp:130</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-11"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> top</div>
|
||
<div class="line">────────────</div>
|
||
<div class="line"> bottom</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00283">283</a> of file <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html">src/ftxui/component/resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gacb75e6e61a021829893f7b57aeb7e3a2" name="gacb75e6e61a021829893f7b57aeb7e3a2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gacb75e6e61a021829893f7b57aeb7e3a2">◆ </a></span>ResizableSplitBottom()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitBottom </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An vertical split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the bottom. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the top. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-34"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="#ga53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> bottom_size = 1;</div>
|
||
<div class="line"><span class="keyword">auto</span> <a class="code hl_variable" href="screen_8cpp.html#a495e1456dc6a7df7638b2c507c756a24">top</a> = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Top"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> bottom = <a class="code hl_function" href="#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Bottom"</span>) | <a class="code hl_function" href="group__dom.html#ga5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = ResizableSplit::Bottom(bottom, <a class="code hl_variable" href="screen_8cpp.html#a495e1456dc6a7df7638b2c507c756a24">top</a>, &bottom_size)</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-12"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> top</div>
|
||
<div class="line">────────────</div>
|
||
<div class="line"> bottom</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00317">317</a> of file <a class="el" href="src_2ftxui_2component_2resizable__split_8cpp_source.html">src/ftxui/component/resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gafdce74ff1421c2f1bda336c8dacefcbd" name="gafdce74ff1421c2f1bda336c8dacefcbd"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gafdce74ff1421c2f1bda336c8dacefcbd">◆ </a></span>Slider()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Slider </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int ></td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>< int ></td> <td class="paramname"><span class="paramname"><em>min</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>< int ></td> <td class="paramname"><span class="paramname"><em>max</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>< int ></td> <td class="paramname"><span class="paramname"><em>increment</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal slider. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The name of the slider. </td></tr>
|
||
<tr><td class="paramname">value</td><td>The current value of the slider. </td></tr>
|
||
<tr><td class="paramname">min</td><td>The minimum value. </td></tr>
|
||
<tr><td class="paramname">max</td><td>The maximum value. </td></tr>
|
||
<tr><td class="paramname">increment</td><td>The increment when used by the cursor.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="example-41"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> value = 50;</div>
|
||
<div class="line"><span class="keyword">auto</span> slider = <a class="code hl_function" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727">Slider</a>(<span class="stringliteral">"Value:"</span>, &value, 0, 100, 1);</div>
|
||
<div class="line">screen.Loop(slider);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_aa3558d992a72679e5e9c9c7b67abd727"><div class="ttname"><a href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727">ftxui::Slider</a></div><div class="ttdeci">Component Slider(SliderOption< T > options)</div><div class="ttdoc">A slider in any direction.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2slider_8cpp_source.html#l00346">src/ftxui/component/slider.cpp:346</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="output-19"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">Value:[██████████████████████████ ]</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2slider_8cpp_source.html#l00289">289</a> of file <a class="el" href="src_2ftxui_2component_2slider_8cpp_source.html">src/ftxui/component/slider.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga638693abef9289912f5fa39606390b20" name="ga638693abef9289912f5fa39606390b20"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga638693abef9289912f5fa39606390b20">◆ </a></span>Window()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Window </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="structftxui_1_1WindowOptions.html">WindowOptions</a></td> <td class="paramname"><span class="paramname"><em>option</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A draggeable / resizeable window. To use multiple of them, they must be stacked using <code>Container::Stacked({...})</code> component;. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">option</td><td>A struct holding every parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>Window</dd></dl>
|
||
<h3><a class="anchor" id="example-44"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> window_1= <a class="code hl_function" href="#ga638693abef9289912f5fa39606390b20">Window</a>({</div>
|
||
<div class="line"> .inner = <a class="code hl_function" href="scrollbar_8cpp.html#a83db372d294b69185f7a26148935cfc3">DummyWindowContent</a>(),</div>
|
||
<div class="line"> .title = <span class="stringliteral">"First window"</span>,</div>
|
||
<div class="line">});</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="keyword">auto</span> window_2= <a class="code hl_function" href="#ga638693abef9289912f5fa39606390b20">Window</a>({</div>
|
||
<div class="line"> .inner = <a class="code hl_function" href="scrollbar_8cpp.html#a83db372d294b69185f7a26148935cfc3">DummyWindowContent</a>(),</div>
|
||
<div class="line"> .title = <span class="stringliteral">"Second window"</span>,</div>
|
||
<div class="line">});</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#gaafd394665b0c231380a143b810339d8e">Container::Stacked</a>({</div>
|
||
<div class="line"> window_1,</div>
|
||
<div class="line"> window_2,</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="agroup__component_html_ga638693abef9289912f5fa39606390b20"><div class="ttname"><a href="#ga638693abef9289912f5fa39606390b20">ftxui::Window</a></div><div class="ttdeci">Component Window(WindowOptions option)</div><div class="ttdoc">A draggeable / resizeable window. To use multiple of them, they must be stacked using Container::Stac...</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2window_8cpp_source.html#l00312">src/ftxui/component/window.cpp:312</a></div></div>
|
||
<div class="ttc" id="ascrollbar_8cpp_html_a83db372d294b69185f7a26148935cfc3"><div class="ttname"><a href="scrollbar_8cpp.html#a83db372d294b69185f7a26148935cfc3">DummyWindowContent</a></div><div class="ttdeci">Component DummyWindowContent()</div><div class="ttdef"><b>Definition</b> <a href="scrollbar_8cpp_source.html#l00010">scrollbar.cpp:10</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2component_2window_8cpp_source.html#l00312">312</a> of file <a class="el" href="src_2ftxui_2component_2window_8cpp_source.html">src/ftxui/component/window.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaaf284a408631f31558694973a04186c2" name="gaaf284a408631f31558694973a04186c2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaaf284a408631f31558694973a04186c2">◆ </a></span>Parent()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> * Parent </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td> const</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return the parent <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a>, or nul if any. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#gabb7a2b60240651d16e17d02eb6f636cf" title="Detach this child from its parent.">Detach</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#gaaf284a408631f31558694973a04186c2" title="Return the parent ComponentBase, or nul if any.">Parent</a> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00039">39</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaceb41a98abe10fb0b521ff8b65529b7f" name="gaceb41a98abe10fb0b521ff8b65529b7f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaceb41a98abe10fb0b521ff8b65529b7f">◆ </a></span>ChildAt()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> & ChildAt </td>
|
||
<td>(</td>
|
||
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Access the child at index <code>i</code>. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00045">45</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga9ae5f77e923e2f0f8b0e26dcd4affb5b" name="ga9ae5f77e923e2f0f8b0e26dcd4affb5b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga9ae5f77e923e2f0f8b0e26dcd4affb5b">◆ </a></span>ChildCount()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">size_t ChildCount </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td> const</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Returns the number of children. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00052">52</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga8ef12397d1682615bc3108c397734179" name="ga8ef12397d1682615bc3108c397734179"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga8ef12397d1682615bc3108c397734179">◆ </a></span>Index()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int Index </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td> const</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return index of the component in its parent. -1 if no parent. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00058">58</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga21f040bec9104e164bfa6c3ad45be3a1" name="ga21f040bec9104e164bfa6c3ad45be3a1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga21f040bec9104e164bfa6c3ad45be3a1">◆ </a></span>Add()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Add </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Add a child. @param child The child to be attached. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00075">75</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gabb7a2b60240651d16e17d02eb6f636cf" name="gabb7a2b60240651d16e17d02eb6f636cf"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gabb7a2b60240651d16e17d02eb6f636cf">◆ </a></span>Detach()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Detach </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Detach this child from its parent. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#gabb7a2b60240651d16e17d02eb6f636cf" title="Detach this child from its parent.">Detach</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#gaaf284a408631f31558694973a04186c2" title="Return the parent ComponentBase, or nul if any.">Parent</a> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00085">85</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga84bd6480cf5e8f51cf5965f81b1f2460" name="ga84bd6480cf5e8f51cf5965f81b1f2460"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga84bd6480cf5e8f51cf5965f81b1f2460">◆ </a></span>DetachAllChildren()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void DetachAllChildren </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Remove all children. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00101">101</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga28d41d6113c5b29c8dd45846582b3299" name="ga28d41d6113c5b29c8dd45846582b3299"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga28d41d6113c5b29c8dd45846582b3299">◆ </a></span>Render()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> Render </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the <a class="el" href="group__screen.html#classftxui_1_1Screen" title="A rectangular grid of Pixel.">ftxui::Screen</a> representing this <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. Please override <a class="el" href="#gab79303652dad19eac0540848487cf8c5" title="Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::C...">OnRender()</a> to modify the rendering. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00111">111</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gab79303652dad19eac0540848487cf8c5" name="gab79303652dad19eac0540848487cf8c5"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gab79303652dad19eac0540848487cf8c5">◆ </a></span>OnRender()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> OnRender </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the ftxi::Screen representing this <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. This function is means to be overridden. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00147">147</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gab84629a8fecad2e1cdd426b7ddc72277" name="gab84629a8fecad2e1cdd426b7ddc72277"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gab84629a8fecad2e1cdd426b7ddc72277">◆ </a></span>OnEvent()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool OnEvent </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="structftxui_1_1Event.html">Event</a></td> <td class="paramname"><span class="paramname"><em>event</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Called in response to an event. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">event</td><td>The event. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>True when the event has been handled. The default implementation called OnEvent on every child until one return true. If none returns true, return false. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00161">161</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaebad858485d02f035a8ea34af66a7fa7" name="gaebad858485d02f035a8ea34af66a7fa7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaebad858485d02f035a8ea34af66a7fa7">◆ </a></span>OnAnimation()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void OnAnimation </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1animation_1_1Params.html">animation::Params</a> &</td> <td class="paramname"><span class="paramname"><em>params</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Called in response to an animation event. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">params</td><td>the parameters of the animation The default implementation dispatch the event to every child. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00174">174</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga5c421f00a2a7f50c542c5c286d2e696c" name="ga5c421f00a2a7f50c542c5c286d2e696c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga5c421f00a2a7f50c542c5c286d2e696c">◆ </a></span>ActiveChild()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> ActiveChild </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return the currently Active child. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>the currently Active child. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00183">183</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga02ccd3db74312f1c66aa8e7931489318" name="ga02ccd3db74312f1c66aa8e7931489318"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga02ccd3db74312f1c66aa8e7931489318">◆ </a></span>Focusable()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool Focusable </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td> const</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00196">196</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga52beef6d7a687d4d109e6cec1606e32e" name="ga52beef6d7a687d4d109e6cec1606e32e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga52beef6d7a687d4d109e6cec1606e32e">◆ </a></span>Active()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool Active </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td> const</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Returns if the element if the currently active child of its parent. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00207">207</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga0cc612fa3d753b456e0f480f44654a9f" name="ga0cc612fa3d753b456e0f480f44654a9f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga0cc612fa3d753b456e0f480f44654a9f">◆ </a></span>Focused()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool Focused </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td> const</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Returns if the elements if focused by the user. True when the <a class="el" href="#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a> is focused by the user. An element is Focused when it is with all its ancestors the <a class="el" href="#ga5c421f00a2a7f50c542c5c286d2e696c" title="Return the currently Active child.">ActiveChild()</a> of their parents, and it <a class="el" href="#ga02ccd3db74312f1c66aa8e7931489318" title="Return true when the component contains focusable elements. The non focusable Components will be skip...">Focusable()</a>. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00216">216</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga8cbf27680c6154e15c8b32d6601340de" name="ga8cbf27680c6154e15c8b32d6601340de"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga8cbf27680c6154e15c8b32d6601340de">◆ </a></span>SetActiveChild() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void SetActiveChild </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#classftxui_1_1ComponentBase">ComponentBase</a> *</td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Make the |child| to be the "active" one. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>the child to become active. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00227">227</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga50ad32ad14dd7912e681fab0ee294be2" name="ga50ad32ad14dd7912e681fab0ee294be2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga50ad32ad14dd7912e681fab0ee294be2">◆ </a></span>SetActiveChild() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void SetActiveChild </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Make the |child| to be the "active" one. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>the child to become active. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00232">232</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga2cf27e9d7128a6a4b3263ecd34c19105" name="ga2cf27e9d7128a6a4b3263ecd34c19105"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga2cf27e9d7128a6a4b3263ecd34c19105">◆ </a></span>TakeFocus()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void TakeFocus </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Configure all the ancestors to give focus to this component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00238">238</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga164d10a2cf367bdd4ae14318a6c7d769" name="ga164d10a2cf367bdd4ae14318a6c7d769"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga164d10a2cf367bdd4ae14318a6c7d769">◆ </a></span>CaptureMouse() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> CaptureMouse </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const <a class="el" href="structftxui_1_1Event.html">Event</a> &</td> <td class="paramname"><span class="paramname"><em>event</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">event</td><td>The event </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00250">250</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gad186d5a36e45174bbc7c50df85c2e91e" name="gad186d5a36e45174bbc7c50df85c2e91e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gad186d5a36e45174bbc7c50df85c2e91e">◆ </a></span>Set()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Set </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>inactive</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>active</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a></td> <td class="paramname"><span class="paramname"><em>duration</em></span><span class="paramdefsep"> = </span><span class="paramdefval">std::chrono::milliseconds(250)</span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a></td> <td class="paramname"><span class="paramname"><em>function</em></span><span class="paramdefsep"> = </span><span class="paramdefval">animation::easing::QuadraticInOut</span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A color option that can be animated. @params _inactive The color when the component is inactive. @params _active The color when the component is active. @params _duration The duration of the animation. @params _function The easing function of the animation. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00021">21</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga754d89398aac6051ced26fd452c62589" name="ga754d89398aac6051ced26fd452c62589"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga754d89398aac6051ced26fd452c62589">◆ </a></span>SetAnimation()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void SetAnimation </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a></td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a></td> <td class="paramname"><span class="paramname"><em>f</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set how the underline should animate. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">d</td><td>The duration of the animation. </td></tr>
|
||
<tr><td class="paramname">f</td><td>The easing function of the animation. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00036">36</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga798360474be7511364b8171f0c62f6d5" name="ga798360474be7511364b8171f0c62f6d5"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga798360474be7511364b8171f0c62f6d5">◆ </a></span>SetAnimationDuration()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void SetAnimationDuration </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a></td> <td class="paramname"><span class="paramname"><em>d</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set how the underline should animate. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">d</td><td>The duration of the animation. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00045">45</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga34e6222dbf10e899074054160870816c" name="ga34e6222dbf10e899074054160870816c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga34e6222dbf10e899074054160870816c">◆ </a></span>SetAnimationFunction() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void SetAnimationFunction </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a></td> <td class="paramname"><span class="paramname"><em>f</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set how the underline should animate. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">f</td><td>The easing function of the animation. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00053">53</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga7d978b34c37e9d08c57a22477016204c" name="ga7d978b34c37e9d08c57a22477016204c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga7d978b34c37e9d08c57a22477016204c">◆ </a></span>SetAnimationFunction() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void SetAnimationFunction </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a></td> <td class="paramname"><span class="paramname"><em>f_leader</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a></td> <td class="paramname"><span class="paramname"><em>f_follower</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set how the underline should animate. This is useful to desynchronize the animation of the leader and the follower. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">f_leader</td><td>The duration of the animation for the leader. </td></tr>
|
||
<tr><td class="paramname">f_follower</td><td>The duration of the animation for the follower. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00064">64</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga5ee36f528383cc1db765fa2140797837" name="ga5ee36f528383cc1db765fa2140797837"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga5ee36f528383cc1db765fa2140797837">◆ </a></span>Horizontal() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> Horizontal </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Standard options for a horizontal menu. This can be useful to implement a tab bar. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00075">75</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaedc93fba91339d9713812821cb140c50" name="gaedc93fba91339d9713812821cb140c50"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaedc93fba91339d9713812821cb140c50">◆ </a></span>HorizontalAnimated()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> HorizontalAnimated </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Standard options for an animated horizontal menu. This can be useful to implement a tab bar. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00100">100</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga617c59fdb94db99100d0e7a569c31d75" name="ga617c59fdb94db99100d0e7a569c31d75"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga617c59fdb94db99100d0e7a569c31d75">◆ </a></span>Vertical() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> Vertical </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Standard options for a vertical menu. This can be useful to implement a list of selectable items. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00110">110</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga6079a7637256d70b30aacb92d2034205" name="ga6079a7637256d70b30aacb92d2034205"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga6079a7637256d70b30aacb92d2034205">◆ </a></span>VerticalAnimated()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> VerticalAnimated </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Standard options for an animated vertical menu. This can be useful to implement a list of selectable items. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00132">132</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga133a8caaf0246db0902f7abce37a9b6d" name="ga133a8caaf0246db0902f7abce37a9b6d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga133a8caaf0246db0902f7abce37a9b6d">◆ </a></span>Toggle() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> Toggle </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Standard options for a horizontal menu with some separator. This can be useful to implement a tab bar. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00155">155</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga66e244b326f3cdc7b80ea836c391c34b" name="ga66e244b326f3cdc7b80ea836c391c34b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga66e244b326f3cdc7b80ea836c391c34b">◆ </a></span>Ascii()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Ascii </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, highlighted using [] characters. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00164">164</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga553fe18f102e8e62aec516d4d3213eac" name="ga553fe18f102e8e62aec516d4d3213eac"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga553fe18f102e8e62aec516d4d3213eac">◆ </a></span>Simple() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Simple </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, inverted when focused. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00177">177</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga2f8ead79a770376a36e9b9b7fa6bc966" name="ga2f8ead79a770376a36e9b9b7fa6bc966"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga2f8ead79a770376a36e9b9b7fa6bc966">◆ </a></span>Border()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Border </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>. The button is shown using a border, inverted when focused. This is the current default. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00192">192</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga008018822835ed0f3758af3c6e72837d" name="ga008018822835ed0f3758af3c6e72837d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga008018822835ed0f3758af3c6e72837d">◆ </a></span>Animated() <span class="overload">[1/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Animated </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00210">210</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga1a78fe7bb802251805a3867ba1a31e15" name="ga1a78fe7bb802251805a3867ba1a31e15"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga1a78fe7bb802251805a3867ba1a31e15">◆ </a></span>Animated() <span class="overload">[2/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Animated </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00218">218</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga0295430ca4a317b0cbba9ee5faa4a324" name="ga0295430ca4a317b0cbba9ee5faa4a324"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga0295430ca4a317b0cbba9ee5faa4a324">◆ </a></span>Animated() <span class="overload">[3/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Animated </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>background</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>foreground</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00229">229</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gadf705e582d884e89211b540a97f2e090" name="gadf705e582d884e89211b540a97f2e090"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gadf705e582d884e89211b540a97f2e090">◆ </a></span>Animated() <span class="overload">[4/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> Animated </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>background</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>foreground</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>background_active</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="group__screen.html#classftxui_1_1Color">Color</a></td> <td class="paramname"><span class="paramname"><em>foreground_active</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create a <a class="el" href="#structftxui_1_1ButtonOption" title="Option for the AnimatedButton component.">ButtonOption</a>, using animated colors. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00242">242</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga41b17a916980353033366c01b15d3cb1" name="ga41b17a916980353033366c01b15d3cb1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga41b17a916980353033366c01b15d3cb1">◆ </a></span>Simple() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> Simple </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Option for standard Checkbox. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00262">262</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaf2b048773665961fae6c104762533908" name="gaf2b048773665961fae6c104762533908"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaf2b048773665961fae6c104762533908">◆ </a></span>Simple() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> Simple </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Option for standard Radiobox. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00287">287</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga2108670f055ede2fdc4993f6ffc8ff07" name="ga2108670f055ede2fdc4993f6ffc8ff07"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga2108670f055ede2fdc4993f6ffc8ff07">◆ </a></span>Default()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1InputOption">InputOption</a> Default </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Create the default input style: </p>
|
||
<p>Standard options for the input component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00312">312</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga36c56131167eaaae707f64bbb9d07ef2" name="ga36c56131167eaaae707f64bbb9d07ef2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga36c56131167eaaae707f64bbb9d07ef2">◆ </a></span>Spacious()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1InputOption">InputOption</a> Spacious </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A white on black style with high margins: </p>
|
||
<p>Standard options for a more beautiful input component. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00335">335</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga769519ed730b72a53a2e770d6ee44365" name="ga769519ed730b72a53a2e770d6ee44365"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga769519ed730b72a53a2e770d6ee44365">◆ </a></span>Character() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1Event.html">Event</a> Character </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An event corresponding to a given typed character. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">input</td><td>The character typed by the user. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="event_8cpp_source.html#l00029">29</a> of file <a class="el" href="event_8cpp_source.html">event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga9970fcb99b3c5ed50753111edf1d2cae" name="ga9970fcb99b3c5ed50753111edf1d2cae"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga9970fcb99b3c5ed50753111edf1d2cae">◆ </a></span>Character() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1Event.html">Event</a> Character </td>
|
||
<td>(</td>
|
||
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>c</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An event corresponding to a given typed character. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">c</td><td>The character typed by the user. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="event_8cpp_source.html#l00040">40</a> of file <a class="el" href="event_8cpp_source.html">event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga2f33d5ea7fca5423861773f891f5ba07" name="ga2f33d5ea7fca5423861773f891f5ba07"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga2f33d5ea7fca5423861773f891f5ba07">◆ </a></span>Character() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1Event.html">Event</a> Character </td>
|
||
<td>(</td>
|
||
<td class="paramtype">wchar_t</td> <td class="paramname"><span class="paramname"><em>c</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An event corresponding to a given typed character. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">c</td><td>The character typed by the user. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="event_8cpp_source.html#l00048">48</a> of file <a class="el" href="event_8cpp_source.html">event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga382859ca10d98eb9c03713de4a95d3f9" name="ga382859ca10d98eb9c03713de4a95d3f9"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga382859ca10d98eb9c03713de4a95d3f9">◆ </a></span>Mouse()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1Event.html">Event</a> <a class="el" href="#structftxui_1_1Mouse">Mouse</a> </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>input</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#structftxui_1_1Mouse">Mouse</a></td> <td class="paramname"><span class="paramname"><em>mouse</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An event corresponding to a given typed character. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">input</td><td>The sequence of character send by the terminal. </td></tr>
|
||
<tr><td class="paramname">mouse</td><td>The mouse state. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="event_8cpp_source.html#l00057">57</a> of file <a class="el" href="event_8cpp_source.html">event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gafe901de476c29382cc358333f10e5ee7" name="gafe901de476c29382cc358333f10e5ee7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gafe901de476c29382cc358333f10e5ee7">◆ </a></span>Special()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="structftxui_1_1Event.html">Event</a> Special </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An custom event whose meaning is defined by the user of the library. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">input</td><td>An arbitrary sequence of character defined by the developer. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="event_8cpp_source.html#l00079">79</a> of file <a class="el" href="event_8cpp_source.html">event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaacbc899babaac445c3b9b831322e8c70" name="gaacbc899babaac445c3b9b831322e8c70"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaacbc899babaac445c3b9b831322e8c70">◆ </a></span>Loop() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> *</td> <td class="paramname"><span class="paramname"><em>screen</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A <a class="el" href="classftxui_1_1Loop.html">Loop</a> is a wrapper around a Component and a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>. It is used to run a Component in a terminal. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>, <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>. </dd>
|
||
<dd>
|
||
<a class="el" href="classftxui_1_1ScreenInteractive.html#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop()</a>. </dd>
|
||
<dd>
|
||
ScreenInteractive::ExitLoop(). </dd></dl>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramdir">[in]</td><td class="paramname">screen</td><td>The screen to use. </td></tr>
|
||
<tr><td class="paramdir">[in]</td><td class="paramname">component</td><td>The component to run. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00021">21</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga0f10869cb1cad212e8885deac6960a41" name="ga0f10869cb1cad212e8885deac6960a41"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga0f10869cb1cad212e8885deac6960a41">◆ </a></span>HasQuitted()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool HasQuitted </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Whether the loop has quitted. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="loop_8cpp_source.html#l00032">32</a> of file <a class="el" href="loop_8cpp_source.html">loop.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga53dc5c3030151713857cf1a898d0f897" name="ga53dc5c3030151713857cf1a898d0f897"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga53dc5c3030151713857cf1a898d0f897">◆ </a></span>Fullscreen()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> Fullscreen </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Create a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content. </p><dl class="section note"><dt>Note</dt><dd>This is the same as <code><a class="el" href="#gacad4646ece7569fd39a3a5c847ebb4a8">ScreenInteractive::FullscreenAlternateScreen()</a></code> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00374">374</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga6be13532d5bef8f566c12090db2dffba" name="ga6be13532d5bef8f566c12090db2dffba"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga6be13532d5bef8f566c12090db2dffba">◆ </a></span>FullscreenPrimaryScreen()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> FullscreenPrimaryScreen </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Create a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> taking the full terminal size. The primary screen buffer is being used. It means if the terminal is resized, the previous content might mess up with the terminal content. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00383">383</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gacad4646ece7569fd39a3a5c847ebb4a8" name="gacad4646ece7569fd39a3a5c847ebb4a8"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gacad4646ece7569fd39a3a5c847ebb4a8">◆ </a></span>FullscreenAlternateScreen()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> FullscreenAlternateScreen </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Create a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00396">396</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gad5961c1d4caf0ba9a030e5675162a164" name="gad5961c1d4caf0ba9a030e5675162a164"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gad5961c1d4caf0ba9a030e5675162a164">◆ </a></span>TrackMouse()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void TrackMouse </td>
|
||
<td>(</td>
|
||
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>enable</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set whether mouse is tracked and events reported. called outside of the main loop. E.g <code><a class="el" href="classftxui_1_1ScreenInteractive.html#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop(...)</a></code>. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">enable</td><td>Whether to enable mouse event tracking. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section note"><dt>Note</dt><dd>This muse be called outside of the main loop. E.g. before calling <code><a class="el" href="classftxui_1_1ScreenInteractive.html#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop</a></code>. </dd>
|
||
<dd>
|
||
<a class="el" href="#structftxui_1_1Mouse" title="A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift,...">Mouse</a> tracking is enabled by default. </dd>
|
||
<dd>
|
||
<a class="el" href="#structftxui_1_1Mouse" title="A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift,...">Mouse</a> tracking is only supported on terminals that supports it.</dd></dl>
|
||
<h3><a class="anchor" id="example-43"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">screen.TrackMouse(<span class="keyword">false</span>);</div>
|
||
<div class="line">screen.Loop(component);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00441">441</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga49209b09dcf8bc540f79e2bfd0a7ee88" name="ga49209b09dcf8bc540f79e2bfd0a7ee88"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga49209b09dcf8bc540f79e2bfd0a7ee88">◆ </a></span>Post()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Post </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#aaa92a82e968c721805c62787cd000534">Task</a></td> <td class="paramname"><span class="paramname"><em>task</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Add a task to the main loop. It will be executed later, after every other scheduled tasks. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00448">448</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga29e75bdaa1d5465518787ec014b2c3bf" name="ga29e75bdaa1d5465518787ec014b2c3bf"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga29e75bdaa1d5465518787ec014b2c3bf">◆ </a></span>PostEvent()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void PostEvent </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="structftxui_1_1Event.html">Event</a></td> <td class="paramname"><span class="paramname"><em>event</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Add an event to the main loop. It will be executed later, after every other scheduled events. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00461">461</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gaad61519d291dcc216d2ac618618a45a2" name="gaad61519d291dcc216d2ac618618a45a2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gaad61519d291dcc216d2ac618618a45a2">◆ </a></span>CaptureMouse() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> CaptureMouse </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Try to get the unique lock about behing able to capture the mouse. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>A unique lock if the mouse is not already captured, otherwise a null. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00483">483</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga9bd3dbd471fce0038700caaa47dddc1a" name="ga9bd3dbd471fce0038700caaa47dddc1a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga9bd3dbd471fce0038700caaa47dddc1a">◆ </a></span>Loop() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void <a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Execute the main loop. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">component</td><td>The component to draw. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00495">495</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="gae295157a88e6300609df83769ed885f2" name="gae295157a88e6300609df83769ed885f2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#gae295157a88e6300609df83769ed885f2">◆ </a></span>ExitLoopClosure()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a> ExitLoopClosure </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a function to exit the main loop. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l01026">1026</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ga1a6a7739e9cc01ba888b57d1f9457f4c" name="ga1a6a7739e9cc01ba888b57d1f9457f4c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ga1a6a7739e9cc01ba888b57d1f9457f4c">◆ </a></span>Exit()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Exit </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Exit the main loop. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l01032">1032</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
</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>
|