mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-06-23 23:41:13 +08:00
258 lines
18 KiB
HTML
258 lines
18 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: 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>
|
|
<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="module">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
await new Promise(r => window.addEventListener('DOMContentLoaded', r));
|
|
// Remove title when a img[alt='title-img'] is present.
|
|
// Find an image with the alt "img-title".
|
|
const img = document.querySelector("img[alt='title-img']");
|
|
const header = document.querySelector(".headertitle");
|
|
if (img && header) {
|
|
// Hide the header title progressively.
|
|
header.style.display = "none";
|
|
// Show progressively the image.
|
|
img.style.maxHeight = "40vh";
|
|
img.style.maxWidth = "100%";
|
|
img.style.objectFit = "contain";
|
|
}
|
|
// In the "examples.html" page. Turn every link with text
|
|
// "examples/<...>
|
|
//
|
|
// Add a "demo" link toward.
|
|
// https://arthursonzogni.github.io/FTXUI/examples/?file=<...>
|
|
const examples = document.querySelectorAll("a")
|
|
examples.forEach((example) => {
|
|
if (!example.textContent.startsWith("examples/")) {
|
|
return;
|
|
}
|
|
// Remove the ".cpp" extension from the example name.
|
|
const exampleName = example.textContent.replace("examples/", "").replace(".cpp", "");
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + exampleName;
|
|
a.style.marginRight= "1em";
|
|
a.style.fontWeight = "bold";
|
|
example.parentElement.insertBefore(a, example)
|
|
});
|
|
// If the current URL ends with -example.html, we can add a link to the demo
|
|
// as well using the div.title textContent.
|
|
const url = new URL(window.location.href);
|
|
if (url.pathname.endsWith("-example.html")) {
|
|
// Get the title text.
|
|
const title = document.querySelector("div.title").textContent;
|
|
const example = title.replace("examples/", "").replace(".cpp", "");
|
|
// Create a link to the demo.
|
|
const a = document.createElement("a");
|
|
a.textContent = "[demo]";
|
|
a.href = "https://arthursonzogni.github.io/FTXUI/examples/?file=" + example;
|
|
a.style.marginLeft = "1em";
|
|
a.style.fontWeight = "bold";
|
|
a.style.display = "inline-block";
|
|
// Insert the link after the title.
|
|
const titleDiv = document.querySelector("div.title");
|
|
if (titleDiv) {
|
|
titleDiv.insertBefore(a, titleDiv.nextSibling);
|
|
}
|
|
}
|
|
</script>
|
|
<script type="module">
|
|
// Click on the navtree, except for the main page where this is already done
|
|
// automatically.
|
|
let delay = 0;
|
|
while(true) {
|
|
const navtree = document.querySelector("div.item.selected");
|
|
if (!navtree) {
|
|
delay *= 2;
|
|
delay += 1;
|
|
await new Promise(resolve => setTimeout(resolve, delay));
|
|
continue;
|
|
}
|
|
// Include only selected navtree items.
|
|
console.log("navtree.textContent", navtree.textContent);
|
|
if (!navtree.textContent.includes("Getting Started") &&
|
|
!navtree.textContent.includes("Installation") &&
|
|
!navtree.textContent.includes("ftxui / screen") &&
|
|
!navtree.textContent.includes("ftxui / dom") &&
|
|
!navtree.textContent.includes("ftxui / component") &&
|
|
!navtree.textContent.includes("Reference")) {
|
|
break;
|
|
}
|
|
// Find the first link inside the navtree.
|
|
const link = navtree.querySelector("a");
|
|
if (link) {
|
|
// Simulate a click on the link.
|
|
link.click();
|
|
break;
|
|
}
|
|
}
|
|
</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('frame_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> |
|
|
<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:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html">ftxui</a></td></tr>
|
|
<tr class="memdesc:namespaceftxui"><td class="mdescLeft"> </td><td class="mdescRight">The FTXUI ftxui:: namespace. <br /></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="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaa2d7d671f184f85e0f396f2610fa6c2e" id="r_gaa2d7d671f184f85e0f396f2610fa6c2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#gaa2d7d671f184f85e0f396f2610fa6c2e">focus</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:gaa2d7d671f184f85e0f396f2610fa6c2e"><td class="mdescLeft"> </td><td class="mdescRight">Set the <code>child</code> to be the one focused among its siblings. <br /></td></tr>
|
|
<tr class="separator:gaa2d7d671f184f85e0f396f2610fa6c2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e3e2988ed61a129d82d634ad66f7eb1" id="r_a9e3e2988ed61a129d82d634ad66f7eb1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a9e3e2988ed61a129d82d634ad66f7eb1">select</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:a9e3e2988ed61a129d82d634ad66f7eb1"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:ad0d6a96f6e1fb6d67d9fa6323062a737" id="r_ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#ad0d6a96f6e1fb6d67d9fa6323062a737">frame</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:ad0d6a96f6e1fb6d67d9fa6323062a737"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a2d0617c0912b732f059cf360ac951c49" id="r_a2d0617c0912b732f059cf360ac951c49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a2d0617c0912b732f059cf360ac951c49">xframe</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:a2d0617c0912b732f059cf360ac951c49"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a7ea9d3ceb2a977955125c6e4a6072325" id="r_a7ea9d3ceb2a977955125c6e4a6072325"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui.html#a7ea9d3ceb2a977955125c6e4a6072325">yframe</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:a7ea9d3ceb2a977955125c6e4a6072325"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:ga509ef7e7f8913ea3de7efd45e3301ea1" id="r_ga509ef7e7f8913ea3de7efd45e3301ea1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#ga509ef7e7f8913ea3de7efd45e3301ea1">focusCursorBlock</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:ga509ef7e7f8913ea3de7efd45e3301ea1"><td class="mdescLeft"> </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:ga509ef7e7f8913ea3de7efd45e3301ea1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadda589914ba8fe863c905b6566557768" id="r_gadda589914ba8fe863c905b6566557768"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#gadda589914ba8fe863c905b6566557768">focusCursorBlockBlinking</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:gadda589914ba8fe863c905b6566557768"><td class="mdescLeft"> </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:gadda589914ba8fe863c905b6566557768"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4f89e72e7001064e3eb8189c8317e95b" id="r_ga4f89e72e7001064e3eb8189c8317e95b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#ga4f89e72e7001064e3eb8189c8317e95b">focusCursorBar</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:ga4f89e72e7001064e3eb8189c8317e95b"><td class="mdescLeft"> </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:ga4f89e72e7001064e3eb8189c8317e95b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga085a7c997e7364c5a54e73c7b84145db" id="r_ga085a7c997e7364c5a54e73c7b84145db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#ga085a7c997e7364c5a54e73c7b84145db">focusCursorBarBlinking</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:ga085a7c997e7364c5a54e73c7b84145db"><td class="mdescLeft"> </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:ga085a7c997e7364c5a54e73c7b84145db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga61e1fe02a18c2b18e31ccc9cd3943823" id="r_ga61e1fe02a18c2b18e31ccc9cd3943823"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#ga61e1fe02a18c2b18e31ccc9cd3943823">focusCursorUnderline</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:ga61e1fe02a18c2b18e31ccc9cd3943823"><td class="mdescLeft"> </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:ga61e1fe02a18c2b18e31ccc9cd3943823"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga33637d59d1e52aa06dd2a94162adbfe9" id="r_ga33637d59d1e52aa06dd2a94162adbfe9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dom.html#ga33637d59d1e52aa06dd2a94162adbfe9">focusCursorUnderlineBlinking</a> (<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a> child)</td></tr>
|
|
<tr class="memdesc:ga33637d59d1e52aa06dd2a94162adbfe9"><td class="mdescLeft"> </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:ga33637d59d1e52aa06dd2a94162adbfe9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</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="frame_8cpp.html">frame.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>
|