Files
FTXUI/box__helper_8hpp_source.html

149 lines
12 KiB
HTML
Raw Normal View History

<!-- 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/box_helper.hpp Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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('box__helper_8hpp_source.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="headertitle"><div class="title">box_helper.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="box__helper_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2021 Arthur Sonzogni. All rights reserved.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// the LICENSE file.line.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifndef FTXUI_DOM_BOX_HELPER_HPP</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define FTXUI_DOM_BOX_HELPER_HPP</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="requirement_8hpp.html">ftxui/dom/requirement.hpp</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui_1_1box__helper.html">ftxui::box_helper</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1box__helper.html"> 12</a></span><span class="keyword">struct </span><a class="code hl_struct" href="namespaceftxui_1_1box__helper.html#structftxui_1_1box__helper_1_1Element">Element</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// Input:</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1box__helper.html#ac3f0cc8c8c9e0fb97f20cf7777773197"> 14</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceftxui_1_1box__helper.html#ac3f0cc8c8c9e0fb97f20cf7777773197">min_size</a> = 0;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1box__helper.html#a2fb16db68c0bf00d3bf872bc18675116"> 15</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceftxui_1_1box__helper.html#a2fb16db68c0bf00d3bf872bc18675116">flex_grow</a> = 0;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1box__helper.html#a94a9a7333988edf4249f38c1b1491cf4"> 16</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceftxui_1_1box__helper.html#a94a9a7333988edf4249f38c1b1491cf4">flex_shrink</a> = 0;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Output;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespaceftxui_1_1box__helper.html#a439227feff9d7f55384e8780cfc2eb82"> 19</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceftxui_1_1box__helper.html#a439227feff9d7f55384e8780cfc2eb82">size</a> = 0;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>};</div>
</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceftxui_1_1box__helper.html#aede4ed6e71fbe0689a500ff8db06f3a3">Compute</a>(std::vector&lt;Element&gt;* <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">elements</a>, <span class="keywordtype">int</span> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">target_size</a>);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>} <span class="comment">// namespace ftxui::box_helper</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#endif </span><span class="comment">/* end of include guard: FTXUI_DOM_BOX_HELPER_HPP */</span><span class="preprocessor"></span></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html">ftxui::box_helper</a></div><div class="ttdef"><b>Definition</b> <a href="box__helper_8cpp_source.html#l00009">box_helper.cpp:9</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html_a2fb16db68c0bf00d3bf872bc18675116"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html#a2fb16db68c0bf00d3bf872bc18675116">ftxui::box_helper::Element::flex_grow</a></div><div class="ttdeci">int flex_grow</div><div class="ttdef"><b>Definition</b> <a href="box__helper_8hpp_source.html#l00015">box_helper.hpp:15</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html_a439227feff9d7f55384e8780cfc2eb82"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html#a439227feff9d7f55384e8780cfc2eb82">ftxui::box_helper::Element::size</a></div><div class="ttdeci">int size</div><div class="ttdef"><b>Definition</b> <a href="box__helper_8hpp_source.html#l00019">box_helper.hpp:19</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html_a94a9a7333988edf4249f38c1b1491cf4"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html#a94a9a7333988edf4249f38c1b1491cf4">ftxui::box_helper::Element::flex_shrink</a></div><div class="ttdeci">int flex_shrink</div><div class="ttdef"><b>Definition</b> <a href="box__helper_8hpp_source.html#l00016">box_helper.hpp:16</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html_ac3f0cc8c8c9e0fb97f20cf7777773197"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html#ac3f0cc8c8c9e0fb97f20cf7777773197">ftxui::box_helper::Element::min_size</a></div><div class="ttdeci">int min_size</div><div class="ttdef"><b>Definition</b> <a href="box__helper_8hpp_source.html#l00014">box_helper.hpp:14</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html_aede4ed6e71fbe0689a500ff8db06f3a3"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html#aede4ed6e71fbe0689a500ff8db06f3a3">ftxui::box_helper::Compute</a></div><div class="ttdeci">void Compute(std::vector&lt; Element &gt; *elements, int target_size)</div><div class="ttdef"><b>Definition</b> <a href="box__helper_8cpp_source.html#l00065">box_helper.cpp:65</a></div></div>
<div class="ttc" id="anamespaceftxui_1_1box__helper_html_structftxui_1_1box__helper_1_1Element"><div class="ttname"><a href="namespaceftxui_1_1box__helper.html#structftxui_1_1box__helper_1_1Element">ftxui::box_helper::Element</a></div><div class="ttdef"><b>Definition</b> <a href="box__helper_8hpp_source.html#l00012">box_helper.hpp:12</a></div></div>
<div class="ttc" id="anamespaceftxui_html_a2b8973dc71334f1d98e2e6f55de8b5ae"><div class="ttname"><a href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">ftxui::Make</a></div><div class="ttdeci">std::shared_ptr&lt; T &gt; Make(Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition</b> <a href="component_8hpp_source.html#l00026">component.hpp:26</a></div></div>
<div class="ttc" id="arequirement_8hpp_html"><div class="ttname"><a href="requirement_8hpp.html">requirement.hpp</a></div></div>
</div><!-- fragment --></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>