mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
928 lines
54 KiB
HTML
928 lines
54 KiB
HTML
<!-- HTML header for doxygen 1.9.8-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.12.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FTXUI: ComponentBase Class 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>
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
</script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">FTXUI<span id="projectnumber"> 6.1.9</span>
|
|
</div>
|
|
<div id="projectbrief">C++ functional terminal UI.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classftxui_1_1ComponentBase.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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> </div>
|
|
<div class="headertitle"><div class="title">ComponentBase Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>It implement rendering itself as <a class="el" href="namespaceftxui.html#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="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad2a5b6ce11bc7a8ce1150cf0ba9144c0" id="r_ad2a5b6ce11bc7a8ce1150cf0ba9144c0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2a5b6ce11bc7a8ce1150cf0ba9144c0">ComponentBase</a> (<a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</td></tr>
|
|
<tr class="separator:ad2a5b6ce11bc7a8ce1150cf0ba9144c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae490d465a018a9d81bb4e30604708fba" id="r_ae490d465a018a9d81bb4e30604708fba"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae490d465a018a9d81bb4e30604708fba">~ComponentBase</a> ()</td></tr>
|
|
<tr class="separator:ae490d465a018a9d81bb4e30604708fba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acda4c8b63ffbc2e9e2e28f056edbf01c" id="r_acda4c8b63ffbc2e9e2e28f056edbf01c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acda4c8b63ffbc2e9e2e28f056edbf01c">ComponentBase</a> ()=default</td></tr>
|
|
<tr class="separator:acda4c8b63ffbc2e9e2e28f056edbf01c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd8cf6a9df5eb4678fb9925b686c7aea" id="r_abd8cf6a9df5eb4678fb9925b686c7aea"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abd8cf6a9df5eb4678fb9925b686c7aea">ComponentBase</a> (const <a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &)=delete</td></tr>
|
|
<tr class="separator:abd8cf6a9df5eb4678fb9925b686c7aea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b3cf357cf150023641969d5fcb7d08f" id="r_a9b3cf357cf150023641969d5fcb7d08f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b3cf357cf150023641969d5fcb7d08f">ComponentBase</a> (<a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &&)=delete</td></tr>
|
|
<tr class="separator:a9b3cf357cf150023641969d5fcb7d08f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac444ac233dcbd4b2ad7972d2086ecc73" id="r_ac444ac233dcbd4b2ad7972d2086ecc73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac444ac233dcbd4b2ad7972d2086ecc73">operator=</a> (const <a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &)=delete</td></tr>
|
|
<tr class="separator:ac444ac233dcbd4b2ad7972d2086ecc73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e3b99c8fc32f2ce151e2ba737c0d546" id="r_a9e3b99c8fc32f2ce151e2ba737c0d546"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e3b99c8fc32f2ce151e2ba737c0d546">operator=</a> (<a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &&)=delete</td></tr>
|
|
<tr class="separator:a9e3b99c8fc32f2ce151e2ba737c0d546"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf284a408631f31558694973a04186c2" id="r_aaf284a408631f31558694973a04186c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf284a408631f31558694973a04186c2">Parent</a> () const</td></tr>
|
|
<tr class="memdesc:aaf284a408631f31558694973a04186c2"><td class="mdescLeft"> </td><td class="mdescRight">Return the parent <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a>, or nul if any. <br /></td></tr>
|
|
<tr class="separator:aaf284a408631f31558694973a04186c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceb41a98abe10fb0b521ff8b65529b7f" id="r_aceb41a98abe10fb0b521ff8b65529b7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aceb41a98abe10fb0b521ff8b65529b7f">ChildAt</a> (size_t i)</td></tr>
|
|
<tr class="memdesc:aceb41a98abe10fb0b521ff8b65529b7f"><td class="mdescLeft"> </td><td class="mdescRight">Access the child at index <code>i</code>. <br /></td></tr>
|
|
<tr class="separator:aceb41a98abe10fb0b521ff8b65529b7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ae5f77e923e2f0f8b0e26dcd4affb5b" id="r_a9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ae5f77e923e2f0f8b0e26dcd4affb5b">ChildCount</a> () const</td></tr>
|
|
<tr class="memdesc:a9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of children. <br /></td></tr>
|
|
<tr class="separator:a9ae5f77e923e2f0f8b0e26dcd4affb5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ef12397d1682615bc3108c397734179" id="r_a8ef12397d1682615bc3108c397734179"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ef12397d1682615bc3108c397734179">Index</a> () const</td></tr>
|
|
<tr class="memdesc:a8ef12397d1682615bc3108c397734179"><td class="mdescLeft"> </td><td class="mdescRight">Return index of the component in its parent. -1 if no parent. <br /></td></tr>
|
|
<tr class="separator:a8ef12397d1682615bc3108c397734179"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21f040bec9104e164bfa6c3ad45be3a1" id="r_a21f040bec9104e164bfa6c3ad45be3a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a21f040bec9104e164bfa6c3ad45be3a1">Add</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> children)</td></tr>
|
|
<tr class="memdesc:a21f040bec9104e164bfa6c3ad45be3a1"><td class="mdescLeft"> </td><td class="mdescRight">Add a child. @param child The child to be attached. <br /></td></tr>
|
|
<tr class="separator:a21f040bec9104e164bfa6c3ad45be3a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb7a2b60240651d16e17d02eb6f636cf" id="r_abb7a2b60240651d16e17d02eb6f636cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#abb7a2b60240651d16e17d02eb6f636cf">Detach</a> ()</td></tr>
|
|
<tr class="memdesc:abb7a2b60240651d16e17d02eb6f636cf"><td class="mdescLeft"> </td><td class="mdescRight">Detach this child from its parent. <br /></td></tr>
|
|
<tr class="separator:abb7a2b60240651d16e17d02eb6f636cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84bd6480cf5e8f51cf5965f81b1f2460" id="r_a84bd6480cf5e8f51cf5965f81b1f2460"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a84bd6480cf5e8f51cf5965f81b1f2460">DetachAllChildren</a> ()</td></tr>
|
|
<tr class="memdesc:a84bd6480cf5e8f51cf5965f81b1f2460"><td class="mdescLeft"> </td><td class="mdescRight">Remove all children. <br /></td></tr>
|
|
<tr class="separator:a84bd6480cf5e8f51cf5965f81b1f2460"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28d41d6113c5b29c8dd45846582b3299" id="r_a28d41d6113c5b29c8dd45846582b3299"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a28d41d6113c5b29c8dd45846582b3299">Render</a> ()</td></tr>
|
|
<tr class="memdesc:a28d41d6113c5b29c8dd45846582b3299"><td class="mdescLeft"> </td><td class="mdescRight">Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">ftxui::Screen</a> representing this <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. Please override <a class="el" href="#ab79303652dad19eac0540848487cf8c5" title="Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::C...">OnRender()</a> to modify the rendering. <br /></td></tr>
|
|
<tr class="separator:a28d41d6113c5b29c8dd45846582b3299"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab79303652dad19eac0540848487cf8c5" id="r_ab79303652dad19eac0540848487cf8c5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab79303652dad19eac0540848487cf8c5">OnRender</a> ()</td></tr>
|
|
<tr class="memdesc:ab79303652dad19eac0540848487cf8c5"><td class="mdescLeft"> </td><td class="mdescRight">Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the ftxi::Screen representing this <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. This function is means to be overridden. <br /></td></tr>
|
|
<tr class="separator:ab79303652dad19eac0540848487cf8c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab84629a8fecad2e1cdd426b7ddc72277" id="r_ab84629a8fecad2e1cdd426b7ddc72277"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab84629a8fecad2e1cdd426b7ddc72277">OnEvent</a> (<a class="el" href="structftxui_1_1Event.html">Event</a>)</td></tr>
|
|
<tr class="memdesc:ab84629a8fecad2e1cdd426b7ddc72277"><td class="mdescLeft"> </td><td class="mdescRight">Called in response to an event. <br /></td></tr>
|
|
<tr class="separator:ab84629a8fecad2e1cdd426b7ddc72277"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebad858485d02f035a8ea34af66a7fa7" id="r_aebad858485d02f035a8ea34af66a7fa7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aebad858485d02f035a8ea34af66a7fa7">OnAnimation</a> (<a class="el" href="classftxui_1_1animation_1_1Params.html">animation::Params</a> &params)</td></tr>
|
|
<tr class="memdesc:aebad858485d02f035a8ea34af66a7fa7"><td class="mdescLeft"> </td><td class="mdescRight">Called in response to an animation event. <br /></td></tr>
|
|
<tr class="separator:aebad858485d02f035a8ea34af66a7fa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c421f00a2a7f50c542c5c286d2e696c" id="r_a5c421f00a2a7f50c542c5c286d2e696c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c421f00a2a7f50c542c5c286d2e696c">ActiveChild</a> ()</td></tr>
|
|
<tr class="memdesc:a5c421f00a2a7f50c542c5c286d2e696c"><td class="mdescLeft"> </td><td class="mdescRight">Return the currently Active child. <br /></td></tr>
|
|
<tr class="separator:a5c421f00a2a7f50c542c5c286d2e696c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02ccd3db74312f1c66aa8e7931489318" id="r_a02ccd3db74312f1c66aa8e7931489318"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a02ccd3db74312f1c66aa8e7931489318">Focusable</a> () const</td></tr>
|
|
<tr class="memdesc:a02ccd3db74312f1c66aa8e7931489318"><td class="mdescLeft"> </td><td class="mdescRight">Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. <br /></td></tr>
|
|
<tr class="separator:a02ccd3db74312f1c66aa8e7931489318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52beef6d7a687d4d109e6cec1606e32e" id="r_a52beef6d7a687d4d109e6cec1606e32e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a52beef6d7a687d4d109e6cec1606e32e">Active</a> () const</td></tr>
|
|
<tr class="memdesc:a52beef6d7a687d4d109e6cec1606e32e"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the element if the currently active child of its parent. <br /></td></tr>
|
|
<tr class="separator:a52beef6d7a687d4d109e6cec1606e32e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cc612fa3d753b456e0f480f44654a9f" id="r_a0cc612fa3d753b456e0f480f44654a9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0cc612fa3d753b456e0f480f44654a9f">Focused</a> () const</td></tr>
|
|
<tr class="memdesc:a0cc612fa3d753b456e0f480f44654a9f"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the elements if focused by the user. True when the <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a> is focused by the user. An element is Focused when it is with all its ancestors the <a class="el" href="#a5c421f00a2a7f50c542c5c286d2e696c" title="Return the currently Active child.">ActiveChild()</a> of their parents, and it <a class="el" href="#a02ccd3db74312f1c66aa8e7931489318" title="Return true when the component contains focusable elements. The non focusable Components will be skip...">Focusable()</a>. <br /></td></tr>
|
|
<tr class="separator:a0cc612fa3d753b456e0f480f44654a9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cbf27680c6154e15c8b32d6601340de" id="r_a8cbf27680c6154e15c8b32d6601340de"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8cbf27680c6154e15c8b32d6601340de">SetActiveChild</a> (<a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> *child)</td></tr>
|
|
<tr class="memdesc:a8cbf27680c6154e15c8b32d6601340de"><td class="mdescLeft"> </td><td class="mdescRight">Make the |child| to be the "active" one. <br /></td></tr>
|
|
<tr class="separator:a8cbf27680c6154e15c8b32d6601340de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50ad32ad14dd7912e681fab0ee294be2" id="r_a50ad32ad14dd7912e681fab0ee294be2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a50ad32ad14dd7912e681fab0ee294be2">SetActiveChild</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child)</td></tr>
|
|
<tr class="memdesc:a50ad32ad14dd7912e681fab0ee294be2"><td class="mdescLeft"> </td><td class="mdescRight">Make the |child| to be the "active" one. <br /></td></tr>
|
|
<tr class="separator:a50ad32ad14dd7912e681fab0ee294be2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cf27e9d7128a6a4b3263ecd34c19105" id="r_a2cf27e9d7128a6a4b3263ecd34c19105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2cf27e9d7128a6a4b3263ecd34c19105">TakeFocus</a> ()</td></tr>
|
|
<tr class="memdesc:a2cf27e9d7128a6a4b3263ecd34c19105"><td class="mdescLeft"> </td><td class="mdescRight">Configure all the ancestors to give focus to this component. <br /></td></tr>
|
|
<tr class="separator:a2cf27e9d7128a6a4b3263ecd34c19105"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a164d10a2cf367bdd4ae14318a6c7d769" id="r_a164d10a2cf367bdd4ae14318a6c7d769"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a164d10a2cf367bdd4ae14318a6c7d769">CaptureMouse</a> (const <a class="el" href="structftxui_1_1Event.html">Event</a> &event)</td></tr>
|
|
<tr class="memdesc:a164d10a2cf367bdd4ae14318a6c7d769"><td class="mdescLeft"> </td><td class="mdescRight">Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. <br /></td></tr>
|
|
<tr class="separator:a164d10a2cf367bdd4ae14318a6c7d769"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a22b4fa4d6aa4c9c2eef275cd25aa8ab9" id="r_a22b4fa4d6aa4c9c2eef275cd25aa8ab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a></td></tr>
|
|
<tr class="separator:a22b4fa4d6aa4c9c2eef275cd25aa8ab9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>It implement rendering itself as <a class="el" href="namespaceftxui.html#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>. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#_a1">examples/component/resizable_split.cpp</a>, <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#_a5">examples/component/scrollbar.cpp</a>, <a class="el" href="examples_2component_2toggle_8cpp-example.html#_a1">examples/component/toggle.cpp</a>, and <a class="el" href="examples_2component_2window_8cpp-example.html#_a2">examples/component/window.cpp</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00030">30</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad2a5b6ce11bc7a8ce1150cf0ba9144c0" name="ad2a5b6ce11bc7a8ce1150cf0ba9144c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2a5b6ce11bc7a8ce1150cf0ba9144c0">◆ </a></span>ComponentBase() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00032">32</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae490d465a018a9d81bb4e30604708fba" name="ae490d465a018a9d81bb4e30604708fba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae490d465a018a9d81bb4e30604708fba">◆ </a></span>~ComponentBase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">~<a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00031">31</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acda4c8b63ffbc2e9e2e28f056edbf01c" name="acda4c8b63ffbc2e9e2e28f056edbf01c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acda4c8b63ffbc2e9e2e28f056edbf01c">◆ </a></span>ComponentBase() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd8cf6a9df5eb4678fb9925b686c7aea" name="abd8cf6a9df5eb4678fb9925b686c7aea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd8cf6a9df5eb4678fb9925b686c7aea">◆ </a></span>ComponentBase() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b3cf357cf150023641969d5fcb7d08f" name="a9b3cf357cf150023641969d5fcb7d08f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b3cf357cf150023641969d5fcb7d08f">◆ </a></span>ComponentBase() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac444ac233dcbd4b2ad7972d2086ecc73" name="ac444ac233dcbd4b2ad7972d2086ecc73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac444ac233dcbd4b2ad7972d2086ecc73">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> & operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9e3b99c8fc32f2ce151e2ba737c0d546" name="a9e3b99c8fc32f2ce151e2ba737c0d546"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e3b99c8fc32f2ce151e2ba737c0d546">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> & operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf284a408631f31558694973a04186c2" name="aaf284a408631f31558694973a04186c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf284a408631f31558694973a04186c2">◆ </a></span>Parent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> * Parent </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the parent <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a>, or nul if any. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#abb7a2b60240651d16e17d02eb6f636cf" title="Detach this child from its parent.">Detach</a> </dd>
|
|
<dd>
|
|
<a class="el" href="#aaf284a408631f31558694973a04186c2" title="Return the parent ComponentBase, or nul if any.">Parent</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00039">39</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aceb41a98abe10fb0b521ff8b65529b7f" name="aceb41a98abe10fb0b521ff8b65529b7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aceb41a98abe10fb0b521ff8b65529b7f">◆ </a></span>ChildAt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> & ChildAt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access the child at index <code>i</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00045">45</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ae5f77e923e2f0f8b0e26dcd4affb5b" name="a9ae5f77e923e2f0f8b0e26dcd4affb5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ae5f77e923e2f0f8b0e26dcd4affb5b">◆ </a></span>ChildCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t ChildCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of children. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00052">52</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ef12397d1682615bc3108c397734179" name="a8ef12397d1682615bc3108c397734179"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ef12397d1682615bc3108c397734179">◆ </a></span>Index()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int Index </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return index of the component in its parent. -1 if no parent. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00058">58</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21f040bec9104e164bfa6c3ad45be3a1" name="a21f040bec9104e164bfa6c3ad45be3a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21f040bec9104e164bfa6c3ad45be3a1">◆ </a></span>Add()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Add </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>children</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a child. @param child The child to be attached. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00075">75</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb7a2b60240651d16e17d02eb6f636cf" name="abb7a2b60240651d16e17d02eb6f636cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb7a2b60240651d16e17d02eb6f636cf">◆ </a></span>Detach()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Detach </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Detach this child from its parent. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#abb7a2b60240651d16e17d02eb6f636cf" title="Detach this child from its parent.">Detach</a> </dd>
|
|
<dd>
|
|
<a class="el" href="#aaf284a408631f31558694973a04186c2" title="Return the parent ComponentBase, or nul if any.">Parent</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00085">85</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84bd6480cf5e8f51cf5965f81b1f2460" name="a84bd6480cf5e8f51cf5965f81b1f2460"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84bd6480cf5e8f51cf5965f81b1f2460">◆ </a></span>DetachAllChildren()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DetachAllChildren </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove all children. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00101">101</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28d41d6113c5b29c8dd45846582b3299" name="a28d41d6113c5b29c8dd45846582b3299"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28d41d6113c5b29c8dd45846582b3299">◆ </a></span>Render()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> Render </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">ftxui::Screen</a> representing this <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. Please override <a class="el" href="#ab79303652dad19eac0540848487cf8c5" title="Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::C...">OnRender()</a> to modify the rendering. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00111">111</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab79303652dad19eac0540848487cf8c5" name="ab79303652dad19eac0540848487cf8c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab79303652dad19eac0540848487cf8c5">◆ </a></span>OnRender()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> OnRender </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw the component. Build a <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a> to be drawn on the ftxi::Screen representing this <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ftxui::ComponentBase</a>. This function is means to be overridden. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00147">147</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab84629a8fecad2e1cdd426b7ddc72277" name="ab84629a8fecad2e1cdd426b7ddc72277"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab84629a8fecad2e1cdd426b7ddc72277">◆ </a></span>OnEvent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OnEvent </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structftxui_1_1Event.html">Event</a></td> <td class="paramname"><span class="paramname"><em>event</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called in response to an event. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>The event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True when the event has been handled. The default implementation called OnEvent on every child until one return true. If none returns true, return false. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00161">161</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebad858485d02f035a8ea34af66a7fa7" name="aebad858485d02f035a8ea34af66a7fa7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebad858485d02f035a8ea34af66a7fa7">◆ </a></span>OnAnimation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OnAnimation </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1animation_1_1Params.html">animation::Params</a> &</td> <td class="paramname"><span class="paramname"><em>params</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called in response to an animation event. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">params</td><td>the parameters of the animation The default implementation dispatch the event to every child. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00174">174</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c421f00a2a7f50c542c5c286d2e696c" name="a5c421f00a2a7f50c542c5c286d2e696c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c421f00a2a7f50c542c5c286d2e696c">◆ </a></span>ActiveChild()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> ActiveChild </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the currently Active child. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the currently Active child. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00183">183</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02ccd3db74312f1c66aa8e7931489318" name="a02ccd3db74312f1c66aa8e7931489318"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02ccd3db74312f1c66aa8e7931489318">◆ </a></span>Focusable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Focusable </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00196">196</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a52beef6d7a687d4d109e6cec1606e32e" name="a52beef6d7a687d4d109e6cec1606e32e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52beef6d7a687d4d109e6cec1606e32e">◆ </a></span>Active()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Active </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns if the element if the currently active child of its parent. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00207">207</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0cc612fa3d753b456e0f480f44654a9f" name="a0cc612fa3d753b456e0f480f44654a9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cc612fa3d753b456e0f480f44654a9f">◆ </a></span>Focused()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Focused </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns if the elements if focused by the user. True when the <a class="el" href="classftxui_1_1ComponentBase.html" title="It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...">ComponentBase</a> is focused by the user. An element is Focused when it is with all its ancestors the <a class="el" href="#a5c421f00a2a7f50c542c5c286d2e696c" title="Return the currently Active child.">ActiveChild()</a> of their parents, and it <a class="el" href="#a02ccd3db74312f1c66aa8e7931489318" title="Return true when the component contains focusable elements. The non focusable Components will be skip...">Focusable()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00216">216</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8cbf27680c6154e15c8b32d6601340de" name="a8cbf27680c6154e15c8b32d6601340de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8cbf27680c6154e15c8b32d6601340de">◆ </a></span>SetActiveChild() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetActiveChild </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a> *</td> <td class="paramname"><span class="paramname"><em>child</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make the |child| to be the "active" one. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">child</td><td>the child to become active. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00227">227</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50ad32ad14dd7912e681fab0ee294be2" name="a50ad32ad14dd7912e681fab0ee294be2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50ad32ad14dd7912e681fab0ee294be2">◆ </a></span>SetActiveChild() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetActiveChild </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</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 |child| to be the "active" one. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">child</td><td>the child to become active. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00232">232</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2cf27e9d7128a6a4b3263ecd34c19105" name="a2cf27e9d7128a6a4b3263ecd34c19105"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2cf27e9d7128a6a4b3263ecd34c19105">◆ </a></span>TakeFocus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TakeFocus </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure all the ancestors to give focus to this component. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00238">238</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a164d10a2cf367bdd4ae14318a6c7d769" name="a164d10a2cf367bdd4ae14318a6c7d769"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a164d10a2cf367bdd4ae14318a6c7d769">◆ </a></span>CaptureMouse()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> CaptureMouse </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structftxui_1_1Event.html">Event</a> &</td> <td class="paramname"><span class="paramname"><em>event</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>The event </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component_8cpp_source.html#l00250">250</a> of file <a class="el" href="component_8cpp_source.html">component.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a22b4fa4d6aa4c9c2eef275cd25aa8ab9" name="a22b4fa4d6aa4c9c2eef275cd25aa8ab9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">◆ </a></span>children_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="component__base_8hpp_source.html#l00096">96</a> of file <a class="el" href="component__base_8hpp_source.html">component_base.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="component__base_8hpp_source.html">component_base.hpp</a></li>
|
|
<li><a class="el" href="component_8cpp_source.html">component.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.9.8-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="classftxui_1_1ComponentBase.html">ComponentBase</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|