Files
FTXUI/classftxui_1_1Selection.html

422 lines
21 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: Selection Class 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('classftxui_1_1Selection.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="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle"><div class="title">Selection Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represent a selection in the terminal.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="selection_8hpp_source.html">selection.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ade00d4039f147221b9fd6b6b402b43b1" id="r_ade00d4039f147221b9fd6b6b402b43b1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade00d4039f147221b9fd6b6b402b43b1">Selection</a> ()</td></tr>
<tr class="memdesc:ade00d4039f147221b9fd6b6b402b43b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty selection. <br /></td></tr>
<tr class="separator:ade00d4039f147221b9fd6b6b402b43b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76eafd8bc098ec9f0405e3b1f6fb42c4" id="r_a76eafd8bc098ec9f0405e3b1f6fb42c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a76eafd8bc098ec9f0405e3b1f6fb42c4">Selection</a> (int start_x, int start_y, int end_x, int end_y)</td></tr>
<tr class="memdesc:a76eafd8bc098ec9f0405e3b1f6fb42c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a selection. <br /></td></tr>
<tr class="separator:a76eafd8bc098ec9f0405e3b1f6fb42c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03f5cc5dcad10fecb7a0b8203c86a13e" id="r_a03f5cc5dcad10fecb7a0b8203c86a13e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structftxui_1_1Box.html">Box</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03f5cc5dcad10fecb7a0b8203c86a13e">GetBox</a> () const</td></tr>
<tr class="memdesc:a03f5cc5dcad10fecb7a0b8203c86a13e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the box of the selection. <br /></td></tr>
<tr class="separator:a03f5cc5dcad10fecb7a0b8203c86a13e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3f2674604d907fbce26d4217cfa9324" id="r_af3f2674604d907fbce26d4217cfa9324"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Selection.html">Selection</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3f2674604d907fbce26d4217cfa9324">SaturateHorizontal</a> (<a class="el" href="structftxui_1_1Box.html">Box</a> box)</td></tr>
<tr class="memdesc:af3f2674604d907fbce26d4217cfa9324"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate the selection to be inside the box. This is called by <code>hbox</code> to propagate the selection to its children. <br /></td></tr>
<tr class="separator:af3f2674604d907fbce26d4217cfa9324"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace69e1e7c6e64b7ae0c4402e0e1e3336" id="r_ace69e1e7c6e64b7ae0c4402e0e1e3336"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Selection.html">Selection</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ace69e1e7c6e64b7ae0c4402e0e1e3336">SaturateVertical</a> (<a class="el" href="structftxui_1_1Box.html">Box</a> box)</td></tr>
<tr class="memdesc:ace69e1e7c6e64b7ae0c4402e0e1e3336"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate the selection to be inside the box. This is called by <code>vbox</code> to propagate the selection to its children. <br /></td></tr>
<tr class="separator:ace69e1e7c6e64b7ae0c4402e0e1e3336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e12342fc420701fbffd97025421575a" id="r_a8e12342fc420701fbffd97025421575a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e12342fc420701fbffd97025421575a">IsEmpty</a> () const</td></tr>
<tr class="separator:a8e12342fc420701fbffd97025421575a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9887e25feddebbf840876824cb3cbf61" id="r_a9887e25feddebbf840876824cb3cbf61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9887e25feddebbf840876824cb3cbf61">AddPart</a> (const std::string &amp;part, int y, int <a class="el" href="screen_8cpp.html#a972107f15f3c0c099eb9fd605e7f51c6">left</a>, int <a class="el" href="screen_8cpp.html#aa4b74e56e675912bbc06504407fc7a46">right</a>)</td></tr>
<tr class="separator:a9887e25feddebbf840876824cb3cbf61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d4387d24d418b865c77ed592602d08d" id="r_a4d4387d24d418b865c77ed592602d08d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d4387d24d418b865c77ed592602d08d">GetParts</a> ()</td></tr>
<tr class="separator:a4d4387d24d418b865c77ed592602d08d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represent a selection in the terminal. </p>
<p class="definition">Definition at line <a class="el" href="selection_8hpp_source.html#l00017">17</a> of file <a class="el" href="selection_8hpp_source.html">selection.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ade00d4039f147221b9fd6b6b402b43b1" name="ade00d4039f147221b9fd6b6b402b43b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade00d4039f147221b9fd6b6b402b43b1">&#9670;&#160;</a></span>Selection() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Selection.html">Selection</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an empty selection. </p>
</div>
</div>
<a id="a76eafd8bc098ec9f0405e3b1f6fb42c4" name="a76eafd8bc098ec9f0405e3b1f6fb42c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76eafd8bc098ec9f0405e3b1f6fb42c4">&#9670;&#160;</a></span>Selection() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Selection.html">Selection</a> </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>start_x</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>start_y</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>end_x</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>end_y</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a selection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start_x</td><td>The x coordinate of the start of the selection. </td></tr>
<tr><td class="paramname">start_y</td><td>The y coordinate of the start of the selection. </td></tr>
<tr><td class="paramname">end_x</td><td>The x coordinate of the end of the selection. </td></tr>
<tr><td class="paramname">end_y</td><td>The y coordinate of the end of the selection. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html#l00034">34</a> of file <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html">src/ftxui/dom/selection.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a03f5cc5dcad10fecb7a0b8203c86a13e" name="a03f5cc5dcad10fecb7a0b8203c86a13e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03f5cc5dcad10fecb7a0b8203c86a13e">&#9670;&#160;</a></span>GetBox()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structftxui_1_1Box.html">Box</a> &amp; GetBox </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the box of the selection. </p>
<dl class="section return"><dt>Returns</dt><dd>The box of the selection. </dd></dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html#l00067">67</a> of file <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html">src/ftxui/dom/selection.cpp</a>.</p>
</div>
</div>
<a id="af3f2674604d907fbce26d4217cfa9324" name="af3f2674604d907fbce26d4217cfa9324"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3f2674604d907fbce26d4217cfa9324">&#9670;&#160;</a></span>SaturateHorizontal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Selection.html">Selection</a> SaturateHorizontal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structftxui_1_1Box.html">Box</a></td> <td class="paramname"><span class="paramname"><em>box</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Saturate the selection to be inside the box. This is called by <code>hbox</code> to propagate the selection to its children. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">box</td><td>The box to saturate the selection in. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The saturated selection. </dd></dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html#l00075">75</a> of file <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html">src/ftxui/dom/selection.cpp</a>.</p>
</div>
</div>
<a id="ace69e1e7c6e64b7ae0c4402e0e1e3336" name="ace69e1e7c6e64b7ae0c4402e0e1e3336"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace69e1e7c6e64b7ae0c4402e0e1e3336">&#9670;&#160;</a></span>SaturateVertical()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Selection.html">Selection</a> SaturateVertical </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structftxui_1_1Box.html">Box</a></td> <td class="paramname"><span class="paramname"><em>box</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Saturate the selection to be inside the box. This is called by <code>vbox</code> to propagate the selection to its children. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">box</td><td>The box to saturate the selection in. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The saturated selection. </dd></dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html#l00113">113</a> of file <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html">src/ftxui/dom/selection.cpp</a>.</p>
</div>
</div>
<a id="a8e12342fc420701fbffd97025421575a" name="a8e12342fc420701fbffd97025421575a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e12342fc420701fbffd97025421575a">&#9670;&#160;</a></span>IsEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsEmpty </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="selection_8hpp_source.html#l00026">26</a> of file <a class="el" href="selection_8hpp_source.html">selection.hpp</a>.</p>
</div>
</div>
<a id="a9887e25feddebbf840876824cb3cbf61" name="a9887e25feddebbf840876824cb3cbf61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9887e25feddebbf840876824cb3cbf61">&#9670;&#160;</a></span>AddPart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AddPart </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>part</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>y</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html#l00146">146</a> of file <a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html">src/ftxui/dom/selection.cpp</a>.</p>
</div>
</div>
<a id="a4d4387d24d418b865c77ed592602d08d" name="a4d4387d24d418b865c77ed592602d08d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d4387d24d418b865c77ed592602d08d">&#9670;&#160;</a></span>GetParts()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string GetParts </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="selection_8hpp_source.html#l00029">29</a> of file <a class="el" href="selection_8hpp_source.html">selection.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="selection_8hpp_source.html">selection.hpp</a></li>
<li><a class="el" href="src_2ftxui_2dom_2selection_8cpp_source.html">src/ftxui/dom/selection.cpp</a></li>
</ul>
</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="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="classftxui_1_1Selection.html">Selection</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>