mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
240 lines
19 KiB
HTML
240 lines
19 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/input.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_2input_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/input.cpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<h1><a class="anchor" id="autotoc_md179"></a>
|
|
input_in_frame</h1>
|
|
<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_access</span></div>
|
|
<div class="line"><span class="preprocessor">#include <string></span> <span class="comment">// for string, basic_string, operator+, to_string</span></div>
|
|
<div class="line"><span class="preprocessor">#include <vector></span> <span class="comment">// for vector</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 Input, Renderer, Vertical</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 Component, 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 operator|, Element, size, border, frame, vscroll_indicator, HEIGHT, LESS_THAN</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"> </div>
|
|
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input_list = Container::Vertical({});</div>
|
|
<div class="line"> std::vector<std::string> items(100, <span class="stringliteral">""</span>);</div>
|
|
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < items.size(); ++i) {</div>
|
|
<div class="line"> input_list->Add(Input(&(items[i]), <span class="stringliteral">"placeholder "</span> + std::to_string(i)));</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keyword">auto</span> renderer = Renderer(input_list, [&] {</div>
|
|
<div class="line"> <span class="keywordflow">return</span> input_list->Render() | vscroll_indicator | frame | border |</div>
|
|
<div class="line"> size(HEIGHT, LESS_THAN, 10);</div>
|
|
<div class="line"> });</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keyword">auto</span> screen = ScreenInteractive::TerminalOutput();</div>
|
|
<div class="line"> screen.Loop(renderer);</div>
|
|
<div class="line">}</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_8hpp_html"><div class="ttname"><a href="component_8hpp.html">component.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 class="ttc" id="aelements_8hpp_html"><div class="ttname"><a href="elements_8hpp.html">elements.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="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_af1479ede01dbf087342534ab4ada11d3"><div class="ttname"><a href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">ftxui::Component</a></div><div class="ttdeci">std::shared_ptr< ComponentBase > 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="ascreen__interactive_8hpp_html"><div class="ttname"><a href="screen__interactive_8hpp.html">screen_interactive.hpp</a></div></div>
|
|
</div><!-- fragment --><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 <memory></span> <span class="comment">// for allocator, __shared_ptr_access</span></div>
|
|
<div class="line"><span class="preprocessor">#include <string></span> <span class="comment">// for char_traits, operator+, string, basic_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 Input, Renderer, Vertical</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="component__options_8hpp.html">ftxui/component/component_options.hpp</a>"</span> <span class="comment">// for InputOption</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 Component, 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, hbox, separator, Element, operator|, vbox, border</span></div>
|
|
<div class="line"><span class="preprocessor">#include "<a class="code" href="ref_8hpp.html">ftxui/util/ref.hpp</a>"</span> <span class="comment">// for Ref</span></div>
|
|
<div class="line"> </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">using namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// The data:</span></div>
|
|
<div class="line"> std::string first_name;</div>
|
|
<div class="line"> std::string last_name;</div>
|
|
<div class="line"> std::string password;</div>
|
|
<div class="line"> std::string phoneNumber;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// The basic input components:</span></div>
|
|
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input_first_name = Input(&first_name, <span class="stringliteral">"first name"</span>);</div>
|
|
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input_last_name = Input(&last_name, <span class="stringliteral">"last name"</span>);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// The password input component:</span></div>
|
|
<div class="line"> <a id="_a1" name="_a1"></a><a class="code hl_struct" href="structftxui_1_1InputOption.html">InputOption</a> password_option;</div>
|
|
<div class="line"> password_option.<a id="a2" name="a2"></a><a class="code hl_variable" href="structftxui_1_1InputOption.html#a927bd46792ffe38c7545a764d847d066">password</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input_password = Input(&password, <span class="stringliteral">"password"</span>, password_option);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// The phone number input component:</span></div>
|
|
<div class="line"> <span class="comment">// We are using `CatchEvent` to filter out non-digit characters.</span></div>
|
|
<div class="line"> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> input_phone_number = Input(&phoneNumber, <span class="stringliteral">"phone number"</span>);</div>
|
|
<div class="line"> input_phone_number |= CatchEvent([&](<a id="_a3" name="_a3"></a><a class="code hl_struct" href="structftxui_1_1Event.html">Event</a> event) {</div>
|
|
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">event</span>.is_character() && !std::isdigit(event.<a id="a4" name="a4"></a><a class="code hl_function" href="structftxui_1_1Event.html#a07022c6e92b9144a0e5b337b562f9892">character</a>()[0]);</div>
|
|
<div class="line"> });</div>
|
|
<div class="line"> input_phone_number |= CatchEvent([&](<a class="code hl_struct" href="structftxui_1_1Event.html">Event</a> event) {</div>
|
|
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">event</span>.is_character() && phoneNumber.size() > 10;</div>
|
|
<div class="line"> });</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// The component tree:</span></div>
|
|
<div class="line"> <span class="keyword">auto</span> component = Container::Vertical({</div>
|
|
<div class="line"> input_first_name,</div>
|
|
<div class="line"> input_last_name,</div>
|
|
<div class="line"> input_password,</div>
|
|
<div class="line"> input_phone_number,</div>
|
|
<div class="line"> });</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Tweak how the component tree is rendered:</span></div>
|
|
<div class="line"> <span class="keyword">auto</span> renderer = Renderer(component, [&] {</div>
|
|
<div class="line"> <span class="keywordflow">return</span> vbox({</div>
|
|
<div class="line"> hbox(text(<span class="stringliteral">" First name : "</span>), input_first_name->Render()),</div>
|
|
<div class="line"> hbox(text(<span class="stringliteral">" Last name : "</span>), input_last_name->Render()),</div>
|
|
<div class="line"> hbox(text(<span class="stringliteral">" Password : "</span>), input_password->Render()),</div>
|
|
<div class="line"> hbox(text(<span class="stringliteral">" Phone num : "</span>), input_phone_number->Render()),</div>
|
|
<div class="line"> separator(),</div>
|
|
<div class="line"> text(<span class="stringliteral">"Hello "</span> + first_name + <span class="stringliteral">" "</span> + last_name),</div>
|
|
<div class="line"> text(<span class="stringliteral">"Your password is "</span> + password),</div>
|
|
<div class="line"> text(<span class="stringliteral">"Your phone number is "</span> + phoneNumber),</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> screen = ScreenInteractive::TerminalOutput();</div>
|
|
<div class="line"> screen.Loop(renderer);</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="acomponent__options_8hpp_html"><div class="ttname"><a href="component__options_8hpp.html">component_options.hpp</a></div></div>
|
|
<div class="ttc" id="aref_8hpp_html"><div class="ttname"><a href="ref_8hpp.html">ref.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 class="ttc" id="astructftxui_1_1Event_html_a07022c6e92b9144a0e5b337b562f9892"><div class="ttname"><a href="structftxui_1_1Event.html#a07022c6e92b9144a0e5b337b562f9892">ftxui::Event::character</a></div><div class="ttdeci">std::string character() const</div><div class="ttdef"><b>Definition</b> <a href="event_8hpp_source.html#l00105">event.hpp:105</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1InputOption_html"><div class="ttname"><a href="structftxui_1_1InputOption.html">ftxui::InputOption</a></div><div class="ttdoc">Option for the Input component.</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00161">component_options.hpp:161</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1InputOption_html_a927bd46792ffe38c7545a764d847d066"><div class="ttname"><a href="structftxui_1_1InputOption.html#a927bd46792ffe38c7545a764d847d066">ftxui::InputOption::password</a></div><div class="ttdeci">Ref< bool > password</div><div class="ttdoc">Obscure the input content using '*'.</div><div class="ttdef"><b>Definition</b> <a href="component__options_8hpp_source.html#l00177">component_options.hpp:177</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>
|