mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-11-15 11:38:56 +08:00
433 lines
26 KiB
HTML
433 lines
26 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: ftxui::Container Namespace 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
|
|
 <span id="projectnumber">6.0.2</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('namespaceftxui_1_1Container.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="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">ftxui::Container Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a6471e39f5664d059144746c5801d37e6" id="r_a6471e39f5664d059144746c5801d37e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6471e39f5664d059144746c5801d37e6">Vertical</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
|
<tr class="memdesc:a6471e39f5664d059144746c5801d37e6"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. <br /></td></tr>
|
|
<tr class="separator:a6471e39f5664d059144746c5801d37e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25099e2d2ead8a46c8d9a899982070b7" id="r_a25099e2d2ead8a46c8d9a899982070b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a25099e2d2ead8a46c8d9a899982070b7">Vertical</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
|
<tr class="memdesc:a25099e2d2ead8a46c8d9a899982070b7"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. <br /></td></tr>
|
|
<tr class="separator:a25099e2d2ead8a46c8d9a899982070b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01563bae9454fe64c0b29b0eb3755e68" id="r_a01563bae9454fe64c0b29b0eb3755e68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a01563bae9454fe64c0b29b0eb3755e68">Horizontal</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
|
<tr class="memdesc:a01563bae9454fe64c0b29b0eb3755e68"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. <br /></td></tr>
|
|
<tr class="separator:a01563bae9454fe64c0b29b0eb3755e68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a337564f8a13c98222025d8fe7e47df4c" id="r_a337564f8a13c98222025d8fe7e47df4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a337564f8a13c98222025d8fe7e47df4c">Horizontal</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
|
<tr class="memdesc:a337564f8a13c98222025d8fe7e47df4c"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. <br /></td></tr>
|
|
<tr class="separator:a337564f8a13c98222025d8fe7e47df4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea9fe244eeeb420276bcc5760b46953d" id="r_aea9fe244eeeb420276bcc5760b46953d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aea9fe244eeeb420276bcc5760b46953d">Tab</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children, int *selector)</td></tr>
|
|
<tr class="memdesc:aea9fe244eeeb420276bcc5760b46953d"><td class="mdescLeft"> </td><td class="mdescRight">A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. <br /></td></tr>
|
|
<tr class="separator:aea9fe244eeeb420276bcc5760b46953d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafd394665b0c231380a143b810339d8e" id="r_aafd394665b0c231380a143b810339d8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aafd394665b0c231380a143b810339d8e">Stacked</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
|
<tr class="memdesc:aafd394665b0c231380a143b810339d8e"><td class="mdescLeft"> </td><td class="mdescRight">A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. <br /></td></tr>
|
|
<tr class="separator:aafd394665b0c231380a143b810339d8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a6471e39f5664d059144746c5801d37e6" name="a6471e39f5664d059144746c5801d37e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6471e39f5664d059144746c5801d37e6">◆ </a></span>Vertical() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Vertical </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">children</td><td>the list of components.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
|
<h3><a class="anchor" id="autotoc_md10"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#a6471e39f5664d059144746c5801d37e6">Container::Vertical</a>({</div>
|
|
<div class="line"> children_1,</div>
|
|
<div class="line"> children_2,</div>
|
|
<div class="line"> children_3,</div>
|
|
<div class="line"> children_4,</div>
|
|
<div class="line">});</div>
|
|
<div class="ttc" id="anamespaceftxui_1_1Container_html_a6471e39f5664d059144746c5801d37e6"><div class="ttname"><a href="#a6471e39f5664d059144746c5801d37e6">ftxui::Container::Vertical</a></div><div class="ttdeci">Component Vertical(Components children)</div><div class="ttdoc">A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00317">container.cpp:317</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00317">317</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25099e2d2ead8a46c8d9a899982070b7" name="a25099e2d2ead8a46c8d9a899982070b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25099e2d2ead8a46c8d9a899982070b7">◆ </a></span>Vertical() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Vertical </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selector</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">children</td><td>the list of components. </td></tr>
|
|
<tr><td class="paramname">selector</td><td>A reference to the index of the selected children.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
|
<h3><a class="anchor" id="autotoc_md11"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#a6471e39f5664d059144746c5801d37e6">Container::Vertical</a>({</div>
|
|
<div class="line"> children_1,</div>
|
|
<div class="line"> children_2,</div>
|
|
<div class="line"> children_3,</div>
|
|
<div class="line"> children_4,</div>
|
|
<div class="line">}, &selected_children);</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00339">339</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a01563bae9454fe64c0b29b0eb3755e68" name="a01563bae9454fe64c0b29b0eb3755e68"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a01563bae9454fe64c0b29b0eb3755e68">◆ </a></span>Horizontal() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Horizontal </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">children</td><td>the list of components.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
|
<h3><a class="anchor" id="autotoc_md12"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> selected_children = 2;</div>
|
|
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#a01563bae9454fe64c0b29b0eb3755e68">Container::Horizontal</a>({</div>
|
|
<div class="line"> children_1,</div>
|
|
<div class="line"> children_2,</div>
|
|
<div class="line"> children_3,</div>
|
|
<div class="line"> children_4,</div>
|
|
<div class="line">});</div>
|
|
<div class="ttc" id="anamespaceftxui_1_1Container_html_a01563bae9454fe64c0b29b0eb3755e68"><div class="ttname"><a href="#a01563bae9454fe64c0b29b0eb3755e68">ftxui::Container::Horizontal</a></div><div class="ttdeci">Component Horizontal(Components children)</div><div class="ttdoc">A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00360">container.cpp:360</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00360">360</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a337564f8a13c98222025d8fe7e47df4c" name="a337564f8a13c98222025d8fe7e47df4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a337564f8a13c98222025d8fe7e47df4c">◆ </a></span>Horizontal() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Horizontal </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selector</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">children</td><td>the list of components. </td></tr>
|
|
<tr><td class="paramname">selector</td><td>A reference to the index of the selected children.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
|
<h3><a class="anchor" id="autotoc_md13"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> selected_children = 2;</div>
|
|
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#a01563bae9454fe64c0b29b0eb3755e68">Container::Horizontal</a>({</div>
|
|
<div class="line"> children_1,</div>
|
|
<div class="line"> children_2,</div>
|
|
<div class="line"> children_3,</div>
|
|
<div class="line"> children_4,</div>
|
|
<div class="line">}, selected_children);</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00382">382</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea9fe244eeeb420276bcc5760b46953d" name="aea9fe244eeeb420276bcc5760b46953d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea9fe244eeeb420276bcc5760b46953d">◆ </a></span>Tab()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Tab </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selector</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">children</td><td>The list of components. </td></tr>
|
|
<tr><td class="paramname">selector</td><td>The index of the drawn children.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>ContainerBase</dd></dl>
|
|
<h3><a class="anchor" id="autotoc_md14"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"><span class="keywordtype">int</span> tab_drawn = 0;</div>
|
|
<div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#aea9fe244eeeb420276bcc5760b46953d">Container::Tab</a>({</div>
|
|
<div class="line"> children_1,</div>
|
|
<div class="line"> children_2,</div>
|
|
<div class="line"> children_3,</div>
|
|
<div class="line"> children_4,</div>
|
|
<div class="line">}, &tab_drawn);</div>
|
|
<div class="ttc" id="anamespaceftxui_1_1Container_html_aea9fe244eeeb420276bcc5760b46953d"><div class="ttname"><a href="#aea9fe244eeeb420276bcc5760b46953d">ftxui::Container::Tab</a></div><div class="ttdeci">Component Tab(Components children, int *selector)</div><div class="ttdoc">A list of components, where only one is drawn and interacted with at a time. The |selector| gives the...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00405">container.cpp:405</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00405">405</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aafd394665b0c231380a143b810339d8e" name="aafd394665b0c231380a143b810339d8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafd394665b0c231380a143b810339d8e">◆ </a></span>Stacked()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> Stacked </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. </p>
|
|
<p>This should be used with the <code>Window</code> component.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">children</td><td>The list of components.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui.html#a638693abef9289912f5fa39606390b20" title="A draggeable / resizeable window. To use multiple of them, they must be stacked using Container::Stac...">Window</a></dd></dl>
|
|
<h3><a class="anchor" id="autotoc_md15"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> container = <a class="code hl_function" href="#aafd394665b0c231380a143b810339d8e">Container::Stacked</a>({</div>
|
|
<div class="line"> children_1,</div>
|
|
<div class="line"> children_2,</div>
|
|
<div class="line"> children_3,</div>
|
|
<div class="line"> children_4,</div>
|
|
<div class="line">});</div>
|
|
<div class="ttc" id="anamespaceftxui_1_1Container_html_aafd394665b0c231380a143b810339d8e"><div class="ttname"><a href="#aafd394665b0c231380a143b810339d8e">ftxui::Container::Stacked</a></div><div class="ttdeci">Component Stacked(Components children)</div><div class="ttdoc">A list of components to be stacked on top of each other. Events are propagated to the first component...</div><div class="ttdef"><b>Definition</b> <a href="container_8cpp_source.html#l00432">container.cpp:432</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="container_8cpp_source.html#l00432">432</a> of file <a class="el" href="container_8cpp_source.html">container.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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": "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": "../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 = "v6.0.2";
|
|
|
|
// 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>
|