mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
257 lines
18 KiB
HTML
257 lines
18 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: examples/component/composition.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>
|
||
|
|
<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()
|
||
|
|
</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('examples_2component_2composition_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/composition.cpp</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<h1><a class="anchor" id="autotoc_md170"></a>
|
||
|
|
custom_loop</h1>
|
||
|
|
<div class="fragment"><div class="line"><span class="comment">// Copyright 2020 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 <stdlib.h></span> <span class="comment">// for EXIT_SUCCESS</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <chrono></span> <span class="comment">// for milliseconds</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <<a class="code" href="event_8hpp.html">ftxui/component/event.hpp</a>></span> <span class="comment">// for Event</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <<a class="code" href="mouse_8hpp.html">ftxui/component/mouse.hpp</a>></span> <span class="comment">// for ftxui</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <<a class="code" href="elements_8hpp.html">ftxui/dom/elements.hpp</a>></span> <span class="comment">// for text, separator, Element, operator|, vbox, border</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <memory></span> <span class="comment">// for allocator, shared_ptr</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <string></span> <span class="comment">// for operator+, to_string</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <thread></span> <span class="comment">// for sleep_for</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="component_8hpp.html">ftxui/component/component.hpp</a>"</span> <span class="comment">// for CatchEvent, Renderer, operator|=</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="loop_8hpp.html">ftxui/component/loop.hpp</a>"</span> <span class="comment">// for Loop</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="screen__interactive_8hpp.html">ftxui/component/screen_interactive.hpp</a>"</span> <span class="comment">// for ScreenInteractive</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="keywordtype">int</span> <a id="a0" name="a0"></a><a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
||
|
|
<div class="line"> <span class="keyword">using namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>;</div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> screen = ScreenInteractive::FitComponent();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Create a component counting the number of frames drawn and event handled.</span></div>
|
||
|
|
<div class="line"> <span class="keywordtype">int</span> custom_loop_count = 0;</div>
|
||
|
|
<div class="line"> <span class="keywordtype">int</span> frame_count = 0;</div>
|
||
|
|
<div class="line"> <span class="keywordtype">int</span> event_count = 0;</div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> component = Renderer([&] {</div>
|
||
|
|
<div class="line"> frame_count++;</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> vbox({</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"This demonstrates using a custom ftxui::Loop. It "</span>),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"runs at 100 iterations per seconds. The FTXUI events "</span>),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"are all processed once per iteration and a new frame "</span>),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"is rendered as needed"</span>),</div>
|
||
|
|
<div class="line"> separator(),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"ftxui event count: "</span> + std::to_string(event_count)),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"ftxui frame count: "</span> + std::to_string(frame_count)),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"Custom loop count: "</span> + std::to_string(custom_loop_count)),</div>
|
||
|
|
<div class="line"> }) |</div>
|
||
|
|
<div class="line"> border;</div>
|
||
|
|
<div class="line"> });</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> component |= CatchEvent([&](<a id="_a1" name="_a1"></a><a class="code hl_struct" href="structftxui_1_1Event.html">Event</a>) -> <span class="keywordtype">bool</span> {</div>
|
||
|
|
<div class="line"> event_count++;</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||
|
|
<div class="line"> });</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <a id="_a2" name="_a2"></a><a class="code hl_class" href="classftxui_1_1Loop.html">Loop</a> loop(&screen, component);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">while</span> (!loop.HasQuitted()) {</div>
|
||
|
|
<div class="line"> custom_loop_count++;</div>
|
||
|
|
<div class="line"> loop.RunOnce();</div>
|
||
|
|
<div class="line"> std::this_thread::sleep_for(std::chrono::milliseconds(10));</div>
|
||
|
|
<div class="line"> }</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_1Loop_html"><div class="ttname"><a href="classftxui_1_1Loop.html">ftxui::Loop</a></div><div class="ttdef"><b>Definition</b> <a href="loop_8hpp_source.html#l00017">loop.hpp:17</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="aelements_8hpp_html"><div class="ttname"><a href="elements_8hpp.html">elements.hpp</a></div></div>
|
||
|
|
<div class="ttc" id="aevent_8hpp_html"><div class="ttname"><a href="event_8hpp.html">event.hpp</a></div></div>
|
||
|
|
<div class="ttc" id="aexamples_2component_2button_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="examples_2component_2button_8cpp_source.html#l00004">examples/component/button.cpp:4</a></div></div>
|
||
|
|
<div class="ttc" id="aloop_8hpp_html"><div class="ttname"><a href="loop_8hpp.html">loop.hpp</a></div></div>
|
||
|
|
<div class="ttc" id="amouse_8hpp_html"><div class="ttname"><a href="mouse_8hpp.html">mouse.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="ascreen__interactive_8hpp_html"><div class="ttname"><a href="screen__interactive_8hpp.html">screen_interactive.hpp</a></div></div>
|
||
|
|
<div class="ttc" id="astructftxui_1_1Event_html"><div class="ttname"><a href="structftxui_1_1Event.html">ftxui::Event</a></div><div class="ttdoc">Represent an event. It can be key press event, a terminal resize, or more ...</div><div class="ttdef"><b>Definition</b> <a href="event_8hpp_source.html#l00027">event.hpp:27</a></div></div>
|
||
|
|
</div><!-- fragment --><div class="fragment"><div class="line"><span class="comment">// Copyright 2021 Arthur Sonzogni. All rights reserved.</span></div>
|
||
|
|
<div class="line"><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
|
||
|
|
<div class="line"><span class="comment">// the LICENSE file.</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <memory></span> <span class="comment">// for allocator, shared_ptr, __shared_ptr_access</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <string></span> <span class="comment">// for operator+, to_string</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="captured__mouse_8hpp.html">ftxui/component/captured_mouse.hpp</a>"</span> <span class="comment">// for ftxui</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="component_8hpp.html">ftxui/component/component.hpp</a>"</span> <span class="comment">// for Button, Horizontal, Renderer</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="component__base_8hpp.html">ftxui/component/component_base.hpp</a>"</span> <span class="comment">// for ComponentBase</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="screen__interactive_8hpp.html">ftxui/component/screen_interactive.hpp</a>"</span> <span class="comment">// for ScreenInteractive</span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="elements_8hpp.html">ftxui/dom/elements.hpp</a>"</span> <span class="comment">// for text, separator, Element, operator|, vbox, border</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"><span class="comment">// An example of how to compose multiple components into one and maintain their</span></div>
|
||
|
|
<div class="line"><span class="comment">// interactiveness.</span></div>
|
||
|
|
<div class="line"><span class="keywordtype">int</span> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> left_count = 0;</div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> right_count = 0;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> left_buttons = Container::Horizontal({</div>
|
||
|
|
<div class="line"> Button(<span class="stringliteral">"Decrease"</span>, [&] { left_count--; }),</div>
|
||
|
|
<div class="line"> Button(<span class="stringliteral">"Increase"</span>, [&] { left_count++; }),</div>
|
||
|
|
<div class="line"> });</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> right_buttons = Container::Horizontal({</div>
|
||
|
|
<div class="line"> Button(<span class="stringliteral">"Decrease"</span>, [&] { right_count--; }),</div>
|
||
|
|
<div class="line"> Button(<span class="stringliteral">"Increase"</span>, [&] { right_count++; }),</div>
|
||
|
|
<div class="line"> });</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Renderer decorates its child with a new rendering function. The way the</span></div>
|
||
|
|
<div class="line"> <span class="comment">// children reacts to events is maintained.</span></div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> leftpane = Renderer(left_buttons, [&] {</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> vbox({</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"This is the left control"</span>),</div>
|
||
|
|
<div class="line"> separator(),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"Left button count: "</span> + std::to_string(left_count)),</div>
|
||
|
|
<div class="line"> left_buttons->Render(),</div>
|
||
|
|
<div class="line"> }) |</div>
|
||
|
|
<div class="line"> border;</div>
|
||
|
|
<div class="line"> });</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> rightpane = Renderer(right_buttons, [&] {</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> vbox({</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"This is the right control"</span>),</div>
|
||
|
|
<div class="line"> separator(),</div>
|
||
|
|
<div class="line"> text(<span class="stringliteral">"Right button count: "</span> + std::to_string(right_count)),</div>
|
||
|
|
<div class="line"> right_buttons->Render(),</div>
|
||
|
|
<div class="line"> }) |</div>
|
||
|
|
<div class="line"> border;</div>
|
||
|
|
<div class="line"> });</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Container groups components togethers. To render a Container::Horizontal,</span></div>
|
||
|
|
<div class="line"> <span class="comment">// it render its children side by side. It maintains their interactiveness and</span></div>
|
||
|
|
<div class="line"> <span class="comment">// provide the logic to navigate from one to the other using the arrow keys.</span></div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> composition = Container::Horizontal({leftpane, rightpane});</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> screen = ScreenInteractive::FitComponent();</div>
|
||
|
|
<div class="line"> screen.Loop(composition);</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> 0;</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="comment">// Thanks to Chris Morgan for this example!</span></div>
|
||
|
|
<div class="ttc" id="acaptured__mouse_8hpp_html"><div class="ttname"><a href="captured__mouse_8hpp.html">captured_mouse.hpp</a></div></div>
|
||
|
|
<div class="ttc" id="acomponent__base_8hpp_html"><div class="ttname"><a href="component__base_8hpp.html">component_base.hpp</a></div></div>
|
||
|
|
</div><!-- fragment --> </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="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>
|