Files
FTXUI/en/v6.1.0/examples_2component_2scrollbar_8cpp-example.html
2025-11-12 12:56:59 +00:00

295 lines
21 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: examples/component/scrollbar.cpp</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">6.1.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('examples_2component_2scrollbar_8cpp-example.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="headertitle"><div class="title">examples/component/scrollbar.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><span class="comment">// Copyright 2023 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">#include &lt;<a class="code" href="component_8hpp.html">ftxui/component/component.hpp</a>&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="screen__interactive_8hpp.html">ftxui/component/screen_interactive.hpp</a>&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>;</div>
<div class="line"> </div>
<div class="line"><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> DummyWindowContent() {</div>
<div class="line"> <span class="keyword">class </span>Impl : <span class="keyword">public</span> <a id="_a0" name="_a0"></a><a class="code hl_class" href="classftxui_1_1ComponentBase.html">ComponentBase</a> {</div>
<div class="line"> <span class="keyword">private</span>:</div>
<div class="line"> <span class="keywordtype">float</span> scroll_x = 0.1;</div>
<div class="line"> <span class="keywordtype">float</span> scroll_y = 0.1;</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">public</span>:</div>
<div class="line"> Impl() {</div>
<div class="line"> <span class="keyword">auto</span> content = Renderer([=] {</div>
<div class="line"> <span class="keyword">const</span> std::string lorem =</div>
<div class="line"> <span class="stringliteral">&quot;Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;do eiusmod tempor incididunt ut labore et dolore magna &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;aliqua. Ut enim ad minim veniam, quis nostrud exercitation &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;aute irure dolor in reprehenderit in voluptate velit esse &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;cillum dolore eu fugiat nulla pariatur. Excepteur sint &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;occaecat cupidatat non proident, sunt in culpa qui officia &quot;</span></div>
<div class="line"> <span class="stringliteral">&quot;deserunt mollit anim id est laborum.&quot;</span>;</div>
<div class="line"> <span class="keywordflow">return</span> vbox({</div>
<div class="line"> text(lorem.substr(0, -1)), text(lorem.substr(5, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(10, -1)), text(lorem.substr(15, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(20, -1)), text(lorem.substr(25, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(30, -1)), text(lorem.substr(35, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(40, -1)), text(lorem.substr(45, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(50, -1)), text(lorem.substr(55, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(60, -1)), text(lorem.substr(65, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(70, -1)), text(lorem.substr(75, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(80, -1)), text(lorem.substr(85, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(90, -1)), text(lorem.substr(95, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(100, -1)), text(lorem.substr(105, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(110, -1)), text(lorem.substr(115, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(120, -1)), text(lorem.substr(125, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(130, -1)), text(lorem.substr(135, -1)), text(<span class="stringliteral">&quot;&quot;</span>),</div>
<div class="line"> text(lorem.substr(140, -1)),</div>
<div class="line"> });</div>
<div class="line"> });</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">auto</span> scrollable_content = Renderer(content, [&amp;, content] {</div>
<div class="line"> <span class="keywordflow">return</span> content-&gt;Render() | focusPositionRelative(scroll_x, scroll_y) |</div>
<div class="line"> frame | flex;</div>
<div class="line"> });</div>
<div class="line"> </div>
<div class="line"> <a id="_a1" name="_a1"></a><a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1SliderOption">SliderOption&lt;float&gt;</a> option_x;</div>
<div class="line"> option_x.<a id="a2" name="a2"></a><a class="code hl_variable" href="namespaceftxui.html#ab256d6c86a100045ed2329da289dce3a">value</a> = &amp;scroll_x;</div>
<div class="line"> option_x.min = 0.f;</div>
<div class="line"> option_x.max = 1.f;</div>
<div class="line"> option_x.increment = 0.1f;</div>
<div class="line"> option_x.direction = Direction::Right;</div>
<div class="line"> option_x.color_active = Color::Blue;</div>
<div class="line"> option_x.color_inactive = Color::BlueLight;</div>
<div class="line"> <span class="keyword">auto</span> scrollbar_x = Slider(option_x);</div>
<div class="line"> </div>
<div class="line"> <a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1SliderOption">SliderOption&lt;float&gt;</a> option_y;</div>
<div class="line"> option_y.<a class="code hl_variable" href="namespaceftxui.html#ab256d6c86a100045ed2329da289dce3a">value</a> = &amp;scroll_y;</div>
<div class="line"> option_y.<a id="a3" name="a3"></a><a class="code hl_variable" href="namespaceftxui.html#a337a8e502154b70ef2a1d4bb3cb47ea9">min</a> = 0.f;</div>
<div class="line"> option_y.<a id="a4" name="a4"></a><a class="code hl_variable" href="namespaceftxui.html#abd146f0de5789f02aee07c54e819099b">max</a> = 1.f;</div>
<div class="line"> option_y.<a id="a5" name="a5"></a><a class="code hl_variable" href="namespaceftxui.html#a752366b00bdf7bba57a18e239e86e2e1">increment</a> = 0.1f;</div>
<div class="line"> option_y.<a id="a6" name="a6"></a><a class="code hl_variable" href="namespaceftxui.html#a53421c695d00016ab925777d423b4eb6">direction</a> = Direction::Down;</div>
<div class="line"> option_y.<a id="a7" name="a7"></a><a class="code hl_variable" href="namespaceftxui.html#a593f1ba15add21d1972c01372db369df">color_active</a> = Color::Yellow;</div>
<div class="line"> option_y.<a id="a8" name="a8"></a><a class="code hl_variable" href="namespaceftxui.html#ad5a77e0bc0ce649271a13949a7a0a635">color_inactive</a> = Color::YellowLight;</div>
<div class="line"> <span class="keyword">auto</span> scrollbar_y = Slider(option_y);</div>
<div class="line"> </div>
<div class="line"> Add(Container::Vertical({</div>
<div class="line"> Container::Horizontal({</div>
<div class="line"> scrollable_content,</div>
<div class="line"> scrollbar_y,</div>
<div class="line"> }) | flex,</div>
<div class="line"> Container::Horizontal({</div>
<div class="line"> scrollbar_x,</div>
<div class="line"> Renderer([] { <span class="keywordflow">return</span> text(L<span class="stringliteral">&quot;x&quot;</span>); }),</div>
<div class="line"> }),</div>
<div class="line"> }));</div>
<div class="line"> }</div>
<div class="line"> };</div>
<div class="line"> <span class="keywordflow">return</span> Make&lt;Impl&gt;();</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main() {</div>
<div class="line"> <span class="keyword">auto</span> window_1 = Window({</div>
<div class="line"> .inner = DummyWindowContent(),</div>
<div class="line"> .title = <span class="stringliteral">&quot;First window&quot;</span>,</div>
<div class="line"> .width = 80,</div>
<div class="line"> .height = 30,</div>
<div class="line"> });</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">auto</span> window_2 = <a class="code hl_function" href="namespaceftxui.html#a638693abef9289912f5fa39606390b20">Window</a>({</div>
<div class="line"> .inner = DummyWindowContent(),</div>
<div class="line"> .title = <span class="stringliteral">&quot;My window&quot;</span>,</div>
<div class="line"> .left = 40,</div>
<div class="line"> .top = 20,</div>
<div class="line"> .width = 80,</div>
<div class="line"> .height = 30,</div>
<div class="line"> });</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">auto</span> window_container = Container::Stacked({</div>
<div class="line"> window_1,</div>
<div class="line"> window_2,</div>
<div class="line"> });</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">auto</span> screen = ScreenInteractive::Fullscreen();</div>
<div class="line"> screen.Loop(window_container);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> EXIT_SUCCESS;</div>
<div class="line">}</div>
<div class="ttc" id="aclassftxui_1_1ComponentBase_html"><div class="ttname"><a href="classftxui_1_1ComponentBase.html">ftxui::ComponentBase</a></div><div class="ttdoc">It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...</div><div class="ttdef"><b>Definition</b> <a href="component__base_8hpp_source.html#l00030">component_base.hpp:30</a></div></div>
<div class="ttc" id="acomponent_8hpp_html"><div class="ttname"><a href="component_8hpp.html">component.hpp</a></div></div>
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></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_a337a8e502154b70ef2a1d4bb3cb47ea9"><div class="ttname"><a href="namespaceftxui.html#a337a8e502154b70ef2a1d4bb3cb47ea9">ftxui::SliderOption::min</a></div><div class="ttdeci">ConstRef&lt; T &gt; min</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00225">component_options.hpp:225</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a53421c695d00016ab925777d423b4eb6"><div class="ttname"><a href="namespaceftxui.html#a53421c695d00016ab925777d423b4eb6">ftxui::SliderOption::direction</a></div><div class="ttdeci">Direction direction</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00228">component_options.hpp:228</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a593f1ba15add21d1972c01372db369df"><div class="ttname"><a href="namespaceftxui.html#a593f1ba15add21d1972c01372db369df">ftxui::SliderOption::color_active</a></div><div class="ttdeci">Color color_active</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00229">component_options.hpp:229</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a638693abef9289912f5fa39606390b20"><div class="ttname"><a href="namespaceftxui.html#a638693abef9289912f5fa39606390b20">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="window_8cpp_source.html#l00312">window.cpp:312</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a752366b00bdf7bba57a18e239e86e2e1"><div class="ttname"><a href="namespaceftxui.html#a752366b00bdf7bba57a18e239e86e2e1">ftxui::SliderOption::increment</a></div><div class="ttdeci">ConstRef&lt; T &gt; increment</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00227">component_options.hpp:227</a></div></div>
<div class="ttc" id="anamespaceftxui_html_ab256d6c86a100045ed2329da289dce3a"><div class="ttname"><a href="namespaceftxui.html#ab256d6c86a100045ed2329da289dce3a">ftxui::SliderOption::value</a></div><div class="ttdeci">Ref&lt; T &gt; value</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00224">component_options.hpp:224</a></div></div>
<div class="ttc" id="anamespaceftxui_html_abd146f0de5789f02aee07c54e819099b"><div class="ttname"><a href="namespaceftxui.html#abd146f0de5789f02aee07c54e819099b">ftxui::SliderOption::max</a></div><div class="ttdeci">ConstRef&lt; T &gt; max</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00226">component_options.hpp:226</a></div></div>
<div class="ttc" id="anamespaceftxui_html_ad5a77e0bc0ce649271a13949a7a0a635"><div class="ttname"><a href="namespaceftxui.html#ad5a77e0bc0ce649271a13949a7a0a635">ftxui::SliderOption::color_inactive</a></div><div class="ttdeci">Color color_inactive</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00230">component_options.hpp:230</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&lt; ComponentBase &gt; 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_structftxui_1_1SliderOption"><div class="ttname"><a href="namespaceftxui.html#structftxui_1_1SliderOption">ftxui::SliderOption</a></div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00223">component_options.hpp:223</a></div></div>
<div class="ttc" id="ascreen__interactive_8hpp_html"><div class="ttname"><a href="screen__interactive_8hpp.html">screen_interactive.hpp</a></div></div>
</div><!-- fragment --> </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": "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": "../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.1.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>