Files
FTXUI/structftxui_1_1WindowRenderState.html

348 lines
18 KiB
HTML
Raw Normal View 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: WindowRenderState Struct 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('structftxui_1_1WindowRenderState.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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">WindowRenderState Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>&gt;</code></p>
<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:a5486612c1fe0c8651fbb399ac512fccf" id="r_a5486612c1fe0c8651fbb399ac512fccf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5486612c1fe0c8651fbb399ac512fccf">inner</a></td></tr>
<tr class="memdesc:a5486612c1fe0c8651fbb399ac512fccf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The element wrapped inside this window. <br /></td></tr>
<tr class="separator:a5486612c1fe0c8651fbb399ac512fccf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32309346e2ae5546e342e991d0a53b37" id="r_a32309346e2ae5546e342e991d0a53b37"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a32309346e2ae5546e342e991d0a53b37">title</a></td></tr>
<tr class="memdesc:a32309346e2ae5546e342e991d0a53b37"><td class="mdescLeft">&#160;</td><td class="mdescRight">The title of the window. <br /></td></tr>
<tr class="separator:a32309346e2ae5546e342e991d0a53b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c996f9fcf0e10baeb3e700be0c409a" id="r_a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03c996f9fcf0e10baeb3e700be0c409a">active</a> = false</td></tr>
<tr class="memdesc:a03c996f9fcf0e10baeb3e700be0c409a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the window is the active one. <br /></td></tr>
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2104e875bdb7c78a8bf7dfd3728459c5" id="r_a2104e875bdb7c78a8bf7dfd3728459c5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2104e875bdb7c78a8bf7dfd3728459c5">drag</a> = false</td></tr>
<tr class="memdesc:a2104e875bdb7c78a8bf7dfd3728459c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the window is being dragged. <br /></td></tr>
<tr class="separator:a2104e875bdb7c78a8bf7dfd3728459c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47beb6819c84c39255cb60f5710714ce" id="r_a47beb6819c84c39255cb60f5710714ce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a47beb6819c84c39255cb60f5710714ce">resize</a> = false</td></tr>
<tr class="memdesc:a47beb6819c84c39255cb60f5710714ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the window is being resized. <br /></td></tr>
<tr class="separator:a47beb6819c84c39255cb60f5710714ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abca2d427dd57d2b5eecb6685ed68e857" id="r_abca2d427dd57d2b5eecb6685ed68e857"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abca2d427dd57d2b5eecb6685ed68e857">hover_left</a> = false</td></tr>
<tr class="memdesc:abca2d427dd57d2b5eecb6685ed68e857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the resizeable left side is hovered. <br /></td></tr>
<tr class="separator:abca2d427dd57d2b5eecb6685ed68e857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e6af441e03d44f593bcb0d17ee809b1" id="r_a8e6af441e03d44f593bcb0d17ee809b1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e6af441e03d44f593bcb0d17ee809b1">hover_right</a> = false</td></tr>
<tr class="memdesc:a8e6af441e03d44f593bcb0d17ee809b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the resizeable right side is hovered. <br /></td></tr>
<tr class="separator:a8e6af441e03d44f593bcb0d17ee809b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb4dc002e621733f1e6c232f369af8ca" id="r_acb4dc002e621733f1e6c232f369af8ca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acb4dc002e621733f1e6c232f369af8ca">hover_top</a> = false</td></tr>
<tr class="memdesc:acb4dc002e621733f1e6c232f369af8ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the resizeable top side is hovered. <br /></td></tr>
<tr class="separator:acb4dc002e621733f1e6c232f369af8ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fbfe3e43b596c8a47c5548b38e4d721" id="r_a2fbfe3e43b596c8a47c5548b38e4d721"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2fbfe3e43b596c8a47c5548b38e4d721">hover_down</a> = false</td></tr>
<tr class="memdesc:a2fbfe3e43b596c8a47c5548b38e4d721"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the resizeable down side is hovered. <br /></td></tr>
<tr class="separator:a2fbfe3e43b596c8a47c5548b38e4d721"><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="component__options_8hpp_source.html#l00234">234</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a5486612c1fe0c8651fbb399ac512fccf" name="a5486612c1fe0c8651fbb399ac512fccf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5486612c1fe0c8651fbb399ac512fccf">&#9670;&#160;</a></span>inner</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> inner</td>
</tr>
</table>
</div><div class="memdoc">
<p>The element wrapped inside this window. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00235">235</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a32309346e2ae5546e342e991d0a53b37" name="a32309346e2ae5546e342e991d0a53b37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32309346e2ae5546e342e991d0a53b37">&#9670;&#160;</a></span>title</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; title</td>
</tr>
</table>
</div><div class="memdoc">
<p>The title of the window. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00236">236</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a03c996f9fcf0e10baeb3e700be0c409a" name="a03c996f9fcf0e10baeb3e700be0c409a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03c996f9fcf0e10baeb3e700be0c409a">&#9670;&#160;</a></span>active</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool active = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the window is the active one. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00237">237</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a2104e875bdb7c78a8bf7dfd3728459c5" name="a2104e875bdb7c78a8bf7dfd3728459c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2104e875bdb7c78a8bf7dfd3728459c5">&#9670;&#160;</a></span>drag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool drag = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the window is being dragged. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00238">238</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a47beb6819c84c39255cb60f5710714ce" name="a47beb6819c84c39255cb60f5710714ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47beb6819c84c39255cb60f5710714ce">&#9670;&#160;</a></span>resize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool resize = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the window is being resized. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00239">239</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="abca2d427dd57d2b5eecb6685ed68e857" name="abca2d427dd57d2b5eecb6685ed68e857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abca2d427dd57d2b5eecb6685ed68e857">&#9670;&#160;</a></span>hover_left</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hover_left = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the resizeable left side is hovered. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00240">240</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a8e6af441e03d44f593bcb0d17ee809b1" name="a8e6af441e03d44f593bcb0d17ee809b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e6af441e03d44f593bcb0d17ee809b1">&#9670;&#160;</a></span>hover_right</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hover_right = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the resizeable right side is hovered. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00241">241</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="acb4dc002e621733f1e6c232f369af8ca" name="acb4dc002e621733f1e6c232f369af8ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb4dc002e621733f1e6c232f369af8ca">&#9670;&#160;</a></span>hover_top</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hover_top = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the resizeable top side is hovered. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00242">242</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a2fbfe3e43b596c8a47c5548b38e4d721" name="a2fbfe3e43b596c8a47c5548b38e4d721"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fbfe3e43b596c8a47c5548b38e4d721">&#9670;&#160;</a></span>hover_down</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hover_down = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the resizeable down side is hovered. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00243">243</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="component__options_8hpp_source.html">component_options.hpp</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="structftxui_1_1WindowRenderState.html">WindowRenderState</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>