mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
572 lines
33 KiB
HTML
572 lines
33 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: MenuOption Struct 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>
|
|
<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="text/javascript">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
window.addEventListener('DOMContentLoaded', function () {
|
|
document.querySelectorAll(".headertitle").forEach(div => {
|
|
// Hide progressively the title.
|
|
if (div.textContent != "Getting Started" &&
|
|
div.textContent != "Installation" &&
|
|
div.textContent != "Modules" &&
|
|
true) {
|
|
return;
|
|
}
|
|
div.style.display = "none";
|
|
// Show progressively the image.
|
|
const img = document.querySelector("img.inline");
|
|
img.style.maxHeight = "40vh";
|
|
img.style.maxWidth = "100%";
|
|
img.style.objectFit = "contain";
|
|
});
|
|
});
|
|
</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('structftxui_1_1MenuOption.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="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">MenuOption Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Option for the Menu component.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>></code></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for MenuOption:</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="structftxui_1_1MenuOption__coll__graph.png" border="0" usemap="#aMenuOption_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aMenuOption_coll__map" id="aMenuOption_coll__map">
|
|
<area shape="rect" title="Option for the Menu component." alt="" coords="226,401,327,427"/>
|
|
<area shape="rect" href="classftxui_1_1ConstStringListRef.html" title="An adapter. Reference a list of strings." alt="" coords="5,299,148,324"/>
|
|
<area shape="poly" title=" " alt="" coords="100,332,127,354,159,375,193,389,227,400,225,405,191,394,157,380,124,359,97,336"/>
|
|
<area shape="rect" href="classftxui_1_1Ref.html" title=" " alt="" coords="173,299,263,324"/>
|
|
<area shape="poly" title=" " alt="" coords="216,337,216,357,222,376,233,389,248,399,245,403,229,393,217,379,211,358,210,337"/>
|
|
<area shape="rect" href="structftxui_1_1UnderlineOption.html" title=" " alt="" coords="271,159,399,185"/>
|
|
<area shape="poly" title=" " alt="" coords="341,198,344,235,343,281,336,331,319,379,309,392,297,403,293,399,305,389,314,376,331,330,338,281,339,235,336,199"/>
|
|
<area shape="rect" href="classftxui_1_1Color.html" title="A class representing terminal colors." alt="" coords="369,5,425,31"/>
|
|
<area shape="poly" title=" " alt="" coords="358,35,344,44,334,56,324,82,324,111,334,159,328,160,318,111,319,81,329,53,340,40,355,30"/>
|
|
<area shape="rect" href="structftxui_1_1AnimatedColorOption.html" title="Option about a potentially animated color." alt="" coords="377,108,539,133"/>
|
|
<area shape="poly" title=" " alt="" coords="420,39,431,53,446,82,456,107,452,109,441,84,426,56,416,43"/>
|
|
<area shape="rect" href="structftxui_1_1MenuEntryOption.html" title="Option for the MenuEntry component." alt="" coords="391,299,525,324"/>
|
|
<area shape="poly" title=" " alt="" coords="431,334,355,380,305,404,303,399,353,375,428,330"/>
|
|
<area shape="rect" href="classftxui_1_1ConstStringRef.html" title="An adapter. Own or reference a constant string. For convenience, this class convert multiple immutabl..." alt="" coords="580,211,699,236"/>
|
|
<area shape="poly" title=" " alt="" coords="620,247,578,277,546,291,513,301,511,296,544,286,575,272,616,243"/>
|
|
<area shape="rect" href="classftxui_1_1ConstRef.html" title=" " alt="" coords="563,108,739,133"/>
|
|
<area shape="poly" title=" " alt="" coords="651,148,643,211,638,210,646,147"/>
|
|
<area shape="rect" href="structftxui_1_1AnimatedColorsOption.html" title=" " alt="" coords="373,211,543,236"/>
|
|
<area shape="poly" title=" " alt="" coords="461,250,461,298,455,298,455,250"/>
|
|
<area shape="poly" title=" " alt="" coords="461,147,461,211,455,211,455,147"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a5ee36f528383cc1db765fa2140797837" id="r_a5ee36f528383cc1db765fa2140797837"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ee36f528383cc1db765fa2140797837">Horizontal</a> ()</td></tr>
|
|
<tr class="memdesc:a5ee36f528383cc1db765fa2140797837"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an horizontal menu. This can be useful to implement a tab bar. <br /></td></tr>
|
|
<tr class="separator:a5ee36f528383cc1db765fa2140797837"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedc93fba91339d9713812821cb140c50" id="r_aedc93fba91339d9713812821cb140c50"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aedc93fba91339d9713812821cb140c50">HorizontalAnimated</a> ()</td></tr>
|
|
<tr class="memdesc:aedc93fba91339d9713812821cb140c50"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an animated horizontal menu. This can be useful to implement a tab bar. <br /></td></tr>
|
|
<tr class="separator:aedc93fba91339d9713812821cb140c50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a617c59fdb94db99100d0e7a569c31d75" id="r_a617c59fdb94db99100d0e7a569c31d75"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a617c59fdb94db99100d0e7a569c31d75">Vertical</a> ()</td></tr>
|
|
<tr class="memdesc:a617c59fdb94db99100d0e7a569c31d75"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a vertical menu. This can be useful to implement a list of selectable items. <br /></td></tr>
|
|
<tr class="separator:a617c59fdb94db99100d0e7a569c31d75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6079a7637256d70b30aacb92d2034205" id="r_a6079a7637256d70b30aacb92d2034205"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6079a7637256d70b30aacb92d2034205">VerticalAnimated</a> ()</td></tr>
|
|
<tr class="memdesc:a6079a7637256d70b30aacb92d2034205"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for an animated vertical menu. This can be useful to implement a list of selectable items. <br /></td></tr>
|
|
<tr class="separator:a6079a7637256d70b30aacb92d2034205"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a133a8caaf0246db0902f7abce37a9b6d" id="r_a133a8caaf0246db0902f7abce37a9b6d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a133a8caaf0246db0902f7abce37a9b6d">Toggle</a> ()</td></tr>
|
|
<tr class="memdesc:a133a8caaf0246db0902f7abce37a9b6d"><td class="mdescLeft"> </td><td class="mdescRight">Standard options for a horitontal menu with some separator. This can be useful to implement a tab bar. <br /></td></tr>
|
|
<tr class="separator:a133a8caaf0246db0902f7abce37a9b6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a7b534b117dbbe826d34ba17af85f1e93" id="r_a7b534b117dbbe826d34ba17af85f1e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b534b117dbbe826d34ba17af85f1e93">entries</a></td></tr>
|
|
<tr class="separator:a7b534b117dbbe826d34ba17af85f1e93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac42a32c3439d08be9c5626a5fbc3a0c4" id="r_ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac42a32c3439d08be9c5626a5fbc3a0c4">selected</a> = 0</td></tr>
|
|
<tr class="separator:ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55b558727e02acce3f5259811b2dfe5b" id="r_a55b558727e02acce3f5259811b2dfe5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1UnderlineOption.html">UnderlineOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a55b558727e02acce3f5259811b2dfe5b">underline</a></td></tr>
|
|
<tr class="separator:a55b558727e02acce3f5259811b2dfe5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2076e7253c5acce2321c067e9b7a1823" id="r_a2076e7253c5acce2321c067e9b7a1823"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1MenuEntryOption.html">MenuEntryOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2076e7253c5acce2321c067e9b7a1823">entries_option</a></td></tr>
|
|
<tr class="separator:a2076e7253c5acce2321c067e9b7a1823"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53421c695d00016ab925777d423b4eb6" id="r_a53421c695d00016ab925777d423b4eb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a53421c695d00016ab925777d423b4eb6">direction</a> = <a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aaa08a38277b0309070706f6652eeae9a53">Direction::Down</a></td></tr>
|
|
<tr class="separator:a53421c695d00016ab925777d423b4eb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11476ea3dc58bf17777879693fb2985a" id="r_a11476ea3dc58bf17777879693fb2985a"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a11476ea3dc58bf17777879693fb2985a">elements_prefix</a></td></tr>
|
|
<tr class="separator:a11476ea3dc58bf17777879693fb2985a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9504d8d3bfa1daaab000e5455536b20d" id="r_a9504d8d3bfa1daaab000e5455536b20d"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9504d8d3bfa1daaab000e5455536b20d">elements_infix</a></td></tr>
|
|
<tr class="separator:a9504d8d3bfa1daaab000e5455536b20d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab08362a5698543aec0fbb37f99777119" id="r_ab08362a5698543aec0fbb37f99777119"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab08362a5698543aec0fbb37f99777119">elements_postfix</a></td></tr>
|
|
<tr class="separator:ab08362a5698543aec0fbb37f99777119"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a></td></tr>
|
|
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ba9530701be07334a17c0184747c535" id="r_a4ba9530701be07334a17c0184747c535"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ba9530701be07334a17c0184747c535">on_enter</a></td></tr>
|
|
<tr class="separator:a4ba9530701be07334a17c0184747c535"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93d5d37708b77971a666b73486017835" id="r_a93d5d37708b77971a666b73486017835"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a93d5d37708b77971a666b73486017835">focused_entry</a> = 0</td></tr>
|
|
<tr class="separator:a93d5d37708b77971a666b73486017835"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Option for the Menu component. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2maybe_8cpp-example.html#_a1">examples/component/maybe.cpp</a>, <a class="el" href="examples_2component_2menu_8cpp-example.html#_a1">examples/component/menu.cpp</a>, and <a class="el" href="examples_2component_2menu2_8cpp-example.html#_a6">examples/component/menu2.cpp</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00084">84</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a5ee36f528383cc1db765fa2140797837" name="a5ee36f528383cc1db765fa2140797837"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ee36f528383cc1db765fa2140797837">◆ </a></span>Horizontal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> Horizontal </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Standard options for an horizontal menu. This can be useful to implement a tab bar. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00075">75</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aedc93fba91339d9713812821cb140c50" name="aedc93fba91339d9713812821cb140c50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aedc93fba91339d9713812821cb140c50">◆ </a></span>HorizontalAnimated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> HorizontalAnimated </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Standard options for an animated horizontal menu. This can be useful to implement a tab bar. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00100">100</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a617c59fdb94db99100d0e7a569c31d75" name="a617c59fdb94db99100d0e7a569c31d75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a617c59fdb94db99100d0e7a569c31d75">◆ </a></span>Vertical()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> Vertical </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Standard options for a vertical menu. This can be useful to implement a list of selectable items. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00110">110</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6079a7637256d70b30aacb92d2034205" name="a6079a7637256d70b30aacb92d2034205"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6079a7637256d70b30aacb92d2034205">◆ </a></span>VerticalAnimated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> VerticalAnimated </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Standard options for an animated vertical menu. This can be useful to implement a list of selectable items. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00132">132</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a133a8caaf0246db0902f7abce37a9b6d" name="a133a8caaf0246db0902f7abce37a9b6d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a133a8caaf0246db0902f7abce37a9b6d">◆ </a></span>Toggle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a> Toggle </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Standard options for a horitontal menu with some separator. This can be useful to implement a tab bar. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00155">155</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a7b534b117dbbe826d34ba17af85f1e93" name="a7b534b117dbbe826d34ba17af85f1e93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b534b117dbbe826d34ba17af85f1e93">◆ </a></span>entries</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00092">92</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac42a32c3439d08be9c5626a5fbc3a0c4" name="ac42a32c3439d08be9c5626a5fbc3a0c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac42a32c3439d08be9c5626a5fbc3a0c4">◆ </a></span>selected</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> selected = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<blockquote class="doxtable">
|
|
<p>‍The list of entries. </p>
|
|
</blockquote>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00093">93</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55b558727e02acce3f5259811b2dfe5b" name="a55b558727e02acce3f5259811b2dfe5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55b558727e02acce3f5259811b2dfe5b">◆ </a></span>underline</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1UnderlineOption.html">UnderlineOption</a> underline</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<blockquote class="doxtable">
|
|
<p>‍The index of the selected entry. </p>
|
|
</blockquote>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00096">96</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2076e7253c5acce2321c067e9b7a1823" name="a2076e7253c5acce2321c067e9b7a1823"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2076e7253c5acce2321c067e9b7a1823">◆ </a></span>entries_option</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structftxui_1_1MenuEntryOption.html">MenuEntryOption</a> entries_option</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00097">97</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53421c695d00016ab925777d423b4eb6" name="a53421c695d00016ab925777d423b4eb6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53421c695d00016ab925777d423b4eb6">◆ </a></span>direction</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> direction = <a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aaa08a38277b0309070706f6652eeae9a53">Direction::Down</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00098">98</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a11476ea3dc58bf17777879693fb2985a" name="a11476ea3dc58bf17777879693fb2985a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11476ea3dc58bf17777879693fb2985a">◆ </a></span>elements_prefix</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> elements_prefix</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00099">99</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9504d8d3bfa1daaab000e5455536b20d" name="a9504d8d3bfa1daaab000e5455536b20d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9504d8d3bfa1daaab000e5455536b20d">◆ </a></span>elements_infix</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> elements_infix</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00100">100</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab08362a5698543aec0fbb37f99777119" name="ab08362a5698543aec0fbb37f99777119"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab08362a5698543aec0fbb37f99777119">◆ </a></span>elements_postfix</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> elements_postfix</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00101">101</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abdfe3c83deeec2323ff90248815b8f0a" name="abdfe3c83deeec2323ff90248815b8f0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abdfe3c83deeec2323ff90248815b8f0a">◆ </a></span>on_change</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<void()> on_change</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00104">104</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ba9530701be07334a17c0184747c535" name="a4ba9530701be07334a17c0184747c535"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ba9530701be07334a17c0184747c535">◆ </a></span>on_enter</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<void()> on_enter</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<blockquote class="doxtable">
|
|
<p>‍Called when the selected entry changes. </p>
|
|
</blockquote>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2maybe_8cpp-example.html#a2">examples/component/maybe.cpp</a>, and <a class="el" href="examples_2component_2menu_8cpp-example.html#a2">examples/component/menu.cpp</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00105">105</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a93d5d37708b77971a666b73486017835" name="a93d5d37708b77971a666b73486017835"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a93d5d37708b77971a666b73486017835">◆ </a></span>focused_entry</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> focused_entry = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<blockquote class="doxtable">
|
|
<p>‍Called when the user presses enter. </p>
|
|
</blockquote>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00106">106</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li><a class="el" href="component__options_8hpp_source.html">component_options.hpp</a></li>
|
|
<li><a class="el" href="component__options_8cpp_source.html">component_options.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.9.8-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="structftxui_1_1MenuOption.html">MenuOption</a></li>
|
|
<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>
|