zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-06-23 23:41:13 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
fca8e2977f
FTXUI/component__base_8hpp_source.html

355 lines
43 KiB
HTML
Raw Normal View History

deploy: 68fc9b12127bd540c8ebfd6ef70f722604e5a0cd
2025-06-20 22:18:44 +08:00
<!-- 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: component_base.hpp Source File</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="module">
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeParagraphLink.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeTabs.init()
await new Promise(r => window.addEventListener('DOMContentLoaded', r));
// Remove title when a img[alt='title-img'] is present.
// Find an image with the alt "img-title".
const img = document.querySelector("img[alt='title-img']");
const header = document.querySelector(".headertitle");
if (img && header) {
// Hide the header title progressively.
header.style.display = "none";
// Show progressively the image.
img.style.maxHeight = "40vh";
img.style.maxWidth = "100%";
img.style.objectFit = "contain";
}
// In the "examples.html" page. Turn every link with text
// "examples/<...>
//
// Add a "demo" link toward.
// https://arthursonzogni.github.io/FTXUI/examples/?file=<...>
const examples = document.querySelectorAll("a")
examples.forEach((example) => {
if (!example.textContent.startsWith("examples/")) {
return;
}
// Remove the ".cpp" extension from the example name.
const exampleName = example.textContent.replace("examples/", "").replace(".cpp", "");
const a = document.createElement("a");
a.textContent = "[demo]";
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + exampleName;
a.style.marginRight= "1em";
a.style.fontWeight = "bold";
example.parentElement.insertBefore(a, example)
});
// If the current URL ends with -example.html, we can add a link to the demo
// as well using the div.title textContent.
const url = new URL(window.location.href);
if (url.pathname.endsWith("-example.html")) {
// Get the title text.
const title = document.querySelector("div.title").textContent;
const example = title.replace("examples/", "").replace(".cpp", "");
// Create a link to the demo.
const a = document.createElement("a");
a.textContent = "[demo]";
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + example;
a.style.marginLeft = "1em";
a.style.fontWeight = "bold";
a.style.display = "inline-block";
// Insert the link after the title.
const titleDiv = document.querySelector("div.title");
if (titleDiv) {
titleDiv.insertBefore(a, titleDiv.nextSibling);
}
}
</script>
<script type="module">
// Click on the navtree, except for the main page where this is already done
// automatically.
let delay = 0;
while(true) {
const navtree = document.querySelector("div.item.selected");
if (!navtree) {
delay *= 2;
delay += 1;
await new Promise(resolve => setTimeout(resolve, delay));
continue;
}
// Include only selected navtree items.
console.log("navtree.textContent", navtree.textContent);
if (!navtree.textContent.includes("Getting Started") &&
!navtree.textContent.includes("Installation") &&
!navtree.textContent.includes("ftxui / screen") &&
!navtree.textContent.includes("ftxui / dom") &&
!navtree.textContent.includes("ftxui / component") &&
!navtree.textContent.includes("Reference")) {
break;
}
// Find the first link inside the navtree.
const link = navtree.querySelector("a");
if (link) {
// Simulate a click on the link.
link.click();
break;
}
}
</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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('component__base_8hpp_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">component_base.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="component__base_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2020 Arthur Sonzogni. All rights reserved.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// the LICENSE file.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifndef FTXUI_COMPONENT_BASE_HPP</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define FTXUI_COMPONENT_BASE_HPP</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;memory&gt;</span> <span class="comment">// for unique_ptr</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;vector&gt;</span> <span class="comment">// for vector</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;<a class="code" href="captured__mouse_8hpp.html">ftxui/component/captured_mouse.hpp</a>&quot;</span> <span class="comment">// for CaptureMouse</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;<a class="code" href="elements_8hpp.html">ftxui/dom/elements.hpp</a>&quot;</span> <span class="comment">// for Element</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">class </span>Delegate;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">class </span>Focus;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">struct </span>Event;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">namespace </span>animation {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">class </span>Params;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>} <span class="comment">// namespace animation</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">class </span>ComponentBase;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3"> 24</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> = std::shared_ptr&lt;ComponentBase&gt;;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c"> 25</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> = std::vector&lt;Component&gt;;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"></span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">/// @brief It implement rendering itself as ftxui::Element. It implement</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">/// keyboard navigation by responding to ftxui::Event.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">/// @ingroup component</span></div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="group__component.html"> 30</a></span><span class="comment"></span><span class="keyword">class </span><a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a> {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="}">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="group__component.html#ad2a5b6ce11bc7a8ce1150cf0ba9144c0"> 32</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="group__component.html#ad2a5b6ce11bc7a8ce1150cf0ba9144c0">ComponentBase</a>(<a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> children)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> : <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>(std::move(children)) {}</div>
</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">virtual</span> <a class="code hl_function" href="group__component.html#ae490d465a018a9d81bb4e30604708fba">~ComponentBase</a>();</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="group__component.html#acda4c8b63ffbc2e9e2e28f056edbf01c"> 35</a></span> <a class="code hl_function" href="group__component.html#acda4c8b63ffbc2e9e2e28f056edbf01c">ComponentBase</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// A component is not copyable/movable.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group__component.html#abd8cf6a9df5eb4678fb9925b686c7aea"> 38</a></span> <a class="code hl_function" href="group__component.html#abd8cf6a9df5eb4678fb9925b686c7aea">ComponentBase</a>(<span class="keyword">const</span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="group__component.html#a9b3cf357cf150023641969d5fcb7d08f"> 39</a></span> <a class="code hl_function" href="group__component.html#a9b3cf357cf150023641969d5fcb7d08f">ComponentBase</a>(<a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>&amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="group__component.html#ac444ac233dcbd4b2ad7972d2086ecc73"> 40</a></span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>&amp; <a class="code hl_function" href="group__component.html#ac444ac233dcbd4b2ad7972d2086ecc73">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="group__component.html#a9e3b99c8fc32f2ce151e2ba737c0d546"> 41</a></span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>&amp; <a class="code hl_function" href="group__component.html#a9e3b99c8fc32f2ce151e2ba737c0d546">operator=</a>(<a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>&amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Component hierarchy:</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* <a class="code hl_function" href="group__component.html#aaf284a408631f31558694973a04186c2">Parent</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; <a class="code hl_function" href="group__component.html#aceb41a98abe10fb0b521ff8b65529b7f">ChildAt</a>(<span class="keywordtype">size_t</span> i);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="group__component.html#a9ae5f77e923e2f0f8b0e26dcd4affb5b">ChildCount</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">int</span> <a class="code hl_function" href="group__component.html#a8ef12397d1682615bc3108c397734179">Index</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a21f040bec9104e164bfa6c3ad45be3a1">Add</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> children);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#abb7a2b60240651d16e17d02eb6f636cf">Detach</a>();</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a84bd6480cf5e8f51cf5965f81b1f2460">DetachAllChildren</a>();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Renders the component.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="code hl_function" href="group__component.html#a28d41d6113c5b29c8dd45846582b3299">Render</a>();</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Override this function modify how `Render` works.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="code hl_function" href="group__component.html#ab79303652dad19eac0540848487cf8c5">OnRender</a>();</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// Handles an event.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// By default, reduce on children with a lazy OR.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="comment">//</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Returns whether the event was handled or not.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#ab84629a8fecad2e1cdd426b7ddc72277">OnEvent</a>(<a class="code hl_struct" href="group__component.html#structftxui_1_1Event">Event</a>);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// Handle an animation step.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#aebad858485d02f035a8ea34af66a7fa7">OnAnimation</a>(<a class="code hl_class" href="classftxui_1_1animation_1_1Params.html">animation::Params</a>&amp; params);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Focus management ----------------------------------------------------------</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">//</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// If this component contains children, this indicates which one is active,</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// nullptr if none is active.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="comment">//</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// We say an element has the focus if the chain of ActiveChild() from the</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// root component contains this object.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#a5c421f00a2a7f50c542c5c286d2e696c">ActiveChild</a>();</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// Return true when the component contains focusable elements.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// The non focusable Component will be skipped when navigating using the</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// keyboard.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#a02ccd3db74312f1c66aa8e7931489318">Focusable</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// Whether this is the active child of its parent.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#a52beef6d7a687d4d109e6cec1606e32e">Active</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Whether all the ancestors are active.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#a0cc612fa3d753b456e0f480f44654a9f">Focused</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// Make the |child| to be the &quot;active&quot; one.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">SetActiveChild</a>(<a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* child);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">SetActiveChild</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// Configure all the ancestors to give focus to this component.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a2cf27e9d7128a6a4b3263ecd34c19105">TakeFocus</a>();</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <a class="code hl_typedef" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> <a class="code hl_function" href="group__component.html#a164d10a2cf367bdd4ae14318a6c7d769">CaptureMouse</a>(<span class="keyword">const</span> <a class="code hl_struct" href="group__component.html#structftxui_1_1Event">Event</a>&amp; event);</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9"> 96</a></span> <a class="code hl_typedef" href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">Components</a> <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* parent_ = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">bool</span> in_render = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>};</div>
</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>} <span class="comment">// namespace ftxui</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="preprocessor">#endif </span><span class="comment">/* end of include guard: FTXUI_COMPONENT_BASE_HPP */</span><span class="preprocessor"></span></div>
<div class="ttc" id="acaptured__mouse_8hpp_html"><div class="ttname"><a href="captured__mouse_8hpp.html">captured_mouse.hpp</a></div></div>
<div class="ttc" id="aclassftxui_1_1animation_1_1Params_html"><div class="ttname"><a href="classftxui_1_1animation_1_1Params.html">ftxui::animation::Params</a></div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00033">animation.hpp:33</a></div></div>
<div class="ttc" id="aelements_8hpp_html"><div class="ttname"><a href="elements_8hpp.html">elements.hpp</a></div></div>
<div class="ttc" id="agroup__component_html_a02ccd3db74312f1c66aa8e7931489318"><div class="ttname"><a href="group__component.html#a02ccd3db74312f1c66aa8e7931489318">ftxui::ComponentBase::Focusable</a></div><div class="ttdeci">virtual bool Focusable() const</div><div class="ttdoc">Return true when the component contains focusable elements. The non focusable Components will be skip...</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00183">component.cpp:183</a></div></div>
<div class="ttc" id="agroup__component_html_a0cc612fa3d753b456e0f480f44654a9f"><div class="ttname"><a href="group__component.html#a0cc612fa3d753b456e0f480f44654a9f">ftxui::ComponentBase::Focused</a></div><div class="ttdeci">bool Focused() const</div><div class="ttdoc">Returns if the elements if focused by the user. True when the ComponentBase is focused by the user....</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00201">component.cpp:201</a></div></div>
<div class="ttc" id="agroup__component_html_a164d10a2cf367bdd4ae14318a6c7d769"><div class="ttname"><a href="group__component.html#a164d10a2cf367bdd4ae14318a6c7d769">ftxui::ComponentBase::CaptureMouse</a></div><div class="ttdeci">CapturedMouse CaptureMouse(const Event &amp;event)</div><div class="ttdoc">Take the CapturedMouse if available. There is only one component of them. It represents a component t...</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00231">component.cpp:231</a></div></div>
<div class="ttc" id="agroup__component_html_a21f040bec9104e164bfa6c3ad45be3a1"><div class="ttname"><a href="group__component.html#a21f040bec9104e164bfa6c3ad45be3a1">ftxui::ComponentBase::Add</a></div><div class="ttdeci">void Add(Component children)</div><div class="ttdoc">Add a child. @param child The child to be attached.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00070">component.cpp:70</a></div></div>
<div class="ttc" id="agroup__component_html_a22b4fa4d6aa4c9c2eef275cd25aa8ab9"><div class="ttname"><a href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">ftxui::ComponentBase::children_</a></div><div class="ttdeci">Components children_</div><div class="ttdef"><b>Definition</b> <a href="#l00096">component_base.hpp:96</a></div></div>
<div class="ttc" id="agroup__component_html_a28d41d6113c5b29c8dd45846582b3299"><div class="ttname"><a href="group__component.html#a28d41d6113c5b29c8dd45846582b3299">ftxui::ComponentBase::Render</a></div><div class="ttdeci">Element Render()</div><div class="ttdoc">Draw the component. Build a ftxui::Element to be drawn on the ftxui::Screen representing this ftxui::...</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00103">component.cpp:103</a></div></div>
<div class="ttc" id="agroup__component_html_a2cf27e9d7128a6a4b3263ecd34c19105"><div class="ttname"><a href="group__component.html#a2cf27e9d7128a6a4b3263ecd34c19105">ftxui::ComponentBase::TakeFocus</a></div><div class="ttdeci">void TakeFocus()</div><div class="ttdoc">Configure all the ancestors to give focus to this component.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00220">component.cpp:220</a></div></div>
<div class="ttc" id="agroup__component_html_a52beef6d7a687d4d109e6cec1606e32e"><div class="ttname"><a href="group__component.html#a52beef6d7a687d4d109e6cec1606e32e">ftxui::ComponentBase::Active</a></div><div class="ttdeci">bool Active() const</div><div class="ttdoc">Returns if the element if the currently active child of its parent.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00193">component.cpp:193</a></div></div>
<div class="ttc" id="agroup__component_html_a5c421f00a2a7f50c542c5c286d2e696c"><div class="ttname"><a href="group__component.html#a5c421f00a2a7f50c542c5c286d2e696c">ftxui::ComponentBase::ActiveChild</a></div><div class="ttdeci">virtual Component ActiveChild()</div><div class="ttdoc">Return the currently Active child.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00171">component.cpp:171</a></div></div>
<div class="ttc" id="agroup__component_html_a84bd6480cf5e8f51cf5965f81b1f2460"><div class="ttname"><a href="group__component.html#a84bd6480cf5e8f51cf5965f81b1f2460">ftxui::ComponentBase::DetachAllChildren</a></div><div class="ttdeci">void DetachAllChildren()</div><div class="ttdoc">Remove all children.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00094">component.cpp:94</a></div></div>
<div class="ttc" id="agroup__component_html_a8cbf27680c6154e15c8b32d6601340de"><div class="ttname"><a href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">ftxui::ComponentBase::SetActiveChild</a></div><div class="ttdeci">virtual void SetActiveChild(ComponentBase *child)</div><div class="ttdoc">Make the |child| to be the &quot;active&quot; one.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00211">component.cpp:211</a></div></div>
<div class="ttc" id="agroup__component_html_a8ef12397d1682615bc3108c397734179"><div class="ttname"><a href="group__component.html#a8ef12397d1682615bc3108c397734179">ftxui::ComponentBase::Index</a></div><div class="ttdeci">int Index() const</div><div class="ttdoc">Return index of the component in its parent. -1 if no parent.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00054">component.cpp:54</a></div></div>
<div class="ttc" id="agroup__component_html_a9ae5f77e923e2f0f8b0e26dcd4affb5b"><div class="ttname"><a href="group__component.html#a9ae5f77e923e2f0f8b0e26dcd4affb5b">ftxui::ComponentBase::ChildCount</a></div><div class="ttdeci">size_t ChildCount() const</div><div class="ttdoc">Returns the number of children.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00049">component.cpp:49</a></div></div>
<div class="ttc" id="agroup__component_html_a9b3cf357cf150023641969d5fcb7d08f"><div class="ttname"><a href="group__component.html#a9b3cf357cf150023641969d5fcb7d08f">ftxui::ComponentBase::ComponentBase</a></div><div class="ttdeci">ComponentBase(ComponentBase &amp;&amp;)=delete</div></div>
<div class="ttc" id="agroup__component_html_a9e3b99c8fc32f2ce151e2ba737c0d546"><div class="ttname"><a href="group__component.html#a9e3b99c8fc32f2ce151e2ba737c0d546">ftxui::ComponentBase::operator=</a></div><div class="ttdeci">ComponentBase &amp; operator=(ComponentBase &amp;&amp;)=delete</div></div>
<div class="ttc" id="agroup__component_html_aaf284a408631f31558694973a04186c2"><div class="ttname"><a href="group__component.html#aaf284a408631f31558694973a04186c2">ftxui::ComponentBase::Parent</a></div><div class="ttdeci">ComponentBase * Parent() const</div><div class="ttdoc">Return the parent ComponentBase, or nul if any.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00038">component.cpp:38</a></div></div>
<div class="ttc" id="agroup__component_html_ab79303652dad19eac0540848487cf8c5"><div class="ttname"><a href="group__component.html#ab79303652dad19eac0540848487cf8c5">ftxui::ComponentBase::OnRender</a></div><div class="ttdeci">virtual Element OnRender()</div><div class="ttdoc">Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::C...</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00138">component.cpp:138</a></div></div>
<div class="ttc" id="agroup__component_html_ab84629a8fecad2e1cdd426b7ddc72277"><div class="ttname"><a href="group__component.html#ab84629a8fecad2e1cdd426b7ddc72277">ftxui::ComponentBase::OnEvent</a></div><div class="ttdeci">virtual bool OnEvent(Event)</div><div class="ttdoc">Called in response to an event.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00151">component.cpp:151</a></div></div>
<div class="ttc" id="agroup__component_html_abb7a2b60240651d16e17d02eb6f636cf"><div class="ttname"><a href="group__component.html#abb7a2b60240651d16e17d02eb6f636cf">ftxui::ComponentBase::Detach</a></div><div class="ttdeci">void Detach()</div><div class="ttdoc">Detach this child from its parent.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00079">component.cpp:79</a></div></div>
<div class="ttc" id="agroup__component_html_abd8cf6a9df5eb4678fb9925b686c7aea"><div class="ttname"><a href="group__component.html#abd8cf6a9df5eb4678fb9925b686c7aea">ftxui::ComponentBase::ComponentBase</a></div><div class="ttdeci">ComponentBase(const ComponentBase &amp;)=delete</div></div>
<div class="ttc" id="agroup__component_html_ac444ac233dcbd4b2ad7972d2086ecc73"><div class="ttname"><a href="group__component.html#ac444ac233dcbd4b2ad7972d2086ecc73">ftxui::ComponentBase::operator=</a></div><div class="ttdeci">ComponentBase &amp; operator=(const ComponentBase &amp;)=delete</div></div>
<div class="ttc" id="agroup__component_html_acda4c8b63ffbc2e9e2e28f056edbf01c"><div class="ttname"><a href="group__component.html#acda4c8b63ffbc2e9e2e28f056edbf01c">ftxui::ComponentBase::ComponentBase</a></div><div class="ttdeci">ComponentBase()=default</div></div>
<div class="ttc" id="agroup__component_html_aceb41a98abe10fb0b521ff8b65529b7f"><div class="ttname"><a href="group__component.html#aceb41a98abe10fb0b521ff8b65529b7f">ftxui::ComponentBase::ChildAt</a></div><div class="ttdeci">Component &amp; ChildAt(size_t i)</div><div class="ttdoc">Access the child at index i.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00043">component.cpp:43</a></div></div>
<div class="ttc" id="agroup__component_html_ad2a5b6ce11bc7a8ce1150cf0ba9144c0"><div class="ttname"><a href="group__component.html#ad2a5b6ce11bc7a8ce1150cf0ba9144c0">ftxui::ComponentBase::ComponentBase</a></div><div class="ttdeci">ComponentBase(Components children)</div><div class="ttdef"><b>Definition</b> <a href="#l00032">component_base.hpp:32</a></div></div>
<div class="ttc" id="agroup__component_html_ae490d465a018a9d81bb4e30604708fba"><div class="ttname"><a href="group__component.html#ae490d465a018a9d81bb4e30604708fba">ftxui::ComponentBase::~ComponentBase</a></div><div class="ttdeci">virtual ~ComponentBase()</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00031">component.cpp:31</a></div></div>
<div class="ttc" id="agroup__component_html_aebad858485d02f035a8ea34af66a7fa7"><div class="ttname"><a href="group__component.html#aebad858485d02f035a8ea34af66a7fa7">ftxui::ComponentBase::OnAnimation</a></div><div class="ttdeci">virtual void OnAnimation(animation::Params &amp;params)</div><div class="ttdoc">Called in response to an animation event.</div><div class="ttdef"><b>Definition</b> <a href="component_8cpp_source.html#l00163">component.cpp:163</a></div></div>
<div class="ttc" id="agroup__component_html_classftxui_1_1ComponentBase"><div class="ttname"><a href="group__component.html#classftxui_1_1ComponentBase">ftxui::ComponentBase</a></div><div class="ttdoc">It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ft...</div><div class="ttdef"><b>Definition</b> <a href="#l00030">component_base.hpp:30</a></div></div>
<div class="ttc" id="agroup__component_html_structftxui_1_1Event"><div class="ttname"><a href="group__component.html#structftxui_1_1Event">ftxui::Event</a></div><div class="ttdoc">Represent an event. It can be key press event, a terminal resize, or more ...</div><div class="ttdef"><b>Definition</b> <a href="event_8hpp_source.html#l00029">event.hpp:29</a></div></div>
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdoc">The FTXUI ftxui:: namespace.</div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a24b663cb6b0b262055c94d3a03bdd274"><div class="ttname"><a href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">ftxui::CapturedMouse</a></div><div class="ttdeci">std::unique_ptr&lt; CapturedMouseInterface &gt; CapturedMouse</div><div class="ttdef"><b>Definition</b> <a href="captured__mouse_8hpp_source.html#l00020">captured_mouse.hpp:20</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a2bc31f2d685189e5c61d2293a1f51b4f"><div class="ttname"><a href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></div><div class="ttdeci">std::shared_ptr&lt; Node &gt; Element</div><div class="ttdef"><b>Definition</b> <a href="elements_8hpp_source.html#l00022">elements.hpp:22</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a3d4ccad0c8a07d5b0cb4b2e690ffc90c"><div class="ttname"><a href="namespaceftxui.html#a3d4ccad0c8a07d5b0cb4b2e690ffc90c">ftxui::Components</a></div><div class="ttdeci">std::vector&lt; Component &gt; Components</div><div class="ttdef"><b>Definition</b> <a href="#l00025">component_base.hpp:25</a></div></div>
<div class="ttc" id="anamespaceftxui_html_af1479ede01dbf087342534ab4ada11d3"><div class="ttname"><a href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">ftxui::Component</a></div><div class="ttdeci">std::shared_ptr&lt; ComponentBase &gt; Component</div><div class="ttdef"><b>Definition</b> <a href="#l00024">component_base.hpp:24</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.8-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7f0d124f4cd00c9c7b5b93f60cb4ae34.html">ftxui</a></li><li class="navelem"><a class="el" href="dir_b7c1fcae8d0ae1df453f463e8938778b.html">component</a></li><li class="navelem"><a class="el" href="component__base_8hpp.html">component_base.hpp</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>
Reference in New Issue Copy Permalink