mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-11-15 11:38:56 +08:00
4012 lines
291 KiB
HTML
4012 lines
291 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 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">0.10.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&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.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> |
|
||
<a href="#enum-members">Enumerations</a> |
|
||
<a href="#typedef-members">Typedefs</a> |
|
||
<a href="#nested-classes">Data Structures</a> |
|
||
<a href="#namespaces">Namespaces</a> |
|
||
<a href="#var-members">Variables</a> </div>
|
||
<div class="headertitle"><div class="title">ftxui 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:a2b8973dc71334f1d98e2e6f55de8b5ae" id="r_a2b8973dc71334f1d98e2e6f55de8b5ae"><td class="memTemplParams" colspan="2">template<class T , class... Args> </td></tr>
|
||
<tr class="memitem:a2b8973dc71334f1d98e2e6f55de8b5ae"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a2b8973dc71334f1d98e2e6f55de8b5ae">Make</a> (Args &&... args)</td></tr>
|
||
<tr class="separator:a2b8973dc71334f1d98e2e6f55de8b5ae"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a6910ffaa082c693603aafab4e7dddac3" id="r_a6910ffaa082c693603aafab4e7dddac3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6910ffaa082c693603aafab4e7dddac3">Button</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, std::function< void()> on_click, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a6910ffaa082c693603aafab4e7dddac3"><td class="mdescLeft"> </td><td class="mdescRight">Draw a button. Execute a function when clicked. <br /></td></tr>
|
||
<tr class="separator:a6910ffaa082c693603aafab4e7dddac3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a04e40e348dee25bbbfce0a13bf234e19" id="r_a04e40e348dee25bbbfce0a13bf234e19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a04e40e348dee25bbbfce0a13bf234e19">Checkbox</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, bool *checked, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a04e40e348dee25bbbfce0a13bf234e19"><td class="mdescLeft"> </td><td class="mdescRight">Draw checkable element. <br /></td></tr>
|
||
<tr class="separator:a04e40e348dee25bbbfce0a13bf234e19"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a30be54a28004c1c48c2a5ed54e4abd64" id="r_a30be54a28004c1c48c2a5ed54e4abd64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a30be54a28004c1c48c2a5ed54e4abd64">Input</a> (<a class="el" href="classftxui_1_1StringRef.html">StringRef</a> content, <a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> placeholder, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1InputOption">InputOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a30be54a28004c1c48c2a5ed54e4abd64"><td class="mdescLeft"> </td><td class="mdescRight">An input box for editing text. <br /></td></tr>
|
||
<tr class="separator:a30be54a28004c1c48c2a5ed54e4abd64"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a777280bcec2414bef5c6725658c7714b" id="r_a777280bcec2414bef5c6725658c7714b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a777280bcec2414bef5c6725658c7714b">Menu</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a777280bcec2414bef5c6725658c7714b"><td class="mdescLeft"> </td><td class="mdescRight">A list of text. The focused element is selected. <br /></td></tr>
|
||
<tr class="separator:a777280bcec2414bef5c6725658c7714b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab984001f4208b35a22b9dcafae4debb6" id="r_ab984001f4208b35a22b9dcafae4debb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab984001f4208b35a22b9dcafae4debb6">MenuEntry</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a> >={})</td></tr>
|
||
<tr class="separator:ab984001f4208b35a22b9dcafae4debb6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa22bddff4aeed66e20f30d0715596999" id="r_aa22bddff4aeed66e20f30d0715596999"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa22bddff4aeed66e20f30d0715596999">Dropdown</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected)</td></tr>
|
||
<tr class="separator:aa22bddff4aeed66e20f30d0715596999"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0d757f667caaff5287cb8702f52186ee" id="r_a0d757f667caaff5287cb8702f52186ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d757f667caaff5287cb8702f52186ee">Radiobox</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a0d757f667caaff5287cb8702f52186ee"><td class="mdescLeft"> </td><td class="mdescRight">A list of element, where only one can be selected. <br /></td></tr>
|
||
<tr class="separator:a0d757f667caaff5287cb8702f52186ee"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a1c4cbe6596ef55350f8a6a49a090510c" id="r_a1c4cbe6596ef55350f8a6a49a090510c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c4cbe6596ef55350f8a6a49a090510c">Toggle</a> (<a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries, int *selected, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1ToggleOption">ToggleOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a1c4cbe6596ef55350f8a6a49a090510c"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal list of elements. The user can navigate through them. <br /></td></tr>
|
||
<tr class="separator:a1c4cbe6596ef55350f8a6a49a090510c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:acc572957ec06e5eb955856ee058f8d90" id="r_acc572957ec06e5eb955856ee058f8d90"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
||
<tr class="memitem:acc572957ec06e5eb955856ee058f8d90"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#acc572957ec06e5eb955856ee058f8d90">Slider</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, T *value, T min, T max, T increment)</td></tr>
|
||
<tr class="memdesc:acc572957ec06e5eb955856ee058f8d90"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal slider. <br /></td></tr>
|
||
<tr class="separator:acc572957ec06e5eb955856ee058f8d90"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae2205fc172615b43e1e3307bb614be4c" id="r_ae2205fc172615b43e1e3307bb614be4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2205fc172615b43e1e3307bb614be4c">ResizableSplitLeft</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> main, <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:ae2205fc172615b43e1e3307bb614be4c"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:ae2205fc172615b43e1e3307bb614be4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9030d0beb64f653603cab382b02750a8" id="r_a9030d0beb64f653603cab382b02750a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9030d0beb64f653603cab382b02750a8">ResizableSplitRight</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> main, <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:a9030d0beb64f653603cab382b02750a8"><td class="mdescLeft"> </td><td class="mdescRight">An horizontal split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:a9030d0beb64f653603cab382b02750a8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a238b4b650aca14716b82b2198695e008" id="r_a238b4b650aca14716b82b2198695e008"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a238b4b650aca14716b82b2198695e008">ResizableSplitTop</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> main, <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:a238b4b650aca14716b82b2198695e008"><td class="mdescLeft"> </td><td class="mdescRight">An vertical split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:a238b4b650aca14716b82b2198695e008"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:acb75e6e61a021829893f7b57aeb7e3a2" id="r_acb75e6e61a021829893f7b57aeb7e3a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acb75e6e61a021829893f7b57aeb7e3a2">ResizableSplitBottom</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> main, <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> back, int *main_size)</td></tr>
|
||
<tr class="memdesc:acb75e6e61a021829893f7b57aeb7e3a2"><td class="mdescLeft"> </td><td class="mdescRight">An vertical split in between two components, configurable using the mouse. <br /></td></tr>
|
||
<tr class="separator:acb75e6e61a021829893f7b57aeb7e3a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a533e883e2aeea28de2b60564fcaf0361" id="r_a533e883e2aeea28de2b60564fcaf0361"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> render)</td></tr>
|
||
<tr class="memdesc:a533e883e2aeea28de2b60564fcaf0361"><td class="mdescLeft"> </td><td class="mdescRight">Return a new Component, similar to |child|, but using |render| as the Component::Render() event. <br /></td></tr>
|
||
<tr class="separator:a533e883e2aeea28de2b60564fcaf0361"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af03d3df7243bf71bb1a73686628f7f2b" id="r_af03d3df7243bf71bb1a73686628f7f2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af03d3df7243bf71bb1a73686628f7f2b">Renderer</a> (std::function< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()> render)</td></tr>
|
||
<tr class="memdesc:af03d3df7243bf71bb1a73686628f7f2b"><td class="mdescLeft"> </td><td class="mdescRight">Return a component, using |render| to render its interface. <br /></td></tr>
|
||
<tr class="separator:af03d3df7243bf71bb1a73686628f7f2b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a099cb57274a99396ee10f38acbfe62a7" id="r_a099cb57274a99396ee10f38acbfe62a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a099cb57274a99396ee10f38acbfe62a7">Renderer</a> (std::function< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(bool)> render)</td></tr>
|
||
<tr class="memdesc:a099cb57274a99396ee10f38acbfe62a7"><td class="mdescLeft"> </td><td class="mdescRight">Return a focusable component, using |render| to render its interface. <br /></td></tr>
|
||
<tr class="separator:a099cb57274a99396ee10f38acbfe62a7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:afa5872ba3f9889c7487e57e745e56857" id="r_afa5872ba3f9889c7487e57e745e56857"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afa5872ba3f9889c7487e57e745e56857">CatchEvent</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a>)>)</td></tr>
|
||
<tr class="separator:afa5872ba3f9889c7487e57e745e56857"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abe1e4e93c6f28539357d0a6aec27ebdd" id="r_abe1e4e93c6f28539357d0a6aec27ebdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abe1e4e93c6f28539357d0a6aec27ebdd">Maybe</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a>, bool *show)</td></tr>
|
||
<tr class="separator:abe1e4e93c6f28539357d0a6aec27ebdd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a26d065934276991f218d3fd985b86f7d" id="r_a26d065934276991f218d3fd985b86f7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a26d065934276991f218d3fd985b86f7d">Input</a> (<a class="el" href="classftxui_1_1WideStringRef.html">WideStringRef</a> content, <a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> placeholder, <a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1InputOption">InputOption</a> > option)</td></tr>
|
||
<tr class="memdesc:a26d065934276991f218d3fd985b86f7d"><td class="mdescLeft"> </td><td class="mdescRight">. An input box for editing text. <br /></td></tr>
|
||
<tr class="separator:a26d065934276991f218d3fd985b86f7d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a57abe3e11733b1d3ebacc56692d3537c" id="r_a57abe3e11733b1d3ebacc56692d3537c"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
||
<tr class="memitem:a57abe3e11733b1d3ebacc56692d3537c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#a7abbe763f26611fbf3902861863b7659">Receiver</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a57abe3e11733b1d3ebacc56692d3537c">MakeReceiver</a> ()</td></tr>
|
||
<tr class="separator:a57abe3e11733b1d3ebacc56692d3537c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a75baaa2734ed76a9f478beaafa87ae57" id="r_a75baaa2734ed76a9f478beaafa87ae57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a> (std::wstring text)</td></tr>
|
||
<tr class="memdesc:a75baaa2734ed76a9f478beaafa87ae57"><td class="mdescLeft"> </td><td class="mdescRight">Display a piece of unicode text. <br /></td></tr>
|
||
<tr class="separator:a75baaa2734ed76a9f478beaafa87ae57"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9f9f7485a45aa9d432726ca9845d1eac" id="r_a9f9f7485a45aa9d432726ca9845d1eac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f9f7485a45aa9d432726ca9845d1eac">vtext</a> (std::wstring <a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>)</td></tr>
|
||
<tr class="memdesc:a9f9f7485a45aa9d432726ca9845d1eac"><td class="mdescLeft"> </td><td class="mdescRight">Display a piece unicode text vertically. <br /></td></tr>
|
||
<tr class="separator:a9f9f7485a45aa9d432726ca9845d1eac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3b8fc08cbe1ef6e1f9607644b1580aad" id="r_a3b8fc08cbe1ef6e1f9607644b1580aad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b8fc08cbe1ef6e1f9607644b1580aad">paragraph</a> (std::wstring the_text)</td></tr>
|
||
<tr class="memdesc:a3b8fc08cbe1ef6e1f9607644b1580aad"><td class="mdescLeft"> </td><td class="mdescRight">Return a vector of <a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57" title="Display a piece of unicode text.">ftxui::text</a> for every word of the string. This is useful combined with <a class="el" href="#a345b31919048562675615d5af78e6322" title="A container displaying elements horizontally one by one.">ftxui::hflow</a>. <br /></td></tr>
|
||
<tr class="separator:a3b8fc08cbe1ef6e1f9607644b1580aad"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a7e9a69f0592b4013bd725d662f4a76e7" id="r_a7e9a69f0592b4013bd725d662f4a76e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e9a69f0592b4013bd725d662f4a76e7">operator|</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> element, <a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> decorator)</td></tr>
|
||
<tr class="memdesc:a7e9a69f0592b4013bd725d662f4a76e7"><td class="mdescLeft"> </td><td class="mdescRight">From an element, apply a decorator. <br /></td></tr>
|
||
<tr class="separator:a7e9a69f0592b4013bd725d662f4a76e7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a6cbc84eb24a655ae084b3c7d26f9abfc" id="r_a6cbc84eb24a655ae084b3c7d26f9abfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6cbc84eb24a655ae084b3c7d26f9abfc">operator|</a> (<a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> elements, <a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> decorator)</td></tr>
|
||
<tr class="memdesc:a6cbc84eb24a655ae084b3c7d26f9abfc"><td class="mdescLeft"> </td><td class="mdescRight">From a set of element, apply a decorator to every elements. <br /></td></tr>
|
||
<tr class="separator:a6cbc84eb24a655ae084b3c7d26f9abfc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a027fbc9cf6fef9e86ae6a2a79e8bf23a" id="r_a027fbc9cf6fef9e86ae6a2a79e8bf23a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a027fbc9cf6fef9e86ae6a2a79e8bf23a">operator|</a> (<a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> a, <a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> b)</td></tr>
|
||
<tr class="memdesc:a027fbc9cf6fef9e86ae6a2a79e8bf23a"><td class="mdescLeft"> </td><td class="mdescRight">Compose two decorator into one. <br /></td></tr>
|
||
<tr class="separator:a027fbc9cf6fef9e86ae6a2a79e8bf23a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a366051704fd333c23460f7932598a5e3" id="r_a366051704fd333c23460f7932598a5e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a366051704fd333c23460f7932598a5e3">text</a> (std::string text)</td></tr>
|
||
<tr class="memdesc:a366051704fd333c23460f7932598a5e3"><td class="mdescLeft"> </td><td class="mdescRight">Display a piece of UTF8 encoded unicode text. <br /></td></tr>
|
||
<tr class="separator:a366051704fd333c23460f7932598a5e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a64172a43b4b526afeb6313e6e1a6d5a1" id="r_a64172a43b4b526afeb6313e6e1a6d5a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a64172a43b4b526afeb6313e6e1a6d5a1">vtext</a> (std::string <a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>)</td></tr>
|
||
<tr class="memdesc:a64172a43b4b526afeb6313e6e1a6d5a1"><td class="mdescLeft"> </td><td class="mdescRight">Display a piece of unicode text vertically. <br /></td></tr>
|
||
<tr class="separator:a64172a43b4b526afeb6313e6e1a6d5a1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a4d3951dde56262b80ee4eb805ced51d1" id="r_a4d3951dde56262b80ee4eb805ced51d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d3951dde56262b80ee4eb805ced51d1">separator</a> (void)</td></tr>
|
||
<tr class="separator:a4d3951dde56262b80ee4eb805ced51d1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a37c2b93daf557f68064bc9fbf93ebde0" id="r_a37c2b93daf557f68064bc9fbf93ebde0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a37c2b93daf557f68064bc9fbf93ebde0">separatorLight</a> ()</td></tr>
|
||
<tr class="separator:a37c2b93daf557f68064bc9fbf93ebde0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af0649e89a9960f1c2703e48c1817645b" id="r_af0649e89a9960f1c2703e48c1817645b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af0649e89a9960f1c2703e48c1817645b">separatorHeavy</a> ()</td></tr>
|
||
<tr class="separator:af0649e89a9960f1c2703e48c1817645b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:add376830fdb51b0bf52672ef17515989" id="r_add376830fdb51b0bf52672ef17515989"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#add376830fdb51b0bf52672ef17515989">separatorDouble</a> ()</td></tr>
|
||
<tr class="separator:add376830fdb51b0bf52672ef17515989"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af5a5a3d46e6a043059728d706cfd1145" id="r_af5a5a3d46e6a043059728d706cfd1145"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af5a5a3d46e6a043059728d706cfd1145">separatorStyled</a> (<a class="el" href="#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a>)</td></tr>
|
||
<tr class="separator:af5a5a3d46e6a043059728d706cfd1145"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa0e5364767764045f44e7e3191b40cdd" id="r_aa0e5364767764045f44e7e3191b40cdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0e5364767764045f44e7e3191b40cdd">separator</a> (<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>)</td></tr>
|
||
<tr class="separator:aa0e5364767764045f44e7e3191b40cdd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae0b8041a60629fd790716038738c93ce" id="r_ae0b8041a60629fd790716038738c93ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0b8041a60629fd790716038738c93ce">gauge</a> (float progress)</td></tr>
|
||
<tr class="memdesc:ae0b8041a60629fd790716038738c93ce"><td class="mdescLeft"> </td><td class="mdescRight">Draw a high definition progress bar. <br /></td></tr>
|
||
<tr class="separator:ae0b8041a60629fd790716038738c93ce"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae8537acd423d47cf07e61bd774fb1098" id="r_ae8537acd423d47cf07e61bd774fb1098"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098">border</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:ae8537acd423d47cf07e61bd774fb1098"><td class="mdescLeft"> </td><td class="mdescRight">Draw a border around the element. <br /></td></tr>
|
||
<tr class="separator:ae8537acd423d47cf07e61bd774fb1098"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa074cdab57eeb47b99f1699bcc8addd8" id="r_aa074cdab57eeb47b99f1699bcc8addd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa074cdab57eeb47b99f1699bcc8addd8">borderLight</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:aa074cdab57eeb47b99f1699bcc8addd8"><td class="mdescLeft"> </td><td class="mdescRight">Draw a light border around the element. <br /></td></tr>
|
||
<tr class="separator:aa074cdab57eeb47b99f1699bcc8addd8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a666c31419cc31cdadc9f8178ed63529e" id="r_a666c31419cc31cdadc9f8178ed63529e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a666c31419cc31cdadc9f8178ed63529e">borderHeavy</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a666c31419cc31cdadc9f8178ed63529e"><td class="mdescLeft"> </td><td class="mdescRight">Draw a heavy border around the element. <br /></td></tr>
|
||
<tr class="separator:a666c31419cc31cdadc9f8178ed63529e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a052b504344f3bc1ff86b3493cd934215" id="r_a052b504344f3bc1ff86b3493cd934215"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a052b504344f3bc1ff86b3493cd934215">borderDouble</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a052b504344f3bc1ff86b3493cd934215"><td class="mdescLeft"> </td><td class="mdescRight">Draw a double border around the element. <br /></td></tr>
|
||
<tr class="separator:a052b504344f3bc1ff86b3493cd934215"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3cf2db223a5efaa370f0ca6bb405b80e" id="r_a3cf2db223a5efaa370f0ca6bb405b80e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cf2db223a5efaa370f0ca6bb405b80e">borderRounded</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a3cf2db223a5efaa370f0ca6bb405b80e"><td class="mdescLeft"> </td><td class="mdescRight">Draw a rounded border around the element. <br /></td></tr>
|
||
<tr class="separator:a3cf2db223a5efaa370f0ca6bb405b80e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abc9db79957d4dd36deb8ca79938e4c41" id="r_abc9db79957d4dd36deb8ca79938e4c41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc9db79957d4dd36deb8ca79938e4c41">borderStyled</a> (<a class="el" href="#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a> style)</td></tr>
|
||
<tr class="memdesc:abc9db79957d4dd36deb8ca79938e4c41"><td class="mdescLeft"> </td><td class="mdescRight">Same as border but with different styles. <br /></td></tr>
|
||
<tr class="separator:abc9db79957d4dd36deb8ca79938e4c41"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a346da47464c320ac6b93ffe44b4da9df" id="r_a346da47464c320ac6b93ffe44b4da9df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a346da47464c320ac6b93ffe44b4da9df">borderWith</a> (<a class="el" href="structftxui_1_1Pixel.html">Pixel</a> pixel)</td></tr>
|
||
<tr class="memdesc:a346da47464c320ac6b93ffe44b4da9df"><td class="mdescLeft"> </td><td class="mdescRight">Same as border but with a constant <a class="el" href="structftxui_1_1Pixel.html" title="A unicode character and its associated style.">Pixel</a> around the element. <br /></td></tr>
|
||
<tr class="separator:a346da47464c320ac6b93ffe44b4da9df"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a443afb3d149fedaf88b89249c8f6dc25" id="r_a443afb3d149fedaf88b89249c8f6dc25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a443afb3d149fedaf88b89249c8f6dc25">window</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> title, <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> content)</td></tr>
|
||
<tr class="memdesc:a443afb3d149fedaf88b89249c8f6dc25"><td class="mdescLeft"> </td><td class="mdescRight">Draw window with a title and a border around the element. <br /></td></tr>
|
||
<tr class="separator:a443afb3d149fedaf88b89249c8f6dc25"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3b08e0030a0831d3ec3e2a505908273b" id="r_a3b08e0030a0831d3ec3e2a505908273b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b08e0030a0831d3ec3e2a505908273b">spinner</a> (int charset_index, size_t image_index)</td></tr>
|
||
<tr class="memdesc:a3b08e0030a0831d3ec3e2a505908273b"><td class="mdescLeft"> </td><td class="mdescRight">Useful to represent the effect of time and/or events. This display an ASCII art "video". <br /></td></tr>
|
||
<tr class="separator:a3b08e0030a0831d3ec3e2a505908273b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2d755c2b73e3e653d53e541526c27785" id="r_a2d755c2b73e3e653d53e541526c27785"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d755c2b73e3e653d53e541526c27785">paragraph</a> (std::string the_text)</td></tr>
|
||
<tr class="memdesc:a2d755c2b73e3e653d53e541526c27785"><td class="mdescLeft"> </td><td class="mdescRight">Return a vector of <a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57" title="Display a piece of unicode text.">ftxui::text</a> for every word of the string. This is useful combined with <a class="el" href="#a345b31919048562675615d5af78e6322" title="A container displaying elements horizontally one by one.">ftxui::hflow</a>. <br /></td></tr>
|
||
<tr class="separator:a2d755c2b73e3e653d53e541526c27785"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae78c2b2b147e65701493465f8e3f4d89" id="r_ae78c2b2b147e65701493465f8e3f4d89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae78c2b2b147e65701493465f8e3f4d89">graph</a> (<a class="el" href="#ab07cb9a766f38fc867f8fe736ce2e6e3">GraphFunction</a> graph_function)</td></tr>
|
||
<tr class="memdesc:ae78c2b2b147e65701493465f8e3f4d89"><td class="mdescLeft"> </td><td class="mdescRight">Draw a graph using a GraphFunction. <br /></td></tr>
|
||
<tr class="separator:ae78c2b2b147e65701493465f8e3f4d89"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a353c769068e25303eb41fa2da565c604" id="r_a353c769068e25303eb41fa2da565c604"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a353c769068e25303eb41fa2da565c604">bold</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a353c769068e25303eb41fa2da565c604"><td class="mdescLeft"> </td><td class="mdescRight">Use a bold font, for elements with more emphasis. <br /></td></tr>
|
||
<tr class="separator:a353c769068e25303eb41fa2da565c604"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac6a3b77604739516e809369810896646" id="r_ac6a3b77604739516e809369810896646"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac6a3b77604739516e809369810896646">dim</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:ac6a3b77604739516e809369810896646"><td class="mdescLeft"> </td><td class="mdescRight">Use a light font, for elements with less emphasis. <br /></td></tr>
|
||
<tr class="separator:ac6a3b77604739516e809369810896646"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a672456b8f2091b615a30ff755418b37b" id="r_a672456b8f2091b615a30ff755418b37b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a672456b8f2091b615a30ff755418b37b">inverted</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a672456b8f2091b615a30ff755418b37b"><td class="mdescLeft"> </td><td class="mdescRight">Add a filter that will invert the foreground and the background colors. <br /></td></tr>
|
||
<tr class="separator:a672456b8f2091b615a30ff755418b37b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5ad450c97c4d084b64ffb5b5ca942664" id="r_a5ad450c97c4d084b64ffb5b5ca942664"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ad450c97c4d084b64ffb5b5ca942664">underlined</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a5ad450c97c4d084b64ffb5b5ca942664"><td class="mdescLeft"> </td><td class="mdescRight">Make the underlined element to be underlined. <br /></td></tr>
|
||
<tr class="separator:a5ad450c97c4d084b64ffb5b5ca942664"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad57613de5895e774218d91dea48d074b" id="r_ad57613de5895e774218d91dea48d074b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad57613de5895e774218d91dea48d074b">blink</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:ad57613de5895e774218d91dea48d074b"><td class="mdescLeft"> </td><td class="mdescRight">The text drawn alternates in between visible and hidden. <br /></td></tr>
|
||
<tr class="separator:ad57613de5895e774218d91dea48d074b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af61b489da39ca5e24b68e6e1a2b09c0d" id="r_af61b489da39ca5e24b68e6e1a2b09c0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af61b489da39ca5e24b68e6e1a2b09c0d">color</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> c)</td></tr>
|
||
<tr class="memdesc:af61b489da39ca5e24b68e6e1a2b09c0d"><td class="mdescLeft"> </td><td class="mdescRight">Decorate using a foreground color. <br /></td></tr>
|
||
<tr class="separator:af61b489da39ca5e24b68e6e1a2b09c0d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a01d4c5aaf0447e862246849111782245" id="r_a01d4c5aaf0447e862246849111782245"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a01d4c5aaf0447e862246849111782245">bgcolor</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> <a class="el" href="#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>)</td></tr>
|
||
<tr class="memdesc:a01d4c5aaf0447e862246849111782245"><td class="mdescLeft"> </td><td class="mdescRight">Decorate using a background color. <br /></td></tr>
|
||
<tr class="separator:a01d4c5aaf0447e862246849111782245"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:adef6e6e66199153de6d3b21b14dcf868" id="r_adef6e6e66199153de6d3b21b14dcf868"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#adef6e6e66199153de6d3b21b14dcf868">color</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> color, <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:adef6e6e66199153de6d3b21b14dcf868"><td class="mdescLeft"> </td><td class="mdescRight">Set the foreground color of an element. <br /></td></tr>
|
||
<tr class="separator:adef6e6e66199153de6d3b21b14dcf868"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aae86eacae0a0626b41e9964ac7f4f532" id="r_aae86eacae0a0626b41e9964ac7f4f532"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aae86eacae0a0626b41e9964ac7f4f532">bgcolor</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> <a class="el" href="#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>, <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:aae86eacae0a0626b41e9964ac7f4f532"><td class="mdescLeft"> </td><td class="mdescRight">Set the background color of an element. <br /></td></tr>
|
||
<tr class="separator:aae86eacae0a0626b41e9964ac7f4f532"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a552ba6d33b3c9bec586b99fba4c243ac" id="r_a552ba6d33b3c9bec586b99fba4c243ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a552ba6d33b3c9bec586b99fba4c243ac">hbox</a> (<a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> children)</td></tr>
|
||
<tr class="memdesc:a552ba6d33b3c9bec586b99fba4c243ac"><td class="mdescLeft"> </td><td class="mdescRight">A container displaying elements horizontally one by one. <br /></td></tr>
|
||
<tr class="separator:a552ba6d33b3c9bec586b99fba4c243ac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:afd28058f0ccbbdf34691a85a7cc9b2e3" id="r_afd28058f0ccbbdf34691a85a7cc9b2e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afd28058f0ccbbdf34691a85a7cc9b2e3">vbox</a> (<a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> children)</td></tr>
|
||
<tr class="memdesc:afd28058f0ccbbdf34691a85a7cc9b2e3"><td class="mdescLeft"> </td><td class="mdescRight">A container displaying elements vertically one by one. <br /></td></tr>
|
||
<tr class="separator:afd28058f0ccbbdf34691a85a7cc9b2e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a901ab1b6b2e0e8c295552168ab206441" id="r_a901ab1b6b2e0e8c295552168ab206441"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a901ab1b6b2e0e8c295552168ab206441">dbox</a> (<a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> children_)</td></tr>
|
||
<tr class="memdesc:a901ab1b6b2e0e8c295552168ab206441"><td class="mdescLeft"> </td><td class="mdescRight">Stack several element on top of each other. <br /></td></tr>
|
||
<tr class="separator:a901ab1b6b2e0e8c295552168ab206441"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abcdf409d605edafd3191cd7ba47bcbd1" id="r_abcdf409d605edafd3191cd7ba47bcbd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abcdf409d605edafd3191cd7ba47bcbd1">gridbox</a> (std::vector< <a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> > lines)</td></tr>
|
||
<tr class="memdesc:abcdf409d605edafd3191cd7ba47bcbd1"><td class="mdescLeft"> </td><td class="mdescRight">A container displaying a grid of elements. <br /></td></tr>
|
||
<tr class="separator:abcdf409d605edafd3191cd7ba47bcbd1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a345b31919048562675615d5af78e6322" id="r_a345b31919048562675615d5af78e6322"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a345b31919048562675615d5af78e6322">hflow</a> (<a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> children)</td></tr>
|
||
<tr class="memdesc:a345b31919048562675615d5af78e6322"><td class="mdescLeft"> </td><td class="mdescRight">A container displaying elements horizontally one by one. <br /></td></tr>
|
||
<tr class="separator:a345b31919048562675615d5af78e6322"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a257acd2bd47bab7db879cca2c0e67e23" id="r_a257acd2bd47bab7db879cca2c0e67e23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a257acd2bd47bab7db879cca2c0e67e23">flex</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a257acd2bd47bab7db879cca2c0e67e23"><td class="mdescLeft"> </td><td class="mdescRight">Make a child element to expand proportionnally to the space left in a container. <br /></td></tr>
|
||
<tr class="separator:a257acd2bd47bab7db879cca2c0e67e23"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a81ed6b31f512e849247f13d249f6f20e" id="r_a81ed6b31f512e849247f13d249f6f20e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a81ed6b31f512e849247f13d249f6f20e">flex_grow</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a81ed6b31f512e849247f13d249f6f20e"><td class="mdescLeft"> </td><td class="mdescRight">Expand if possible. <br /></td></tr>
|
||
<tr class="separator:a81ed6b31f512e849247f13d249f6f20e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a4629196b5ffc280054d35f2a9977e829" id="r_a4629196b5ffc280054d35f2a9977e829"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4629196b5ffc280054d35f2a9977e829">flex_shrink</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a4629196b5ffc280054d35f2a9977e829"><td class="mdescLeft"> </td><td class="mdescRight">Minimize if needed. <br /></td></tr>
|
||
<tr class="separator:a4629196b5ffc280054d35f2a9977e829"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0dbba98e14f63f1dd5163cbdc4f42da8" id="r_a0dbba98e14f63f1dd5163cbdc4f42da8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dbba98e14f63f1dd5163cbdc4f42da8">xflex</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a0dbba98e14f63f1dd5163cbdc4f42da8"><td class="mdescLeft"> </td><td class="mdescRight">Expand/Minimize if possible/needed on the X axis. <br /></td></tr>
|
||
<tr class="separator:a0dbba98e14f63f1dd5163cbdc4f42da8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a1618cb15307f29eb3d531e7b44c280d3" id="r_a1618cb15307f29eb3d531e7b44c280d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1618cb15307f29eb3d531e7b44c280d3">xflex_grow</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a1618cb15307f29eb3d531e7b44c280d3"><td class="mdescLeft"> </td><td class="mdescRight">Expand if possible on the X axis. <br /></td></tr>
|
||
<tr class="separator:a1618cb15307f29eb3d531e7b44c280d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a95275a9271934cf76e970c6650cc224d" id="r_a95275a9271934cf76e970c6650cc224d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a95275a9271934cf76e970c6650cc224d">xflex_shrink</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a95275a9271934cf76e970c6650cc224d"><td class="mdescLeft"> </td><td class="mdescRight">Minimize if needed on the X axis. <br /></td></tr>
|
||
<tr class="separator:a95275a9271934cf76e970c6650cc224d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a42c7a33df6d890de30fc1ebb2d1b3ca6" id="r_a42c7a33df6d890de30fc1ebb2d1b3ca6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a42c7a33df6d890de30fc1ebb2d1b3ca6">yflex</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a42c7a33df6d890de30fc1ebb2d1b3ca6"><td class="mdescLeft"> </td><td class="mdescRight">Expand/Minimize if possible/needed on the Y axis. <br /></td></tr>
|
||
<tr class="separator:a42c7a33df6d890de30fc1ebb2d1b3ca6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a7eac3f709e905af8f583aed52093b7ce" id="r_a7eac3f709e905af8f583aed52093b7ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7eac3f709e905af8f583aed52093b7ce">yflex_grow</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a7eac3f709e905af8f583aed52093b7ce"><td class="mdescLeft"> </td><td class="mdescRight">Expand if possible on the Y axis. <br /></td></tr>
|
||
<tr class="separator:a7eac3f709e905af8f583aed52093b7ce"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af7d0757f5965aa579bccc125ff909256" id="r_af7d0757f5965aa579bccc125ff909256"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af7d0757f5965aa579bccc125ff909256">yflex_shrink</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:af7d0757f5965aa579bccc125ff909256"><td class="mdescLeft"> </td><td class="mdescRight">Minimize if needed on the Y axis. <br /></td></tr>
|
||
<tr class="separator:af7d0757f5965aa579bccc125ff909256"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a845b0ea50d51024aa4e050447b46e1dd" id="r_a845b0ea50d51024aa4e050447b46e1dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a845b0ea50d51024aa4e050447b46e1dd">notflex</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a845b0ea50d51024aa4e050447b46e1dd"><td class="mdescLeft"> </td><td class="mdescRight">Make the element not flexible. <br /></td></tr>
|
||
<tr class="separator:a845b0ea50d51024aa4e050447b46e1dd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac2a9ed2d22ec3c8811b61f4a901ed367" id="r_ac2a9ed2d22ec3c8811b61f4a901ed367"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2a9ed2d22ec3c8811b61f4a901ed367">filler</a> ()</td></tr>
|
||
<tr class="memdesc:ac2a9ed2d22ec3c8811b61f4a901ed367"><td class="mdescLeft"> </td><td class="mdescRight">An element that will take expand proportionnally to the space left in a container. <br /></td></tr>
|
||
<tr class="separator:ac2a9ed2d22ec3c8811b61f4a901ed367"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:adbda408cdd76f3bbd9c4e863672b7122" id="r_adbda408cdd76f3bbd9c4e863672b7122"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#adbda408cdd76f3bbd9c4e863672b7122">size</a> (<a class="el" href="#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> direction, <a class="el" href="#ae09f44b989d381a387329fd0a0935926">Constraint</a> constraint, int value)</td></tr>
|
||
<tr class="memdesc:adbda408cdd76f3bbd9c4e863672b7122"><td class="mdescLeft"> </td><td class="mdescRight">Apply a constraint on the size of an element. <br /></td></tr>
|
||
<tr class="separator:adbda408cdd76f3bbd9c4e863672b7122"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aaff8245861617a3d9e846e99de582a63" id="r_aaff8245861617a3d9e846e99de582a63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaff8245861617a3d9e846e99de582a63">reflect</a> (<a class="el" href="structftxui_1_1Box.html">Box</a> &box)</td></tr>
|
||
<tr class="separator:aaff8245861617a3d9e846e99de582a63"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad0d6a96f6e1fb6d67d9fa6323062a737" id="r_ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0d6a96f6e1fb6d67d9fa6323062a737">frame</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="mdescLeft"> </td><td class="mdescRight">Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible. <br /></td></tr>
|
||
<tr class="separator:ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2616fcc18ca2fb41954749e67647b48f" id="r_a2616fcc18ca2fb41954749e67647b48f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2616fcc18ca2fb41954749e67647b48f">xframe</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)</td></tr>
|
||
<tr class="separator:a2616fcc18ca2fb41954749e67647b48f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a8406bb311fbaf67a7779833635c348ea" id="r_a8406bb311fbaf67a7779833635c348ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8406bb311fbaf67a7779833635c348ea">yframe</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)</td></tr>
|
||
<tr class="separator:a8406bb311fbaf67a7779833635c348ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a52ee73ca2fb34afb6e6f25ac7df04b0e" id="r_a52ee73ca2fb34afb6e6f25ac7df04b0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a52ee73ca2fb34afb6e6f25ac7df04b0e">focus</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)</td></tr>
|
||
<tr class="separator:a52ee73ca2fb34afb6e6f25ac7df04b0e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af0a483ef6e8a00023755c4637a1fcb9d" id="r_af0a483ef6e8a00023755c4637a1fcb9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af0a483ef6e8a00023755c4637a1fcb9d">select</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)</td></tr>
|
||
<tr class="separator:af0a483ef6e8a00023755c4637a1fcb9d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a1974176e676afdb96d203e8e0f579219" id="r_a1974176e676afdb96d203e8e0f579219"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1974176e676afdb96d203e8e0f579219">vscroll_indicator</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a1974176e676afdb96d203e8e0f579219"><td class="mdescLeft"> </td><td class="mdescRight">Add a filter that will invert the foreground and the background colors. <br /></td></tr>
|
||
<tr class="separator:a1974176e676afdb96d203e8e0f579219"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af7d0d1e44c1a5424e42a5cddceacf7f7" id="r_af7d0d1e44c1a5424e42a5cddceacf7f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af7d0d1e44c1a5424e42a5cddceacf7f7">hcenter</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:af7d0d1e44c1a5424e42a5cddceacf7f7"><td class="mdescLeft"> </td><td class="mdescRight">Center an element horizontally. <br /></td></tr>
|
||
<tr class="separator:af7d0d1e44c1a5424e42a5cddceacf7f7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad907a8a48bb9f9dfdb06402e9fc12316" id="r_ad907a8a48bb9f9dfdb06402e9fc12316"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad907a8a48bb9f9dfdb06402e9fc12316">vcenter</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:ad907a8a48bb9f9dfdb06402e9fc12316"><td class="mdescLeft"> </td><td class="mdescRight">Center an element vertically. <br /></td></tr>
|
||
<tr class="separator:ad907a8a48bb9f9dfdb06402e9fc12316"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5b11656305fce8427b81daf1c35883f1" id="r_a5b11656305fce8427b81daf1c35883f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b11656305fce8427b81daf1c35883f1">center</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a5b11656305fce8427b81daf1c35883f1"><td class="mdescLeft"> </td><td class="mdescRight">Center an element horizontally and vertically. <br /></td></tr>
|
||
<tr class="separator:a5b11656305fce8427b81daf1c35883f1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a778e52afe28f1978f1f7ef065ed92d6d" id="r_a778e52afe28f1978f1f7ef065ed92d6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a778e52afe28f1978f1f7ef065ed92d6d">align_right</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a778e52afe28f1978f1f7ef065ed92d6d"><td class="mdescLeft"> </td><td class="mdescRight">Align an element on the right side. <br /></td></tr>
|
||
<tr class="separator:a778e52afe28f1978f1f7ef065ed92d6d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a1bfd3885ac8b40dc82a1103725003c07" id="r_a1bfd3885ac8b40dc82a1103725003c07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1bfd3885ac8b40dc82a1103725003c07">nothing</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> element)</td></tr>
|
||
<tr class="memdesc:a1bfd3885ac8b40dc82a1103725003c07"><td class="mdescLeft"> </td><td class="mdescRight">A decoration doing absolutely nothing. <br /></td></tr>
|
||
<tr class="separator:a1bfd3885ac8b40dc82a1103725003c07"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a23baec2f3d3a6a82e3f605d695c7e21b" id="r_a23baec2f3d3a6a82e3f605d695c7e21b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a23baec2f3d3a6a82e3f605d695c7e21b">clear_under</a> (<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
||
<tr class="memdesc:a23baec2f3d3a6a82e3f605d695c7e21b"><td class="mdescLeft"> </td><td class="mdescRight">Before drawing |child|, clear the pixels below. This is useful in. <br /></td></tr>
|
||
<tr class="separator:a23baec2f3d3a6a82e3f605d695c7e21b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad4b8aa9392f56ba41e2b421e046a7d83" id="r_ad4b8aa9392f56ba41e2b421e046a7d83"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4b8aa9392f56ba41e2b421e046a7d83">Render</a> (<a class="el" href="classftxui_1_1Screen.html">Screen</a> &screen, const <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> &element)</td></tr>
|
||
<tr class="memdesc:ad4b8aa9392f56ba41e2b421e046a7d83"><td class="mdescLeft"> </td><td class="mdescRight">Display an element on a <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">ftxui::Screen</a>. <br /></td></tr>
|
||
<tr class="separator:ad4b8aa9392f56ba41e2b421e046a7d83"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a32a24db985fa1b37bf686b00f7e1b4ff" id="r_a32a24db985fa1b37bf686b00f7e1b4ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a32a24db985fa1b37bf686b00f7e1b4ff">Render</a> (<a class="el" href="classftxui_1_1Screen.html">Screen</a> &screen, <a class="el" href="classftxui_1_1Node.html">Node</a> *node)</td></tr>
|
||
<tr class="memdesc:a32a24db985fa1b37bf686b00f7e1b4ff"><td class="mdescLeft"> </td><td class="mdescRight">Display an element on a <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">ftxui::Screen</a>. <br /></td></tr>
|
||
<tr class="separator:a32a24db985fa1b37bf686b00f7e1b4ff"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a66d988ecc082819b1671ee2bbadebccd" id="r_a66d988ecc082819b1671ee2bbadebccd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Color.html">Color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1literals.html#a66d988ecc082819b1671ee2bbadebccd">operator""_rgb</a> (unsigned long long int combined)</td></tr>
|
||
<tr class="memdesc:a66d988ecc082819b1671ee2bbadebccd"><td class="mdescLeft"> </td><td class="mdescRight">Creates a color from a combined hex RGB representation, e.g. 0x808000_rgb. <br /></td></tr>
|
||
<tr class="separator:a66d988ecc082819b1671ee2bbadebccd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a883a81f30fb771a82f6c87b77ac3658e" id="r_a883a81f30fb771a82f6c87b77ac3658e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a883a81f30fb771a82f6c87b77ac3658e">GetColorInfo</a> (<a class="el" href="classftxui_1_1Color.html#abd07c48f62cc507fafa2486a43130fcf">Color::Palette256</a> index)</td></tr>
|
||
<tr class="separator:a883a81f30fb771a82f6c87b77ac3658e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad5dd7fa2651003bf7c9f8b58de9b0a93" id="r_ad5dd7fa2651003bf7c9f8b58de9b0a93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5dd7fa2651003bf7c9f8b58de9b0a93">GetColorInfo</a> (<a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802f">Color::Palette16</a> index)</td></tr>
|
||
<tr class="separator:ad5dd7fa2651003bf7c9f8b58de9b0a93"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a1bb4947f62228380f5c415f69b34021f" id="r_a1bb4947f62228380f5c415f69b34021f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1bb4947f62228380f5c415f69b34021f">wchar_width</a> (wchar_t)</td></tr>
|
||
<tr class="separator:a1bb4947f62228380f5c415f69b34021f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:adedb4aa528ad2aef48177dea69ca7a9d" id="r_adedb4aa528ad2aef48177dea69ca7a9d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#adedb4aa528ad2aef48177dea69ca7a9d">wstring_width</a> (const std::wstring &)</td></tr>
|
||
<tr class="separator:adedb4aa528ad2aef48177dea69ca7a9d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a757b345f73bb6cde5165a4d7f0c0a298" id="r_a757b345f73bb6cde5165a4d7f0c0a298"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a757b345f73bb6cde5165a4d7f0c0a298">to_string</a> (const std::wstring &s)</td></tr>
|
||
<tr class="memdesc:a757b345f73bb6cde5165a4d7f0c0a298"><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF8 std::string into a std::wstring. <br /></td></tr>
|
||
<tr class="separator:a757b345f73bb6cde5165a4d7f0c0a298"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a57429a83a46c643a81dee81e49384439" id="r_a57429a83a46c643a81dee81e49384439"><td class="memItemLeft" align="right" valign="top">std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="#a57429a83a46c643a81dee81e49384439">to_wstring</a> (const std::string &s)</td></tr>
|
||
<tr class="memdesc:a57429a83a46c643a81dee81e49384439"><td class="mdescLeft"> </td><td class="mdescRight">Convert a std::wstring into a UTF8 std::string. <br /></td></tr>
|
||
<tr class="separator:a57429a83a46c643a81dee81e49384439"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a24ea52e8ef70889ef1da986837e0ff34" id="r_a24ea52e8ef70889ef1da986837e0ff34"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||
<tr class="memitem:a24ea52e8ef70889ef1da986837e0ff34"><td class="memTemplItemLeft" align="right" valign="top">std::wstring </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a24ea52e8ef70889ef1da986837e0ff34">to_wstring</a> (T s)</td></tr>
|
||
<tr class="separator:a24ea52e8ef70889ef1da986837e0ff34"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a517b35c7721e632812d8b3a7697c4099" id="r_a517b35c7721e632812d8b3a7697c4099"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a517b35c7721e632812d8b3a7697c4099">string_width</a> (const std::string &)</td></tr>
|
||
<tr class="separator:a517b35c7721e632812d8b3a7697c4099"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a389c58d385e861cd2ef109b53fc6ef96" id="r_a389c58d385e861cd2ef109b53fc6ef96"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a389c58d385e861cd2ef109b53fc6ef96">Utf8ToGlyphs</a> (const std::string &input)</td></tr>
|
||
<tr class="separator:a389c58d385e861cd2ef109b53fc6ef96"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0bfd67a2815807dc6fc9bc0f79bce29e" id="r_a0bfd67a2815807dc6fc9bc0f79bce29e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bfd67a2815807dc6fc9bc0f79bce29e">CatchEvent</a> (<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> child, std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a> event)> on_event)</td></tr>
|
||
<tr class="memdesc:a0bfd67a2815807dc6fc9bc0f79bce29e"><td class="mdescLeft"> </td><td class="mdescRight">Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. <br /></td></tr>
|
||
<tr class="separator:a0bfd67a2815807dc6fc9bc0f79bce29e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a737061bef132d71c408d12a5d538827a" id="r_a737061bef132d71c408d12a5d538827a"><td class="memItemLeft" align="right" valign="top">template <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a737061bef132d71c408d12a5d538827a">Slider</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, int *value, int min, int max, int increment)</td></tr>
|
||
<tr class="separator:a737061bef132d71c408d12a5d538827a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a8ce92386e55e65bb157162d0ee1cf159" id="r_a8ce92386e55e65bb157162d0ee1cf159"><td class="memItemLeft" align="right" valign="top">template <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ce92386e55e65bb157162d0ee1cf159">Slider</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, float *value, float min, float max, float increment)</td></tr>
|
||
<tr class="separator:a8ce92386e55e65bb157162d0ee1cf159"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad6ce10b7cb20a078b35f759c0e2b91c5" id="r_ad6ce10b7cb20a078b35f759c0e2b91c5"><td class="memItemLeft" align="right" valign="top">template <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6ce10b7cb20a078b35f759c0e2b91c5">Slider</a> (<a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a> label, long *value, long min, long max, long increment)</td></tr>
|
||
<tr class="separator:ad6ce10b7cb20a078b35f759c0e2b91c5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
||
Enumerations</h2></td></tr>
|
||
<tr class="memitem:afe3103dd0b8240c5443892484ef5af9c" id="r_afe3103dd0b8240c5443892484ef5af9c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a> { <a class="el" href="#afe3103dd0b8240c5443892484ef5af9caf917d6c11c85b4ac32e30d1cc9da25eb">LIGHT</a>
|
||
, <a class="el" href="#afe3103dd0b8240c5443892484ef5af9ca34cd68a92c52759ed9b545969a11c2da">HEAVY</a>
|
||
, <a class="el" href="#afe3103dd0b8240c5443892484ef5af9ca33465d1d419b1074fb259ef444609e92">DOUBLE</a>
|
||
, <a class="el" href="#afe3103dd0b8240c5443892484ef5af9ca655074b92b285adff7d18a45748bf493">ROUNDED</a>
|
||
}</td></tr>
|
||
<tr class="separator:afe3103dd0b8240c5443892484ef5af9c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a224b9163917ac32fc95a60d8c1eec3aa" id="r_a224b9163917ac32fc95a60d8c1eec3aa"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> { <a class="el" href="#a224b9163917ac32fc95a60d8c1eec3aaa73c0818986b7c462c2977f57afd00522">WIDTH</a>
|
||
, <a class="el" href="#a224b9163917ac32fc95a60d8c1eec3aaa38b9241136017b93ea2755a49cf0a000">HEIGHT</a>
|
||
}</td></tr>
|
||
<tr class="separator:a224b9163917ac32fc95a60d8c1eec3aa"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae09f44b989d381a387329fd0a0935926" id="r_ae09f44b989d381a387329fd0a0935926"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae09f44b989d381a387329fd0a0935926">Constraint</a> { <a class="el" href="#ae09f44b989d381a387329fd0a0935926a41b05932cd237b2b133fff1ade85bed5">LESS_THAN</a>
|
||
, <a class="el" href="#ae09f44b989d381a387329fd0a0935926a59a84258a4cb9025b567ee5139455029">EQUAL</a>
|
||
, <a class="el" href="#ae09f44b989d381a387329fd0a0935926a5fae95457121bd697edd588d1b64cc7c">GREATER_THAN</a>
|
||
}</td></tr>
|
||
<tr class="separator:ae09f44b989d381a387329fd0a0935926"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
||
Typedefs</h2></td></tr>
|
||
<tr class="memitem:a24b663cb6b0b262055c94d3a03bdd274" id="r_a24b663cb6b0b262055c94d3a03bdd274"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> = std::unique_ptr<<a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a>></td></tr>
|
||
<tr class="separator:a24b663cb6b0b262055c94d3a03bdd274"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af1479ede01dbf087342534ab4ada11d3" id="r_af1479ede01dbf087342534ab4ada11d3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> = std::shared_ptr<<a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a>></td></tr>
|
||
<tr class="separator:af1479ede01dbf087342534ab4ada11d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3d4ccad0c8a07d5b0cb4b2e690ffc90c" id="r_a3d4ccad0c8a07d5b0cb4b2e690ffc90c"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> = std::vector<<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a>></td></tr>
|
||
<tr class="separator:a3d4ccad0c8a07d5b0cb4b2e690ffc90c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a8f713c247c551bd416c4697ed9ab871c" id="r_a8f713c247c551bd416c4697ed9ab871c"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
||
<tr class="memitem:a8f713c247c551bd416c4697ed9ab871c"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8f713c247c551bd416c4697ed9ab871c">Sender</a> = std::unique_ptr<<a class="el" href="classftxui_1_1SenderImpl.html">SenderImpl</a><T>></td></tr>
|
||
<tr class="separator:a8f713c247c551bd416c4697ed9ab871c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a7abbe763f26611fbf3902861863b7659" id="r_a7abbe763f26611fbf3902861863b7659"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
||
<tr class="memitem:a7abbe763f26611fbf3902861863b7659"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a7abbe763f26611fbf3902861863b7659">Receiver</a> = std::unique_ptr<<a class="el" href="classftxui_1_1ReceiverImpl.html">ReceiverImpl</a><T>></td></tr>
|
||
<tr class="separator:a7abbe763f26611fbf3902861863b7659"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2bc31f2d685189e5c61d2293a1f51b4f" id="r_a2bc31f2d685189e5c61d2293a1f51b4f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> = std::shared_ptr<<a class="el" href="classftxui_1_1Node.html">Node</a>></td></tr>
|
||
<tr class="separator:a2bc31f2d685189e5c61d2293a1f51b4f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5d4aa06ca6cc6a72e981bd5386f93f0a" id="r_a5d4aa06ca6cc6a72e981bd5386f93f0a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> = std::vector<<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>></td></tr>
|
||
<tr class="separator:a5d4aa06ca6cc6a72e981bd5386f93f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a164021903e9ac6f1357e4186582891e3" id="r_a164021903e9ac6f1357e4186582891e3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> = std::function<<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)></td></tr>
|
||
<tr class="separator:a164021903e9ac6f1357e4186582891e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab07cb9a766f38fc867f8fe736ce2e6e3" id="r_ab07cb9a766f38fc867f8fe736ce2e6e3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab07cb9a766f38fc867f8fe736ce2e6e3">GraphFunction</a> = std::function<std::vector<int>(int, int)></td></tr>
|
||
<tr class="separator:ab07cb9a766f38fc867f8fe736ce2e6e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||
Data Structures</h2></td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1AutoReset.html">AutoReset</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Assign a value to a variable, reset its old value when going out of scope. <a href="classftxui_1_1AutoReset.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1Box.html">Box</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1ButtonOption" id="r_structftxui_1_1ButtonOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1ButtonOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Button component. <a href="#structftxui_1_1ButtonOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1ButtonOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1CheckboxOption" id="r_structftxui_1_1CheckboxOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1CheckboxOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Checkbox component. <a href="#structftxui_1_1CheckboxOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1CheckboxOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Color.html">Color</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class representing terminal colors. <a href="classftxui_1_1Color.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1ColorInfo" id="r_structftxui_1_1ColorInfo"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a></td></tr>
|
||
<tr class="separator:structftxui_1_1ColorInfo"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">It implement rendering itself as <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a>. It implement keyboard navigation by responding to <a class="el" href="structftxui_1_1Event.html" title="Represent an event. It can be key press event, a terminal resize, or more ...">ftxui::Event</a>. <a href="classftxui_1_1ComponentBase.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An adapter. Own or reference an immutable object. <a href="classftxui_1_1ConstRef.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An adapter. Reference a list of strings. <a href="classftxui_1_1ConstStringListRef.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation. <a href="classftxui_1_1ConstStringRef.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1Dimensions" id="r_structftxui_1_1Dimensions"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1Dimensions">Dimensions</a></td></tr>
|
||
<tr class="separator:structftxui_1_1Dimensions"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1Event.html">Event</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represent an event. It can be key press event, a terminal resize, or more ... <a href="structftxui_1_1Event.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1InputOption" id="r_structftxui_1_1InputOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1InputOption">InputOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1InputOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Input component. <a href="#structftxui_1_1InputOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1InputOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1MenuEntryOption" id="r_structftxui_1_1MenuEntryOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1MenuEntryOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the MenuEntry component. <a href="#structftxui_1_1MenuEntryOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1MenuEntryOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1MenuOption" id="r_structftxui_1_1MenuOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1MenuOption">MenuOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1MenuOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Menu component. <a href="#structftxui_1_1MenuOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1MenuOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1Mouse.html">Mouse</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift, ctrl, meta). <a href="structftxui_1_1Mouse.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Node.html">Node</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1NodeDecorator.html">NodeDecorator</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1Pixel.html">Pixel</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A unicode character and its associated style. <a href="structftxui_1_1Pixel.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1RadioboxOption" id="r_structftxui_1_1RadioboxOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1RadioboxOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Radiobox component. <a href="#structftxui_1_1RadioboxOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1RadioboxOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ReceiverImpl.html">ReceiverImpl</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Ref.html">Ref</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An adapter. Own or reference an mutable object. <a href="classftxui_1_1Ref.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1Requirement.html">Requirement</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html">Screen</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A rectangular grid of <a class="el" href="structftxui_1_1Pixel.html" title="A unicode character and its associated style.">Pixel</a>. <a href="classftxui_1_1Screen.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1SenderImpl.html">SenderImpl</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation. <a href="classftxui_1_1StringRef.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1TerminalInputParser.html">TerminalInputParser</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:structftxui_1_1ToggleOption" id="r_structftxui_1_1ToggleOption"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="#structftxui_1_1ToggleOption">ToggleOption</a></td></tr>
|
||
<tr class="memdesc:structftxui_1_1ToggleOption"><td class="mdescLeft"> </td><td class="mdescRight">Option for the Toggle component. <a href="#structftxui_1_1ToggleOption">More...</a><br /></td></tr>
|
||
<tr class="separator:structftxui_1_1ToggleOption"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1WideStringRef.html">WideStringRef</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation. <a href="classftxui_1_1WideStringRef.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
|
||
Namespaces</h2></td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1box__helper.html">box_helper</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1Container.html">Container</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1Dimension.html">Dimension</a></td></tr>
|
||
<tr class="memdesc:namespaceftxui_1_1Dimension"><td class="mdescLeft"> </td><td class="mdescRight">Define how the <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">Screen</a>'s dimensions should look like. <br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1literals.html">literals</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1Terminal.html">Terminal</a></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
||
Variables</h2></td></tr>
|
||
<tr class="memitem:a987f5d0522854bb0c2be1b58c72ffe1c" id="r_a987f5d0522854bb0c2be1b58c72ffe1c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a987f5d0522854bb0c2be1b58c72ffe1c">palette256</a> []</td></tr>
|
||
<tr class="separator:a987f5d0522854bb0c2be1b58c72ffe1c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
||
<a name="structftxui_1_1ButtonOption" id="structftxui_1_1ButtonOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1ButtonOption">◆ </a></span>ftxui::ButtonOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::ButtonOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1CheckboxOption" id="structftxui_1_1CheckboxOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1CheckboxOption">◆ </a></span>ftxui::CheckboxOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::CheckboxOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1ColorInfo" id="structftxui_1_1ColorInfo"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1ColorInfo">◆ </a></span>ftxui::ColorInfo</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::ColorInfo</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1Dimensions" id="structftxui_1_1Dimensions"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1Dimensions">◆ </a></span>ftxui::Dimensions</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::Dimensions</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1InputOption" id="structftxui_1_1InputOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1InputOption">◆ </a></span>ftxui::InputOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::InputOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1MenuEntryOption" id="structftxui_1_1MenuEntryOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1MenuEntryOption">◆ </a></span>ftxui::MenuEntryOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::MenuEntryOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1MenuOption" id="structftxui_1_1MenuOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1MenuOption">◆ </a></span>ftxui::MenuOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::MenuOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1RadioboxOption" id="structftxui_1_1RadioboxOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1RadioboxOption">◆ </a></span>ftxui::RadioboxOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::RadioboxOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a name="structftxui_1_1ToggleOption" id="structftxui_1_1ToggleOption"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#structftxui_1_1ToggleOption">◆ </a></span>ftxui::ToggleOption</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">struct ftxui::ToggleOption</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Typedef Documentation</h2>
|
||
<a id="a24b663cb6b0b262055c94d3a03bdd274" name="a24b663cb6b0b262055c94d3a03bdd274"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a24b663cb6b0b262055c94d3a03bdd274">◆ </a></span>CapturedMouse</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">using <a class="el" href="#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> = std::unique_ptr<<a class="el" href="classftxui_1_1CapturedMouseInterface.html">CapturedMouseInterface</a>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="captured__mouse_8hpp_source.html#l00011">11</a> of file <a class="el" href="captured__mouse_8hpp_source.html">captured_mouse.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af1479ede01dbf087342534ab4ada11d3" name="af1479ede01dbf087342534ab4ada11d3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af1479ede01dbf087342534ab4ada11d3">◆ </a></span>Component</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">typedef std::shared_ptr< <a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> > <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> = std::shared_ptr<<a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00017">17</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a3d4ccad0c8a07d5b0cb4b2e690ffc90c" name="a3d4ccad0c8a07d5b0cb4b2e690ffc90c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">◆ </a></span>Components</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">using <a class="el" href="#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> = std::vector<<a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00018">18</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a8f713c247c551bd416c4697ed9ab871c" name="a8f713c247c551bd416c4697ed9ab871c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a8f713c247c551bd416c4697ed9ab871c">◆ </a></span>Sender</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<class T > </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">using <a class="el" href="#a8f713c247c551bd416c4697ed9ab871c">Sender</a> = std::unique_ptr<<a class="el" href="classftxui_1_1SenderImpl.html">SenderImpl</a><T>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="receiver_8hpp_source.html#l00044">44</a> of file <a class="el" href="receiver_8hpp_source.html">receiver.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a7abbe763f26611fbf3902861863b7659" name="a7abbe763f26611fbf3902861863b7659"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7abbe763f26611fbf3902861863b7659">◆ </a></span>Receiver</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<class T > </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">using <a class="el" href="#a7abbe763f26611fbf3902861863b7659">Receiver</a> = std::unique_ptr<<a class="el" href="classftxui_1_1ReceiverImpl.html">ReceiverImpl</a><T>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="receiver_8hpp_source.html#l00045">45</a> of file <a class="el" href="receiver_8hpp_source.html">receiver.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a2bc31f2d685189e5c61d2293a1f51b4f" name="a2bc31f2d685189e5c61d2293a1f51b4f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2bc31f2d685189e5c61d2293a1f51b4f">◆ </a></span>Element</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">typedef std::shared_ptr< <a class="el" href="classftxui_1_1Node.html">Node</a> > <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> = std::shared_ptr<<a class="el" href="classftxui_1_1Node.html">Node</a>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00015">15</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5d4aa06ca6cc6a72e981bd5386f93f0a" name="a5d4aa06ca6cc6a72e981bd5386f93f0a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">◆ </a></span>Elements</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">typedef std::vector< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> > <a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> = std::vector<<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00016">16</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a164021903e9ac6f1357e4186582891e3" name="a164021903e9ac6f1357e4186582891e3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a164021903e9ac6f1357e4186582891e3">◆ </a></span>Decorator</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">using <a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> = std::function<<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>)></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00017">17</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab07cb9a766f38fc867f8fe736ce2e6e3" name="ab07cb9a766f38fc867f8fe736ce2e6e3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab07cb9a766f38fc867f8fe736ce2e6e3">◆ </a></span>GraphFunction</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">using <a class="el" href="#ab07cb9a766f38fc867f8fe736ce2e6e3">GraphFunction</a> = std::function<std::vector<int>(int, int)></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00018">18</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
||
<a id="afe3103dd0b8240c5443892484ef5af9c" name="afe3103dd0b8240c5443892484ef5af9c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afe3103dd0b8240c5443892484ef5af9c">◆ </a></span>BorderStyle</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">enum <a class="el" href="#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<table class="fieldtable">
|
||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afe3103dd0b8240c5443892484ef5af9caf917d6c11c85b4ac32e30d1cc9da25eb" name="afe3103dd0b8240c5443892484ef5af9caf917d6c11c85b4ac32e30d1cc9da25eb"></a>LIGHT </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="afe3103dd0b8240c5443892484ef5af9ca34cd68a92c52759ed9b545969a11c2da" name="afe3103dd0b8240c5443892484ef5af9ca34cd68a92c52759ed9b545969a11c2da"></a>HEAVY </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="afe3103dd0b8240c5443892484ef5af9ca33465d1d419b1074fb259ef444609e92" name="afe3103dd0b8240c5443892484ef5af9ca33465d1d419b1074fb259ef444609e92"></a>DOUBLE </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="afe3103dd0b8240c5443892484ef5af9ca655074b92b285adff7d18a45748bf493" name="afe3103dd0b8240c5443892484ef5af9ca655074b92b285adff7d18a45748bf493"></a>ROUNDED </td><td class="fielddoc"></td></tr>
|
||
</table>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00020">20</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a224b9163917ac32fc95a60d8c1eec3aa" name="a224b9163917ac32fc95a60d8c1eec3aa"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a224b9163917ac32fc95a60d8c1eec3aa">◆ </a></span>Direction</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">enum <a class="el" href="#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<table class="fieldtable">
|
||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a224b9163917ac32fc95a60d8c1eec3aaa73c0818986b7c462c2977f57afd00522" name="a224b9163917ac32fc95a60d8c1eec3aaa73c0818986b7c462c2977f57afd00522"></a>WIDTH </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="a224b9163917ac32fc95a60d8c1eec3aaa38b9241136017b93ea2755a49cf0a000" name="a224b9163917ac32fc95a60d8c1eec3aaa38b9241136017b93ea2755a49cf0a000"></a>HEIGHT </td><td class="fielddoc"></td></tr>
|
||
</table>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00090">90</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae09f44b989d381a387329fd0a0935926" name="ae09f44b989d381a387329fd0a0935926"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae09f44b989d381a387329fd0a0935926">◆ </a></span>Constraint</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">enum <a class="el" href="#ae09f44b989d381a387329fd0a0935926">Constraint</a></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<table class="fieldtable">
|
||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae09f44b989d381a387329fd0a0935926a41b05932cd237b2b133fff1ade85bed5" name="ae09f44b989d381a387329fd0a0935926a41b05932cd237b2b133fff1ade85bed5"></a>LESS_THAN </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="ae09f44b989d381a387329fd0a0935926a59a84258a4cb9025b567ee5139455029" name="ae09f44b989d381a387329fd0a0935926a59a84258a4cb9025b567ee5139455029"></a>EQUAL </td><td class="fielddoc"></td></tr>
|
||
<tr><td class="fieldname"><a id="ae09f44b989d381a387329fd0a0935926a5fae95457121bd697edd588d1b64cc7c" name="ae09f44b989d381a387329fd0a0935926a5fae95457121bd697edd588d1b64cc7c"></a>GREATER_THAN </td><td class="fielddoc"></td></tr>
|
||
</table>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="elements_8hpp_source.html#l00091">91</a> of file <a class="el" href="elements_8hpp_source.html">elements.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Function Documentation</h2>
|
||
<a id="a2b8973dc71334f1d98e2e6f55de8b5ae" name="a2b8973dc71334f1d98e2e6f55de8b5ae"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2b8973dc71334f1d98e2e6f55de8b5ae">◆ </a></span>Make()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<class T , class... Args> </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::shared_ptr< T > Make </td>
|
||
<td>(</td>
|
||
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="component_8hpp_source.html#l00025">25</a> of file <a class="el" href="component_8hpp_source.html">component.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a6910ffaa082c693603aafab4e7dddac3" name="a6910ffaa082c693603aafab4e7dddac3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a6910ffaa082c693603aafab4e7dddac3">◆ </a></span>Button()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Button </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< void()></td> <td class="paramname"><span class="paramname"><em>on_click</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1ButtonOption">ButtonOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a button. Execute a function when clicked. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The label of the button. </td></tr>
|
||
<tr><td class="paramname">on_click</td><td>The action to execute when clicked. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>ButtonBase</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md0"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string label = <span class="stringliteral">"Click to quit"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> button = <a class="code hl_function" href="#a6910ffaa082c693603aafab4e7dddac3">Button</a>(&label, screen.ExitLoopClosure());</div>
|
||
<div class="line">screen.Loop(button)</div>
|
||
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html_a4f458e443ed672c2aea9fdd96531a621"><div class="ttname"><a href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ftxui::ScreenInteractive::FitComponent</a></div><div class="ttdeci">static ScreenInteractive FitComponent()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00260">screen_interactive.cpp:260</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a6910ffaa082c693603aafab4e7dddac3"><div class="ttname"><a href="#a6910ffaa082c693603aafab4e7dddac3">ftxui::Button</a></div><div class="ttdeci">Component Button(ConstStringRef label, std::function< void()> on_click, Ref< ButtonOption >={})</div><div class="ttdoc">Draw a button. Execute a function when clicked.</div><div class="ttdef"><b>Definition</b> <a href="button_8cpp_source.html#l00090">button.cpp:90</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_af1479ede01dbf087342534ab4ada11d3"><div class="ttname"><a href="#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#l00017">component_base.hpp:17</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md1"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┌─────────────┐</div>
|
||
<div class="line">│Click to quit│</div>
|
||
<div class="line">└─────────────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="button_8cpp_source.html#l00090">90</a> of file <a class="el" href="button_8cpp_source.html">button.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a04e40e348dee25bbbfce0a13bf234e19" name="a04e40e348dee25bbbfce0a13bf234e19"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a04e40e348dee25bbbfce0a13bf234e19">◆ </a></span>Checkbox()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Checkbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>checked</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1CheckboxOption">CheckboxOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw checkable element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The label of the checkbox. </td></tr>
|
||
<tr><td class="paramname">checked</td><td>Whether the checkbox is checked or not. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>CheckboxBase</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md3"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string label = <span class="stringliteral">"Make a sandwidth"</span>;</div>
|
||
<div class="line"><span class="keywordtype">bool</span> checked = <span class="keyword">false</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> checkbox = <a class="code hl_function" href="#a04e40e348dee25bbbfce0a13bf234e19">Checkbox</a>(&label, &checked);</div>
|
||
<div class="line">screen.Loop(checkbox)</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a04e40e348dee25bbbfce0a13bf234e19"><div class="ttname"><a href="#a04e40e348dee25bbbfce0a13bf234e19">ftxui::Checkbox</a></div><div class="ttdeci">Component Checkbox(ConstStringRef label, bool *checked, Ref< CheckboxOption > option={})</div><div class="ttdoc">Draw checkable element.</div><div class="ttdef"><b>Definition</b> <a href="checkbox_8cpp_source.html#l00117">checkbox.cpp:117</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md4"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">☐ Make a sandwitch</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="checkbox_8cpp_source.html#l00117">117</a> of file <a class="el" href="checkbox_8cpp_source.html">checkbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a30be54a28004c1c48c2a5ed54e4abd64" name="a30be54a28004c1c48c2a5ed54e4abd64"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a30be54a28004c1c48c2a5ed54e4abd64">◆ </a></span>Input() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Input </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a></td> <td class="paramname"><span class="paramname"><em>content</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>placeholder</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1InputOption">InputOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An input box for editing text. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">content</td><td>The editable content. </td></tr>
|
||
<tr><td class="paramname">placeholder</td><td>The text displayed when content is still empty. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>InputBase</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md10"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string content= <span class="stringliteral">""</span>;</div>
|
||
<div class="line">std::string placeholder = <span class="stringliteral">"placeholder"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> input = <a class="code hl_function" href="#a30be54a28004c1c48c2a5ed54e4abd64">Input</a>(&content, &placeholder);</div>
|
||
<div class="line">screen.Loop(input);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a30be54a28004c1c48c2a5ed54e4abd64"><div class="ttname"><a href="#a30be54a28004c1c48c2a5ed54e4abd64">ftxui::Input</a></div><div class="ttdeci">Component Input(StringRef content, ConstStringRef placeholder, Ref< InputOption > option={})</div><div class="ttdoc">An input box for editing text.</div><div class="ttdef"><b>Definition</b> <a href="input_8cpp_source.html#l00241">input.cpp:241</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md11"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">placeholder</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="input_8cpp_source.html#l00241">241</a> of file <a class="el" href="input_8cpp_source.html">input.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a777280bcec2414bef5c6725658c7714b" name="a777280bcec2414bef5c6725658c7714b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a777280bcec2414bef5c6725658c7714b">◆ </a></span>Menu()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Menu </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1MenuOption">MenuOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of text. The focused element is selected. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of entries in the menu. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>The index of the currently selected element. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>MenuBase</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md14"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::vector<std::string> entries = {</div>
|
||
<div class="line"> <span class="stringliteral">"entry 1"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 2"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 3"</span>,</div>
|
||
<div class="line">};</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#a777280bcec2414bef5c6725658c7714b">Menu</a>(&entries, &selected);</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html_a0b7de0467b4e57ce5f337ba8634d8d13"><div class="ttname"><a href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ftxui::ScreenInteractive::TerminalOutput</a></div><div class="ttdeci">static ScreenInteractive TerminalOutput()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00255">screen_interactive.cpp:255</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a777280bcec2414bef5c6725658c7714b"><div class="ttname"><a href="#a777280bcec2414bef5c6725658c7714b">ftxui::Menu</a></div><div class="ttdeci">Component Menu(ConstStringListRef entries, int *selected_, Ref< MenuOption >={})</div><div class="ttdoc">A list of text. The focused element is selected.</div><div class="ttdef"><b>Definition</b> <a href="menu_8cpp_source.html#l00173">menu.cpp:173</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md15"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">> entry 1</div>
|
||
<div class="line"> entry 2</div>
|
||
<div class="line"> entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="menu_8cpp_source.html#l00173">173</a> of file <a class="el" href="menu_8cpp_source.html">menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab984001f4208b35a22b9dcafae4debb6" name="ab984001f4208b35a22b9dcafae4debb6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab984001f4208b35a22b9dcafae4debb6">◆ </a></span>MenuEntry()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> MenuEntry </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1MenuEntryOption">MenuEntryOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="menu_8cpp_source.html#l00179">179</a> of file <a class="el" href="menu_8cpp_source.html">menu.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aa22bddff4aeed66e20f30d0715596999" name="aa22bddff4aeed66e20f30d0715596999"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa22bddff4aeed66e20f30d0715596999">◆ </a></span>Dropdown()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Dropdown </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="dropdown_8cpp_source.html#l00007">7</a> of file <a class="el" href="dropdown_8cpp_source.html">dropdown.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0d757f667caaff5287cb8702f52186ee" name="a0d757f667caaff5287cb8702f52186ee"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0d757f667caaff5287cb8702f52186ee">◆ </a></span>Radiobox()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Radiobox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1RadioboxOption">RadioboxOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A list of element, where only one can be selected. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of entries in the list. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>The index of the currently selected element. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>RadioboxBase</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md16"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::vector<std::string> entries = {</div>
|
||
<div class="line"> <span class="stringliteral">"entry 1"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 2"</span>,</div>
|
||
<div class="line"> <span class="stringliteral">"entry 3"</span>,</div>
|
||
<div class="line">};</div>
|
||
<div class="line"><span class="keywordtype">int</span> selected = 0;</div>
|
||
<div class="line"><span class="keyword">auto</span> menu = <a class="code hl_function" href="#a0d757f667caaff5287cb8702f52186ee">Radiobox</a>(&entries, &selected);</div>
|
||
<div class="line">screen.Loop(menu);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a0d757f667caaff5287cb8702f52186ee"><div class="ttname"><a href="#a0d757f667caaff5287cb8702f52186ee">ftxui::Radiobox</a></div><div class="ttdeci">Component Radiobox(ConstStringListRef entries, int *selected_, Ref< RadioboxOption > option={})</div><div class="ttdoc">A list of element, where only one can be selected.</div><div class="ttdef"><b>Definition</b> <a href="radiobox_8cpp_source.html#l00190">radiobox.cpp:190</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md17"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">◉ entry 1</div>
|
||
<div class="line">○ entry 2</div>
|
||
<div class="line">○ entry 3</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="radiobox_8cpp_source.html#l00190">190</a> of file <a class="el" href="radiobox_8cpp_source.html">radiobox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a1c4cbe6596ef55350f8a6a49a090510c" name="a1c4cbe6596ef55350f8a6a49a090510c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a1c4cbe6596ef55350f8a6a49a090510c">◆ </a></span>Toggle()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Toggle </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a></td> <td class="paramname"><span class="paramname"><em>entries</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>selected</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1ToggleOption">ToggleOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal list of elements. The user can navigate through them. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">entries</td><td>The list of selectable entries to display. </td></tr>
|
||
<tr><td class="paramname">selected</td><td>Reference the selected entry. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="toggle_8cpp_source.html#l00126">126</a> of file <a class="el" href="toggle_8cpp_source.html">toggle.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="acc572957ec06e5eb955856ee058f8d90" name="acc572957ec06e5eb955856ee058f8d90"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#acc572957ec06e5eb955856ee058f8d90">◆ </a></span>Slider() <span class="overload">[1/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<class T > </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Slider </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">T *</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>min</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>max</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>increment</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal slider. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">label</td><td>The name of the slider. </td></tr>
|
||
<tr><td class="paramname">value</td><td>The current value of the slider. </td></tr>
|
||
<tr><td class="paramname">min</td><td>The minimum value. </td></tr>
|
||
<tr><td class="paramname">max</td><td>The maximum value. </td></tr>
|
||
<tr><td class="paramname">increment</td><td>The increment when used by the cursor.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md29"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> value = 50;</div>
|
||
<div class="line"><span class="keyword">auto</span> slider = <a class="code hl_function" href="#acc572957ec06e5eb955856ee058f8d90">Slider</a>(<span class="stringliteral">"Value:"</span>, &value, 0, 100, 1);</div>
|
||
<div class="line">screen.Loop(slider);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_acc572957ec06e5eb955856ee058f8d90"><div class="ttname"><a href="#acc572957ec06e5eb955856ee058f8d90">ftxui::Slider</a></div><div class="ttdeci">Component Slider(ConstStringRef label, T *value, T min, T max, T increment)</div><div class="ttdoc">An horizontal slider.</div><div class="ttdef"><b>Definition</b> <a href="slider_8cpp_source.html#l00123">slider.cpp:123</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md30"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">Value:[██████████████████████████ ]</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="slider_8cpp_source.html#l00123">123</a> of file <a class="el" href="slider_8cpp_source.html">slider.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae2205fc172615b43e1e3307bb614be4c" name="ae2205fc172615b43e1e3307bb614be4c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae2205fc172615b43e1e3307bb614be4c">◆ </a></span>ResizableSplitLeft()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitLeft </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the left. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the right. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md21"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> left_size = 10;</div>
|
||
<div class="line"><span class="keyword">auto</span> left = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Left"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> right = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"right"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = <a class="code hl_function" href="#ae2205fc172615b43e1e3307bb614be4c">ResizableSplitLeft</a>(left, right, &left_size);</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html_a53dc5c3030151713857cf1a898d0f897"><div class="ttname"><a href="classftxui_1_1ScreenInteractive.html#a53dc5c3030151713857cf1a898d0f897">ftxui::ScreenInteractive::Fullscreen</a></div><div class="ttdeci">static ScreenInteractive Fullscreen()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00250">screen_interactive.cpp:250</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a533e883e2aeea28de2b60564fcaf0361"><div class="ttname"><a href="#a533e883e2aeea28de2b60564fcaf0361">ftxui::Renderer</a></div><div class="ttdeci">Component Renderer(Component child, std::function< Element()>)</div><div class="ttdoc">Return a new Component, similar to |child|, but using |render| as the Component::Render() event.</div><div class="ttdef"><b>Definition</b> <a href="renderer_8cpp_source.html#l00059">renderer.cpp:59</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a5b11656305fce8427b81daf1c35883f1"><div class="ttname"><a href="#a5b11656305fce8427b81daf1c35883f1">ftxui::center</a></div><div class="ttdeci">Element center(Element)</div><div class="ttdoc">Center an element horizontally and vertically.</div><div class="ttdef"><b>Definition</b> <a href="composite__decorator_8cpp_source.html#l00028">composite_decorator.cpp:28</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_a75baaa2734ed76a9f478beaafa87ae57"><div class="ttname"><a href="#a75baaa2734ed76a9f478beaafa87ae57">ftxui::text</a></div><div class="ttdeci">Element text(std::wstring text)</div><div class="ttdoc">Display a piece of unicode text.</div><div class="ttdef"><b>Definition</b> <a href="text_8cpp_source.html#l00106">text.cpp:106</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_ae2205fc172615b43e1e3307bb614be4c"><div class="ttname"><a href="#ae2205fc172615b43e1e3307bb614be4c">ftxui::ResizableSplitLeft</a></div><div class="ttdeci">Component ResizableSplitLeft(Component main, Component back, int *main_size)</div><div class="ttdoc">An horizontal split in between two components, configurable using the mouse.</div><div class="ttdef"><b>Definition</b> <a href="resizable__split_8cpp_source.html#l00266">resizable_split.cpp:266</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md22"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> │</div>
|
||
<div class="line">left │ right</div>
|
||
<div class="line"> │</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="resizable__split_8cpp_source.html#l00266">266</a> of file <a class="el" href="resizable__split_8cpp_source.html">resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9030d0beb64f653603cab382b02750a8" name="a9030d0beb64f653603cab382b02750a8"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9030d0beb64f653603cab382b02750a8">◆ </a></span>ResizableSplitRight()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitRight </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An horizontal split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the right. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the left. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md23"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> right_size = 10;</div>
|
||
<div class="line"><span class="keyword">auto</span> left = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Left"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> right = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"right"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = <a class="code hl_function" href="#a9030d0beb64f653603cab382b02750a8">ResizableSplitRight</a>(right, left, &right_size);</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a9030d0beb64f653603cab382b02750a8"><div class="ttname"><a href="#a9030d0beb64f653603cab382b02750a8">ftxui::ResizableSplitRight</a></div><div class="ttdeci">Component ResizableSplitRight(Component main, Component back, int *main_size)</div><div class="ttdoc">An horizontal split in between two components, configurable using the mouse.</div><div class="ttdef"><b>Definition</b> <a href="resizable__split_8cpp_source.html#l00296">resizable_split.cpp:296</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md24"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> │</div>
|
||
<div class="line">left │ right</div>
|
||
<div class="line"> │</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="resizable__split_8cpp_source.html#l00296">296</a> of file <a class="el" href="resizable__split_8cpp_source.html">resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a238b4b650aca14716b82b2198695e008" name="a238b4b650aca14716b82b2198695e008"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a238b4b650aca14716b82b2198695e008">◆ </a></span>ResizableSplitTop()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitTop </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An vertical split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the top. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the bottom. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md25"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> top_size = 1;</div>
|
||
<div class="line"><span class="keyword">auto</span> top = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Top"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> bottom = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Bottom"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = <a class="code hl_function" href="#a238b4b650aca14716b82b2198695e008">ResizableSplitTop</a>(top, bottom, &top_size);</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a238b4b650aca14716b82b2198695e008"><div class="ttname"><a href="#a238b4b650aca14716b82b2198695e008">ftxui::ResizableSplitTop</a></div><div class="ttdeci">Component ResizableSplitTop(Component main, Component back, int *main_size)</div><div class="ttdoc">An vertical split in between two components, configurable using the mouse.</div><div class="ttdef"><b>Definition</b> <a href="resizable__split_8cpp_source.html#l00326">resizable_split.cpp:326</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md26"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> top</div>
|
||
<div class="line">────────────</div>
|
||
<div class="line"> bottom</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="resizable__split_8cpp_source.html#l00326">326</a> of file <a class="el" href="resizable__split_8cpp_source.html">resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="acb75e6e61a021829893f7b57aeb7e3a2" name="acb75e6e61a021829893f7b57aeb7e3a2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#acb75e6e61a021829893f7b57aeb7e3a2">◆ </a></span>ResizableSplitBottom()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> ResizableSplitBottom </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>main</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>back</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>main_size</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An vertical split in between two components, configurable using the mouse. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">main</td><td>The main component of size |main_size|, on the bottom. </td></tr>
|
||
<tr><td class="paramname">back</td><td>The back component taking the remaining size, on the top. </td></tr>
|
||
<tr><td class="paramname">main_size</td><td>The size of the |main| component.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md27"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a53dc5c3030151713857cf1a898d0f897">ScreenInteractive::Fullscreen</a>();</div>
|
||
<div class="line"><span class="keywordtype">int</span> bottom_size = 1;</div>
|
||
<div class="line"><span class="keyword">auto</span> top = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Top"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> bottom = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Bottom"</span>) | <a class="code hl_function" href="#a5b11656305fce8427b81daf1c35883f1">center</a>;});</div>
|
||
<div class="line"><span class="keyword">auto</span> split = ResizableSplit::Bottom(bottom, top, &bottom_size);</div>
|
||
<div class="line">screen.Loop(split);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md28"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line"> top</div>
|
||
<div class="line">────────────</div>
|
||
<div class="line"> bottom</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="resizable__split_8cpp_source.html#l00356">356</a> of file <a class="el" href="resizable__split_8cpp_source.html">resizable_split.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a533e883e2aeea28de2b60564fcaf0361" name="a533e883e2aeea28de2b60564fcaf0361"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a533e883e2aeea28de2b60564fcaf0361">◆ </a></span>Renderer() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()></td> <td class="paramname"><span class="paramname"><em>render</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a new Component, similar to |child|, but using |render| as the Component::Render() event. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The component to forward events to. </td></tr>
|
||
<tr><td class="paramname">render</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md19"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line">std::string label = <span class="stringliteral">"Click to quit"</span>;</div>
|
||
<div class="line"><span class="keyword">auto</span> button = <a class="code hl_function" href="#a6910ffaa082c693603aafab4e7dddac3">Button</a>(&label, screen.ExitLoopClosure());</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>(button, [&] {</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="#a552ba6d33b3c9bec586b99fba4c243ac">hbox</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"A button:"</span>),</div>
|
||
<div class="line"> button->Render(),</div>
|
||
<div class="line"> });</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a552ba6d33b3c9bec586b99fba4c243ac"><div class="ttname"><a href="#a552ba6d33b3c9bec586b99fba4c243ac">ftxui::hbox</a></div><div class="ttdeci">Element hbox(Elements)</div><div class="ttdoc">A container displaying elements horizontally one by one.</div><div class="ttdef"><b>Definition</b> <a href="hbox_8cpp_source.html#l00076">hbox.cpp:76</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="renderer_8cpp_source.html#l00059">59</a> of file <a class="el" href="renderer_8cpp_source.html">renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af03d3df7243bf71bb1a73686628f7f2b" name="af03d3df7243bf71bb1a73686628f7f2b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af03d3df7243bf71bb1a73686628f7f2b">◆ </a></span>Renderer() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>()></td> <td class="paramname"><span class="paramname"><em>render</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a component, using |render| to render its interface. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">render</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md18"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] {</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>);</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="renderer_8cpp_source.html#l00028">28</a> of file <a class="el" href="renderer_8cpp_source.html">renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a099cb57274a99396ee10f38acbfe62a7" name="a099cb57274a99396ee10f38acbfe62a7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a099cb57274a99396ee10f38acbfe62a7">◆ </a></span>Renderer() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Renderer </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::function< <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(bool)></td> <td class="paramname"><span class="paramname"><em>render</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a focusable component, using |render| to render its interface. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">render</td><td>The function drawing the interface, taking a boolean telling whether the component is focused or not.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md20"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] (<span class="keywordtype">bool</span> focused) {</div>
|
||
<div class="line"> <span class="keywordflow">if</span> (focused)</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>) | <a class="code hl_function" href="#a672456b8f2091b615a30ff755418b37b">inverted</a>;</div>
|
||
<div class="line"> <span class="keywordflow">else</span></div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>);</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a672456b8f2091b615a30ff755418b37b"><div class="ttname"><a href="#a672456b8f2091b615a30ff755418b37b">ftxui::inverted</a></div><div class="ttdeci">Element inverted(Element)</div><div class="ttdoc">Add a filter that will invert the foreground and the background colors.</div><div class="ttdef"><b>Definition</b> <a href="inverted_8cpp_source.html#l00029">inverted.cpp:29</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="renderer_8cpp_source.html#l00082">82</a> of file <a class="el" href="renderer_8cpp_source.html">renderer.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="afa5872ba3f9889c7487e57e745e56857" name="afa5872ba3f9889c7487e57e745e56857"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afa5872ba3f9889c7487e57e745e56857">◆ </a></span>CatchEvent() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> CatchEvent </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a>)></td> <td class="paramname"><span class="paramname"><em></em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abe1e4e93c6f28539357d0a6aec27ebdd" name="abe1e4e93c6f28539357d0a6aec27ebdd"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abe1e4e93c6f28539357d0a6aec27ebdd">◆ </a></span>Maybe()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Maybe </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>show</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="maybe_8cpp_source.html#l00007">7</a> of file <a class="el" href="maybe_8cpp_source.html">maybe.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a26d065934276991f218d3fd985b86f7d" name="a26d065934276991f218d3fd985b86f7d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a26d065934276991f218d3fd985b86f7d">◆ </a></span>Input() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Input </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1WideStringRef.html">WideStringRef</a></td> <td class="paramname"><span class="paramname"><em>content</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>placeholder</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< <a class="el" href="#structftxui_1_1InputOption">InputOption</a> ></td> <td class="paramname"><span class="paramname"><em>option</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>. An input box for editing text. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">content</td><td>The editable content. </td></tr>
|
||
<tr><td class="paramname">placeholder</td><td>The text displayed when content is still empty. </td></tr>
|
||
<tr><td class="paramname">option</td><td>Additional optional parameters.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd>InputBase</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md12"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a4f458e443ed672c2aea9fdd96531a621">ScreenInteractive::FitComponent</a>();</div>
|
||
<div class="line">std::string content= <span class="stringliteral">""</span>;</div>
|
||
<div class="line">std::string placeholder = <span class="stringliteral">"placeholder"</span>;</div>
|
||
<div class="line"><a class="code hl_typedef" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> input = <a class="code hl_function" href="#a30be54a28004c1c48c2a5ed54e4abd64">Input</a>(&content, &placeholder);</div>
|
||
<div class="line">screen.Loop(input);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md13"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">placeholder</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="input_8cpp_source.html#l00269">269</a> of file <a class="el" href="input_8cpp_source.html">input.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a57abe3e11733b1d3ebacc56692d3537c" name="a57abe3e11733b1d3ebacc56692d3537c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a57abe3e11733b1d3ebacc56692d3537c">◆ </a></span>MakeReceiver()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<class T > </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a7abbe763f26611fbf3902861863b7659">Receiver</a>< T > MakeReceiver </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="receiver_8hpp_source.html#l00117">117</a> of file <a class="el" href="receiver_8hpp_source.html">receiver.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a75baaa2734ed76a9f478beaafa87ae57" name="a75baaa2734ed76a9f478beaafa87ae57"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a75baaa2734ed76a9f478beaafa87ae57">◆ </a></span>text() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> text </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::wstring</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Display a piece of unicode text. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a57429a83a46c643a81dee81e49384439" title="Convert a std::wstring into a UTF8 std::string.">ftxui::to_wstring</a></dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md50"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(L<span class="stringliteral">"Hello world!"</span>);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a2bc31f2d685189e5c61d2293a1f51b4f"><div class="ttname"><a href="#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></div><div class="ttdeci">std::shared_ptr< Node > Element</div><div class="ttdef"><b>Definition</b> <a href="elements_8hpp_source.html#l00015">elements.hpp:15</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md51"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">Hello world!</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="text_8cpp_source.html#l00106">106</a> of file <a class="el" href="text_8cpp_source.html">text.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9f9f7485a45aa9d432726ca9845d1eac" name="a9f9f7485a45aa9d432726ca9845d1eac"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9f9f7485a45aa9d432726ca9845d1eac">◆ </a></span>vtext() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> vtext </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::wstring</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Display a piece unicode text vertically. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a57429a83a46c643a81dee81e49384439" title="Convert a std::wstring into a UTF8 std::string.">ftxui::to_wstring</a></dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md54"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a9f9f7485a45aa9d432726ca9845d1eac">vtext</a>(L<span class="stringliteral">"Hello world!"</span>);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a9f9f7485a45aa9d432726ca9845d1eac"><div class="ttname"><a href="#a9f9f7485a45aa9d432726ca9845d1eac">ftxui::vtext</a></div><div class="ttdeci">Element vtext(std::wstring text)</div><div class="ttdoc">Display a piece unicode text vertically.</div><div class="ttdef"><b>Definition</b> <a href="text_8cpp_source.html#l00166">text.cpp:166</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md55"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">H</div>
|
||
<div class="line">e</div>
|
||
<div class="line">l</div>
|
||
<div class="line">l</div>
|
||
<div class="line">o</div>
|
||
<div class="line"> </div>
|
||
<div class="line">w</div>
|
||
<div class="line">o</div>
|
||
<div class="line">r</div>
|
||
<div class="line">l</div>
|
||
<div class="line">d</div>
|
||
<div class="line">!</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="text_8cpp_source.html#l00166">166</a> of file <a class="el" href="text_8cpp_source.html">text.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a3b8fc08cbe1ef6e1f9607644b1580aad" name="a3b8fc08cbe1ef6e1f9607644b1580aad"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a3b8fc08cbe1ef6e1f9607644b1580aad">◆ </a></span>paragraph() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> paragraph </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::wstring</td> <td class="paramname"><span class="paramname"><em>the_text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a vector of <a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57" title="Display a piece of unicode text.">ftxui::text</a> for every word of the string. This is useful combined with <a class="el" href="#a345b31919048562675615d5af78e6322" title="A container displaying elements horizontally one by one.">ftxui::hflow</a>. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">the_text</td><td>The string to be splitted.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a345b31919048562675615d5af78e6322" title="A container displaying elements horizontally one by one.">hflow</a>. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="paragraph_8cpp_source.html#l00014">14</a> of file <a class="el" href="paragraph_8cpp_source.html">paragraph.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a7e9a69f0592b4013bd725d662f4a76e7" name="a7e9a69f0592b4013bd725d662f4a76e7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7e9a69f0592b4013bd725d662f4a76e7">◆ </a></span>operator|() <span class="overload">[1/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> operator| </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>element</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a></td> <td class="paramname"><span class="paramname"><em>decorator</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>From an element, apply a decorator. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>the decorated element.</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md57"></a>
|
||
Example</h3>
|
||
<p>Both of these are equivalent: </p><div class="fragment"><div class="line"><a class="code hl_function" href="#a353c769068e25303eb41fa2da565c604">bold</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello"</span>));</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a353c769068e25303eb41fa2da565c604"><div class="ttname"><a href="#a353c769068e25303eb41fa2da565c604">ftxui::bold</a></div><div class="ttdeci">Element bold(Element)</div><div class="ttdoc">Use a bold font, for elements with more emphasis.</div><div class="ttdef"><b>Definition</b> <a href="bold_8cpp_source.html#l00028">bold.cpp:28</a></div></div>
|
||
</div><!-- fragment --> <div class="fragment"><div class="line"><a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello"</span>) | <a class="code hl_function" href="#a353c769068e25303eb41fa2da565c604">bold</a>;</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="util_8cpp_source.html#l00064">64</a> of file <a class="el" href="util_8cpp_source.html">util.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a6cbc84eb24a655ae084b3c7d26f9abfc" name="a6cbc84eb24a655ae084b3c7d26f9abfc"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a6cbc84eb24a655ae084b3c7d26f9abfc">◆ </a></span>operator|() <span class="overload">[2/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> operator| </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a></td> <td class="paramname"><span class="paramname"><em>elements</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a></td> <td class="paramname"><span class="paramname"><em>decorator</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>From a set of element, apply a decorator to every elements. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>the set of decorated element. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="util_8cpp_source.html#l00044">44</a> of file <a class="el" href="util_8cpp_source.html">util.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a027fbc9cf6fef9e86ae6a2a79e8bf23a" name="a027fbc9cf6fef9e86ae6a2a79e8bf23a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a027fbc9cf6fef9e86ae6a2a79e8bf23a">◆ </a></span>operator|() <span class="overload">[3/3]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> operator| </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a></td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a></td> <td class="paramname"><span class="paramname"><em>b</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Compose two decorator into one. </p>
|
||
<h3><a class="anchor" id="autotoc_md56"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> decorator = <a class="code hl_function" href="#a353c769068e25303eb41fa2da565c604">bold</a> | <a class="code hl_function" href="#ad57613de5895e774218d91dea48d074b">blink</a>;</div>
|
||
<div class="ttc" id="anamespaceftxui_html_ad57613de5895e774218d91dea48d074b"><div class="ttname"><a href="#ad57613de5895e774218d91dea48d074b">ftxui::blink</a></div><div class="ttdeci">Element blink(Element)</div><div class="ttdoc">The text drawn alternates in between visible and hidden.</div><div class="ttdef"><b>Definition</b> <a href="blink_8cpp_source.html#l00028">blink.cpp:28</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="util_8cpp_source.html#l00037">37</a> of file <a class="el" href="util_8cpp_source.html">util.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a366051704fd333c23460f7932598a5e3" name="a366051704fd333c23460f7932598a5e3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a366051704fd333c23460f7932598a5e3">◆ </a></span>text() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> text </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Display a piece of UTF8 encoded unicode text. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a57429a83a46c643a81dee81e49384439" title="Convert a std::wstring into a UTF8 std::string.">ftxui::to_wstring</a></dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md48"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Hello world!"</span>);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md49"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">Hello world!</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="text_8cpp_source.html#l00087">87</a> of file <a class="el" href="text_8cpp_source.html">text.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a64172a43b4b526afeb6313e6e1a6d5a1" name="a64172a43b4b526afeb6313e6e1a6d5a1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a64172a43b4b526afeb6313e6e1a6d5a1">◆ </a></span>vtext() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> vtext </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Display a piece of unicode text vertically. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a57429a83a46c643a81dee81e49384439" title="Convert a std::wstring into a UTF8 std::string.">ftxui::to_wstring</a></dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md52"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a9f9f7485a45aa9d432726ca9845d1eac">vtext</a>(<span class="stringliteral">"Hello world!"</span>);</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md53"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">H</div>
|
||
<div class="line">e</div>
|
||
<div class="line">l</div>
|
||
<div class="line">l</div>
|
||
<div class="line">o</div>
|
||
<div class="line"> </div>
|
||
<div class="line">w</div>
|
||
<div class="line">o</div>
|
||
<div class="line">r</div>
|
||
<div class="line">l</div>
|
||
<div class="line">d</div>
|
||
<div class="line">!</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="text_8cpp_source.html#l00136">136</a> of file <a class="el" href="text_8cpp_source.html">text.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a4d3951dde56262b80ee4eb805ced51d1" name="a4d3951dde56262b80ee4eb805ced51d1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a4d3951dde56262b80ee4eb805ced51d1">◆ </a></span>separator() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> separator </td>
|
||
<td>(</td>
|
||
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="separator_8cpp_source.html#l00061">61</a> of file <a class="el" href="separator_8cpp_source.html">separator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a37c2b93daf557f68064bc9fbf93ebde0" name="a37c2b93daf557f68064bc9fbf93ebde0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a37c2b93daf557f68064bc9fbf93ebde0">◆ </a></span>separatorLight()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> separatorLight </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="separator_8cpp_source.html#l00069">69</a> of file <a class="el" href="separator_8cpp_source.html">separator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af0649e89a9960f1c2703e48c1817645b" name="af0649e89a9960f1c2703e48c1817645b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af0649e89a9960f1c2703e48c1817645b">◆ </a></span>separatorHeavy()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> separatorHeavy </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="separator_8cpp_source.html#l00072">72</a> of file <a class="el" href="separator_8cpp_source.html">separator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="add376830fdb51b0bf52672ef17515989" name="add376830fdb51b0bf52672ef17515989"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#add376830fdb51b0bf52672ef17515989">◆ </a></span>separatorDouble()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> separatorDouble </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="separator_8cpp_source.html#l00075">75</a> of file <a class="el" href="separator_8cpp_source.html">separator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af5a5a3d46e6a043059728d706cfd1145" name="af5a5a3d46e6a043059728d706cfd1145"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af5a5a3d46e6a043059728d706cfd1145">◆ </a></span>separatorStyled()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> separatorStyled </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a></td> <td class="paramname"><span class="paramname"><em>style</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="separator_8cpp_source.html#l00065">65</a> of file <a class="el" href="separator_8cpp_source.html">separator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aa0e5364767764045f44e7e3191b40cdd" name="aa0e5364767764045f44e7e3191b40cdd"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa0e5364767764045f44e7e3191b40cdd">◆ </a></span>separator() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> separator </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="structftxui_1_1Pixel.html">Pixel</a></td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae0b8041a60629fd790716038738c93ce" name="ae0b8041a60629fd790716038738c93ce"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae0b8041a60629fd790716038738c93ce">◆ </a></span>gauge()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> gauge </td>
|
||
<td>(</td>
|
||
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>progress</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a high definition progress bar. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">progress</td><td>The proportion of the area to be filled. Belong to [0,1].</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md47"></a>
|
||
Example</h3>
|
||
<p>A gauge. It can be used to represent a progress bar. </p><div class="fragment"><div class="line"><a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a>(<a class="code hl_function" href="#ae0b8041a60629fd790716038738c93ce">gauge</a>(0.5))</div>
|
||
<div class="ttc" id="anamespaceftxui_html_ae0b8041a60629fd790716038738c93ce"><div class="ttname"><a href="#ae0b8041a60629fd790716038738c93ce">ftxui::gauge</a></div><div class="ttdeci">Element gauge(float ratio)</div><div class="ttdoc">Draw a high definition progress bar.</div><div class="ttdef"><b>Definition</b> <a href="gauge_8cpp_source.html#l00075">gauge.cpp:75</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_ae8537acd423d47cf07e61bd774fb1098"><div class="ttname"><a href="#ae8537acd423d47cf07e61bd774fb1098">ftxui::border</a></div><div class="ttdeci">Element border(Element)</div><div class="ttdoc">Draw a border around the element.</div><div class="ttdef"><b>Definition</b> <a href="border_8cpp_source.html#l00148">border.cpp:148</a></div></div>
|
||
</div><!-- fragment --><h4>Output</h4>
|
||
<div class="fragment"><div class="line">┌──────────────────────────────────────────────────────────────────────────┐</div>
|
||
<div class="line">│█████████████████████████████████████ │</div>
|
||
<div class="line">└──────────────────────────────────────────────────────────────────────────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="gauge_8cpp_source.html#l00075">75</a> of file <a class="el" href="gauge_8cpp_source.html">gauge.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae8537acd423d47cf07e61bd774fb1098" name="ae8537acd423d47cf07e61bd774fb1098"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae8537acd423d47cf07e61bd774fb1098">◆ </a></span>border()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> border </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a border around the element. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#aa074cdab57eeb47b99f1699bcc8addd8" title="Draw a light border around the element.">borderLight</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a052b504344f3bc1ff86b3493cd934215" title="Draw a double border around the element.">borderDouble</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a666c31419cc31cdadc9f8178ed63529e" title="Draw a heavy border around the element.">borderHeavy</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a3cf2db223a5efaa370f0ca6bb405b80e" title="Draw a rounded border around the element.">borderRounded</a></dd></dl>
|
||
<p>Add a border around an element</p>
|
||
<h3><a class="anchor" id="autotoc_md31"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="comment">// Use 'border' as a function...</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>));</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="comment">// ...Or as a 'pipe'.</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>) | <a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a>;</div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md32"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┌───────────┐</div>
|
||
<div class="line">│The element│</div>
|
||
<div class="line">└───────────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00148">148</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aa074cdab57eeb47b99f1699bcc8addd8" name="aa074cdab57eeb47b99f1699bcc8addd8"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa074cdab57eeb47b99f1699bcc8addd8">◆ </a></span>borderLight()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> borderLight </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a light border around the element. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#aa074cdab57eeb47b99f1699bcc8addd8" title="Draw a light border around the element.">borderLight</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a052b504344f3bc1ff86b3493cd934215" title="Draw a double border around the element.">borderDouble</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a666c31419cc31cdadc9f8178ed63529e" title="Draw a heavy border around the element.">borderHeavy</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a3cf2db223a5efaa370f0ca6bb405b80e" title="Draw a rounded border around the element.">borderRounded</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#abc9db79957d4dd36deb8ca79938e4c41" title="Same as border but with different styles.">borderStyled</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a346da47464c320ac6b93ffe44b4da9df" title="Same as border but with a constant Pixel around the element.">borderWith</a></dd></dl>
|
||
<p>Add a border around an element</p>
|
||
<h3><a class="anchor" id="autotoc_md33"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="comment">// Use 'borderLight' as a function...</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#aa074cdab57eeb47b99f1699bcc8addd8">borderLight</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>));</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="comment">// ...Or as a 'pipe'.</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>) | <a class="code hl_function" href="#aa074cdab57eeb47b99f1699bcc8addd8">borderLight</a>;</div>
|
||
<div class="ttc" id="anamespaceftxui_html_aa074cdab57eeb47b99f1699bcc8addd8"><div class="ttname"><a href="#aa074cdab57eeb47b99f1699bcc8addd8">ftxui::borderLight</a></div><div class="ttdeci">Element borderLight(Element)</div><div class="ttdoc">Draw a light border around the element.</div><div class="ttdef"><b>Definition</b> <a href="border_8cpp_source.html#l00199">border.cpp:199</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md34"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┌──────────────┐</div>
|
||
<div class="line">│The element │</div>
|
||
<div class="line">└──────────────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00199">199</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a666c31419cc31cdadc9f8178ed63529e" name="a666c31419cc31cdadc9f8178ed63529e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a666c31419cc31cdadc9f8178ed63529e">◆ </a></span>borderHeavy()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> borderHeavy </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a heavy border around the element. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#aa074cdab57eeb47b99f1699bcc8addd8" title="Draw a light border around the element.">borderLight</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a052b504344f3bc1ff86b3493cd934215" title="Draw a double border around the element.">borderDouble</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a666c31419cc31cdadc9f8178ed63529e" title="Draw a heavy border around the element.">borderHeavy</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a3cf2db223a5efaa370f0ca6bb405b80e" title="Draw a rounded border around the element.">borderRounded</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#abc9db79957d4dd36deb8ca79938e4c41" title="Same as border but with different styles.">borderStyled</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a346da47464c320ac6b93ffe44b4da9df" title="Same as border but with a constant Pixel around the element.">borderWith</a></dd></dl>
|
||
<p>Add a border around an element</p>
|
||
<h3><a class="anchor" id="autotoc_md35"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="comment">// Use 'borderHeavy' as a function...</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a666c31419cc31cdadc9f8178ed63529e">borderHeavy</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>));</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="comment">// ...Or as a 'pipe'.</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>) | <a class="code hl_function" href="#a666c31419cc31cdadc9f8178ed63529e">borderHeavy</a>;</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a666c31419cc31cdadc9f8178ed63529e"><div class="ttname"><a href="#a666c31419cc31cdadc9f8178ed63529e">ftxui::borderHeavy</a></div><div class="ttdeci">Element borderHeavy(Element)</div><div class="ttdoc">Draw a heavy border around the element.</div><div class="ttdef"><b>Definition</b> <a href="border_8cpp_source.html#l00232">border.cpp:232</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md36"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┏━━━━━━━━━━━━━━┓</div>
|
||
<div class="line">┃The element ┃</div>
|
||
<div class="line">┗━━━━━━━━━━━━━━┛</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00232">232</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a052b504344f3bc1ff86b3493cd934215" name="a052b504344f3bc1ff86b3493cd934215"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a052b504344f3bc1ff86b3493cd934215">◆ </a></span>borderDouble()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> borderDouble </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a double border around the element. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#aa074cdab57eeb47b99f1699bcc8addd8" title="Draw a light border around the element.">borderLight</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a052b504344f3bc1ff86b3493cd934215" title="Draw a double border around the element.">borderDouble</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a666c31419cc31cdadc9f8178ed63529e" title="Draw a heavy border around the element.">borderHeavy</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a3cf2db223a5efaa370f0ca6bb405b80e" title="Draw a rounded border around the element.">borderRounded</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#abc9db79957d4dd36deb8ca79938e4c41" title="Same as border but with different styles.">borderStyled</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a346da47464c320ac6b93ffe44b4da9df" title="Same as border but with a constant Pixel around the element.">borderWith</a></dd></dl>
|
||
<p>Add a border around an element</p>
|
||
<h3><a class="anchor" id="autotoc_md37"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="comment">// Use 'borderDouble' as a function...</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a052b504344f3bc1ff86b3493cd934215">borderDouble</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>));</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="comment">// ...Or as a 'pipe'.</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>) | <a class="code hl_function" href="#a052b504344f3bc1ff86b3493cd934215">borderDouble</a>;</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a052b504344f3bc1ff86b3493cd934215"><div class="ttname"><a href="#a052b504344f3bc1ff86b3493cd934215">ftxui::borderDouble</a></div><div class="ttdeci">Element borderDouble(Element)</div><div class="ttdoc">Draw a double border around the element.</div><div class="ttdef"><b>Definition</b> <a href="border_8cpp_source.html#l00265">border.cpp:265</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md38"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">╔══════════════╗</div>
|
||
<div class="line">║The element ║</div>
|
||
<div class="line">╚══════════════╝</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00265">265</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a3cf2db223a5efaa370f0ca6bb405b80e" name="a3cf2db223a5efaa370f0ca6bb405b80e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a3cf2db223a5efaa370f0ca6bb405b80e">◆ </a></span>borderRounded()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> borderRounded </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a rounded border around the element. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#aa074cdab57eeb47b99f1699bcc8addd8" title="Draw a light border around the element.">borderLight</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a052b504344f3bc1ff86b3493cd934215" title="Draw a double border around the element.">borderDouble</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a666c31419cc31cdadc9f8178ed63529e" title="Draw a heavy border around the element.">borderHeavy</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a3cf2db223a5efaa370f0ca6bb405b80e" title="Draw a rounded border around the element.">borderRounded</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#abc9db79957d4dd36deb8ca79938e4c41" title="Same as border but with different styles.">borderStyled</a> </dd>
|
||
<dd>
|
||
<a class="el" href="#a346da47464c320ac6b93ffe44b4da9df" title="Same as border but with a constant Pixel around the element.">borderWith</a></dd></dl>
|
||
<p>Add a border around an element</p>
|
||
<h3><a class="anchor" id="autotoc_md39"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="comment">// Use 'borderRounded' as a function...</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a3cf2db223a5efaa370f0ca6bb405b80e">borderRounded</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>));</div>
|
||
<div class="line"> </div>
|
||
<div class="line"><span class="comment">// ...Or as a 'pipe'.</span></div>
|
||
<div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"The element"</span>) | <a class="code hl_function" href="#a3cf2db223a5efaa370f0ca6bb405b80e">borderRounded</a>;</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a3cf2db223a5efaa370f0ca6bb405b80e"><div class="ttname"><a href="#a3cf2db223a5efaa370f0ca6bb405b80e">ftxui::borderRounded</a></div><div class="ttdeci">Element borderRounded(Element)</div><div class="ttdoc">Draw a rounded border around the element.</div><div class="ttdef"><b>Definition</b> <a href="border_8cpp_source.html#l00298">border.cpp:298</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md40"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">╭──────────────╮</div>
|
||
<div class="line">│The element │</div>
|
||
<div class="line">╰──────────────╯</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00298">298</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abc9db79957d4dd36deb8ca79938e4c41" name="abc9db79957d4dd36deb8ca79938e4c41"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abc9db79957d4dd36deb8ca79938e4c41">◆ </a></span>borderStyled()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> borderStyled </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a></td> <td class="paramname"><span class="paramname"><em>style</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Same as border but with different styles. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00164">164</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a346da47464c320ac6b93ffe44b4da9df" name="a346da47464c320ac6b93ffe44b4da9df"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a346da47464c320ac6b93ffe44b4da9df">◆ </a></span>borderWith()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> borderWith </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="structftxui_1_1Pixel.html">Pixel</a></td> <td class="paramname"><span class="paramname"><em>pixel</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Same as border but with a constant <a class="el" href="structftxui_1_1Pixel.html" title="A unicode character and its associated style.">Pixel</a> around the element. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00155">155</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a443afb3d149fedaf88b89249c8f6dc25" name="a443afb3d149fedaf88b89249c8f6dc25"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a443afb3d149fedaf88b89249c8f6dc25">◆ </a></span>window()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> window </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>title</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>content</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw window with a title and a border around the element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">title</td><td>The title of the window. </td></tr>
|
||
<tr><td class="paramname">content</td><td>The element to be wrapped.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ae8537acd423d47cf07e61bd774fb1098" title="Draw a border around the element.">border</a></dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md41"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a443afb3d149fedaf88b89249c8f6dc25">window</a>(<a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Title"</span>),</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"content"</span>)</div>
|
||
<div class="line"> );</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a443afb3d149fedaf88b89249c8f6dc25"><div class="ttname"><a href="#a443afb3d149fedaf88b89249c8f6dc25">ftxui::window</a></div><div class="ttdeci">Element window(Element title, Element content)</div><div class="ttdoc">Draw window with a title and a border around the element.</div><div class="ttdef"><b>Definition</b> <a href="border_8cpp_source.html#l00323">border.cpp:323</a></div></div>
|
||
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md42"></a>
|
||
Output</h3>
|
||
<div class="fragment"><div class="line">┌Title──┐</div>
|
||
<div class="line">│content│</div>
|
||
<div class="line">└───────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="border_8cpp_source.html#l00323">323</a> of file <a class="el" href="border_8cpp_source.html">border.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a3b08e0030a0831d3ec3e2a505908273b" name="a3b08e0030a0831d3ec3e2a505908273b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a3b08e0030a0831d3ec3e2a505908273b">◆ </a></span>spinner()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> spinner </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>charset_index</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>image_index</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Useful to represent the effect of time and/or events. This display an ASCII art "video". </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">charset_index</td><td>The type of "video". </td></tr>
|
||
<tr><td class="paramname">image_index</td><td>The "frame" of the video. You need to increase this for every "step". </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="spinner_8cpp_source.html#l00255">255</a> of file <a class="el" href="spinner_8cpp_source.html">spinner.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a2d755c2b73e3e653d53e541526c27785" name="a2d755c2b73e3e653d53e541526c27785"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2d755c2b73e3e653d53e541526c27785">◆ </a></span>paragraph() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> paragraph </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>the_text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a vector of <a class="el" href="#a75baaa2734ed76a9f478beaafa87ae57" title="Display a piece of unicode text.">ftxui::text</a> for every word of the string. This is useful combined with <a class="el" href="#a345b31919048562675615d5af78e6322" title="A container displaying elements horizontally one by one.">ftxui::hflow</a>. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">the_text</td><td>The string to be splitted.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a345b31919048562675615d5af78e6322" title="A container displaying elements horizontally one by one.">hflow</a>. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="paragraph_8cpp_source.html#l00028">28</a> of file <a class="el" href="paragraph_8cpp_source.html">paragraph.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae78c2b2b147e65701493465f8e3f4d89" name="ae78c2b2b147e65701493465f8e3f4d89"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae78c2b2b147e65701493465f8e3f4d89">◆ </a></span>graph()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> graph </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#ab07cb9a766f38fc867f8fe736ce2e6e3">GraphFunction</a></td> <td class="paramname"><span class="paramname"><em>graph_function</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Draw a graph using a GraphFunction. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">graph_function</td><td>the function to be called to get the data. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="graph_8cpp_source.html#l00059">59</a> of file <a class="el" href="graph_8cpp_source.html">graph.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a353c769068e25303eb41fa2da565c604" name="a353c769068e25303eb41fa2da565c604"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a353c769068e25303eb41fa2da565c604">◆ </a></span>bold()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> bold </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Use a bold font, for elements with more emphasis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="bold_8cpp_source.html#l00028">28</a> of file <a class="el" href="bold_8cpp_source.html">bold.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac6a3b77604739516e809369810896646" name="ac6a3b77604739516e809369810896646"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac6a3b77604739516e809369810896646">◆ </a></span>dim()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> dim </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Use a light font, for elements with less emphasis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="dim_8cpp_source.html#l00028">28</a> of file <a class="el" href="dim_8cpp_source.html">dim.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a672456b8f2091b615a30ff755418b37b" name="a672456b8f2091b615a30ff755418b37b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a672456b8f2091b615a30ff755418b37b">◆ </a></span>inverted()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> inverted </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Add a filter that will invert the foreground and the background colors. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="inverted_8cpp_source.html#l00029">29</a> of file <a class="el" href="inverted_8cpp_source.html">inverted.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5ad450c97c4d084b64ffb5b5ca942664" name="a5ad450c97c4d084b64ffb5b5ca942664"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5ad450c97c4d084b64ffb5b5ca942664">◆ </a></span>underlined()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> underlined </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Make the underlined element to be underlined. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="underlined_8cpp_source.html#l00028">28</a> of file <a class="el" href="underlined_8cpp_source.html">underlined.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad57613de5895e774218d91dea48d074b" name="ad57613de5895e774218d91dea48d074b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad57613de5895e774218d91dea48d074b">◆ </a></span>blink()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> blink </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>The text drawn alternates in between visible and hidden. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="blink_8cpp_source.html#l00028">28</a> of file <a class="el" href="blink_8cpp_source.html">blink.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af61b489da39ca5e24b68e6e1a2b09c0d" name="af61b489da39ca5e24b68e6e1a2b09c0d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af61b489da39ca5e24b68e6e1a2b09c0d">◆ </a></span>color() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> color </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>c</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate using a foreground color. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">c</td><td>The foreground color to be applied. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The Decorator applying the color.</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md45"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"red"</span>) | <a class="code hl_function" href="#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">Color::Red</a>);</div>
|
||
<div class="ttc" id="aclassftxui_1_1Color_html_ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743"><div class="ttname"><a href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a></div><div class="ttdeci">@ Red</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00041">color.hpp:41</a></div></div>
|
||
<div class="ttc" id="anamespaceftxui_html_af61b489da39ca5e24b68e6e1a2b09c0d"><div class="ttname"><a href="#af61b489da39ca5e24b68e6e1a2b09c0d">ftxui::color</a></div><div class="ttdeci">Decorator color(Color)</div><div class="ttdoc">Decorate using a foreground color.</div><div class="ttdef"><b>Definition</b> <a href="dom_2color_8cpp_source.html#l00086">color.cpp:86</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="dom_2color_8cpp_source.html#l00086">86</a> of file <a class="el" href="dom_2color_8cpp_source.html">color.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a01d4c5aaf0447e862246849111782245" name="a01d4c5aaf0447e862246849111782245"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a01d4c5aaf0447e862246849111782245">◆ </a></span>bgcolor() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> bgcolor </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Decorate using a background color. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">color</td><td>The background color to be applied. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The Decorator applying the color.</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md46"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"red"</span>) | <a class="code hl_function" href="#a01d4c5aaf0447e862246849111782245">bgcolor</a>(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">Color::Red</a>);</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a01d4c5aaf0447e862246849111782245"><div class="ttname"><a href="#a01d4c5aaf0447e862246849111782245">ftxui::bgcolor</a></div><div class="ttdeci">Decorator bgcolor(Color)</div><div class="ttdoc">Decorate using a background color.</div><div class="ttdef"><b>Definition</b> <a href="dom_2color_8cpp_source.html#l00100">color.cpp:100</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="dom_2color_8cpp_source.html#l00100">100</a> of file <a class="el" href="dom_2color_8cpp_source.html">color.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="adef6e6e66199153de6d3b21b14dcf868" name="adef6e6e66199153de6d3b21b14dcf868"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#adef6e6e66199153de6d3b21b14dcf868">◆ </a></span>color() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> color </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set the foreground color of an element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">color</td><td>The color of the output element. </td></tr>
|
||
<tr><td class="paramname">child</td><td>The input element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The output element colored.</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md43"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106">Color::Green</a>, <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Success"</span>)),</div>
|
||
<div class="ttc" id="aclassftxui_1_1Color_html_ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106"><div class="ttname"><a href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106">ftxui::Color::Green</a></div><div class="ttdeci">@ Green</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00042">color.hpp:42</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="dom_2color_8cpp_source.html#l00057">57</a> of file <a class="el" href="dom_2color_8cpp_source.html">color.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aae86eacae0a0626b41e9964ac7f4f532" name="aae86eacae0a0626b41e9964ac7f4f532"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aae86eacae0a0626b41e9964ac7f4f532">◆ </a></span>bgcolor() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> bgcolor </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Set the background color of an element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">color</td><td>The color of the output element. </td></tr>
|
||
<tr><td class="paramname">child</td><td>The input element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The output element colored.</dd></dl>
|
||
<h3><a class="anchor" id="autotoc_md44"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><a class="code hl_typedef" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> document = <a class="code hl_function" href="#a01d4c5aaf0447e862246849111782245">bgcolor</a>(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106">Color::Green</a>, <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Success"</span>)),</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="dom_2color_8cpp_source.html#l00072">72</a> of file <a class="el" href="dom_2color_8cpp_source.html">color.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a552ba6d33b3c9bec586b99fba4c243ac" name="a552ba6d33b3c9bec586b99fba4c243ac"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a552ba6d33b3c9bec586b99fba4c243ac">◆ </a></span>hbox()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> hbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</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 container displaying elements horizontally one by one. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>The elements in the container </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The container.</dd></dl>
|
||
<h4>Example</h4>
|
||
<div class="fragment"><div class="line"><a class="code hl_function" href="#a552ba6d33b3c9bec586b99fba4c243ac">hbox</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Left"</span>),</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Right"</span>),</div>
|
||
<div class="line">});</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hbox_8cpp_source.html#l00076">76</a> of file <a class="el" href="hbox_8cpp_source.html">hbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="afd28058f0ccbbdf34691a85a7cc9b2e3" name="afd28058f0ccbbdf34691a85a7cc9b2e3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afd28058f0ccbbdf34691a85a7cc9b2e3">◆ </a></span>vbox()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> vbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</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 container displaying elements vertically one by one. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>The elements in the container </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The container.</dd></dl>
|
||
<h4>Example</h4>
|
||
<div class="fragment"><div class="line"><a class="code hl_function" href="#afd28058f0ccbbdf34691a85a7cc9b2e3">vbox</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Up"</span>),</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Down"</span>),</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="anamespaceftxui_html_afd28058f0ccbbdf34691a85a7cc9b2e3"><div class="ttname"><a href="#afd28058f0ccbbdf34691a85a7cc9b2e3">ftxui::vbox</a></div><div class="ttdeci">Element vbox(Elements)</div><div class="ttdoc">A container displaying elements vertically one by one.</div><div class="ttdef"><b>Definition</b> <a href="vbox_8cpp_source.html#l00077">vbox.cpp:77</a></div></div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="vbox_8cpp_source.html#l00077">77</a> of file <a class="el" href="vbox_8cpp_source.html">vbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a901ab1b6b2e0e8c295552168ab206441" name="a901ab1b6b2e0e8c295552168ab206441"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a901ab1b6b2e0e8c295552168ab206441">◆ </a></span>dbox()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> dbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a></td> <td class="paramname"><span class="paramname"><em>children_</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Stack several element on top of each other. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children_</td><td>The input element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The right aligned element. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="dbox_8cpp_source.html#l00050">50</a> of file <a class="el" href="dbox_8cpp_source.html">dbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abcdf409d605edafd3191cd7ba47bcbd1" name="abcdf409d605edafd3191cd7ba47bcbd1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abcdf409d605edafd3191cd7ba47bcbd1">◆ </a></span>gridbox()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> gridbox </td>
|
||
<td>(</td>
|
||
<td class="paramtype">std::vector< <a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</a> ></td> <td class="paramname"><span class="paramname"><em>lines</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A container displaying a grid of elements. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">lines</td><td>A list of lines, each line being a list of elements. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The container.</dd></dl>
|
||
<h4>Example</h4>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> cell = [](<span class="keyword">const</span> <span class="keywordtype">char</span>* t) { <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(t) | <a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a>; };</div>
|
||
<div class="line"><span class="keyword">auto</span> document = <a class="code hl_function" href="#abcdf409d605edafd3191cd7ba47bcbd1">gridbox</a>({</div>
|
||
<div class="line"> {cell(<span class="stringliteral">"north-west"</span>) , cell(<span class="stringliteral">"north"</span>) , cell(<span class="stringliteral">"north-east"</span>)} ,</div>
|
||
<div class="line"> {cell(<span class="stringliteral">"west"</span>) , cell(<span class="stringliteral">"center"</span>) , cell(<span class="stringliteral">"east"</span>)} ,</div>
|
||
<div class="line"> {cell(<span class="stringliteral">"south-west"</span>) , cell(<span class="stringliteral">"south"</span>) , cell(<span class="stringliteral">"south-east"</span>)} ,</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="anamespaceftxui_html_abcdf409d605edafd3191cd7ba47bcbd1"><div class="ttname"><a href="#abcdf409d605edafd3191cd7ba47bcbd1">ftxui::gridbox</a></div><div class="ttdeci">Element gridbox(std::vector< Elements > lines)</div><div class="ttdoc">A container displaying a grid of elements.</div><div class="ttdef"><b>Definition</b> <a href="gridbox_8cpp_source.html#l00154">gridbox.cpp:154</a></div></div>
|
||
</div><!-- fragment --><p> Output: </p><div class="fragment"><div class="line">╭──────────╮╭──────╮╭──────────╮</div>
|
||
<div class="line">│north-west││north ││north-east│</div>
|
||
<div class="line">╰──────────╯╰──────╯╰──────────╯</div>
|
||
<div class="line">╭──────────╮╭──────╮╭──────────╮</div>
|
||
<div class="line">│west ││center││east │</div>
|
||
<div class="line">╰──────────╯╰──────╯╰──────────╯</div>
|
||
<div class="line">╭──────────╮╭──────╮╭──────────╮</div>
|
||
<div class="line">│south-west││south ││south-east│</div>
|
||
<div class="line">╰──────────╯╰──────╯╰──────────╯</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="gridbox_8cpp_source.html#l00154">154</a> of file <a class="el" href="gridbox_8cpp_source.html">gridbox.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a345b31919048562675615d5af78e6322" name="a345b31919048562675615d5af78e6322"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a345b31919048562675615d5af78e6322">◆ </a></span>hflow()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> hflow </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a5d4aa06ca6cc6a72e981bd5386f93f0a">Elements</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 container displaying elements horizontally one by one. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">children</td><td>The elements in the container </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The container.</dd></dl>
|
||
<h4>Example</h4>
|
||
<div class="fragment"><div class="line"><a class="code hl_function" href="#a552ba6d33b3c9bec586b99fba4c243ac">hbox</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Left"</span>),</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"Right"</span>),</div>
|
||
<div class="line">});</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="hflow_8cpp_source.html#l00075">75</a> of file <a class="el" href="hflow_8cpp_source.html">hflow.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a257acd2bd47bab7db879cca2c0e67e23" name="a257acd2bd47bab7db879cca2c0e67e23"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a257acd2bd47bab7db879cca2c0e67e23">◆ </a></span>flex()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> flex </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Make a child element to expand proportionnally to the space left in a container. </p>
|
||
<h4>Examples:</h4>
|
||
<div class="fragment"><div class="line"><a class="code hl_function" href="#a552ba6d33b3c9bec586b99fba4c243ac">hbox</a>({</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"left"</span>) | <a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a> ,</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"middle"</span>) | <a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a> | <a class="code hl_function" href="#a257acd2bd47bab7db879cca2c0e67e23">flex</a>,</div>
|
||
<div class="line"> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"right"</span>) | <a class="code hl_function" href="#ae8537acd423d47cf07e61bd774fb1098">border</a>,</div>
|
||
<div class="line">});</div>
|
||
<div class="ttc" id="anamespaceftxui_html_a257acd2bd47bab7db879cca2c0e67e23"><div class="ttname"><a href="#a257acd2bd47bab7db879cca2c0e67e23">ftxui::flex</a></div><div class="ttdeci">Element flex(Element)</div><div class="ttdoc">Make a child element to expand proportionnally to the space left in a container.</div><div class="ttdef"><b>Definition</b> <a href="flex_8cpp_source.html#l00119">flex.cpp:119</a></div></div>
|
||
</div><!-- fragment --><h4>Output:</h4>
|
||
<div class="fragment"><div class="line">┌────┐┌─────────────────────────────────────────────────────────┐┌─────┐</div>
|
||
<div class="line">│left││middle ││right│</div>
|
||
<div class="line">└────┘└─────────────────────────────────────────────────────────┘└─────┘</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00119">119</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a81ed6b31f512e849247f13d249f6f20e" name="a81ed6b31f512e849247f13d249f6f20e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a81ed6b31f512e849247f13d249f6f20e">◆ </a></span>flex_grow()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> flex_grow </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Expand if possible. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00137">137</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a4629196b5ffc280054d35f2a9977e829" name="a4629196b5ffc280054d35f2a9977e829"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a4629196b5ffc280054d35f2a9977e829">◆ </a></span>flex_shrink()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> flex_shrink </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Minimize if needed. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00155">155</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0dbba98e14f63f1dd5163cbdc4f42da8" name="a0dbba98e14f63f1dd5163cbdc4f42da8"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0dbba98e14f63f1dd5163cbdc4f42da8">◆ </a></span>xflex()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> xflex </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Expand/Minimize if possible/needed on the X axis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00125">125</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a1618cb15307f29eb3d531e7b44c280d3" name="a1618cb15307f29eb3d531e7b44c280d3"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a1618cb15307f29eb3d531e7b44c280d3">◆ </a></span>xflex_grow()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> xflex_grow </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Expand if possible on the X axis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00143">143</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a95275a9271934cf76e970c6650cc224d" name="a95275a9271934cf76e970c6650cc224d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a95275a9271934cf76e970c6650cc224d">◆ </a></span>xflex_shrink()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> xflex_shrink </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Minimize if needed on the X axis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00161">161</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a42c7a33df6d890de30fc1ebb2d1b3ca6" name="a42c7a33df6d890de30fc1ebb2d1b3ca6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a42c7a33df6d890de30fc1ebb2d1b3ca6">◆ </a></span>yflex()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> yflex </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Expand/Minimize if possible/needed on the Y axis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00131">131</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a7eac3f709e905af8f583aed52093b7ce" name="a7eac3f709e905af8f583aed52093b7ce"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7eac3f709e905af8f583aed52093b7ce">◆ </a></span>yflex_grow()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> yflex_grow </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Expand if possible on the Y axis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00149">149</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af7d0757f5965aa579bccc125ff909256" name="af7d0757f5965aa579bccc125ff909256"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af7d0757f5965aa579bccc125ff909256">◆ </a></span>yflex_shrink()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> yflex_shrink </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Minimize if needed on the Y axis. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00167">167</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a845b0ea50d51024aa4e050447b46e1dd" name="a845b0ea50d51024aa4e050447b46e1dd"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a845b0ea50d51024aa4e050447b46e1dd">◆ </a></span>notflex()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> notflex </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Make the element not flexible. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00173">173</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac2a9ed2d22ec3c8811b61f4a901ed367" name="ac2a9ed2d22ec3c8811b61f4a901ed367"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac2a9ed2d22ec3c8811b61f4a901ed367">◆ </a></span>filler()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> filler </td>
|
||
<td>(</td>
|
||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>An element that will take expand proportionnally to the space left in a container. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="flex_8cpp_source.html#l00094">94</a> of file <a class="el" href="flex_8cpp_source.html">flex.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="adbda408cdd76f3bbd9c4e863672b7122" name="adbda408cdd76f3bbd9c4e863672b7122"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#adbda408cdd76f3bbd9c4e863672b7122">◆ </a></span>size()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> size </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a></td> <td class="paramname"><span class="paramname"><em>direction</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="#ae09f44b989d381a387329fd0a0935926">Constraint</a></td> <td class="paramname"><span class="paramname"><em>constraint</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Apply a constraint on the size of an element. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">direction</td><td>Whether the WIDTH of the HEIGHT of the element must be constrained. </td></tr>
|
||
<tr><td class="paramname">constraint</td><td>The type of constaint. </td></tr>
|
||
<tr><td class="paramname">value</td><td>The value. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="size_8cpp_source.html#l00086">86</a> of file <a class="el" href="size_8cpp_source.html">size.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aaff8245861617a3d9e846e99de582a63" name="aaff8245861617a3d9e846e99de582a63"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aaff8245861617a3d9e846e99de582a63">◆ </a></span>reflect()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a164021903e9ac6f1357e4186582891e3">Decorator</a> reflect </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="structftxui_1_1Box.html">Box</a> &</td> <td class="paramname"><span class="paramname"><em>box</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="reflect_8cpp_source.html#l00039">39</a> of file <a class="el" href="reflect_8cpp_source.html">reflect.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad0d6a96f6e1fb6d67d9fa6323062a737" name="ad0d6a96f6e1fb6d67d9fa6323062a737"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad0d6a96f6e1fb6d67d9fa6323062a737">◆ </a></span>frame()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> frame </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a52ee73ca2fb34afb6e6f25ac7df04b0e">focus</a> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="frame_8cpp_source.html#l00138">138</a> of file <a class="el" href="frame_8cpp_source.html">frame.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a2616fcc18ca2fb41954749e67647b48f" name="a2616fcc18ca2fb41954749e67647b48f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2616fcc18ca2fb41954749e67647b48f">◆ </a></span>xframe()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> xframe </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="frame_8cpp_source.html#l00142">142</a> of file <a class="el" href="frame_8cpp_source.html">frame.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a8406bb311fbaf67a7779833635c348ea" name="a8406bb311fbaf67a7779833635c348ea"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a8406bb311fbaf67a7779833635c348ea">◆ </a></span>yframe()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> yframe </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="frame_8cpp_source.html#l00146">146</a> of file <a class="el" href="frame_8cpp_source.html">frame.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a52ee73ca2fb34afb6e6f25ac7df04b0e" name="a52ee73ca2fb34afb6e6f25ac7df04b0e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a52ee73ca2fb34afb6e6f25ac7df04b0e">◆ </a></span>focus()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> focus </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="frame_8cpp_source.html#l00079">79</a> of file <a class="el" href="frame_8cpp_source.html">frame.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af0a483ef6e8a00023755c4637a1fcb9d" name="af0a483ef6e8a00023755c4637a1fcb9d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af0a483ef6e8a00023755c4637a1fcb9d">◆ </a></span>select()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> select </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="frame_8cpp_source.html#l00038">38</a> of file <a class="el" href="frame_8cpp_source.html">frame.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a1974176e676afdb96d203e8e0f579219" name="a1974176e676afdb96d203e8e0f579219"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a1974176e676afdb96d203e8e0f579219">◆ </a></span>vscroll_indicator()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> vscroll_indicator </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Add a filter that will invert the foreground and the background colors. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="scroll__indicator_8cpp_source.html#l00012">12</a> of file <a class="el" href="scroll__indicator_8cpp_source.html">scroll_indicator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af7d0d1e44c1a5424e42a5cddceacf7f7" name="af7d0d1e44c1a5424e42a5cddceacf7f7"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af7d0d1e44c1a5424e42a5cddceacf7f7">◆ </a></span>hcenter()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> hcenter </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Center an element horizontally. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The decorated element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The centered element. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="composite__decorator_8cpp_source.html#l00012">12</a> of file <a class="el" href="composite__decorator_8cpp_source.html">composite_decorator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad907a8a48bb9f9dfdb06402e9fc12316" name="ad907a8a48bb9f9dfdb06402e9fc12316"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad907a8a48bb9f9dfdb06402e9fc12316">◆ </a></span>vcenter()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> vcenter </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Center an element vertically. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The decorated element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The centered element. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="composite__decorator_8cpp_source.html#l00020">20</a> of file <a class="el" href="composite__decorator_8cpp_source.html">composite_decorator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5b11656305fce8427b81daf1c35883f1" name="a5b11656305fce8427b81daf1c35883f1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5b11656305fce8427b81daf1c35883f1">◆ </a></span>center()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> center </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Center an element horizontally and vertically. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The decorated element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The centered element. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="composite__decorator_8cpp_source.html#l00028">28</a> of file <a class="el" href="composite__decorator_8cpp_source.html">composite_decorator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a778e52afe28f1978f1f7ef065ed92d6d" name="a778e52afe28f1978f1f7ef065ed92d6d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a778e52afe28f1978f1f7ef065ed92d6d">◆ </a></span>align_right()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> align_right </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Align an element on the right side. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The decorated element. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The right aligned element. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="composite__decorator_8cpp_source.html#l00036">36</a> of file <a class="el" href="composite__decorator_8cpp_source.html">composite_decorator.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a1bfd3885ac8b40dc82a1103725003c07" name="a1bfd3885ac8b40dc82a1103725003c07"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a1bfd3885ac8b40dc82a1103725003c07">◆ </a></span>nothing()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> nothing </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>element</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>A decoration doing absolutely nothing. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="util_8cpp_source.html#l00025">25</a> of file <a class="el" href="util_8cpp_source.html">util.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a23baec2f3d3a6a82e3f605d695c7e21b" name="a23baec2f3d3a6a82e3f605d695c7e21b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a23baec2f3d3a6a82e3f605d695c7e21b">◆ </a></span>clear_under()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> clear_under </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a></td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Before drawing |child|, clear the pixels below. This is useful in. </p>
|
||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a901ab1b6b2e0e8c295552168ab206441" title="Stack several element on top of each other.">ftxui::dbox</a> </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="clear__under_8cpp_source.html#l00032">32</a> of file <a class="el" href="clear__under_8cpp_source.html">clear_under.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad4b8aa9392f56ba41e2b421e046a7d83" name="ad4b8aa9392f56ba41e2b421e046a7d83"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad4b8aa9392f56ba41e2b421e046a7d83">◆ </a></span>Render() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Render </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Screen.html">Screen</a> &</td> <td class="paramname"><span class="paramname"><em>screen</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const <a class="el" href="#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> &</td> <td class="paramname"><span class="paramname"><em>node</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Display an element on a <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">ftxui::Screen</a>. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="node_8cpp_source.html#l00034">34</a> of file <a class="el" href="node_8cpp_source.html">node.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a32a24db985fa1b37bf686b00f7e1b4ff" name="a32a24db985fa1b37bf686b00f7e1b4ff"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a32a24db985fa1b37bf686b00f7e1b4ff">◆ </a></span>Render() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void Render </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Screen.html">Screen</a> &</td> <td class="paramname"><span class="paramname"><em>screen</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Node.html">Node</a> *</td> <td class="paramname"><span class="paramname"><em>node</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Display an element on a <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">ftxui::Screen</a>. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="node_8cpp_source.html#l00040">40</a> of file <a class="el" href="node_8cpp_source.html">node.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a883a81f30fb771a82f6c87b77ac3658e" name="a883a81f30fb771a82f6c87b77ac3658e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a883a81f30fb771a82f6c87b77ac3658e">◆ </a></span>GetColorInfo() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a> GetColorInfo </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html#abd07c48f62cc507fafa2486a43130fcf">Color::Palette256</a></td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="color__info_8cpp_source.html#l00266">266</a> of file <a class="el" href="color__info_8cpp_source.html">color_info.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad5dd7fa2651003bf7c9f8b58de9b0a93" name="ad5dd7fa2651003bf7c9f8b58de9b0a93"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad5dd7fa2651003bf7c9f8b58de9b0a93">◆ </a></span>GetColorInfo() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a> GetColorInfo </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802f">Color::Palette16</a></td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="color__info_8cpp_source.html#l00270">270</a> of file <a class="el" href="color__info_8cpp_source.html">color_info.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a1bb4947f62228380f5c415f69b34021f" name="a1bb4947f62228380f5c415f69b34021f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a1bb4947f62228380f5c415f69b34021f">◆ </a></span>wchar_width()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int wchar_width </td>
|
||
<td>(</td>
|
||
<td class="paramtype">wchar_t</td> <td class="paramname"><span class="paramname"><em>ucs</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8cpp_source.html#l00210">210</a> of file <a class="el" href="string_8cpp_source.html">string.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="adedb4aa528ad2aef48177dea69ca7a9d" name="adedb4aa528ad2aef48177dea69ca7a9d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#adedb4aa528ad2aef48177dea69ca7a9d">◆ </a></span>wstring_width()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int wstring_width </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::wstring &</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8cpp_source.html#l00214">214</a> of file <a class="el" href="string_8cpp_source.html">string.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a757b345f73bb6cde5165a4d7f0c0a298" name="a757b345f73bb6cde5165a4d7f0c0a298"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a757b345f73bb6cde5165a4d7f0c0a298">◆ </a></span>to_string()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::string to_string </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::wstring &</td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Convert a UTF8 std::string into a std::wstring. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8cpp_source.html#l00297">297</a> of file <a class="el" href="string_8cpp_source.html">string.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a57429a83a46c643a81dee81e49384439" name="a57429a83a46c643a81dee81e49384439"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a57429a83a46c643a81dee81e49384439">◆ </a></span>to_wstring() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::wstring to_wstring </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Convert a std::wstring into a UTF8 std::string. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8cpp_source.html#l00303">303</a> of file <a class="el" href="string_8cpp_source.html">string.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a24ea52e8ef70889ef1da986837e0ff34" name="a24ea52e8ef70889ef1da986837e0ff34"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a24ea52e8ef70889ef1da986837e0ff34">◆ </a></span>to_wstring() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<typename T > </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::wstring to_wstring </td>
|
||
<td>(</td>
|
||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8hpp_source.html#l00012">12</a> of file <a class="el" href="string_8hpp_source.html">string.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a517b35c7721e632812d8b3a7697c4099" name="a517b35c7721e632812d8b3a7697c4099"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a517b35c7721e632812d8b3a7697c4099">◆ </a></span>string_width()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int string_width </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8cpp_source.html#l00226">226</a> of file <a class="el" href="string_8cpp_source.html">string.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a389c58d385e861cd2ef109b53fc6ef96" name="a389c58d385e861cd2ef109b53fc6ef96"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a389c58d385e861cd2ef109b53fc6ef96">◆ </a></span>Utf8ToGlyphs()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::vector< std::string > Utf8ToGlyphs </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="string_8cpp_source.html#l00250">250</a> of file <a class="el" href="string_8cpp_source.html">string.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0bfd67a2815807dc6fc9bc0f79bce29e" name="a0bfd67a2815807dc6fc9bc0f79bce29e"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0bfd67a2815807dc6fc9bc0f79bce29e">◆ </a></span>CatchEvent() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> CatchEvent </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">std::function< bool(<a class="el" href="structftxui_1_1Event.html">Event</a> event)></td> <td class="paramname"><span class="paramname"><em>on_event</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">child</td><td>The wrapped component. </td></tr>
|
||
<tr><td class="paramname">on_event</td><td>The function drawing the interface.</td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<h3><a class="anchor" id="autotoc_md2"></a>
|
||
Example</h3>
|
||
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1ScreenInteractive.html#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
|
||
<div class="line"><span class="keyword">auto</span> renderer = <a class="code hl_function" href="#a533e883e2aeea28de2b60564fcaf0361">Renderer</a>([] {</div>
|
||
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="#a75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">"My interface"</span>);</div>
|
||
<div class="line">});</div>
|
||
<div class="line">screen.Loop(renderer);</div>
|
||
</div><!-- fragment -->
|
||
<p class="definition">Definition at line <a class="el" href="catch__event_8cpp_source.html#l00044">44</a> of file <a class="el" href="catch__event_8cpp_source.html">catch_event.cpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a737061bef132d71c408d12a5d538827a" name="a737061bef132d71c408d12a5d538827a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a737061bef132d71c408d12a5d538827a">◆ </a></span>Slider() <span class="overload">[2/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">template <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Slider </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>min</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>max</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>increment</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a8ce92386e55e65bb157162d0ee1cf159" name="a8ce92386e55e65bb157162d0ee1cf159"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a8ce92386e55e65bb157162d0ee1cf159">◆ </a></span>Slider() <span class="overload">[3/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">template <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Slider </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">float *</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>min</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>max</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>increment</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad6ce10b7cb20a078b35f759c0e2b91c5" name="ad6ce10b7cb20a078b35f759c0e2b91c5"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad6ce10b7cb20a078b35f759c0e2b91c5">◆ </a></span>Slider() <span class="overload">[4/4]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">template <a class="el" href="#af1479ede01dbf087342534ab4ada11d3">Component</a> Slider </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classftxui_1_1ConstStringRef.html">ConstStringRef</a></td> <td class="paramname"><span class="paramname"><em>label</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">long *</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>min</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>max</em></span>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>increment</em></span> )</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
</div>
|
||
</div>
|
||
<h2 class="groupheader">Variable Documentation</h2>
|
||
<a id="a987f5d0522854bb0c2be1b58c72ffe1c" name="a987f5d0522854bb0c2be1b58c72ffe1c"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a987f5d0522854bb0c2be1b58c72ffe1c">◆ </a></span>palette256</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">const <a class="el" href="#structftxui_1_1ColorInfo">ColorInfo</a> palette256[]</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p class="definition">Definition at line <a class="el" href="color__info_8cpp_source.html#l00007">7</a> of file <a class="el" href="color__info_8cpp_source.html">color_info.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": "../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": "index.html"};
|
||
const currentVersion = "v0.10";
|
||
|
||
// 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>
|