mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
1025 lines
57 KiB
HTML
1025 lines
57 KiB
HTML
<!-- HTML header for doxygen 1.9.8-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.12.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FTXUI: Screen 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"> 6.1.9</span>
|
|
</div>
|
|
<div id="projectbrief">C++ functional terminal UI.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classftxui_1_1Screen.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> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Data Fields</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> </div>
|
|
<div class="headertitle"><div class="title">Screen Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A rectangular grid of <a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a>.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="screen_8hpp_source.html">screen.hpp</a>></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 Screen:</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_1Screen__inherit__graph.png" border="0" usemap="#aScreen_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aScreen_inherit__map" id="aScreen_inherit__map">
|
|
<area shape="rect" title="A rectangular grid of Pixel." alt="" coords="40,79,107,104"/>
|
|
<area shape="rect" href="classftxui_1_1ScreenInteractive.html" title=" " alt="" coords="5,152,141,177"/>
|
|
<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 Screen:</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_1Screen__coll__graph.png" border="0" usemap="#aScreen_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aScreen_coll__map" id="aScreen_coll__map">
|
|
<area shape="rect" title="A rectangular grid of Pixel." alt="" coords="47,181,114,207"/>
|
|
<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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> = std::function<void(<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>&)></td></tr>
|
|
<tr class="separator:a0424ec9a980000671f12bfa39fc32273"><td class="memSeparator" colspan="2"> </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:a7ecf7c5fb3d90a1620098a60cfafc215" id="r_a7ecf7c5fb3d90a1620098a60cfafc215"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ecf7c5fb3d90a1620098a60cfafc215">Screen</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:a7ecf7c5fb3d90a1620098a60cfafc215"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19c380b03cea21d7ac7325136a131ff0" id="r_a19c380b03cea21d7ac7325136a131ff0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a19c380b03cea21d7ac7325136a131ff0">ToString</a> () const</td></tr>
|
|
<tr class="separator:a19c380b03cea21d7ac7325136a131ff0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad93edbe885499a712129356f1ffd506b" id="r_ad93edbe885499a712129356f1ffd506b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad93edbe885499a712129356f1ffd506b">Print</a> () const</td></tr>
|
|
<tr class="separator:ad93edbe885499a712129356f1ffd506b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa71d36872f416feaa853788a7a7a7ef8" id="r_aa71d36872f416feaa853788a7a7a7ef8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa71d36872f416feaa853788a7a7a7ef8">Clear</a> ()</td></tr>
|
|
<tr class="memdesc:aa71d36872f416feaa853788a7a7a7ef8"><td class="mdescLeft"> </td><td class="mdescRight">Clear all the pixel from the screen. <br /></td></tr>
|
|
<tr class="separator:aa71d36872f416feaa853788a7a7a7ef8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9677c078c4270afdb7451cdc0b0871d4" id="r_a9677c078c4270afdb7451cdc0b0871d4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9677c078c4270afdb7451cdc0b0871d4">ResetPosition</a> (bool clear=false) const</td></tr>
|
|
<tr class="memdesc:a9677c078c4270afdb7451cdc0b0871d4"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a04d18c0cb0df3ed7a01ca5c3b8711ff7" id="r_a04d18c0cb0df3ed7a01ca5c3b8711ff7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a04d18c0cb0df3ed7a01ca5c3b8711ff7">ApplyShader</a> ()</td></tr>
|
|
<tr class="separator:a04d18c0cb0df3ed7a01ca5c3b8711ff7"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a94febaac347b83267ff6a10b7837d612">cursor</a> () const</td></tr>
|
|
<tr class="separator:a94febaac347b83267ff6a10b7837d612"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1aa24862a3d050b3aea2ade1300d51a7" id="r_a1aa24862a3d050b3aea2ade1300d51a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1aa24862a3d050b3aea2ade1300d51a7">SetCursor</a> (<a class="el" href="structftxui_1_1Screen_1_1Cursor.html">Cursor</a> <a class="el" href="#a94febaac347b83267ff6a10b7837d612">cursor</a>)</td></tr>
|
|
<tr class="separator:a1aa24862a3d050b3aea2ade1300d51a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38015a8bc3dda474354ec8a374a6e2de" id="r_a38015a8bc3dda474354ec8a374a6e2de"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a38015a8bc3dda474354ec8a374a6e2de">RegisterHyperlink</a> (const std::string &link)</td></tr>
|
|
<tr class="separator:a38015a8bc3dda474354ec8a374a6e2de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b55b16969dfccc79195fe61c5ba6d1a" id="r_a0b55b16969dfccc79195fe61c5ba6d1a"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b55b16969dfccc79195fe61c5ba6d1a">Hyperlink</a> (uint8_t id) const</td></tr>
|
|
<tr class="separator:a0b55b16969dfccc79195fe61c5ba6d1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a056c2ad43affdac744b6907e9ea81463" id="r_a056c2ad43affdac744b6907e9ea81463"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a056c2ad43affdac744b6907e9ea81463">GetSelectionStyle</a> () const</td></tr>
|
|
<tr class="memdesc:a056c2ad43affdac744b6907e9ea81463"><td class="mdescLeft"> </td><td class="mdescRight">Return the current selection style. <br /></td></tr>
|
|
<tr class="separator:a056c2ad43affdac744b6907e9ea81463"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba0d30b90db17d6b7561f704ed63b5e6" id="r_aba0d30b90db17d6b7561f704ed63b5e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aba0d30b90db17d6b7561f704ed63b5e6">SetSelectionStyle</a> (<a class="el" href="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> decorator)</td></tr>
|
|
<tr class="memdesc:aba0d30b90db17d6b7561f704ed63b5e6"><td class="mdescLeft"> </td><td class="mdescRight">Set the current selection style. <br /></td></tr>
|
|
<tr class="separator:aba0d30b90db17d6b7561f704ed63b5e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55b0a995463c6936efb33391f29565bc" id="r_a55b0a995463c6936efb33391f29565bc"><td class="memItemLeft" align="right" valign="top">std::string & </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"> </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"> </td></tr>
|
|
<tr class="memitem:a0882d58bb8ca1be9953135338456cf9e" id="r_a0882d58bb8ca1be9953135338456cf9e"><td class="memItemLeft" align="right" valign="top">const std::string & </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"> </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"> </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> & </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"> </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"> </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> & </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"> </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"> </td></tr>
|
|
<tr class="memitem:ae7a460c9dacd70ed81b1adfea46b492e" id="r_ae7a460c9dacd70ed81b1adfea46b492e"><td class="memItemLeft" align="right" valign="top">int </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"> </td></tr>
|
|
<tr class="memitem:a0d283cfb1ec16b3fc13d344ebfea93d4" id="r_a0d283cfb1ec16b3fc13d344ebfea93d4"><td class="memItemLeft" align="right" valign="top">int </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"> </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:a32b98be0603ace46d6dc9d05b330a9fd" id="r_a32b98be0603ace46d6dc9d05b330a9fd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classftxui_1_1Screen.html">Screen</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a32b98be0603ace46d6dc9d05b330a9fd">Create</a> (<a class="el" href="structftxui_1_1Dimensions.html">Dimensions</a> dimension)</td></tr>
|
|
<tr class="memdesc:a32b98be0603ace46d6dc9d05b330a9fd"><td class="mdescLeft"> </td><td class="mdescRight">Create a screen with the given dimension. <br /></td></tr>
|
|
<tr class="separator:a32b98be0603ace46d6dc9d05b330a9fd"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="#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"> </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"> </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:a92cacd07ba30909855f19edc01192ff0" id="r_a92cacd07ba30909855f19edc01192ff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1Box.html">Box</a> </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9df9d1ae7ed66857ca987963b2365904">cursor_</a></td></tr>
|
|
<tr class="separator:a9df9d1ae7ed66857ca987963b2365904"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acff83d382ef60ad2a0fca3ba68e9397f" id="r_acff83d382ef60ad2a0fca3ba68e9397f"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#acff83d382ef60ad2a0fca3ba68e9397f">hyperlinks_</a> = {""}</td></tr>
|
|
<tr class="separator:acff83d382ef60ad2a0fca3ba68e9397f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9f757d5d67255f61e27950be4131be1" id="r_ab9f757d5d67255f61e27950be4131be1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9f757d5d67255f61e27950be4131be1">selection_style_</a></td></tr>
|
|
<tr class="separator:ab9f757d5d67255f61e27950be4131be1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b254c3faacd432c325efff4268ca683" id="r_a1b254c3faacd432c325efff4268ca683"><td class="memItemLeft" align="right" valign="top">int </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"> </td></tr>
|
|
<tr class="memitem:a9e9d5df4b41aaa5eca27cdcaca6d4574" id="r_a9e9d5df4b41aaa5eca27cdcaca6d4574"><td class="memItemLeft" align="right" valign="top">int </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"> </td></tr>
|
|
<tr class="memitem:aeab8c1788b3f2c7403749c3be95a68ae" id="r_aeab8c1788b3f2c7403749c3be95a68ae"><td class="memItemLeft" align="right" valign="top">std::vector< std::vector< <a class="el" href="structftxui_1_1Pixel.html">Pixel</a> > > </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"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A rectangular grid of <a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a>. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2dom_2dbox_8cpp-example.html#_a1">examples/dom/dbox.cpp</a>, <a class="el" href="examples_2dom_2gauge_8cpp-example.html#_a1">examples/dom/gauge.cpp</a>, and <a class="el" href="examples_2dom_2gauge_direction_8cpp-example.html#_a3">examples/dom/gauge_direction.cpp</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="screen_8hpp_source.html#l00027">27</a> of file <a class="el" href="screen_8hpp_source.html">screen.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">◆ </a></span>SelectionStyle</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> = std::function<void(<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>&)></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">Constructor & Destructor Documentation</h2>
|
|
<a id="a7ecf7c5fb3d90a1620098a60cfafc215" name="a7ecf7c5fb3d90a1620098a60cfafc215"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ecf7c5fb3d90a1620098a60cfafc215">◆ </a></span>Screen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classftxui_1_1Screen.html">Screen</a> </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> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00398">398</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a32b98be0603ace46d6dc9d05b330a9fd" name="a32b98be0603ace46d6dc9d05b330a9fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32b98be0603ace46d6dc9d05b330a9fd">◆ </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> </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">◆ </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> )</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 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">◆ </a></span>ToString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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>
|
|
</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="#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">◆ </a></span>Print()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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>
|
|
</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">◆ </a></span>Clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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>
|
|
</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">◆ </a></span>ResetPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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>
|
|
</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="#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 << reset_position << screen.ToString() << 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="#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 &, 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 &screen, const Element &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">◆ </a></span>ApplyShader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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>
|
|
</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">◆ </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> </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">◆ </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> </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">◆ </a></span>RegisterHyperlink()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::uint8_t RegisterHyperlink </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>link</em></span></td><td>)</td>
|
|
<td></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">◆ </a></span>Hyperlink()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string & 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>
|
|
</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">◆ </a></span>GetSelectionStyle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#a0424ec9a980000671f12bfa39fc32273">Screen::SelectionStyle</a> & GetSelectionStyle </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the current selection style. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#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">◆ </a></span>SetSelectionStyle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetSelectionStyle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a></td> <td class="paramname"><span class="paramname"><em>decorator</em></span></td><td>)</td>
|
|
<td></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="#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">◆ </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 & 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> )</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">◆ </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 & 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> ) 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">◆ </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> & 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> )</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">◆ </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> & 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> ) 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">◆ </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">◆ </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="a9df9d1ae7ed66857ca987963b2365904" name="a9df9d1ae7ed66857ca987963b2365904"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9df9d1ae7ed66857ca987963b2365904">◆ </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> </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">◆ </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<std::string> hyperlinks_ = {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="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">◆ </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="#a0424ec9a980000671f12bfa39fc32273">SelectionStyle</a> selection_style_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= [](Pixel& 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">◆ </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">◆ </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">◆ </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">◆ </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<std::vector<<a class="el" href="structftxui_1_1Pixel.html">Pixel</a>> > 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_8hpp_source.html">screen.hpp</a></li>
|
|
<li><a class="el" href="screen_8cpp_source.html">screen.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_1Screen.html">Screen</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>
|