zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-12-16 01:48:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
02764cd443be15005858fb10df020f4f1f770d66
FTXUI/en/v5.0.0/screen_8hpp_source.html
ArthurSonzogni 02764cd443 deploy: 9f4b2bcf96
2025-12-13 19:38:34 +00:00

422 lines
59 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="cache-control" content="max-age=86400"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FTXUI: include/ftxui/screen/screen.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FTXUI
&#160;<span id="projectnumber">5.0.0</span>
</div>
<div id="projectbrief">C++ functional terminal UI.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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('screen_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">screen.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="screen_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_SCREEN_SCREEN_HPP</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define FTXUI_SCREEN_SCREEN_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;cstdint&gt;</span> <span class="comment">// for uint8_t</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;string&gt;</span> <span class="comment">// for string, basic_string, allocator</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</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="box_8hpp.html">ftxui/screen/box.hpp</a>&quot;</span> <span class="comment">// for Box</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="color_8hpp.html">ftxui/screen/color.hpp</a>&quot;</span> <span class="comment">// for Color, Color::Default</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="terminal_8hpp.html">ftxui/screen/terminal.hpp</a>&quot;</span> <span class="comment">// for Dimensions</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/// @brief A unicode character and its associated style.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/// @ingroup screen</span></div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html"> 20</a></span><span class="comment"></span><span class="keyword">struct </span><a class="code hl_struct" href="structftxui_1_1Pixel.html">Pixel</a> {</div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a3d22dc2630f1c1c69ec973cd4648b5d5"> 21</a></span> <a class="code hl_function" href="structftxui_1_1Pixel.html#a3d22dc2630f1c1c69ec973cd4648b5d5">Pixel</a>()</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> : <a class="code hl_variable" href="structftxui_1_1Pixel.html#a399ff0c757d88aeaa2439212f073f380">blink</a>(false),</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a7a210a24d67146bd143c013d1da0f2dd">bold</a>(false),</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a3cecb006e0ca185024cd89f9ea2ea69a">dim</a>(false),</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a19bbb3c355941d56eccf70be7f7ed9e1">inverted</a>(false),</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a7c8849e8321ea248cd4991ea8ef198eb">underlined</a>(false),</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#afe0ea73f380e746092213b879003afd6">underlined_double</a>(false),</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a21fbeba389ccf8f76447c7a73ead8db2">strikethrough</a>(false),</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#ada8b6dbd466ba5b6c4b240f229bd627f">automerge</a>(false) {}</div>
</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// A bit field representing the style:</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a399ff0c757d88aeaa2439212f073f380"> 32</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a399ff0c757d88aeaa2439212f073f380">blink</a> : 1;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a7a210a24d67146bd143c013d1da0f2dd"> 33</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a7a210a24d67146bd143c013d1da0f2dd">bold</a> : 1;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a3cecb006e0ca185024cd89f9ea2ea69a"> 34</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a3cecb006e0ca185024cd89f9ea2ea69a">dim</a> : 1;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a19bbb3c355941d56eccf70be7f7ed9e1"> 35</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a19bbb3c355941d56eccf70be7f7ed9e1">inverted</a> : 1;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a7c8849e8321ea248cd4991ea8ef198eb"> 36</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a7c8849e8321ea248cd4991ea8ef198eb">underlined</a> : 1;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#afe0ea73f380e746092213b879003afd6"> 37</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#afe0ea73f380e746092213b879003afd6">underlined_double</a> : 1;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a21fbeba389ccf8f76447c7a73ead8db2"> 38</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a21fbeba389ccf8f76447c7a73ead8db2">strikethrough</a> : 1;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#ada8b6dbd466ba5b6c4b240f229bd627f"> 39</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structftxui_1_1Pixel.html#ada8b6dbd466ba5b6c4b240f229bd627f">automerge</a> : 1;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// The hyperlink associated with the pixel.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// 0 is the default value, meaning no hyperlink.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a071ab11cf7706c7800281716177c88e3"> 43</a></span> uint8_t <a class="code hl_variable" href="structftxui_1_1Pixel.html#a071ab11cf7706c7800281716177c88e3">hyperlink</a> = 0;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// The graphemes stored into the pixel. To support combining characters,</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// like: a⃦, this can potentially contain multiple codepoints.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a3bbcd6a381555ea201dbe4251a9aafb3"> 47</a></span> std::string <a class="code hl_variable" href="structftxui_1_1Pixel.html#a3bbcd6a381555ea201dbe4251a9aafb3">character</a> = <span class="stringliteral">&quot; &quot;</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// Colors:</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a3af4612678da78558adccf47e17164bb"> 50</a></span> <a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a3af4612678da78558adccf47e17164bb">background_color</a> = <a class="code hl_enumvalue" href="classftxui_1_1Color.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">Color::Default</a>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structftxui_1_1Pixel.html#a2ce82adc1d02baf22df658b903dcb351"> 51</a></span> <a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_variable" href="structftxui_1_1Pixel.html#a2ce82adc1d02baf22df658b903dcb351">foreground_color</a> = <a class="code hl_enumvalue" href="classftxui_1_1Color.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">Color::Default</a>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>};</div>
</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"></span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">/// @brief Define how the Screen&#39;s dimensions should look like.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">/// @ingroup screen</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"></span><span class="keyword">namespace </span>Dimension {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937"> 57</a></span><a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">Fixed</a>(<span class="keywordtype">int</span>);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa"> 58</a></span><a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">Full</a>();</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace Dimension</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">/// @brief A rectangular grid of Pixel.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/// @ingroup screen</span></div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="};">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html"> 63</a></span><span class="comment"></span><span class="keyword">class </span><a class="code hl_class" href="classftxui_1_1Screen.html">Screen</a> {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Constructors:</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_function" href="classftxui_1_1Screen.html#a7ecf7c5fb3d90a1620098a60cfafc215">Screen</a>(<span class="keywordtype">int</span> <a class="code hl_function" href="classftxui_1_1Screen.html#ae7a460c9dacd70ed81b1adfea46b492e">dimx</a>, <span class="keywordtype">int</span> <a class="code hl_function" href="classftxui_1_1Screen.html#a0d283cfb1ec16b3fc13d344ebfea93d4">dimy</a>);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">static</span> <a class="code hl_class" href="classftxui_1_1Screen.html">Screen</a> <a class="code hl_function" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">Create</a>(<a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> dimension);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">static</span> <a class="code hl_class" href="classftxui_1_1Screen.html">Screen</a> <a class="code hl_function" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">Create</a>(<a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> width, <a class="code hl_struct" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> height);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// Access a character in the grid at a given position.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> std::string&amp; <a class="code hl_function" href="classftxui_1_1Screen.html#a55b0a995463c6936efb33391f29565bc">at</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classftxui_1_1Screen.html#a55b0a995463c6936efb33391f29565bc">at</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// Access a cell (Pixel) in the grid at a given position.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_struct" href="structftxui_1_1Pixel.html">Pixel</a>&amp; <a class="code hl_function" href="classftxui_1_1Screen.html#a483f8ee1967e200cfc9e277b3ce00174">PixelAt</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">const</span> <a class="code hl_struct" href="structftxui_1_1Pixel.html">Pixel</a>&amp; <a class="code hl_function" href="classftxui_1_1Screen.html#a483f8ee1967e200cfc9e277b3ce00174">PixelAt</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> std::string <a class="code hl_function" href="classftxui_1_1Screen.html#a19c380b03cea21d7ac7325136a131ff0">ToString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// Print the Screen on to the terminal.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classftxui_1_1Screen.html#ad93edbe885499a712129356f1ffd506b">Print</a>() <span class="keyword">const</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="comment">// Get screen dimensions.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#ae7a460c9dacd70ed81b1adfea46b492e"> 84</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classftxui_1_1Screen.html#ae7a460c9dacd70ed81b1adfea46b492e">dimx</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classftxui_1_1Screen.html#a1b254c3faacd432c325efff4268ca683">dimx_</a>; }</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#a0d283cfb1ec16b3fc13d344ebfea93d4"> 85</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classftxui_1_1Screen.html#a0d283cfb1ec16b3fc13d344ebfea93d4">dimy</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classftxui_1_1Screen.html#a9e9d5df4b41aaa5eca27cdcaca6d4574">dimy_</a>; }</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// Move the terminal cursor n-lines up with n = dimy().</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> std::string <a class="code hl_function" href="classftxui_1_1Screen.html#a9677c078c4270afdb7451cdc0b0871d4">ResetPosition</a>(<span class="keywordtype">bool</span> clear = <span class="keyword">false</span>) <span class="keyword">const</span>;</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">// Fill the screen with space.</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="classftxui_1_1Screen.html#aa71d36872f416feaa853788a7a7a7ef8">Clear</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="keywordtype">void</span> <a class="code hl_function" href="classftxui_1_1Screen.html#a04d18c0cb0df3ed7a01ca5c3b8711ff7">ApplyShader</a>();</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="foldopen" id="foldopen00095" data-start="{" data-end="};">
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html"> 95</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a6150e0515f7202e2fb518f7206ed97dc"> 96</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structftxui_1_1Screen_1_1Cursor.html#a6150e0515f7202e2fb518f7206ed97dc">x</a> = 0;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a0a2f84ed7838f07779ae24c5a9086d33"> 97</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structftxui_1_1Screen_1_1Cursor.html#a0a2f84ed7838f07779ae24c5a9086d33">y</a> = 0;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="foldopen" id="foldopen00099" data-start="{" data-end="};">
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37c"> 99</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37c">Shape</a> {</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cacf46e529658ebc6532c204f3246929f4"> 100</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cacf46e529658ebc6532c204f3246929f4">Hidden</a> = 0,</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca2f4a0b3cacb4468d8467dc0746ea23aa"> 101</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca2f4a0b3cacb4468d8467dc0746ea23aa">BlockBlinking</a> = 1,</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa00f801460e81f86eab56d86fe627551"> 102</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa00f801460e81f86eab56d86fe627551">Block</a> = 2,</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cad7df11ee39d53d4ee2da1b22b2238abc"> 103</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cad7df11ee39d53d4ee2da1b22b2238abc">UnderlineBlinking</a> = 3,</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa909c5f2b588ba35fcc40b3b504ad2ed"> 104</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa909c5f2b588ba35fcc40b3b504ad2ed">Underline</a> = 4,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cae7dfc08d4e90b88e0cb1cea7a54796c1"> 105</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cae7dfc08d4e90b88e0cb1cea7a54796c1">BarBlinking</a> = 5,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca6424dbda22da2f105580d1c8095600d3"> 106</a></span> <a class="code hl_enumvalue" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca6424dbda22da2f105580d1c8095600d3">Bar</a> = 6,</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> };</div>
</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="structftxui_1_1Screen_1_1Cursor.html#a8b9f7758a8bd2bef680aeecc40bcfe04"> 108</a></span> <a class="code hl_enumeration" href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37c">Shape</a> <a class="code hl_variable" href="structftxui_1_1Screen_1_1Cursor.html#a8b9f7758a8bd2bef680aeecc40bcfe04">shape</a>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> };</div>
</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612"> 110</a></span> <a class="code hl_struct" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> <a class="code hl_function" href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612">cursor</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="classftxui_1_1Screen.html#a9df9d1ae7ed66857ca987963b2365904">cursor_</a>; }</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#a1aa24862a3d050b3aea2ade1300d51a7"> 111</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classftxui_1_1Screen.html#a1aa24862a3d050b3aea2ade1300d51a7">SetCursor</a>(<a class="code hl_struct" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> <a class="code hl_function" href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612">cursor</a>) { <a class="code hl_variable" href="classftxui_1_1Screen.html#a9df9d1ae7ed66857ca987963b2365904">cursor_</a> = <a class="code hl_function" href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612">cursor</a>; }</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// Store an hyperlink in the screen. Return the id of the hyperlink. The id is</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="comment">// used to identify the hyperlink when the user click on it.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> uint8_t <a class="code hl_function" href="classftxui_1_1Screen.html#a937f1d3d98e2c4152fae2ffb8d31e4a9">RegisterHyperlink</a>(<span class="keyword">const</span> std::string&amp; link);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classftxui_1_1Screen.html#a0b55b16969dfccc79195fe61c5ba6d1a">Hyperlink</a>(uint8_t <span class="keywordtype">id</span>) <span class="keyword">const</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"><a class="line" href="classftxui_1_1Screen.html#a92cacd07ba30909855f19edc01192ff0"> 118</a></span> <a class="code hl_struct" href="structftxui_1_1Box.html">Box</a> <a class="code hl_variable" href="classftxui_1_1Screen.html#a92cacd07ba30909855f19edc01192ff0">stencil</a>;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#a1b254c3faacd432c325efff4268ca683"> 121</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classftxui_1_1Screen.html#a1b254c3faacd432c325efff4268ca683">dimx_</a>;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#a9e9d5df4b41aaa5eca27cdcaca6d4574"> 122</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classftxui_1_1Screen.html#a9e9d5df4b41aaa5eca27cdcaca6d4574">dimy_</a>;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#aeab8c1788b3f2c7403749c3be95a68ae"> 123</a></span> std::vector&lt;std::vector&lt;Pixel&gt;&gt; <a class="code hl_variable" href="classftxui_1_1Screen.html#aeab8c1788b3f2c7403749c3be95a68ae">pixels_</a>;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#a9df9d1ae7ed66857ca987963b2365904"> 124</a></span> <a class="code hl_struct" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> <a class="code hl_variable" href="classftxui_1_1Screen.html#a9df9d1ae7ed66857ca987963b2365904">cursor_</a>;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classftxui_1_1Screen.html#acff83d382ef60ad2a0fca3ba68e9397f"> 125</a></span> std::vector&lt;std::string&gt; <a class="code hl_variable" href="classftxui_1_1Screen.html#acff83d382ef60ad2a0fca3ba68e9397f">hyperlinks_</a> = {<span class="stringliteral">&quot;&quot;</span>};</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>};</div>
</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>} <span class="comment">// namespace ftxui</span></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><span class="preprocessor">#endif </span><span class="comment">// FTXUI_SCREEN_SCREEN_HPP</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="aclassftxui_1_1Color_html"><div class="ttname"><a href="classftxui_1_1Color.html">ftxui::Color</a></div><div class="ttdoc">A class representing terminal colors.</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00021">color.hpp:21</a></div></div>
<div class="ttc" id="aclassftxui_1_1Color_html_aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051"><div class="ttname"><a href="classftxui_1_1Color.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">ftxui::Color::Default</a></div><div class="ttdeci">@ Default</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00041">color.hpp:41</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html"><div class="ttname"><a href="classftxui_1_1Screen.html">ftxui::Screen</a></div><div class="ttdoc">A rectangular grid of Pixel.</div><div class="ttdef"><b>Definition</b> <a href="#l00063">screen.hpp:63</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a04d18c0cb0df3ed7a01ca5c3b8711ff7"><div class="ttname"><a href="classftxui_1_1Screen.html#a04d18c0cb0df3ed7a01ca5c3b8711ff7">ftxui::Screen::ApplyShader</a></div><div class="ttdeci">void ApplyShader()</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00534">screen.cpp:534</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a0b55b16969dfccc79195fe61c5ba6d1a"><div class="ttname"><a href="classftxui_1_1Screen.html#a0b55b16969dfccc79195fe61c5ba6d1a">ftxui::Screen::Hyperlink</a></div><div class="ttdeci">const std::string &amp; Hyperlink(uint8_t id) const</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00574">screen.cpp:574</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a0d283cfb1ec16b3fc13d344ebfea93d4"><div class="ttname"><a href="classftxui_1_1Screen.html#a0d283cfb1ec16b3fc13d344ebfea93d4">ftxui::Screen::dimy</a></div><div class="ttdeci">int dimy() const</div><div class="ttdef"><b>Definition</b> <a href="#l00085">screen.hpp:85</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a19c380b03cea21d7ac7325136a131ff0"><div class="ttname"><a href="classftxui_1_1Screen.html#a19c380b03cea21d7ac7325136a131ff0">ftxui::Screen::ToString</a></div><div class="ttdeci">std::string ToString() const</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00416">screen.cpp:416</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a1aa24862a3d050b3aea2ade1300d51a7"><div class="ttname"><a href="classftxui_1_1Screen.html#a1aa24862a3d050b3aea2ade1300d51a7">ftxui::Screen::SetCursor</a></div><div class="ttdeci">void SetCursor(Cursor cursor)</div><div class="ttdef"><b>Definition</b> <a href="#l00111">screen.hpp:111</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a1b254c3faacd432c325efff4268ca683"><div class="ttname"><a href="classftxui_1_1Screen.html#a1b254c3faacd432c325efff4268ca683">ftxui::Screen::dimx_</a></div><div class="ttdeci">int dimx_</div><div class="ttdef"><b>Definition</b> <a href="#l00121">screen.hpp:121</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a32b98be0603ace46d6dc9d05b330a9fd"><div class="ttname"><a href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a></div><div class="ttdeci">static Screen Create(Dimensions dimension)</div><div class="ttdoc">Create a screen with the given dimension.</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00391">screen.cpp:391</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a483f8ee1967e200cfc9e277b3ce00174"><div class="ttname"><a href="classftxui_1_1Screen.html#a483f8ee1967e200cfc9e277b3ce00174">ftxui::Screen::PixelAt</a></div><div class="ttdeci">Pixel &amp; PixelAt(int x, int y)</div><div class="ttdoc">Access a cell (Pixel) at a given position.</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00470">screen.cpp:470</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a55b0a995463c6936efb33391f29565bc"><div class="ttname"><a href="classftxui_1_1Screen.html#a55b0a995463c6936efb33391f29565bc">ftxui::Screen::at</a></div><div class="ttdeci">std::string &amp; at(int x, int y)</div><div class="ttdoc">Access a character in a cell at a given position.</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00456">screen.cpp:456</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a7ecf7c5fb3d90a1620098a60cfafc215"><div class="ttname"><a href="classftxui_1_1Screen.html#a7ecf7c5fb3d90a1620098a60cfafc215">ftxui::Screen::Screen</a></div><div class="ttdeci">Screen(int dimx, int dimy)</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00395">screen.cpp:395</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a92cacd07ba30909855f19edc01192ff0"><div class="ttname"><a href="classftxui_1_1Screen.html#a92cacd07ba30909855f19edc01192ff0">ftxui::Screen::stencil</a></div><div class="ttdeci">Box stencil</div><div class="ttdef"><b>Definition</b> <a href="#l00118">screen.hpp:118</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a937f1d3d98e2c4152fae2ffb8d31e4a9"><div class="ttname"><a href="classftxui_1_1Screen.html#a937f1d3d98e2c4152fae2ffb8d31e4a9">ftxui::Screen::RegisterHyperlink</a></div><div class="ttdeci">uint8_t RegisterHyperlink(const std::string &amp;link)</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00561">screen.cpp:561</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a94febaac347b83267ff6a10b7837d612"><div class="ttname"><a href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612">ftxui::Screen::cursor</a></div><div class="ttdeci">Cursor cursor() const</div><div class="ttdef"><b>Definition</b> <a href="#l00110">screen.hpp:110</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a9677c078c4270afdb7451cdc0b0871d4"><div class="ttname"><a href="classftxui_1_1Screen.html#a9677c078c4270afdb7451cdc0b0871d4">ftxui::Screen::ResetPosition</a></div><div class="ttdeci">std::string ResetPosition(bool clear=false) const</div><div class="ttdoc">Return a string to be printed in order to reset the cursor position to the beginning of the screen.</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00500">screen.cpp:500</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a9df9d1ae7ed66857ca987963b2365904"><div class="ttname"><a href="classftxui_1_1Screen.html#a9df9d1ae7ed66857ca987963b2365904">ftxui::Screen::cursor_</a></div><div class="ttdeci">Cursor cursor_</div><div class="ttdef"><b>Definition</b> <a href="#l00124">screen.hpp:124</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_a9e9d5df4b41aaa5eca27cdcaca6d4574"><div class="ttname"><a href="classftxui_1_1Screen.html#a9e9d5df4b41aaa5eca27cdcaca6d4574">ftxui::Screen::dimy_</a></div><div class="ttdeci">int dimy_</div><div class="ttdef"><b>Definition</b> <a href="#l00122">screen.hpp:122</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_aa71d36872f416feaa853788a7a7a7ef8"><div class="ttname"><a href="classftxui_1_1Screen.html#aa71d36872f416feaa853788a7a7a7ef8">ftxui::Screen::Clear</a></div><div class="ttdeci">void Clear()</div><div class="ttdoc">Clear all the pixel from the screen.</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00519">screen.cpp:519</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_acff83d382ef60ad2a0fca3ba68e9397f"><div class="ttname"><a href="classftxui_1_1Screen.html#acff83d382ef60ad2a0fca3ba68e9397f">ftxui::Screen::hyperlinks_</a></div><div class="ttdeci">std::vector&lt; std::string &gt; hyperlinks_</div><div class="ttdef"><b>Definition</b> <a href="#l00125">screen.hpp:125</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_ad93edbe885499a712129356f1ffd506b"><div class="ttname"><a href="classftxui_1_1Screen.html#ad93edbe885499a712129356f1ffd506b">ftxui::Screen::Print</a></div><div class="ttdeci">void Print() const</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00449">screen.cpp:449</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_ae7a460c9dacd70ed81b1adfea46b492e"><div class="ttname"><a href="classftxui_1_1Screen.html#ae7a460c9dacd70ed81b1adfea46b492e">ftxui::Screen::dimx</a></div><div class="ttdeci">int dimx() const</div><div class="ttdef"><b>Definition</b> <a href="#l00084">screen.hpp:84</a></div></div>
<div class="ttc" id="aclassftxui_1_1Screen_html_aeab8c1788b3f2c7403749c3be95a68ae"><div class="ttname"><a href="classftxui_1_1Screen.html#aeab8c1788b3f2c7403749c3be95a68ae">ftxui::Screen::pixels_</a></div><div class="ttdeci">std::vector&lt; std::vector&lt; Pixel &gt; &gt; pixels_</div><div class="ttdef"><b>Definition</b> <a href="#l00123">screen.hpp:123</a></div></div>
<div class="ttc" id="acolor_8hpp_html"><div class="ttname"><a href="color_8hpp.html">color.hpp</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Dimension_html_a36e539ed36f88d7f01233974da485937"><div class="ttname"><a href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">ftxui::Dimension::Fixed</a></div><div class="ttdeci">Dimensions Fixed(int)</div></div>
<div class="ttc" id="anamespaceftxui_1_1Dimension_html_af795790b995132f62de607ddfd07f9fa"><div class="ttname"><a href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">ftxui::Dimension::Full</a></div><div class="ttdeci">Dimensions Full()</div></div>
<div class="ttc" id="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00012">animation.hpp:12</a></div></div>
<div class="ttc" id="anamespaceftxui_html_structftxui_1_1Dimensions"><div class="ttname"><a href="namespaceftxui.html#structftxui_1_1Dimensions">ftxui::Dimensions</a></div><div class="ttdef"><b>Definition</b> <a href="terminal_8hpp_source.html#l00008">terminal.hpp:8</a></div></div>
<div class="ttc" id="astructftxui_1_1Box_html"><div class="ttname"><a href="structftxui_1_1Box.html">ftxui::Box</a></div><div class="ttdef"><b>Definition</b> <a href="box_8hpp_source.html#l00009">box.hpp:9</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html"><div class="ttname"><a href="structftxui_1_1Pixel.html">ftxui::Pixel</a></div><div class="ttdoc">A unicode character and its associated style.</div><div class="ttdef"><b>Definition</b> <a href="#l00020">screen.hpp:20</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a071ab11cf7706c7800281716177c88e3"><div class="ttname"><a href="structftxui_1_1Pixel.html#a071ab11cf7706c7800281716177c88e3">ftxui::Pixel::hyperlink</a></div><div class="ttdeci">uint8_t hyperlink</div><div class="ttdef"><b>Definition</b> <a href="#l00043">screen.hpp:43</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a19bbb3c355941d56eccf70be7f7ed9e1"><div class="ttname"><a href="structftxui_1_1Pixel.html#a19bbb3c355941d56eccf70be7f7ed9e1">ftxui::Pixel::inverted</a></div><div class="ttdeci">bool inverted</div><div class="ttdef"><b>Definition</b> <a href="#l00035">screen.hpp:35</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a21fbeba389ccf8f76447c7a73ead8db2"><div class="ttname"><a href="structftxui_1_1Pixel.html#a21fbeba389ccf8f76447c7a73ead8db2">ftxui::Pixel::strikethrough</a></div><div class="ttdeci">bool strikethrough</div><div class="ttdef"><b>Definition</b> <a href="#l00038">screen.hpp:38</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a2ce82adc1d02baf22df658b903dcb351"><div class="ttname"><a href="structftxui_1_1Pixel.html#a2ce82adc1d02baf22df658b903dcb351">ftxui::Pixel::foreground_color</a></div><div class="ttdeci">Color foreground_color</div><div class="ttdef"><b>Definition</b> <a href="#l00051">screen.hpp:51</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a399ff0c757d88aeaa2439212f073f380"><div class="ttname"><a href="structftxui_1_1Pixel.html#a399ff0c757d88aeaa2439212f073f380">ftxui::Pixel::blink</a></div><div class="ttdeci">bool blink</div><div class="ttdef"><b>Definition</b> <a href="#l00032">screen.hpp:32</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a3af4612678da78558adccf47e17164bb"><div class="ttname"><a href="structftxui_1_1Pixel.html#a3af4612678da78558adccf47e17164bb">ftxui::Pixel::background_color</a></div><div class="ttdeci">Color background_color</div><div class="ttdef"><b>Definition</b> <a href="#l00050">screen.hpp:50</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a3bbcd6a381555ea201dbe4251a9aafb3"><div class="ttname"><a href="structftxui_1_1Pixel.html#a3bbcd6a381555ea201dbe4251a9aafb3">ftxui::Pixel::character</a></div><div class="ttdeci">std::string character</div><div class="ttdef"><b>Definition</b> <a href="#l00047">screen.hpp:47</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a3cecb006e0ca185024cd89f9ea2ea69a"><div class="ttname"><a href="structftxui_1_1Pixel.html#a3cecb006e0ca185024cd89f9ea2ea69a">ftxui::Pixel::dim</a></div><div class="ttdeci">bool dim</div><div class="ttdef"><b>Definition</b> <a href="#l00034">screen.hpp:34</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a3d22dc2630f1c1c69ec973cd4648b5d5"><div class="ttname"><a href="structftxui_1_1Pixel.html#a3d22dc2630f1c1c69ec973cd4648b5d5">ftxui::Pixel::Pixel</a></div><div class="ttdeci">Pixel()</div><div class="ttdef"><b>Definition</b> <a href="#l00021">screen.hpp:21</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a7a210a24d67146bd143c013d1da0f2dd"><div class="ttname"><a href="structftxui_1_1Pixel.html#a7a210a24d67146bd143c013d1da0f2dd">ftxui::Pixel::bold</a></div><div class="ttdeci">bool bold</div><div class="ttdef"><b>Definition</b> <a href="#l00033">screen.hpp:33</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_a7c8849e8321ea248cd4991ea8ef198eb"><div class="ttname"><a href="structftxui_1_1Pixel.html#a7c8849e8321ea248cd4991ea8ef198eb">ftxui::Pixel::underlined</a></div><div class="ttdeci">bool underlined</div><div class="ttdef"><b>Definition</b> <a href="#l00036">screen.hpp:36</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_ada8b6dbd466ba5b6c4b240f229bd627f"><div class="ttname"><a href="structftxui_1_1Pixel.html#ada8b6dbd466ba5b6c4b240f229bd627f">ftxui::Pixel::automerge</a></div><div class="ttdeci">bool automerge</div><div class="ttdef"><b>Definition</b> <a href="#l00039">screen.hpp:39</a></div></div>
<div class="ttc" id="astructftxui_1_1Pixel_html_afe0ea73f380e746092213b879003afd6"><div class="ttname"><a href="structftxui_1_1Pixel.html#afe0ea73f380e746092213b879003afd6">ftxui::Pixel::underlined_double</a></div><div class="ttdeci">bool underlined_double</div><div class="ttdef"><b>Definition</b> <a href="#l00037">screen.hpp:37</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html">ftxui::Screen::Cursor</a></div><div class="ttdef"><b>Definition</b> <a href="#l00095">screen.hpp:95</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a0a2f84ed7838f07779ae24c5a9086d33"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a0a2f84ed7838f07779ae24c5a9086d33">ftxui::Screen::Cursor::y</a></div><div class="ttdeci">int y</div><div class="ttdef"><b>Definition</b> <a href="#l00097">screen.hpp:97</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37c"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37c">ftxui::Screen::Cursor::Shape</a></div><div class="ttdeci">Shape</div><div class="ttdef"><b>Definition</b> <a href="#l00099">screen.hpp:99</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37ca2f4a0b3cacb4468d8467dc0746ea23aa"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca2f4a0b3cacb4468d8467dc0746ea23aa">ftxui::Screen::Cursor::BlockBlinking</a></div><div class="ttdeci">@ BlockBlinking</div><div class="ttdef"><b>Definition</b> <a href="#l00101">screen.hpp:101</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37ca6424dbda22da2f105580d1c8095600d3"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37ca6424dbda22da2f105580d1c8095600d3">ftxui::Screen::Cursor::Bar</a></div><div class="ttdeci">@ Bar</div><div class="ttdef"><b>Definition</b> <a href="#l00106">screen.hpp:106</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37caa00f801460e81f86eab56d86fe627551"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa00f801460e81f86eab56d86fe627551">ftxui::Screen::Cursor::Block</a></div><div class="ttdeci">@ Block</div><div class="ttdef"><b>Definition</b> <a href="#l00102">screen.hpp:102</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37caa909c5f2b588ba35fcc40b3b504ad2ed"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37caa909c5f2b588ba35fcc40b3b504ad2ed">ftxui::Screen::Cursor::Underline</a></div><div class="ttdeci">@ Underline</div><div class="ttdef"><b>Definition</b> <a href="#l00104">screen.hpp:104</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37cacf46e529658ebc6532c204f3246929f4"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cacf46e529658ebc6532c204f3246929f4">ftxui::Screen::Cursor::Hidden</a></div><div class="ttdeci">@ Hidden</div><div class="ttdef"><b>Definition</b> <a href="#l00100">screen.hpp:100</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37cad7df11ee39d53d4ee2da1b22b2238abc"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cad7df11ee39d53d4ee2da1b22b2238abc">ftxui::Screen::Cursor::UnderlineBlinking</a></div><div class="ttdeci">@ UnderlineBlinking</div><div class="ttdef"><b>Definition</b> <a href="#l00103">screen.hpp:103</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a55b506070847a13554f8b879c1bfb37cae7dfc08d4e90b88e0cb1cea7a54796c1"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a55b506070847a13554f8b879c1bfb37cae7dfc08d4e90b88e0cb1cea7a54796c1">ftxui::Screen::Cursor::BarBlinking</a></div><div class="ttdeci">@ BarBlinking</div><div class="ttdef"><b>Definition</b> <a href="#l00105">screen.hpp:105</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a6150e0515f7202e2fb518f7206ed97dc"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a6150e0515f7202e2fb518f7206ed97dc">ftxui::Screen::Cursor::x</a></div><div class="ttdeci">int x</div><div class="ttdef"><b>Definition</b> <a href="#l00096">screen.hpp:96</a></div></div>
<div class="ttc" id="astructftxui_1_1Screen_1_1Cursor_html_a8b9f7758a8bd2bef680aeecc40bcfe04"><div class="ttname"><a href="structftxui_1_1Screen_1_1Cursor.html#a8b9f7758a8bd2bef680aeecc40bcfe04">ftxui::Screen::Cursor::shape</a></div><div class="ttdeci">Shape shape</div><div class="ttdef"><b>Definition</b> <a href="#l00108">screen.hpp:108</a></div></div>
<div class="ttc" id="aterminal_8hpp_html"><div class="ttname"><a href="terminal_8hpp.html">terminal.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
<script>
document.addEventListener('DOMContentLoaded', function() {
const projectNumber = document.getElementById('projectname');
if (!projectNumber) {
console.warn('Doxygen element with ID "projectnumber" not found. Cannot add version switcher.');
return;
}
const langs = ["en", "es", "fr", "ja", "zh-CH", "zh-TW"];
const lang_paths = {"en": "../../index.html", "es": "../../es/index.html", "fr": "../../fr/index.html", "ja": "../../ja/index.html", "zh-CH": "../../zh-CH/index.html", "zh-TW": "../../zh-TW/index.html"};
const lang_display = {"en": "English", "es": "Espa\u00f1ol", "fr": "Fran\u00e7ais", "ja": "\u65e5\u672c\u8a9e", "zh-CH": "\u4e2d\u6587 (\u7b80\u4f53)", "zh-TW": "\u4e2d\u6587 (\u7e41\u9ad4)"};
const versions = ["main", "v6.1.9", "v6.1.8", "v6.1.7", "v6.1.6", "v6.1.5", "v6.1.4", "v6.1.3", "v6.1.2", "v6.1.1", "v6.1.0", "v6.0.2", "v6.0.1", "v6.0.0", "v5.0.0", "v4.1.1", "v4.1.0", "v4.0.0", "v3.0.0", "v2.0.0", "v0.9", "v0.11", "v0.10"];
const version_paths = {"main": "../../index.html", "v6.1.9": "../v6.1.9/index.html", "v6.1.8": "../v6.1.8/index.html", "v6.1.7": "../v6.1.7/index.html", "v6.1.6": "../v6.1.6/index.html", "v6.1.5": "../v6.1.5/index.html", "v6.1.4": "../v6.1.4/index.html", "v6.1.3": "../v6.1.3/index.html", "v6.1.2": "../v6.1.2/index.html", "v6.1.1": "../v6.1.1/index.html", "v6.1.0": "../v6.1.0/index.html", "v6.0.2": "../v6.0.2/index.html", "v6.0.1": "../v6.0.1/index.html", "v6.0.0": "../v6.0.0/index.html", "v5.0.0": "index.html", "v4.1.1": "../v4.1.1/index.html", "v4.1.0": "../v4.1.0/index.html", "v4.0.0": "../v4.0.0/index.html", "v3.0.0": "../v3.0.0/index.html", "v2.0.0": "../v2.0.0/index.html", "v0.9": "../v0.9/index.html", "v0.11": "../v0.11/index.html", "v0.10": "../v0.10/index.html"};
const currentLang = "en";
const currentVersion = "v5.0.0";
// Helper function to create a styled select element
const createSelect = (options, current, paths, label, displayMap = null) => {
const select = document.createElement('select');
select.title = label;
select.onchange = function() {
const selectedValue = this.value;
if (selectedValue in paths) {
window.location.href = paths[selectedValue];
}
};
// Sort versions: 'main' first, then others numerically descending.
options.sort((a, b) => {
if (a === 'main') return -1;
if (b === 'main') return 1;
return b.localeCompare(a, undefined, { numeric: true, sensitivity: 'base' });
});
options.forEach(v => {
const option = document.createElement('option');
option.value = v;
// Use the displayMap if provided, otherwise default to the value (v)
option.textContent = displayMap ? displayMap[v] : v;
if (v === current) {
option.selected = true;
}
select.appendChild(option);
});
// Apply some styling to make it look good.
Object.assign(select.style, {
backgroundColor: 'rgba(0, 0, 0, 0.8)',
color: 'white',
border: '1px solid rgba(255, 255, 255, 0.2)',
padding: '5px',
borderRadius: '5px',
fontSize: '14px',
fontFamily: 'inherit',
margin: '0 5px 0 0',
cursor: 'pointer'
});
return select;
};
// 1. Create Language Switcher, passing the language display names map
const langSelect = createSelect(langs, currentLang, lang_paths, 'Select Language', lang_display);
// 2. Create Version Switcher
const versionSelect = createSelect(versions, currentVersion, version_paths, 'Select Version');
// 3. Create FTXUI title.
const ftxuiTitle = document.createElement('span');
ftxuiTitle.textContent = 'FTXUI: ';
Object.assign(ftxuiTitle.style, {
color: 'white',
fontSize: '20px',
fontWeight: 'bold',
marginRight: '10px'
});
// 3. Create a container to hold both selectors
const container = document.createElement('div');
container.id = 'version-lang-switchers';
Object.assign(container.style, {
display: 'flex',
alignItems: 'center',
justifyContent: 'flex-end',
width: 'auto'
});
container.appendChild(ftxuiTitle);
container.appendChild(langSelect);
container.appendChild(versionSelect);
Object.assign(container.style, {
backgroundColor: 'rgba(0, 0, 0, 0.5)',
padding: '5px 10px',
borderRadius: '8px'
});
// Replace the Doxygen project number element with our container.
projectNumber.replaceWith(container);
// Clean up the original Doxygen project number text if it still exists nearby
const parent = container.parentElement;
if (parent) {
const textNode = Array.from(parent.childNodes).find(n => n.nodeType === 3 && n.textContent.trim() !== '');
if (textNode) {
textNode.remove();
}
}
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink