Files
FTXUI/en/v3.0.0/component__options_8hpp.html
2025-11-12 12:56:59 +00:00

321 lines
20 KiB
HTML

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="cache-control" content="max-age=86400"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FTXUI: include/ftxui/component/component_options.hpp File Reference</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>
<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_extra.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FTXUI
&#160;<span id="projectnumber">3.0.0</span>
</div>
<div id="projectbrief">C++ functional terminal UI.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('component__options_8hpp.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">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle"><div class="title">component_options.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="component__options_8hpp__dep__incl.png" border="0" usemap="#ainclude_2ftxui_2component_2component__options_8hppdep" alt=""/></div>
<map name="ainclude_2ftxui_2component_2component__options_8hppdep" id="ainclude_2ftxui_2component_2component__options_8hppdep">
<area shape="rect" title=" " alt="" coords="1212,5,1395,45"/>
<area shape="rect" href="component_8hpp.html" title=" " alt="" coords="1214,93,1393,133"/>
<area shape="poly" title=" " alt="" coords="1306,59,1306,93,1301,93,1301,59"/>
<area shape="rect" href="button_8cpp.html" title=" " alt="" coords="5,181,156,221"/>
<area shape="poly" title=" " alt="" coords="1198,33,891,52,702,70,514,96,412,116,310,139,144,184,142,179,309,134,411,110,514,91,702,65,890,47,1198,28"/>
<area shape="rect" href="checkbox_8cpp.html" title=" " alt="" coords="180,181,331,221"/>
<area shape="poly" title=" " alt="" coords="1199,37,972,59,839,76,706,96,497,140,324,184,322,179,495,135,706,91,838,70,971,54,1198,32"/>
<area shape="rect" href="collapsible_8cpp.html" title=" " alt="" coords="355,181,505,221"/>
<area shape="poly" title=" " alt="" coords="1199,44,1051,67,888,96,678,141,504,184,502,179,677,136,887,91,1050,62,1198,39"/>
<area shape="rect" href="dropdown_8cpp.html" title=" " alt="" coords="529,181,680,221"/>
<area shape="poly" title=" " alt="" coords="1216,51,681,184,680,179,1214,46"/>
<area shape="rect" href="input_8cpp.html" title=" " alt="" coords="2297,181,2448,221"/>
<area shape="poly" title=" " alt="" coords="1345,51,1406,91,1434,114,1446,123,1463,131,1540,149,1639,160,1751,166,1871,168,2105,169,2206,172,2286,179,2298,180,2297,186,2286,184,2205,177,2105,175,1871,173,1751,171,1638,165,1539,154,1461,136,1443,128,1430,118,1403,95,1342,55"/>
<area shape="rect" href="menu_8cpp.html" title=" " alt="" coords="2472,181,2623,221"/>
<area shape="poly" title=" " alt="" coords="1364,49,1453,91,1483,113,1495,123,1513,131,1603,150,1716,162,1846,167,1983,169,2253,169,2368,171,2461,179,2472,180,2471,186,2460,184,2368,177,2252,174,1983,174,1846,173,1716,167,1602,156,1512,136,1493,127,1480,118,1450,96,1362,53"/>
<area shape="rect" href="radiobox_8cpp.html" title=" " alt="" coords="2647,181,2797,221"/>
<area shape="poly" title=" " alt="" coords="1389,47,1445,66,1502,91,1519,102,1530,113,1541,123,1558,131,1604,144,1659,154,1788,167,1935,172,2092,173,2398,169,2530,171,2636,179,2647,180,2646,186,2635,184,2530,176,2398,175,2092,178,1935,177,1787,172,1658,159,1603,149,1556,136,1538,127,1526,117,1515,106,1499,96,1444,71,1387,52"/>
<area shape="rect" href="component__options_8cpp.html" title=" " alt="" coords="1569,93,1750,133"/>
<area shape="poly" title=" " alt="" coords="1395,46,1582,91,1581,96,1394,51"/>
<area shape="poly" title=" " alt="" coords="1200,118,1008,122,751,133,461,152,168,184,157,186,156,180,167,179,460,147,751,127,1008,117,1200,113"/>
<area shape="rect" href="catch__event_8cpp.html" title=" " alt="" coords="1752,181,1903,221"/>
<area shape="poly" title=" " alt="" coords="1407,130,1412,131,1577,154,1741,179,1752,181,1751,186,1740,184,1576,159,1411,136,1406,135"/>
<area shape="poly" title=" " alt="" coords="1200,120,1035,126,821,137,582,156,342,184,331,186,330,180,342,179,582,151,821,132,1035,120,1200,114"/>
<area shape="poly" title=" " alt="" coords="1200,122,893,142,705,160,517,184,506,186,505,181,516,179,705,155,893,137,1200,117"/>
<area shape="rect" href="component_8cpp.html" title=" " alt="" coords="1927,181,2077,221"/>
<area shape="poly" title=" " alt="" coords="1407,130,1412,131,1553,146,1664,153,1774,161,1916,179,1927,181,1926,186,1915,184,1774,166,1663,158,1553,151,1411,136,1406,135"/>
<area shape="rect" href="component__fuzzer_8cpp.html" title=" " alt="" coords="2101,181,2273,221"/>
<area shape="poly" title=" " alt="" coords="1407,130,1412,131,1602,148,1751,154,1900,160,2090,179,2101,180,2101,186,2090,184,1899,165,1751,159,1602,153,1411,136,1406,135"/>
<area shape="rect" href="container_8cpp.html" title=" " alt="" coords="704,181,855,221"/>
<area shape="poly" title=" " alt="" coords="1201,131,1043,154,866,184,855,186,854,181,866,179,1042,149,1200,126"/>
<area shape="poly" title=" " alt="" coords="1201,125,967,148,692,184,681,186,680,181,691,179,967,142,1200,120"/>
<area shape="poly" title=" " alt="" coords="1407,130,1412,131,1544,143,1657,149,1849,152,2041,155,2154,164,2286,179,2298,180,2297,186,2286,184,2153,169,2041,161,1849,157,1657,155,1544,149,1411,136,1406,135"/>
<area shape="rect" href="maybe_8cpp.html" title=" " alt="" coords="879,181,1029,221"/>
<area shape="poly" title=" " alt="" coords="1214,139,1031,184,1029,179,1213,134"/>
<area shape="poly" title=" " alt="" coords="1407,125,1462,131,1614,141,1743,146,1962,147,2181,152,2310,162,2461,179,2472,180,2471,186,2460,184,2309,167,2181,157,1962,152,1743,151,1614,146,1462,136,1406,130"/>
<area shape="poly" title=" " alt="" coords="1407,122,1513,131,1684,140,1829,143,2075,143,2194,144,2321,149,2466,160,2636,179,2647,180,2646,186,2635,184,2465,165,2321,154,2194,150,2075,149,1829,148,1684,145,1512,136,1406,127"/>
<area shape="rect" href="renderer_8cpp.html" title=" " alt="" coords="1053,181,1204,221"/>
<area shape="poly" title=" " alt="" coords="1254,142,1168,184,1166,179,1252,137"/>
<area shape="rect" href="resizable__split_8cpp.html" title=" " alt="" coords="1228,181,1379,221"/>
<area shape="poly" title=" " alt="" coords="1306,147,1306,181,1301,181,1301,147"/>
<area shape="rect" href="slider_8cpp.html" title=" " alt="" coords="1403,181,1553,221"/>
<area shape="poly" title=" " alt="" coords="1355,137,1441,179,1439,184,1353,142"/>
<area shape="rect" href="component_2util_8cpp.html" title=" " alt="" coords="1577,181,1728,221"/>
<area shape="poly" title=" " alt="" coords="1394,134,1577,179,1576,184,1392,139"/>
</map>
</div>
</div>
<p><a href="component__options_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structftxui_1_1EntryState" id="r_structftxui_1_1EntryState"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#structftxui_1_1EntryState">EntryState</a></td></tr>
<tr class="memdesc:structftxui_1_1EntryState"><td class="mdescLeft">&#160;</td><td class="mdescRight">arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform|. <a href="namespaceftxui.html#structftxui_1_1EntryState">More...</a><br /></td></tr>
<tr class="separator:structftxui_1_1EntryState"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1UnderlineOption.html">UnderlineOption</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1AnimatedColorOption.html">AnimatedColorOption</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option about a potentially animated color. <a href="structftxui_1_1AnimatedColorOption.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structftxui_1_1AnimatedColorsOption" id="r_structftxui_1_1AnimatedColorsOption"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#structftxui_1_1AnimatedColorsOption">AnimatedColorsOption</a></td></tr>
<tr class="separator:structftxui_1_1AnimatedColorsOption"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structftxui_1_1MenuEntryOption" id="r_structftxui_1_1MenuEntryOption"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#structftxui_1_1MenuEntryOption">MenuEntryOption</a></td></tr>
<tr class="memdesc:structftxui_1_1MenuEntryOption"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for the MenuEntry component. <a href="namespaceftxui.html#structftxui_1_1MenuEntryOption">More...</a><br /></td></tr>
<tr class="separator:structftxui_1_1MenuEntryOption"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for the Menu component. <a href="structftxui_1_1MenuOption.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1ButtonOption.html">ButtonOption</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for the AnimatedButton component. <a href="structftxui_1_1ButtonOption.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1CheckboxOption.html">CheckboxOption</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for the Checkbox component. <a href="structftxui_1_1CheckboxOption.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structftxui_1_1InputOption" id="r_structftxui_1_1InputOption"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#structftxui_1_1InputOption">InputOption</a></td></tr>
<tr class="memdesc:structftxui_1_1InputOption"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for the Input component. <a href="namespaceftxui.html#structftxui_1_1InputOption">More...</a><br /></td></tr>
<tr class="separator:structftxui_1_1InputOption"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1RadioboxOption.html">RadioboxOption</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for the Radiobox component. <a href="structftxui_1_1RadioboxOption.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html">ftxui</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structftxui_1_1EntryState" id="structftxui_1_1EntryState"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1EntryState">&#9670;&#160;</a></span>ftxui::EntryState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ftxui::EntryState</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a name="structftxui_1_1AnimatedColorsOption" id="structftxui_1_1AnimatedColorsOption"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1AnimatedColorsOption">&#9670;&#160;</a></span>ftxui::AnimatedColorsOption</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ftxui::AnimatedColorsOption</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a name="structftxui_1_1MenuEntryOption" id="structftxui_1_1MenuEntryOption"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1MenuEntryOption">&#9670;&#160;</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>
</div>
<a name="structftxui_1_1InputOption" id="structftxui_1_1InputOption"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1InputOption">&#9670;&#160;</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>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
<script>
document.addEventListener('DOMContentLoaded', function() {
const projectNumber = document.getElementById('projectnumber');
if (!projectNumber) {
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
return;
}
const versions = ["main", "v6.1.9", "v6.1.8", "v6.1.7", "v6.1.6", "v6.1.5", "v6.1.4", "v6.1.3", "v6.1.2", "v6.1.1", "v6.1.0", "v6.0.2", "v6.0.1", "v6.0.0", "v5.0.0", "v4.1.1", "v4.1.0", "v4.0.0", "v3.0.0", "v2.0.0", "v0.9", "v0.11", "v0.10"];
const version_paths = {"main": "../../index.html", "v6.1.9": "../v6.1.9/index.html", "v6.1.8": "../v6.1.8/index.html", "v6.1.7": "../v6.1.7/index.html", "v6.1.6": "../v6.1.6/index.html", "v6.1.5": "../v6.1.5/index.html", "v6.1.4": "../v6.1.4/index.html", "v6.1.3": "../v6.1.3/index.html", "v6.1.2": "../v6.1.2/index.html", "v6.1.1": "../v6.1.1/index.html", "v6.1.0": "../v6.1.0/index.html", "v6.0.2": "../v6.0.2/index.html", "v6.0.1": "../v6.0.1/index.html", "v6.0.0": "../v6.0.0/index.html", "v5.0.0": "../v5.0.0/index.html", "v4.1.1": "../v4.1.1/index.html", "v4.1.0": "../v4.1.0/index.html", "v4.0.0": "../v4.0.0/index.html", "v3.0.0": "index.html", "v2.0.0": "../v2.0.0/index.html", "v0.9": "../v0.9/index.html", "v0.11": "../v0.11/index.html", "v0.10": "../v0.10/index.html"};
const currentVersion = "v3.0.0";
// Sort versions: 'main' first, then others numerically descending.
versions.sort((a, b) => {
if (a === 'main') return -1;
if (b === 'main') return 1;
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
});
const select = document.createElement('select');
select.onchange = function() {
const selectedVersion = this.value;
// Navigate directly to the pre-calculated relative path.
if (selectedVersion !== currentVersion) {
window.location.href = version_paths[selectedVersion];
}
};
versions.forEach(v => {
const option = document.createElement('option');
option.value = v;
option.textContent = v;
if (v === currentVersion) {
option.selected = true;
}
select.appendChild(option);
});
// Replace the Doxygen project number element with our dropdown.
projectNumber.replaceWith(select);
// Apply some styling to make it look good.
Object.assign(select.style, {
backgroundColor: 'rgba(0, 0, 0, 0.8)',
color: 'white',
border: '1px solid rgba(255, 255, 255, 0.2)',
padding: '5px',
borderRadius: '5px',
fontSize: '14px',
fontFamily: 'inherit',
marginLeft: '10px',
cursor: 'pointer'
});
});
</script>
</body>
</html>