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
4489987a188753198158d105e4a9f21ab93c04a6
FTXUI/classftxui_1_1ScreenInteractive.html
ArthurSonzogni 4489987a18 deploy: 2f0afe7b14
2025-05-30 18:32:48 +00:00

1647 lines
93 KiB
HTML
Raw Blame History

<!-- 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: ScreenInteractive Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeParagraphLink.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeTabs.init()
window.addEventListener('DOMContentLoaded', function () {
document.querySelectorAll(".headertitle").forEach(div => {
// Hide progressively the title.
if (div.textContent != "Getting Started" &&
div.textContent != "Installation" &&
div.textContent != "Modules" &&
true) {
return;
}
div.style.display = "none";
// Show progressively the image.
const img = document.querySelector("img.inline");
img.style.maxHeight = "40vh";
img.style.maxWidth = "100%";
img.style.objectFit = "contain";
});
});
</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('classftxui_1_1ScreenInteractive.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle"><div class="title">ScreenInteractive Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="screen__interactive_8hpp_source.html">screen_interactive.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ScreenInteractive:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classftxui_1_1ScreenInteractive__inherit__graph.png" border="0" usemap="#aScreenInteractive_inherit__map" alt="Inheritance graph"/></div>
<map name="aScreenInteractive_inherit__map" id="aScreenInteractive_inherit__map">
<area shape="rect" title=" " alt="" coords="5,152,141,177"/>
<area shape="rect" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel." alt="" coords="40,79,107,104"/>
<area shape="poly" title=" " alt="" coords="76,118,76,152,71,152,71,118"/>
<area shape="rect" href="classftxui_1_1Image.html" title="A rectangular grid of Pixel." alt="" coords="42,5,105,31"/>
<area shape="poly" title=" " alt="" coords="76,44,76,79,71,79,71,44"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for ScreenInteractive:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classftxui_1_1ScreenInteractive__coll__graph.png" border="0" usemap="#aScreenInteractive_coll__map" alt="Collaboration graph"/></div>
<map name="aScreenInteractive_coll__map" id="aScreenInteractive_coll__map">
<area shape="rect" title=" " alt="" coords="13,256,149,281"/>
<area shape="rect" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel." alt="" coords="47,181,114,207"/>
<area shape="poly" title=" " alt="" coords="83,221,83,256,78,256,78,221"/>
<area shape="rect" href="classftxui_1_1Image.html" title="A rectangular grid of Pixel." alt="" coords="5,93,68,119"/>
<area shape="poly" title=" " alt="" coords="51,130,77,180,72,182,47,132"/>
<area shape="rect" href="structftxui_1_1Box.html" title=" " alt="" coords="13,5,60,31"/>
<area shape="poly" title=" " alt="" coords="39,45,39,93,34,93,34,45"/>
<area shape="rect" href="structftxui_1_1Screen_1_1Cursor.html" title=" " alt="" coords="93,93,157,119"/>
<area shape="poly" title=" " alt="" coords="115,132,89,182,84,180,110,130"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1ScreenInteractive_1_1Private.html">Private</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0424ec9a980000671f12bfa39fc32273" id="r_a0424ec9a980000671f12bfa39fc32273"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> = std::function&lt;void(<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>&amp;)&gt;</td></tr>
<tr class="separator:a0424ec9a980000671f12bfa39fc32273"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad5961c1d4caf0ba9a030e5675162a164" id="r_ad5961c1d4caf0ba9a030e5675162a164"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5961c1d4caf0ba9a030e5675162a164">TrackMouse</a> (bool enable=true)</td></tr>
<tr class="memdesc:ad5961c1d4caf0ba9a030e5675162a164"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether mouse is tracked and events reported. called outside of the main loop. E.g <code><a class="el" href="#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop(...)</a></code>. <br /></td></tr>
<tr class="separator:ad5961c1d4caf0ba9a030e5675162a164"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd3dbd471fce0038700caaa47dddc1a" id="r_a9bd3dbd471fce0038700caaa47dddc1a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9bd3dbd471fce0038700caaa47dddc1a">Loop</a> (<a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a>)</td></tr>
<tr class="memdesc:a9bd3dbd471fce0038700caaa47dddc1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the main loop. <br /></td></tr>
<tr class="separator:a9bd3dbd471fce0038700caaa47dddc1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a6a7739e9cc01ba888b57d1f9457f4c" id="r_a1a6a7739e9cc01ba888b57d1f9457f4c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1a6a7739e9cc01ba888b57d1f9457f4c">Exit</a> ()</td></tr>
<tr class="memdesc:a1a6a7739e9cc01ba888b57d1f9457f4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit the main loop. <br /></td></tr>
<tr class="separator:a1a6a7739e9cc01ba888b57d1f9457f4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae295157a88e6300609df83769ed885f2" id="r_ae295157a88e6300609df83769ed885f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae295157a88e6300609df83769ed885f2">ExitLoopClosure</a> ()</td></tr>
<tr class="memdesc:ae295157a88e6300609df83769ed885f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a function to exit the main loop. <br /></td></tr>
<tr class="separator:ae295157a88e6300609df83769ed885f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49209b09dcf8bc540f79e2bfd0a7ee88" id="r_a49209b09dcf8bc540f79e2bfd0a7ee88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a49209b09dcf8bc540f79e2bfd0a7ee88">Post</a> (<a class="el" href="namespaceftxui.html#aaa92a82e968c721805c62787cd000534">Task</a> task)</td></tr>
<tr class="memdesc:a49209b09dcf8bc540f79e2bfd0a7ee88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a task to the main loop. It will be executed later, after every other scheduled tasks. <br /></td></tr>
<tr class="separator:a49209b09dcf8bc540f79e2bfd0a7ee88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29e75bdaa1d5465518787ec014b2c3bf" id="r_a29e75bdaa1d5465518787ec014b2c3bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29e75bdaa1d5465518787ec014b2c3bf">PostEvent</a> (<a class="el" href="structftxui_1_1Event.html">Event</a> event)</td></tr>
<tr class="memdesc:a29e75bdaa1d5465518787ec014b2c3bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an event to the main loop. It will be executed later, after every other scheduled events. <br /></td></tr>
<tr class="separator:a29e75bdaa1d5465518787ec014b2c3bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad94d3d42aba3359550759aae5bcffbe9" id="r_ad94d3d42aba3359550759aae5bcffbe9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad94d3d42aba3359550759aae5bcffbe9">RequestAnimationFrame</a> ()</td></tr>
<tr class="memdesc:ad94d3d42aba3359550759aae5bcffbe9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a task to draw the screen one more time, until all the animations are done. <br /></td></tr>
<tr class="separator:ad94d3d42aba3359550759aae5bcffbe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad61519d291dcc216d2ac618618a45a2" id="r_aad61519d291dcc216d2ac618618a45a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad61519d291dcc216d2ac618618a45a2">CaptureMouse</a> ()</td></tr>
<tr class="memdesc:aad61519d291dcc216d2ac618618a45a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to get the unique lock about behing able to capture the mouse. <br /></td></tr>
<tr class="separator:aad61519d291dcc216d2ac618618a45a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9df2de690486078fea4a7151b83b089" id="r_af9df2de690486078fea4a7151b83b089"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af9df2de690486078fea4a7151b83b089">WithRestoredIO</a> (<a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a>)</td></tr>
<tr class="memdesc:af9df2de690486078fea4a7151b83b089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution. <br /></td></tr>
<tr class="separator:af9df2de690486078fea4a7151b83b089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae48c11a6c9160dc14cd5504ebe69304b" id="r_ae48c11a6c9160dc14cd5504ebe69304b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae48c11a6c9160dc14cd5504ebe69304b">ForceHandleCtrlC</a> (bool force)</td></tr>
<tr class="memdesc:ae48c11a6c9160dc14cd5504ebe69304b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force FTXUI to handle or not handle Ctrl-C, even if the component catches the <a class="el" href="structftxui_1_1Event.html#a038a33c469a2e4474d08d637e37f660d">Event::CtrlC</a>. <br /></td></tr>
<tr class="separator:ae48c11a6c9160dc14cd5504ebe69304b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1c772ab581e587daad086227435f2ec" id="r_af1c772ab581e587daad086227435f2ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af1c772ab581e587daad086227435f2ec">ForceHandleCtrlZ</a> (bool force)</td></tr>
<tr class="memdesc:af1c772ab581e587daad086227435f2ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force FTXUI to handle or not handle Ctrl-Z, even if the component catches the <a class="el" href="structftxui_1_1Event.html#a22ef83103e0443ba82acc19f24f729bc">Event::CtrlZ</a>. <br /></td></tr>
<tr class="separator:af1c772ab581e587daad086227435f2ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac25769e248caa01d336f5eaa79cd6160" id="r_ac25769e248caa01d336f5eaa79cd6160"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac25769e248caa01d336f5eaa79cd6160">GetSelection</a> ()</td></tr>
<tr class="memdesc:ac25769e248caa01d336f5eaa79cd6160"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the content of the current selection. <br /></td></tr>
<tr class="separator:ac25769e248caa01d336f5eaa79cd6160"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6daabb2df61b6be6f0b2a8950ac3281" id="r_ad6daabb2df61b6be6f0b2a8950ac3281"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6daabb2df61b6be6f0b2a8950ac3281">SelectionChange</a> (std::function&lt; void()&gt; callback)</td></tr>
<tr class="separator:ad6daabb2df61b6be6f0b2a8950ac3281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19c380b03cea21d7ac7325136a131ff0" id="r_a19c380b03cea21d7ac7325136a131ff0"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a19c380b03cea21d7ac7325136a131ff0">ToString</a> () const</td></tr>
<tr class="separator:a19c380b03cea21d7ac7325136a131ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad93edbe885499a712129356f1ffd506b" id="r_ad93edbe885499a712129356f1ffd506b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#ad93edbe885499a712129356f1ffd506b">Print</a> () const</td></tr>
<tr class="separator:ad93edbe885499a712129356f1ffd506b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa71d36872f416feaa853788a7a7a7ef8" id="r_aa71d36872f416feaa853788a7a7a7ef8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#aa71d36872f416feaa853788a7a7a7ef8">Clear</a> ()</td></tr>
<tr class="memdesc:aa71d36872f416feaa853788a7a7a7ef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all the pixel from the screen. <br /></td></tr>
<tr class="separator:aa71d36872f416feaa853788a7a7a7ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9677c078c4270afdb7451cdc0b0871d4" id="r_a9677c078c4270afdb7451cdc0b0871d4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a9677c078c4270afdb7451cdc0b0871d4">ResetPosition</a> (bool clear=false) const</td></tr>
<tr class="memdesc:a9677c078c4270afdb7451cdc0b0871d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string to be printed in order to reset the cursor position to the beginning of the screen. <br /></td></tr>
<tr class="separator:a9677c078c4270afdb7451cdc0b0871d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04d18c0cb0df3ed7a01ca5c3b8711ff7" id="r_a04d18c0cb0df3ed7a01ca5c3b8711ff7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a04d18c0cb0df3ed7a01ca5c3b8711ff7">ApplyShader</a> ()</td></tr>
<tr class="separator:a04d18c0cb0df3ed7a01ca5c3b8711ff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94febaac347b83267ff6a10b7837d612" id="r_a94febaac347b83267ff6a10b7837d612"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612">cursor</a> () const</td></tr>
<tr class="separator:a94febaac347b83267ff6a10b7837d612"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1aa24862a3d050b3aea2ade1300d51a7" id="r_a1aa24862a3d050b3aea2ade1300d51a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a1aa24862a3d050b3aea2ade1300d51a7">SetCursor</a> (<a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> <a class="el" href="classftxui_1_1Screen.html#a94febaac347b83267ff6a10b7837d612">cursor</a>)</td></tr>
<tr class="separator:a1aa24862a3d050b3aea2ade1300d51a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38015a8bc3dda474354ec8a374a6e2de" id="r_a38015a8bc3dda474354ec8a374a6e2de"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a38015a8bc3dda474354ec8a374a6e2de">RegisterHyperlink</a> (const std::string &amp;link)</td></tr>
<tr class="separator:a38015a8bc3dda474354ec8a374a6e2de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b55b16969dfccc79195fe61c5ba6d1a" id="r_a0b55b16969dfccc79195fe61c5ba6d1a"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a0b55b16969dfccc79195fe61c5ba6d1a">Hyperlink</a> (uint8_t id) const</td></tr>
<tr class="separator:a0b55b16969dfccc79195fe61c5ba6d1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a056c2ad43affdac744b6907e9ea81463" id="r_a056c2ad43affdac744b6907e9ea81463"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a056c2ad43affdac744b6907e9ea81463">GetSelectionStyle</a> () const</td></tr>
<tr class="memdesc:a056c2ad43affdac744b6907e9ea81463"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current selection style. <br /></td></tr>
<tr class="separator:a056c2ad43affdac744b6907e9ea81463"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba0d30b90db17d6b7561f704ed63b5e6" id="r_aba0d30b90db17d6b7561f704ed63b5e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#aba0d30b90db17d6b7561f704ed63b5e6">SetSelectionStyle</a> (<a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> decorator)</td></tr>
<tr class="memdesc:aba0d30b90db17d6b7561f704ed63b5e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current selection style. <br /></td></tr>
<tr class="separator:aba0d30b90db17d6b7561f704ed63b5e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55b0a995463c6936efb33391f29565bc" id="r_a55b0a995463c6936efb33391f29565bc"><td class="memItemLeft" align="right" valign="top">std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a55b0a995463c6936efb33391f29565bc">at</a> (int x, int y)</td></tr>
<tr class="memdesc:a55b0a995463c6936efb33391f29565bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access a character in a cell at a given position. <br /></td></tr>
<tr class="separator:a55b0a995463c6936efb33391f29565bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0882d58bb8ca1be9953135338456cf9e" id="r_a0882d58bb8ca1be9953135338456cf9e"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a0882d58bb8ca1be9953135338456cf9e">at</a> (int x, int y) const</td></tr>
<tr class="memdesc:a0882d58bb8ca1be9953135338456cf9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access a character in a cell at a given position. <br /></td></tr>
<tr class="separator:a0882d58bb8ca1be9953135338456cf9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a483f8ee1967e200cfc9e277b3ce00174" id="r_a483f8ee1967e200cfc9e277b3ce00174"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1Pixel.html">Pixel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a483f8ee1967e200cfc9e277b3ce00174">PixelAt</a> (int x, int y)</td></tr>
<tr class="memdesc:a483f8ee1967e200cfc9e277b3ce00174"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access a cell (<a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a>) at a given position. <br /></td></tr>
<tr class="separator:a483f8ee1967e200cfc9e277b3ce00174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03b2b39bb8f4d72068744776093125b3" id="r_a03b2b39bb8f4d72068744776093125b3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structftxui_1_1Pixel.html">Pixel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a03b2b39bb8f4d72068744776093125b3">PixelAt</a> (int x, int y) const</td></tr>
<tr class="memdesc:a03b2b39bb8f4d72068744776093125b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access a cell (<a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a>) at a given position. <br /></td></tr>
<tr class="separator:a03b2b39bb8f4d72068744776093125b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7a460c9dacd70ed81b1adfea46b492e" id="r_ae7a460c9dacd70ed81b1adfea46b492e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#ae7a460c9dacd70ed81b1adfea46b492e">dimx</a> () const</td></tr>
<tr class="separator:ae7a460c9dacd70ed81b1adfea46b492e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d283cfb1ec16b3fc13d344ebfea93d4" id="r_a0d283cfb1ec16b3fc13d344ebfea93d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a0d283cfb1ec16b3fc13d344ebfea93d4">dimy</a> () const</td></tr>
<tr class="separator:a0d283cfb1ec16b3fc13d344ebfea93d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a267cfc2d693fa96a82ae74029214d02e" id="r_a267cfc2d693fa96a82ae74029214d02e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a267cfc2d693fa96a82ae74029214d02e">FixedSize</a> (int <a class="el" href="classftxui_1_1Image.html#ae7a460c9dacd70ed81b1adfea46b492e">dimx</a>, int <a class="el" href="classftxui_1_1Image.html#a0d283cfb1ec16b3fc13d344ebfea93d4">dimy</a>)</td></tr>
<tr class="separator:a267cfc2d693fa96a82ae74029214d02e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53dc5c3030151713857cf1a898d0f897" id="r_a53dc5c3030151713857cf1a898d0f897"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53dc5c3030151713857cf1a898d0f897">Fullscreen</a> ()</td></tr>
<tr class="separator:a53dc5c3030151713857cf1a898d0f897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6be13532d5bef8f566c12090db2dffba" id="r_a6be13532d5bef8f566c12090db2dffba"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6be13532d5bef8f566c12090db2dffba">FullscreenPrimaryScreen</a> ()</td></tr>
<tr class="separator:a6be13532d5bef8f566c12090db2dffba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acad4646ece7569fd39a3a5c847ebb4a8" id="r_acad4646ece7569fd39a3a5c847ebb4a8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acad4646ece7569fd39a3a5c847ebb4a8">FullscreenAlternateScreen</a> ()</td></tr>
<tr class="separator:acad4646ece7569fd39a3a5c847ebb4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f458e443ed672c2aea9fdd96531a621" id="r_a4f458e443ed672c2aea9fdd96531a621"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f458e443ed672c2aea9fdd96531a621">FitComponent</a> ()</td></tr>
<tr class="separator:a4f458e443ed672c2aea9fdd96531a621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b7de0467b4e57ce5f337ba8634d8d13" id="r_a0b7de0467b4e57ce5f337ba8634d8d13"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b7de0467b4e57ce5f337ba8634d8d13">TerminalOutput</a> ()</td></tr>
<tr class="separator:a0b7de0467b4e57ce5f337ba8634d8d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dc30615370889030396a239ceee2a77" id="r_a9dc30615370889030396a239ceee2a77"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9dc30615370889030396a239ceee2a77">Active</a> ()</td></tr>
<tr class="memdesc:a9dc30615370889030396a239ceee2a77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the currently active screen, or null if none. <br /></td></tr>
<tr class="separator:a9dc30615370889030396a239ceee2a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32b98be0603ace46d6dc9d05b330a9fd" id="r_a32b98be0603ace46d6dc9d05b330a9fd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1Screen.html">Screen</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">Create</a> (<a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a> dimension)</td></tr>
<tr class="memdesc:a32b98be0603ace46d6dc9d05b330a9fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a screen with the given dimension. <br /></td></tr>
<tr class="separator:a32b98be0603ace46d6dc9d05b330a9fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29a8d230cd1913d26626158fc4fc0a0c" id="r_a29a8d230cd1913d26626158fc4fc0a0c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1Screen.html">Screen</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a29a8d230cd1913d26626158fc4fc0a0c">Create</a> (<a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a> width, <a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a> height)</td></tr>
<tr class="memdesc:a29a8d230cd1913d26626158fc4fc0a0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a screen with the given dimension along the x-axis and y-axis. <br /></td></tr>
<tr class="separator:a29a8d230cd1913d26626158fc4fc0a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a55bfcd8369da28d548069f2761d2c39f" id="r_a55bfcd8369da28d548069f2761d2c39f"><td class="memItemLeft" align="right" valign="top">friend&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a55bfcd8369da28d548069f2761d2c39f">Private</a></td></tr>
<tr class="separator:a55bfcd8369da28d548069f2761d2c39f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92cacd07ba30909855f19edc01192ff0" id="r_a92cacd07ba30909855f19edc01192ff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1Box.html">Box</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a92cacd07ba30909855f19edc01192ff0">stencil</a></td></tr>
<tr class="separator:a92cacd07ba30909855f19edc01192ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9df9d1ae7ed66857ca987963b2365904" id="r_a9df9d1ae7ed66857ca987963b2365904"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#a9df9d1ae7ed66857ca987963b2365904">cursor_</a></td></tr>
<tr class="separator:a9df9d1ae7ed66857ca987963b2365904"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acff83d382ef60ad2a0fca3ba68e9397f" id="r_acff83d382ef60ad2a0fca3ba68e9397f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#acff83d382ef60ad2a0fca3ba68e9397f">hyperlinks_</a> = {&quot;&quot;}</td></tr>
<tr class="separator:acff83d382ef60ad2a0fca3ba68e9397f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f757d5d67255f61e27950be4131be1" id="r_ab9f757d5d67255f61e27950be4131be1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Screen.html#ab9f757d5d67255f61e27950be4131be1">selection_style_</a></td></tr>
<tr class="separator:ab9f757d5d67255f61e27950be4131be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b254c3faacd432c325efff4268ca683" id="r_a1b254c3faacd432c325efff4268ca683"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a1b254c3faacd432c325efff4268ca683">dimx_</a></td></tr>
<tr class="separator:a1b254c3faacd432c325efff4268ca683"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e9d5df4b41aaa5eca27cdcaca6d4574" id="r_a9e9d5df4b41aaa5eca27cdcaca6d4574"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#a9e9d5df4b41aaa5eca27cdcaca6d4574">dimy_</a></td></tr>
<tr class="separator:a9e9d5df4b41aaa5eca27cdcaca6d4574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeab8c1788b3f2c7403749c3be95a68ae" id="r_aeab8c1788b3f2c7403749c3be95a68ae"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; <a class="el" href="structftxui_1_1Pixel.html">Pixel</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classftxui_1_1Image.html#aeab8c1788b3f2c7403749c3be95a68ae">pixels_</a></td></tr>
<tr class="separator:aeab8c1788b3f2c7403749c3be95a68ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="screen__interactive_8hpp_source.html#l00030">30</a> of file <a class="el" href="screen__interactive_8hpp_source.html">screen_interactive.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0424ec9a980000671f12bfa39fc32273" name="a0424ec9a980000671f12bfa39fc32273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0424ec9a980000671f12bfa39fc32273">&#9670;&#160;</a></span>SelectionStyle</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> = std::function&lt;void(<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>&amp;)&gt;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00072">72</a> of file <a class="el" href="screen_8hpp_source.html">screen.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a267cfc2d693fa96a82ae74029214d02e" name="a267cfc2d693fa96a82ae74029214d02e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a267cfc2d693fa96a82ae74029214d02e">&#9670;&#160;</a></span>FixedSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> FixedSize </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>dimx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>dimy</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00360">360</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a53dc5c3030151713857cf1a898d0f897" name="a53dc5c3030151713857cf1a898d0f897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53dc5c3030151713857cf1a898d0f897">&#9670;&#160;</a></span>Fullscreen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> Fullscreen </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content. </p><dl class="section note"><dt>Note</dt><dd>This is the same as <code><a class="el" href="#acad4646ece7569fd39a3a5c847ebb4a8">ScreenInteractive::FullscreenAlternateScreen()</a></code> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2button_8cpp-example.html#a1">examples/component/button.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00374">374</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a6be13532d5bef8f566c12090db2dffba" name="a6be13532d5bef8f566c12090db2dffba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6be13532d5bef8f566c12090db2dffba">&#9670;&#160;</a></span>FullscreenPrimaryScreen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> FullscreenPrimaryScreen </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> taking the full terminal size. The primary screen buffer is being used. It means if the terminal is resized, the previous content might mess up with the terminal content. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00383">383</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="acad4646ece7569fd39a3a5c847ebb4a8" name="acad4646ece7569fd39a3a5c847ebb4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acad4646ece7569fd39a3a5c847ebb4a8">&#9670;&#160;</a></span>FullscreenAlternateScreen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> FullscreenAlternateScreen </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00396">396</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a4f458e443ed672c2aea9fdd96531a621" name="a4f458e443ed672c2aea9fdd96531a621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f458e443ed672c2aea9fdd96531a621">&#9670;&#160;</a></span>FitComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> FitComponent </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00416">416</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a0b7de0467b4e57ce5f337ba8634d8d13" name="a0b7de0467b4e57ce5f337ba8634d8d13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b7de0467b4e57ce5f337ba8634d8d13">&#9670;&#160;</a></span>TerminalOutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> TerminalOutput </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00406">406</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="ad5961c1d4caf0ba9a030e5675162a164" name="ad5961c1d4caf0ba9a030e5675162a164"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5961c1d4caf0ba9a030e5675162a164">&#9670;&#160;</a></span>TrackMouse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TrackMouse </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>enable</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether mouse is tracked and events reported. called outside of the main loop. E.g <code><a class="el" href="#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop(...)</a></code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td>Whether to enable mouse event tracking. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This muse be called outside of the main loop. E.g. before calling <code><a class="el" href="#a6f7095d721dd1dbd490d97c028eb676f">ScreenInteractive::Loop</a></code>. </dd>
<dd>
<a class="el" href="structftxui_1_1Mouse.html" title="A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift,...">Mouse</a> tracking is enabled by default. </dd>
<dd>
<a class="el" href="structftxui_1_1Mouse.html" title="A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift,...">Mouse</a> tracking is only supported on terminals that supports it.</dd></dl>
<h3><a class="anchor" id="autotoc_md92"></a>
Example</h3>
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="#a0b7de0467b4e57ce5f337ba8634d8d13">ScreenInteractive::TerminalOutput</a>();</div>
<div class="line">screen.TrackMouse(<span class="keyword">false</span>);</div>
<div class="line">screen.Loop(component);</div>
<div class="ttc" id="aclassftxui_1_1ScreenInteractive_html_a0b7de0467b4e57ce5f337ba8634d8d13"><div class="ttname"><a href="#a0b7de0467b4e57ce5f337ba8634d8d13">ftxui::ScreenInteractive::TerminalOutput</a></div><div class="ttdeci">static ScreenInteractive TerminalOutput()</div><div class="ttdef"><b>Definition</b> <a href="screen__interactive_8cpp_source.html#l00406">screen_interactive.cpp:406</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00441">441</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a9dc30615370889030396a239ceee2a77" name="a9dc30615370889030396a239ceee2a77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dc30615370889030396a239ceee2a77">&#9670;&#160;</a></span>Active()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a> * Active </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the currently active screen, or null if none. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00594">594</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a9bd3dbd471fce0038700caaa47dddc1a" name="a9bd3dbd471fce0038700caaa47dddc1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bd3dbd471fce0038700caaa47dddc1a">&#9670;&#160;</a></span>Loop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classftxui_1_1Loop.html">Loop</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceftxui.html#af1479ede01dbf087342534ab4ada11d3">Component</a></td> <td class="paramname"><span class="paramname"><em>component</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute the main loop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">component</td><td>The component to draw. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00495">495</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a1a6a7739e9cc01ba888b57d1f9457f4c" name="a1a6a7739e9cc01ba888b57d1f9457f4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a6a7739e9cc01ba888b57d1f9457f4c">&#9670;&#160;</a></span>Exit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Exit </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Exit the main loop. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l01032">1032</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="ae295157a88e6300609df83769ed885f2" name="ae295157a88e6300609df83769ed885f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae295157a88e6300609df83769ed885f2">&#9670;&#160;</a></span>ExitLoopClosure()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a> ExitLoopClosure </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a function to exit the main loop. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l01026">1026</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a49209b09dcf8bc540f79e2bfd0a7ee88" name="a49209b09dcf8bc540f79e2bfd0a7ee88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49209b09dcf8bc540f79e2bfd0a7ee88">&#9670;&#160;</a></span>Post()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Post </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceftxui.html#aaa92a82e968c721805c62787cd000534">Task</a></td> <td class="paramname"><span class="paramname"><em>task</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a task to the main loop. It will be executed later, after every other scheduled tasks. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00448">448</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a29e75bdaa1d5465518787ec014b2c3bf" name="a29e75bdaa1d5465518787ec014b2c3bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29e75bdaa1d5465518787ec014b2c3bf">&#9670;&#160;</a></span>PostEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PostEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structftxui_1_1Event.html">Event</a></td> <td class="paramname"><span class="paramname"><em>event</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an event to the main loop. It will be executed later, after every other scheduled events. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00461">461</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="ad94d3d42aba3359550759aae5bcffbe9" name="ad94d3d42aba3359550759aae5bcffbe9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad94d3d42aba3359550759aae5bcffbe9">&#9670;&#160;</a></span>RequestAnimationFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RequestAnimationFrame </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a task to draw the screen one more time, until all the animations are done. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00467">467</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="aad61519d291dcc216d2ac618618a45a2" name="aad61519d291dcc216d2ac618618a45a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad61519d291dcc216d2ac618618a45a2">&#9670;&#160;</a></span>CaptureMouse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui.html#a24b663cb6b0b262055c94d3a03bdd274">CapturedMouse</a> CaptureMouse </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Try to get the unique lock about behing able to capture the mouse. </p>
<dl class="section return"><dt>Returns</dt><dd>A unique lock if the mouse is not already captured, otherwise a null. </dd></dl>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00483">483</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="af9df2de690486078fea4a7151b83b089" name="af9df2de690486078fea4a7151b83b089"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9df2de690486078fea4a7151b83b089">&#9670;&#160;</a></span>WithRestoredIO()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a> WithRestoredIO </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceftxui.html#adc2f3bfa69ce99c596a1ff1b69b04d33">Closure</a></td> <td class="paramname"><span class="paramname"><em>fn</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fn</td><td>The function to decorate. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00560">560</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="ae48c11a6c9160dc14cd5504ebe69304b" name="ae48c11a6c9160dc14cd5504ebe69304b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae48c11a6c9160dc14cd5504ebe69304b">&#9670;&#160;</a></span>ForceHandleCtrlC()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ForceHandleCtrlC </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>force</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Force FTXUI to handle or not handle Ctrl-C, even if the component catches the <a class="el" href="structftxui_1_1Event.html#a038a33c469a2e4474d08d637e37f660d">Event::CtrlC</a>. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00570">570</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="af1c772ab581e587daad086227435f2ec" name="af1c772ab581e587daad086227435f2ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1c772ab581e587daad086227435f2ec">&#9670;&#160;</a></span>ForceHandleCtrlZ()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ForceHandleCtrlZ </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>force</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Force FTXUI to handle or not handle Ctrl-Z, even if the component catches the <a class="el" href="structftxui_1_1Event.html#a22ef83103e0443ba82acc19f24f729bc">Event::CtrlZ</a>. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00576">576</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="ac25769e248caa01d336f5eaa79cd6160" name="ac25769e248caa01d336f5eaa79cd6160"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac25769e248caa01d336f5eaa79cd6160">&#9670;&#160;</a></span>GetSelection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string GetSelection </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the content of the current selection. </p>
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00581">581</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="ad6daabb2df61b6be6f0b2a8950ac3281" name="ad6daabb2df61b6be6f0b2a8950ac3281"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6daabb2df61b6be6f0b2a8950ac3281">&#9670;&#160;</a></span>SelectionChange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SelectionChange </td>
<td>(</td>
<td class="paramtype">std::function&lt; void()&gt;</td> <td class="paramname"><span class="paramname"><em>callback</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen__interactive_8cpp_source.html#l00588">588</a> of file <a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a>.</p>
</div>
</div>
<a id="a32b98be0603ace46d6dc9d05b330a9fd" name="a32b98be0603ace46d6dc9d05b330a9fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32b98be0603ace46d6dc9d05b330a9fd">&#9670;&#160;</a></span>Create() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Screen.html">Screen</a> Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a></td> <td class="paramname"><span class="paramname"><em>dimension</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a screen with the given dimension. </p>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00394">394</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a29a8d230cd1913d26626158fc4fc0a0c" name="a29a8d230cd1913d26626158fc4fc0a0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29a8d230cd1913d26626158fc4fc0a0c">&#9670;&#160;</a></span>Create() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Screen.html">Screen</a> Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a></td> <td class="paramname"><span class="paramname"><em>width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a></td> <td class="paramname"><span class="paramname"><em>height</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a screen with the given dimension along the x-axis and y-axis. </p>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00388">388</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a19c380b03cea21d7ac7325136a131ff0" name="a19c380b03cea21d7ac7325136a131ff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19c380b03cea21d7ac7325136a131ff0">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ToString </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produce a std::string that can be used to print the <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">Screen</a> on the terminal. </p><dl class="section note"><dt>Note</dt><dd>Don't forget to flush stdout. Alternatively, you can use <a class="el" href="classftxui_1_1Screen.html#ad93edbe885499a712129356f1ffd506b">Screen::Print()</a>; </dd></dl>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00415">415</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="ad93edbe885499a712129356f1ffd506b" name="ad93edbe885499a712129356f1ffd506b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad93edbe885499a712129356f1ffd506b">&#9670;&#160;</a></span>Print()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Print </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00452">452</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="aa71d36872f416feaa853788a7a7a7ef8" name="aa71d36872f416feaa853788a7a7a7ef8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa71d36872f416feaa853788a7a7a7ef8">&#9670;&#160;</a></span>Clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Clear </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear all the pixel from the screen. </p>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00494">494</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a9677c078c4270afdb7451cdc0b0871d4" name="a9677c078c4270afdb7451cdc0b0871d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9677c078c4270afdb7451cdc0b0871d4">&#9670;&#160;</a></span>ResetPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ResetPosition </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>clear</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string to be printed in order to reset the cursor position to the beginning of the screen. </p>
<div class="fragment"><div class="line">std::string reset_position;</div>
<div class="line"><span class="keywordflow">while</span>(<span class="keyword">true</span>) {</div>
<div class="line"> <span class="keyword">auto</span> document = render();</div>
<div class="line"> <span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">Screen::Create</a>(<a class="code hl_function" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">Dimension::Full</a>(), <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#aee138f0b60ddc07682a785f55eb5fda6">Dimension::Fit</a>(document));</div>
<div class="line"> <a class="code hl_function" href="namespaceftxui.html#ad4b8aa9392f56ba41e2b421e046a7d83">Render</a>(screen, document);</div>
<div class="line"> std::cout &lt;&lt; reset_position &lt;&lt; screen.ToString() &lt;&lt; std::flush;</div>
<div class="line"> reset_position = screen.ResetPosition();</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">using namespace </span>std::chrono_literals;</div>
<div class="line"> std::this_thread::sleep_for(0.01s);</div>
<div class="line">}</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#l00394">screen.cpp:394</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1Dimension_html_aee138f0b60ddc07682a785f55eb5fda6"><div class="ttname"><a href="namespaceftxui_1_1Dimension.html#aee138f0b60ddc07682a785f55eb5fda6">ftxui::Dimension::Fit</a></div><div class="ttdeci">Dimensions Fit(Element &amp;, bool extend_beyond_screen=false)</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_ad4b8aa9392f56ba41e2b421e046a7d83"><div class="ttname"><a href="namespaceftxui.html#ad4b8aa9392f56ba41e2b421e046a7d83">ftxui::Render</a></div><div class="ttdeci">void Render(Screen &amp;screen, const Element &amp;element)</div><div class="ttdoc">Display an element on a ftxui::Screen.</div><div class="ttdef"><b>Definition</b> <a href="node_8cpp_source.html#l00088">node.cpp:88</a></div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The string to print in order to reset the cursor position to the beginning. </dd></dl>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00475">475</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a04d18c0cb0df3ed7a01ca5c3b8711ff7" name="a04d18c0cb0df3ed7a01ca5c3b8711ff7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04d18c0cb0df3ed7a01ca5c3b8711ff7">&#9670;&#160;</a></span>ApplyShader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ApplyShader </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00506">506</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a94febaac347b83267ff6a10b7837d612" name="a94febaac347b83267ff6a10b7837d612"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94febaac347b83267ff6a10b7837d612">&#9670;&#160;</a></span>cursor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> cursor </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00064">64</a> of file <a class="el" href="screen_8hpp_source.html">screen.hpp</a>.</p>
</div>
</div>
<a id="a1aa24862a3d050b3aea2ade1300d51a7" name="a1aa24862a3d050b3aea2ade1300d51a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1aa24862a3d050b3aea2ade1300d51a7">&#9670;&#160;</a></span>SetCursor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SetCursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a></td> <td class="paramname"><span class="paramname"><em>cursor</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00065">65</a> of file <a class="el" href="screen_8hpp_source.html">screen.hpp</a>.</p>
</div>
</div>
<a id="a38015a8bc3dda474354ec8a374a6e2de" name="a38015a8bc3dda474354ec8a374a6e2de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38015a8bc3dda474354ec8a374a6e2de">&#9670;&#160;</a></span>RegisterHyperlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::uint8_t RegisterHyperlink </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>link</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00533">533</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a0b55b16969dfccc79195fe61c5ba6d1a" name="a0b55b16969dfccc79195fe61c5ba6d1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b55b16969dfccc79195fe61c5ba6d1a">&#9670;&#160;</a></span>Hyperlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string &amp; Hyperlink </td>
<td>(</td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>id</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00546">546</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a056c2ad43affdac744b6907e9ea81463" name="a056c2ad43affdac744b6907e9ea81463"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a056c2ad43affdac744b6907e9ea81463">&#9670;&#160;</a></span>GetSelectionStyle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">Screen::SelectionStyle</a> &amp; GetSelectionStyle </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current selection style. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classftxui_1_1Screen.html#aba0d30b90db17d6b7561f704ed63b5e6" title="Set the current selection style.">SetSelectionStyle</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00555">555</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="aba0d30b90db17d6b7561f704ed63b5e6" name="aba0d30b90db17d6b7561f704ed63b5e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0d30b90db17d6b7561f704ed63b5e6">&#9670;&#160;</a></span>SetSelectionStyle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SetSelectionStyle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a></td> <td class="paramname"><span class="paramname"><em>decorator</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the current selection style. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classftxui_1_1Screen.html#a056c2ad43affdac744b6907e9ea81463" title="Return the current selection style.">GetSelectionStyle</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00561">561</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
</div>
</div>
<a id="a55b0a995463c6936efb33391f29565bc" name="a55b0a995463c6936efb33391f29565bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55b0a995463c6936efb33391f29565bc">&#9670;&#160;</a></span>at() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string &amp; at </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>x</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>y</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a character in a cell at a given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The cell position along the x-axis. </td></tr>
<tr><td class="paramname">y</td><td>The cell position along the y-axis. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="image_8cpp_source.html#l00029">29</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>
</div>
</div>
<a id="a0882d58bb8ca1be9953135338456cf9e" name="a0882d58bb8ca1be9953135338456cf9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0882d58bb8ca1be9953135338456cf9e">&#9670;&#160;</a></span>at() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string &amp; at </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>x</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>y</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a character in a cell at a given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The cell position along the x-axis. </td></tr>
<tr><td class="paramname">y</td><td>The cell position along the y-axis. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="image_8cpp_source.html#l00036">36</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>
</div>
</div>
<a id="a483f8ee1967e200cfc9e277b3ce00174" name="a483f8ee1967e200cfc9e277b3ce00174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a483f8ee1967e200cfc9e277b3ce00174">&#9670;&#160;</a></span>PixelAt() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1Pixel.html">Pixel</a> &amp; PixelAt </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>x</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>y</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a cell (<a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a>) at a given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The cell position along the x-axis. </td></tr>
<tr><td class="paramname">y</td><td>The cell position along the y-axis. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="image_8cpp_source.html#l00043">43</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>
</div>
</div>
<a id="a03b2b39bb8f4d72068744776093125b3" name="a03b2b39bb8f4d72068744776093125b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03b2b39bb8f4d72068744776093125b3">&#9670;&#160;</a></span>PixelAt() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structftxui_1_1Pixel.html">Pixel</a> &amp; PixelAt </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>x</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>y</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a cell (<a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a>) at a given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The cell position along the x-axis. </td></tr>
<tr><td class="paramname">y</td><td>The cell position along the y-axis. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="image_8cpp_source.html#l00050">50</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>
</div>
</div>
<a id="ae7a460c9dacd70ed81b1adfea46b492e" name="ae7a460c9dacd70ed81b1adfea46b492e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7a460c9dacd70ed81b1adfea46b492e">&#9670;&#160;</a></span>dimx()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int dimx </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="image_8hpp_source.html#l00032">32</a> of file <a class="el" href="image_8hpp_source.html">image.hpp</a>.</p>
</div>
</div>
<a id="a0d283cfb1ec16b3fc13d344ebfea93d4" name="a0d283cfb1ec16b3fc13d344ebfea93d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d283cfb1ec16b3fc13d344ebfea93d4">&#9670;&#160;</a></span>dimy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int dimy </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="image_8hpp_source.html#l00033">33</a> of file <a class="el" href="image_8hpp_source.html">image.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="a55bfcd8369da28d548069f2761d2c39f" name="a55bfcd8369da28d548069f2761d2c39f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55bfcd8369da28d548069f2761d2c39f">&#9670;&#160;</a></span>Private</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend Private</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen__interactive_8hpp_source.html#l00162">162</a> of file <a class="el" href="screen__interactive_8hpp_source.html">screen_interactive.hpp</a>.</p>
</div>
</div>
<a id="a9df9d1ae7ed66857ca987963b2365904" name="a9df9d1ae7ed66857ca987963b2365904"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9df9d1ae7ed66857ca987963b2365904">&#9670;&#160;</a></span>cursor_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> cursor_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00077">77</a> of file <a class="el" href="screen_8hpp_source.html">screen.hpp</a>.</p>
</div>
</div>
<a id="acff83d382ef60ad2a0fca3ba68e9397f" name="acff83d382ef60ad2a0fca3ba68e9397f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acff83d382ef60ad2a0fca3ba68e9397f">&#9670;&#160;</a></span>hyperlinks_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::string&gt; hyperlinks_ = {&quot;&quot;}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00078">78</a> of file <a class="el" href="screen_8hpp_source.html">screen.hpp</a>.</p>
</div>
</div>
<a id="ab9f757d5d67255f61e27950be4131be1" name="ab9f757d5d67255f61e27950be4131be1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f757d5d67255f61e27950be4131be1">&#9670;&#160;</a></span>selection_style_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Screen.html#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> selection_style_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= [](Pixel&amp; pixel) {</div>
<div class="line"> pixel.inverted ^= <span class="keyword">true</span>;</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00081">81</a> of file <a class="el" href="screen_8hpp_source.html">screen.hpp</a>.</p>
</div>
</div>
<a id="a92cacd07ba30909855f19edc01192ff0" name="a92cacd07ba30909855f19edc01192ff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92cacd07ba30909855f19edc01192ff0">&#9670;&#160;</a></span>stencil</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1Box.html">Box</a> stencil</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="image_8hpp_source.html#l00038">38</a> of file <a class="el" href="image_8hpp_source.html">image.hpp</a>.</p>
</div>
</div>
<a id="a1b254c3faacd432c325efff4268ca683" name="a1b254c3faacd432c325efff4268ca683"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b254c3faacd432c325efff4268ca683">&#9670;&#160;</a></span>dimx_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int dimx_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="image_8hpp_source.html#l00041">41</a> of file <a class="el" href="image_8hpp_source.html">image.hpp</a>.</p>
</div>
</div>
<a id="a9e9d5df4b41aaa5eca27cdcaca6d4574" name="a9e9d5df4b41aaa5eca27cdcaca6d4574"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e9d5df4b41aaa5eca27cdcaca6d4574">&#9670;&#160;</a></span>dimy_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int dimy_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="image_8hpp_source.html#l00042">42</a> of file <a class="el" href="image_8hpp_source.html">image.hpp</a>.</p>
</div>
</div>
<a id="aeab8c1788b3f2c7403749c3be95a68ae" name="aeab8c1788b3f2c7403749c3be95a68ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeab8c1788b3f2c7403749c3be95a68ae">&#9670;&#160;</a></span>pixels_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::vector&lt;<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>&gt; &gt; pixels_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="image_8hpp_source.html#l00043">43</a> of file <a class="el" href="image_8hpp_source.html">image.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="screen__interactive_8hpp_source.html">screen_interactive.hpp</a></li>
<li><a class="el" href="screen__interactive_8cpp_source.html">screen_interactive.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.8-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="classftxui_1_1ScreenInteractive.html">ScreenInteractive</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink