Files
FTXUI/structftxui_1_1RadioboxOption.html
2025-05-29 07:37:37 +00:00

291 lines
15 KiB
HTML

<!-- 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: RadioboxOption 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_1RadioboxOption.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-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">RadioboxOption Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Option for the Radiobox component.
<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 RadioboxOption:</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_1RadioboxOption__coll__graph.png" border="0" usemap="#aRadioboxOption_coll__map" alt="Collaboration graph"/></div>
<map name="aRadioboxOption_coll__map" id="aRadioboxOption_coll__map">
<area shape="rect" title="Option for the Radiobox component." alt="" coords="84,108,211,133"/>
<area shape="rect" href="classftxui_1_1ConstStringListRef.html" title="An adapter. Reference a list of strings." alt="" coords="5,5,148,31"/>
<area shape="poly" title=" " alt="" coords="95,40,141,106,137,110,90,43"/>
<area shape="rect" href="classftxui_1_1Ref.html" title=" " alt="" coords="173,5,263,31"/>
<area shape="poly" title=" " alt="" coords="206,44,177,86,159,109,155,106,173,82,201,41"/>
</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-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af2b048773665961fae6c104762533908" id="r_af2b048773665961fae6c104762533908"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1RadioboxOption.html">RadioboxOption</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af2b048773665961fae6c104762533908">Simple</a> ()</td></tr>
<tr class="memdesc:af2b048773665961fae6c104762533908"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option for standard Radiobox. <br /></td></tr>
<tr class="separator:af2b048773665961fae6c104762533908"><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:a7b534b117dbbe826d34ba17af85f1e93" id="r_a7b534b117dbbe826d34ba17af85f1e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b534b117dbbe826d34ba17af85f1e93">entries</a></td></tr>
<tr class="separator:a7b534b117dbbe826d34ba17af85f1e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac42a32c3439d08be9c5626a5fbc3a0c4" id="r_ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac42a32c3439d08be9c5626a5fbc3a0c4">selected</a> = 0</td></tr>
<tr class="separator:ac42a32c3439d08be9c5626a5fbc3a0c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe14c161494dad905597e75661c7b6a0" id="r_afe14c161494dad905597e75661c7b6a0"><td class="memItemLeft" align="right" valign="top">std::function&lt; <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a> &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe14c161494dad905597e75661c7b6a0">transform</a></td></tr>
<tr class="separator:afe14c161494dad905597e75661c7b6a0"><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="memdesc:abdfe3c83deeec2323ff90248815b8f0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the selected entry changes. <br /></td></tr>
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93d5d37708b77971a666b73486017835" id="r_a93d5d37708b77971a666b73486017835"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93d5d37708b77971a666b73486017835">focused_entry</a> = 0</td></tr>
<tr class="separator:a93d5d37708b77971a666b73486017835"><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 for the Radiobox component. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00192">192</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="af2b048773665961fae6c104762533908" name="af2b048773665961fae6c104762533908"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2b048773665961fae6c104762533908">&#9670;&#160;</a></span>Simple()</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="structftxui_1_1RadioboxOption.html">RadioboxOption</a> Simple </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Option for standard Radiobox. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00287">287</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="a7b534b117dbbe826d34ba17af85f1e93" name="a7b534b117dbbe826d34ba17af85f1e93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b534b117dbbe826d34ba17af85f1e93">&#9670;&#160;</a></span>entries</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1ConstStringListRef.html">ConstStringListRef</a> entries</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00197">197</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="ac42a32c3439d08be9c5626a5fbc3a0c4" name="ac42a32c3439d08be9c5626a5fbc3a0c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac42a32c3439d08be9c5626a5fbc3a0c4">&#9670;&#160;</a></span>selected</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a>&lt;int&gt; selected = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00198">198</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="afe14c161494dad905597e75661c7b6a0" name="afe14c161494dad905597e75661c7b6a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe14c161494dad905597e75661c7b6a0">&#9670;&#160;</a></span>transform</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::function&lt;<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(const <a class="el" href="structftxui_1_1EntryState.html">EntryState</a>&amp;)&gt; transform</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00201">201</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">
<table class="memname">
<tr>
<td class="memname">std::function&lt;void()&gt; on_change = [] {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when the selected entry changes. </p>
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00205">205</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
</div>
</div>
<a id="a93d5d37708b77971a666b73486017835" name="a93d5d37708b77971a666b73486017835"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93d5d37708b77971a666b73486017835">&#9670;&#160;</a></span>focused_entry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a>&lt;int&gt; focused_entry = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00206">206</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_1RadioboxOption.html">RadioboxOption</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>