Files
FTXUI/structftxui_1_1SliderOption.html

348 lines
22 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: SliderOption&lt; T &gt; Struct Template 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('structftxui_1_1SliderOption.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-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">SliderOption&lt; T &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for SliderOption&lt; T &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="structftxui_1_1SliderOption__coll__graph.png" border="0" usemap="#aSliderOption_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aSliderOption_3_01T_01_4_coll__map" id="aSliderOption_3_01T_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,108,145,133"/>
<area shape="rect" href="classftxui_1_1Color.html" title="A class representing terminal colors." alt="" coords="47,5,103,31"/>
<area shape="poly" title=" " alt="" coords="78,45,78,108,73,108,73,45"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ab256d6c86a100045ed2329da289dce3a" id="r_ab256d6c86a100045ed2329da289dce3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab256d6c86a100045ed2329da289dce3a">value</a></td></tr>
<tr class="separator:ab256d6c86a100045ed2329da289dce3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a337a8e502154b70ef2a1d4bb3cb47ea9" id="r_a337a8e502154b70ef2a1d4bb3cb47ea9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a337a8e502154b70ef2a1d4bb3cb47ea9">min</a> = T(0)</td></tr>
<tr class="separator:a337a8e502154b70ef2a1d4bb3cb47ea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd146f0de5789f02aee07c54e819099b" id="r_abd146f0de5789f02aee07c54e819099b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd146f0de5789f02aee07c54e819099b">max</a> = T(100)</td></tr>
<tr class="separator:abd146f0de5789f02aee07c54e819099b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a752366b00bdf7bba57a18e239e86e2e1" id="r_a752366b00bdf7bba57a18e239e86e2e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a752366b00bdf7bba57a18e239e86e2e1">increment</a> = (<a class="el" href="#abd146f0de5789f02aee07c54e819099b">max</a>() - <a class="el" href="#a337a8e502154b70ef2a1d4bb3cb47ea9">min</a>()) / 20</td></tr>
<tr class="separator:a752366b00bdf7bba57a18e239e86e2e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53421c695d00016ab925777d423b4eb6" id="r_a53421c695d00016ab925777d423b4eb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53421c695d00016ab925777d423b4eb6">direction</a> = <a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aaa92b09c7c48c520c3c55e497875da437c">Direction::Right</a></td></tr>
<tr class="separator:a53421c695d00016ab925777d423b4eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a593f1ba15add21d1972c01372db369df" id="r_a593f1ba15add21d1972c01372db369df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Color.html">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a593f1ba15add21d1972c01372db369df">color_active</a> = <a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fab548046646b36c12aa6ba841de500094">Color::White</a></td></tr>
<tr class="separator:a593f1ba15add21d1972c01372db369df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5a77e0bc0ce649271a13949a7a0a635" id="r_ad5a77e0bc0ce649271a13949a7a0a635"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Color.html">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5a77e0bc0ce649271a13949a7a0a635">color_inactive</a> = <a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fade3b52f7f38e412815092547cd6e8be7">Color::GrayDark</a></td></tr>
<tr class="separator:ad5a77e0bc0ce649271a13949a7a0a635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function&lt; void()&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a></td></tr>
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T&gt;<br />
struct ftxui::SliderOption&lt; T &gt;</div><dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#_a2">examples/component/resizable_split.cpp</a>, <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#_a6">examples/component/scrollbar.cpp</a>, <a class="el" href="examples_2component_2slider_8cpp-example.html#_a1">examples/component/slider.cpp</a>, and <a class="el" href="examples_2component_2slider_direction_8cpp-example.html#_a3">examples/component/slider_direction.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00222">222</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ab256d6c86a100045ed2329da289dce3a" name="ab256d6c86a100045ed2329da289dce3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab256d6c86a100045ed2329da289dce3a">&#9670;&#160;</a></span>value</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a>&lt;T&gt; value</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a3">examples/component/resizable_split.cpp</a>, <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a7">examples/component/scrollbar.cpp</a>, <a class="el" href="examples_2component_2slider_8cpp-example.html#a2">examples/component/slider.cpp</a>, and <a class="el" href="examples_2component_2slider_direction_8cpp-example.html#a4">examples/component/slider_direction.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00223">223</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a337a8e502154b70ef2a1d4bb3cb47ea9" name="a337a8e502154b70ef2a1d4bb3cb47ea9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a337a8e502154b70ef2a1d4bb3cb47ea9">&#9670;&#160;</a></span>min</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>&lt;T&gt; min = T(0)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a4">examples/component/resizable_split.cpp</a>, and <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a8">examples/component/scrollbar.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00224">224</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="abd146f0de5789f02aee07c54e819099b" name="abd146f0de5789f02aee07c54e819099b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd146f0de5789f02aee07c54e819099b">&#9670;&#160;</a></span>max</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>&lt;T&gt; max = T(100)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a5">examples/component/resizable_split.cpp</a>, <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a9">examples/component/scrollbar.cpp</a>, <a class="el" href="examples_2component_2slider_8cpp-example.html#a3">examples/component/slider.cpp</a>, and <a class="el" href="examples_2component_2slider_direction_8cpp-example.html#a5">examples/component/slider_direction.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00225">225</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a752366b00bdf7bba57a18e239e86e2e1" name="a752366b00bdf7bba57a18e239e86e2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a752366b00bdf7bba57a18e239e86e2e1">&#9670;&#160;</a></span>increment</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ConstRef.html">ConstRef</a>&lt;T&gt; increment = (<a class="el" href="#abd146f0de5789f02aee07c54e819099b">max</a>() - <a class="el" href="#a337a8e502154b70ef2a1d4bb3cb47ea9">min</a>()) / 20</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a6">examples/component/resizable_split.cpp</a>, <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a10">examples/component/scrollbar.cpp</a>, <a class="el" href="examples_2component_2slider_8cpp-example.html#a4">examples/component/slider.cpp</a>, and <a class="el" href="examples_2component_2slider_direction_8cpp-example.html#a6">examples/component/slider_direction.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00226">226</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a53421c695d00016ab925777d423b4eb6" name="a53421c695d00016ab925777d423b4eb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53421c695d00016ab925777d423b4eb6">&#9670;&#160;</a></span>direction</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aa">Direction</a> direction = <a class="el" href="namespaceftxui.html#a224b9163917ac32fc95a60d8c1eec3aaa92b09c7c48c520c3c55e497875da437c">Direction::Right</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a7">examples/component/resizable_split.cpp</a>, <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a11">examples/component/scrollbar.cpp</a>, <a class="el" href="examples_2component_2slider_8cpp-example.html#a5">examples/component/slider.cpp</a>, and <a class="el" href="examples_2component_2slider_direction_8cpp-example.html#a7">examples/component/slider_direction.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00227">227</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a593f1ba15add21d1972c01372db369df" name="a593f1ba15add21d1972c01372db369df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a593f1ba15add21d1972c01372db369df">&#9670;&#160;</a></span>color_active</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Color.html">Color</a> color_active = <a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fab548046646b36c12aa6ba841de500094">Color::White</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a8">examples/component/resizable_split.cpp</a>, and <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a12">examples/component/scrollbar.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00228">228</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="ad5a77e0bc0ce649271a13949a7a0a635" name="ad5a77e0bc0ce649271a13949a7a0a635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5a77e0bc0ce649271a13949a7a0a635">&#9670;&#160;</a></span>color_inactive</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Color.html">Color</a> color_inactive = <a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fade3b52f7f38e412815092547cd6e8be7">Color::GrayDark</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2resizable_split_8cpp-example.html#a9">examples/component/resizable_split.cpp</a>, and <a class="el" href="examples_2component_2scrollbar_8cpp-example.html#a13">examples/component/scrollbar.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00229">229</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="abdfe3c83deeec2323ff90248815b8f0a" name="abdfe3c83deeec2323ff90248815b8f0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdfe3c83deeec2323ff90248815b8f0a">&#9670;&#160;</a></span>on_change</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::function&lt;void()&gt; on_change</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00230">230</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="component__options_8hpp_source.html">component_options.hpp</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="structftxui_1_1SliderOption.html">SliderOption</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>