FTXUI/component_8cpp_source.html
2025-06-20 14:18:44 +00:00

526 lines
67 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: component.cpp 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_8cpp_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.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="component_8cpp.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">#include &lt;algorithm&gt;</span> <span class="comment">// for find_if</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;cassert&gt;</span> <span class="comment">// for assert</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;cstddef&gt;</span> <span class="comment">// for size_t</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;iterator&gt;</span> <span class="comment">// for begin, end</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;memory&gt;</span> <span class="comment">// for unique_ptr, make_unique</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;utility&gt;</span> <span class="comment">// for move</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;vector&gt;</span> <span class="comment">// for vector, __alloc_traits&lt;&gt;::value_type</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</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 CapturedMouse, CapturedMouseInterface</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;<a class="code" href="component_8hpp.html">ftxui/component/component.hpp</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;<a class="code" href="component__base_8hpp.html">ftxui/component/component_base.hpp</a>&quot;</span> <span class="comment">// for ComponentBase, Components</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="event_8hpp.html">ftxui/component/event.hpp</a>&quot;</span> <span class="comment">// for Event</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &quot;<a class="code" href="screen__interactive_8hpp.html">ftxui/component/screen_interactive.hpp</a>&quot;</span> <span class="comment">// for Component, ScreenInteractive</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &quot;<a class="code" href="elements_8hpp.html">ftxui/dom/elements.hpp</a>&quot;</span> <span class="comment">// for text, Element</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &quot;<a class="code" href="node_8hpp.html">ftxui/dom/node.hpp</a>&quot;</span> <span class="comment">// for Node, Elements</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &quot;<a class="code" href="box_8hpp.html">ftxui/screen/box.hpp</a>&quot;</span> <span class="comment">// for Box</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui_1_1animation.html">ftxui::animation</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">class </span>Params;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>} <span class="comment">// namespace ftxui::animation</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">class </span>CaptureMouseImpl : <span class="keyword">public</span> CapturedMouseInterface {};</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>} <span class="comment">// namespace</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="foldopen" id="foldopen00031" data-start="{" data-end="}">
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="group__component.html#ae490d465a018a9d81bb4e30604708fba"> 31</a></span><a class="code hl_function" href="group__component.html#ae490d465a018a9d81bb4e30604708fba">ComponentBase::~ComponentBase</a>() {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_function" href="group__component.html#a84bd6480cf5e8f51cf5965f81b1f2460">DetachAllChildren</a>();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>}</div>
</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"></span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">/// @brief Return the parent ComponentBase, or nul if any.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">/// @see Detach</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">/// @see Parent</span></div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group__component.html#aaf284a408631f31558694973a04186c2"> 38</a></span><span class="comment"></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">ComponentBase::Parent</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">return</span> parent_;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>}</div>
</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"></span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">/// @brief Access the child at index `i`.</span></div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="group__component.html#aceb41a98abe10fb0b521ff8b65529b7f"> 43</a></span><span class="comment"></span><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; <a class="code hl_function" href="group__component.html#aceb41a98abe10fb0b521ff8b65529b7f">ComponentBase::ChildAt</a>(<span class="keywordtype">size_t</span> i) {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> assert(i &lt; <a class="code hl_function" href="group__component.html#a9ae5f77e923e2f0f8b0e26dcd4affb5b">ChildCount</a>()); <span class="comment">// NOLINT</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>[i];</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>}</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"></span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">/// @brief Returns the number of children.</span></div>
<div class="foldopen" id="foldopen00049" data-start="{" data-end="}">
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="group__component.html#a9ae5f77e923e2f0f8b0e26dcd4affb5b"> 49</a></span><span class="comment"></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="group__component.html#a9ae5f77e923e2f0f8b0e26dcd4affb5b">ComponentBase::ChildCount</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>.size();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>}</div>
</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"></span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">/// @brief Return index of the component in its parent. -1 if no parent.</span></div>
<div class="foldopen" id="foldopen00054" data-start="{" data-end="}">
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="group__component.html#a8ef12397d1682615bc3108c397734179"> 54</a></span><span class="comment"></span><span class="keywordtype">int</span> <a class="code hl_function" href="group__component.html#a8ef12397d1682615bc3108c397734179">ComponentBase::Index</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">if</span> (parent_ == <span class="keyword">nullptr</span>) {</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> -1;</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="keywordtype">int</span> index = 0;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; child : parent_-&gt;<a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>) {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">if</span> (child.get() == <span class="keyword">this</span>) {</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> index;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> index++;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> }</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> -1; <span class="comment">// Not reached.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>}</div>
</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"></span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment">/// @brief Add a child.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">/// @@param child The child to be attached.</span></div>
<div class="foldopen" id="foldopen00070" data-start="{" data-end="}">
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="group__component.html#a21f040bec9104e164bfa6c3ad45be3a1"> 70</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a21f040bec9104e164bfa6c3ad45be3a1">ComponentBase::Add</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child) {</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> child-&gt;Detach();</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> child-&gt;parent_ = <span class="keyword">this</span>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>.push_back(std::move(child));</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>}</div>
</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"></span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">/// @brief Detach this child from its parent.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment">/// @see Detach</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">/// @see Parent</span></div>
<div class="foldopen" id="foldopen00079" data-start="{" data-end="}">
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="group__component.html#abb7a2b60240651d16e17d02eb6f636cf"> 79</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#abb7a2b60240651d16e17d02eb6f636cf">ComponentBase::Detach</a>() {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordflow">if</span> (parent_ == <span class="keyword">nullptr</span>) {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> }</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">auto</span> it = std::find_if(std::begin(parent_-&gt;<a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>), <span class="comment">//</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> std::end(parent_-&gt;<a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>), <span class="comment">//</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> [<span class="keyword">this</span>](<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; that) { <span class="comment">//</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> return this == that.get();</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> });</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* parent = parent_;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> parent_ = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> parent-&gt;<a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>.erase(it); <span class="comment">// Might delete |this|.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>}</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"></span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment">/// @brief Remove all children.</span></div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="}">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="group__component.html#a84bd6480cf5e8f51cf5965f81b1f2460"> 94</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a84bd6480cf5e8f51cf5965f81b1f2460">ComponentBase::DetachAllChildren</a>() {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordflow">while</span> (!<a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>.empty()) {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>[0]-&gt;Detach();</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>}</div>
</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"></span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment">/// @brief Draw the component.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment">/// Build a ftxui::Element to be drawn on the ftxui::Screen representing this</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment">/// ftxui::ComponentBase. Please override OnRender() to modify the rendering.</span></div>
<div class="foldopen" id="foldopen00103" data-start="{" data-end="}">
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="group__component.html#a28d41d6113c5b29c8dd45846582b3299"> 103</a></span><span class="comment"></span><a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="code hl_function" href="group__component.html#a28d41d6113c5b29c8dd45846582b3299">ComponentBase::Render</a>() {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// Some users might call `ComponentBase::Render()` from</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// `T::OnRender()`. To avoid infinite recursion, we use a flag.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keywordflow">if</span> (in_render) {</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keywordflow">return</span> <a class="code hl_function" href="group__component.html#ab79303652dad19eac0540848487cf8c5">ComponentBase::OnRender</a>();</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> }</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> in_render = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> element = <a class="code hl_function" href="group__component.html#ab79303652dad19eac0540848487cf8c5">OnRender</a>();</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> in_render = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">class </span>Wrapper : <span class="keyword">public</span> <a class="code hl_class" href="group__dom.html#classftxui_1_1Node">Node</a> {</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">bool</span> active_ = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> Wrapper(<a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child, <span class="keywordtype">bool</span> active)</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> : <a class="code hl_class" href="group__dom.html#classftxui_1_1Node">Node</a>({std::move(child)}), active_(active) {}</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordtype">void</span> SetBox(<a class="code hl_struct" href="group__screen.html#structftxui_1_1Box">Box</a> box)<span class="keyword"> override </span>{</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> Node::SetBox(box);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> children_[0]-&gt;SetBox(box);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> }</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keywordtype">void</span> ComputeRequirement()<span class="keyword"> override </span>{</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> Node::ComputeRequirement();</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> requirement_.focused.component_active = active_;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> }</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> };</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordflow">return</span> std::make_shared&lt;Wrapper&gt;(std::move(element), <a class="code hl_function" href="group__component.html#a52beef6d7a687d4d109e6cec1606e32e">Active</a>());</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>}</div>
</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="comment"></span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="comment">/// @brief Draw the component.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><span class="comment">/// Build a ftxui::Element to be drawn on the ftxi::Screen representing this</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment">/// ftxui::ComponentBase. This function is means to be overridden.</span></div>
<div class="foldopen" id="foldopen00138" data-start="{" data-end="}">
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="group__component.html#ab79303652dad19eac0540848487cf8c5"> 138</a></span><span class="comment"></span><a class="code hl_typedef" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> <a class="code hl_function" href="group__component.html#ab79303652dad19eac0540848487cf8c5">ComponentBase::OnRender</a>() {</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>.size() == 1) {</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>.front()-&gt;Render();</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> }</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keywordflow">return</span> <a class="code hl_function" href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">text</a>(<span class="stringliteral">&quot;Not implemented component&quot;</span>);</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span>}</div>
</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="comment"></span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="comment">/// @brief Called in response to an event.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="comment">/// @param event The event.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="comment">/// @return True when the event has been handled.</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="comment">/// The default implementation called OnEvent on every child until one return</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="comment">/// true. If none returns true, return false.</span></div>
<div class="foldopen" id="foldopen00151" data-start="{" data-end="}">
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="group__component.html#ab84629a8fecad2e1cdd426b7ddc72277"> 151</a></span><span class="comment"></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#ab84629a8fecad2e1cdd426b7ddc72277">ComponentBase::OnEvent</a>(<a class="code hl_struct" href="group__component.html#structftxui_1_1Event">Event</a> event) { <span class="comment">// NOLINT</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <span class="keywordflow">for</span> (<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; child : <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>) { <span class="comment">// NOLINT</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keywordflow">if</span> (child-&gt;OnEvent(event)) {</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> }</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> }</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span>}</div>
</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="comment"></span> </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="comment">/// @brief Called in response to an animation event.</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span><span class="comment">/// @param params the parameters of the animation</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="comment">/// The default implementation dispatch the event to every child.</span></div>
<div class="foldopen" id="foldopen00163" data-start="{" data-end="}">
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="group__component.html#aebad858485d02f035a8ea34af66a7fa7"> 163</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#aebad858485d02f035a8ea34af66a7fa7">ComponentBase::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="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; child : <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>) {</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> child-&gt;OnAnimation(params);</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> }</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span>}</div>
</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span><span class="comment"></span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span><span class="comment">/// @brief Return the currently Active child.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span><span class="comment">/// @return the currently Active child.</span></div>
<div class="foldopen" id="foldopen00171" data-start="{" data-end="}">
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="group__component.html#a5c421f00a2a7f50c542c5c286d2e696c"> 171</a></span><span class="comment"></span><a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> <a class="code hl_function" href="group__component.html#a5c421f00a2a7f50c542c5c286d2e696c">ComponentBase::ActiveChild</a>() {</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; child : <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>) {</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="keywordflow">if</span> (child-&gt;Focusable()) {</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordflow">return</span> child;</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> }</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> }</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span>}</div>
</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span><span class="comment"></span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span><span class="comment">/// @brief Return true when the component contains focusable elements.</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span><span class="comment">/// The non focusable Components will be skipped when navigating using the</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span><span class="comment">/// keyboard.</span></div>
<div class="foldopen" id="foldopen00183" data-start="{" data-end="}">
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"><a class="line" href="group__component.html#a02ccd3db74312f1c66aa8e7931489318"> 183</a></span><span class="comment"></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#a02ccd3db74312f1c66aa8e7931489318">ComponentBase::Focusable</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>&amp; child : <a class="code hl_variable" href="group__component.html#a22b4fa4d6aa4c9c2eef275cd25aa8ab9">children_</a>) { <span class="comment">// NOLINT</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <span class="keywordflow">if</span> (child-&gt;Focusable()) {</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> }</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> }</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span>}</div>
</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span><span class="comment"></span> </div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span><span class="comment">/// @brief Returns if the element if the currently active child of its parent.</span></div>
<div class="foldopen" id="foldopen00193" data-start="{" data-end="}">
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="group__component.html#a52beef6d7a687d4d109e6cec1606e32e"> 193</a></span><span class="comment"></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#a52beef6d7a687d4d109e6cec1606e32e">ComponentBase::Active</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keywordflow">return</span> parent_ == <span class="keyword">nullptr</span> || parent_-&gt;<a class="code hl_function" href="group__component.html#a5c421f00a2a7f50c542c5c286d2e696c">ActiveChild</a>().get() == <span class="keyword">this</span>;</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span>}</div>
</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span><span class="comment"></span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span><span class="comment">/// @brief Returns if the elements if focused by the user.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span><span class="comment">/// True when the ComponentBase is focused by the user. An element is Focused</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span><span class="comment">/// when it is with all its ancestors the ActiveChild() of their parents, and it</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span><span class="comment">/// Focusable().</span></div>
<div class="foldopen" id="foldopen00201" data-start="{" data-end="}">
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="group__component.html#a0cc612fa3d753b456e0f480f44654a9f"> 201</a></span><span class="comment"></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__component.html#a0cc612fa3d753b456e0f480f44654a9f">ComponentBase::Focused</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> <span class="keyword">const</span> <span class="keyword">auto</span>* current = <span class="keyword">this</span>;</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> <span class="keywordflow">while</span> (current &amp;&amp; current-&gt;Active()) {</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> current = current-&gt;parent_;</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> }</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <span class="keywordflow">return</span> !current &amp;&amp; <a class="code hl_function" href="group__component.html#a02ccd3db74312f1c66aa8e7931489318">Focusable</a>();</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span>}</div>
</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span><span class="comment"></span> </div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span><span class="comment">/// @brief Make the |child| to be the &quot;active&quot; one.</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span><span class="comment">/// @param child the child to become active.</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"><a class="line" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de"> 211</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">ComponentBase::SetActiveChild</a>([[maybe_unused]] <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* child) {}</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span><span class="comment"></span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span><span class="comment">/// @brief Make the |child| to be the &quot;active&quot; one.</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span><span class="comment">/// @param child the child to become active.</span></div>
<div class="foldopen" id="foldopen00215" data-start="{" data-end="}">
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"><a class="line" href="group__component.html#a50ad32ad14dd7912e681fab0ee294be2"> 215</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">ComponentBase::SetActiveChild</a>(<a class="code hl_typedef" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a> child) { <span class="comment">// NOLINT</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> <a class="code hl_function" href="group__component.html#a8cbf27680c6154e15c8b32d6601340de">SetActiveChild</a>(child.get());</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span>}</div>
</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span><span class="comment"></span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span><span class="comment">/// @brief Configure all the ancestors to give focus to this component.</span></div>
<div class="foldopen" id="foldopen00220" data-start="{" data-end="}">
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"><a class="line" href="group__component.html#a2cf27e9d7128a6a4b3263ecd34c19105"> 220</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__component.html#a2cf27e9d7128a6a4b3263ecd34c19105">ComponentBase::TakeFocus</a>() {</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* child = <span class="keyword">this</span>;</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> <span class="keywordflow">while</span> (<a class="code hl_class" href="group__component.html#classftxui_1_1ComponentBase">ComponentBase</a>* parent = child-&gt;parent_) {</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> parent-&gt;SetActiveChild(child);</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> child = parent;</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> }</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span>}</div>
</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span><span class="comment"></span> </div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span><span class="comment">/// @brief Take the CapturedMouse if available. There is only one component of</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span><span class="comment">/// them. It represents a component taking priority over others.</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span><span class="comment">/// @param event The event</span></div>
<div class="foldopen" id="foldopen00231" data-start="{" data-end="}">
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"><a class="line" href="group__component.html#a164d10a2cf367bdd4ae14318a6c7d769"> 231</a></span><span class="comment"></span><a class="code hl_typedef" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> <a class="code hl_function" href="group__component.html#a164d10a2cf367bdd4ae14318a6c7d769">ComponentBase::CaptureMouse</a>(<span class="keyword">const</span> <a class="code hl_struct" href="group__component.html#structftxui_1_1Event">Event</a>&amp; event) { <span class="comment">// NOLINT</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> <span class="keywordflow">if</span> (event.<a class="code hl_variable" href="group__component.html#a57ae65156ecf0f469cc559a49e6c4f2f">screen_</a>) {</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> <span class="keywordflow">return</span> <span class="keyword">event</span>.screen_-&gt;CaptureMouse();</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> }</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> <span class="keywordflow">return</span> std::make_unique&lt;CaptureMouseImpl&gt;();</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span>}</div>
</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> </div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span>} <span class="comment">// namespace ftxui</span></div>
<div class="ttc" id="abox_8hpp_html"><div class="ttname"><a href="box_8hpp.html">box.hpp</a></div></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="acomponent_8hpp_html"><div class="ttname"><a href="component_8hpp.html">component.hpp</a></div></div>
<div class="ttc" id="acomponent__base_8hpp_html"><div class="ttname"><a href="component__base_8hpp.html">component_base.hpp</a></div></div>
<div class="ttc" id="aelements_8hpp_html"><div class="ttname"><a href="elements_8hpp.html">elements.hpp</a></div></div>
<div class="ttc" id="aevent_8hpp_html"><div class="ttname"><a href="event_8hpp.html">event.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="#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="#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="#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="#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="component__base_8hpp_source.html#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="#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="#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="#l00193">component.cpp:193</a></div></div>
<div class="ttc" id="agroup__component_html_a57ae65156ecf0f469cc559a49e6c4f2f"><div class="ttname"><a href="group__component.html#a57ae65156ecf0f469cc559a49e6c4f2f">ftxui::Event::screen_</a></div><div class="ttdeci">ScreenInteractive * screen_</div><div class="ttdef"><b>Definition</b> <a href="event_8hpp_source.html#l00124">event.hpp:124</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="#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="#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="#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="#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="#l00049">component.cpp:49</a></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="#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="#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="#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="#l00079">component.cpp:79</a></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="#l00043">component.cpp:43</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="#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="#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="component__base_8hpp_source.html#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="agroup__dom_html_classftxui_1_1Node"><div class="ttname"><a href="group__dom.html#classftxui_1_1Node">ftxui::Node</a></div><div class="ttdoc">Node is the base class for all elements in the DOM tree.</div><div class="ttdef"><b>Definition</b> <a href="node_8hpp_source.html#l00037">node.hpp:37</a></div></div>
<div class="ttc" id="agroup__dom_html_ga75baaa2734ed76a9f478beaafa87ae57"><div class="ttname"><a href="group__dom.html#ga75baaa2734ed76a9f478beaafa87ae57">ftxui::text</a></div><div class="ttdeci">Element text(std::wstring text)</div><div class="ttdoc">Display a piece of unicode text.</div><div class="ttdef"><b>Definition</b> <a href="text_8cpp_source.html#l00160">text.cpp:160</a></div></div>
<div class="ttc" id="agroup__screen_html_structftxui_1_1Box"><div class="ttname"><a href="group__screen.html#structftxui_1_1Box">ftxui::Box</a></div><div class="ttdoc">Box is a structure that represents a rectangular area in a 2D space.</div><div class="ttdef"><b>Definition</b> <a href="box_8hpp_source.html#l00016">box.hpp:16</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1animation_html"><div class="ttname"><a href="namespaceftxui_1_1animation.html">ftxui::animation</a></div><div class="ttdoc">The FTXUI ftxui::animation:: 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"><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_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="component__base_8hpp_source.html#l00024">component_base.hpp:24</a></div></div>
<div class="ttc" id="anode_8hpp_html"><div class="ttname"><a href="node_8hpp.html">node.hpp</a></div></div>
<div class="ttc" id="ascreen__interactive_8hpp_html"><div class="ttname"><a href="screen__interactive_8hpp.html">screen_interactive.hpp</a></div></div>
</div><!-- fragment --></div><!-- 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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aca3139ef08e710186b498ba0b7d3b1a.html">ftxui</a></li><li class="navelem"><a class="el" href="dir_591e152ed8a369b957ed274cdb7355d5.html">component</a></li><li class="navelem"><a class="el" href="component_8cpp.html">component.cpp</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>