mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
204 lines
10 KiB
HTML
204 lines
10 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: ftxui::Dimension Namespace 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
|
||
|
|
 <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&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&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&dn=expat.txt MIT */
|
||
|
|
$(document).ready(function(){initNavTree('namespaceftxui_1_1Dimension.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="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">ftxui::Dimension Namespace Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Define how the <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">Screen</a>'s dimensions should look like.
|
||
|
|
<a href="namespaceftxui_1_1Dimension.html#details">More...</a></p>
|
||
|
|
<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:aee138f0b60ddc07682a785f55eb5fda6" id="r_aee138f0b60ddc07682a785f55eb5fda6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1Dimension.html#aee138f0b60ddc07682a785f55eb5fda6">Fit</a> (<a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> &, <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">bool</a> <a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">extend_beyond_screen</a>=<a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">false</a>)</td></tr>
|
||
|
|
<tr class="separator:aee138f0b60ddc07682a785f55eb5fda6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a36e539ed36f88d7f01233974da485937" id="r_a36e539ed36f88d7f01233974da485937"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">Fixed</a> (<a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">int</a>)</td></tr>
|
||
|
|
<tr class="separator:a36e539ed36f88d7f01233974da485937"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af795790b995132f62de607ddfd07f9fa" id="r_af795790b995132f62de607ddfd07f9fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">Full</a> ()</td></tr>
|
||
|
|
<tr class="separator:af795790b995132f62de607ddfd07f9fa"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Define how the <a class="el" href="classftxui_1_1Screen.html" title="A rectangular grid of Pixel.">Screen</a>'s dimensions should look like. </p>
|
||
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="aee138f0b60ddc07682a785f55eb5fda6" name="aee138f0b60ddc07682a785f55eb5fda6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee138f0b60ddc07682a785f55eb5fda6">◆ </a></span>Fit()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> Fit </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a26a62b91b796ce76a5582cf194da3fb2">Element</a> & </td>
|
||
|
|
<td class="paramname"><em>e</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">bool</a> </td>
|
||
|
|
<td class="paramname"><em>extend_beyond_screen</em> = <code><a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">false</a></code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>The minimal dimension that will fit the given element. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">Fixed</a> </dd>
|
||
|
|
<dd>
|
||
|
|
<a class="el" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">Full</a> </dd></dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="dom_2util_8cpp_source.html#l00093">93</a> of file <a class="el" href="dom_2util_8cpp_source.html">util.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a36e539ed36f88d7f01233974da485937" name="a36e539ed36f88d7f01233974da485937"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36e539ed36f88d7f01233974da485937">◆ </a></span>Fixed()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> Fixed </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">int</a> </td>
|
||
|
|
<td class="paramname"><em>v</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>A fixed dimension. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui_1_1Dimension.html#aee138f0b60ddc07682a785f55eb5fda6">Fit</a> </dd>
|
||
|
|
<dd>
|
||
|
|
<a class="el" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">Full</a> </dd></dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00375">375</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af795790b995132f62de607ddfd07f9fa" name="af795790b995132f62de607ddfd07f9fa"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af795790b995132f62de607ddfd07f9fa">◆ </a></span>Full()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="namespaceftxui.html#structftxui_1_1Dimensions">Dimensions</a> Full </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Use the terminal dimensions. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">Fixed</a> </dd>
|
||
|
|
<dd>
|
||
|
|
<a class="el" href="namespaceftxui_1_1Dimension.html#aee138f0b60ddc07682a785f55eb5fda6">Fit</a> </dd></dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="screen_8cpp_source.html#l00382">382</a> of file <a class="el" href="screen_8cpp_source.html">screen.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</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>
|