Files
FTXUI/structftxui_1_1AnimatedColorOption.html

298 lines
18 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: AnimatedColorOption Struct 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()
</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_1AnimatedColorOption.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> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">AnimatedColorOption Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Option about a potentially animated color.
<a href="#details">More...</a></p>
<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 AnimatedColorOption:</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_1AnimatedColorOption__coll__graph.png" border="0" usemap="#aAnimatedColorOption_coll__map" alt="Collaboration graph"/></div>
<map name="aAnimatedColorOption_coll__map" id="aAnimatedColorOption_coll__map">
<area shape="rect" title="Option about a potentially animated color." alt="" coords="5,108,168,133"/>
<area shape="rect" href="classftxui_1_1Color.html" title="A class representing terminal colors." alt="" coords="59,5,115,31"/>
<area shape="poly" title=" " alt="" coords="89,45,89,108,84,108,84,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-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad186d5a36e45174bbc7c50df85c2e91e" id="r_ad186d5a36e45174bbc7c50df85c2e91e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad186d5a36e45174bbc7c50df85c2e91e">Set</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> <a class="el" href="#a898e4eb6c2a93ea3b71fc373f39854eb">inactive</a>, <a class="el" href="classftxui_1_1Color.html">Color</a> <a class="el" href="#a5c04e41d802330270ae14a9861c1e2df">active</a>, <a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> <a class="el" href="#a7449575119a6168a323351fb04a7eb64">duration</a>=std::chrono::milliseconds(250), <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> <a class="el" href="#a23a21de13ab9c6644225966245df3fe3">function</a>=<a class="el" href="namespaceftxui_1_1animation_1_1easing.html#a8155757f48a6e85e27da99c0a93f7e8d">animation::easing::QuadraticInOut</a>)</td></tr>
<tr class="memdesc:ad186d5a36e45174bbc7c50df85c2e91e"><td class="mdescLeft">&#160;</td><td class="mdescRight">A color option that can be animated. @params _inactive The color when the component is inactive. @params _active The color when the component is active. @params _duration The duration of the animation. @params _function The easing function of the animation. <br /></td></tr>
<tr class="separator:ad186d5a36e45174bbc7c50df85c2e91e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a8740ba80e30dd75e71d09fa1dcf04f3d" id="r_a8740ba80e30dd75e71d09fa1dcf04f3d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8740ba80e30dd75e71d09fa1dcf04f3d">enabled</a> = false</td></tr>
<tr class="separator:a8740ba80e30dd75e71d09fa1dcf04f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a898e4eb6c2a93ea3b71fc373f39854eb" id="r_a898e4eb6c2a93ea3b71fc373f39854eb"><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="#a898e4eb6c2a93ea3b71fc373f39854eb">inactive</a></td></tr>
<tr class="separator:a898e4eb6c2a93ea3b71fc373f39854eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c04e41d802330270ae14a9861c1e2df" id="r_a5c04e41d802330270ae14a9861c1e2df"><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="#a5c04e41d802330270ae14a9861c1e2df">active</a></td></tr>
<tr class="separator:a5c04e41d802330270ae14a9861c1e2df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7449575119a6168a323351fb04a7eb64" id="r_a7449575119a6168a323351fb04a7eb64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7449575119a6168a323351fb04a7eb64">duration</a> = std::chrono::milliseconds(250)</td></tr>
<tr class="separator:a7449575119a6168a323351fb04a7eb64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23a21de13ab9c6644225966245df3fe3" id="r_a23a21de13ab9c6644225966245df3fe3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23a21de13ab9c6644225966245df3fe3">function</a> = <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#a8155757f48a6e85e27da99c0a93f7e8d">animation::easing::QuadraticInOut</a></td></tr>
<tr class="separator:a23a21de13ab9c6644225966245df3fe3"><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>Option about a potentially animated color. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00055">55</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad186d5a36e45174bbc7c50df85c2e91e" name="ad186d5a36e45174bbc7c50df85c2e91e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad186d5a36e45174bbc7c50df85c2e91e">&#9670;&#160;</a></span>Set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>inactive</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>active</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a></td> <td class="paramname"><span class="paramname"><em>duration</em></span><span class="paramdefsep"> = </span><span class="paramdefval">std::chrono::milliseconds(250)</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a></td> <td class="paramname"><span class="paramname"><em>function</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#a8155757f48a6e85e27da99c0a93f7e8d">animation::easing::QuadraticInOut</a></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A color option that can be animated. @params _inactive The color when the component is inactive. @params _active The color when the component is active. @params _duration The duration of the animation. @params _function The easing function of the animation. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00021">21</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="a8740ba80e30dd75e71d09fa1dcf04f3d" name="a8740ba80e30dd75e71d09fa1dcf04f3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8740ba80e30dd75e71d09fa1dcf04f3d">&#9670;&#160;</a></span>enabled</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool enabled = false</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2menu_entries_8cpp-example.html#a5">examples/component/menu_entries.cpp</a>, and <a class="el" href="examples_2component_2menu_entries_animated_8cpp-example.html#a6">examples/component/menu_entries_animated.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00062">62</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a898e4eb6c2a93ea3b71fc373f39854eb" name="a898e4eb6c2a93ea3b71fc373f39854eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a898e4eb6c2a93ea3b71fc373f39854eb">&#9670;&#160;</a></span>inactive</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Color.html">Color</a> inactive</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2menu_entries_8cpp-example.html#a8">examples/component/menu_entries.cpp</a>, and <a class="el" href="examples_2component_2menu_entries_animated_8cpp-example.html#a9">examples/component/menu_entries_animated.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00063">63</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a5c04e41d802330270ae14a9861c1e2df" name="a5c04e41d802330270ae14a9861c1e2df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c04e41d802330270ae14a9861c1e2df">&#9670;&#160;</a></span>active</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Color.html">Color</a> active</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2menu_entries_8cpp-example.html#a7">examples/component/menu_entries.cpp</a>, and <a class="el" href="examples_2component_2menu_entries_animated_8cpp-example.html#a8">examples/component/menu_entries_animated.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00064">64</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a7449575119a6168a323351fb04a7eb64" name="a7449575119a6168a323351fb04a7eb64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7449575119a6168a323351fb04a7eb64">&#9670;&#160;</a></span>duration</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui_1_1animation.html#a3c06579c86b609bce4a9a097b23cd739">animation::Duration</a> duration = std::chrono::milliseconds(250)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00065">65</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a23a21de13ab9c6644225966245df3fe3" name="a23a21de13ab9c6644225966245df3fe3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23a21de13ab9c6644225966245df3fe3">&#9670;&#160;</a></span>function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceftxui_1_1animation_1_1easing.html#ad820848234fca6290b7399cc5e07af3a">animation::easing::Function</a> function = <a class="el" href="namespaceftxui_1_1animation_1_1easing.html#a8155757f48a6e85e27da99c0a93f7e8d">animation::easing::QuadraticInOut</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00066">66</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 files:<ul>
<li><a class="el" href="component__options_8hpp_source.html">component_options.hpp</a></li>
<li><a class="el" href="component__options_8cpp_source.html">component_options.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="structftxui_1_1AnimatedColorOption.html">AnimatedColorOption</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>