mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
442 lines
25 KiB
HTML
442 lines
25 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: InputOption 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()
|
||
|
|
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"> 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&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
||
|
|
$(function(){initNavTree('structftxui_1_1InputOption.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> |
|
||
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">InputOption Struct Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Option for the Input component.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>></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 InputOption:</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_1InputOption__coll__graph.png" border="0" usemap="#aInputOption_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="aInputOption_coll__map" id="aInputOption_coll__map">
|
||
|
|
<area shape="rect" title="Option for the Input component." alt="" coords="143,197,241,223"/>
|
||
|
|
<area shape="rect" href="classftxui_1_1StringRef.html" title="An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable ..." alt="" coords="33,80,116,105"/>
|
||
|
|
<area shape="poly" title=" " alt="" coords="83,118,93,146,111,171,129,185,150,195,148,200,127,190,107,175,89,148,78,120"/>
|
||
|
|
<area shape="rect" href="classftxui_1_1Ref.html" title=" " alt="" coords="5,5,144,31"/>
|
||
|
|
<area shape="poly" title=" " alt="" coords="77,45,77,80,72,80,72,45"/>
|
||
|
|
<area shape="rect" href="classftxui_1_1Ref.html" title=" " alt="" coords="141,80,243,105"/>
|
||
|
|
<area shape="poly" title=" " alt="" coords="195,119,195,197,189,197,189,119"/>
|
||
|
|
<area shape="rect" href="classftxui_1_1Ref.html" title=" " alt="" coords="268,80,359,105"/>
|
||
|
|
<area shape="poly" title=" " alt="" coords="304,119,286,148,262,175,223,200,220,195,258,171,282,145,299,116"/>
|
||
|
|
</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:a2108670f055ede2fdc4993f6ffc8ff07" id="r_a2108670f055ede2fdc4993f6ffc8ff07"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1InputOption.html">InputOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2108670f055ede2fdc4993f6ffc8ff07">Default</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a2108670f055ede2fdc4993f6ffc8ff07"><td class="mdescLeft"> </td><td class="mdescRight">Create the default input style: <br /></td></tr>
|
||
|
|
<tr class="separator:a2108670f055ede2fdc4993f6ffc8ff07"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a36c56131167eaaae707f64bbb9d07ef2" id="r_a36c56131167eaaae707f64bbb9d07ef2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structftxui_1_1InputOption.html">InputOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a36c56131167eaaae707f64bbb9d07ef2">Spacious</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a36c56131167eaaae707f64bbb9d07ef2"><td class="mdescLeft"> </td><td class="mdescRight">A white on black style with high margins: <br /></td></tr>
|
||
|
|
<tr class="separator:a36c56131167eaaae707f64bbb9d07ef2"><td class="memSeparator" colspan="2"> </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:ac9f6c2acd72d74eeb3a18baf32b02932" id="r_ac9f6c2acd72d74eeb3a18baf32b02932"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9f6c2acd72d74eeb3a18baf32b02932">content</a> = ""</td></tr>
|
||
|
|
<tr class="memdesc:ac9f6c2acd72d74eeb3a18baf32b02932"><td class="mdescLeft"> </td><td class="mdescRight">The content of the input. <br /></td></tr>
|
||
|
|
<tr class="separator:ac9f6c2acd72d74eeb3a18baf32b02932"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaca8e18f9fe70089d8fd4165f4b518e1" id="r_aaca8e18f9fe70089d8fd4165f4b518e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaca8e18f9fe70089d8fd4165f4b518e1">placeholder</a> = ""</td></tr>
|
||
|
|
<tr class="memdesc:aaca8e18f9fe70089d8fd4165f4b518e1"><td class="mdescLeft"> </td><td class="mdescRight">The content of the input when it's empty. <br /></td></tr>
|
||
|
|
<tr class="separator:aaca8e18f9fe70089d8fd4165f4b518e1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a93721d00aaf44f42cc0399024514b628" id="r_a93721d00aaf44f42cc0399024514b628"><td class="memItemLeft" align="right" valign="top">std::function< <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="el" href="structftxui_1_1InputState.html">InputState</a>)> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a93721d00aaf44f42cc0399024514b628">transform</a></td></tr>
|
||
|
|
<tr class="separator:a93721d00aaf44f42cc0399024514b628"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a927bd46792ffe38c7545a764d847d066" id="r_a927bd46792ffe38c7545a764d847d066"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a927bd46792ffe38c7545a764d847d066">password</a> = false</td></tr>
|
||
|
|
<tr class="memdesc:a927bd46792ffe38c7545a764d847d066"><td class="mdescLeft"> </td><td class="mdescRight">Obscure the input content using '*'. <br /></td></tr>
|
||
|
|
<tr class="separator:a927bd46792ffe38c7545a764d847d066"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af18b2db29029e23c13a8bfc233c62878" id="r_af18b2db29029e23c13a8bfc233c62878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#af18b2db29029e23c13a8bfc233c62878">multiline</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:af18b2db29029e23c13a8bfc233c62878"><td class="mdescLeft"> </td><td class="mdescRight">Whether the input can be multiline. <br /></td></tr>
|
||
|
|
<tr class="separator:af18b2db29029e23c13a8bfc233c62878"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3ae35fa7cff9f950b9c66536523c69c1" id="r_a3ae35fa7cff9f950b9c66536523c69c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3ae35fa7cff9f950b9c66536523c69c1">insert</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a3ae35fa7cff9f950b9c66536523c69c1"><td class="mdescLeft"> </td><td class="mdescRight">Insert or overtype character mode. <br /></td></tr>
|
||
|
|
<tr class="separator:a3ae35fa7cff9f950b9c66536523c69c1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:abdfe3c83deeec2323ff90248815b8f0a" id="r_abdfe3c83deeec2323ff90248815b8f0a"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdfe3c83deeec2323ff90248815b8f0a">on_change</a> = [] {}</td></tr>
|
||
|
|
<tr class="memdesc:abdfe3c83deeec2323ff90248815b8f0a"><td class="mdescLeft"> </td><td class="mdescRight">Called when the content changes. <br /></td></tr>
|
||
|
|
<tr class="separator:abdfe3c83deeec2323ff90248815b8f0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4ba9530701be07334a17c0184747c535" id="r_a4ba9530701be07334a17c0184747c535"><td class="memItemLeft" align="right" valign="top">std::function< void()> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ba9530701be07334a17c0184747c535">on_enter</a> = [] {}</td></tr>
|
||
|
|
<tr class="memdesc:a4ba9530701be07334a17c0184747c535"><td class="mdescLeft"> </td><td class="mdescRight">Called when the user presses enter. <br /></td></tr>
|
||
|
|
<tr class="separator:a4ba9530701be07334a17c0184747c535"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a699547942204afa70864e0e6df94c96c" id="r_a699547942204afa70864e0e6df94c96c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classftxui_1_1Ref.html">Ref</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a699547942204afa70864e0e6df94c96c">cursor_position</a> = 0</td></tr>
|
||
|
|
<tr class="separator:a699547942204afa70864e0e6df94c96c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Option for the Input component. </p>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2gallery_8cpp-example.html#_a1">examples/component/gallery.cpp</a>, <a class="el" href="examples_2component_2homescreen_8cpp-example.html#_a1">examples/component/homescreen.cpp</a>, <a class="el" href="examples_2component_2input_8cpp-example.html#_a1">examples/component/input.cpp</a>, <a class="el" href="examples_2component_2input_in_frame_8cpp-example.html#_a1">examples/component/input_in_frame.cpp</a>, and <a class="el" href="examples_2component_2input_style_8cpp-example.html#_a3">examples/component/input_style.cpp</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00161">161</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="a2108670f055ede2fdc4993f6ffc8ff07" name="a2108670f055ede2fdc4993f6ffc8ff07"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2108670f055ede2fdc4993f6ffc8ff07">◆ </a></span>Default()</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_1InputOption.html">InputOption</a> Default </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>Create the default input style: </p>
|
||
|
|
<p>Standard options for the input component. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00312">312</a> of file <a class="el" href="component__options_8cpp_source.html">component_options.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a36c56131167eaaae707f64bbb9d07ef2" name="a36c56131167eaaae707f64bbb9d07ef2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36c56131167eaaae707f64bbb9d07ef2">◆ </a></span>Spacious()</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_1InputOption.html">InputOption</a> Spacious </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>A white on black style with high margins: </p>
|
||
|
|
<p>Standard options for a more beautiful input component. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8cpp_source.html#l00335">335</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="ac9f6c2acd72d74eeb3a18baf32b02932" name="ac9f6c2acd72d74eeb3a18baf32b02932"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9f6c2acd72d74eeb3a18baf32b02932">◆ </a></span>content</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> content = ""</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The content of the input. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00170">170</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aaca8e18f9fe70089d8fd4165f4b518e1" name="aaca8e18f9fe70089d8fd4165f4b518e1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaca8e18f9fe70089d8fd4165f4b518e1">◆ </a></span>placeholder</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1StringRef.html">StringRef</a> placeholder = ""</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The content of the input when it's empty. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00173">173</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a93721d00aaf44f42cc0399024514b628" name="a93721d00aaf44f42cc0399024514b628"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a93721d00aaf44f42cc0399024514b628">◆ </a></span>transform</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::function<<a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">Element</a>(<a class="el" href="structftxui_1_1InputState.html">InputState</a>)> transform</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2input_in_frame_8cpp-example.html#a2">examples/component/input_in_frame.cpp</a>, and <a class="el" href="examples_2component_2input_style_8cpp-example.html#a4">examples/component/input_style.cpp</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00176">176</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a927bd46792ffe38c7545a764d847d066" name="a927bd46792ffe38c7545a764d847d066"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a927bd46792ffe38c7545a764d847d066">◆ </a></span>password</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> password = false</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Obscure the input content using '*'. </p>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2homescreen_8cpp-example.html#a2">examples/component/homescreen.cpp</a>, and <a class="el" href="examples_2component_2input_8cpp-example.html#a2">examples/component/input.cpp</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00177">177</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af18b2db29029e23c13a8bfc233c62878" name="af18b2db29029e23c13a8bfc233c62878"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af18b2db29029e23c13a8bfc233c62878">◆ </a></span>multiline</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> multiline = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Whether the input can be multiline. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00178">178</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a3ae35fa7cff9f950b9c66536523c69c1" name="a3ae35fa7cff9f950b9c66536523c69c1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ae35fa7cff9f950b9c66536523c69c1">◆ </a></span>insert</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><bool> insert = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Insert or overtype character mode. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00179">179</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">◆ </a></span>on_change</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::function<void()> on_change = [] {}</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Called when the content changes. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00182">182</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a4ba9530701be07334a17c0184747c535" name="a4ba9530701be07334a17c0184747c535"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ba9530701be07334a17c0184747c535">◆ </a></span>on_enter</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::function<void()> on_enter = [] {}</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Called when the user presses enter. </p>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00184">184</a> of file <a class="el" href="component__options_8hpp_source.html">component_options.hpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a699547942204afa70864e0e6df94c96c" name="a699547942204afa70864e0e6df94c96c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a699547942204afa70864e0e6df94c96c">◆ </a></span>cursor_position</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classftxui_1_1Ref.html">Ref</a><int> cursor_position = 0</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="component__options_8hpp_source.html#l00187">187</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_1InputOption.html">InputOption</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>
|