mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
626 lines
73 KiB
HTML
626 lines
73 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('module-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><div class="header">
|
|||
|
|
<div class="headertitle"><div class="title">ftxui / component</div></div>
|
|||
|
|
</div><!--header-->
|
|||
|
|
<div class="contents">
|
|||
|
|
<div class="toc"><h3>Table of Contents</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-input">Input</a>
|
|||
|
|
<ul>
|
|||
|
|
<li class="level2">
|
|||
|
|
<a href="#filtered-input">Filtered input</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-menu">Menu</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-toggle">Toggle </a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-checkbox">CheckBox</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-radiobox">RadioBox</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-dropdown">Dropdown</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-slider">Slider</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-renderer">Renderer</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-catchevent">CatchEvent</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-collapsible">Collapsible</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-maybe">Maybe</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-container">Container</a>
|
|||
|
|
<ul>
|
|||
|
|
<li class="level2">
|
|||
|
|
<a href="#component-horizontal">Horizontal</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level2">
|
|||
|
|
<a href="#component-vertical">Vertical</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level2">
|
|||
|
|
<a href="#component-tab">Tab</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-resizable-split">ResizableSplit</a>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1">
|
|||
|
|
<a href="#component-force-redraw">Force a frame redraw.</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="textblock"><p><img src="https://nsm09.casimages.com/img/2025/05/31//2505310207423242518595349.png" alt="title-img" class="inline"/></p>
|
|||
|
|
<p>The <code>ftxui::component</code> module defines the logic that produces interactive components that respond to user events (keyboard, mouse, etc.).</p>
|
|||
|
|
<p>The <a class="el" href="module-component-examples.html">Example</a> section provides a collection of examples.</p>
|
|||
|
|
<p>A <code><a class="el" href="group__component.html#classftxui_1_1ScreenInteractive" title="ScreenInteractive is a Screen that can handle events, run a main loop, and manage components.">ftxui::ScreenInteractive</a></code> defines a main loop that renders a component.</p>
|
|||
|
|
<p>A <code><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">ftxui::Component</a></code> is a shared pointer to a <code><a class="el" href="group__component.html#classftxui_1_1ComponentBase" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a></code>. The latter defines:</p><ul>
|
|||
|
|
<li><code><a class="el" href="group__component.html#a28d41d6113c5b29c8dd45846582b3299" title="Draw the component. Build a ftxui::Element to be drawn on the ftxui::Screen representing this ftxui::...">ftxui::ComponentBase::Render()</a></code>: How to render the interface.</li>
|
|||
|
|
<li><code><a class="el" href="group__component.html#ab84629a8fecad2e1cdd426b7ddc72277" title="Called in response to an event.">ftxui::ComponentBase::OnEvent()</a></code>: How to react to events.</li>
|
|||
|
|
<li><code><a class="el" href="group__component.html#a21f040bec9104e164bfa6c3ad45be3a1" title="Add a child. @param child The child to be attached.">ftxui::ComponentBase::Add()</a></code>: Construct a parent/child relationship between two components. The tree of components is used to define how to navigate using the keyboard.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p><code><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></code> are used to render a single frame.</p>
|
|||
|
|
<p><code><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">ftxui::Component</a></code> are used to render dynamic user interface, producing multiple frame, and updating its state on events.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2gallery_8cpp-example.html">Gallery</a> of multiple components. (<a href="https://arthursonzogni.github.io/FTXUI/examples/?file=component/gallery">demo</a>)</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147247330-b60beb9f-e665-48b4-81c0-4b01ee95bc66.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>All predefined components are available in <a href="./component_8hpp.html">"ftxui/dom/component.hpp"</a></p>
|
|||
|
|
<div class="fragment"><div class="line"><span class="comment">// Copyright 2021 Arthur Sonzogni. All rights reserved.</span></div>
|
|||
|
|
<div class="line"><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
|
|||
|
|
<div class="line"><span class="comment">// the LICENSE file.</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#ifndef FTXUI_COMPONENT_HPP</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#define FTXUI_COMPONENT_HPP</span></div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include <functional></span> <span class="comment">// for function</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include <memory></span> <span class="comment">// for make_shared, shared_ptr</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include <utility></span> <span class="comment">// for forward</span></div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="component__base_8hpp.html">ftxui/component/component_base.hpp</a>"</span> <span class="comment">// for Component, Components</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="component__options_8hpp.html">ftxui/component/component_options.hpp</a>"</span> <span class="comment">// for ButtonOption, CheckboxOption, MenuOption</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="elements_8hpp.html">ftxui/dom/elements.hpp</a>"</span> <span class="comment">// for Element</span></div>
|
|||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="ref_8hpp.html">ftxui/util/ref.hpp</a>"</span> <span class="comment">// for ConstRef, Ref, ConstStringRef, ConstStringListRef, StringRef</span></div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>ButtonOption;</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>CheckboxOption;</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>Event;</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>InputOption;</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>MenuOption;</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>RadioboxOption;</div>
|
|||
|
|
<div class="line"><span class="keyword">struct </span>MenuEntryOption;</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="keyword">template</span> <<span class="keyword">class </span>T, <span class="keyword">class</span>... Args></div>
|
|||
|
|
<div class="line">std::shared_ptr<T> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">Make</a>(Args&&... args) {</div>
|
|||
|
|
<div class="line"> <span class="keywordflow">return</span> std::make_shared<T>(std::forward<Args>(args)...);</div>
|
|||
|
|
<div class="line">}</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="comment">// Pipe operator to decorate components.</span></div>
|
|||
|
|
<div class="line"><span class="keyword">using </span><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> = std::function<<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>)>;</div>
|
|||
|
|
<div class="line"><span class="keyword">using </span><a class="code hl_typedef" href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ElementDecorator</a> = std::function<<a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)>;</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#a65a2e15f64ae3bc205c485abc3a5aeb9">operator|</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, <a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> decorator);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#a65a2e15f64ae3bc205c485abc3a5aeb9">operator|</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, <a class="code hl_typedef" href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ElementDecorator</a> decorator);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>& <a class="code hl_function" href="namespaceftxui.html#ade35e69d695327db85be01c9787c39f8">operator|=</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>& component, <a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> decorator);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>& <a class="code hl_function" href="namespaceftxui.html#ade35e69d695327db85be01c9787c39f8">operator|=</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>& component, <a class="code hl_typedef" href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ElementDecorator</a> decorator);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="keyword">namespace </span>Container {</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga6471e39f5664d059144746c5801d37e6">Vertical</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga6471e39f5664d059144746c5801d37e6">Vertical</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, <span class="keywordtype">int</span>* selector);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga01563bae9454fe64c0b29b0eb3755e68">Horizontal</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga01563bae9454fe64c0b29b0eb3755e68">Horizontal</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, <span class="keywordtype">int</span>* selector);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gaea9fe244eeeb420276bcc5760b46953d">Tab</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, <span class="keywordtype">int</span>* selector);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gaafd394665b0c231380a143b810339d8e">Stacked</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children);</div>
|
|||
|
|
<div class="line">} <span class="comment">// namespace Container</span></div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(ButtonOption options);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga4e8295ec77dd31b0acc5063b134473e7">Button</a>(ConstStringRef label,</div>
|
|||
|
|
<div class="line"> std::function<<span class="keywordtype">void</span>()> on_click,</div>
|
|||
|
|
<div class="line"> ButtonOption options = <a class="code hl_function" href="group__component.html#a553fe18f102e8e62aec516d4d3213eac">ButtonOption::Simple</a>());</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gae0d441d2c83740f187f62db566bbefcd">Checkbox</a>(CheckboxOption options);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gae0d441d2c83740f187f62db566bbefcd">Checkbox</a>(ConstStringRef label,</div>
|
|||
|
|
<div class="line"> <span class="keywordtype">bool</span>* checked,</div>
|
|||
|
|
<div class="line"> CheckboxOption options = <a class="code hl_function" href="group__component.html#a41b17a916980353033366c01b15d3cb1">CheckboxOption::Simple</a>());</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a>(InputOption options = {});</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a>(StringRef content, InputOption options = {});</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga7f285fcbc4dd0a0767b89a255fd062dc">Input</a>(StringRef content,</div>
|
|||
|
|
<div class="line"> StringRef placeholder,</div>
|
|||
|
|
<div class="line"> InputOption options = {});</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga27828fc39da10a18478ba84b1b162039">Menu</a>(MenuOption options);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga27828fc39da10a18478ba84b1b162039">Menu</a>(ConstStringListRef entries,</div>
|
|||
|
|
<div class="line"> <span class="keywordtype">int</span>* selected_,</div>
|
|||
|
|
<div class="line"> MenuOption options = <a class="code hl_function" href="group__component.html#a617c59fdb94db99100d0e7a569c31d75">MenuOption::Vertical</a>());</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>(MenuEntryOption options);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga2c0a27959e6a5d90109f6d4506e00f69">MenuEntry</a>(ConstStringRef label, MenuEntryOption options = {});</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga3e7a44f321fa910f07aef5879e67af95">Radiobox</a>(RadioboxOption options);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga3e7a44f321fa910f07aef5879e67af95">Radiobox</a>(ConstStringListRef entries,</div>
|
|||
|
|
<div class="line"> <span class="keywordtype">int</span>* selected_,</div>
|
|||
|
|
<div class="line"> RadioboxOption options = {});</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gaa22bddff4aeed66e20f30d0715596999">Dropdown</a>(ConstStringListRef entries, <span class="keywordtype">int</span>* selected);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gaa22bddff4aeed66e20f30d0715596999">Dropdown</a>(DropdownOption options);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga3537fccac66b07cd792874c9a6086811">Toggle</a>(ConstStringListRef entries, <span class="keywordtype">int</span>* selected);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="comment">// General slider constructor:</span></div>
|
|||
|
|
<div class="line"><span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727">Slider</a>(SliderOption<T> options);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="comment">// Shorthand without the `SliderOption` constructor:</span></div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727">Slider</a>(ConstStringRef label,</div>
|
|||
|
|
<div class="line"> Ref<int> value,</div>
|
|||
|
|
<div class="line"> ConstRef<int> min = 0,</div>
|
|||
|
|
<div class="line"> ConstRef<int> max = 100,</div>
|
|||
|
|
<div class="line"> ConstRef<int> increment = 5);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727">Slider</a>(ConstStringRef label,</div>
|
|||
|
|
<div class="line"> Ref<float> value,</div>
|
|||
|
|
<div class="line"> ConstRef<float> min = 0.f,</div>
|
|||
|
|
<div class="line"> ConstRef<float> max = 100.f,</div>
|
|||
|
|
<div class="line"> ConstRef<float> increment = 5.f);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727">Slider</a>(ConstStringRef label,</div>
|
|||
|
|
<div class="line"> Ref<long> value,</div>
|
|||
|
|
<div class="line"> ConstRef<long> min = 0L,</div>
|
|||
|
|
<div class="line"> ConstRef<long> max = 100L,</div>
|
|||
|
|
<div class="line"> ConstRef<long> increment = 5L);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#a5ce41caeafc35dedc5c7da5347386e80">ResizableSplit</a>(ResizableSplitOption options);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gae2205fc172615b43e1e3307bb614be4c">ResizableSplitLeft</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, <span class="keywordtype">int</span>* main_size);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga9030d0beb64f653603cab382b02750a8">ResizableSplitRight</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, <span class="keywordtype">int</span>* main_size);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga238b4b650aca14716b82b2198695e008">ResizableSplitTop</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, <span class="keywordtype">int</span>* main_size);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#gacb75e6e61a021829893f7b57aeb7e3a2">ResizableSplitBottom</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> back, <span class="keywordtype">int</span>* main_size);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function<<a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()>);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>(std::function<<a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()>);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>(std::function<<a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<span class="keywordtype">bool</span> <span class="comment">/* focused */</span>)>);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga533e883e2aeea28de2b60564fcaf0361">Renderer</a>(<a class="code hl_typedef" href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ElementDecorator</a>);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#afa5872ba3f9889c7487e57e745e56857">CatchEvent</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function<<span class="keywordtype">bool</span>(Event)>);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="namespaceftxui.html#afa5872ba3f9889c7487e57e745e56857">CatchEvent</a>(std::function<<span class="keywordtype">bool</span>(Event)> on_event);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>, <span class="keyword">const</span> <span class="keywordtype">bool</span>* show);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>, std::function<<span class="keywordtype">bool</span>()>);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span>* show);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga20b66a70c1cd4ff3f0ff571a4507d2b4">Maybe</a>(std::function<<span class="keywordtype">bool</span>()>);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga5185342fbba215496cb8a6805f36089c">Modal</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>, <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> modal, <span class="keyword">const</span> <span class="keywordtype">bool</span>* show_modal);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga5185342fbba215496cb8a6805f36089c">Modal</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> modal, <span class="keyword">const</span> <span class="keywordtype">bool</span>* show_modal);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="namespaceftxui.html#a760cd5eb9a72c008ca18f1e6b366c796">Collapsible</a>(ConstStringRef label,</div>
|
|||
|
|
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child,</div>
|
|||
|
|
<div class="line"> Ref<bool> show = <span class="keyword">false</span>);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, <span class="keywordtype">bool</span>* hover);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component,</div>
|
|||
|
|
<div class="line"> std::function<<span class="keywordtype">void</span>()> on_enter,</div>
|
|||
|
|
<div class="line"> std::function<<span class="keywordtype">void</span>()> on_leave);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> component, <span class="comment">//</span></div>
|
|||
|
|
<div class="line"> std::function<<span class="keywordtype">void</span>(<span class="keywordtype">bool</span>)> on_change);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(<span class="keywordtype">bool</span>* hover);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(std::function<<span class="keywordtype">void</span>()> on_enter,</div>
|
|||
|
|
<div class="line"> std::function<<span class="keywordtype">void</span>()> on_leave);</div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ComponentDecorator</a> <a class="code hl_function" href="group__component.html#ga562d984d3830d63285643565cd55d16f">Hoverable</a>(std::function<<span class="keywordtype">void</span>(<span class="keywordtype">bool</span>)> on_change);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#ga638693abef9289912f5fa39606390b20">Window</a>(WindowOptions option);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line">} <span class="comment">// namespace ftxui</span></div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="preprocessor">#endif </span><span class="comment">/* end of include guard: FTXUI_COMPONENT_HPP */</span><span class="preprocessor"></span></div>
|
|||
|
|
<div class="ttc" id="acomponent__base_8hpp_html"><div class="ttname"><a href="component__base_8hpp.html">component_base.hpp</a></div></div>
|
|||
|
|
<div class="ttc" id="acomponent__options_8hpp_html"><div class="ttname"><a href="component__options_8hpp.html">component_options.hpp</a></div></div>
|
|||
|
|
<div class="ttc" id="aelements_8hpp_html"><div class="ttname"><a href="elements_8hpp.html">elements.hpp</a></div></div>
|
|||
|
|
<div class="ttc" id="aexamples_2component_2button_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="examples_2component_2button_8cpp_source.html#l00004">examples/component/button.cpp:4</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_a41b17a916980353033366c01b15d3cb1"><div class="ttname"><a href="group__component.html#a41b17a916980353033366c01b15d3cb1">ftxui::CheckboxOption::Simple</a></div><div class="ttdeci">static CheckboxOption Simple()</div><div class="ttdoc">Option for standard Checkbox.</div><div class="ttdef"><b>Definition</b> <a href="component__options_8cpp_source.html#l00244">component_options.cpp:244</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_a553fe18f102e8e62aec516d4d3213eac"><div class="ttname"><a href="group__component.html#a553fe18f102e8e62aec516d4d3213eac">ftxui::ButtonOption::Simple</a></div><div class="ttdeci">static ButtonOption Simple()</div><div class="ttdoc">Create a ButtonOption, inverted when focused.</div><div class="ttdef"><b>Definition</b> <a href="component__options_8cpp_source.html#l00165">component_options.cpp:165</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_a617c59fdb94db99100d0e7a569c31d75"><div class="ttname"><a href="group__component.html#a617c59fdb94db99100d0e7a569c31d75">ftxui::MenuOption::Vertical</a></div><div class="ttdeci">static MenuOption Vertical()</div><div class="ttdoc">Standard options for a vertical menu. This can be useful to implement a list of selectable items.</div><div class="ttdef"><b>Definition</b> <a href="component__options_8cpp_source.html#l00102">component_options.cpp:102</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_ga01563bae9454fe64c0b29b0eb3755e68"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga20b66a70c1cd4ff3f0ff571a4507d2b4"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga238b4b650aca14716b82b2198695e008"><div class="ttname"><a href="group__component.html#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="agroup__component_html_ga27828fc39da10a18478ba84b1b162039"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga2c0a27959e6a5d90109f6d4506e00f69"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga3537fccac66b07cd792874c9a6086811"><div class="ttname"><a href="group__component.html#ga3537fccac66b07cd792874c9a6086811">ftxui::Toggle</a></div><div class="ttdeci">Component Toggle(ConstStringListRef entries, int *selected)</div><div class="ttdoc">An horizontal list of elements. The user can navigate through them.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2menu_8cpp_source.html#l00554">src/ftxui/component/menu.cpp:554</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_ga3e7a44f321fa910f07aef5879e67af95"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga4e8295ec77dd31b0acc5063b134473e7"><div class="ttname"><a href="group__component.html#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="agroup__component_html_ga5185342fbba215496cb8a6805f36089c"><div class="ttname"><a href="group__component.html#ga5185342fbba215496cb8a6805f36089c">ftxui::Modal</a></div><div class="ttdeci">Component Modal(Component main, Component modal, const bool *show_modal)</div><div class="ttdef"><b>Definition</b> <a href="modal_8cpp_source.html#l00018">modal.cpp:18</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_ga533e883e2aeea28de2b60564fcaf0361"><div class="ttname"><a href="group__component.html#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__component_html_ga562d984d3830d63285643565cd55d16f"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga638693abef9289912f5fa39606390b20"><div class="ttname"><a href="group__component.html#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="agroup__component_html_ga6471e39f5664d059144746c5801d37e6"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga7f285fcbc4dd0a0767b89a255fd062dc"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_ga9030d0beb64f653603cab382b02750a8"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_gaa22bddff4aeed66e20f30d0715596999"><div class="ttname"><a href="group__component.html#gaa22bddff4aeed66e20f30d0715596999">ftxui::Dropdown</a></div><div class="ttdeci">Component Dropdown(ConstStringListRef entries, int *selected)</div><div class="ttdoc">A dropdown menu.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2dropdown_8cpp_source.html#l00022">src/ftxui/component/dropdown.cpp:22</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_gaafd394665b0c231380a143b810339d8e"><div class="ttname"><a href="group__component.html#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 class="ttc" id="agroup__component_html_gacb75e6e61a021829893f7b57aeb7e3a2"><div class="ttname"><a href="group__component.html#gacb75e6e61a021829893f7b57aeb7e3a2">ftxui::ResizableSplitBottom</a></div><div class="ttdeci">Component ResizableSplitBottom(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#l00317">src/ftxui/component/resizable_split.cpp:317</a></div></div>
|
|||
|
|
<div class="ttc" id="agroup__component_html_gae0d441d2c83740f187f62db566bbefcd"><div class="ttname"><a href="group__component.html#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_gae2205fc172615b43e1e3307bb614be4c"><div class="ttname"><a href="group__component.html#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__component_html_gaea9fe244eeeb420276bcc5760b46953d"><div class="ttname"><a href="group__component.html#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 class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdoc">The FTXUI ftxui:: namespace.</div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a2b8973dc71334f1d98e2e6f55de8b5ae"><div class="ttname"><a href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">ftxui::Make</a></div><div class="ttdeci">std::shared_ptr< T > Make(Args &&... args)</div><div class="ttdef"><b>Definition</b> <a href="component_8hpp_source.html#l00026">component.hpp:26</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a2bc31f2d685189e5c61d2293a1f51b4f"><div class="ttname"><a href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></div><div class="ttdeci">std::shared_ptr< Node > Element</div><div class="ttdef"><b>Definition</b> <a href="elements_8hpp_source.html#l00022">elements.hpp:22</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a2d5012891073dbf196bfada5f702f382"><div class="ttname"><a href="namespaceftxui.html#a2d5012891073dbf196bfada5f702f382">ftxui::ElementDecorator</a></div><div class="ttdeci">std::function< Element(Element)> ElementDecorator</div><div class="ttdef"><b>Definition</b> <a href="component_8hpp_source.html#l00032">component.hpp:32</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a3d4ccad0c8a07d5b0cb4b2e690ffc90c"><div class="ttname"><a href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">ftxui::Components</a></div><div class="ttdeci">std::vector< Component > Components</div><div class="ttdef"><b>Definition</b> <a href="component__base_8hpp_source.html#l00025">component_base.hpp:25</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a5ce41caeafc35dedc5c7da5347386e80"><div class="ttname"><a href="namespaceftxui.html#a5ce41caeafc35dedc5c7da5347386e80">ftxui::ResizableSplit</a></div><div class="ttdeci">Component ResizableSplit(ResizableSplitOption options)</div><div class="ttdoc">A split in between two components.</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2resizable__split_8cpp_source.html#l00186">src/ftxui/component/resizable_split.cpp:186</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a65a2e15f64ae3bc205c485abc3a5aeb9"><div class="ttname"><a href="namespaceftxui.html#a65a2e15f64ae3bc205c485abc3a5aeb9">ftxui::operator|</a></div><div class="ttdeci">Component operator|(Component component, ComponentDecorator decorator)</div><div class="ttdef"><b>Definition</b> <a href="component_2util_8cpp_source.html#l00012">component/util.cpp:12</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_a760cd5eb9a72c008ca18f1e6b366c796"><div class="ttname"><a href="namespaceftxui.html#a760cd5eb9a72c008ca18f1e6b366c796">ftxui::Collapsible</a></div><div class="ttdeci">Component Collapsible(ConstStringRef label, Component child, Ref< bool > show=false)</div><div class="ttdoc">A collapsible component. It displays a checkbox with an arrow. Once activated, the child is displayed...</div><div class="ttdef"><b>Definition</b> <a href="src_2ftxui_2component_2collapsible_8cpp_source.html#l00033">src/ftxui/component/collapsible.cpp:33</a></div></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 class="ttc" id="anamespaceftxui_html_ade35e69d695327db85be01c9787c39f8"><div class="ttname"><a href="namespaceftxui.html#ade35e69d695327db85be01c9787c39f8">ftxui::operator|=</a></div><div class="ttdeci">Component & operator|=(Component &component, ComponentDecorator decorator)</div><div class="ttdef"><b>Definition</b> <a href="component_2util_8cpp_source.html#l00022">component/util.cpp:22</a></div></div>
|
|||
|
|
<div class="ttc" id="anamespaceftxui_html_af07b496fe512e3a4863ee546f19e9a6c"><div class="ttname"><a href="namespaceftxui.html#af07b496fe512e3a4863ee546f19e9a6c">ftxui::ComponentDecorator</a></div><div class="ttdeci">std::function< Component(Component)> ComponentDecorator</div><div class="ttdef"><b>Definition</b> <a href="component_8hpp_source.html#l00031">component.hpp:31</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 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 class="ttc" id="aref_8hpp_html"><div class="ttname"><a href="ref_8hpp.html">ref.hpp</a></div></div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="component-input"></a>
|
|||
|
|
Input</h1>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2input_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147247671-f1d6f606-1845-4e94-a4a0-d4273e9ae6bd.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga7f285fcbc4dd0a0767b89a255fd062dc" title="An input box for editing text.">ftxui::Input()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<p>
|
|||
|
|
<script id="asciicast-223719" src="https://asciinema.org/a/223719.js" async></script>
|
|||
|
|
</p>
|
|||
|
|
<h2><a class="anchor" id="filtered-input"></a>
|
|||
|
|
Filtered input</h2>
|
|||
|
|
<p>One can filter out the characters received by the input component, using <code>ftxui::CatchEvent</code>.</p>
|
|||
|
|
<div class="fragment"><div class="line">std::string phone_number;</div>
|
|||
|
|
<div class="line">Component input = Input(&phone_number, <span class="stringliteral">"phone number"</span>);</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="comment">// Filter out non-digit characters.</span></div>
|
|||
|
|
<div class="line">input |= CatchEvent([&](Event event) {</div>
|
|||
|
|
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">event</span>.is_character() && !std::isdigit(event.character()[0]);</div>
|
|||
|
|
<div class="line">});</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="comment">// Filter out characters past the 10th one.</span></div>
|
|||
|
|
<div class="line">input |= CatchEvent([&](Event event) {</div>
|
|||
|
|
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">event</span>.is_character() && phone_number.size() >= 10;</div>
|
|||
|
|
<div class="line">});</div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="component-menu"></a>
|
|||
|
|
Menu</h1>
|
|||
|
|
<p>Defines a menu object. It contains a list of entries, one of them is selected.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2menu_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147247822-0035fd6f-bb13-4b3a-b057-77eb9291582f.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga27828fc39da10a18478ba84b1b162039" title="A list of text. The focused element is selected.">ftxui::Menu()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<p>
|
|||
|
|
<script id="asciicast-223720" src="https://asciinema.org/a/223720.js" async></script>
|
|||
|
|
</p>
|
|||
|
|
<h1><a class="anchor" id="component-toggle"></a>
|
|||
|
|
Toggle </h1>
|
|||
|
|
<p>A special kind of menu. The entries are displayed horizontally.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2toggle_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147249383-e2201cf1-b7b8-4a5a-916f-d761e3e7ae40.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga3537fccac66b07cd792874c9a6086811" title="An horizontal list of elements. The user can navigate through them.">ftxui::Toggle()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<p>
|
|||
|
|
<script id="asciicast-223722" src="https://asciinema.org/a/223722.js" async></script>
|
|||
|
|
</p>
|
|||
|
|
<h1><a class="anchor" id="component-checkbox"></a>
|
|||
|
|
CheckBox</h1>
|
|||
|
|
<p>This component defines a checkbox. It is a single entry that can be turned on/off.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2checkbox_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147246646-b86926a9-1ef9-4efb-af98-48a9b62acd81.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#gae0d441d2c83740f187f62db566bbefcd" title="Draw checkable element.">ftxui::Checkbox()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<p>
|
|||
|
|
<script id="asciicast-223724" src="https://asciinema.org/a/223724.js" async></script>
|
|||
|
|
</p>
|
|||
|
|
<h1><a class="anchor" id="component-radiobox"></a>
|
|||
|
|
RadioBox</h1>
|
|||
|
|
<p>A radiobutton component. This is a list of entries, where one can be turned on.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2radiobox_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147246401-809d14a5-6621-4e36-8dd9-a2d75ef2a94e.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga3e7a44f321fa910f07aef5879e67af95" title="A list of element, where only one can be selected.">ftxui::Radiobox()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<p>
|
|||
|
|
<script id="asciicast-223725" src="https://asciinema.org/a/223725.js" async></script>
|
|||
|
|
</p>
|
|||
|
|
<h1><a class="anchor" id="component-dropdown"></a>
|
|||
|
|
Dropdown</h1>
|
|||
|
|
<p>A drop-down menu is a component that, when opened, displays a list of elements for the user to select from.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2dropdown_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147246982-1e821751-531c-4e1f-bc37-2fa290e143cd.gif" alt="youtube-video-gif (3)" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#gaa22bddff4aeed66e20f30d0715596999" title="A dropdown menu.">ftxui::Dropdown()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<h1><a class="anchor" id="component-slider"></a>
|
|||
|
|
Slider</h1>
|
|||
|
|
<p>Represents a slider object that consists of a range with binned intermediate intervals. It can be created by <code><a class="el" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727" title="A slider in any direction.">ftxui::Slider()</a></code>.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2slider_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147249265-7e2cad75-082c-436e-affe-44a550c480ab.png" alt="image" class="inline"/></p>
|
|||
|
|
<p>Produced by: <code><a class="el" href="namespaceftxui.html#aa3558d992a72679e5e9c9c7b67abd727" title="A slider in any direction.">ftxui::Slider()</a></code> from "ftxui/component/component.hpp"</p>
|
|||
|
|
<h1><a class="anchor" id="component-renderer"></a>
|
|||
|
|
Renderer</h1>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga533e883e2aeea28de2b60564fcaf0361" title="Return a new Component, similar to |child|, but using |render| as the Component::Render() event.">ftxui::Renderer()</a></code> from <a class="el" href="component_8hpp.html">ftxui/component/component.hpp</a>. This component decorate another one by using a different function to render an interface.</p>
|
|||
|
|
<p>Example: </p><div class="fragment"><div class="line"><span class="keyword">auto</span> inner = [...]</div>
|
|||
|
|
<div class="line"> </div>
|
|||
|
|
<div class="line"><span class="keyword">auto</span> renderer = Renderer(inner, [&] {</div>
|
|||
|
|
<div class="line"> <span class="keywordflow">return</span> inner->Render() | border</div>
|
|||
|
|
<div class="line">});</div>
|
|||
|
|
</div><!-- fragment --><p><code>ftxui::Renderer</code> also supports the component decorator pattern: </p><div class="fragment"><div class="line"><span class="keyword">auto</span> component = [...]</div>
|
|||
|
|
<div class="line">component = component</div>
|
|||
|
|
<div class="line"> | Renderer([](Element e) { <span class="keywordflow">return</span> e | border))</div>
|
|||
|
|
<div class="line"> | Renderer(bold)</div>
|
|||
|
|
</div><!-- fragment --><p>As a short hand, you can also compose a component with an element decorator: </p><div class="fragment"><div class="line"><span class="keyword">auto</span> component = [...]</div>
|
|||
|
|
<div class="line">component = component | border | bold;</div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="component-catchevent"></a>
|
|||
|
|
CatchEvent</h1>
|
|||
|
|
<p>Produced by: <code><a class="el" href="namespaceftxui.html#afa5872ba3f9889c7487e57e745e56857">ftxui::CatchEvent()</a></code> from <a class="el" href="component_8hpp.html">ftxui/component/component.hpp</a>. This component decorate others, catching events before the underlying component.</p>
|
|||
|
|
<p>Examples: </p><div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ScreenInteractive::TerminalOutput();</div>
|
|||
|
|
<div class="line"><span class="keyword">auto</span> renderer = Renderer([] {</div>
|
|||
|
|
<div class="line"> <span class="keywordflow">return</span> text(<span class="stringliteral">"My interface"</span>);</div>
|
|||
|
|
<div class="line">});</div>
|
|||
|
|
<div class="line"><span class="keyword">auto</span> component = CatchEvent(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><!-- fragment --><p>The <code>ftxui::CatchEvent</code> can also be used as a decorator: </p><div class="fragment"><div class="line">component = component</div>
|
|||
|
|
<div class="line"> | CatchEvent(handler_1)</div>
|
|||
|
|
<div class="line"> | CatchEvent(handler_2)</div>
|
|||
|
|
<div class="line"> | CatchEvent(handler_3)</div>
|
|||
|
|
<div class="line"> ;</div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="component-collapsible"></a>
|
|||
|
|
Collapsible</h1>
|
|||
|
|
<p>Useful for visual elements whose visibility can be toggled on or off by the user. Essentially, this is the combination of the <code><a class="el" href="group__component.html#gae0d441d2c83740f187f62db566bbefcd" title="Draw checkable element.">ftxui::Checkbox()</a></code> and <code><a class="el" href="group__component.html#ga20b66a70c1cd4ff3f0ff571a4507d2b4" title="Decorate a component |child|. It is shown only when |show| is true.">ftxui::Maybe()</a></code> components.</p>
|
|||
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> collapsible = Collapsible(<span class="stringliteral">"Show more"</span>, inner_element);</div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="component-maybe"></a>
|
|||
|
|
Maybe</h1>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga20b66a70c1cd4ff3f0ff571a4507d2b4" title="Decorate a component |child|. It is shown only when |show| is true.">ftxui::Maybe()</a></code> from <a class="el" href="component_8hpp.html">ftxui/component/component.hpp</a>. This component can be utilized to show/hide any other component via a boolean or a predicate.</p>
|
|||
|
|
<p>Example with a boolean: </p><div class="fragment"><div class="line"><span class="keywordtype">bool</span> show = <span class="keyword">true</span>;</div>
|
|||
|
|
<div class="line"><span class="keyword">auto</span> component = Renderer([]{ <span class="keywordflow">return</span> <span class="stringliteral">"Hello World!"</span>; });</div>
|
|||
|
|
<div class="line"><span class="keyword">auto</span> maybe_component = Maybe(component, &show)</div>
|
|||
|
|
</div><!-- fragment --><p>Example with a predicate: </p><div class="fragment"><div class="line"><span class="keyword">auto</span> component = Renderer([]{ <span class="keywordflow">return</span> <span class="stringliteral">"Hello World!"</span>; });</div>
|
|||
|
|
<div class="line"><span class="keyword">auto</span> maybe_component = Maybe(component, [&] { <span class="keywordflow">return</span> time > 10; })</div>
|
|||
|
|
</div><!-- fragment --><p>As usual, <code>ftxui::Maybe</code> can also be used as a decorator: </p><div class="fragment"><div class="line">component = component</div>
|
|||
|
|
<div class="line"> | Maybe(&a_boolean)</div>
|
|||
|
|
<div class="line"> | Maybe([&] { <span class="keywordflow">return</span> time > 10; })</div>
|
|||
|
|
<div class="line"> ;</div>
|
|||
|
|
</div><!-- fragment --><h1><a class="anchor" id="component-container"></a>
|
|||
|
|
Container</h1>
|
|||
|
|
<h2><a class="anchor" id="component-horizontal"></a>
|
|||
|
|
Horizontal</h2>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga01563bae9454fe64c0b29b0eb3755e68" title="A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow...">ftxui::Container::Horizontal()</a></code> from "ftxui/component/component.hpp". It displays a list of components horizontally and handles keyboard/mouse navigation.</p>
|
|||
|
|
<h2><a class="anchor" id="component-vertical"></a>
|
|||
|
|
Vertical</h2>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#ga6471e39f5664d059144746c5801d37e6" title="A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or...">ftxui::Container::Vertical()</a></code> from "ftxui/component/component.hpp". It displays a list of components vertically and handles keyboard/mouse navigation.</p>
|
|||
|
|
<h2><a class="anchor" id="component-tab"></a>
|
|||
|
|
Tab</h2>
|
|||
|
|
<p>Produced by: <code><a class="el" href="group__component.html#gaea9fe244eeeb420276bcc5760b46953d" title="A list of components, where only one is drawn and interacted with at a time. The |selector| gives the...">ftxui::Container::Tab()</a></code> from "ftxui/component/component.hpp". It takes a list of components and displays only one of them. This is useful for implementing a tab bar.</p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2tab_vertical_8cpp-example.html">Vertical</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147250144-22ff044a-4773-4ff7-a49c-12ba4034acb4.gif" alt="ezgif com-gif-maker (1)" class="inline"/></p>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2tab_horizontal_8cpp-example.html">Horizontal</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147250217-fe447e0f-7a99-4e08-948a-995087d9b40e.gif" alt="ezgif com-gif-maker (2)" class="inline"/></p>
|
|||
|
|
<h1><a class="anchor" id="component-resizable-split"></a>
|
|||
|
|
ResizableSplit</h1>
|
|||
|
|
<p>It defines a horizontal or vertical separation between two children components. The position of the split is variable and controllable using the mouse. There are four possible splits:</p><ul>
|
|||
|
|
<li><code><a class="el" href="group__component.html#gae2205fc172615b43e1e3307bb614be4c" title="An horizontal split in between two components, configurable using the mouse.">ftxui::ResizableSplitLeft()</a></code></li>
|
|||
|
|
<li><code><a class="el" href="group__component.html#ga9030d0beb64f653603cab382b02750a8" title="An horizontal split in between two components, configurable using the mouse.">ftxui::ResizableSplitRight()</a></code></li>
|
|||
|
|
<li><code><a class="el" href="group__component.html#ga238b4b650aca14716b82b2198695e008" title="An vertical split in between two components, configurable using the mouse.">ftxui::ResizableSplitTop()</a></code></li>
|
|||
|
|
<li><code><a class="el" href="group__component.html#gacb75e6e61a021829893f7b57aeb7e3a2" title="An vertical split in between two components, configurable using the mouse.">ftxui::ResizableSplitBottom()</a></code> from "ftxui/component/component.hpp"</li>
|
|||
|
|
</ul>
|
|||
|
|
<p><a href="https://arthursonzogni.github.io/FTXUI/examples_2component_2resizable_split_8cpp-example.html">Example</a>:</p>
|
|||
|
|
<p><img src="https://user-images.githubusercontent.com/4759106/147248372-c55512fe-9b96-4b08-a1df-d05cf2cae431.gif" alt="ezgif com-gif-maker" class="inline"/> <br />
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
<script id="asciicast-tprMH2EdkUoMb7D2YxgMGgpzx" src="https://asciinema.org/a/tprMH2EdkUoMb7D2YxgMGgpzx.js" async></script>
|
|||
|
|
</p>
|
|||
|
|
<h1><a class="anchor" id="component-force-redraw"></a>
|
|||
|
|
Force a frame redraw.</h1>
|
|||
|
|
<p>Typically, <code><a class="el" href="group__component.html#a6f7095d721dd1dbd490d97c028eb676f">ftxui::ScreenInteractive::Loop()</a></code> is responsible for drawing a new frame whenever a new group of events (e.g keyboard, mouse, window resize, etc.) has been processed. However, you might want to react to arbitrary events that are unknown to FTXUI. To accomplish this, you must post events using <code><a class="el" href="group__component.html#a29e75bdaa1d5465518787ec014b2c3bf" title="Add an event to the main loop. It will be executed later, after every other scheduled events.">ftxui::ScreenInteractive::PostEvent</a></code> (<b>this is thread safe</b>) via a thread. You will have to post the event <code><a class="el" href="group__component.html#a699872f2a6d8607d714be174e9435290">ftxui::Event::Custom</a></code>.</p>
|
|||
|
|
<p>Example: </p><div class="fragment"><div class="line">screen->PostEvent(Event::Custom);</div>
|
|||
|
|
</div><!-- fragment --><p>If you don't need to process a new Event, you can use: </p><div class="fragment"><div class="line">screen->RequestAnimationFrame();</div>
|
|||
|
|
</div><!-- fragment --><p> instead. </p>
|
|||
|
|
</div></div><!-- contents -->
|
|||
|
|
</div><!-- PageDoc -->
|
|||
|
|
</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>
|