Files
FTXUI/src_2ftxui_2dom_2border_8cpp.html

227 lines
17 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: border.cpp File 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('src_2ftxui_2dom_2border_8cpp.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="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">border.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="src_2ftxui_2dom_2border_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html">ftxui</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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae8537acd423d47cf07e61bd774fb1098" id="r_ae8537acd423d47cf07e61bd774fb1098"><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="namespaceftxui.html#ae8537acd423d47cf07e61bd774fb1098">border</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:ae8537acd423d47cf07e61bd774fb1098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a border around the element. <br /></td></tr>
<tr class="separator:ae8537acd423d47cf07e61bd774fb1098"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa97cfcfbe6df92dac085454395ec7b2f" id="r_aa97cfcfbe6df92dac085454395ec7b2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a164021903e9ac6f1357e4186582891e3">Decorator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#aa97cfcfbe6df92dac085454395ec7b2f">borderWith</a> (const <a class="el" href="structftxui_1_1Pixel.html">Pixel</a> &amp;pixel)</td></tr>
<tr class="memdesc:aa97cfcfbe6df92dac085454395ec7b2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as border but with a constant <a class="el" href="structftxui_1_1Pixel.html" title="A Unicode character and its associated style.">Pixel</a> around the element. <br /></td></tr>
<tr class="separator:aa97cfcfbe6df92dac085454395ec7b2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc9db79957d4dd36deb8ca79938e4c41" id="r_abc9db79957d4dd36deb8ca79938e4c41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a164021903e9ac6f1357e4186582891e3">Decorator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#abc9db79957d4dd36deb8ca79938e4c41">borderStyled</a> (<a class="el" href="namespaceftxui.html#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a> style)</td></tr>
<tr class="memdesc:abc9db79957d4dd36deb8ca79938e4c41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as border but with different styles. <br /></td></tr>
<tr class="separator:abc9db79957d4dd36deb8ca79938e4c41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1dbf36194dcb77674085df9e11c1e22" id="r_ad1dbf36194dcb77674085df9e11c1e22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a164021903e9ac6f1357e4186582891e3">Decorator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#ad1dbf36194dcb77674085df9e11c1e22">borderStyled</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> foreground_color)</td></tr>
<tr class="memdesc:ad1dbf36194dcb77674085df9e11c1e22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as border but with a foreground color. <br /></td></tr>
<tr class="separator:ad1dbf36194dcb77674085df9e11c1e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aab98b289d2e7b2ce8ca0eeee51ce78" id="r_a5aab98b289d2e7b2ce8ca0eeee51ce78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a164021903e9ac6f1357e4186582891e3">Decorator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a5aab98b289d2e7b2ce8ca0eeee51ce78">borderStyled</a> (<a class="el" href="namespaceftxui.html#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a> style, <a class="el" href="classftxui_1_1Color.html">Color</a> foreground_color)</td></tr>
<tr class="memdesc:a5aab98b289d2e7b2ce8ca0eeee51ce78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as border but with a foreground color and a different style. <br /></td></tr>
<tr class="separator:a5aab98b289d2e7b2ce8ca0eeee51ce78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a181c80f8ada12d1356f6bfa0ebb7219f" id="r_a181c80f8ada12d1356f6bfa0ebb7219f"><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="namespaceftxui.html#a181c80f8ada12d1356f6bfa0ebb7219f">borderDashed</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:a181c80f8ada12d1356f6bfa0ebb7219f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a dashed border around the element. <br /></td></tr>
<tr class="separator:a181c80f8ada12d1356f6bfa0ebb7219f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa074cdab57eeb47b99f1699bcc8addd8" id="r_aa074cdab57eeb47b99f1699bcc8addd8"><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="namespaceftxui.html#aa074cdab57eeb47b99f1699bcc8addd8">borderLight</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:aa074cdab57eeb47b99f1699bcc8addd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a light border around the element. <br /></td></tr>
<tr class="separator:aa074cdab57eeb47b99f1699bcc8addd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a666c31419cc31cdadc9f8178ed63529e" id="r_a666c31419cc31cdadc9f8178ed63529e"><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="namespaceftxui.html#a666c31419cc31cdadc9f8178ed63529e">borderHeavy</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:a666c31419cc31cdadc9f8178ed63529e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a heavy border around the element. <br /></td></tr>
<tr class="separator:a666c31419cc31cdadc9f8178ed63529e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a052b504344f3bc1ff86b3493cd934215" id="r_a052b504344f3bc1ff86b3493cd934215"><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="namespaceftxui.html#a052b504344f3bc1ff86b3493cd934215">borderDouble</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:a052b504344f3bc1ff86b3493cd934215"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a double border around the element. <br /></td></tr>
<tr class="separator:a052b504344f3bc1ff86b3493cd934215"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cf2db223a5efaa370f0ca6bb405b80e" id="r_a3cf2db223a5efaa370f0ca6bb405b80e"><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="namespaceftxui.html#a3cf2db223a5efaa370f0ca6bb405b80e">borderRounded</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:a3cf2db223a5efaa370f0ca6bb405b80e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw a rounded border around the element. <br /></td></tr>
<tr class="separator:a3cf2db223a5efaa370f0ca6bb405b80e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af20f7d6fb275d109f0bdc01a2e4d3f3e" id="r_af20f7d6fb275d109f0bdc01a2e4d3f3e"><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="namespaceftxui.html#af20f7d6fb275d109f0bdc01a2e4d3f3e">borderEmpty</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
<tr class="memdesc:af20f7d6fb275d109f0bdc01a2e4d3f3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw an empty border around the element. <br /></td></tr>
<tr class="separator:af20f7d6fb275d109f0bdc01a2e4d3f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03049def08fa7a5eaa4d5e897152bc1a" id="r_a03049def08fa7a5eaa4d5e897152bc1a"><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="namespaceftxui.html#a03049def08fa7a5eaa4d5e897152bc1a">window</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> title, <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> content, <a class="el" href="namespaceftxui.html#afe3103dd0b8240c5443892484ef5af9c">BorderStyle</a> <a class="el" href="namespaceftxui.html#ae8537acd423d47cf07e61bd774fb1098">border</a>)</td></tr>
<tr class="memdesc:a03049def08fa7a5eaa4d5e897152bc1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw window with a title and a border around the element. <br /></td></tr>
<tr class="separator:a03049def08fa7a5eaa4d5e897152bc1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a108d200440dbd1759a7b025709c2d321" name="a108d200440dbd1759a7b025709c2d321"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a108d200440dbd1759a7b025709c2d321">&#9670;&#160;</a></span>charset_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Charset&amp; charset_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2border_8cpp_source.html#l00045">45</a> of file <a class="el" href="src_2ftxui_2dom_2border_8cpp_source.html">src/ftxui/dom/border.cpp</a>.</p>
</div>
</div>
<a id="ab929ed9438df4a818e56490a23d8324e" name="ab929ed9438df4a818e56490a23d8324e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab929ed9438df4a818e56490a23d8324e">&#9670;&#160;</a></span>foreground_color_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt;Color&gt; foreground_color_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2border_8cpp_source.html#l00046">46</a> of file <a class="el" href="src_2ftxui_2dom_2border_8cpp_source.html">src/ftxui/dom/border.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.8-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aca3139ef08e710186b498ba0b7d3b1a.html">ftxui</a></li><li class="navelem"><a class="el" href="dir_8b052a5e35b6e4510790af7766fda6cf.html">dom</a></li><li class="navelem"><a class="el" href="src_2ftxui_2dom_2border_8cpp.html">border.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>