Files
FTXUI/frame_8cpp.html
2025-04-30 10:23:00 +00:00

155 lines
14 KiB
HTML

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="cache-control" content="max-age=86400"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FTXUI: src/ftxui/dom/frame.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FTXUI
&#160;<span id="projectnumber">6.1.1</span>
</div>
<div id="projectbrief">C++ functional terminal UI.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(document).ready(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 */
$(document).ready(function(){initNavTree('frame_8cpp.html',''); initResizable(); });
/* @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">frame.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="frame_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:namespaceftxui" id="r_namespaceftxui"><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:aa2d7d671f184f85e0f396f2610fa6c2e" id="r_aa2d7d671f184f85e0f396f2610fa6c2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#aa2d7d671f184f85e0f396f2610fa6c2e">focus</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:aa2d7d671f184f85e0f396f2610fa6c2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the <code>child</code> to be the one focused among its siblings. <br /></td></tr>
<tr class="separator:aa2d7d671f184f85e0f396f2610fa6c2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e3e2988ed61a129d82d634ad66f7eb1" id="r_a9e3e2988ed61a129d82d634ad66f7eb1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a9e3e2988ed61a129d82d634ad66f7eb1">select</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a9e3e2988ed61a129d82d634ad66f7eb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the <code>child</code> to be the one focused among its siblings. <br /></td></tr>
<tr class="separator:a9e3e2988ed61a129d82d634ad66f7eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0d6a96f6e1fb6d67d9fa6323062a737" id="r_ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#ad0d6a96f6e1fb6d67d9fa6323062a737">frame</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible. <br /></td></tr>
<tr class="separator:ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d0617c0912b732f059cf360ac951c49" id="r_a2d0617c0912b732f059cf360ac951c49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a2d0617c0912b732f059cf360ac951c49">xframe</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a2d0617c0912b732f059cf360ac951c49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>frame</code>, but only on the x-axis. <br /></td></tr>
<tr class="separator:a2d0617c0912b732f059cf360ac951c49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ea9d3ceb2a977955125c6e4a6072325" id="r_a7ea9d3ceb2a977955125c6e4a6072325"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a7ea9d3ceb2a977955125c6e4a6072325">yframe</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a7ea9d3ceb2a977955125c6e4a6072325"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>frame</code>, but only on the y-axis. <br /></td></tr>
<tr class="separator:a7ea9d3ceb2a977955125c6e4a6072325"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a509ef7e7f8913ea3de7efd45e3301ea1" id="r_a509ef7e7f8913ea3de7efd45e3301ea1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a509ef7e7f8913ea3de7efd45e3301ea1">focusCursorBlock</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a509ef7e7f8913ea3de7efd45e3301ea1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>focus</code>, but set the cursor shape to be a still block. <br /></td></tr>
<tr class="separator:a509ef7e7f8913ea3de7efd45e3301ea1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adda589914ba8fe863c905b6566557768" id="r_adda589914ba8fe863c905b6566557768"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#adda589914ba8fe863c905b6566557768">focusCursorBlockBlinking</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:adda589914ba8fe863c905b6566557768"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>focus</code>, but set the cursor shape to be a blinking block. <br /></td></tr>
<tr class="separator:adda589914ba8fe863c905b6566557768"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f89e72e7001064e3eb8189c8317e95b" id="r_a4f89e72e7001064e3eb8189c8317e95b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a4f89e72e7001064e3eb8189c8317e95b">focusCursorBar</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a4f89e72e7001064e3eb8189c8317e95b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>focus</code>, but set the cursor shape to be a still block. <br /></td></tr>
<tr class="separator:a4f89e72e7001064e3eb8189c8317e95b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a085a7c997e7364c5a54e73c7b84145db" id="r_a085a7c997e7364c5a54e73c7b84145db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a085a7c997e7364c5a54e73c7b84145db">focusCursorBarBlinking</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a085a7c997e7364c5a54e73c7b84145db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>focus</code>, but set the cursor shape to be a blinking bar. <br /></td></tr>
<tr class="separator:a085a7c997e7364c5a54e73c7b84145db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e1fe02a18c2b18e31ccc9cd3943823" id="r_a61e1fe02a18c2b18e31ccc9cd3943823"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a61e1fe02a18c2b18e31ccc9cd3943823">focusCursorUnderline</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a61e1fe02a18c2b18e31ccc9cd3943823"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>focus</code>, but set the cursor shape to be a still underline. <br /></td></tr>
<tr class="separator:a61e1fe02a18c2b18e31ccc9cd3943823"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33637d59d1e52aa06dd2a94162adbfe9" id="r_a33637d59d1e52aa06dd2a94162adbfe9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a33637d59d1e52aa06dd2a94162adbfe9">focusCursorUnderlineBlinking</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">child</a>)</td></tr>
<tr class="memdesc:a33637d59d1e52aa06dd2a94162adbfe9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <code>focus</code>, but set the cursor shape to be a blinking underline. <br /></td></tr>
<tr class="separator:a33637d59d1e52aa06dd2a94162adbfe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
</body>
</html>